neverbounce-cli 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 202a7ded299c4761089c26e09d03b252b811d9d8
-  data.tar.gz: 311bd68352a8b8f2bea857fef0dc50e10c7196ab
+  metadata.gz: de530e60fa6e4110955d29a0c975a0365b937bb8
+  data.tar.gz: dff27632c5de34e9621b43497e313d1fc6a9b952
 SHA512:
-  metadata.gz: 55ed5e3dd94804598bb0d4512249b70e7eaab1f7e3260a6e07003375945d445066daf7435700e5763a6dc7f3d3eab2f0f49e668216b57a8cf1d0efd75e153426
-  data.tar.gz: 362647aab0c2e7d77361a91caf2c8dd9138a0298e3277e1cba700f8a8f2c024e8a9ff346f5b2cf437cda11d6e1d85cc75c46bc88ade35c45ef12c0c28c36a000
+  metadata.gz: 73bea0d0c19c223d9b9d7e36b71606a29cb47cd0b6e1747a5213ae34ce1a21abfe3f4ca362178fafafafe286e5e4cec150cc5d2f835c9880a6ddcf8f163c0647
+  data.tar.gz: b37a8e309a058329ce282c63c9150ad39df3bbde4460063b65f44ab133347f8489326b8cb14e63918b5c8f3eaf0e3b39475cb67e7316e643e22ae0d89beb128b

data/.gitignore

