zerobounce-sdk 0.4.0

data/files/zerobounce-batch-validation.csv

@@ -0,0 +1,31 @@
+email,first,last,gender,ip
+disposable@example.com,First,Last,male,127.0.0.1
+invalid@example.com,First,Last,male,127.0.0.1
+valid@example.com,First,Last,male,127.0.0.1
+toxic@example.com,First,Last,male,127.0.0.1
+donotmail@example.com,First,Last,male,127.0.0.1
+spamtrap@example.com,First,Last,male,127.0.0.1
+abuse@example.com,First,Last,male,127.0.0.1
+unknown@example.com,First,Last,male,127.0.0.1
+catch_all@example.com,First,Last,male,127.0.0.1
+antispam_system@example.com,First,Last,male,127.0.0.1
+does_not_accept_mail@example.com,First,Last,male,127.0.0.1
+exception_occurred@example.com,First,Last,male,127.0.0.1
+failed_smtp_connection@example.com,First,Last,male,127.0.0.1
+failed_syntax_check@example.com,First,Last,male,127.0.0.1
+forcible_disconnect@example.com,First,Last,male,127.0.0.1
+global_suppression@example.com,First,Last,male,127.0.0.1
+greylisted@example.com,First,Last,male,127.0.0.1
+leading_period_removed@example.com,First,Last,male,127.0.0.1
+mail_server_did_not_respond@example.com,First,Last,male,127.0.0.1
+mail_server_temporary_error@example.com,First,Last,male,127.0.0.1
+mailbox_quota_exceeded@example.com,First,Last,male,127.0.0.1
+mailbox_not_found@example.com,First,Last,male,127.0.0.1
+no_dns_entries@example.com,First,Last,male,127.0.0.1
+possible_trap@example.com,First,Last,male,127.0.0.1
+possible_typo@example.com,First,Last,male,127.0.0.1
+role_based@example.com,First,Last,male,127.0.0.1
+timeout_exceeded@example.com,First,Last,male,127.0.0.1
+unroutable_ip_address@example.com,First,Last,male,127.0.0.1
+free_email@example.com,First,Last,male,127.0.0.1
+role_based_catch_all@example.com,First,Last,male,127.0.0.1

data/lib/zerobounce/base_request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# https://github.com/rest-client/rest-client
+require 'rest-client'
+
+
+module Zerobounce
+  
+  # Sends the HTTP request.
+  class BaseRequest
+
+    protected 
+
+    def self._get(root, path, params, content_type='application/json')
+
+      # puts path
+      # puts Zerobounce.config.apikey
+
+      raise ("API key must be assigned") if not Zerobounce.config.apikey
+
+      params[:api_key] = Zerobounce.config.apikey
+      url = "#{root}/#{path}"
+
+      response = RestClient.get(url, {params: params})
+      return response
+    end
+
+    def self._post(root, path, params, content_type='application/json', filepath=nil)
+
+      raise ("API key must be assigned") if not Zerobounce.config.apikey
+
+      params[:api_key] = Zerobounce.config.apikey
+      url = "#{root}/#{path}"
+      response = nil
+
+      if filepath or content_type == 'multipart/form-data'
+        params[:file] = File.new(filepath, 'rb')
+        params[:multipart] = true
+        response = RestClient.post(url, params)
+
+      elsif content_type == 'application/json'
+        response = RestClient.post(url, params.to_json, \
+                      content_type: :json, accept: :json)
+      else
+        # this shouldn't happen
+        raise Error.new('Unknown content type specified in request.'\
+          ' Must be either multipart/form-data or application/json.')
+      end
+      return response
+    end
+
+  end
+end

data/lib/zerobounce/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
+module Zerobounce
+  # Configuration object for Zerobounce.
+  #
+  # @author Aaron Frase
+  #
+  # @attr [String] host
+  #   The Zerobounce API host.
+  #
+  # @attr [Hash] headers
+  #   Headers to use in all requests.
+  #
+  # @attr [String] apikey
+  #   A Zerobounce API key.
+  #
+  # @attr [Array<Symbol>] valid_statues
+  #   The statuses that are considered valid by {Response#valid?}.
+  class Configuration
+    attr_accessor :host
+    attr_accessor :headers
+    attr_accessor :apikey
+    attr_accessor :valid_statuses
+    attr_accessor :mock
+
+    def initialize(mock=false)
+      self.host = 'https://api.zerobounce.net'
+      self.apikey = ENV['ZEROBOUNCE_API_KEY']
+      self.valid_statuses = %i[valid catch_all]
+      self.headers = { user_agent: "ZerobounceRubyGem/#{Zerobounce::VERSION}" }
+      self.mock = mock
+    end
+  end
+end

