Merge pull request #15 from emailable/add-access-token-auth

Add support for access token authentication

Author: jclusso

.github/workflows/ci.yml

@@ -2,17 +2,16 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ 'master' ]
   pull_request:
-    branches: [ master ]
 
 jobs:
   tests:
     name: Tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
 
     steps:
     - uses: actions/checkout@v4

.rubocop.yml

@@ -1,4 +1,2 @@
-inherit_from: .rubocop_todo.yml
-
 inherit_gem:
   rubocop-cache-ventures: rubocop.yml

.rubocop_todo.yml

@@ -1 +1 @@
-3.3.0
+3.4.4

.ruby-version

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in emailable-ruby.gemspec
 gemspec

Gemfile

@@ -30,17 +30,26 @@ Or install it yourself as:
 
 ## Usage
 
-The library needs to be configured with your account's API key which is
-available in your [Emailable Dashboard](https://app.emailable.com/api). Set
-`Emailable.api_key` to its value:
+### Authentication
 
-### Setup
+The Emailable API requires either an API key or an access token for
+authentication. API keys can be created and managed in the
+[Emailable Dashboard](https://app.emailable.com/api).
+
+An API key can be set globally for the Emailable client:
+
+```ruby
+Emailable.api_key = 'your_api_key'
+```
+
+Or, you can specify an `api_key` or an `access_token` with each request:
 
 ```ruby
-require 'emailable'
+# set api_key at request time
+Emailable.verify(api_key: 'your_api_key')
 
-# set api key
-Emailable.api_key = 'live_...'
+# set access_token at request time
+Emailable.verify(access_token: 'your_access_token')
 ```
 
 ### Verification

README.md

@@ -15,9 +15,9 @@ Gem::Specification.new do |s|
   s.email = 'support@emailable.com'
   s.license = 'MIT'
   s.metadata = {
-    "bug_tracker_uri" => "https://github.com/emailable/emailable-ruby/issues",
-    "documentation_uri" => "https://docs.emailable.com/?ruby",
-    "source_code_uri" => "https://github.com/emailable/emailable-ruby"
+    'bug_tracker_uri' => 'https://github.com/emailable/emailable-ruby/issues',
+    'documentation_uri' => 'https://emailable.com/docs/api/?ruby',
+    'source_code_uri' => 'https://github.com/emailable/emailable-ruby'
   }
 
   s.files = `git ls-files`.split("\n")
@@ -29,8 +29,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'amazing_print'
   s.add_development_dependency 'minitest', '~> 5.0'
   s.add_development_dependency 'minitest-reporters'
   s.add_development_dependency 'activemodel'

emailable.gemspec

@@ -32,7 +32,7 @@ def verify(email, parameters = {})
     parameters[:email] = email
 
     client = Emailable::Client.new
-    response = client.request(:get, 'verify', parameters)
+    response = client.request(:post, 'verify', parameters)
 
     if response.status == 249
       raise Emailable::TimeoutError.new(response.body)
@@ -41,9 +41,9 @@ def verify(email, parameters = {})
     end
   end
 
-  def account
+  def account(parameters = {})
     client = Emailable::Client.new
-    response = client.request(:get, 'account')
+    response = client.request(:get, 'account', parameters)
     Account.new(response.body)
   end
 

lib/emailable.rb

@@ -17,18 +17,24 @@ def initialize
     end
 
     def request(method, endpoint, params = {})
-      begin
-        tries ||= 3
+      api_key = params.delete(:api_key)
+      access_token = params.delete(:access_token)
 
-        uri = URI("#{@base_url}/#{endpoint}")
-        params[:api_key] = Emailable.api_key
+      uri = URI("#{@base_url}/#{endpoint}")
+      headers = {
+        'Authorization': "Bearer #{Emailable.api_key || api_key || access_token}",
+        'Content-Type': 'application/json'
+      }
 
+      begin
+        tries ||= 3
         http_response =
           if method == :get
-            uri.query = URI.encode_www_form(params)
-            @connection.get(uri)
+            uri.query = URI.encode_www_form(params) unless params.empty?
+            request = Net::HTTP::Get.new(uri, headers)
+            @connection.request(request)
           elsif method == :post
-            request = Net::HTTP::Post.new(uri, 'Content-Type': 'application/json')
+            request = Net::HTTP::Post.new(uri, headers)
             request.body = params.to_json
             @connection.request(request)
           end
@@ -65,7 +71,7 @@ def create_connection(uri)
       if connection.respond_to?(:write_timeout=)
         connection.write_timeout = Emailable.write_timeout
       end
-      connection.use_ssl = uri.scheme == "https"
+      connection.use_ssl = uri.scheme == 'https'
 
       connection
     end

lib/emailable/client.rb

@@ -18,7 +18,7 @@ def validate_each(record, attribute, value)
     states = options.fetch(:states, %i(deliverable risky unknown))
     allowed_states = %i[deliverable undeliverable risky unknown]
     unless (states - allowed_states).empty?
-      raise ArgumentError, ":states must be an array of symbols containing "\
+      raise ArgumentError, ':states must be an array of symbols containing '\
         "any or all of :#{allowed_states.join(', :')}"
     end
 
@@ -29,7 +29,7 @@ def validate_each(record, attribute, value)
 
     timeout = options.fetch(:timeout, 3)
     unless timeout.is_a?(Integer) && timeout > 1
-      raise ArgumentError, ":timeout must be an Integer greater than 1"
+      raise ArgumentError, ':timeout must be an Integer greater than 1'
     end
 
     return if record.errors[attribute].present?