neverbounce-cli 1.0.0

data/.travis.yml

@@ -0,0 +1,27 @@
+
+language: ruby
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=c38ec11990e222f0b5aa1254e9d97dd92a2eadbaeef9e5cc1c2eaa93e9322bae
+
+install:
+  - bundle install --path ~/bundle
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rspec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4

data/.yardopts

@@ -0,0 +1,2 @@
+
+--private

data/Gemfile

@@ -0,0 +1,19 @@
+
+source "https://rubygems.org"
+
+# Self.
+gem "neverbounce-cli", path: Pathname(__dir__).realpath
+
+gem "neverbounce-api", git: "https://github.com/NeverBounce/NeverBounceApi-Ruby.git"
+
+group :development do
+  # Code coverage report.
+  gem "simplecov"
+
+  # RSpec.
+  gem "rspec"
+
+  # YARD and friends.
+  gem "redcarpet"
+  gem "yard"
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GIT
+  remote: https://github.com/NeverBounce/NeverBounceApi-Ruby.git
+  revision: f7ecf950759aa61b818089cd1a1554bb93cb3851
+  specs:
+    neverbounce-api (1.0.0)
+      httparty (~> 0.15)
+
+PATH
+  remote: .
+  specs:
+    neverbounce-cli (1.0.0)
+      neverbounce-api (~> 1.0.0)
+      terminal-table (~> 1.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.1.5)
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    json (2.1.0)
+    multi_xml (0.6.0)
+    redcarpet (3.4.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.15.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.3.0)
+    yard (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  neverbounce-api!
+  neverbounce-cli!
+  redcarpet
+  rspec
+  simplecov
+  yard
+
+BUNDLED WITH
+   1.15.3

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2017 NeverBounce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,138 @@
+
+<p align="center"><img src="https://neverbounce-marketing.s3.amazonaws.com/neverbounce_color_600px.png"></p>
+
+<p align="center">
+  <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>
+</p>
+
+NeverBounceCli-Ruby
+===================
+
+This is the official NeverBounce V4 CLI written in Ruby. See also:
+
+* Our Ruby API gem: https://github.com/NeverBounce/NeverBounceApi-Ruby.
+* Our full RubyDoc documentation: http://rubydoc.info/github/NeverBounce/NeverBounceCli-Ruby.
+
+## Installation
+
+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"
+```
+
+Install bundle, generate binstubs:
+
+```sh
+$ 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
+```
+
+Create `~/.neverbounce.yml`, add your API key there:
+
+```yaml
+api_key: key123abc
+```
+
+## Usage
+
+Before we begin, here's just 2 things you need to know to become a happy NeverBounce CLI user:
+
+1. Script names consistently map to our [REST API v4](https://developers.neverbounce.com/v4.0/).
+  <br />For example, `nb-single-check` calls `single/check`, `nb-jobs-create` calls `jobs/create` and so on.
+2. Every script supports `--help` and tells everything about itself.
+
+Let's see what `nb-single-check` has to offer:
+
+```
+$ bin/nb-single-check --help
+nb-single-check - Check a single e-mail
+
+USAGE: nb-single-check [options] [VAR1=value] [VAR2=value] ...
+
+-h, --help                       Show help information
+
+Environment variables:
+* API_KEY      - API key ("2ed45186c72f9319dc64338cdf16ab76b44cf3d1")
+* EMAIL        - E-mail to check ("alice@isp.com", "bob.smith+1@domain.com")
+- ADDRESS_INFO - Request additional address info ("y", "n")
+- API_URL      - Custom API URL ("https://staging-api.isp.com/v5")
+- CREDITS_INFO - Request additional credits info ("y", "n")
+- CURL         - Print cURL request and exit ("y", ["N"])
+- RAW          - Print raw response body ("y", ["N"])
+- TIMEOUT      - Timeout in seconds to verify the address ("5")
+```
+
+Now, let's check an e-mail:
+
+```
+$ bin/nb-single-check EMAIL=support@neverbounce.com
+
+Response:
++--------+------------------+----------+----------+
+| Result |      Flags       | SuggCorr | ExecTime |
++--------+------------------+----------+----------+
+| valid  | has_dns          |          |      651 |
+|        | has_dns_mx       |          |          |
+|        | role_account     |          |          |
+|        | smtp_connectable |          |          |
++--------+------------------+----------+----------+
+```
+
+With a bit of tuning:
+
+```
+$ bin/nb-single-check EMAIL=support@neverbounce.com CREDITS_INFO=y
+
+Response:
+<...like above...>
+
+CreditsInfo:
++---------+----------+---------+----------+
+| FreeRmn | FreeUsed | PaidRmn | PaidUsed |
++---------+----------+---------+----------+
+|     969 |        1 | 1000000 |        0 |
++---------+----------+---------+----------+
+```
+
+## Advanced usage
+
+### Print cURL command with `CURL=y`
+
+Each of our scripts can print command to make the request using native `curl` binary on your OS. For example:
+
+```
+$ bin/nb-single-check EMAIL=support@neverbounce.com CURL=y
+curl --request GET --url https://api.neverbounce.com/v4/single/check --header Content-Type:\ application/json
+--data-binary \{\"email\":\"support@neverbounce.com\",\"key\":\"key123abc\"\}
+```
+
+You can now pass this command around, use it in scripts etc.
+
+### Print raw response with `RAW=y`
+
+Each of our scripts can print raw server response without decoding it. For example:
+
+```
+$ bin/nb-single-check EMAIL=support@neverbounce.com RAW=y
+{"status":"success","result":"valid","flags":["smtp_connectable","has_dns","has_dns_mx","role_account"],
+"suggested_correction":"","execution_time":787}
+```
+
+Although primary users of this feature is us at NeverBounce, you can also find it helpful once you encounter a server glitch and want to send us a meaningful bug report.
+
+## Compatibility
+
+Minimum Ruby version is 2.0.
+
+## Copyright
+
+NeverBounce CLI in Ruby is free and is licensed under the MIT License.
+Copyright &copy; 2017 NeverBounce.

data/exe/nb-account-info

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

data/exe/nb-jobs-create

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

data/exe/nb-jobs-delete

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

data/exe/nb-jobs-download

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

data/exe/nb-jobs-parse

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

data/exe/nb-jobs-results

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

data/exe/nb-jobs-search

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

data/exe/nb-jobs-start

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

data/exe/nb-jobs-status

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

data/exe/nb-single-check

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

data/lib/never_bounce/cli/feature/basic_initialize.rb

@@ -0,0 +1,20 @@
+
+module NeverBounce; module CLI; module Feature
+  # Provide the basic method <tt>#initialize</tt> for the owner class.
+  # @see InstanceMethods#initialize
+  module BasicInitialize
+    # @param owner [Class]
+    # @return [nil]
+    def self.load(owner)
+      return if owner < InstanceMethods
+      owner.send(:include, InstanceMethods)
+    end
+
+    module InstanceMethods
+      # See source for details.
+      def initialize(attrs = {})
+        attrs.each { |k, v| public_send("#{k}=", v) }
+      end
+    end
+  end
+end; end; end

data/lib/never_bounce/cli/feature/eigencache.rb

@@ -0,0 +1,47 @@
+
+module NeverBounce; module CLI; module Feature
+  # Eigenclass (singleton class)-based cache which allows to handle "hidden" instance variables.
+  # @see InstanceMethods#_cache
+  module Eigencache
+    # @param owner [Class]
+    # @return [nil]
+    def self.load(owner)
+      return if owner < InstanceMethods
+      owner.send(:include, InstanceMethods)
+    end
+
+    module InstanceMethods
+      # Hidden cache.
+      #
+      #   def body
+      #     _cache[:body] ||= File.read("my-bulky-body.csv")
+      #   end
+      #
+      #   def body=(v)
+      #     _cache[:body] = v
+      #   end
+      #
+      # @return [Hash]
+      def _cache
+        if eigen.instance_variable_defined?(k = :@cache)
+          eigen.instance_variable_get(k)
+        else
+          eigen.instance_variable_set(k, {})
+        end
+      end
+
+      private
+
+      # Object's eigenclass (singleton class).
+      # @return [Class]
+      def eigen
+        class << self; self; end
+      end
+    end
+  end
+end; end; end
+
+#
+# Implementation notes:
+#
+# * As of Ruby 2.1 `Object#singleton_class` is introduced. We use our own compatible implementation, `eigen`.

data/lib/never_bounce/cli/feature/envars/examples_mapper.rb

@@ -0,0 +1,38 @@
+
+require_relative "../envars"
+
+module NeverBounce; module CLI; module Feature; module Envars
+  # A simple transformer/validator for <tt>examples</tt> argument.
+  #
+  # @see #process
+  class ExamplesMapper
+    # Process input, render output.
+    #
+    #   process([1, 2, 3])            # => {values: [1, 2, 3]}
+    #   process([1, 2, default: 3])   # => {values: [1, 2, 3], default: 3}
+    #
+    # @param input [Array] Items to process.
+    # @return [Hash] A hash with <tt>values</tt> and optionally <tt>default</tt>.
+    def process(input)
+      values, default = [], nil
+
+      input.each do |elem|
+        if elem.is_a? Hash
+          # Validate, then use.
+          raise ArgumentError, "Unknown element format: #{elem.inspect}" if elem.keys != [:default]
+          values << (default = elem[:default])
+        else
+          values << elem
+        end
+      end
+
+      # Return result.
+      {}.tap do |h|
+        h[:values] = values
+        h[:default] = default if default
+      end
+    end
+
+    alias_method :[], :process
+  end
+end; end; end; end