zerobounce 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ef1325579afd30cbb3769cfbfe204c057fa7f12
-  data.tar.gz: 425716b0fc5f8af222625c4b9761745363d6fac8
+  metadata.gz: c721e810255839a88073d013c9b97065471160e1
+  data.tar.gz: 84b8c3683741ea097daba407bc245ebd0d92b3cf
 SHA512:
-  metadata.gz: 9cdf22f0b5d461eb37247ba3ab8facdbd73edea58381a54d3f9f85e5bc960dcab76f88549f9452b1d69af23c43e8847ece85e9ec405d8538a8ce7602e71367b5
-  data.tar.gz: 0674c6bdd1e4b52ccd492315c59faf5006c7c1a29534082c6300ee064c292c3aeffc4b12ad248f471c955cc9ea281c610de2e767a43a9cc8e9d976586cb68cd4
+  metadata.gz: be2427a95a25fed9e115da52757cefe0c389a67e02d6b720117ae24f760c5de86603a0b9b8af2d46f9c30ede766e83d2003d64b4633cd3b3cfdcd360654f33c7
+  data.tar.gz: 9ec05422f597f3b91fba26d07ef5d57be77a46b0936a61481a6b9290121a5e20eb7c4917cd0c0e266b3e519a67d3839b757420be8ffcd630e7441f7b53c866ae

data/lib/zerobounce.rb

@@ -43,11 +43,7 @@ module Zerobounce
     # @option params [Proc] :middleware Use different middleware for this request.
     # @return [Zerobounce::Response]
     def validate(params)
-      if params.key?(:ipaddress) || params.key?(:ip_address)
-        Request.new(params).validate_with_ip(params)
-      else
-        Request.new(params).validate(params)
-      end
+      Request.new(params).validate(params)
     end
 
     # Get the number of remaining credits on the account.

data/lib/zerobounce/configuration.rb

@@ -24,6 +24,9 @@ module Zerobounce
   #   @note If you modify the default make sure to add middleware to parse
   #     the response as json and symbolize the keys.
   #
+  # @attr [String] api_version
+  #   The version of the API to use.
+  #
   # @attr [Array<Symbol>] valid_statues
   #   The statuses that are considered valid by {Response#valid?}.
   class Configuration
@@ -31,16 +34,19 @@ module Zerobounce
     attr_accessor :headers
     attr_accessor :apikey
     attr_accessor :middleware
+    attr_accessor :api_version
     attr_accessor :valid_statuses
 
     def initialize
       self.host = 'https://api.zerobounce.net'
       self.apikey = ENV['ZEROBOUNCE_API_KEY']
+      self.api_version = 'v2'
       self.valid_statuses = %i[valid catch_all]
       self.headers = { user_agent: "ZerobounceRubyGem/#{Zerobounce::VERSION}" }
 
       self.middleware = proc do |builder|
         builder.response(:json, content_type: /\bjson$/, parser_options: { symbolize_names: true })
+        builder.response(:logger) { |l| l.filter(/(api_?key=)(\w+)/, '\1[REMOVED]') } if ENV['ZEROBOUNCE_API_DEBUG']
         builder.use(Zerobounce::Middleware::RaiseError)
         builder.adapter(Faraday.default_adapter)
       end

data/lib/zerobounce/request.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'zerobounce/request/v1_request'
+require 'zerobounce/request/v2_request'
 
 module Zerobounce
   # Sends the HTTP request.
@@ -16,46 +18,30 @@ module Zerobounce
   # @attr_reader [Proc] middleware
   #   Faraday middleware used for the request.
   class Request
-    # The normal email validation endpoint.
-    VALIDATE_PATH = '/v1/validate'
-    # The validation endpoint for email and IP validation.
-    VALIDATE_WITH_IP_PATH = '/v1/validatewithip'
-    # The path to get number number of credits remaining on the account.
-    GET_CREDITS_PATH = '/v1/getcredits'
-
     attr_reader :host
     attr_reader :headers
     attr_reader :middleware
