neverbounce-cli 1.0.0

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

@@ -0,0 +1,67 @@
+
+module NeverBounce; module CLI; module Script
+  describe RequestMaker do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "envars" do
+      it "generally works" do
+        envars = described_class.envars
+        expect(envars.map(&:name)).to eq ["API_KEY", "API_URL", "CURL", "RAW"]
+        expect(envars.map(&:mandatory?)).to eq [true, false, false, false]
+      end
+    end
+
+    describe "CURL=y" do
+      it "generally works" do
+        r = goodo(
+          argv: ["CURL=y"],
+          request: API::Request::JobsParse.new(api_key: "api_key", job_id: "job_id"),
+        )
+        expect { r.main }.not_to raise_error
+        lines = r.stdout.tap(&:rewind).to_a
+        expect(lines[0]).to start_with "curl --request POST --url https://api.neverbounce.com/v4/jobs/parse"
+      end
+    end
+
+    describe "RAW=y" do
+      it "generally works" do
+        r = goodo(
+          argv: ["RAW=y"],
+          server_raw: "raw123",
+        )
+        expect { r.main }.not_to raise_error
+        lines = r.stdout.tap(&:rewind).to_a
+        expect(lines).to eq ["raw123\n"]
+      end
+    end
+
+    describe "#api_key" do
+      it "generally works" do
+        r = newo(env: {}, user_config: Struct.new(:api_key).new)
+        expect { r.api_key }.to raise_error(UsageError, "API key not given, use `API_KEY=`")
+        r = newo(env: {"API_KEY" => "api_key"})
+        expect(r.api_key).to eq "api_key"
+        r = newo(env: {}, user_config: Class.new { def api_key; "api_key2"; end }.new)
+        expect(r.api_key).to eq "api_key2"
+      end
+    end
+
+    describe "#api_url" do
+      it "generally works" do
+        r = newo(env: {}, user_config: Struct.new(:api_url).new)
+        expect(r.api_url).to be nil
+        r = newo(env: {"API_URL" => "api_url"})
+        expect(r.api_url).to eq "api_url"
+        r = newo(env: {}, user_config: Class.new { def api_url; "api_url2"; end }.new)
+        expect(r.api_url).to eq "api_url2"
+      end
+    end
+  end
+end; end; end
+
+#
+# Implementation notes:
+#
+# * We check envars in order of declaration for ease of whole-set testing.

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

