Deprecate Config module

Author: danschultzer

CHANGELOG.md

@@ -16,6 +16,11 @@
 * `Assent.Strategy.decode_response/2` deprecated accepting result tuples and now accepts `Assent.HTTPAdapter.HTTPResponse` structs
 * `Assent.Strategy.request/5` deprecated in favor of `Assent.Strategy.http_request/5`
 * `Assent.Strategy.decode_response/2` deprecated in favor of `Assent.HTTPAdapter.decode_response/2`
+* `Assent.Config.get/3` deprecated in favor of `Keyword.get/3`
+* `Assent.Config.put/3` deprecated in favor of `Keyword.put/3`
+* `Assent.Config.merge/2` deprecated in favor of `Keyword.merge/2`
+* `Assent.Config.t()` type deprecated in favor of `Keyword.t()` type
+* `Assent.Config.fetch/2` deprecated in favor of `Assent.fetch_config/2`
 
 ## v0.2.10 (2024-04-11)
 

README.md

@@ -137,7 +137,7 @@ defmodule ProviderAuth do
 
     @config
     # Session params should be added to the config so the strategy can use them
-    |> Config.put(:session_params, session_params)
+    |> Keyword.put(:session_params, session_params)
     |> Github.callback(params)
     |> case do
       {:ok, %{user: user, token: token}} ->
@@ -166,8 +166,6 @@ config :my_app, :strategies,
 
 ```elixir
 defmodule MultiProviderAuth do
-  alias Assent.Config
-
   @spec request(atom()) :: {:ok, map()} | {:error, term()}
   def request(provider) do
     config = config!(provider)
@@ -180,7 +178,7 @@ defmodule MultiProviderAuth do
     config = config!(provider)
 
     config
-    |> Assent.Config.put(:session_params, session_params)
+    |> Keyword.put(:session_params, session_params)
     |> config[:strategy].callback(params)
   end
 
@@ -189,7 +187,7 @@ defmodule MultiProviderAuth do
       Application.get_env(:my_app, :strategies)[provider] ||
         raise "No provider configuration for #{provider}"
 
-    Config.put(config, :redirect_uri, "http://localhost:4000/oauth/#{provider}/callback")
+    Keyword.put(config, :redirect_uri, "http://localhost:4000/oauth/#{provider}/callback")
   end
 end
 ```

integration/lib/router.ex

@@ -75,7 +75,7 @@ defmodule IntegrationServer.Router do
 
       unquote(path)
       |> config!()
-      |> Assent.Config.put(:session_params, get_session(conn, :session_params))
+      |> Keyword.put(:session_params, get_session(conn, :session_params))
       |> unquote(module).callback(conn.params)
       |> case do
         {:ok, %{user: user, token: token}} ->

lib/assent.ex

@@ -1,6 +1,22 @@
 defmodule Assent do
   @moduledoc false
 
+  defmodule MissingConfigError do
+    defexception [:key, :config]
+
+    @type t :: %__MODULE__{
+            key: atom(),
+            config: Keyword.t()
+          }
+
+    def message(exception) do
+      key = inspect(exception.key)
+      config_keys = inspect(Keyword.keys(exception.config))
+
+      "Expected #{key} in config, got: #{config_keys}"
+    end
+  end
+
   defmodule CallbackError do
     defexception [:message, :error, :error_uri]
   end
@@ -27,9 +43,9 @@ defmodule Assent do
 
     def message(exception) do
       expected_key = inspect(exception.expected_key)
-      params = inspect(Map.keys(exception.params))
+      param_keys = exception.params |> Map.keys() |> Enum.sort() |> inspect()
 
-      "Expected #{expected_key} in params, got: #{params}"
+      "Expected #{expected_key} in params, got: #{param_keys}"
     end
   end
 
@@ -112,6 +128,49 @@ defmodule Assent do
     end
   end
 
