Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Custom client implementation. #133

Closed
wants to merge 1 commit into from
Closed

Custom client implementation. #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 45 additions & 18 deletions lib/tesla.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ defmodule Tesla.Env do
end

defmodule Tesla.Client do
@type t :: %__MODULE__{
@type t :: %{
__struct__: atom,
fun: (Tesla.Env.t, Tesla.Env.stack -> Tesla.Env.t),
pre: Tesla.Env.stack,
post: Tesla.Env.stack
Expand All @@ -62,6 +63,10 @@ defmodule Tesla.Builder do
opts = Macro.prewalk(opts, &Macro.expand(&1, __CALLER__))
docs = Keyword.get(opts, :docs, true)

module = Keyword.get(opts, :client, Tesla.Client)
generate_client_struct(module)
opts = Keyword.put(opts, :client, module)

quote do
Module.register_attribute(__MODULE__, :__middleware__, accumulate: true)
Module.register_attribute(__MODULE__, :__adapter__, [])
Expand Down Expand Up @@ -104,7 +109,7 @@ defmodule Tesla.Builder do
else
@doc false
end
def request(%Tesla.Client{} = client, options) do
def request(%unquote(module){} = client, options) do
Tesla.perform_request(__MODULE__, client, options)
end

Expand Down Expand Up @@ -193,16 +198,32 @@ defmodule Tesla.Builder do
quote do: @__adapter__ {unquote(adapter), unquote(opts)}
end

defp generate_client_struct(module) do
unless Code.ensure_loaded?(module) do
defmodule module do
@type t :: %__MODULE__{
fun: (Tesla.Env.t, Tesla.Env.stack -> Tesla.Env.t),
pre: Tesla.Env.stack,
post: Tesla.Env.stack
}
defstruct fun: nil,
pre: [],
post: []
end
end
end

defp generate_http_verbs(opts) do
client = Keyword.fetch!(opts, :client)
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)))
|> Enum.map(&generate_api(&1, client, Keyword.get(opts, :docs, true)))
end

defp generate_api(method, docs) when method in [:post, :put, :patch] do
defp generate_api(method, client, docs) when method in [:post, :put, :patch] do
quote do
if unquote(docs) do
@doc """
Expand All @@ -216,13 +237,13 @@ defmodule Tesla.Builder do
else
@doc false
end
def unquote(method)(%Tesla.Client{} = client, url, body, options) when is_list(options) do
def unquote(method)(%unquote(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)
unquote(method)(%unquote(client){fun: fun}, url, body, options)
end

if unquote(docs) do
Expand All @@ -238,13 +259,13 @@ defmodule Tesla.Builder do
else
@doc false
end
def unquote(method)(%Tesla.Client{} = client, url, body) do
def unquote(method)(%unquote(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)
unquote(method)(%unquote(client){fun: fun}, url, body)
end

if unquote(docs) do
Expand Down Expand Up @@ -274,7 +295,7 @@ defmodule Tesla.Builder do
end
end

defp generate_api(method, docs) when method in [:head, :get, :delete, :trace, :options] do
defp generate_api(method, client, docs) when method in [:head, :get, :delete, :trace, :options] do
quote do
if unquote(docs) do
@doc """
Expand All @@ -288,13 +309,13 @@ defmodule Tesla.Builder do
else
@doc false
end
def unquote(method)(%Tesla.Client{} = client, url, options) when is_list(options) do
def unquote(method)(%unquote(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)
unquote(method)(%unquote(client){fun: fun}, url, options)
end

if unquote(docs) do
Expand All @@ -310,13 +331,13 @@ defmodule Tesla.Builder do
else
@doc false
end
def unquote(method)(%Tesla.Client{} = client, url) do
def unquote(method)(%unquote(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)
unquote(method)(%unquote(client){fun: fun}, url)
end

if unquote(docs) do
Expand Down Expand Up @@ -398,7 +419,7 @@ defmodule Tesla do
def alias(key), do: key

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

stack = pre
++ prepare(module, List.wrap(fun) ++ module.__middleware__ ++ default_middleware())
Expand Down Expand Up @@ -481,17 +502,23 @@ defmodule Tesla do
client |> ExampleAPI.get("/me")
```
"""
defmacro build_client(pre, post \\ []) do
defmacro build_client(client \\ Tesla.Client, pre, post \\ []) do
{client, pre, post} = if is_list(client) do
{Tesla.Client, client, pre}
else
{client, pre, post}
end

quote do
%Tesla.Client{
%unquote(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}]}
def build_adapter(client \\ Tesla.Client, fun) do
struct(client, post: [{:fn, fn env, _next -> fun.(env) end}])
end

def build_url(url, []), do: url
Expand Down
20 changes: 20 additions & 0 deletions test/tesla_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,26 @@ defmodule TeslaTest do
end
end

describe "Custom client" do
defmodule CustomClient do
use Tesla, client: CustomClient.Client
end

test "calls work with custom client client" do
assert %{status: 200} = CustomClient.get(%CustomClient.Client{}, @url <> "/")
end

test "calls do not accept normal clients" do
assert_raise FunctionClauseError, fn ->
CustomClient.get(%Tesla.Client{}, @url <> "/")
end
end

test "calls defaults to the custom client" do
assert %{status: 200} = CustomClient.get(@url <> "/")
end
end

describe "request API" do
defmodule SimpleClient do
use Tesla
Expand Down