emailable 3.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e7635cc0f814700d29137678bd7b53fd91f07f042ff5435b8777cc269a51fb6
+  data.tar.gz: 808f71d2c343495ad48143230d1daa11ba59e334d75a242d25df637abd446b51
+SHA512:
+  metadata.gz: 8a78fd0ab06eca710c67e2e8c01142d0a4bfdfa19f7357c9f54b7a8d53eddaf7b29f32ded7ad85145f414e95782a61dd4774d0a39821f2194f0228b9b402b6c4
+  data.tar.gz: 99f27b66dc848815689fe3a0869b2b47a0f412c3305b910a044488b65598161a8349f690b5772d4e5181e97a4c55fa794f9593d3fa4b60bca5d5ad9a99b84530

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+emailable-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    emailable (3.0.0)
+      faraday
+      faraday_middleware
+      net-http-persistent
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ansi (1.5.0)
+    awesome_print (1.8.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multipart-post (2.1.1)
+    net-http-persistent (4.0.1)
+      connection_pool (~> 2.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  awesome_print
+  bundler
+  emailable!
+  minitest (~> 5.0)
+  minitest-reporters
+  pry
+  rake (~> 13.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Emailable. https://emailable.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# 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)
+
+This is the official ruby wrapper for the Emailable API.
+
+It also includes an Active Record (Rails) validator to verify email attributes.
+
+## Documentation
+
+See the [Ruby API docs](https://emailable.com/docs/api/?ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'emailable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emailable
+
+## 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:
+
+### Setup
+
+```ruby
+require 'emailable'
+
+# set api key
+Emailable.api_key = 'live_...'
+```
+
+### Verification
+
+```ruby
+# verify an email address
+Emailable.verify('jarrett@emailable.com')
+```
+
+#### Slow Email Server Handling
+
+Some email servers are slow to respond. As a result, the timeout may be reached
+before we are able to complete the verification process. If this happens, the
+verification will continue in the background on our servers, and a
+`Emailable::TimeoutError` will be raised. We recommend sleeping for at least
+one second and trying your request again. Re-requesting the same verification
+with the same options will not impact your credit allocation within a 5 minute
+window. You can test this behavior using a test key and the special
+email `slow@example.com`.
+
+### Batch Verification
+
+#### 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
+```
+
+#### 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.
+
+```ruby
+id = '5cfcbfdeede34200693c4319'
+batch = Emailable::Batch.new(id)
+
+# get status of batch
+batch.status
+
+# gets the results
+batch.status.emails
+
+# get the counts
+batch.status.total_counts
+batch.status.reason_counts
+
+# returns true / false
+batch.complete?
+```
+
+### Active Record Validator
+
+Define a validator on an Active Record model for your email attribute(s).
+It'll validate the attribute only when it's present and has changed.
+
+#### Options
+
+* `smtp`, `timeout`: Passed directly to API as options.
+* `states`: An array of states you'd like to be considered valid.
+* `free`, `role`, `disposable`, `accept_all`: If you'd like any of these to be valid.
+
+```ruby
+validates :email, email: {
+  smtp: true, states: %i[deliverable risky unknown],
+  free: true, role: true, disposable: false, accept_all: true, timeout: 3
+}
+```
+
+#### Access Verification Result
+
+You can define an `attr_accessor` with the following format to gain
+access to the verification result.
+
+```ruby
+# [attribute_name]_verification_result
+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.
+
+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.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "emailable/ruby"
+
+# 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"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  errors:
+    messages:
+      undeliverable: is undeliverable
+      risky: is risky
+      unknown: is unknown
+      free: is a free address
+      role: is a role address
+      disposable: is a disposable address
+      accept_all: is an accept-all address

data/emailable.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), 'lib'))
+
+require 'emailable/version'
+
+Gem::Specification.new do |s|
+  s.name = 'emailable'
+  s.version = Emailable::VERSION
+  s.summary = 'Ruby bindings for the Emailable API'
+  s.description = 'Email Verification that’s astonishingly easy and low-cost. '\
+                  'See https://emailable.com for details.'
+  s.homepage = 'https://emailable.com'
+  s.author = 'Emailable'
+  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"
+  }
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    ::File.basename(f)
+  end
+  s.require_paths = ['lib']
+
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'net-http-persistent'
+  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 'minitest', '~> 5.0'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'activemodel'
+end

data/lib/emailable/batch.rb