data/lib/zerobounce/error.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# todo:
+
+module Zerobounce
+  # The base Zerobounce error.
+  #
+  # @author Aaron Frase
+  class Error < StandardError
+    attr_reader :env
+
+    def initialize(env={})
+      @env = env
+      super(env[:body])
+    end
+
+    class << self
+      # Parse the response for errors.
+      #
+      # @param [Hash] env
+      # @return [Error, nil]
+      def from_response(env)
+        case env[:status]
+        when 500
+          parse500(env)
+        when 200
+          parse200(env)
+        else
+          UnknownError.new(env)
+        end
+      end
+
+      private
+
+      # @param [Hash] env
+      # @return [Error]
+      def parse500(env)
+        if env[:body].to_s.start_with?('Missing parameter')
+          MissingParameter.new(env)
+        else
+          InternalServerError.new(env)
+        end
+      end
+
+      # @param [Hash] env
+      # @return [Error, nil]
+      def parse200(env)
+        # The body hasn't been parsed yet and to avoid potentially parsing the body twice
+        # we just use String#start_with?
+        ApiError.new(env) if env[:body].to_s.start_with?('{"error":')
+      end
+    end
+  end
+
+  # Server returned a 500 error.
+  #
+  # @author Aaron Frase
+  class InternalServerError < Error
+  end
+
+  # A parameter was missing, usually the apikey.
+  #
+  # @author Aaron Frase
+  class MissingParameter < Error
+  end
+
+  # When the status code isn't in the defined codes to parse.
+  #
+  # @author Aaron Frase
+  class UnknownError < Error
+  end
+
+  # General API error, the response code was 200 but an error still occurred.
+  #
+  # @author Aaron Frase
+  class ApiError < Error
+    # @see #message
+    def message
+      JSON.parse(@env[:body])['error']
+    end
+  end
+end

data/lib/zerobounce/mock_request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'zerobounce/base_request'
+
+module Zerobounce
+  
+  # Sends the HTTP request.
+  class MockRequest < BaseRequest
+    
+    def self.get(path, params, content_type='application/json')
+      response = self._get(Zerobounce::API_ROOT_URL, path, params, content_type)
+      if response.headers[:content_type] == 'application/json'
+        response_body = response.body
+        response_body_json = JSON.parse(response_body) 
+
+        raise (response_body_json['error']) if response_body_json.key?('error')
+        raise (response_body_json['errors'][0]['error']) \
+          if response_body_json.key?('errors') and \
+            response_body_json['errors'].length > 0
+
+        return response_body_json
+      else 
+        return response
+      end
+    end
+
+    def self.bulk_get(path, params, content_type='application/json')
+      response = self._get(Zerobounce::BULK_API_ROOT_URL, path, params, content_type)
+      if response.headers[:content_type] == 'application/json'
+        response_body = response.body
+        response_body_json = JSON.parse(response_body)
+
+        raise (response_body_json['error']) if response_body_json.key?('error')
+        raise (response_body_json['errors'][0]['error']) \
+          if response_body_json.key?('errors') and \
+            response_body_json['errors'].length > 0
+
+        return response_body_json
+      else
+        return response.body
+      end
+    end
+
+    def self.bulk_post(path, params, content_type='application/json', filepath=nil)
+      response = self._post(Zerobounce::BULK_API_ROOT_URL, path, params, \
+          content_type, filepath)
+      if response.headers[:content_type] == 'application/json'
+        response_body = response.body
+        response_body_json = JSON.parse(response_body) 
+
+        raise (response_body_json['error']) if response_body_json.key?('error')
+        raise (response_body_json['errors'][0]['error']) \
+          if response_body_json.key?('errors') and \
+            response_body_json['errors'].length > 0
+
+        return response_body_json
+      end
+      return response.body
+    end
+
+  end
+
+end

data/lib/zerobounce/request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'zerobounce/base_request'
+
+module Zerobounce
+  
+  # Sends the HTTP request.
+  class Request < BaseRequest
+
+    def self.get(path, params, content_type='application/json')
+      response = self._get(Zerobounce::API_ROOT_URL, path, params, content_type)
+      if response.headers[:content_type] == 'application/json'
+        response_body = response.body
+        response_body_json = JSON.parse(response_body) 
+
+        raise (response_body_json['error']) if response_body_json.key?('error')
+        raise (response_body_json['errors'][0]['error']) \
+          if response_body_json.key?('errors') and \
+            response_body_json['errors'].length > 0
+
+        return response_body_json
+      else 
+        return response
+      end
+    end
+
+    def self.bulk_get(path, params, content_type='application/json')
+      response = self._get(Zerobounce::BULK_API_ROOT_URL, path, params, content_type)
+      if response.headers[:content_type] == 'application/json'
+        response_body = response.body
+        response_body_json = JSON.parse(response_body)
+
+        raise (response_body_json['error']) if response_body_json.key?('error')
+        raise (response_body_json['errors'][0]['error']) \
+          if response_body_json.key?('errors') and \
+            response_body_json['errors'].length > 0
+
+        return response_body_json
+      else
+        return response.body
+      end
+    end
+
+    def self.bulk_post(path, params, content_type='application/json', filepath=nil)
+      response = self._post(Zerobounce::BULK_API_ROOT_URL, path, params, \
+          content_type, filepath)
+      if response.headers[:content_type] == 'application/json'
+        response_body = response.body
+        response_body_json = JSON.parse(response_body) 
+
+        raise (response_body_json['error']) if response_body_json.key?('error')
+        raise (response_body_json['errors'][0]['error']) \
+          if response_body_json.key?('errors') and \
+            response_body_json['errors'].length > 0
+
+        return response_body_json
+      end
+      return response.body
+    end
+
+  end
+
+end

data/lib/zerobounce/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Zerobounce
+  # The version of the gem.
+  VERSION = '0.4.0'
+end