+  @doc """
+  Fetches the key value from the configuration.
+
+  Returns a `Assent.MissingConfigError` if the key is not found.
+  """
+  @spec fetch_config(Keyword.t(), atom()) :: {:ok, any()} | {:error, MissingConfigError.t()}
+  def fetch_config(config, key) when is_list(config) and is_atom(key) do
+    case Keyword.fetch(config, key) do
+      {:ok, value} -> {:ok, value}
+      :error -> {:error, MissingConfigError.exception(key: key, config: config)}
+    end
+  end
+
+  @doc """
+  Fetches the key value from the params.
+
+  Returns a `Assent.MissingParamError` if the key is not found.
+  """
+  @spec fetch_param(map(), binary()) :: {:ok, any()} | {:error, MissingParamError.t()}
+  def fetch_param(params, key) when is_map(params) and is_binary(key) do
+    case Map.fetch(params, key) do
+      {:ok, value} -> {:ok, value}
+      :error -> {:error, MissingParamError.exception(expected_key: key, params: params)}
+    end
+  end
+
+  @default_json_library (Code.ensure_loaded?(JSON) && JSON) || Jason
+
+  @doc """
+  Fetches the JSON library in config.
+
+  If not found in provided config, this will attempt to load the JSON library
+  from global application environment for `:assent`. Defaults to
+  `#{inspect(@default_json_library)}`.
+  """
+  @spec json_library(Keyword.t()) :: module()
+  def json_library(config) do
+    case Keyword.fetch(config, :json_library) do
+      :error -> Application.get_env(:assent, :json_library, @default_json_library)
+      {:ok, json_library} -> json_library
+    end
+  end
+
   import Bitwise
 
   @doc false

lib/assent/config.ex

@@ -1,9 +1,8 @@
+# TODO: Deprecated, remove in 0.3
 defmodule Assent.Config do
-  @moduledoc """
-  Methods to handle configurations.
-  """
+  @moduledoc false
 
-  defmodule MissingKeyError do
+  defmodule MissingConfigError do
     @type t :: %__MODULE__{}
 
     defexception [:key]
@@ -15,51 +14,29 @@ defmodule Assent.Config do
 
   @type t :: Keyword.t()
 
-  @doc """
-  Fetches the key value from the configuration.
-  """
-  @spec fetch(t(), atom()) :: {:ok, any()} | {:error, MissingKeyError.t()}
-  def fetch(config, key) do
-    case Keyword.fetch(config, key) do
-      {:ok, value} -> {:ok, value}
-      :error -> {:error, MissingKeyError.exception(key: key)}
-    end
-  end
+  @doc false
+  @deprecated "Use Assent.fetch_config/2 instead"
+  def fetch(config, key), do: Assent.fetch_config(config, key)
 
+  @deprecated "Use Keyword.get/3 instead"
   defdelegate get(config, key, default), to: Keyword
 
+  @deprecated "Use Keyword.put/3 instead"
   defdelegate put(config, key, value), to: Keyword
 
+  @deprecated "Use Keyword.merge/2 instead"
   defdelegate merge(config_a, config_b), to: Keyword
 
-  @default_json_library (Code.ensure_loaded?(JSON) && JSON) || Jason
-
-  @doc """
-  Fetches the JSON library in config.
-
-  If not found in provided config, this will attempt to load the JSON library
-  from global application environment for `:assent`. Defaults to
-  `#{inspect(@default_json_library)}`.
-  """
-  @spec json_library(t()) :: module()
-  def json_library(config) do
-    case get(config, :json_library, nil) do
-      nil ->
-        Application.get_env(:assent, :json_library, @default_json_library)
-
-      json_library ->
-        json_library
-    end
-  end
+  @deprecated "Use Assent.json_library/1 instead"
+  def json_library(config), do: Assent.json_library(config)
 
-  # TODO: Remove in next major version
   def __base_url__(config) do
-    case fetch(config, :base_url) do
+    case Assent.fetch_config(config, :base_url) do
       {:ok, base_url} ->
         {:ok, base_url}
 
       {:error, error} ->
