neverbounce-api 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da7750382da1d6b5deddf629b7a592ea48cc265f
-  data.tar.gz: e5172de975642ebf2fee9c766ebfa8186853299e
+  metadata.gz: a4914041f3d0851a7bc008ad8ae7a93d788d9722
+  data.tar.gz: 9bfb58a3ef4662106c64160cbeae2edbdce1edc8
 SHA512:
-  metadata.gz: fed8ba58fab324a869a11571de730549469118e1af58894c708393c65a6b1ad502c05ed4ad1e75093adfe35853b470457a60aee0631c5ec92499ec9039f1f043
-  data.tar.gz: 5b389616e21e31f82a264fe0c9e7b5233f0a0f2feb6aadc6988dd1aefacccbd4f24fd624251c7b515ba490c88ebcae965df5d56a46d77f791e873a0fabd9fe1c
+  metadata.gz: 8fc8a9fc1608a38a5f5eab79fe7941e36310d22c0391b9e338f20a05b318e1d972e64bf498adf2dbb638a05f7f0846b9ab915456e96f750e3d31a8de6f27458f
+  data.tar.gz: 380320a15db88c0e2b995e95e8d5b0ffb209ca8d043f81bcace0ee5501a6159bdeb86f029e2653e002a6aa0c9a489dfbf3576ddb9d84520a66119431d0585a22

data/.travis.yml

@@ -6,10 +6,10 @@ env:
     - CC_TEST_REPORTER_ID=9300cb7898e254e78099399acbb2796471fde0e5c1873899273a583d56c9d740
 
 before_install:
-  - gem update --system
   - gem install bundler
 
 install:
+  - bundle update --bundler
   - bundle install --path ~/bundle
 
 before_script:
@@ -24,9 +24,7 @@ after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neverbounce-api (1.0.3)
+    neverbounce-api (1.1.0)
       httparty (~> 0.15)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     diff-lcs (1.3)
     docile (1.1.5)
-    httparty (0.15.6)
+    httparty (0.16.2)
       multi_xml (>= 0.5.2)
     json (2.1.0)
     multi_xml (0.6.0)

data/lib/never_bounce/api/client.rb

@@ -37,7 +37,7 @@ module NeverBounce; module API
     Feature::BasicInitialize.load(self)
     Feature::RequireAttr.load(self)
 
-    attr_writer :api_key
+    attr_writer :api_key, :api_version
 
     # API key.
     # @return [String]
@@ -45,6 +45,12 @@ module NeverBounce; module API
       @api_key or raise AttributeError, "Attribute must be set: api_key"
     end
 
+    # API version.
+    # @return [String]
+    def api_version
+      @api_version
+    end
+
     #--------------------------------------- Misc
 
     # Wrap request in a session, return response.
@@ -67,6 +73,7 @@ module NeverBounce; module API
     def account_info
       response_to(Request::AccountInfo.new({
         api_key: api_key,
+        api_version: api_version,
       }))
     end
 
@@ -83,7 +90,7 @@ module NeverBounce; module API
     # @raise [StandardError]
     # @see Request::JobsCreate
     # @see https://developers.neverbounce.com/v4.0/reference#jobs-create
-    def jobs_create(auto_parse: false, auto_start: false, filename: nil, remote_input: nil, run_sample: false, supplied_input: nil)
+    def jobs_create(auto_parse: false, auto_start: false, filename: nil, remote_input: nil, run_sample: false, supplied_input: nil, historical: nil)
       raise ArgumentError, "`remote_input` and `supplied_input` can't both be given" if remote_input && supplied_input
 
       input_location = if (v = remote_input)
@@ -102,12 +109,14 @@ module NeverBounce; module API
 
       response_to(API::Request::JobsCreate.new({
         api_key: api_key,
+        api_version: api_version,
         auto_parse: auto_parse,
         auto_start: auto_start,
         filename: filename,
         input: input,
         input_location: input_location,
         run_sample: run_sample,
+        historical: historical,
       }))
     end
 
@@ -122,6 +131,7 @@ module NeverBounce; module API
     def jobs_delete(job_id: nil)
       response_to(Request::JobsDelete.new({
         api_key: api_key,
+        api_version: api_version,
         job_id: job_id,
       }))
     end
@@ -137,6 +147,7 @@ module NeverBounce; module API
     def jobs_download(job_id: nil)
       response_to(Request::JobsDownload.new({
         api_key: api_key,
+        api_version: api_version,
         job_id: job_id,
       }))
     end
@@ -153,6 +164,7 @@ module NeverBounce; module API
     def jobs_parse(auto_start: nil, job_id: nil)
       response_to(Request::JobsParse.new({
         api_key: api_key,
+        api_version: api_version,
         auto_start: auto_start,
         job_id: job_id,
       }))
@@ -171,6 +183,7 @@ module NeverBounce; module API
     def jobs_results(job_id: nil, page: 1, per_page: nil)
       response_to(Request::JobsResults.new({
         api_key: api_key,
+        api_version: api_version,
         job_id: job_id,
         page: page,
         per_page: per_page,
@@ -190,6 +203,7 @@ module NeverBounce; module API
     def jobs_search(job_id: nil, page: 1, per_page: nil)
       response_to(Request::JobsSearch.new({
         api_key: api_key,
+        api_version: api_version,
         job_id: job_id,
         page: page,
         per_page: per_page,
@@ -208,6 +222,7 @@ module NeverBounce; module API
     def jobs_start(job_id: nil, run_sample: nil)
       response_to(Request::JobsStart.new({
         api_key: api_key,
+        api_version: api_version,
         job_id: job_id,
         run_sample: run_sample,
       }))
@@ -224,6 +239,7 @@ module NeverBounce; module API
     def jobs_status(job_id: nil)
       response_to(Request::JobsStatus.new({
         api_key: api_key,
+        api_version: api_version,
         job_id: job_id,
       }))
     end
@@ -239,13 +255,15 @@ module NeverBounce; module API
     # @raise [StandardError]
     # @see Request::SingleCheck
     # @see https://developers.neverbounce.com/v4.0/reference#single-check
-    def single_check(address_info: nil, credits_info: nil, email: nil, timeout: nil)
+    def single_check(address_info: nil, credits_info: nil, email: nil, timeout: nil, historical: nil)
       response_to(Request::SingleCheck.new({
         address_info: address_info,
         api_key: api_key,
+        api_version: api_version,
         credits_info: credits_info,
         email: email,
         timeout: timeout,
+        historical: historical,
       }))
     end
 
@@ -263,6 +281,7 @@ module NeverBounce; module API
     def poe_confirm(email: nil, transaction_id: nil, confirmation_token: nil, result: nil)
       response_to(Request::POEConfirm.new({
         api_key: api_key,
+        api_version: api_version,
         email: email,
         transaction_id: transaction_id,
         confirmation_token: confirmation_token,

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

@@ -12,12 +12,18 @@ module NeverBounce; module API; module Request
     # User's API key.
     # @return [String]
     attr_accessor :api_key
-    attr_writer :api_url, :headers, :user_agent
+    attr_writer :api_url, :headers, :user_agent, :api_version
 
-    # Custom API URL. Default is <tt>https://api.neverbounce.com/v4</tt>.
+    # Custom API URL. Default is <tt>https://api.neverbounce.com</tt>.
     # @return [String]
     def api_url
-      @api_url ||= "https://api.neverbounce.com/v4"
+      @api_url ||= "https://api.neverbounce.com"
+    end
+
+    # Custom API URL. Default is <tt>https://api.neverbounce.com</tt>.
+    # @return [String]
+    def api_version
+      @api_version ||= "v4.1"
     end
 
     # @!attribute headers
@@ -57,7 +63,7 @@ module NeverBounce; module API; module Request
       @curl ||= begin
         ar = [
           "--request", self.class.http_method.to_s.upcase,
-          "--url", "#{api_url}/#{self.class.path}",
+          "--url", "#{api_url}/#{api_version}/#{self.class.path}",
         ]
 
         ar += headers.reject { |k,| k == "User-Agent" }.flat_map do |k, v|
@@ -82,7 +88,7 @@ module NeverBounce; module API; module Request
     def to_httparty
       [
         self.class.http_method,   # E.g. `:get`.
-        "#{api_url}/#{self.class.path}",
+        "#{api_url}/#{api_version}/#{self.class.path}",
         {
           body: to_h.to_json,
           headers: headers,

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

@@ -23,6 +23,13 @@ module NeverBounce; module API; module Request
     # @return [Boolean]
     attr_accessor :run_sample
 
+    # @return [Boolean]
+    attr_accessor :historical
+
+    def leverage_historical
+      defined?(@historical) ? @historical : true
+    end
+
     # @return [Symbol]
     def self.http_method
       :post
@@ -53,6 +60,10 @@ module NeverBounce; module API; module Request
         unless (v = run_sample).nil?
           _[:run_sample] = v
         end
+
+        unless historical.nil?
+          _[:request_meta_data] = {leverage_historical_data: leverage_historical}
+        end
       end
     end
 

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

@@ -17,6 +17,13 @@ module NeverBounce; module API; module Request
     # @return [Integer]
     attr_accessor :timeout
 
+    # @return [Boolean]
+    attr_accessor :historical
+
+    def leverage_historical
+      defined?(@historical) ? @historical : true
+    end
+
     # @return [Symbol]
     def self.http_method
       :get
@@ -47,6 +54,10 @@ module NeverBounce; module API; module Request
         unless (v = timeout).nil?
           _[:timeout] = v
         end
+
+        unless historical.nil?
+          _[:request_meta_data] = {leverage_historical_data: leverage_historical}
+        end
       end
     end
 

data/lib/never_bounce/api/version.rb

@@ -1,4 +1,4 @@
 
 module NeverBounce; module API
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end; end

data/spec/lib/never_bounce/api/client_spec.rb

@@ -14,6 +14,16 @@ module NeverBounce; module API
           expect(r.api_key).to eq "api_key"
         end
       end
+
+      describe "#api_version" do
+        it "generally works" do
+          r = newo
+          r.api_key = "api_key"
+          expect(r.api_version).to eq nil
+          r.api_version = "api_version"
+          expect(r.api_version).to eq "api_version"
+        end
+      end
     end # describe "attributes"
 
     describe "requests" do

data/spec/lib/never_bounce/api/request/account_info_spec.rb

@@ -19,7 +19,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :get
-        expect(url).to eq "https://api.neverbounce.com/v4/account/info"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/account/info"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq "{\"key\":\"api_key\"}"
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/jobs_create_spec.rb

@@ -15,6 +15,10 @@ module NeverBounce; module API; module Request
         expect(r.mode_h).to eq({auto_start: false, auto_parse: false, run_sample: false})
         r = newo(auto_start: true, auto_parse: true, run_sample: true)
         expect(r.mode_h).to eq({auto_start: true, auto_parse: true, run_sample: true})
+        r = newo(historical: true)
+        expect(r.mode_h).to eq({request_meta_data: {leverage_historical_data: true}})
+        r = newo(historical: false)
+        expect(r.mode_h).to eq({request_meta_data: {leverage_historical_data: false}})
       end
     end
 
@@ -79,11 +83,39 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :post
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/create"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/create"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq "{\"input\":\"input\",\"input_location\":\"remote_url\",\"filename\":\"filename\",\"key\":\"api_key\"}"
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
       end
+
+      it "allows historical to be disabled" do
+        r = newo
+        r.input = "input"
+        r.input_location = "remote_url"
+        r.filename = "filename"
+        r.api_key = "api_key"
+        r.historical = false
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(data.fetch(:body)).to eq "{\"input\":\"input\",\"input_location\":\"remote_url\",\"filename\":\"filename\",\"key\":\"api_key\",\"request_meta_data\":{\"leverage_historical_data\":false}}"
+      end
+
+      it "allows historical to be explicitly enabled" do
+        r = newo
+        r.input = "input"
+        r.input_location = "remote_url"
+        r.filename = "filename"
+        r.api_key = "api_key"
+        r.historical = true
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(data.fetch(:body)).to eq "{\"input\":\"input\",\"input_location\":\"remote_url\",\"filename\":\"filename\",\"key\":\"api_key\",\"request_meta_data\":{\"leverage_historical_data\":true}}"
+      end
     end
   end
 end; end; end

data/spec/lib/never_bounce/api/request/jobs_delete_spec.rb

@@ -21,7 +21,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :post
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/delete"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/delete"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/jobs_download_spec.rb

@@ -21,7 +21,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :get
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/download"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/download"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/jobs_parse_spec.rb

@@ -34,7 +34,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :post
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/parse"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/parse"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/jobs_results_spec.rb

@@ -32,7 +32,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :get
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/results"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/results"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq "{\"job_id\":\"123\",\"key\":\"api_key\"}"
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/jobs_search_spec.rb

@@ -30,7 +30,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :get
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/search"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/search"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq "{\"key\":\"api_key\",\"job_id\":\"abc\",\"page\":12,\"items_per_page\":34}"
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/jobs_start_spec.rb

@@ -34,7 +34,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :post
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/start"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/start"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/jobs_status_spec.rb

@@ -21,7 +21,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :get
-        expect(url).to eq "https://api.neverbounce.com/v4/jobs/status"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/jobs/status"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq "{\"job_id\":\"123\",\"key\":\"api_key\"}"
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/poe_confirm_spec.rb

@@ -27,7 +27,7 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :get
-        expect(url).to eq "https://api.neverbounce.com/v4/poe/confirm"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/poe/confirm"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq "{\"email\":\"email\",\"transaction_id\":\"NBTRNS-abcdefg\",\"confirmation_token\":\"abcdefg123456\",\"result\":\"valid\",\"key\":\"api_key\"}"
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")

data/spec/lib/never_bounce/api/request/single_check_spec.rb

@@ -15,6 +15,10 @@ module NeverBounce; module API; module Request
         expect(r.mode_h).to eq({address_info: false, credits_info: false})
         r = newo(address_info: true, credits_info: true, timeout: 12)
         expect(r.mode_h).to eq({address_info: true, credits_info: true, timeout: 12})
+        r = newo(historical: true)
+        expect(r.mode_h).to eq({request_meta_data: {leverage_historical_data: true}})
+        r = newo(historical: false)
+        expect(r.mode_h).to eq({request_meta_data: {leverage_historical_data: false}})
       end
     end
 
@@ -34,11 +38,33 @@ module NeverBounce; module API; module Request
         expect(res).to be_a Array
         method, url, data = res
         expect(method).to eq :get
-        expect(url).to eq "https://api.neverbounce.com/v4/single/check"
+        expect(url).to eq "https://api.neverbounce.com/v4.1/single/check"
         expect(data).to include(:body, :headers)
         expect(data.fetch(:body)).to eq "{\"email\":\"email\",\"key\":\"api_key\",\"address_info\":true,\"credits_info\":true,\"timeout\":12}"
         expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
       end
+
+      it "allows historical to be disabled" do
+        r = newo(address_info: true, credits_info: true, timeout: 12, historical: false)
+        r.email = "email"
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(data.fetch(:body)).to eq "{\"email\":\"email\",\"key\":\"api_key\",\"address_info\":true,\"credits_info\":true,\"timeout\":12,\"request_meta_data\":{\"leverage_historical_data\":false}}"
+      end
+
+      it "allows historical to be explicitly enabled" do
+        r = newo(address_info: true, credits_info: true, timeout: 12, historical: true)
+        r.email = "email"
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(data.fetch(:body)).to eq "{\"email\":\"email\",\"key\":\"api_key\",\"address_info\":true,\"credits_info\":true,\"timeout\":12,\"request_meta_data\":{\"leverage_historical_data\":true}}"
+      end
     end
   end
 end; end; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neverbounce-api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - NeverBounce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-27 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty