Skip to content

Commit 35d26e0

Browse files
danschultzerdanschultzer
committed
Refactor decode_response/2
1 parent 949a3fc commit 35d26e0

File tree

4 files changed

+112
-54
lines changed

4 files changed

+112
-54
lines changed

‎CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
* `Assent.Strategy.Twitch` added
1111
* `Assent.Strategy.OAuth2` now supports PKCE
1212
* `Assent.Strategy.OAuth2.Base.authorize_url/2` incomplete typespec fixed
13+
* `Assent.Strategy.decode_response/2` deprecated accepting result tuples and now accepts `Assent.HTTPAdapter.HTTPResponse` structs
14+
1315

1416
## v0.2.10 (2024-04-11)
1517

‎lib/assent.ex

+28
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ defmodule Assent do
88
defmodule CallbackCSRFError do
99
defexception [:key]
1010

11+
@type t :: %__MODULE__{
12+
key: binary()
13+
}
14+
1115
def message(exception) do
1216
"CSRF detected with param key #{inspect(exception.key)}"
1317
end
@@ -16,6 +20,11 @@ defmodule Assent do
1620
defmodule MissingParamError do
1721
defexception [:expected_key, :params]
1822

23+
@type t :: %__MODULE__{
24+
expected_key: binary(),
25+
params: map()
26+
}
27+
1928
def message(exception) do
2029
expected_key = inspect(exception.expected_key)
2130
params = inspect(Map.keys(exception.params))
@@ -29,6 +38,11 @@ defmodule Assent do
2938

3039
alias Assent.HTTPAdapter.HTTPResponse
3140

41+
@type t :: %__MODULE__{
42+
message: binary(),
43+
response: HTTPResponse.t()
44+
}
45+
3246
def message(exception) do
3347
"""
3448
#{exception.message}
@@ -43,6 +57,10 @@ defmodule Assent do
4357

4458
alias Assent.HTTPAdapter.HTTPResponse
4559

60+
@type t :: %__MODULE__{
61+
response: HTTPResponse.t()
62+
}
63+
4664
def message(exception) do
4765
"""
4866
An invalid response was received.
@@ -57,6 +75,10 @@ defmodule Assent do
5775

5876
alias Assent.HTTPAdapter.HTTPResponse
5977

78+
@type t :: %__MODULE__{
79+
response: HTTPResponse.t()
80+
}
81+
6082
def message(exception) do
6183
"""
6284
An unexpected response was received.
@@ -69,6 +91,12 @@ defmodule Assent do
6991
defmodule ServerUnreachableError do
7092
defexception [:http_adapter, :request_url, :reason]
7193

94+
@type t :: %__MODULE__{
95+
http_adapter: module(),
96+
request_url: binary(),
97+
reason: term()
98+
}
99+
72100
def message(exception) do
73101
[url | _rest] = String.split(exception.request_url, "?", parts: 2)
74102

‎lib/assent/strategy.ex

+27-13
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ defmodule Assent.Strategy do
2626
end
2727
end
2828
"""
29-
alias Assent.{Config, HTTPAdapter.HTTPResponse, ServerUnreachableError}
29+
alias Assent.{Config, HTTPAdapter.HTTPResponse, InvalidResponseError, ServerUnreachableError}
3030

3131
@callback authorize_url(Config.t()) ::
3232
{:ok, %{:url => binary(), optional(atom()) => any()}} | {:error, term()}
@@ -45,7 +45,7 @@ defmodule Assent.Strategy do
4545
|> http_adapter.request(url, body, headers, opts)
4646
|> case do
4747
{:ok, response} ->
48-
decode_response({:ok, response}, config)
48+
decode_response(response, config)
4949