-        case fetch(config, :site) do
+        case Assent.fetch_config(config, :site) do
           {:ok, base_url} ->
             IO.warn("The `:site` configuration key is deprecated, use `:base_url` instead")
             {:ok, base_url}

lib/assent/http_adapter.ex

@@ -26,7 +26,7 @@ defmodule Assent.HTTPAdapter do
         end
       end
   """
-  alias Assent.{Config, InvalidResponseError, ServerUnreachableError}
+  alias Assent.{InvalidResponseError, ServerUnreachableError}
 
   defmodule HTTPResponse do
     @moduledoc """
@@ -100,12 +100,12 @@ defmodule Assent.HTTPAdapter do
   - `:http_adapter` - The HTTP adapter to use, defaults to
     `#{inspect(elem(@default_http_client, 0))}`.
   - `:json_library` - The JSON library to use, see
-    `Assent.Config.json_library/1`.
+    `Assent.json_library/1`.
   """
   @spec request(atom(), binary(), binary() | nil, list(), Keyword.t()) ::
           {:ok, HTTPResponse.t()} | {:error, HTTPResponse.t()} | {:error, term()}
   def request(method, url, body, headers, opts) do
-    {http_adapter, http_adapter_opts} = get_http_adapter(opts)
+    {http_adapter, http_adapter_opts} = get_adapter(opts)
 
     method
     |> http_adapter.request(url, body, headers, http_adapter_opts)
@@ -133,7 +133,7 @@ defmodule Assent.HTTPAdapter do
     end
   end
 
-  defp get_http_adapter(opts) do
+  defp get_adapter(opts) do
     default_http_adapter = Application.get_env(:assent, :http_adapter, @default_http_client)
 
     case Keyword.get(opts, :http_adapter, default_http_adapter) do
@@ -148,7 +148,7 @@ defmodule Assent.HTTPAdapter do
   ## Options
 
   - `:json_library` - The JSON library to use, see
-    `Assent.Config.json_library/1`
+    `Assent.json_library/1`
   """
   @spec decode_response(HTTPResponse.t(), Keyword.t()) ::
           {:ok, HTTPResponse.t()} | {:error, InvalidResponseError.t()}
@@ -162,10 +162,10 @@ defmodule Assent.HTTPAdapter do
   defp decode(headers, body, opts) when is_binary(body) do
     case List.keyfind(headers, "content-type", 0) do
       {"content-type", "application/json" <> _rest} ->
-        Config.json_library(opts).decode(body)
+        Assent.json_library(opts).decode(body)
 
       {"content-type", "text/javascript" <> _rest} ->
-        Config.json_library(opts).decode(body)
+        Assent.json_library(opts).decode(body)
 
       {"content-type", "application/x-www-form-urlencoded" <> _reset} ->
         {:ok, URI.decode_query(body)}

lib/assent/jwt_adapter.ex

@@ -30,9 +30,6 @@ defmodule Assent.JWTAdapter do
         end
       end
   """
-
-  alias Assent.Config
-
   @callback sign(map(), binary(), binary(), Keyword.t()) :: {:ok, binary()} | {:error, term()}
   @callback verify(binary(), binary() | map() | nil, Keyword.t()) ::
               {:ok, map()} | {:error, term()}
@@ -45,7 +42,7 @@ defmodule Assent.JWTAdapter do
   ## Options
 
   - `:json_library` - The JSON library to use, optional, see
-    `Assent.Config.json_library/1`.
+    `Assent.json_library/1`.
   - `:jwt_adapter` - The JWT adapter module to use, optional, defaults to
     `#{inspect(@default_jwt_adapter)}`
   """
@@ -61,7 +58,7 @@ defmodule Assent.JWTAdapter do
   ## Options
 
   - `:json_library` - The JSON library to use, optional, see