@@ -0,0 +1,94 @@
+
+module NeverBounce; module CLI; module Script
+  describe SingleCheck do
+    include_dir_context __dir__
+
+    def margv(*args)
+      ["API_KEY=abc", "EMAIL=alice@isp.com"] + args
+    end
+
+    it_behaves_like "instantiatable"
+    it_behaves_like "a script supporting `--help`", signatures: [/nb-single-check/, /ADDRESS_INFO/, /EMAIL/, /CREDITS_INFO/, /TIMEOUT/]
+
+    describe "mode attributes" do
+      describe "#address_info" do
+        let(:m) { :address_info }
+        it "generally works" do
+          expect(newo(env: {}).send(m)).to be nil
+          expect(newo(env: {"ADDRESS_INFO" => "y"}).send(m)).to be true
+          expect(newo(env: {"ADDRESS_INFO" => "n"}).send(m)).to be false
+        end
+      end
+
+      describe "#credits_info" do
+        let(:m) { :credits_info }
+        it "generally works" do
+          expect(newo(env: {}).send(m)).to be nil
+          expect(newo(env: {"CREDITS_INFO" => "y"}).send(m)).to be true
+          expect(newo(env: {"CREDITS_INFO" => "n"}).send(m)).to be false
+        end
+      end
+
+      describe "#timeout" do
+        let(:m) { :timeout }
+        it "generally works" do
+          expect(newo(env: {}).send(m)).to be nil
+          expect { newo(env: {"TIMEOUT" => "abc"}).send(m) }.to raise_error(UsageError, "invalid value for Integer(): \"abc\"")
+          expect(newo(env: {"TIMEOUT" => "12"}).send(m)).to be 12
+        end
+      end
+    end
+
+    describe "#request_curl" do
+      it "generally works" do
+        r = goodo(argv: margv("ADDRESS_INFO=y", "CREDITS_INFO=y", "TIMEOUT=12"))
+        expect(r.request_curl).to eq ["--request", "GET", "--url", "https://api.neverbounce.com/v4/single/check", "--header", "Content-Type: application/json", "--data-binary", "{\"email\":\"alice@isp.com\",\"key\":\"abc\",\"address_info\":true,\"credits_info\":true,\"timeout\":12}"]
+      end
+    end
+
+    describe "output" do
+      context "when monthly subscription" do
+        it "generally works" do
+          r = goodo(argv: margv).tap do |_|
+            _.session.server_content_type = "application/json"
+            _.session.server_raw = '{"address_info":{"addr":"support","alias":"","domain":"neverbounce","fqdn":"neverbounce.com","host":"neverbounce.com","normalized_email":"support@neverbounce.com","original_email":"support@neverbounce.com","subdomain":"","tld":"com"},"credits_info":{"free_credits_remaining":999,"free_credits_used":1,"monthly_api_usage":0},"execution_time":678,"flags":["has_dns","has_dns_mx","role_account","smtp_connectable"],"result":"valid","status":"success","suggested_correction":""}'
+          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("Result") }
+          expect(lines).to be_any { |s| s =~ cell("ExecTime") }
+          expect(lines).to be_any { |s| s =~ /AddressInfo:/ }
+          expect(lines).to be_any { |s| s =~ cell("Addr") }
+          expect(lines).to be_any { |s| s =~ cell("TLD") }
+          expect(lines).to be_any { |s| s =~ /CreditsInfo:/ }
+          expect(lines).to be_any { |s| s =~ cell("FreeRmn") }
+          expect(lines).to be_any { |s| s =~ cell("FreeUsed") }
+          expect(lines).to be_any { |s| s =~ cell("MonthlyUsage") }
+        end
+      end
+
+      context "when paid subscription" do
+        it "generally works" do
+          r = goodo(argv: margv).tap do |_|
+            _.session.server_content_type = "application/json"
+            _.session.server_raw = '{"status":"success","result":"valid","flags":["contains_alias","smtp_connectable","has_dns","has_dns_mx"],"suggested_correction":"","address_info":{"original_email":"fortunadze+1@gmail.com","normalized_email":"fortunadze@gmail.com","addr":"fortunadze","alias":"1","host":"gmail.com","fqdn":"gmail.com","domain":"gmail","subdomain":"","tld":"com"},"credits_info":{"paid_credits_used":0,"free_credits_used":1,"paid_credits_remaining":1000000,"free_credits_remaining":941},"execution_time":189}'
+          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("Result") }
+          expect(lines).to be_any { |s| s =~ cell("ExecTime") }
+          expect(lines).to be_any { |s| s =~ /AddressInfo:/ }
+          expect(lines).to be_any { |s| s =~ cell("Addr") }
+          expect(lines).to be_any { |s| s =~ cell("TLD") }
+          expect(lines).to be_any { |s| s =~ /CreditsInfo:/ }
+          expect(lines).to be_any { |s| s =~ cell("FreeRmn") }
+          expect(lines).to be_any { |s| s =~ cell("FreeUsed") }
+          expect(lines).to be_any { |s| s =~ cell("PaidRmn") }
+          expect(lines).to be_any { |s| s =~ cell("PaidUsed") }
+        end
+      end
+    end
+  end
+end; end; end

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

@@ -0,0 +1,59 @@
+
+shared_context __dir__ do
+  # Build a regexp to match a text cell value.
+  def cell(value)
+    Regexp.compile '\|\s*?' + value.to_s + '\s*?\|'
+  end
+
+  # Create a "good" script object which is about to do some real processing.
+  def goodo(attrs = {})
+    # This thing is much over the top for a regular "new object", hence a unique name `goodo`.
+    # Stuff empty `argv` for convenience. It'll be overridden by `merge` if needed.
+    # Otherwise it'll fetch args given to `rspec`, which has no point.
+    described_class.new({
+      argv: [],
+      env: {},    # We don't want RSpec invocation environment to interfere.
+      stderr: (stderr = StringIO.new),
+      stdout: (stdout = StringIO.new),
+    }.merge(attrs)).tap do |_|
+      # IMPORTANT: We *MUST* call `handle_help_and_options` to read ENV settings from `argv`.
+      #   We add expectation here since we have to call that thing anyway.
+      #   It's mostly due to screwed `OptionParser` logic.
+      #expect(_.handle_help_and_options).to be_nil
+      res = _.handle_help_and_options
+      if not res.nil?
+        # Print all messages and errors from the script.
+        puts stdout.tap(&:rewind).to_a
+        STDERR.puts stderr.tap(&:rewind).to_a
+        expect(res).to be nil   # Make it fail now.
+      end
+    end
+  end
+
+  # Usage:
+  #
+  #   it_behaves_like "..."
+  #   it_behaves_like "...", klass: the_klass
+  #   it_behaves_like "...", signatures: [/nb-jobs-delete/, /ID/]
+  shared_examples "a script supporting `--help`" do |klass: described_class, signatures: nil|
+    it "generally works" do
+      # Validate arguments.
+      expect(signatures).to be_a Array
+
+      r = klass.new(
+        argv: ["--help"],
+        stdout: StringIO.new,
+      )
+
+      out = nil
+      expect { out = r.main }.not_to raise_error
+      expect(out).to be 0
+
+      lines = r.stdout.tap(&:rewind).to_a
+      expect(lines).to be_any { |s| s =~ /USAGE/ }
+      signatures.each do |re|
+        expect(lines).to be_any { |s| s =~ re }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+
+describe NeverBounce::CLI::Script::Table do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+end

