changed name of API key (#54)

Author: sudoku-lord

.github/workflows/run_tests_job.yml

@@ -26,13 +26,13 @@ jobs:
     - name: Check Code Coverage & Upload to Coveralls.io
       run:  MIX_ENV=test mix coveralls.github --max-cases 1
       env:
-        API_KEY: ${{ secrets.API_KEY }}
+        LOB_API_TEST_KEY: ${{ secrets.LOB_API_TEST_KEY }}
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - name: Run Static Code Analysis for Elixir
       run: mix credo
     - name: Run Static Code Analysis for Erlang
       run: mix dialyzer --halt-exit-status
     - name: Run Elixir Tests
       env:
-        API_KEY: ${{ secrets.API_KEY }}
+        LOB_API_TEST_KEY: ${{ secrets.LOB_API_TEST_KEY }}
       run: mix deps.get && mix test

README.md

@@ -31,7 +31,7 @@ This library implements the Lob API. Please read through the official [API Docum
 The library requires a valid Lob API key to work properly. To acquire an API key, first create an account at [Lob.com](https://dashboard.lob.com/#/register). Once you have created an account, you can access your API Keys from the [Settings Panel](https://dashboard.lob.com/#/settings).
 
 ### API Key Configuration
- The library will by default refer to the `:api_key` config when making authenticated requests. If that is not present, it will look for the `API_KEY` environment variable.
+ The library will by default refer to the `:api_key` config when making authenticated requests. If that is not present, it will look for the `LOB_API_TEST_KEY` environment variable.
 
 ```elixir
 # Configuring an API key with configs
@@ -81,11 +81,11 @@ Tests are written using [ExUnit](https://hexdocs.pm/ex_unit/ExUnit.html), Elixir
 
 Here's how you can run the tests:
 
-    API_KEY=YOUR_TEST_API_KEY mix test
+    LOB_API_TEST_KEY=YOUR_TEST_API_KEY mix test
 
 To run tests with a coverage report:
 
-    API_KEY=YOUR_TEST_API_KEY mix coveralls.html
+    LOB_API_TEST_KEY=YOUR_TEST_API_KEY mix coveralls.html
 
 Then view the report at `cover/excoveralls.html`.
 

config/test.exs

@@ -1,7 +1,7 @@
 import Config
 
 config :lob_elixir,
-  api_key: System.get_env("API_KEY")
+  api_key: System.get_env("LOB_API_TEST_KEY")
 
 # config :pre_commit,
 #   commands: ["test", "credo", "dialyzer", "coveralls"]

lib/lob/client.ex

@@ -19,10 +19,10 @@ defmodule Lob.Client do
 
     defexception message: """
                    The api_key setting is required to make requests to Lob.
-                   Please configure :api_key in config.exs or set the API_KEY
+                   Please configure :api_key in config.exs or set the LOB_API_TEST_KEY
                    environment variable.
 
-                   config :lob_elixir, api_key: API_KEY
+                   config :lob_elixir, api_key: LOB_API_TEST_KEY
                  """
   end
 
@@ -31,7 +31,7 @@ defmodule Lob.Client do
 
   @spec api_key(atom) :: String.t()
   def api_key(env_key \\ :api_key) do
-    case Confex.get_env(:lob_elixir, env_key, System.get_env("API_KEY")) || :not_found do
+    case Confex.get_env(:lob_elixir, env_key, System.get_env("LOB_API_TEST_KEY")) || :not_found do
       :not_found -> raise MissingAPIKeyError
       value -> value
     end

test/lob/client_test.exs

@@ -13,10 +13,10 @@ defmodule Lob.ClientTest do
   describe "api_key/1" do
     test "raises MissingAPIKeyError if no API key is found" do
       assert_raise(MissingAPIKeyError, fn ->
-        api_key = System.get_env("API_KEY")
-        System.delete_env("API_KEY")
+        api_key = System.get_env("LOB_API_TEST_KEY")
+        System.delete_env("LOB_API_TEST_KEY")
         Client.api_key(nil)
-        System.put_env("API_KEY", api_key)
+        System.put_env("LOB_API_TEST_KEY", api_key)
       end)
     end
   end