neverbounce-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2683e539fe60e6a73a4da51b6bb67c07adbe59b3
-  data.tar.gz: 48ed5a308179dbafdb7399ce6d4d92fd45df4b3a
+  metadata.gz: cf9fa5763f319e8fc240af66e7be1809b427ac5e
+  data.tar.gz: d960426232862d34bdd040d444627059fa63217a
 SHA512:
-  metadata.gz: 443a8f1543281ee8857de7cf129785e146dbbf6f6b9ed6c79aef3ca9dd97beb9ae3d9fa3fdf1719ddae4225aa88d602a996accb39ecf5d383edcac144529d1ce
-  data.tar.gz: 974b1aa515a03cf31b20899cbce77c3a2131bdd448dc98793c9a9cee9d4255fb1c3e51aad7858fe43cfc1b76e68d6b2621efe2456b6fab2c0908838276213ee9
+  metadata.gz: 7536bf00e5a1fd3fe82e139be0e361eb2adcc2e9729ec810b4fad6174fc40dac12ed56faa5e7b2a9ba2ebe52578a6269e1b134e83b8c81b497150293441cc019
+  data.tar.gz: 2a30f1057d9e26ea5785f992cc37edd17d560367998085a158ad204d79f4ac9a113f2c1eea17b763ccc0ae718b8e50eb0c30cb406e64933d09988e204f96c70f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neverbounce-api (1.0.0)
+    neverbounce-api (1.0.1)
       httparty (~> 0.15)
 
 GEM
@@ -45,4 +45,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.15.3
+   1.15.4

data/README.md

@@ -2,6 +2,7 @@
 <p align="center"><img src="https://neverbounce-marketing.s3.amazonaws.com/neverbounce_color_600px.png"></p>
 
 <p align="center">
+  <a href="https://badge.fury.io/rb/neverbounce-api"><img src="https://badge.fury.io/rb/neverbounce-api.svg" alt="Gem Version"></a>
   <a href="https://travis-ci.org/NeverBounce/NeverBounceApi-Ruby"><img src="https://travis-ci.org/NeverBounce/NeverBounceApi-Ruby.svg" alt="Build Status"></a>
   <a href="https://codeclimate.com/github/NeverBounce/NeverBounceApi-Ruby/coverage"><img src="https://codeclimate.com/github/NeverBounce/NeverBounceApi-Ruby/badges/coverage.svg" /></a>
   <a href="https://codeclimate.com/github/NeverBounce/NeverBounceApi-Ruby"><img src="https://codeclimate.com/github/NeverBounce/NeverBounceApi-Ruby/badges/gpa.svg" /></a>
@@ -14,15 +15,21 @@ This is the official NeverBounce V4 API for Ruby. See also:
 
 * Our full RubyDoc documentation: http://rubydoc.info/github/NeverBounce/NeverBounceApi-Ruby.
 * Our full REST API documentation: https://developers.neverbounce.com/v4.0/.
+* RubyGems CLI: https://github.com/NeverBounce/NeverBounceCli-Ruby.
 
 ## Installation
 
 In your `Gemfile`, add:
 
 ```ruby
-gem "neverbounce-api", git: "https://github.com/NeverBounce/NeverBounceApi-Ruby.git"
+gem "neverbounce-api"
 ```
 
+> For **edge version,** fetch the gem directly:
+> ```ruby
+> gem "neverbounce-api", git: "https://github.com/NeverBounce/NeverBounceApi-Ruby.git"
+> ```
+
 Install bundle:
 
 ```sh
@@ -100,6 +107,12 @@ resp = client.single_check(email: "alice@isp.com")
 resp = client.single_check(email: "alice@isp.com", address_info: true, credits_info: true, timeout: 3)
 ```
 
+### Confirm frontend (Javascript Widget) verification
+
+```ruby
+resp = client.poe_confirm(email: "alice@isp.com", transaction_id: "NBTRNS-abcdefg123456", confirmation_token: "abcdefg123456", result: "valid")
+```
+
 See also: [method](http://rubydoc.info/github/NeverBounce/NeverBounceApi-Ruby/NeverBounce/API/Client.html#single_check-instance_method), [REST](https://developers.neverbounce.com/v4.0/reference#single-check).
 
 ### Create a bulk job

data/lib/never_bounce/api/client.rb

@@ -248,6 +248,27 @@ module NeverBounce; module API
         timeout: timeout,
       }))
     end
+
+    # Make a <tt>poe/confirm</tt> request.
+    # @param email [String]
+    # @param transaction_id [String]
+    # @param confirmation_token [String]
+    # @param result [String]
+    # @return [Response::POEConfirm]
+    # @return [Response::ErrorMessage]
+    # @raise [API::Error]
+    # @raise [StandardError]
+    # @see Request::POEConfirm
+    # @see https://developers.neverbounce.com/v4.0/reference#poe-confirm
+    def poe_confirm(email: nil, transaction_id: nil, confirmation_token: nil, result: nil)
+      response_to(Request::POEConfirm.new({
+        api_key: api_key,
+        email: email,
+        transaction_id: transaction_id,
+        confirmation_token: confirmation_token,
+        result: result,
+      }))
+    end
   end
 end; end
 

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

@@ -0,0 +1,46 @@
+
+require "never_bounce/api/response/poe_confirm"
+
+require_relative "base"
+
+module NeverBounce; module API; module Request
+  class POEConfirm < Base
+    # @return [String]
+    attr_accessor :email
+
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # @return [String]
+    attr_accessor :confirmation_token
+
+    # @return [String]
+    attr_accessor :result
+
+    # @return [Symbol]
+    def self.http_method
+      :get
+    end
+
+    # @return [String]
+    def self.path
+      "poe/confirm"
+    end
+
+    # @return [Response::POEConfirm]
+    def self.response_klass
+      Response::POEConfirm
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        email: require_attr(:email),
+        transaction_id: require_attr(:transaction_id),
+        confirmation_token: require_attr(:confirmation_token),
+        result: require_attr(:result),
+        key: require_attr(:api_key),
+      }
+    end
+  end
+end; end; end

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