data/spec/lib/never_bounce/cli/user_config/file_content_spec.rb

@@ -0,0 +1,43 @@
+
+describe NeverBounce::CLI::UserConfig::FileContent do
+  include_dir_context __dir__
+
+  describe "#[]" do
+    it "generally works" do
+      r = newo(body_hash: {"a" => 1})
+      expect(r["a"]).to eq 1
+      expect(r[:a]).to eq 1
+      expect(r[:b]).to be nil
+    end
+  end
+
+  describe "#body_hash" do
+    it "generally works" do
+      r = newo(body: "")
+      expect(r.body_hash).to eq({})
+
+      r = newo(body: ":")
+      expect { r.body_hash }.to raise_error YAML::SyntaxError
+
+      r = newo(body: "a: 1\nb: 2")
+      expect(r.body_hash).to eq({"a" => 1, "b" => 2})
+    end
+  end
+
+  describe "#filename" do
+    it "generally works" do
+      r = newo(env: {"HOME" => "/home/joe"})
+      expect(r.filename).to eq "/home/joe/.neverbounce.yml"
+    end
+  end
+
+  describe "#has_key?" do
+    it "generally works" do
+      r = newo(body_hash: {"a" => 1})
+      expect(r.has_key? :a).to be true
+      expect(r.has_key? "a").to be true
+      expect(r.has_key? :b).to be false
+      expect(r.has_key? "b").to be false
+    end
+  end
+end

data/spec/lib/never_bounce/cli/user_config_spec.rb

@@ -0,0 +1,12 @@
+
+module NeverBounce::CLI
+  describe UserConfig do
+    include_dir_context __dir__
+
+    it "generally works" do
+      r = newo(fc: described_class::FileContent.new(body:"---\napi_key: abc\napi_url: def"))
+      expect(r.api_key).to eq "abc"
+      expect(r.api_url).to eq "def"
+    end
+  end
+end

data/spec/lib/never_bounce/cli_spec.rb