@@ -8,6 +8,7 @@
 /tmp/*
 /vendor/bundle/
 /.yardoc/
+*.gem
 
 # Project-specific.
 /lib/lib_local.rb

data/Gemfile.lock

@@ -1,14 +1,14 @@
 GIT
   remote: https://github.com/NeverBounce/NeverBounceApi-Ruby.git
-  revision: f7ecf950759aa61b818089cd1a1554bb93cb3851
+  revision: e1760adf5e4431fbaae811ceb3d0d383db6bc181
   specs:
-    neverbounce-api (1.0.0)
+    neverbounce-api (1.0.1)
       httparty (~> 0.15)
 
 PATH
   remote: .
   specs:
-    neverbounce-cli (1.0.0)
+    neverbounce-cli (1.0.1)
       neverbounce-api (~> 1.0.0)
       terminal-table (~> 1.8.0)
 
@@ -57,4 +57,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-cli"><img src="https://badge.fury.io/rb/neverbounce-cli.svg" alt="Gem Version"></a>
   <a href="https://travis-ci.org/NeverBounce/NeverBounceCli-Ruby"><img src="https://travis-ci.org/NeverBounce/NeverBounceCli-Ruby.svg" alt="Build Status"></a>
   <a href="https://codeclimate.com/github/NeverBounce/NeverBounceCli-Ruby/coverage"><img src="https://codeclimate.com/github/NeverBounce/NeverBounceCli-Ruby/badges/coverage.svg" /></a>
   <a href="https://codeclimate.com/github/NeverBounce/NeverBounceCli-Ruby"><img src="https://codeclimate.com/github/NeverBounce/NeverBounceCli-Ruby/badges/gpa.svg" /></a>
@@ -20,10 +21,16 @@ This is the official NeverBounce V4 CLI written in Ruby. See also:
 In your `Gemfile`, add:
 
 ```ruby
-gem "neverbounce-api", git: "https://github.com/NeverBounce/NeverBounceApi-Ruby.git"
-gem "neverbounce-cli", git: "https://github.com/NeverBounce/NeverBounceCli-Ruby.git"
+gem "neverbounce-cli"
 ```
 
+> For **edge versions** of both, fetch gems directly:
+>
+> ```ruby
+> gem "neverbounce-api", git: "https://github.com/NeverBounce/NeverBounceApi-Ruby.git"
+> gem "neverbounce-cli", git: "https://github.com/NeverBounce/NeverBounceCli-Ruby.git"
+> ```
+
 Install bundle, generate binstubs:
 
 ```sh
@@ -31,8 +38,8 @@ $ bundle install
 $ bundle binstub neverbounce-cli
 
 $ ls bin
-nb-account-info  nb-jobs-delete    nb-jobs-parse    nb-jobs-search  nb-jobs-status
-nb-jobs-create   nb-jobs-download  nb-jobs-results  nb-jobs-start   nb-single-check
+nb-account-info  nb-jobs-delete   nb-jobs-parse    nb-jobs-search   nb-jobs-status   nb-single-check
+nb-jobs-create   nb-jobs-download nb-jobs-results  nb-jobs-start    nb-poe-confirm
 ```
 
 Create `~/.neverbounce.yml`, add your API key there:

data/exe/nb-poe-confirm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "neverbounce-cli"
+
+exit NeverBounce::CLI::Script::POEConfirm.new.main

data/lib/never_bounce/cli/script/poe_confirm.rb

@@ -0,0 +1,80 @@
+
+require "neverbounce"
+
+require_relative "request_maker"
+
+module NeverBounce; module CLI; module Script
+  class POEConfirm < RequestMaker
+
+    attr_writer :email, :transaction_id, :confirmation_token, :result
+
+    envar "EMAIL*", "The email that was verified ", ["alice@isp.com", "bob.smith+1@domain.com"]
+    envar "TRANSACTION_ID*", "The transaction id returned by the public verification", ["NBTRNS-123456"]
+    envar "CONFIRMATION_TOKEN*", "The confirmation_token returned by the public verification", ["abcdefg123456"]
+    envar "RESULT*", "The result returned by the public verification", ["valid", "invalid", "catchall", "disposable", "unknown"]
+
+    def email
+      @email ||= env[k = "EMAIL"] or raise UsageError, "E-mail address not given, use `#{k}=`"
+    end
+
+    def transaction_id
+      @transaction_id ||= env[k = "TRANSACTION_ID"] or raise UsageError, "Transaction ID was not given, use `#{k}=`"
+    end
+
+    def confirmation_token
+      @confirmation_token ||= env[k = "CONFIRMATION_TOKEN"] or raise UsageError, "Confirmation Token was not given, use `#{k}=`"
+    end
+
+    def result
+      @result ||= env[k = "RESULT"] or raise UsageError, "Result was not given, use `#{k}=`"
+    end
+
+    # An <tt>API::Request::POEConfirm</tt>.
+    # @!attribute request
+    # @return [Object]
+    def request
+      @request ||= API::Request::POEConfirm.new({
+        api_key: api_key,
+        email: email,
+        transaction_id: transaction_id,
+        confirmation_token: confirmation_token,
+        result: result,
+      })
+    end
+
+    #--------------------------------------- Manifest
+
+    # @!attribute manifest
+    # @return [Manifest]
+    def manifest
+      @manifest ||= Manifest.new(
+        name: "nb-poe-confirm",
+        function: "Verify a verification performed on the frontend with the Javascript Wdiget",
+        cmdline: "[options] [VAR1=value] [VAR2=value] ...",
+      )
+    end
+
+    #--------------------------------------- Main
+
+    # @return [Integer]
+    def slim_main
+      "Response".tap do |label|
+        headings = [
+          ["TokenConfirmed", :token_confirmed],
+
+          ["ExecTime", :execution_time, :right],
+        ]
+
+        table = Table.new(
+          headings: headings.map { |ar| ar[0] },
+          rows: [headings.map { |ar| get_table_value(response, ar) }],
+        ).align!(headings)
+
+        stdout.puts "\n#{label}:"
+        stdout.puts table
+      end
+
+      0
+    end
+  end
+end; end; end

data/lib/never_bounce/cli/version.rb

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

data/spec/lib/never_bounce/cli/script/poe_confirm_spec.rb

@@ -0,0 +1,36 @@
+
+module NeverBounce; module CLI; module Script
+  describe POEConfirm do
+    include_dir_context __dir__
+
+    def margv(*args)
+      ["API_KEY=abc", "EMAIL=alice@isp.com", "TRANSACTION_ID=NBTRNS-123456", "CONFIRMATION_TOKEN=abcdefg123456", "RESULT=valid"] + args
+    end
+
+    it_behaves_like "instantiatable"
+    it_behaves_like "a script supporting `--help`", signatures: [/nb-poe-confirm/, /EMAIL/, /TRANSACTION_ID/, /CONFIRMATION_TOKEN/, /RESULT/]
+
+    describe "#request_curl" do
+      it "generally works" do
+        r = goodo(argv: margv())
+        expect(r.request_curl).to eq ["--request", "GET", "--url", "https://api.neverbounce.com/v4/poe/confirm", "--header", "Content-Type: application/json", "--data-binary", "{\"email\":\"alice@isp.com\",\"transaction_id\":\"NBTRNS-123456\",\"confirmation_token\":\"abcdefg123456\",\"result\":\"valid\",\"key\":\"abc\"}"]
+      end
+    end
+
+
+
+    describe "output" do
+      it "generally works" do
+        r = goodo(argv: margv).tap do |_|
+          _.session.server_content_type = "application/json"
+          _.session.server_raw = '{"status":"success","token_confirmed":true,"execution_time":25}'
+        end
+        expect { r.main }.not_to raise_error
+        lines = r.stdout.tap(&:rewind).to_a
+        expect(lines).to be_any { |s| s =~ /Response:/ }
+        expect(lines).to be_any { |s| s =~ cell("TokenConfirmed") }
+        expect(lines).to be_any { |s| s =~ cell("ExecTime") }
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/cli_spec.rb

@@ -1,6 +1,6 @@
 
 describe NeverBounce::CLI 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-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - NeverBounce
 autorequire: 
 bindir: exe
 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: neverbounce-api
@@ -51,6 +51,7 @@ executables:
 - nb-jobs-search
 - nb-jobs-start
 - nb-jobs-status
+- nb-poe-confirm
 - nb-single-check
 extensions: []
 extra_rdoc_files: []
@@ -74,6 +75,7 @@ files:
 - exe/nb-jobs-search
 - exe/nb-jobs-start
 - exe/nb-jobs-status
+- exe/nb-poe-confirm
 - exe/nb-single-check
 - lib/never_bounce/cli/feature/basic_initialize.rb
 - lib/never_bounce/cli/feature/eigencache.rb
@@ -98,6 +100,7 @@ files:
 - lib/never_bounce/cli/script/jobs_status.rb
 - lib/never_bounce/cli/script/manifest.rb
 - lib/never_bounce/cli/script/meaningful.rb
+- lib/never_bounce/cli/script/poe_confirm.rb
 - lib/never_bounce/cli/script/request_maker.rb
 - lib/never_bounce/cli/script/single_check.rb
 - lib/never_bounce/cli/script/table.rb
@@ -128,6 +131,7 @@ files:
 - spec/lib/never_bounce/cli/script/jobs_status_spec.rb
 - spec/lib/never_bounce/cli/script/manifest_spec.rb
 - spec/lib/never_bounce/cli/script/meaningful_spec.rb
+- spec/lib/never_bounce/cli/script/poe_confirm_spec.rb
 - spec/lib/never_bounce/cli/script/request_maker_spec.rb
 - spec/lib/never_bounce/cli/script/single_check_spec.rb
 - spec/lib/never_bounce/cli/script/spec_helper.rb
@@ -183,6 +187,7 @@ test_files:
 - spec/lib/never_bounce/cli/script/jobs_status_spec.rb
 - spec/lib/never_bounce/cli/script/manifest_spec.rb
 - spec/lib/never_bounce/cli/script/meaningful_spec.rb
+- spec/lib/never_bounce/cli/script/poe_confirm_spec.rb
 - spec/lib/never_bounce/cli/script/request_maker_spec.rb
 - spec/lib/never_bounce/cli/script/single_check_spec.rb
 - spec/lib/never_bounce/cli/script/spec_helper.rb