5050
{:error, error} ->
5151
{:error,
@@ -87,23 +87,35 @@ defmodule Assent.Strategy do
8787
end
8888

8989
@doc """
90-
Decodes a request response.
90+
Decodes request response body.
9191
"""
92-
@spec decode_response(
93-
{:ok, HTTPResponse.t()} | {:error, HTTPResponse.t()} | {:error, term()},
94-
Config.t()
95-
) :: {:ok, HTTPResponse.t()} | {:error, HTTPResponse.t()} | {:error, term()}
96-
def decode_response({ok_or_error, %{body: body, headers: headers} = resp}, config)
97-
when is_binary(body) do
98-
case decode_body(headers, body, config) do
99-
{:ok, body} -> {ok_or_error, %{resp | body: body}}
92+
@spec decode_response(HTTPResponse.t(), Config.t()) ::
93+
{:ok, HTTPResponse.t()} | {:error, InvalidResponseError.t()}
94+
def decode_response(%HTTPResponse{} = response, config) do
95+
case decode(response.headers, response.body, config) do
96+
{:ok, body} -> {:ok, %{response | body: body}}
97+
{:error, _error} -> {:error, InvalidResponseError.exception(response: response)}
98+
end
99+
end
100+
101+
# TODO: Remove in 0.3 release
102+
def decode_response({res, %HTTPResponse{} = response}, config) do
103+
IO.warn("Passing {:ok | :error, response} to decode_response/2 is deprecated")
104+
105+
case decode(response.headers, response.body, config) do
106+
{:ok, body} -> {res, %{response | body: body}}
100107
{:error, error} -> {:error, error}
101108
end
102109
end
103110

104-
def decode_response(any, _config), do: any
111+
# TODO: Remove in 0.3 release
112+
def decode_response({:error, error}, _config) do
113+
IO.warn("Passing {:error, error} to decode_response/2 is deprecated")
105114

106-
defp decode_body(headers, body, config) do
115+
{:error, error}
116+
end
117+
118+
defp decode(headers, body, config) when is_binary(body) do
107119
case List.keyfind(headers, "content-type", 0) do
108120
{"content-type", "application/json" <> _rest} ->
109121
decode_json(body, config)
@@ -119,6 +131,8 @@ defmodule Assent.Strategy do
119131
end
120132
end
121133

134+
defp decode(_headers, body, _config), do: {:ok, body}
135+
122136
@doc """
123137
Decode a JSON response to a map
124138
"""

‎test/assent/strategy_test.exs

+55-41
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,62 @@ defmodule Assent.StrategyTest do
22
use Assent.TestCase
33
doctest Assent.Strategy
44

5-
alias Assent.{HTTPAdapter.HTTPResponse, Strategy}
5+
alias Assent.{HTTPAdapter.HTTPResponse, InvalidResponseError, Strategy}
66

7-
test "decode_response/2" do
8-
expected = %{"a" => "1", "b" => "2"}
9-
10-
headers = [{"content-type", "application/json"}]
11-
body = @json_library.encode!(expected)
12-
13-
assert Strategy.decode_response({:ok, %{body: body, headers: headers}}, []) ==
14-
{:ok, %{body: expected, headers: headers}}
15-
16-
assert Strategy.decode_response({:error, %{body: body, headers: headers}}, []) ==
17-
{:error, %{body: expected, headers: headers}}
18-
19-
headers = [{"content-type", "application/json; charset=utf-8"}]
20-
21-
assert Strategy.decode_response({:ok, %{body: body, headers: headers}}, []) ==
22-
{:ok, %{body: expected, headers: headers}}
23-
24-
headers = [{"content-type", "text/javascript"}]
25-
26-
assert Strategy.decode_response({:ok, %{body: body, headers: headers}}, []) ==
27-
{:ok, %{body: expected, headers: headers}}
7+
@body %{"a" => "1", "b" => "2"}
8+
@headers [{"content-type", "application/json"}]
9+
@json_encoded_body @json_library.encode!(@body)
10+
@uri_encoded_body URI.encode_query(@body)
2811

29-
headers = [{"content-type", "application/x-www-form-urlencoded"}]
30-
body = URI.encode_query(expected)
31-
32-
assert Strategy.decode_response({:ok, %{body: body, headers: headers}}, []) ==
33-
{:ok, %{body: expected, headers: headers}}
34-
35-
headers = [{"content-type", "application/x-www-form-urlencoded; charset=utf-8"}]
36-
37-
assert Strategy.decode_response({:ok, %{body: body, headers: headers}}, []) ==
38-
{:ok, %{body: expected, headers: headers}}
39-
40-
assert Strategy.decode_response({:error, "error reason"}, []) == {:error, "error reason"}
12+
test "decode_response/2" do
13+
assert {:ok, response} =
14+
Strategy.decode_response(
15+
%HTTPResponse{body: @json_encoded_body, headers: @headers},
16+
[]
17+
)
18+
19+
assert response.body == @body
20+
21+
assert {:ok, response} =
22+
Strategy.decode_response(
23+
%HTTPResponse{
24+
body: @json_encoded_body,
25+
headers: [{"content-type", "application/json; charset=utf-8"}]
26+
},
27+
[]
28+
)
29+
30+
assert response.body == @body
31+
32+
assert {:ok, response} =
33+
Strategy.decode_response(
34+
%HTTPResponse{
35+
body: @json_encoded_body,
36+
headers: [{"content-type", "text/javascript"}]
37+
},
38+
[]
39+
)
40+
41+
assert response.body == @body
42+
43+
assert {:ok, response} =
44+
Strategy.decode_response(
45+
%HTTPResponse{
46+
body: @uri_encoded_body,
47+
headers: [{"content-type", "application/x-www-form-urlencoded"}]
48+
},
49+
[]
50+
)
51+
52+
assert response.body == @body
53+
54+
assert {:ok, response} = Strategy.decode_response(%HTTPResponse{body: @body, headers: []}, [])
55+
assert response.body == @body
56+
57+
assert {:error, %InvalidResponseError{} = error} =
58+
Strategy.decode_response(%HTTPResponse{body: "%", headers: @headers}, [])
59+
60+
assert error.response.body == "%"
4161
end
4262

4363
defmodule JSONMock do
@@ -172,15 +192,9 @@ defmodule Assent.StrategyTest do
172192
request_url: "json-encoded-body-text/javascript-header"
173193
}}
174194

175-
assert {:error, error} =
195+
assert {:error, %InvalidResponseError{}} =
176196
Strategy.request(:get, "invalid-json-body", nil, [], http_adapter: HTTPMock)
177197

178-
if unquote(@json_library == Jason) do
179-
assert %Jason.DecodeError{} = error
180-
else
181-
assert error == {:invalid_byte, 0, 37}
182-
end
183-
184198
assert Strategy.request(:get, "json-no-headers", nil, [], http_adapter: HTTPMock) ==
185199
{:ok,
186200
%HTTPResponse{

0 commit comments

Comments
 (0)