No OneTemporary
Actions

Size

21 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/lib/tesla.ex b/lib/tesla.ex
	index 86e681c..e69dc29 100644
	--- a/lib/tesla.ex
	+++ b/lib/tesla.ex
	@@ -1,549 +1,549 @@
	defmodule Tesla.Error do
	defexception message: "", reason: nil
	end

	defmodule Tesla.Env do
	@type client :: Tesla.Client.t() \| (t, stack -> t)
	@type method :: :head \| :get \| :delete \| :trace \| :options \| :post \| :put \| :patch
	@type url :: binary
	@type param :: binary \| [{binary \| atom, param}]
	@type query :: [{binary \| atom, param}]
	@type headers :: %{binary => binary}
	#
	@type body :: any
	@type status :: integer
	@type opts :: [any]
	@type __module__ :: atom
	@type __client__ :: function

	@type stack :: [{atom, atom, any} \| {atom, atom} \| {:fn, (t -> t)} \| {:fn, (t, stack -> t)}]

	@type t :: %__MODULE__{
	method: method,
	query: query,
	url: url,
	headers: headers,
	body: body,
	status: status,
	opts: opts,
	__module__: __module__,
	__client__: __client__
	}

	defstruct method: nil,
	url: "",
	query: [],
	headers: [],
	body: nil,
	status: nil,
	opts: [],
	__module__: nil,
	__client__: nil
	end

	defmodule Tesla.Client do
	@type t :: %__MODULE__{
	fun: (Tesla.Env.t(), Tesla.Env.stack() -> Tesla.Env.t()) \| nil,
	pre: Tesla.Env.stack(),
	post: Tesla.Env.stack()
	}
	defstruct fun: nil,
	pre: [],
	post: []
	end

	defmodule Tesla.Middleware do
	@callback call(env :: Tesla.Env.t(), next :: Tesla.Env.stack(), options :: any) :: Tesla.Env.t()
	end

	defmodule Tesla.Adapter do
	@callback call(env :: Tesla.Env.t(), options :: any) :: Tesla.Env.t()
	end

	defmodule Tesla.Builder do
	@http_verbs ~w(head get delete trace options post put patch)a

	defmacro __using__(opts \\ []) do
	opts = Macro.prewalk(opts, &Macro.expand(&1, __CALLER__))
	docs = Keyword.get(opts, :docs, true)

	quote do
	Module.register_attribute(__MODULE__, :__middleware__, accumulate: true)
	Module.register_attribute(__MODULE__, :__adapter__, [])

	if unquote(docs) do
	@type option ::
	{:method, Tesla.Env.method()}
	\| {:url, Tesla.Env.url()}
	\| {:query, Tesla.Env.query()}
	\| {:headers, Tesla.Env.headers()}
	\| {:body, Tesla.Env.body()}
	\| {:opts, Tesla.Env.opts()}

	@doc """
	Perform a request using client function

	Options:
	- `:method` - the request method, one of [:head, :get, :delete, :trace, :options, :post, :put, :patch]
	- `:url` - either full url e.g. "http://example.com/some/path" or just "/some/path" if using `Tesla.Middleware.BaseUrl`
	- `:query` - a keyword list of query params, e.g. `[page: 1, per_page: 100]`
	- `:headers` - a keyworld list of headers, e.g. `[{"content-type", "text/plain"}]`
	- `:body` - depends on used middleware:
	- by default it can be a binary
	- if using e.g. JSON encoding middleware it can be a nested map
	- if adapter supports it it can be a Stream with any of the above
	- `:opts` - custom, per-request middleware or adapter options

	Examples:

	ExampleApi.request(method: :get, url: "/users/path")

	You can also use shortcut methods like:

	ExampleApi.get("/users/1")

	or

	myclient \|> ExampleApi.post("/users", %{name: "Jon"})
	"""
	@spec request(Tesla.Env.client(), [option]) :: Tesla.Env.t()
	else
	@doc false
	end

	def request(%Tesla.Client{} = client, options) do
	Tesla.perform_request(__MODULE__, client, options)
	end

	if unquote(docs) do
	@doc """
	Perform a request. See `request/2` for available options.
	"""
	@spec request([option]) :: Tesla.Env.t()
	else
	@doc false
	end

	def request(options) do
	Tesla.perform_request(__MODULE__, options)
	end

	unquote(generate_http_verbs(opts))

	import Tesla.Builder, only: [plug: 1, plug: 2, adapter: 1, adapter: 2]
	@before_compile Tesla.Builder
	end
	end

	@doc """
	Attach middleware to your API client

	```ex
	defmodule ExampleApi do
	use Tesla

	# plug middleware module with options
	plug Tesla.Middleware.BaseUrl, "http://api.example.com"
	plug Tesla.Middleware.JSON, engine: Poison

	# plug middleware function
	plug :handle_errors

	# middleware function gets two parameters: Tesla.Env and the rest of middleware call stack
	# and must return Tesla.Env
	def handle_errors(env, next) do
	env
	\|> modify_env_before_request
	\|> Tesla.run(next) # run the rest of stack
	\|> modify_env_after_request
	end
	end
	"""
	defmacro plug(middleware, opts \\ nil) do
	opts = Macro.escape(opts)
	quote do: @__middleware__({unquote(middleware), unquote(opts)})
	end

	@doc """
	Choose adapter for your API client

	```ex
	defmodule ExampleApi do
	use Tesla

	# set adapter as module
	adapter Tesla.Adapter.Hackney

	# set adapter as function
	adapter :local_adapter

	# set adapter as anonymous function
	adapter fn env ->
	...
	env
	end


	# adapter function gets Tesla.Env as parameter and must return Tesla.Env
	def local_adapter(env) do
	...
	env
	end
	end
	"""
	defmacro adapter({:fn, _, _} = adapter) do
	adapter = Macro.escape(adapter)
	quote do: @__adapter__(unquote(adapter))
	end

	defmacro adapter(adapter, opts \\ nil) do
	quote do: @__adapter__({unquote(adapter), unquote(opts)})
	end

	defp generate_http_verbs(opts) do
	only = Keyword.get(opts, :only, @http_verbs)
	except = Keyword.get(opts, :except, [])

	@http_verbs
	\|> Enum.filter(&(&1 in only && not &1 in except))
	\|> Enum.map(&generate_api(&1, Keyword.get(opts, :docs, true)))
	end

	defp generate_api(method, docs) when method in [:post, :put, :patch] do
	quote do
	if unquote(docs) do
	@doc """
	Perform a #{unquote(method \|> to_string \|> String.upcase())} request.
	See `request/1` or `request/2` for options definition.

	Example
	myclient \|> ExampleApi.#{unquote(method)}("/users", %{name: "Jon"}, query: [scope: "admin"])
	"""
	@spec unquote(method)(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option]) ::
	Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(%Tesla.Client{} = client, url, body, options) when is_list(options) do
	request(client, [method: unquote(method), url: url, body: body] ++ options)
	end

	# fallback to keep backward compatibility
	def unquote(method)(fun, url, body, options) when is_function(fun) and is_list(options) do
	unquote(method)(%Tesla.Client{fun: fun}, url, body, options)
	end

	if unquote(docs) do
	@doc """
	Perform a #{unquote(method \|> to_string \|> String.upcase())} request.
	See `request/1` or `request/2` for options definition.

	Example
	myclient \|> ExampleApi.#{unquote(method)}("/users", %{name: "Jon"})
	ExampleApi.#{unquote(method)}("/users", %{name: "Jon"}, query: [scope: "admin"])
	"""
	@spec unquote(method)(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body()) ::
	Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(%Tesla.Client{} = client, url, body) do
	request(client, method: unquote(method), url: url, body: body)
	end

	# fallback to keep backward compatibility
	def unquote(method)(fun, url, body) when is_function(fun) do
	unquote(method)(%Tesla.Client{fun: fun}, url, body)
	end

	if unquote(docs) do
	@spec unquote(method)(Tesla.Env.url(), Tesla.Env.body(), [option]) :: Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(url, body, options) when is_list(options) do
	request([method: unquote(method), url: url, body: body] ++ options)
	end

	if unquote(docs) do
	@doc """
	Perform a #{unquote(method \|> to_string \|> String.upcase())} request.
	See `request/1` or `request/2` for options definition.

	Example
	ExampleApi.#{unquote(method)}("/users", %{name: "Jon"})
	"""
	@spec unquote(method)(Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(url, body) do
	request(method: unquote(method), url: url, body: body)
	end
	end
	end

	defp generate_api(method, docs) when method in [:head, :get, :delete, :trace, :options] do
	quote do
	if unquote(docs) do
	@doc """
	Perform a #{unquote(method \|> to_string \|> String.upcase())} request.
	See `request/1` or `request/2` for options definition.

	Example
	myclient \|> ExampleApi.#{unquote(method)}("/users", query: [page: 1])
	"""
	@spec unquote(method)(Tesla.Env.client(), Tesla.Env.url(), [option]) :: Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(%Tesla.Client{} = client, url, options) when is_list(options) do
	request(client, [method: unquote(method), url: url] ++ options)
	end

	# fallback to keep backward compatibility
	def unquote(method)(fun, url, options) when is_function(fun) and is_list(options) do
	unquote(method)(%Tesla.Client{fun: fun}, url, options)
	end

	if unquote(docs) do
	@doc """
	Perform a #{unquote(method \|> to_string \|> String.upcase())} request.
	See `request/1` or `request/2` for options definition.

	Example
	myclient \|> ExampleApi.#{unquote(method)}("/users")
	ExampleApi.#{unquote(method)}("/users", query: [page: 1])
	"""
	@spec unquote(method)(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(%Tesla.Client{} = client, url) do
	request(client, method: unquote(method), url: url)
	end

	# fallback to keep backward compatibility
	def unquote(method)(fun, url) when is_function(fun) do
	unquote(method)(%Tesla.Client{fun: fun}, url)
	end

	if unquote(docs) do
	@spec unquote(method)(Tesla.Env.url(), [option]) :: Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(url, options) when is_list(options) do
	request([method: unquote(method), url: url] ++ options)
	end

	if unquote(docs) do
	@doc """
	Perform a #{unquote(method \|> to_string \|> String.upcase())} request.
	See `request/1` or `request/2` for options definition.

	Example
	ExampleApi.#{unquote(method)}("/users")
	"""
	@spec unquote(method)(Tesla.Env.url()) :: Tesla.Env.t()
	else
	@doc false
	end

	def unquote(method)(url) do
	request(method: unquote(method), url: url)
	end
	end
	end

	defmacro __before_compile__(env) do
	adapter = Module.get_attribute(env.module, :__adapter__)
	middleware = Module.get_attribute(env.module, :__middleware__) \|> Enum.reverse()

	quote do
	def __middleware__, do: unquote(middleware)
	def __adapter__, do: Tesla.adapter(__MODULE__, unquote(adapter))
	end
	end
	end

	defmodule Tesla do
	use Tesla.Builder

	@moduledoc """
	A HTTP toolkit for building API clients using middlewares

	Include Tesla module in your api client:

	```ex
	defmodule ExampleApi do
	use Tesla

	plug Tesla.Middleware.BaseUrl, "http://api.example.com"
	plug Tesla.Middleware.JSON
	end
	"""

	defmacro __using__(opts \\ []) do
	quote do
	use Tesla.Builder, unquote(opts)
	end
	end

	def perform_request(module, client \\ nil, options) do
	%{fun: fun, pre: pre, post: post} = client \|\| %Tesla.Client{}

	stack =
	pre ++
	prepare(module, List.wrap(fun) ++ module.__middleware__ ++ default_middleware()) ++
	post ++ prepare(module, [module.__adapter__])

	env = struct(Tesla.Env, options ++ [__module__: module, __client__: client])
	run(env, stack)
	end

	@spec prepare(atom, [any]) :: Tesla.Env.stack()
	def prepare(module, stack) do
	Enum.map(stack, fn
	{name, opts} -> prepare_module(module, name, opts)
	name when is_atom(name) -> prepare_module(module, name, nil)
	fun when is_function(fun) -> {:fn, fun}
	end)
	end

	defp prepare_module(module, name, opts) do
	case Atom.to_charlist(name) do
	~c"Elixir." ++ _ -> {name, :call, [opts]}
	_ -> {module, name}
	end
	end

	# empty stack case is useful for reusing/testing middlewares (just pass [] as next)
	def run(env, []), do: env

	# last item in stack is adapter - skip passing rest of stack
	def run(env, [{:fn, f}]), do: apply(f, [env])
	def run(env, [{m, f}]), do: apply(m, f, [env])
	def run(env, [{m, f, a}]), do: apply(m, f, [env \| a])

	# for all other elements pass (env, next, opts)
	def run(env, [{:fn, f} \| rest]), do: apply(f, [env, rest])
	def run(env, [{m, f} \| rest]), do: apply(m, f, [env, rest])
	def run(env, [{m, f, a} \| rest]), do: apply(m, f, [env, rest \| a])

	# useful helper fuctions
	def put_opt(env, key, value) do
	Map.update!(env, :opts, &Keyword.put(&1, key, value))
	end

	@spec get_header(Tesla.Env.t, binary) :: binary \| nil
	def get_header(%Tesla.Env{headers: headers}, key) when is_list(headers) do
	case List.keyfind(headers, key, 0) do
	{_, value} -> value
	_ -> nil
	end
	end

	@spec get_headers(Tesla.Env.t, binary) :: [binary]
	def get_headers(%Tesla.Env{headers: headers}, key) do
	for {k,v} <- headers, k == key, do: v
	end

	@spec put_header(Tesla.Env.t, binary, binary) :: Tesla.Env.t
	def put_header(env, key, value) do
	headers = List.keystore(env.headers, key, 0, {key, value})
	%{env \| headers: headers}
	end

	@spec put_headers(Tesla.Env.t, [{binary, binary}]) :: Tesla.Env.t
	def put_headers(env, list) when is_list(list) do
	%{env \| headers: env.headers ++ list}
	end

	@spec delete_header(Tesla.Env.t, binary) :: Tesla.Env.t
	def delete_header(env, key) do
	headers = for {k,v} <- env.headers, k != key, do: {k,v}
	%{env \| headers: headers}
	end

	def adapter(module, custom) do
	module_adapter_from_config(module) \|\| custom \|\| default_adapter()
	end

	defp module_adapter_from_config(module) do
	Application.get_env(:tesla, module, [])[:adapter]
	end

	def default_adapter do
	Application.get_env(:tesla, :adapter, Tesla.Adapter.Httpc)
	end

	def run_default_adapter(env, opts \\ []) do
	apply(default_adapter(), :call, [env, opts])
	end

	def default_middleware do
	- [{Tesla.Middleware.Normalize, nil}]
	+ []
	end

	@doc """
	Dynamically build client from list of middlewares.

	```ex
	defmodule ExampleAPI do
	use Tesla

	def new(token) do
	Tesla.build_client([
	{Tesla.Middleware.Headers, %{"Authorization" => token}}
	])
	end
	end

	client = ExampleAPI.new(token: "abc")
	client \|> ExampleAPI.get("/me")
	```
	"""
	defmacro build_client(pre, post \\ []) do
	quote do
	%Tesla.Client{
	pre: Tesla.prepare(__MODULE__, unquote(pre)),
	post: Tesla.prepare(__MODULE__, unquote(post))
	}
	end
	end

	def build_adapter(fun) do
	%Tesla.Client{post: [{:fn, fn env, _next -> fun.(env) end}]}
	end

	def build_url(url, []), do: url

	def build_url(url, query) do
	join = if String.contains?(url, "?"), do: "&", else: "?"
	url <> join <> encode_query(query)
	end

	defp encode_query(query) do
	query
	\|> Enum.flat_map(&encode_pair/1)
	\|> URI.encode_query()
	end

	defp encode_pair({key, value}) when is_list(value) do
	if Keyword.keyword?(value) do
	Enum.flat_map(value, fn {k, v} -> encode_pair({"#{key}[#{k}]", v}) end)
	else
	Enum.map(value, fn e -> {"#{key}[]", e} end)
	end
	end

	defp encode_pair({key, value}), do: [{key, value}]
	end
	diff --git a/test/tesla/middleware/fuse_test.exs b/test/tesla/middleware/fuse_test.exs
	index c101289..a1f2da8 100644
	--- a/test/tesla/middleware/fuse_test.exs
	+++ b/test/tesla/middleware/fuse_test.exs
	@@ -1,47 +1,47 @@
	defmodule Tesla.Middleware.FuseTest do
	use ExUnit.Case, async: false

	defmodule Client do
	use Tesla

	plug Tesla.Middleware.Fuse
	plug :report

	def report(env, next) do
	send(self(), :request_made)
	Tesla.run(env, next)
	end

	adapter fn env ->
	case env.url do
	"/ok" -> env
	- "/unavailable" -> {:error, :econnrefused}
	+ "/unavailable" -> raise %Tesla.Error{message: "adapter error: :econnrefused}", reason: :econnrefused}
	end
	end
	end

	setup do
	Application.ensure_all_started(:fuse)
	:fuse.reset(Client)

	:ok
	end

	test "regular endpoint" do
	assert %Tesla.Env{url: "/ok"} = Client.get("/ok")
	end

	test "unavailable endpoint" do
	assert {:error, :unavailable} = Client.get("/unavailable")
	assert_receive :request_made
	assert {:error, :unavailable} = Client.get("/unavailable")
	assert_receive :request_made
	assert {:error, :unavailable} = Client.get("/unavailable")
	assert_receive :request_made

	assert {:error, :unavailable} = Client.get("/unavailable")
	refute_receive :request_made
	assert {:error, :unavailable} = Client.get("/unavailable")
	refute_receive :request_made
	end
	end
	diff --git a/test/tesla/middleware/retry_test.exs b/test/tesla/middleware/retry_test.exs
	index dba2fe0..05d6d76 100644
	--- a/test/tesla/middleware/retry_test.exs
	+++ b/test/tesla/middleware/retry_test.exs
	@@ -1,58 +1,62 @@
	defmodule Tesla.Middleware.RetryTest do
	use ExUnit.Case, async: false

	defmodule LaggyAdapter do
	def start_link, do: Agent.start_link(fn -> 0 end, name: __MODULE__)

	def call(env, _opts) do
	Agent.get_and_update(__MODULE__, fn retries ->
	response =
	case env.url do
	"/ok" -> env
	"/maybe" when retries < 5 -> {:error, :econnrefused}
	"/maybe" -> env
	"/nope" -> {:error, :econnrefused}
	end

	{response, retries + 1}
	end)
	+ \|> case do
	+ {:error, :econnrefused} -> raise %Tesla.Error{message: "adapter error: :econnrefused}", reason: :econnrefused}
	+ env -> env
	+ end
	end
	end

	defmodule Client do
	use Tesla

	plug Tesla.Middleware.Retry, delay: 10, max_retries: 10

	adapter LaggyAdapter
	end

	setup do
	{:ok, _} = LaggyAdapter.start_link()
	:ok
	end

	test "pass on successful request" do
	assert %Tesla.Env{url: "/ok", method: :get} = Client.get("/ok")
	end

	test "finally pass on laggy request" do
	assert %Tesla.Env{url: "/maybe", method: :get} = Client.get("/maybe")
	end

	test "raise if max_retries is exceeded" do
	assert_raise Tesla.Error, fn -> Client.get("/nope") end
	end

	defmodule DefunctClient do
	use Tesla

	plug Tesla.Middleware.Retry

	adapter fn _ -> raise "runtime-error" end
	end

	test "raise in case or unexpected error" do
	assert_raise RuntimeError, fn -> DefunctClient.get("/blow") end
	end
	end
	diff --git a/test/tesla/middleware/tuples_test.exs b/test/tesla/middleware/tuples_test.exs
	index dc785dc..d226040 100644
	--- a/test/tesla/middleware/tuples_test.exs
	+++ b/test/tesla/middleware/tuples_test.exs
	@@ -1,47 +1,47 @@
	defmodule Tesla.Middleware.TuplesTest do
	use ExUnit.Case, async: false

	defmodule(Custom1, do: defexception(message: "Custom 1"))
	defmodule(Custom2, do: defexception(message: "Custom 2"))

	defmodule Client do
	use Tesla

	plug Tesla.Middleware.Tuples, rescue_errors: [Custom1]
	plug Tesla.Middleware.JSON

	adapter fn env ->
	case env.url do
	"/ok" -> env
	- "/econnrefused" -> {:error, :econnrefused}
	+ "/econnrefused" -> raise %Tesla.Error{message: "adapter error: :econnrefused}", reason: :econnrefused}
	"/custom-1" -> raise %Custom1{}
	"/custom-2" -> raise %Custom2{}
	end
	end
	end

	defmodule DefaultClient do
	use Tesla

	plug Tesla.Middleware.Tuples

	adapter fn _ -> raise %Custom1{} end
	end

	test "return {:ok, env} for successful transaction" do
	assert {:ok, %Tesla.Env{}} = Client.get("/ok")
	end

	test "return {:error, reason} for unsuccessful transaction" do
	assert {:error, %Tesla.Error{}} = Client.get("/econnrefused")
	end

	test "rescue listed custom exception" do
	assert {:error, %Custom1{}} = Client.get("/custom-1")
	end

	test "do not rescue not-listed custom exception" do
	assert catch_error(Client.get("/custom-2"))
	assert catch_error(DefaultClient.get("/"))
	end
	end

File Metadata

Mime Type: text/x-diff
Expires: Mon, Nov 25, 9:26 AM (1 d, 12 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 39753
Default Alt Text: (21 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions