Rename expected_key to key in MissingParamError

Author: danschultzer

lib/assent.ex

@@ -34,18 +34,33 @@ defmodule Assent do
   end
 
   defmodule MissingParamError do
-    defexception [:expected_key, :params]
+    defexception [:key, :params]
 
     @type t :: %__MODULE__{
-            expected_key: binary(),
+            key: binary(),
             params: map()
           }
 
+    # TODO: Deprecated, remove in 0.3
+    def exception(opts) do
+      opts =
+        case Keyword.fetch(opts, :expected_key) do
+          {:ok, key} ->
+            IO.warn("The `expected_key` option is deprecated. Please use `key` instead.")
+            [key: key, params: opts[:params]]
+
+          :error ->
+            opts
+        end
+
+      struct!(__MODULE__, opts)
+    end
+
     def message(exception) do
-      expected_key = inspect(exception.expected_key)
+      key = inspect(exception.key)
       param_keys = exception.params |> Map.keys() |> Enum.sort() |> inspect()
 
-      "Expected #{expected_key} in params, got: #{param_keys}"
+      "Expected #{key} in params, got: #{param_keys}"
     end
   end
 
@@ -150,7 +165,7 @@ defmodule Assent do
   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)}
+      :error -> {:error, MissingParamError.exception(key: key, params: params)}
     end
   end
 

test/assent/strategies/oauth2_test.exs

@@ -188,7 +188,7 @@ defmodule Assent.Strategy.OAuth2Test do
       params = Map.delete(params, "state")
 
       assert {:error, %MissingParamError{} = error} = OAuth2.callback(config, params)
-      assert error.expected_key == "state"
+      assert error.key == "state"
     end
 
     test "with invalid `state` param", %{config: config, callback_params: params} do
@@ -233,7 +233,7 @@ defmodule Assent.Strategy.OAuth2Test do
       params = Map.delete(params, "code")
 
       assert {:error, %MissingParamError{} = error} = OAuth2.callback(config, params)
-      assert error.expected_key == "code"
+      assert error.key == "code"
     end
 
     test "with `code_verifier: true` with missing `:code_verifier` in session_params", %{

test/assent/strategies/oauth_test.exs

@@ -367,15 +367,15 @@ defmodule Assent.Strategy.OAuthTest do
       params = Map.delete(params, "oauth_token")
 
       assert {:error, %MissingParamError{} = error} = OAuth.callback(config, params)
-      assert error.expected_key == "oauth_token"
+      assert error.key == "oauth_token"
       assert error.params == %{"oauth_verifier" => "hfdp7dh39dks9884"}
     end
 
     test "with missing `oauth_verifier` param", %{config: config, callback_params: params} do
       params = Map.delete(params, "oauth_verifier")
 
       assert {:error, %MissingParamError{} = error} = OAuth.callback(config, params)
-      assert error.expected_key == "oauth_verifier"
+      assert error.key == "oauth_verifier"
       assert error.params == %{"oauth_token" => "hh5s93j4hdidpola"}
     end
 

test/assent/strategies/telegram_test.exs

@@ -118,7 +118,7 @@ defmodule Assent.Strategy.TelegramTest do
       assert {:error, %Assent.MissingParamError{} = error} =
                Telegram.callback(config, callback_params)
 
-      assert error.expected_key == "hash"
+      assert error.key == "hash"
     end
 
     @tag authorization_channel: :web_mini_app
@@ -131,7 +131,7 @@ defmodule Assent.Strategy.TelegramTest do
       assert {:error, %Assent.MissingParamError{} = error} =
                Telegram.callback(config, callback_params)
 
-      assert error.expected_key == "init_data"
+      assert error.key == "init_data"
     end
 
     test "with missing auth_date param", %{config: config, callback_params: callback_params} do
@@ -140,7 +140,7 @@ defmodule Assent.Strategy.TelegramTest do
       assert {:error, %Assent.MissingParamError{} = error} =
                Telegram.callback(config, callback_params)
 
-      assert error.expected_key == "auth_date"
+      assert error.key == "auth_date"
     end
 
     test "with expired auth_date param", %{config: config, callback_params: callback_params} do

test/assent_test.exs

@@ -19,7 +19,7 @@ defmodule AssentTest do
     assert Assent.fetch_param(params, "a") == {:ok, 1}
 
     assert {:error, %Assent.MissingParamError{} = error} = Assent.fetch_param(params, "c")
-    assert error.expected_key == "c"
+    assert error.key == "c"
     assert error.params == params
     assert Exception.message(error) == "Expected \"c\" in params, got: [\"a\", \"b\"]"
   end