emailable 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 569f2990e697b4682c76a2d659760562572c175f8649e273bf821965fd2df76f
-  data.tar.gz: cc16ed03e3a287e558a2d681f4c9d08ecadcc56a2bb5ec0242ad05ec4ed4a931
+  metadata.gz: 02e893db37f9960d70d4a0ed17f712ef1e02f13f707d57e7428c3f2b07e36b6d
+  data.tar.gz: 7ab4fc1440cc5cd172059f4d2bb53cc51f169f5f21cb7a9bb919d97f04b2b543
 SHA512:
-  metadata.gz: c8d2241faf3fc8b8bfce8a6f1bef348558b109800f428d67edcc3744c0daac4cd9a5c47b490d4622ff0dbcdf22b09efff69167ccc50b315b90212633b1ef67c5
-  data.tar.gz: 1300dc96e81a82de3ac19bfd392ecafd1f22751fbf261d5528e775f1b9bfab88b224dcbe2da9e3534ed9898b30b022cbc6bf64ae9a2e89cc3df3c5b518168851
+  metadata.gz: eb96ef05631762f2e6fa53e13a621e6006f23af42dba60fa36a86adc978b8b537def118e7547c8af4da8925109a7b671e7cfba4c5eab031a4c874f2e15e64f1d
+  data.tar.gz: c1292e55f4ba32a80da7a30e9d9f401d51f0747d23ccac2f1e8cd336020b9cda45413e7f423eb0b00fee24bb618704e596d20203f8334f532a9d364b97df218f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    emailable (3.0.2)
+    emailable (4.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,20 +17,20 @@ GEM
     ansi (1.5.0)
     awesome_print (1.8.0)
     builder (3.2.3)
-    coderay (1.1.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.7)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
+    method_source (1.0.0)
     minitest (5.11.3)
     minitest-reporters (1.3.6)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (13.0.1)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)

data/README.md

@@ -1,7 +1,7 @@
 # Emailable Ruby Library
 