+    attr_reader :api_version
 
+    # Set instance variables and extends the correct Zerobounce::Request
+    #
     # @param [Hash] params
     # @option params [String] :middleware default: {Configuration#middleware} {include:#middleware}
     # @option params [String] :headers default: {Configuration#headers} {include:#headers}
     # @option params [String] :host default: {Configuration#host} {include:#host}
+    # @option params [String] :api_version default: {Configuration#api_version} {include:#api_version}
     def initialize(params={})
       @middleware = params[:middleware] || Zerobounce.config.middleware
       @headers = params[:headers] || Zerobounce.config.headers
       @host = params[:host] || Zerobounce.config.host
-    end
-
-    # Validate the email address.
-    #
-    # @param [Hash] params
-    # @option params [String] :email
-    # @option params [String] :apikey
-    # @return [Zerobounce::Response]
-    def validate(params)
-      Response.new(get(VALIDATE_PATH, params), self)
-    end
+      @api_version = params[:api_version] || Zerobounce.config.api_version
 
-    # Validate the email address and get geoip info for the IP.
-    #
-    # @param [Hash] params
-    # @option params [String] :email
-    # @option params [String] :ip_address
-    # @option params [String] :apikey
-    # @return [Zerobounce::Response]
-    def validate_with_ip(params)
-      Response.new(get(VALIDATE_WITH_IP_PATH, params), self)
+      case api_version
+      when 'v2'
+        extend(V2Request)
+      else
+        extend(V1Request)
+      end
     end
 
     # Get the number of remaining credits on the account.
@@ -64,7 +50,7 @@ module Zerobounce
     # @option params [String] :apikey
     # @return [Integer] A value of -1 can mean the API is invalid.
     def credits(params={})
-      get(GET_CREDITS_PATH, params).body[:Credits]&.to_i
+      get('getcredits', params).body[:Credits]&.to_i
     end
 
     private
@@ -80,15 +66,7 @@ module Zerobounce
 
     # @return [Faraday::Connection]
     def conn
-      @conn ||= Faraday.new(host, headers: headers, &middleware)
-    end
-
-    # @param [Hash] params
-    # @return [Hash]
-    def get_params(params)
-      valid_params = %i[apikey ipaddress email]
-      params[:ipaddress] = params.delete(:ip_address) if params.key?(:ip_address) # normalize ipaddress key
-      { apikey: Zerobounce.config.apikey }.merge(params.select { |k, _| valid_params.include?(k) })
+      @conn ||= Faraday.new("#{host}/#{api_version}", headers: headers, &middleware)
     end
   end
 end

data/lib/zerobounce/request/v1_request.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Zerobounce
+  class Request
+    # Request methods specific to V1 of the API.
+    module V1Request
+      # Valid v1 get query params
+      VALID_GET_PARAMS = %i[apikey ipaddress email].freeze
+
+      # Validate the email address.
+      #
+      # @param [Hash] params
+      # @option params [String] :email
+      # @option params [String] :ip_address
+      # @option params [String] :apikey
+      # @return [Zerobounce::Response]
+      def validate(params)
+        if params.key?(:ipaddress) || params.key?(:ip_address)
+          validate_with_ip(params)
+        else
+          Response.new(get('validate', params), self)
+        end
+      end
+
+      # Validate the email address and get geoip info for the IP.
+      #
+      # @param [Hash] params
+      # @option params [String] :email
+      # @option params [String] :ip_address
+      # @option params [String] :apikey
+      # @return [Zerobounce::Response]
+      def validate_with_ip(params)
+        Response.new(get('validatewithip', params), self)
+      end
+
+      private
+
+      # @param [Hash] params
+      # @return [Hash]
+      def get_params(params)
+        params[:ipaddress] = params.delete(:ip_address) if params.key?(:ip_address) # normalize ipaddress key
+        params[:apikey] = params.delete(:api_key) if params.key?(:api_key) # normalize apikey param
+        { apikey: Zerobounce.config.apikey }.merge(params.select { |k, _| VALID_GET_PARAMS.include?(k) })
+      end
+    end
+  end
+end