@@ -0,0 +1,9 @@
+require_relative "success_message"
+
+module NeverBounce; module API; module Response;
+  class POEConfirm < SuccessMessage
+    # @!attribute token_confirmed
+    #   @return [Bool]
+    oattr :token_confirmed, :scalar
+  end
+end; end; end

data/lib/never_bounce/api/version.rb

@@ -1,4 +1,4 @@
 
 module NeverBounce; module API
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end; end

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

@@ -194,6 +194,21 @@ module NeverBounce; module API
           expect(request.timeout).to eq 12
         end
       end
+
+      describe "#poe_confirm" do
+        it "generally works" do
+          sc = goodo.poe_confirm(email: "alice@isp.com", transaction_id: "NBTRNS-123456", confirmation_token: "abcdefg123456", result: "valid")
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::POEConfirm
+          expect(request.to_httparty).to be_a Array
+          expect(request.email).to eq "alice@isp.com"
+          expect(request.transaction_id).to eq "NBTRNS-123456"
+          expect(request.confirmation_token).to eq "abcdefg123456"
+          expect(request.result).to eq "valid"
+        end
+      end
     end
   end
 end; end

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

@@ -0,0 +1,37 @@
+
+module NeverBounce; module API; module Request
+  describe POEConfirm do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq Response::POEConfirm }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo()
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: email")
+        r.email = "email"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: transaction_id")
+        r.transaction_id = "NBTRNS-abcdefg"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: confirmation_token")
+        r.confirmation_token = "abcdefg123456"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: result")
+        r.result = "valid"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        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(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")
+      end
+    end
+  end
+end; end; end

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

@@ -0,0 +1,7 @@
+
+describe NeverBounce::API::Response::POEConfirm do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+  it_behaves_like "properly inherited"
+end

data/spec/lib/never_bounce/api_spec.rb

@@ -3,6 +3,6 @@ require "never_bounce/api/version"
 
 describe NeverBounce::API do
   describe "VERSION" do
-    it { expect(described_class::VERSION).to eq "1.0.0" }
+    it { expect(described_class::VERSION).to eq "1.0.1" }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neverbounce-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - NeverBounce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -58,6 +58,7 @@ files:
 - lib/never_bounce/api/request/jobs_search.rb
 - lib/never_bounce/api/request/jobs_start.rb
 - lib/never_bounce/api/request/jobs_status.rb
+- lib/never_bounce/api/request/poe_confirm.rb
 - lib/never_bounce/api/request/single_check.rb
 - lib/never_bounce/api/response/account_info.rb
 - lib/never_bounce/api/response/account_info/job_counts.rb
@@ -83,6 +84,7 @@ files:
 - lib/never_bounce/api/response/jobs_start.rb
 - lib/never_bounce/api/response/jobs_status.rb
 - lib/never_bounce/api/response/message.rb
+- lib/never_bounce/api/response/poe_confirm.rb
 - lib/never_bounce/api/response/single_check.rb
 - lib/never_bounce/api/response/status_message.rb
 - lib/never_bounce/api/response/success_message.rb
@@ -107,6 +109,7 @@ files:
 - spec/lib/never_bounce/api/request/jobs_search_spec.rb
 - spec/lib/never_bounce/api/request/jobs_start_spec.rb
 - spec/lib/never_bounce/api/request/jobs_status_spec.rb
+- spec/lib/never_bounce/api/request/poe_confirm_spec.rb
 - spec/lib/never_bounce/api/request/single_check_spec.rb
 - spec/lib/never_bounce/api/response/account_info/job_counts_spec.rb
 - spec/lib/never_bounce/api/response/account_info_spec.rb
@@ -130,6 +133,7 @@ files:
 - spec/lib/never_bounce/api/response/jobs_search_spec.rb
 - spec/lib/never_bounce/api/response/jobs_start_spec.rb
 - spec/lib/never_bounce/api/response/jobs_status_spec.rb
+- spec/lib/never_bounce/api/response/poe_confirm_spec.rb
 - spec/lib/never_bounce/api/response/single_check_spec.rb
 - spec/lib/never_bounce/api/response/spec_helper.rb
 - spec/lib/never_bounce/api/session_spec.rb
@@ -178,6 +182,7 @@ test_files:
 - spec/lib/never_bounce/api/request/jobs_search_spec.rb
 - spec/lib/never_bounce/api/request/jobs_start_spec.rb
 - spec/lib/never_bounce/api/request/jobs_status_spec.rb
+- spec/lib/never_bounce/api/request/poe_confirm_spec.rb
 - spec/lib/never_bounce/api/request/single_check_spec.rb
 - spec/lib/never_bounce/api/response/account_info/job_counts_spec.rb
 - spec/lib/never_bounce/api/response/account_info_spec.rb
@@ -201,6 +206,7 @@ test_files:
 - spec/lib/never_bounce/api/response/jobs_search_spec.rb
 - spec/lib/never_bounce/api/response/jobs_start_spec.rb
 - spec/lib/never_bounce/api/response/jobs_status_spec.rb
+- spec/lib/never_bounce/api/response/poe_confirm_spec.rb
 - spec/lib/never_bounce/api/response/single_check_spec.rb
 - spec/lib/never_bounce/api/response/spec_helper.rb
 - spec/lib/never_bounce/api/session_spec.rb