@@ -0,0 +1,51 @@
+module Emailable
+  class Batch
+    attr_accessor :id
+
+    def initialize(id_or_emails, callback: nil)
+      if id_or_emails.is_a?(Array)
+        @emails = id_or_emails
+        @callback = callback
+      elsif id_or_emails.is_a?(String)
+        @id = id_or_emails
+      else
+        raise ArgumentError, 'expected an array of emails or batch id'
+      end
+
+      @client = Emailable::Client.new
+    end
+
+    def verify
+      return @id unless @id.nil?
+
+      opts = { emails: @emails.join(','), url: @callback }
+      response = @client.request(:post, 'batch', opts)
+
+      @id = response.body['id']
+    end
+
+    def status
+      return nil unless @id
+      return @status if @status
+
+      response = @client.request(:get, 'batch', { id: @id })
+      bs = BatchStatus.new(response.body)
+      @status = bs if bs.complete?
+
+      bs
+    end
+
+    def complete?
+      !status.complete?
+    end
+
+    def inspect
+      ivars = instance_variables.map do |e|
+        [e.to_s.delete('@'), instance_variable_get(e)]
+      end.to_h
+      "#<#{self.class}:0x#{(object_id << 1).to_s(16)}> JSON: " +
+        JSON.pretty_generate(ivars)
+    end
+
+  end
+end

data/lib/emailable/client.rb

@@ -0,0 +1,70 @@
+module Emailable
+  class Client
+
+    def initialize
+      @client = Faraday.new('https://api.emailable.com/v1') do |f|
+        f.request :url_encoded
+        f.response :json, content_type: /\bjson$/
+        f.adapter :net_http_persistent
+      end
+    end
+
+    def request(method, endpoint, opts = {})
+      begin
+        tries ||= 0
+
+        @client.params[:api_key] = Emailable.api_key
+
+        response =
+          if method == :get
+            @client.get(endpoint, opts)
+          elsif method == :post
+            @client.post(endpoint, opts)
+          end
+      rescue => e
+        retry if self.class.should_retry?(e, tries)
+
+        raise e
+      end
+
+      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)
+    end
+
+    def self.should_retry?(error, num_retries)
+      return false if num_retries >= Emailable.max_network_retries
+
+      # Retry on timeout-related problems (either on open or read).
+      return true if error.is_a?(Faraday::TimeoutError)
+
+      # Destination refused the connection, the connection was reset, or a
+      # variety of other connection failures. This could occur from a single
+      # saturated server, so retry in case it's intermittent.
+      return true if error.is_a?(Faraday::ConnectionFailed)
+
+      if error.is_a?(Faraday::ClientError) && error.response
+        # 409 conflict
+        return true if error.response[:status] == 409
+      end
+
+      false
+    end
+  end
+end

data/lib/emailable/email_validator.rb

@@ -0,0 +1,70 @@
+# ActiveRecord validator for validating an email address with Emailable
+#
+# Usage:
+#   validates :email, presence: true, email: {
+#     smtp: true, states: %i[deliverable risky unknown],
+#     free: true, role: true, disposable: false, accept_all: true,
+#     timeout: 3
+#   }
+#
+# Define an attr_accessor to access verification results.
+#   attr_accessor :email_verification_result
+#
+class EmailValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    smtp = boolean_option_or_raise_error(:smtp, true)
+
+    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 "\
+        "any or all of :#{allowed_states.join(', :')}"
+    end
+
+    free = boolean_option_or_raise_error(:free, true)
+    role = boolean_option_or_raise_error(:role, true)
+    disposable = boolean_option_or_raise_error(:disposable, false)
+    accept_all = boolean_option_or_raise_error(:accept_all, true)
+
+    timeout = options.fetch(:timeout, 3)
+    unless timeout.is_a?(Integer) && timeout > 1
+      raise ArgumentError, ":timeout must be an Integer greater than 1"
+    end
+
+    return if record.errors[attribute].present?
+    return unless value.present?
+    return unless record.changes.include?(attribute.to_sym)
+
+    api_options = { timeout: timeout, smtp: smtp }
+    api_options[:accept_all] = true unless accept_all
+    ev = Emailable.verify(value, api_options)
+
+    result_accessor = "#{attribute}_verification_result"
+    if record.respond_to?(result_accessor)
+      record.instance_variable_set("@#{result_accessor}", ev)
+    end
+
+    error ||= ev.state.to_sym unless states.include?(ev.state.to_sym)
+    error ||= :free if ev.free? && !free
+    error ||= :role if ev.role? && !role
+    error ||= :disposable if ev.disposable? && !disposable
+    error ||= :accept_all if ev.accept_all? && !accept_all
+
+    record.errors.add(attribute, error) if error
+  rescue Emailable::Error
+    # silence errors
+  end
+
+  private
+
+  def boolean_option_or_raise_error(name, default)
+    option = options.fetch(name, default)
+    unless [true, false].include?(option)
+      raise ArgumentError, ":#{name} must by a Boolean"
+    end
+
+    option
+  end
+
+end

