Changes the auth strategy to allow for an api_key to be passed

CHANGELOG.md

@@ -1,3 +1,7 @@
+## main
+
+* BREAKING: removes the `headers` param and replaces with `api_key`.
+
 ## 0.8.1
 
 * Add logger to configuration by @cdmwebs in https://github.com/knowndecimal/fulfil/pull/49

README.md

@@ -32,7 +32,8 @@ Environment variables:
 
 - **FULFIL_SUBDOMAIN:** - always required to use the gem.
 - **FULFIL_OAUTH_TOKEN:** required for oauth bearer authentication
-- **FULFIL_API_KEY:** required for authentication via the `X-API-KEY` request header
+- **FULFIL_API_KEY:** required for authentication via the `X-API-KEY` request
+  header. This is used with the Personal Access Token authentication method.
 
 > **Note:** When `FULFIL_OAUTH_TOKEN` is present, the `FULFIL_API_KEY` will be ignored. So,
 if oauth doesn't work, returning an Unauthorized error, to use the
@@ -72,6 +73,24 @@ pp sales
 #   "rec_name"=>""}]
 ```
 
+To configure a client without using environment variables, pass them as arguments:
+
+```ruby
+client = Fulfil::Client.new(
+  subdomain: 'test',
+  api_key: '123'
+)
+```
+
+With an OAuth token:
+
+```ruby
+client = Fulfil::Client.new(
+  subdomain: 'test',
+  token: '123'
+)
+```
+
 ### Count
 
 ```ruby

lib/fulfil/client.rb

@@ -11,7 +11,7 @@ module Fulfil
   class Client
     class InvalidClientError < StandardError
       def message
-        'Client is not configured correctly.'
+        super() || 'Client is not configured correctly.'
       end
     end
 
@@ -23,12 +23,17 @@ class ConnectionError < StandardError; end
 
     class ResponseError < StandardError; end
 
-    def initialize(subdomain: SUBDOMAIN, token: oauth_token, headers: { 'X-API-KEY' => API_KEY }, debug: false)
+    def initialize(subdomain: SUBDOMAIN, token: oauth_token, api_key: API_KEY, debug: false)
       @subdomain = subdomain
-      @token = token
       @debug = debug
-      @headers = headers
-      @headers.delete('X-API-KEY') if @token
+
+      if token
+        @token = token
+      elsif api_key
+        @api_key = api_key
+      else
+        raise InvalidClientError, 'No token or API key provided.'
+      end
 
       raise InvalidClientError if invalid?
     end
@@ -150,8 +155,6 @@ def model_url(model:, id: nil, endpoint: nil)
     end
 
     def request(endpoint:, verb: :get, **args)
-      raise InvalidClientError if invalid?
-
       response = client.request(verb, endpoint, args)
       Fulfil::ResponseHandler.new(response).verify!
 
@@ -177,7 +180,8 @@ def request(endpoint:, verb: :get, **args)
     def client
       client = HTTP.use(logging: @debug ? { logger: config.logger } : {})
       client = client.auth("Bearer #{@token}") if @token
-      client.headers(@headers)
+      client.headers({ 'X-API-KEY': @api_key }) if @api_key
+      client
     end
 
     def config

test/fulfil/client_test.rb

@@ -8,6 +8,18 @@ def test_invalid_client
       assert_raises('InvalidClientError') { Fulfil::Client.new(subdomain: nil, token: nil) }
     end
 
+    def test_token_authorization
+      client = Fulfil::Client.new(subdomain: 'test', token: '123')
+
+      assert_predicate client, :valid?
+    end
+
+    def test_api_key_authorization
+      client = Fulfil::Client.new(subdomain: 'test', api_key: '123')
+
+      assert_predicate client, :valid?
+    end
+
     def test_find_one
       stub_fulfil_get('sale.sale/213112', 'sale_sale')