-[![Build Status](https://travis-ci.com/emailable/emailable-ruby.svg)](https://travis-ci.com/emailable/emailable-ruby)
-[![Maintainability](https://api.codeclimate.com/v1/badges/2d74c69a9155109058a7/maintainability)](https://codeclimate.com/github/emailable/emailable-ruby/maintainability)
+[![Build Status](https://app.travis-ci.com/emailable/emailable-ruby.svg)](https://app.travis-ci.com/emailable/emailable-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e7eef54e491adec95e6d/maintainability)](https://codeclimate.com/github/emailable/emailable-ruby/maintainability)
 
 This is the official ruby wrapper for the Emailable API.
 
@@ -29,7 +29,9 @@ 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:
+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:
 
 ### Setup
 
@@ -47,6 +49,9 @@ Emailable.api_key = 'live_...'
 Emailable.verify('jarrett@emailable.com')
 ```
 
+All supported parameters for the verify endpoint can be passed in as hash
+arguments to the `verify` method.
+
 #### Slow Email Server Handling
 
 Some email servers are slow to respond. As a result, the timeout may be reached
@@ -60,23 +65,29 @@ email `slow@example.com`.
 
 ### Batch Verification
 
+First, create an `Emailable::Batch` object. Then, call the `verify` method to
+start the batch. All supported parameters for the batch verification endpoint
+can be passed in as hash arguments to the `verify` method.
+
 #### Start a batch
 
 ```ruby
 emails = ['jarrett@emailable.com', 'support@emailable.com', ...]
 batch = Emailable::Batch.new(emails)
 
-# you can optionally pass in a callback url that we'll POST to when the
-# batch is complete.
-batch = Emailable::Batch.new(emails, callback: 'https://emailable.com/')
-
 # start verifying the batch
 batch.verify
+
+# you can optionally pass in a callback url that we'll POST to when the batch
+# is complete.
+batch.verify(url: 'https://emailable.com/')
 ```
 
 #### Get the status / results of a batch
 
-Calling `status` on a batch will return the status. It will contain the results as well once complete. You can also `results` to get just the results.
+Calling `status` on a batch will return the status. It will contain the results
+as well once complete. All supported parameters for the status endpoint can be
+passed in as hash arguments to the `status` method.
 
 ```ruby
 id = '5cfcbfdeede34200693c4319'
@@ -85,6 +96,9 @@ batch = Emailable::Batch.new(id)
 # get status of batch
 batch.status
 
+# get the status of a batch, with partial results if the batch is incomplete
+batch.status(partial: true)
+
 # gets the results
 batch.status.emails
 
@@ -126,10 +140,17 @@ attr_accessor :email_verification_result
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/emailable/emailable-ruby.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/emailable/emailable-ruby.

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "emailable/ruby"
+require 'bundler/setup'
+require 'emailable'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/emailable/batch.rb

@@ -2,15 +2,13 @@ module Emailable
   class Batch
     attr_accessor :id
 
-    def initialize(id_or_emails, callback: nil)
+    def initialize(id_or_emails)
       if id_or_emails.is_a?(Array)
         @id = nil
         @emails = id_or_emails
-        @callback = callback
       elsif id_or_emails.is_a?(String)
         @id = id_or_emails
         @emails = nil
-        @callback = nil
       else
         raise ArgumentError, 'expected an array of emails or batch id'
       end
@@ -19,20 +17,21 @@ module Emailable
       @status = nil
     end
 
-    def verify
+    def verify(parameters = {})
       return @id unless @id.nil?
 
-      opts = { emails: @emails.join(','), url: @callback }
-      response = @client.request(:post, 'batch', opts)
+      parameters[:emails] = @emails.join(',')
+      response = @client.request(:post, 'batch', parameters)
 
       @id = response.body['id']
     end
 
-    def status
+    def status(parameters = {})
       return nil unless @id
       return @status if @status
 
-      response = @client.request(:get, 'batch', { id: @id })
+      parameters[:id] = @id
+      response = @client.request(:get, 'batch', parameters)
       bs = BatchStatus.new(response.body)
       @status = bs if bs.complete?
 
@@ -40,7 +39,7 @@ module Emailable
     end
 
     def complete?
-      !status.complete?
+      status.complete?
     end
 
     def inspect

data/lib/emailable/client.rb

@@ -1,5 +1,15 @@
 module Emailable
   class Client
+    ERRORS = {
+      400 => BadRequestError,
+      401 => UnauthorizedError,
+      402 => PaymentRequiredError,
+      403 => ForbiddenError,
+      404 => NotFoundError,
+      429 => TooManyRequestsError,
+      500 => InternalServerError,
+      503 => ServiceUnavailableError
+    }.freeze
 
     def initialize
       @base_url = 'https://api.emailable.com/v1'
@@ -33,22 +43,7 @@ module Emailable
       status = response.status
       return response if status.between?(200, 299)
 
-      error_attributes = {
-        message: response.body['message'],
-        code: status
-      }
-      error_map = {
-        '400' => BadRequestError,
-        '401' => UnauthorizedError,
-        '402' => PaymentRequiredError,
-        '403' => ForbiddenError,
-        '404' => NotFoundError,
-        '429' => TooManyRequestsError,
-        '500' => InternalServerError,
-        '503' => ServiceUnavailableError
-      }
-
-      raise error_map[status.to_s].new(error_attributes)
+      raise ERRORS[status].new(response.body['message'])
     end
 
     private

data/lib/emailable/email_validator.rb

@@ -38,7 +38,7 @@ class EmailValidator < ActiveModel::EachValidator
 
     api_options = { timeout: timeout, smtp: smtp }
     api_options[:accept_all] = true unless accept_all
-    ev = Emailable.verify(value, **api_options)
+    ev = Emailable.verify(value, api_options)
 
     result_accessor = "#{attribute}_verification_result"
     if record.respond_to?(result_accessor)

data/lib/emailable/errors.rb

@@ -0,0 +1,12 @@
+module Emailable
+  class Error < StandardError; end
+  class BadRequestError < Error; end
+  class UnauthorizedError < Error; end
+  class PaymentRequiredError < Error; end
+  class ForbiddenError < Error; end
+  class NotFoundError < Error; end
+  class TooManyRequestsError < Error; end
+  class InternalServerError < Error; end
+  class ServiceUnavailableError < Error; end
+  class TimeoutError < Error; end
+end

data/lib/emailable/resources/api_resource.rb

@@ -7,13 +7,21 @@ module Emailable
       end
     end
 
-    def inspect
-      ivars = instance_variables.map do |e|
-        [e.to_s.delete('@'), instance_variable_get(e)]
+    def to_h
+      instance_variables.map do |e|
+        [e.to_s.delete('@').to_sym, instance_variable_get(e)]
       end.to_h
-      fmtted_email = @email ? " #{@email}" : ''
-      "#<#{self.class}:0x#{(object_id << 1).to_s(16)}#{fmtted_email}> JSON: " +
-        JSON.pretty_generate(ivars)
+    end
+
+    alias_method :to_hash, :to_h
+
+    def to_json
+      JSON.generate(to_h)
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{(object_id << 1).to_s(16)}> JSON: " +
+        JSON.pretty_generate(to_h)
     end
 
   end

data/lib/emailable/resources/batch_status.rb

@@ -4,7 +4,7 @@ module Emailable
       :processed, :total
 
     def complete?
-      !emails.nil?
+      message.include?('completed')
     end
   end
 end

data/lib/emailable/resources/verification.rb

@@ -11,5 +11,10 @@ module Emailable
       end
     end
 
+    def inspect
+      "#<#{self.class}:0x#{(object_id << 1).to_s(16)}#{@email}> JSON: " +
+        JSON.pretty_generate(to_h)
+    end
+
   end
 end

data/lib/emailable/version.rb

@@ -1,3 +1,3 @@
 module Emailable
-  VERSION = '3.0.2'
+  VERSION = '4.0.0'
 end

data/lib/emailable.rb

@@ -1,4 +1,8 @@
+require 'net/http'
+require 'json'
+
 require 'emailable/version'
+require 'emailable/errors'
 require 'emailable/client'
 require 'emailable/response'
 require 'emailable/batch'
@@ -24,18 +28,14 @@ module Emailable
 
   module_function
 
-  def verify(email, smtp: nil, accept_all: nil, timeout: nil)
-    opts = {
-      email: email, smtp: smtp, accept_all: accept_all, timeout: timeout
-    }
+  def verify(email, parameters = {})
+    parameters[:email] = email
 
     client = Emailable::Client.new
-    response = client.request(:get, 'verify', opts)
+    response = client.request(:get, 'verify', parameters)
 
     if response.status == 249
-      raise Emailable::TimeoutError.new(
-        code: response.status, message: response.body
-      )
+      raise Emailable::TimeoutError.new(response.body)
     else
       Verification.new(response.body)
     end
@@ -47,22 +47,4 @@ module Emailable
     Account.new(response.body)
   end
 
-
-  class Error < StandardError
-    attr_accessor :code, :message
-
-    def initialize(code: nil, message: nil)
-      @code = code
-      @message = message
-    end
-  end
-  class BadRequestError < Error; end
-  class UnauthorizedError < Error; end
-  class PaymentRequiredError < Error; end
-  class ForbiddenError < Error; end
-  class NotFoundError < Error; end
-  class TooManyRequestsError < Error; end
-  class InternalServerError < Error; end
-  class ServiceUnavailableError < Error; end
-  class TimeoutError < Error; end
 end

data/test/email_validator_test.rb

@@ -1,3 +1,4 @@
+require 'active_model'
 require 'test_helper'
 
 class EmailValidatorTest < Minitest::Test

data/test/emailable/batch_test.rb

@@ -22,8 +22,7 @@ module Emailable
     end
 
     def test_batch_complete
-      complete = @batch.complete?
-      assert complete == true || complete == false
+      assert @batch.complete?
     end
 
   end

data/test/emailable/resources/api_resource_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module Emailable
+  module Resources
+    class APIResourceTest < Minitest::Test
+      class Example < APIResource
+        attr_accessor :foo, :bar, :baz
+      end
+
+      def setup
+        @e = Example.new(foo: 'abc', bar: 123, baz: true)
+      end
+
+      def test_init
+        assert_equal 'abc', @e.foo
+        assert_equal 123,   @e.bar
+        assert_equal true,  @e.baz
+      end
+
+      def test_to_h
+        correct = {
+          foo: 'abc',
+          bar: 123,
+          baz: true,
+        }
+        assert_equal correct, @e.to_h
+        assert_equal correct, @e.to_hash
+      end
+
+      def test_to_json
+        correct = %q|{"foo":"abc","bar":123,"baz":true}|
+        assert_equal correct, @e.to_json
+      end
+
+      def test_inspect
+        correct = <<~STR.chomp
+          #<> JSON: {
+            "foo": "abc",
+            "bar": 123,
+            "baz": true
+          }
+        STR
+        output = @e.inspect.gsub(/<.*>/, '<>')
+        assert_equal correct, output
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -1,5 +1,3 @@
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require 'active_model'
 require 'emailable'
 
 require 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailable
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Emailable
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - lib/emailable/batch.rb
 - lib/emailable/client.rb
 - lib/emailable/email_validator.rb
+- lib/emailable/errors.rb
 - lib/emailable/resources/account.rb
 - lib/emailable/resources/api_resource.rb
 - lib/emailable/resources/batch_status.rb
@@ -142,6 +143,7 @@ files:
 - lib/emailable/version.rb
 - test/email_validator_test.rb
 - test/emailable/batch_test.rb
+- test/emailable/resources/api_resource_test.rb
 - test/emailable_test.rb
 - test/test_helper.rb
 homepage: https://emailable.com
@@ -151,7 +153,7 @@ 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
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,11 +169,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Emailable API
 test_files:
 - test/email_validator_test.rb
 - test/emailable/batch_test.rb
+- test/emailable/resources/api_resource_test.rb
 - test/emailable_test.rb
 - test/test_helper.rb