emailable 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e7635cc0f814700d29137678bd7b53fd91f07f042ff5435b8777cc269a51fb6
-  data.tar.gz: 808f71d2c343495ad48143230d1daa11ba59e334d75a242d25df637abd446b51
+  metadata.gz: 59b57b0948d78b837e5a3f82a0a0e5c5446742f57e50ebbd2c5b0817f0aabfc5
+  data.tar.gz: 58ce6a2ac2a9846e5daa63157014cbe0b557f4c94f30c71d9252db8e169cc12f
 SHA512:
-  metadata.gz: 8a78fd0ab06eca710c67e2e8c01142d0a4bfdfa19f7357c9f54b7a8d53eddaf7b29f32ded7ad85145f414e95782a61dd4774d0a39821f2194f0228b9b402b6c4
-  data.tar.gz: 99f27b66dc848815689fe3a0869b2b47a0f412c3305b910a044488b65598161a8349f690b5772d4e5181e97a4c55fa794f9593d3fa4b60bca5d5ad9a99b84530
+  metadata.gz: 033fe8af379957fdee488fca886d3e3ac4818a7f8587b80554424c7ec824bd9dd1ed949268bc246da1460d0afc449df640cdca8e7bf4fcfbef6790c6c5b1fb1a
+  data.tar.gz: 9d9ff16f6db49bc2c8791ae46be20dfdc7e5d8e58cc9b603e9e04492b85d97bc0bf48b7933ca46a1362469cba4ca923b35a4444c056699716a15417518454897

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.4

data/.travis.yml

@@ -3,5 +3,5 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
-before_install: gem install bundler -v 1.17.3
+  - 2.7.4
+before_install: gem install bundler -v 2.2.15

data/Gemfile.lock

@@ -1,10 +1,7 @@
 PATH
   remote: .
   specs:
-    emailable (3.0.0)
-      faraday
-      faraday_middleware
-      net-http-persistent
+    emailable (3.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -22,14 +19,6 @@ GEM
     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)
@@ -39,15 +28,11 @@ GEM
       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)
@@ -67,4 +52,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Emailable. https://emailable.com
+Copyright (c) 2021 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

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.
 

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/emailable.gemspec

@@ -27,9 +27,6 @@ Gem::Specification.new do |s|
   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'

data/lib/emailable/batch.rb

@@ -4,31 +4,36 @@ module Emailable
 
     def initialize(id_or_emails, callback: nil)
       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
 
       @client = Emailable::Client.new
+      @status = nil
     end
 
-    def verify
+    def verify(simulate: nil)
       return @id unless @id.nil?
 
-      opts = { emails: @emails.join(','), url: @callback }
+      opts = { emails: @emails.join(','), url: @callback, simulate: simulate }
       response = @client.request(:post, 'batch', opts)
 
       @id = response.body['id']
     end
 
-    def status
+    def status(simulate: nil, partial: nil)
       return nil unless @id
       return @status if @status
 
-      response = @client.request(:get, 'batch', { id: @id })
+      body = { id: @id, simulate: simulate, partial: partial }
+      response = @client.request(:get, 'batch', body)
       bs = BatchStatus.new(response.body)
       @status = bs if bs.complete?
 
@@ -36,7 +41,7 @@ module Emailable
     end
 
     def complete?
-      !status.complete?
+      status.complete?
     end
 
     def inspect

data/lib/emailable/client.rb

@@ -1,28 +1,41 @@
 module Emailable
   class Client
+    ERRORS = {
+      400 => BadRequestError,
+      401 => UnauthorizedError,
+      402 => PaymentRequiredError,
+      403 => ForbiddenError,
+      404 => NotFoundError,
+      429 => TooManyRequestsError,
+      500 => InternalServerError,
+      503 => ServiceUnavailableError
+    }.freeze
 
     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
+      @base_url = 'https://api.emailable.com/v1'
+      @connection = create_connection(URI(@base_url))
     end
 
-    def request(method, endpoint, opts = {})
+    def request(method, endpoint, params = {})
       begin
-        tries ||= 0
+        tries ||= 3
 
