diff options
author | Samuel Seay <sam@manuka.co> | 2016-09-05 20:20:54 +1200 |
---|---|---|
committer | Samuel Seay <sam@manuka.co> | 2016-09-05 20:20:54 +1200 |
commit | a3a1fa993d09f23619a6605bce7d3e0824ba096c (patch) | |
tree | e160e65c649f084b2ad7ac70af6cd8ea89415ece /lib | |
parent | ba60e34e37848b4b7ee49f26789664c095baeb6d (diff) | |
download | recaptcha-a3a1fa993d09f23619a6605bce7d3e0824ba096c.tar.gz recaptcha-a3a1fa993d09f23619a6605bce7d3e0824ba096c.tar.xz |
Add strict credo checks to build, fix line length issues.
Diffstat (limited to 'lib')
-rw-r--r-- | lib/recaptcha.ex | 27 | ||||
-rw-r--r-- | lib/recaptcha/http.ex | 22 | ||||
-rw-r--r-- | lib/recaptcha/http/mock_http_client.ex | 3 | ||||
-rw-r--r-- | lib/recaptcha/template.ex | 4 |
4 files changed, 41 insertions, 15 deletions
diff --git a/lib/recaptcha.ex b/lib/recaptcha.ex index 0037480..ed7e9b7 100644 --- a/lib/recaptcha.ex +++ b/lib/recaptcha.ex @@ -2,7 +2,8 @@ defmodule Recaptcha do @moduledoc """ A module for verifying reCAPTCHA version 2.0 response strings. - See the [documentation](https://developers.google.com/recaptcha/docs/verify) for more details. + See the [documentation](https://developers.google.com/recaptcha/docs/verify) + for more details. """ @secret Application.get_env(:recaptcha, :secret) @http_client Application.get_env(:recaptcha, :http_client, Recaptcha.Http) @@ -13,14 +14,17 @@ defmodule Recaptcha do ## Options * `:timeout` - the timeout for the request (defaults to 5000ms) - * `:secret` - the secret key used by recaptcha (defaults to the secret provided in application config) + * `:secret` - the secret key used by recaptcha (defaults to the secret + provided in application config) * `:remote_ip` - the IP address of the user (optional and not set by default) ## Example {:ok, api_response} = Recaptcha.verify("response_string") """ - @spec verify(String.t, [timeout: integer, secret: String.t, remote_ip: String.t]) :: {:ok, Recaptcha.Response.t} | {:error, [atom]} + @spec verify(String.t, [timeout: integer, secret: String.t, + remote_ip: String.t]) :: {:ok, Recaptcha.Response.t} | + {:error, [atom]} def verify(response, options \\ []) def verify(nil = _response, _) do @@ -28,10 +32,16 @@ defmodule Recaptcha do end def verify(response, options) do - case @http_client.request_verification(request_body(response, options), Keyword.take(options, [:timeout])) do - {:error, errors} -> {:error, errors} - {:ok, %{"success" => false, "error-codes" => errors}} -> {:error, Enum.map(errors, fn(error) -> atomise_api_error(error) end) } - {:ok, %{"success" => true, "challenge_ts" => timestamp, "hostname" => host}} -> {:ok, %Recaptcha.Response{challenge_ts: timestamp, hostname: host}} + case @http_client.request_verification( + request_body(response, options), + Keyword.take(options, [:timeout]) + ) do + {:error, errors} -> + {:error, errors} + {:ok, %{"success" => false, "error-codes" => errors}} -> + {:error, Enum.map(errors, fn(error) -> atomise_api_error(error) end)} + {:ok, %{"success" => true, "challenge_ts" => timestamp, "hostname" => host}} -> + {:ok, %Recaptcha.Response{challenge_ts: timestamp, hostname: host}} end end @@ -47,7 +57,8 @@ defmodule Recaptcha do end defp atomise_api_error(error) do - String.replace(error, "-", "_") + error + |> String.replace("-", "_") |> String.to_atom end end diff --git a/lib/recaptcha/http.ex b/lib/recaptcha/http.ex index 01c088a..0182a7c 100644 --- a/lib/recaptcha/http.ex +++ b/lib/recaptcha/http.ex @@ -2,14 +2,18 @@ defmodule Recaptcha.Http do @moduledoc """ Responsible for managing HTTP requests to the reCAPTCHA API """ - @headers [{"Content-type", "application/x-www-form-urlencoded"}, {"Accept", "application/json"}] + @headers [ + {"Content-type", "application/x-www-form-urlencoded"}, + {"Accept", "application/json"} + ] @url Application.get_env(:recaptcha, :verify_url) @timeout Application.get_env(:recaptcha, :timeout, 5000) @doc """ Sends an HTTP request to the reCAPTCHA version 2.0 API. - See the [documentation](https://developers.google.com/recaptcha/docs/verify#api-response) for more details on the API response. + See the [docs](https://developers.google.com/recaptcha/docs/verify#api-response) + for more details on the API response. ## Options @@ -17,12 +21,22 @@ defmodule Recaptcha.Http do ## Example - {:ok, %{ "success" => success, "challenge_ts" => ts, "hostname" => host, "error-codes" => errors}} = Recaptcha.Http.request_verification(%{ secret: "secret", response: "response", remote_ip: "remote_ip"}) + {:ok, %{ + "success" => success, + "challenge_ts" => ts, + "hostname" => host, + "error-codes" => errors + }} = Recaptcha.Http.request_verification(%{ + secret: "secret", + response: "response", + remote_ip: "remote_ip" + }) """ @spec request_verification(map, [timeout: integer]) :: {:ok, map} | {:error, [atom]} def request_verification(body, options \\ []) do + timeout = options[:timeout] || @timeout result = - with {:ok, response} <- HTTPoison.post(@url, body, @headers, timeout: options[:timeout] || @timeout), + with {:ok, response} <- HTTPoison.post(@url, body, @headers, timeout: timeout), {:ok, data} <- Poison.decode(response.body) do {:ok, data} end diff --git a/lib/recaptcha/http/mock_http_client.ex b/lib/recaptcha/http/mock_http_client.ex index 2355dd3..492376a 100644 --- a/lib/recaptcha/http/mock_http_client.ex +++ b/lib/recaptcha/http/mock_http_client.ex @@ -2,6 +2,7 @@ defmodule Recaptcha.Http.MockClient do @moduledoc """ A mock HTTP client used for testing. """ + alias Recaptcha.Http def request_verification(body, options \\ []) @@ -13,6 +14,6 @@ defmodule Recaptcha.Http.MockClient do # every other match is a pass through to the real client def request_verification(body, options) do send self(), {:request_verification, body, options} - Recaptcha.Http.request_verification(body, options) + Http.request_verification(body, options) end end diff --git a/lib/recaptcha/template.ex b/lib/recaptcha/template.ex index d644266..28db29c 100644 --- a/lib/recaptcha/template.ex +++ b/lib/recaptcha/template.ex @@ -2,8 +2,8 @@ defmodule Recaptcha.Template do @moduledoc """ Responsible for rendering boilerplate recaptcha HTML code, supports noscript fallback. - Currently the [explicit render](https://developers.google.com/recaptcha/docs/display#explicit_render) functionality - is not supported. + [Some](https://developers.google.com/recaptcha/docs/display#explicit_render) + functionality is not currently supported. In future this module may be separated out into a Phoenix specific library. """ |