neverbounce-api 1.0.0

data/lib/never_bounce/api/request/jobs_delete.rb

@@ -0,0 +1,34 @@
+
+require "never_bounce/api/response/jobs_delete"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class JobsDelete < Base
+    # @return [Integer]
+    attr_accessor :job_id
+
+    # @return [Symbol]
+    def self.http_method
+      :post
+    end
+
+    # @return [String]
+    def self.path
+      "jobs/delete"
+    end
+
+    # @return [Response::Jobs::Delete]
+    def self.response_klass
+      Response::JobsDelete
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        job_id: require_attr(:job_id),
+        key: require_attr(:api_key),
+      }
+    end
+  end
+end; end; end

data/lib/never_bounce/api/request/jobs_download.rb

@@ -0,0 +1,34 @@
+
+require "never_bounce/api/response/jobs_download"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class JobsDownload < Base
+    # @return [Integer]
+    attr_accessor :job_id
+
+    # @return [Symbol]
+    def self.http_method
+      :get
+    end
+
+    # @return [String]
+    def self.path
+      "jobs/download"
+    end
+
+    # @return [Response::JobsDownload]
+    def self.response_klass
+      Response::JobsDownload
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        job_id: require_attr(:job_id),
+        key: require_attr(:api_key),
+      }
+    end
+  end
+end; end; end

data/lib/never_bounce/api/request/jobs_parse.rb

@@ -0,0 +1,55 @@
+
+require "never_bounce/api/response/jobs_parse"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class JobsParse < Base
+    # @return [Integer]
+    attr_accessor :job_id
+
+    # @return [Boolean]
+    attr_accessor :auto_start
+
+    # @return [Symbol]
+    def self.http_method
+      :post
+    end
+
+    # @return [String]
+    def self.path
+      "jobs/parse"
+    end
+
+    # @return [Response::JobsParse]
+    def self.response_klass
+      Response::JobsParse
+    end
+
+    # Return a ready-to-merge mode attributes hash.
+    # @return [Hash]
+    def mode_h
+      @mode_h ||= {}.tap do |_|
+        unless (v = auto_start).nil?
+          _[:auto_start] = v
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        job_id: require_attr(:job_id),
+        key: require_attr(:api_key),
+      }.merge(mode_h)
+    end
+  end
+end; end; end
+
+#
+# Implementation notes:
+#
+# * A convention for all classes working with mode attributes like `auto_start`.
+#   * `to_h[:auto_start]` is present if value is not `nil`.
+#   * Passing `request.auto_start = nil` from the outside doesn't affect `to_h` result.
+#     Thus `nil` value renders the request to use server defaults.

data/lib/never_bounce/api/request/jobs_results.rb

@@ -0,0 +1,53 @@
+
+require "never_bounce/api/response/jobs_results"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class JobsResults < Base
+    # @return [Integer]
+    attr_accessor :job_id
+
+    # @return [Integer]
+    attr_accessor :page
+
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # @return [Symbol]
+    def self.http_method
+      :get
+    end
+
+    # @return [String]
+    def self.path
+      "jobs/results"
+    end
+
+    # @return [Response::JobsResults]
+    def self.response_klass
+      Response::JobsResults
+    end
+
+    # @return [Hash]
+    def mode_h
+      @mode_h ||= {}.tap do |_|
+        unless (v = per_page).nil?
+          _[:items_per_page] = v
+        end
+
+        unless (v = page).nil?
+          _[:page] = v
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        job_id: require_attr(:job_id),
+        key: require_attr(:api_key),
+      }.merge(mode_h)
+    end
+  end
+end; end; end

data/lib/never_bounce/api/request/jobs_search.rb

@@ -0,0 +1,57 @@
+
+require "never_bounce/api/response/jobs_search"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class JobsSearch < Base
+    # @return [Integer]
+    attr_accessor :job_id
+
+    # @return [Integer]
+    attr_accessor :page
+
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # @return [Symbol]
+    def self.http_method
+      :get
+    end
+
+    # @return [String]
+    def self.path
+      "jobs/search"
+    end
+
+    # @return [Response::JobsSearch]
+    def self.response_klass
+      Response::JobsSearch
+    end
+
+    # Return a ready-to-merge mode attributes hash.
+    # @return [Hash]
+    def mode_h
+      @mode_h ||= {}.tap do |_|
+        unless (v = job_id).nil?
+          _[:job_id] = v
+        end
+
+        unless (v = page).nil?
+          _[:page] = v
+        end
+
+        unless (v = per_page).nil?
+          _[:items_per_page] = v
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        key: require_attr(:api_key),
+      }.merge(mode_h)
+    end
+  end
+end; end; end

data/lib/never_bounce/api/request/jobs_start.rb