data/lib/zerobounce/request/v2_request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Zerobounce
+  class Request
+    # Request methods specific to V2 of the API.
+    module V2Request
+      # Valid v2 query params
+      VALID_GET_PARAMS = %i[api_key ip_address email].freeze
+
+      # Validate the email address.
+      #
+      # @param [Hash] params
+      # @option params [String] :email
+      # @option params [String] :ip_address
+      # @option params [String] :api_key
+      # @return [Zerobounce::Response]
+      def validate(params)
+        Response.new(get('validate', params), self)
+      end
+
+      private
+
+      # @param [Hash] params
+      # @return [Hash]
+      def get_params(params)
+        params[:ip_address] ||= '' # ip_address must be in query string
+        params[:api_key] = params.delete(:apikey) if params.key?(:apikey) # normalize api_key param
+        { api_key: Zerobounce.config.apikey }.merge(params.select { |k, _| VALID_GET_PARAMS.include?(k) })
+      end
+    end
+  end
+end

data/lib/zerobounce/response.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'time'
+require 'zerobounce/response/v1_response'
+require 'zerobounce/response/v2_response'
 
 module Zerobounce
   # A Zerobounce response
@@ -22,51 +24,13 @@ module Zerobounce
       @response = response
       @request = request
       @body = response.body
-    end
-
-    # Deliverability status
-    #
-    # Possible values:
-    #   :valid
-    #   :invalid
-    #   :catch_all
-    #   :unknown
-    #   :spamtrap
-    #   :abuse
-    #   :do_not_mail
-    #
-    # @return [Symbol] The status as a +Symbol+.
-    def status
-      @status ||= underscore(@body[:status])&.to_sym
-    end
 
-    # A more detailed status
-    #
-    # Possible values:
-    #   :antispam_system
-    #   :greylisted
-    #   :mail_server_temporary_error
-    #   :forcible_disconnect
-    #   :mail_server_did_not_respond
-    #   :timeout_exceeded
-    #   :failed_smtp_connection
-    #   :mailbox_quota_exceeded
-    #   :exception_occurred
-    #   :possible_traps
-    #   :role_based
-    #   :global_suppression
-    #   :mailbox_not_found
-    #   :no_dns_entries
-    #   :failed_syntax_check
-    #   :possible_typo
-    #   :unroutable_ip_address
-    #   :leading_period_removed
-    #   :does_not_accept_mail
-    #   :alias_address
-    #
-    # @return [Symbol] The sub_status as a +Symbol+.
-    def sub_status
-      @sub_status ||= underscore(@body[:sub_status])&.to_sym
+      case request.api_version
+      when 'v2'
+        extend(V2Response)
+      else
+        extend(V1Response)
+      end
     end
 
     # The email address you are validating.
@@ -111,13 +75,6 @@ module Zerobounce
       @gender ||= @body[:gender]
     end
 
-    # The location of the owner of the email when available.
-    #
-    # @return [String, nil]
-    def location
-      @location ||= @body[:location]
-    end
-
     # The country of the IP passed in.
     #
     # @return [String, nil]
@@ -162,48 +119,13 @@ module Zerobounce
       !valid?
     end
 
