HTTP client for Elixir, based on ibrowse. Continues the HTTPun tradition of HTTParty, HTTPretty, HTTParrot and HTTPie.
Add HTTPotion and ibrowse to your project's dependencies in mix.exs:
defp deps do
[
{:ibrowse, github: "cmullaparthi/ibrowse", tag: "v4.1.1"},
{:httpotion, "~> 2.0.0"}
]
end
def application do
[applications: [:httpotion]]
# Application dependency auto-starts it, otherwise: HTTPotion.start
endAnd fetch your project's dependencies:
$ mix deps.getSome basic examples:
iex> response = HTTPotion.get "httpbin.org/get"
%HTTPotion.Response{body: "...", headers: [Connection: "keep-alive", ...], status_code: 200}
iex> HTTPotion.Response.success?(response)
true
iex> response = HTTPotion.post "https://httpbin.org/post", [body: "hello=world", headers: ["User-Agent": "My App"]]
%HTTPotion.Response{body: "...", headers: [Connection: "keep-alive", ...], status_code: 200}
iex> response = HTTPotion.request :propfind, "https://httpbin.org/post", [body: "I have no idea what I'm doing"]
%HTTPotion.Response{body: "...", headers: [Connection: "keep-alive", ...], status_code: 405}
iex> response = HTTPotion.get "httpbin.org/basic-auth/foo/bar", [basic_auth: {"foo", "bar"}]
%HTTPotion.Response{body: "...", headers: ["Access-Control-Allow-Credentials": "true", ...], status_code: 200}
iex> HTTPotion.get "https://localhost:1"
** (HTTPotion.HTTPError) econnrefusedNote: the API changed in 2.0.0, body and headers are options now!
You can extend HTTPotion.Base to make cool API clients or something (this example uses jsx for JSON):
defmodule GitHub do
use HTTPotion.Base
def process_url(url) do
"https://api.github.com/" <> url
end
def process_request_headers(headers) do
Dict.put headers, :"User-Agent", "github-potion"
end
def process_response_body(body) do
body |> to_string |> :jsx.decode
|> Enum.map fn ({k, v}) -> { String.to_atom(k), v } end
|> :orddict.from_list
end
endiex> GitHub.get("users/myfreeweb").body[:public_repos]
37Read the source to see all the hooks. It's not intimidating at all, pretty easy to read actually :-)
Hey, we're on the Erlang VM, right? Every serious OTP app probably makes a lot of these. It's easy to do in HTTPotion.
iex> HTTPotion.get "https://httpbin.org/get", [stream_to: self]
%HTTPotion.AsyncResponse{id: {1372,8757,656584}}
iex> flush
%HTTPotion.AsyncHeaders{id: {1372,8757,656584}, status_code: 200, headers: ["Transfer-Encoding": "chunked", ...]}
%HTTPotion.AsyncChunk{id: {1372,8757,656584}, chunk: "<!DOCTYPE html>\n..."}
%HTTPotion.AsyncEnd{id: {1372,8757,656584}}ibrowse allows you to use its separate worker processes directly.
We expose this functionality through the direct option.
Don't forget that you have to pass the URL to the worker process, which means the worker only communicates with one server (domain!)
iex> {:ok, worker_pid} = HTTPotion.spawn_worker_process("https://httpbin.org")
iex> HTTPotion.get "httpbin.org/get", [direct: worker_pid]
%HTTPotion.Response{body: "...", headers: ["Connection": "close", ...], status_code: 200}You can even combine it with async!
iex> {:ok, worker_pid} = HTTPotion.spawn_worker_process("https://httpbin.org")
iex> HTTPotion.post "httpbin.org/post", [direct: worker_pid, stream_to: self, headers: ["User-Agent": "hello it's me"]]
%HTTPotion.AsyncResponse{id: {1372,8757,656584}}Please feel free to submit pull requests! Bugfixes and non-breaking improvements will definitely be accepted without any questions :-)
By participating in this project you agree to follow the Contributor Code of Conduct.
Copyright © 2013-2015 HTTPotion Contributors.
This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.