@@ -0,0 +1,47 @@
+
+require "never_bounce/api/response/jobs_start"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class JobsStart < Base
+    # @return [Integer]
+    attr_accessor :job_id
+
+    # @return [Boolean]
+    attr_accessor :run_sample
+
+    # @return [Symbol]
+    def self.http_method
+      :post
+    end
+
+    # @return [String]
+    def self.path
+      "jobs/start"
+    end
+
+    # @return [Response::JobsStart]
+    def self.response_klass
+      Response::JobsStart
+    end
+
+    # Return a ready-to-merge mode attributes hash.
+    # @return [Hash]
+    def mode_h
+      @mode_h ||= {}.tap do |_|
+        unless (v = run_sample).nil?
+          _[:run_sample] = v
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        job_id: require_attr(:job_id),
+        key: require_attr(:api_key),
+      }.merge(mode_h)
+    end
+  end
+end; end; end

data/lib/never_bounce/api/request/jobs_status.rb

@@ -0,0 +1,37 @@
+
+require "never_bounce/api/response/jobs_status"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class JobsStatus < Base
+    # @return [Integer]
+    attr_accessor :job_id
+
+    # @return [Boolean]
+    attr_accessor :auto_start
+
+    # @return [Symbol]
+    def self.http_method
+      :get
+    end
+
+    # @return [String]
+    def self.path
+      "jobs/status"
+    end
+
+    # @return [Response::JobsStatus]
+    def self.response_klass
+      Response::JobsStatus
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        job_id: require_attr(:job_id),
+        key: require_attr(:api_key),
+      }
+    end
+  end
+end; end; end

data/lib/never_bounce/api/request/single_check.rb

@@ -0,0 +1,67 @@
+
+require "never_bounce/api/response/single_check"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class SingleCheck < Base
+    # @return [String]
+    attr_accessor :email
+
+    # @return [Boolean]
+    attr_accessor :address_info
+
+    # @return [Boolean]
+    attr_accessor :credits_info
+
+    # @return [Integer]
+    attr_accessor :timeout
+
+    # @return [Symbol]
+    def self.http_method
+      :get
+    end
+
+    # @return [String]
+    def self.path
+      "single/check"
+    end
+
+    # @return [Response::SingleCheck]
+    def self.response_klass
+      Response::SingleCheck
+    end
+
+    # Return a ready-to-merge mode attributes hash.
+    # @return [Hash]
+    def mode_h
+      @mode_h ||= {}.tap do |_|
+        unless (v = address_info).nil?
+          _[:address_info] = v
+        end
+
+        unless (v = credits_info).nil?
+          _[:credits_info] = v
+        end
+
+        unless (v = timeout).nil?
+          _[:timeout] = v
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        email: require_attr(:email),
+        key: require_attr(:api_key),
+      }.merge(mode_h)
+    end
+  end
+end; end; end
+
+#
+# Implementation notes:
+#
+# * `address_info` and `credits_info` have ugly names for bools, but I keep them for consistency
+#   with the server protocol. We've got the docs stating their type, too.

data/lib/never_bounce/api/response/account_info.rb

@@ -0,0 +1,39 @@
+
+require "never_bounce/api/response/credits_info/monthly"
+require "never_bounce/api/response/credits_info/paid"
+
+require_relative "success_message"
+
+module NeverBounce; module API; module Response
+  class AccountInfo < SuccessMessage
+    require_relative "account_info/job_counts"
+
+    # @!attribute [rw]
+    oattr :credits_info, :writer
+
+    # @!attribute [rw]
+    oattr :job_counts, :writer
+
+    # @return [CreditsInfo::Monthly]
+    # @return [CreditsInfo::Paid]
+    def credits_info
+      @credits_info ||= begin
+        h = body_hash.fetch("credits_info")
+        klass = if h.has_key? "monthly_api_usage"
+          CreditsInfo::Monthly
+        elsif h.has_key? "paid_credits_remaining"
+          CreditsInfo::Paid
+        else
+          raise "Unknown `credits_info`: #{h.inspect}"
+        end
+
+        klass.new(h)
+      end
+    end
+
+    # @return [JobCounts]
+    def job_counts
+      @job_counts ||= JobCounts.new(body_hash: body_hash.fetch("job_counts"))
+    end
+  end
+end; end; end

data/lib/never_bounce/api/response/account_info/job_counts.rb

@@ -0,0 +1,26 @@
+
+require_relative "../account_info"
+
+module NeverBounce; module API; module Response; class AccountInfo
+  class JobCounts < Container
+    # @!attribute completed
+    #   Number of completed jobs.
+    #   @return [Integer]
+    oattr :completed, :scalar, type: :integer
+
+    # @!attribute processing
+    #   Number of jobs in processing.
+    #   @return [Integer]
+    oattr :processing, :scalar, type: :integer   #:nodoc:
+
+    # @!attribute queued
+    #   Number of queued jobs.
+    #   @return [Integer]
+    oattr :queued, :scalar, type: :integer
+
+    # @!attribute under_review
+    #   Number of items under review.
+    #   @return [Integer]
+    oattr :under_review, :scalar, type: :integer
+  end
+end; end; end; end