-    # If the email domain is disposable, which are usually temporary email addresses.
-    #
-    # These are temporary emails created for the sole purpose to sign up to websites without giving their real
-    # email address. These emails are short lived from 15 minutes to around 6 months.
-    #
-    # @note If you have valid emails with this flag set to +true+, you shouldn't email them.
-    #
-    # @return [Boolean]
-    def disposable?
-      @disposable ||= @body[:disposable] || false
-    end
-
-    # These domains are known for abuse, spam, or are bot created.
-    #
-    # @note If you have a valid email with this flag set to +true+, you shouldn't email them.
-    #
-    # @return [Boolean]
-    def toxic?
-      @toxic ||= @body[:toxic] || false
-    end
-
-    # The UTC time the email was validated.
-    #
-    # @return [Time, nil]
-    def process_date
-      @process_date ||= @body[:processedat] && Time.parse(@body[:processedat])
-    end
-
-    # The creation date of the email when available.
-    #
-    # @return [Time, nil]
-    def creation_date
-      @creation_date ||= @body[:creationdate] && Time.parse(@body[:creationdate])
-    end
-
     # Returns a string containing a human-readable representation.
     #
     # @note Overriding inspect to hide the {#request}/{#response} instance variables
     #
     # @return [String]
     def inspect
-      "#<#{self.class.name}:#{object_id}>"
+      "#<#{self.class.name}:0x#{object_id.to_s(16)} @address=#{address}>"
     end
 
     # Convert to a hash.
@@ -215,14 +137,5 @@ module Zerobounce
         memo[meth] = send(meth)
       end
     end
-
-    private
-
-    # @param [String, nil] word
-    # @return [String, nil]
-    def underscore(word)
-      return if word.nil? || word.empty?
-      word.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase.tr('-', '_')
-    end
   end
 end

data/lib/zerobounce/response/v1_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Zerobounce
+  class Response
+    # V1 specific methods for the API.
+    module V1Response
+      # Deliverability status
+      #
+      # Possible values:
+      #   :valid
+      #   :invalid
+      #   :catch_all
+      #   :unknown
+      #   :spamtrap
+      #   :abuse
+      #   :do_not_mail
+      #
+      # @return [Symbol] The status as a +Symbol+.
+      def status
+        @status ||= underscore(@body[:status])&.to_sym
+      end
+
+      # A more detailed status
+      #
+      # Possible values:
+      #   :antispam_system
+      #   :greylisted
+      #   :mail_server_temporary_error
+      #   :forcible_disconnect
+      #   :mail_server_did_not_respond
+      #   :timeout_exceeded
+      #   :failed_smtp_connection
+      #   :mailbox_quota_exceeded
+      #   :exception_occurred
+      #   :possible_traps
+      #   :role_based
+      #   :global_suppression
+      #   :mailbox_not_found
+      #   :no_dns_entries
+      #   :failed_syntax_check
+      #   :possible_typo
+      #   :unroutable_ip_address
+      #   :leading_period_removed
+      #   :does_not_accept_mail
+      #   :alias_address
+      #
+      # @return [Symbol] The sub_status as a +Symbol+.
+      def sub_status
+        @sub_status ||= underscore(@body[:sub_status])&.to_sym
+      end
+
+      # If the email domain is disposable, which are usually temporary email addresses.
+      #
+      # These are temporary emails created for the sole purpose to sign up to websites without giving their real
+      # email address. These emails are short lived from 15 minutes to around 6 months.
+      #
+      # @note If you have valid emails with this flag set to +true+, you shouldn't email them.
+      #
+      # @return [Boolean]
+      def disposable?
+        @disposable ||= @body[:disposable] || false
+      end
+
+      # These domains are known for abuse, spam, or are bot created.
+      #
+      # @note If you have a valid email with this flag set to +true+, you shouldn't email them.
+      #
+      # @return [Boolean]
+      def toxic?
+        @toxic ||= @body[:toxic] || false
+      end
+
+      # The location of the owner of the email when available.
+      #
+      # @return [String, nil]
+      def location
+        @location ||= @body[:location]
+      end
+
+      # The UTC time the email was validated.
+      #
+      # @return [Time, nil]
+      def processed_at
+        @processed_at ||= @body[:processedat] && Time.parse(@body[:processedat])
+      end
+
+      # The creation date of the email when available.
+      #
+      # @return [Time, nil]
+      def creation_date
+        @creation_date ||= @body[:creationdate] && Time.parse(@body[:creationdate])
+      end
+
+      private
+
+      # @param [String, nil] word
+      # @return [String, nil]
+      def underscore(word)
+        return if word.nil? || word.empty?
+        word.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase.tr('-', '_')
+      end
+    end
+  end
+end

