emailable 3.1.1 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f1d586f58f97cf11f78a6dac64fa169e9ff0d1a2902a4f5df86a32f9d16dae
-  data.tar.gz: 20e10632676d8374b41048c9324fe879c5da2cc0841a71ae9bf920ea752abc58
+  metadata.gz: a16092a97f3a44d6367dd6f43c6d2ca0ef865b4f4d72f128fc5e0ed9af61690d
+  data.tar.gz: 193b812579bd58486dccc1b96b27a6be94a08ba95292393c5f76e15787cbb8a1
 SHA512:
-  metadata.gz: 644ea041fc96995db1c0121be0b494f1cbea6df42dbbf691afebce236ce567a5db4ee87d34bf222dc26e244a4624777ca8a08a4df899a980050902403a31a7e0
-  data.tar.gz: 54b5b43f725562bcae4a38385b70a9ff61e74c4fbe74200b288d1112ed7b640eea2326c618ea8f1adf815f5aad42ef69982029f70f7246bbf55746bfe752435f
+  metadata.gz: 12d8fea5456e9a845f14fa8e06beb91503a4589890b82aeb00f519d3474a2d9952efd480c0ff89d36018bed4623a9614a92b4e1617dee84fc3ae4e472c6ac9c8
+  data.tar.gz: d3b50438805d55f28d8c072ce578a4431a848054a38d1a2881dc7696636bce59d1b6b93bd56d175f00e95d1a7c12330bee7c9d4bafaa2f7032c75f90437bdb4c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    emailable (3.1.1)
+    emailable (4.0.1)
 
 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,5 +1,6 @@
 # Emailable Ruby Library
 
+[![Gem Version](https://badge.fury.io/rb/emailable.svg)](https://rubygems.org/gems/emailable)
 [![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)
 
@@ -29,7 +30,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 +50,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 +66,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 +97,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 +141,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/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(simulate: nil)
+    def verify(parameters = {})
       return @id unless @id.nil?
 
-      opts = { emails: @emails.join(','), url: @callback, simulate: simulate }
-      response = @client.request(:post, 'batch', opts)
+      parameters[:emails] = @emails.join(',')
+      response = @client.request(:post, 'batch', parameters)
 
       @id = response.body['id']
     end
 
-    def status(simulate: nil)
+    def status(parameters = {})
       return nil unless @id
       return @status if @status
 
-      response = @client.request(:get, 'batch', { id: @id, simulate: simulate })
+      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/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/resources/batch_status.rb

@@ -1,10 +1,10 @@
 module Emailable
   class BatchStatus < APIResource
     attr_accessor :emails, :id, :message, :reason_counts, :total_counts,
-      :processed, :total
+      :processed, :total, :download_file
 
     def complete?
-      !emails.nil?
+      message.include?('completed')
     end
   end
 end

data/lib/emailable/version.rb

@@ -1,3 +1,3 @@
 module Emailable
-  VERSION = '3.1.1'
+  VERSION = '4.0.1'
 end

data/lib/emailable.rb

@@ -28,13 +28,11 @@ 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(response.body)

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailable
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 4.0.1
 platform: ruby
 authors:
 - Emailable
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler