neverbounce-api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a4914041f3d0851a7bc008ad8ae7a93d788d9722
-  data.tar.gz: 9bfb58a3ef4662106c64160cbeae2edbdce1edc8
+SHA256:
+  metadata.gz: 2f9d774a33fd7d97b58da965a0aaa4479ecd2051121d94b103eb9b79dea2b840
+  data.tar.gz: 9a25032152f3cd29bf9f1a35e59a41f6a7c3f52e56829f2c5449953e925683e2
 SHA512:
-  metadata.gz: 8fc8a9fc1608a38a5f5eab79fe7941e36310d22c0391b9e338f20a05b318e1d972e64bf498adf2dbb638a05f7f0846b9ab915456e96f750e3d31a8de6f27458f
-  data.tar.gz: 380320a15db88c0e2b995e95e8d5b0ffb209ca8d043f81bcace0ee5501a6159bdeb86f029e2653e002a6aa0c9a489dfbf3576ddb9d84520a66119431d0585a22
+  metadata.gz: a6675271c6f4aec84f635a0b6c0f20207f217e4be96cfc64957feae519f1ad0c6fb5d6d15cd80f63d73a8de842917399bb0230afae444ff0ea4203dcf5396ce0
+  data.tar.gz: 73b51b37c0a7ed257c3b7548cd2b3b771483261a2a9cb61a818e91b3442a378f096c0b229d83f703b064b911e8b8f6a913c3fa4a3bcc436333a3e0e0be136bbc

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

@@ -23,7 +23,7 @@ module NeverBounce; module API; module Request
     # Custom API URL. Default is <tt>https://api.neverbounce.com</tt>.
     # @return [String]
     def api_version
-      @api_version ||= "v4.1"
+      @api_version ||= "v4.2"
     end
 
     # @!attribute headers

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

@@ -26,6 +26,15 @@ module NeverBounce; module API; module Request
     # @return [Boolean]
     attr_accessor :historical
 
+    # @return [Boolean]
+    attr_accessor :allow_manual_review
+
+    # @return [String]
+    attr_accessor :callback_url
+
+    # @return [Hash]
+    attr_accessor :callback_headers
+
     def leverage_historical
       defined?(@historical) ? @historical : true
     end
@@ -61,6 +70,18 @@ module NeverBounce; module API; module Request
           _[:run_sample] = v
         end
 
+        unless (v = allow_manual_review).nil?
+          _[:allow_manual_review] = v
+        end
+
+        unless (v = callback_url).nil?
+          _[:callback_url] = v
+        end
+
+        unless (v = callback_headers).nil?
+          _[:callback_headers] = v
+        end
+
         unless historical.nil?
           _[:request_meta_data] = {leverage_historical_data: leverage_historical}
         end

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

@@ -11,6 +11,9 @@ module NeverBounce; module API; module Request
     # @return [Boolean]
     attr_accessor :run_sample
 
+    # @return [Boolean]
+    attr_accessor :allow_manual_review
+
     # @return [Symbol]
     def self.http_method
       :post
@@ -33,6 +36,10 @@ module NeverBounce; module API; module Request
         unless (v = run_sample).nil?
           _[:run_sample] = v
         end
+
+        unless (v = allow_manual_review).nil?
+          _[:allow_manual_review] = v
+        end
       end
     end
 

data/lib/never_bounce/api/response/feature/job_status_fields.rb

@@ -30,6 +30,7 @@ module NeverBounce; module API; module Response; module Feature
         oattr :created_at, :scalar
         oattr :finished_at, :scalar
         oattr :started_at, :scalar
+        oattr :failure_reason, :scalar
       end
     end
 

data/lib/never_bounce/api/version.rb

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

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.1/account/info"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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

@@ -9,7 +9,7 @@ module NeverBounce; module API; module Request
       it "generally works" do
         r = newo()
         expect(r.mode_h).to eq({})
-        r = newo(auto_start: nil, auto_parse: nil, run_sample: nil)
+        r = newo(auto_start: nil, auto_parse: nil, run_sample: nil, allow_manual_review: nil)
         expect(r.mode_h).to eq({})
         r = newo(auto_start: false, auto_parse: false, run_sample: false)
         expect(r.mode_h).to eq({auto_start: false, auto_parse: false, run_sample: false})
@@ -19,6 +19,10 @@ module NeverBounce; module API; module Request
         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}})
+        r = newo(allow_manual_review: true, callback_url: "http://test.com", callback_headers: {:Authorization => "Basic test"})
+        expect(r.mode_h).to eq({allow_manual_review: true, callback_url: "http://test.com", callback_headers: {:Authorization => "Basic test"}})
+        r = newo(allow_manual_review: false, callback_url: nil, callback_headers: nil)
+        expect(r.mode_h).to eq({allow_manual_review: false})
       end
     end
 
@@ -83,7 +87,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.1/jobs/create"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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")
@@ -116,6 +120,49 @@ module NeverBounce; module API; module Request
         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
+
+      it "allows allow manual review parameter to be enabled" do
+        r = newo
+        r.input = "input"
+        r.input_location = "remote_url"
+        r.filename = "filename"
+        r.api_key = "api_key"
+        r.allow_manual_review = 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\",\"allow_manual_review\":true}"
+      end
+
+      it "allows allow manual review parameter to be disabled" do
+        r = newo
+        r.input = "input"
+        r.input_location = "remote_url"
+        r.filename = "filename"
+        r.api_key = "api_key"
+        r.allow_manual_review = 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\",\"allow_manual_review\":false}"
+      end
+
+      it "allows callback url and headers" do
+        r = newo
+        r.input = "input"
+        r.input_location = "remote_url"
+        r.filename = "filename"
+        r.api_key = "api_key"
+        r.callback_url = "http://test.com"
+        r.callback_headers = {:Authorization => "Basic test"}
+
+        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\",\"callback_url\":\"http://test.com\",\"callback_headers\":{\"Authorization\":\"Basic test\"}}"
+      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.1/jobs/delete"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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.1/jobs/download"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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.1/jobs/parse"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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.1/jobs/results"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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.1/jobs/search"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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

@@ -9,12 +9,12 @@ module NeverBounce; module API; module Request
       it "generally works" do
         r = newo()
         expect(r.mode_h).to eq({})
-        r = newo(run_sample: nil)
+        r = newo(run_sample: nil, allow_manual_review: nil)
         expect(r.mode_h).to eq({})
-        r = newo(run_sample: false)
-        expect(r.mode_h).to eq({run_sample: false})
-        r = newo(run_sample: true)
-        expect(r.mode_h).to eq({run_sample: true})
+        r = newo(run_sample: false, allow_manual_review: false)
+        expect(r.mode_h).to eq({run_sample: false, allow_manual_review: false})
+        r = newo(run_sample: true, allow_manual_review: true)
+        expect(r.mode_h).to eq({run_sample: true, allow_manual_review: true})
       end
     end
 
@@ -34,11 +34,35 @@ 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.1/jobs/start"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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")
       end
+
+      it "allows allow manual review parameter to be enabled" do
+        r = newo
+        r.job_id = "123"
+        r.api_key = "api_key"
+        r.allow_manual_review = true
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(data.fetch(:body)).to eq "{\"job_id\":\"123\",\"key\":\"api_key\",\"allow_manual_review\":true}"
+      end
+
+      it "allows allow manual review parameter to be disabled" do
+        r = newo
+        r.job_id = "123"
+        r.api_key = "api_key"
+        r.allow_manual_review = false
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(data.fetch(:body)).to eq "{\"job_id\":\"123\",\"key\":\"api_key\",\"allow_manual_review\":false}"
+      end
     end
   end
 end; end; end

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.1/jobs/status"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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.1/poe/confirm"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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

@@ -38,7 +38,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.1/single/check"
+        expect(url).to eq "https://api.neverbounce.com/v4.2/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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neverbounce-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - NeverBounce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -159,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The official NeverBounce API library for Ruby