Dynamic sendgrid key

lib/bamboo/adapters/send_grid_adapter.ex

@@ -19,7 +19,10 @@ defmodule Bamboo.SendGridAdapter do
       # In config/config.exs, or config.prod.exs, etc.
       config :my_app, MyApp.Mailer,
         adapter: Bamboo.SendGridAdapter,
-        api_key: "my_api_key" # or {:system, "SENDGRID_API_KEY"},
+        api_key: "my_api_key"
+          # or {:system, "SENDGRID_API_KEY"},
+          # or {ModuleName, :method_name, []}
+          # or &ModuleName.method_name/0
         hackney_opts: [
           recv_timeout: :timer.minutes(1)
         ]
@@ -32,6 +35,7 @@ defmodule Bamboo.SendGridAdapter do
       defmodule MyApp.Mailer do
         use Bamboo.Mailer, otp_app: :my_app
       end
+
   """
 
   @service_name "SendGrid"
@@ -43,7 +47,7 @@ defmodule Bamboo.SendGridAdapter do
   import Bamboo.ApiError
 
   def deliver(email, config) do
-    api_key = get_key(config)
+    api_key = _get_key(config)
     body = email |> to_sendgrid_body(config) |> Bamboo.json_library().encode!()
     url = [base_uri(), @send_message_path]
 
@@ -63,16 +67,22 @@ defmodule Bamboo.SendGridAdapter do
   @doc false
   def handle_config(config) do
     # build the api key - will raise if there are errors
-    Map.merge(config, %{api_key: get_key(config)})
+    Map.merge(config, %{api_key: _get_key(config)})
   end
 
   @doc false
   def supports_attachments?, do: true
 
-  defp get_key(config) do
+  @doc """
+    Private function prefixed with `_` for testability.
+    This handles getting the config key.
+  """
+  def _get_key(config) do
     api_key =
       case Map.get(config, :api_key) do
         {:system, var} -> System.get_env(var)
+        {module_name, method_name, args} -> apply(module_name, method_name, args)
+        fun when is_function(fun) -> fun.()
         key -> key
       end
 

test/lib/bamboo/adapters/send_grid_adapter_test.exs

@@ -2,13 +2,22 @@ defmodule Bamboo.SendGridAdapterTest do
   use ExUnit.Case
   alias Bamboo.Email
   alias Bamboo.SendGridAdapter
-
   alias Bamboo.Test.User
 
-  @config %{adapter: SendGridAdapter, api_key: "123_abc"}
+  @good_api_key "123_abc"
+  @config %{adapter: SendGridAdapter, api_key: @good_api_key}
   @config_with_bad_key %{adapter: SendGridAdapter, api_key: nil}
   @config_with_env_var_key %{adapter: SendGridAdapter, api_key: {:system, "SENDGRID_API"}}
-  @config_with_sandbox_enabled %{adapter: SendGridAdapter, api_key: "123_abc", sandbox: true}
+  @config_with_env_var_tuple %{
+    adapter: SendGridAdapter,
+    api_key: {Bamboo.SendGridAdapterTest, :sendgrid_secret, []}
+  }
+  @config_with_env_var_tuple_direct %{
+    adapter: SendGridAdapter,
+    api_key: &Bamboo.SendGridAdapterTest.sendgrid_secret/0
+  }
+
+  @config_with_sandbox_enabled %{adapter: SendGridAdapter, api_key: @good_api_key, sandbox: true}
 
   defmodule FakeSendgrid do
     use Plug.Router
@@ -56,6 +65,12 @@ defmodule Bamboo.SendGridAdapterTest do
     end
   end
 
+  @doc """
+  This is a private function that is referenced in `Bamboo.SendGridAdapterTest`
+  to test the config usage example of having a dynamic key
+  """
+  def sendgrid_secret(), do: @good_api_key
+
   setup do
     FakeSendgrid.start_server(self())
 
@@ -66,33 +81,44 @@ defmodule Bamboo.SendGridAdapterTest do
     :ok
   end
 
-  test "raises if the api key is nil" do
-    assert_raise ArgumentError, ~r/no API key set/, fn ->
-      new_email(from: "foo@bar.com") |> SendGridAdapter.deliver(@config_with_bad_key)
+  describe "API key section" do
+    test "raises if the api key is nil" do
+      assert_raise ArgumentError, ~r/no API key set/, fn ->
+        new_email(from: "foo@bar.com") |> SendGridAdapter.deliver(@config_with_bad_key)
+      end
+
+      assert_raise ArgumentError, ~r/no API key set/, fn ->
+        SendGridAdapter.handle_config(%{})
+      end
     end
 
-    assert_raise ArgumentError, ~r/no API key set/, fn ->
-      SendGridAdapter.handle_config(%{})
+    test "can have a tuple resolution" do
+      config = SendGridAdapter.handle_config(@config_with_env_var_tuple)
+      assert config[:api_key] == @good_api_key
     end
-  end
 
-  test "can read the api key from an ENV var" do
-    System.put_env("SENDGRID_API", "123_abc")
+    test "can have an anonymous function resolution" do
+      config = SendGridAdapter.handle_config(@config_with_env_var_tuple_direct)
+      assert config[:api_key] == @good_api_key
+    end
 
-    config = SendGridAdapter.handle_config(@config_with_env_var_key)
+    test "can read the api key from an ENV var" do
+      System.put_env("SENDGRID_API", @good_api_key)
+      config = SendGridAdapter.handle_config(@config_with_env_var_key)
 
-    assert config[:api_key] == "123_abc"
-  end
+      assert config[:api_key] == @good_api_key
+    end
 
-  test "raises if an invalid ENV var is used for the API key" do
-    System.delete_env("SENDGRID_API")
+    test "raises if an invalid ENV var is used for the API key" do
+      System.delete_env("SENDGRID_API")
 
-    assert_raise ArgumentError, ~r/no API key set/, fn ->
-      new_email(from: "foo@bar.com") |> SendGridAdapter.deliver(@config_with_env_var_key)
-    end
+      assert_raise ArgumentError, ~r/no API key set/, fn ->
+        new_email(from: "foo@bar.com") |> SendGridAdapter.deliver(@config_with_env_var_key)
+      end
 
-    assert_raise ArgumentError, ~r/no API key set/, fn ->
-      SendGridAdapter.handle_config(@config_with_env_var_key)
+      assert_raise ArgumentError, ~r/no API key set/, fn ->
+        SendGridAdapter.handle_config(@config_with_env_var_key)
+      end
     end
   end