-        @client.params[:api_key] = Emailable.api_key
+        uri = URI("#{@base_url}/#{endpoint}")
+        params[:api_key] = Emailable.api_key
 
-        response =
+        http_response =
           if method == :get
-            @client.get(endpoint, opts)
+            uri.query = URI.encode_www_form(params)
+            @connection.get(uri)
           elsif method == :post
-            @client.post(endpoint, opts)
+            request = Net::HTTP::Post.new(uri, 'Content-Type': 'application/json')
+            request.body = params.to_json
+            @connection.request(request)
           end
+
+        response = Response.new(http_response)
       rescue => e
-        retry if self.class.should_retry?(e, tries)
+        retry if (tries -= 1) > 0 && self.class.should_retry?(e, tries)
 
         raise e
       end
@@ -30,41 +43,62 @@ 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
+
+    def create_connection(uri)
+      connection = Net::HTTP.new(uri.host, uri.port)
+
+      # Time in seconds within which Net::HTTP will try to reuse an already
+      # open connection when issuing a new operation. Outside this window, Ruby
+      # will transparently close and re-open the connection without trying to
+      # reuse it.
+      #
+      # Ruby's default of 2 seconds is almost certainly too short. Here I've
+      # reused Go's default for `DefaultTransport`.
+      connection.keep_alive_timeout = 30
+
+      connection.open_timeout = Emailable.open_timeout
+      connection.read_timeout = Emailable.read_timeout
+      if connection.respond_to?(:write_timeout=)
+        connection.write_timeout = Emailable.write_timeout
+      end
+      connection.use_ssl = uri.scheme == "https"
+
+      connection
     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)
+      case error
+      when Net::OpenTimeout, Net::ReadTimeout
+        # Retry on timeout-related problems (either on open or read).
+        true
+      when EOFError, Errno::ECONNREFUSED, Errno::ECONNRESET,
+        Errno::EHOSTUNREACH, Errno::ETIMEDOUT, SocketError
+        # 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.
+        true
+      when Net::HTTPError
+        # 409 Conflict
+        return true if error.http_status == 409
 
-      # 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)
+        # 429 Too Many Requests
+        return true if error.http_status == 429
 
-      if error.is_a?(Faraday::ClientError) && error.response
-        # 409 conflict
-        return true if error.response[:status] == 409
-      end
+        # 500 Internal Server Error
+        return true if error.http_status == 500
 
-      false
+        # 503 Service Unavailable
+        error.http_status == 503
+      else
+        false
+      end
     end
+
   end
 end

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/response.rb

@@ -0,0 +1,12 @@
+module Emailable
+  class Response
+
+    attr_accessor :status, :body
+
+    def initialize(response)
+      @status = response.code.to_i
+      @body = JSON.parse(response.body)
+    end
+
+  end
+end

data/lib/emailable/version.rb

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

data/lib/emailable.rb

@@ -1,7 +1,10 @@
-require 'faraday'
-require 'faraday_middleware'
+require 'net/http'
+require 'json'
+
 require 'emailable/version'
+require 'emailable/errors'
 require 'emailable/client'
+require 'emailable/response'
 require 'emailable/batch'
 require 'emailable/resources/api_resource'
 require 'emailable/resources/account'
@@ -14,9 +17,13 @@ end
 
 module Emailable
   @max_network_retries = 1
+  @open_timeout = 30
+  @read_timeout = 60
+  @write_timeout = 30
 
   class << self
-    attr_accessor :api_key, :max_network_retries
+    attr_accessor :api_key, :max_network_retries, :open_timeout, :read_timeout,
+      :write_timeout
   end
 
   module_function
@@ -30,9 +37,7 @@ module Emailable
     response = client.request(:get, 'verify', opts)
 
     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
@@ -44,22 +49,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,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: emailable
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Emailable
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2022-01-17 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
@@ -176,13 +134,16 @@ 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
 - lib/emailable/resources/verification.rb
+- lib/emailable/response.rb
 - 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
@@ -192,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
@@ -207,12 +168,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.1.6
+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