data/lib/emailable/resources/account.rb

@@ -0,0 +1,5 @@
+module Emailable
+  class Account < APIResource
+    attr_accessor :owner_email, :available_credits
+  end
+end

data/lib/emailable/resources/api_resource.rb

@@ -0,0 +1,20 @@
+module Emailable
+  class APIResource
+
+    def initialize(attributes = {})
+      attributes.each do |attr, value|
+        instance_variable_set("@#{attr}", value)
+      end
+    end
+
+    def inspect
+      ivars = instance_variables.map do |e|
+        [e.to_s.delete('@'), 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
+
+  end
+end

data/lib/emailable/resources/batch_status.rb

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

data/lib/emailable/resources/verification.rb

@@ -0,0 +1,15 @@
+module Emailable
+  class Verification < APIResource
+    attr_accessor :accept_all, :did_you_mean, :disposable, :domain, :duration,
+                  :email, :free, :mx_record, :reason, :role, :score,
+                  :smtp_provider, :state, :tag, :user, :first_name, :last_name,
+                  :full_name, :gender
+
+    %w(accept_all disposable free role).each do |method|
+      define_method("#{method}?") do
+        instance_variable_get "@#{method}"
+      end
+    end
+
+  end
+end

data/lib/emailable/version.rb

@@ -0,0 +1,3 @@
+module Emailable
+  VERSION = '3.0.1'
+end

data/lib/emailable.rb

@@ -0,0 +1,65 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'emailable/version'
+require 'emailable/client'
+require 'emailable/batch'
+require 'emailable/resources/api_resource'
+require 'emailable/resources/account'
+require 'emailable/resources/batch_status'
+require 'emailable/resources/verification'
+if defined?(ActiveModel)
+  require 'emailable/email_validator'
+  I18n.load_path += Dir.glob(File.expand_path('../../config/locales/**/*', __FILE__))
+end
+
+module Emailable
+  @max_network_retries = 1
+
+  class << self
+    attr_accessor :api_key, :max_network_retries
+  end
+
+  module_function
+
+  def verify(email, smtp: nil, accept_all: nil, timeout: nil)
+    opts = {
+      email: email, smtp: smtp, accept_all: accept_all, timeout: timeout
+    }
+
+    client = Emailable::Client.new
+    response = client.request(:get, 'verify', opts)
+
+    if response.status == 249
+      raise Emailable::TimeoutError.new(
+        code: response.status, message: response.body
+      )
+    else
+      Verification.new(response.body)
+    end
+  end
+
+  def account
+    client = Emailable::Client.new
+    response = client.request(:get, 'account')
+    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

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+class EmailValidatorTest < Minitest::Test
+
+  def user_class(
+    smtp: true, states: %i[deliverable risky unknown], free: true, role: true,
+    accept_all: true, disposable: true, timeout: 3
+  )
+    Class.new do
+      include ActiveModel::Model
+      attr_accessor :email, :email_verification_result
+
+      validates :email, presence: true, email: {
+        smtp: smtp, states: states,
+        free: free, role: role, disposable: disposable, accept_all: accept_all,
+        timeout: timeout
+      }
+
+      def self.name
+        'TestClass'
+      end
+
+      # stub changes to always be true
+      def changes
+        { email: true }
+      end
+    end
+  end
+
+  def setup
+    Emailable.api_key = 'test_7aff7fc0142c65f86a00'
+    sleep(0.25)
+  end
+
+  def test_valid
+    @user = user_class.new(email: 'deliverable@example.com')
+
+    assert @user.valid?
+    assert @user.errors.empty?
+  end
+
+  def test_invalid
+    @user = user_class.new(email: 'undeliverable@example.com')
+
+    assert !@user.valid?
+    assert @user.errors[:email].present?
+  end
+
+  def test_verification_result
+    @user = user_class.new(email: 'undeliverable@example.com')
+    @user.valid?
+
+    refute_nil @user.email_verification_result
+    assert @user.email_verification_result.state, :undeliverable
+  end
+
+  def test_boolean_options
+    %i[smtp free role disposable accept_all].each do |option|
+      invalid_user = user_class(option => 'string').new
+      valid_user = user_class.new
+
+      assert !valid_user.valid?
+      assert_raises(ArgumentError) { invalid_user.valid? }
+    end
+  end
+
+  def test_states_option
+    invalid_user = user_class(states: %i[invalid_state]).new
+    valid_user = user_class.new
+
+    assert !valid_user.valid?
+    assert_raises(ArgumentError) { invalid_user.valid? }
+  end
+
+  def test_timeout_option
+    invalid_user1 = user_class(timeout: 'string').new
+    invalid_user2 = user_class(timeout: 1).new
+    valid_user = user_class.new
+
+    assert !valid_user.valid?
+    assert_raises(ArgumentError) { invalid_user1.valid? }
+    assert_raises(ArgumentError) { invalid_user2.valid? }
+  end
+
+end

data/test/emailable/batch_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+module Emailable
+  class BatchTest < Minitest::Test
+
+    def setup
+      sleep(1)
+      Emailable.api_key = 'test_7aff7fc0142c65f86a00'
+      @emails = ['jarrett@emailable.com', 'support@emailable.com']
+      @batch = Emailable::Batch.new(@emails)
+      @batch_id ||= @batch.verify
+      sleep(1)
+    end
+
+    def test_start_batch
+      refute_nil @batch_id
+    end
+
+    def test_batch_status
+      status = @batch.status
+      refute_nil status.message
+    end
+
+    def test_batch_complete
+      complete = @batch.complete?
+      assert complete == true || complete == false
+    end
+
+  end
+end

data/test/emailable_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class EmailableTest < Minitest::Test
+
+  def setup
+    Emailable.api_key = 'test_7aff7fc0142c65f86a00'
+    @result ||= Emailable.verify('jarrett@emailable.com')
+    sleep(0.25)
+  end
+
+  def test_verification
+    refute_nil @result.domain
+    refute_nil @result.email
+    refute_nil @result.reason
+    refute_nil @result.score
+    refute_nil @result.state
+    refute_nil @result.user
+    refute_nil @result.duration
+  end
+
+  def test_verification_state
+    assert %w(deliverable undeliverable risky unknown).include?(@result.state)
+  end
+
+  def test_verification_role
+    result = Emailable.verify('support@emailable.com')
+    assert result.role?
+    refute @result.role?
+  end
+
+  def test_verification_did_you_mean
+    result1 = Emailable.verify('jarrett@gmali.com')
+    result2 = Emailable.verify('jarrett@gmail.com')
+    assert result1.did_you_mean, 'jarrett@gmail.com'
+    assert_nil result2.did_you_mean
+  end
+
+  def test_verification_tag
+    result = Emailable.verify('jarrett+marketing@emailable.com')
+    assert result.tag == 'marketing'
+  end
+
+  def test_account
+    account = Emailable.account
+
+    refute_nil account.owner_email
+    refute_nil account.available_credits
+  end
+
+  def test_name_and_gender
+    result = Emailable.verify('johndoe@emailable.com')
+    if %w(deliverable risky unknown).include?(result.state)
+      assert result.first_name, 'John'
+      assert result.last_name, 'Doe'
+      assert result.full_name, 'John Doe'
+      assert result.gender, 'male'
+    else
+      assert_nil result.first_name
+      assert_nil result.last_name
+      assert_nil result.full_name
+      assert_nil result.gender
+    end
+  end
+
+  def test_slow_verification
+    assert_raises(Emailable::TimeoutError) do
+      Emailable.verify('slow@example.com')
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'active_model'
+require 'emailable'
+
+require 'pry'
+require 'minitest/autorun'
+require 'minitest/reporters'
+Minitest::Reporters.use! [
+  Minitest::Reporters::ProgressReporter.new(color: true)
+]
+Minitest.load_plugins
+Minitest::PrideIO.pride!

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: emailable
+version: !ruby/object:Gem::Version
+  version: 3.0.1
+platform: ruby
+authors:
+- Emailable
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Email Verification that’s astonishingly easy and low-cost. See https://emailable.com
+  for details.
+email: support@emailable.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- emailable.gemspec
+- lib/emailable.rb
+- lib/emailable/batch.rb
+- lib/emailable/client.rb
+- lib/emailable/email_validator.rb
+- lib/emailable/resources/account.rb
+- lib/emailable/resources/api_resource.rb
+- lib/emailable/resources/batch_status.rb
+- lib/emailable/resources/verification.rb
+- lib/emailable/version.rb
+- test/email_validator_test.rb
+- test/emailable/batch_test.rb
+- test/emailable_test.rb
+- test/test_helper.rb
+homepage: https://emailable.com
+licenses:
+- MIT
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+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_test.rb
+- test/test_helper.rb