-    `Assent.Config.json_library/1`.
+    `Assent.json_library/1`.
   - `:jwt_adapter` - The JWT adapter module to use, optional, defaults to
     `#{inspect(@default_jwt_adapter)}`
   """
@@ -72,7 +69,7 @@ defmodule Assent.JWTAdapter do
   end
 
   defp get_adapter(opts) do
-    default_opts = Keyword.put(opts, :json_library, Config.json_library(opts))
+    default_opts = Keyword.put(opts, :json_library, Assent.json_library(opts))
     default_jwt_adapter = Application.get_env(:assent, :jwt_adapter, @default_jwt_adapter)
 
     case Keyword.get(opts, :jwt_adapter, default_jwt_adapter) do
@@ -91,9 +88,9 @@ defmodule Assent.JWTAdapter do
   """
   @spec load_private_key(Keyword.t()) :: {:ok, binary()} | {:error, term()}
   def load_private_key(config) do
-    case Config.fetch(config, :private_key_path) do
+    case Assent.fetch_config(config, :private_key_path) do
       {:ok, path} -> read(path)
-      {:error, _any} -> Config.fetch(config, :private_key)
+      {:error, _any} -> Assent.fetch_config(config, :private_key)
     end
   end
 

lib/assent/jwt_adapter/assent_jwt.ex

@@ -8,7 +8,7 @@ defmodule Assent.JWTAdapter.AssentJWT do
 
   See `Assent.JWTAdapter` for more.
   """
-  alias Assent.{Config, JWTAdapter}
+  alias Assent.JWTAdapter
 
   @behaviour Assent.JWTAdapter
 
@@ -26,9 +26,9 @@ defmodule Assent.JWTAdapter.AssentJWT do
 
   defp encode_header(alg, opts) do
     header =
-      case Keyword.has_key?(opts, :private_key_id) do
-        false -> %{"typ" => "JWT", "alg" => alg}
-        true -> %{"typ" => "JWT", "alg" => alg, "kid" => Keyword.get(opts, :private_key_id)}
+      case Keyword.fetch(opts, :private_key_id) do
+        :error -> %{"typ" => "JWT", "alg" => alg}
+        {:ok, private_key_id} -> %{"typ" => "JWT", "alg" => alg, "kid" => private_key_id}
       end
 
     case encode_json_base64(header, opts) do
@@ -41,7 +41,7 @@ defmodule Assent.JWTAdapter.AssentJWT do
   end
 
   defp encode_json_base64(map, opts) do
-    with {:ok, json_library} <- Config.fetch(opts, :json_library),
+    with {:ok, json_library} <- Assent.fetch_config(opts, :json_library),
          {:ok, json} <- json_encode(json_library, map) do
       {:ok, Base.url_encode64(json, padding: false)}
     end
@@ -173,7 +173,7 @@ defmodule Assent.JWTAdapter.AssentJWT do
   end
 
   defp decode_header(header, opts) do
-    with {:ok, json_library} <- Config.fetch(opts, :json_library),
+    with {:ok, json_library} <- Assent.fetch_config(opts, :json_library),
          {:ok, header} <- decode_base64_url(header),
          {:ok, header} <- decode_json(header, json_library),
          {:ok, alg} <- fetch_alg(header) do
@@ -202,7 +202,7 @@ defmodule Assent.JWTAdapter.AssentJWT do
   defp fetch_alg(_header), do: {:error, "No \"alg\" found in header"}
 
   defp decode_claims(claims, opts) do
-    with {:ok, json_library} <- Config.fetch(opts, :json_library),
+    with {:ok, json_library} <- Assent.fetch_config(opts, :json_library),
          {:ok, claims} <- decode_base64_url(claims),
          {:ok, claims} <- decode_json(claims, json_library) do
       {:ok, claims}

lib/assent/jwt_adapter/jose.ex

@@ -32,9 +32,9 @@ defmodule Assent.JWTAdapter.JOSE do
   defp jws(alg, opts) do
     jws = %{"alg" => alg}
 
-    case Keyword.get(opts, :private_key_id) do
-      nil -> jws
-      kid -> Map.put(jws, "kid", kid)
+    case Keyword.fetch(opts, :private_key_id) do
+      :error -> jws
+      {:ok, kid} -> Map.put(jws, "kid", kid)
     end
   end