@@ -0,0 +1,6 @@
+
+describe NeverBounce::CLI do
+  describe "VERSION" do
+    it { expect(described_class::VERSION).to eq "1.0.0" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+
+# Optionally include developer-local spec helper.
+File.readable?(fn = File.join(__dir__, "spec_local.rb")) and require fn
+
+# Start SimpleCov if it's enabled in Gemlocal.
+begin
+  require "simplecov"
+  puts "NOTE: SimpleCov starting"
+  SimpleCov.start
+rescue LoadError
+  # This is mostly a normal case, don't print anything.
+end
+
+# Self.
+require "neverbounce-cli"
+
+# Require all `spec_helper.rb` throughout the tree for shared contexts.
+Dir[File.join(__dir__, "**/spec_helper.rb")].each { |fn| require fn }
+
+RSpec.configure do |conf|
+  conf.extend Module.new {
+    # Include hierarchical contexts from <tt>spec/</tt> up to <tt>__dir__</tt>.
+    #
+    #   describe Something do
+    #     include_dir_context __dir__
+    #     ...
+    def include_dir_context(dir)
+      d, steps = dir, []
+      while d.size >= __dir__.size
+        steps << d
+        d = File.join(File.split(d)[0..-2])
+      end
+
+      steps.reverse.each do |d|
+        begin; include_context d; rescue ArgumentError; end
+      end
+    end
+  } # conf.extend
+end
+
+# Absolutely common shared context.
+shared_context __dir__ do
+  shared_examples "instantiatable" do
+    it { expect(described_class.new).to be_a described_class }
+  end
+
+  # General-purpose "create new object".
+  def newo(attrs = {})
+    described_class.new(attrs)
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: neverbounce-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- NeverBounce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: neverbounce-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: 
+email:
+- support@neverbounce.com
+executables:
+- nb-account-info
+- nb-jobs-create
+- nb-jobs-delete
+- nb-jobs-download
+- nb-jobs-parse
+- nb-jobs-results
+- nb-jobs-search
+- nb-jobs-start
+- nb-jobs-status
+- nb-single-check
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- exe/nb-account-info
+- exe/nb-jobs-create
+- exe/nb-jobs-delete
+- exe/nb-jobs-download
+- exe/nb-jobs-parse
+- exe/nb-jobs-results
+- exe/nb-jobs-search
+- exe/nb-jobs-start
+- exe/nb-jobs-status
+- exe/nb-single-check
+- lib/never_bounce/cli/feature/basic_initialize.rb
+- lib/never_bounce/cli/feature/eigencache.rb
+- lib/never_bounce/cli/feature/envars.rb
+- lib/never_bounce/cli/feature/envars/examples_mapper.rb
+- lib/never_bounce/cli/feature/envars/item.rb
+- lib/never_bounce/cli/feature/igetset.rb
+- lib/never_bounce/cli/feature/require_attr.rb
+- lib/never_bounce/cli/script/account_info.rb
+- lib/never_bounce/cli/script/base.rb
+- lib/never_bounce/cli/script/error.rb
+- lib/never_bounce/cli/script/feature/requires_job_id.rb
+- lib/never_bounce/cli/script/feature/uses_pagination.rb
+- lib/never_bounce/cli/script/jobs_create.rb
+- lib/never_bounce/cli/script/jobs_create/supplied_input_parser.rb
+- lib/never_bounce/cli/script/jobs_delete.rb
+- lib/never_bounce/cli/script/jobs_download.rb
+- lib/never_bounce/cli/script/jobs_parse.rb
+- lib/never_bounce/cli/script/jobs_results.rb
+- lib/never_bounce/cli/script/jobs_search.rb
+- lib/never_bounce/cli/script/jobs_start.rb
+- 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/request_maker.rb
+- lib/never_bounce/cli/script/single_check.rb
+- lib/never_bounce/cli/script/table.rb
+- lib/never_bounce/cli/user_config.rb
+- lib/never_bounce/cli/user_config/file_content.rb
+- lib/never_bounce/cli/version.rb
+- lib/neverbounce-cli.rb
+- neverbounce-cli.gemspec
+- spec/lib/never_bounce/cli/feature/basic_initialize_spec.rb
+- spec/lib/never_bounce/cli/feature/eigencache_spec.rb
+- spec/lib/never_bounce/cli/feature/envars/examples_mapper_spec.rb
+- spec/lib/never_bounce/cli/feature/envars/item_spec.rb
+- spec/lib/never_bounce/cli/feature/envars_spec.rb
+- spec/lib/never_bounce/cli/feature/igetset_spec.rb
+- spec/lib/never_bounce/cli/feature/require_attr_spec.rb
+- spec/lib/never_bounce/cli/script/account_info_spec.rb
+- spec/lib/never_bounce/cli/script/base_spec.rb
+- spec/lib/never_bounce/cli/script/feature/requires_job_id_spec.rb
+- spec/lib/never_bounce/cli/script/feature/uses_pagination_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_create/supplied_input_parser_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_create_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_delete_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_download_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_parse_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_results_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_search_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_start_spec.rb
+- 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/request_maker_spec.rb
+- spec/lib/never_bounce/cli/script/single_check_spec.rb
+- spec/lib/never_bounce/cli/script/spec_helper.rb
+- spec/lib/never_bounce/cli/script/table_spec.rb
+- spec/lib/never_bounce/cli/user_config/file_content_spec.rb
+- spec/lib/never_bounce/cli/user_config_spec.rb
+- spec/lib/never_bounce/cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://neverbounce.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: The official NeverBounce CLI written in Ruby
+test_files:
+- spec/lib/never_bounce/cli/feature/basic_initialize_spec.rb
+- spec/lib/never_bounce/cli/feature/eigencache_spec.rb
+- spec/lib/never_bounce/cli/feature/envars/examples_mapper_spec.rb
+- spec/lib/never_bounce/cli/feature/envars/item_spec.rb
+- spec/lib/never_bounce/cli/feature/envars_spec.rb
+- spec/lib/never_bounce/cli/feature/igetset_spec.rb
+- spec/lib/never_bounce/cli/feature/require_attr_spec.rb
+- spec/lib/never_bounce/cli/script/account_info_spec.rb
+- spec/lib/never_bounce/cli/script/base_spec.rb
+- spec/lib/never_bounce/cli/script/feature/requires_job_id_spec.rb
+- spec/lib/never_bounce/cli/script/feature/uses_pagination_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_create/supplied_input_parser_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_create_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_delete_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_download_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_parse_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_results_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_search_spec.rb
+- spec/lib/never_bounce/cli/script/jobs_start_spec.rb
+- 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/request_maker_spec.rb
+- spec/lib/never_bounce/cli/script/single_check_spec.rb
+- spec/lib/never_bounce/cli/script/spec_helper.rb
+- spec/lib/never_bounce/cli/script/table_spec.rb
+- spec/lib/never_bounce/cli/user_config/file_content_spec.rb
+- spec/lib/never_bounce/cli/user_config_spec.rb
+- spec/lib/never_bounce/cli_spec.rb
+- spec/spec_helper.rb