data/lib/zerobounce/response/v2_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Zerobounce
+  class Response
+    # V2 specific methods for the API.
+    module V2Response
+      # Deliverability status
+      #
+      # @see https://docs.zerobounce.net/docs/status-codes-v2
+      #
+      # Possible values:
+      #   :valid
+      #   :invalid
+      #   :catch_all
+      #   :unknown
+      #   :spamtrap
+      #   :abuse
+      #   :do_not_mail
+      #
+      # @return [Symbol] The status as a +Symbol+.
+      def status
+        @status ||= @body[:status]&.tr('-', '_')&.to_sym
+      end
+
+      # @return [Symbol, nil]
+      def sub_status
+        @sub_status ||= @body[:sub_status] == '' ? nil : @body[:sub_status]&.to_sym
+      end
+
+      # @return [Integer]
+      def domain_age_days
+        @domain_age_days ||= @body[:domain_age_days].to_i
+      end
+
+      # The SMTP Provider of the email.
+      #
+      # @return [String, nil]
+      def smtp_provider
+        @smtp_provider ||= @body[:smtp_provider]
+      end
+
+      # @return [String, nil]
+      def did_you_mean
+        @did_you_mean ||= @body[:did_you_mean]
+      end
+
+      # The preferred MX record of the domain.
+      #
+      # @return [String, nil]
+      def mx_record
+        @mx_record ||= @body[:mx_record]
+      end
+
+      # The UTC time the email was validated.
+      #
+      # @return [Time, nil]
+      def processed_at
+        @processed_at ||= @body[:processed_at] && Time.parse(@body[:processed_at])
+      end
+
+      # If the email comes from a free provider.
+      #
+      # @return [Boolean]
+      def free_email?
+        @free_email ||= @body[:free_email] || false
+      end
+
+      # If the email domain is disposable, which are usually temporary email addresses.
+      #
+      # These are temporary emails created for the sole purpose to sign up to websites without giving their real
+      # email address. These emails are short lived from 15 minutes to around 6 months.
+      #
+      # @note If you have valid emails with this flag set to +true+, you shouldn't email them.
+      #
+      # @return [Boolean]
+      def disposable?
+        @disposable ||= sub_status == :disposable
+      end
+
+      # These domains are known for abuse, spam, or are bot created.
+      #
+      # @note If you have a valid email with this flag set to +true+, you shouldn't email them.
+      #
+      # @return [Boolean]
+      def toxic?
+        @toxic ||= sub_status == :toxic
+      end
+
+      # Does the domain have an MX record.
+      #
+      # @return [Boolean]
+      def mx_found?
+        @mx_found ||= @body[:mx_found] == 'true'
+      end
+    end
+  end
+end

data/lib/zerobounce/version.rb

@@ -2,5 +2,5 @@
 
 module Zerobounce
   # The version of the gem.
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zerobounce
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Aaron Frase
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-26 00:00:00.000000000 Z
+date: 2018-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -197,7 +197,11 @@ files:
 - lib/zerobounce/error.rb
 - lib/zerobounce/middleware/raise_error.rb
 - lib/zerobounce/request.rb
+- lib/zerobounce/request/v1_request.rb
+- lib/zerobounce/request/v2_request.rb
 - lib/zerobounce/response.rb
+- lib/zerobounce/response/v1_response.rb
+- lib/zerobounce/response/v2_response.rb
 - lib/zerobounce/version.rb
 - zerobounce.gemspec
 homepage: https://github.com/afrase/zerobounce