neverbounce-cli 1.0.0

data/lib/never_bounce/cli/version.rb

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

data/lib/neverbounce-cli.rb

@@ -0,0 +1,3 @@
+
+# Main gem require. Load all libraries.
+Dir[File.join(__dir__, "**/*.rb")].each { |fn| require fn }

data/neverbounce-cli.gemspec

@@ -0,0 +1,24 @@
+
+require_relative "lib/never_bounce/cli/version"
+
+Gem::Specification.new do |s|
+  s.name = "neverbounce-cli"
+  s.summary = "The official NeverBounce CLI written in Ruby"
+
+  s.authors = ["NeverBounce"]
+  s.email = ["support@neverbounce.com"]
+  s.homepage = "https://neverbounce.com"
+  s.license = "MIT"
+  s.version = NeverBounce::CLI::VERSION
+
+  s.required_ruby_version = ">= 2.0.0"
+
+  s.bindir = "exe"
+  s.executables = `git ls-files -- exe/*`.split("\n").map { |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency("neverbounce-api", "~> 1.0.0")
+  s.add_dependency("terminal-table", "~> 1.8.0")
+end

data/spec/lib/never_bounce/cli/feature/basic_initialize_spec.rb

@@ -0,0 +1,26 @@
+
+describe NeverBounce::CLI::Feature::BasicInitialize do
+  let(:klass) do
+    feature = described_class
+
+    Class.new do
+      feature.load(self)
+
+      attr_accessor :a, :b
+
+      private
+
+      def c=(value)
+        @c = value
+      end
+    end
+  end
+
+  it "generally works" do
+    r = klass.new(a: 12, b: "34")
+    expect(r.a).to eq 12
+    expect(r.b).to eq "34"
+
+    expect { klass.new(c: 12) }.to raise_error(NoMethodError, /\bprivate method `c='/)
+  end
+end

data/spec/lib/never_bounce/cli/feature/eigencache_spec.rb

@@ -0,0 +1,28 @@
+
+describe NeverBounce::CLI::Feature::Eigencache do
+  let(:klass) do
+    feature = described_class
+
+    Class.new do
+      feature.load(self)
+
+      def a
+        _cache[:a] ||= "a"
+      end
+
+      def a=(value)
+        _cache[:a] = value
+      end
+    end
+  end
+
+  it "generally works" do
+    r = klass.new
+    expect(r.a).to eq "a"
+    expect(r.inspect).not_to match "@a"
+
+    r.a = "a+"
+    expect(r.a).to eq "a+"
+    expect(r.inspect).not_to match "@a"
+  end
+end

data/spec/lib/never_bounce/cli/feature/envars/examples_mapper_spec.rb

@@ -0,0 +1,26 @@
+
+describe NeverBounce::CLI::Feature::Envars::ExamplesMapper do
+  def m(input)
+    described_class.new.process(input)
+  end
+
+  it "generally works" do
+    # Bad input.
+    [
+      [[1, abc: "xyz"], ArgumentError, "Unknown element format: {:abc=>\"xyz\"}"],
+    ].each do |input, error, message|
+      expect {m(input)}.to raise_error(error, message)
+    end
+
+    # Good input.
+    [
+      [[], {values: []}],
+      [[1], {values: [1]}],
+      [["y", default: "N"], {values: ["y", "N"], default: "N"}],
+      [[1, default: 2], {values: [1, 2], default: 2}],
+      [[1, {default: 2}, {default: 3}], {values: [1, 2, 3], default: 3}],
+    ].each do |input, expected|
+      expect([input, m(input)]).to eq([input, expected])
+    end
+  end
+end

data/spec/lib/never_bounce/cli/feature/envars/item_spec.rb

@@ -0,0 +1,9 @@
+
+describe NeverBounce::CLI::Feature::Envars::Item do
+  it "has defaults" do
+    r = described_class.new
+    expect(r.examples).to eq []
+    expect(r.default).to be nil
+    expect(r.is_mandatory).to be false
+  end
+end

data/spec/lib/never_bounce/cli/feature/envars_spec.rb

@@ -0,0 +1,55 @@
+
+describe NeverBounce::CLI::Feature::Envars do
+  describe "#define_envar" do
+    it "generally works" do
+      feature = described_class
+
+      parent = Class.new do
+        feature.load(self)
+        define_envar "p.var1", "p.cmt1"
+      end
+
+      r = Class.new(parent) do
+        define_envar "var1", "cmt1"
+        define_envar "var2", "cmt2", is_mandatory: true
+        define_envar "var3", "cmt3", examples: ["a", "b"]
+        define_envar "var4", "cmt4", examples: ["y", "N"], default: "N"
+      end.new
+
+      # Do some "matrix" checks on the items.
+      envars = r.class.envars
+      expect(envars.size).to eq 5
+      expect(envars.map(&:name)).to eq ["p.var1", "var1", "var2", "var3", "var4"]
+      expect(envars.map(&:comment)).to eq ["p.cmt1", "cmt1", "cmt2", "cmt3", "cmt4"]
+      expect(envars.map(&:is_mandatory)).to eq [false, false, true, false, false]
+      expect(envars.map(&:examples)).to eq [[], [], [], ["a", "b"], ["y", "N"]]
+      expect(envars.map(&:default)).to eq [nil, nil, nil, nil, "N"]
+    end
+  end
+
+  describe "#envar" do
+    it "generally works" do
+      feature = described_class
+
+      parent = Class.new do
+        feature.load(self)
+        envar "p.var1", "p.cmt1"
+      end
+
+      r = Class.new(parent) do
+        envar "var1", "cmt1"
+        envar "var2*", "cmt2"
+        envar "var3", "cmt3", ["a", "b"]
+        envar "var4", "cmt4", ["y", default: "N"]
+      end.new
+
+      envars = r.class.envars
+      expect(envars.size).to eq 5
+      expect(envars.map(&:name)).to eq ["p.var1", "var1", "var2", "var3", "var4"]
+      expect(envars.map(&:comment)).to eq ["p.cmt1", "cmt1", "cmt2", "cmt3", "cmt4"]
+      expect(envars.map(&:is_mandatory)).to eq [false, false, true, false, false]
+      expect(envars.map(&:examples)).to eq [[], [], [], ["a", "b"], ["y", "N"]]
+      expect(envars.map(&:default)).to eq [nil, nil, nil, nil, "N"]
+    end
+  end
+end

data/spec/lib/never_bounce/cli/feature/igetset_spec.rb

@@ -0,0 +1,45 @@
+
+describe NeverBounce::CLI::Feature::Igetset do
+  let(:klass) do
+    feature = described_class
+
+    Class.new do
+      feature.load(self)
+
+      attr_writer :is_a, :is_b
+
+      def is_a
+        igetset(:is_a) do
+          seq << :is_a_block
+          false
+        end
+      end
+
+      def is_b
+        igetset(:is_a) do
+          seq << :is_b_block
+          nil
+        end
+      end
+
+      # Store call sequence here.
+      def seq
+        @log ||= []
+      end
+    end
+  end
+
+  it "generally works" do
+    r = klass.new
+    expect(r.seq).to eq []
+    expect(r.is_a).to be false
+    expect(r.is_a).to be false
+    expect(r.seq).to eq [:is_a_block]   # Block evaluation is logged once.
+
+    r = klass.new
+    expect(r.seq).to eq []
+    expect(r.is_b).to be nil
+    expect(r.is_b).to be nil
+    expect(r.seq).to eq [:is_b_block]
+  end
+end

data/spec/lib/never_bounce/cli/feature/require_attr_spec.rb

@@ -0,0 +1,25 @@
+
+module NeverBounce; module CLI; module Feature
+  describe RequireAttr do
+    let(:klass) do
+      feature = described_class
+      Class.new do
+        feature.load(self)
+
+        attr_accessor :a
+
+        def b
+          v = require_attr :a
+          [v, "b"]
+        end
+      end
+    end
+
+    it "generally works" do
+      r = klass.new
+      expect { r.b }.to raise_error(RuntimeError, "Attribute must be set: a")
+      r.a = "a"
+      expect(r.b).to eq ["a", "b"]
+    end
+  end
+end; end; end

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

@@ -0,0 +1,65 @@
+
+module NeverBounce; module CLI; module Script
+  describe AccountInfo do
+    include_dir_context __dir__
+
+    def margv(*args)
+      ["API_KEY=abc"] + args
+    end
+
+    it_behaves_like "instantiatable"
+    it_behaves_like "a script supporting `--help`", signatures: [/nb-account-info/]
+
+    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/account/info", "--header", "Content-Type: application/json", "--data-binary", "{\"key\":\"abc\"}"]
+      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 = '{"credits_info":{"free_credits_remaining":1000,"free_credits_used":0,"monthly_api_usage":0},"execution_time":405,"job_counts":{"completed":3,"processing":0,"queued":0,"under_review":0},"status":"success"}'
+          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("ExecTime") }
+          expect(lines).to be_any { |s| s =~ /^Credits:$/ }
+          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") }
+          expect(lines).to be_any { |s| s =~ /^JobCounts:$/ }
+          expect(lines).to be_any { |s| s =~ cell("Completed") }
+          expect(lines).to be_any { |s| s =~ cell("UnderReview") }
+        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","credits_info":{"paid_credits_used":0,"free_credits_used":0,"paid_credits_remaining":1000000,"free_credits_remaining":959},"job_counts":{"completed":1,"under_review":0,"queued":0,"processing":0},"execution_time":525}'
+          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("ExecTime") }
+          expect(lines).to be_any { |s| s =~ /^Credits:$/ }
+          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") }
+          expect(lines).to be_any { |s| s =~ /^JobCounts:$/ }
+          expect(lines).to be_any { |s| s =~ cell("Completed") }
+          expect(lines).to be_any { |s| s =~ cell("UnderReview") }
+        end
+      end
+    end # describe "output"
+  end
+end; end; end

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

@@ -0,0 +1,56 @@
+
+describe NeverBounce::CLI::Script::Base do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+
+  describe ".env_value_truthy?" do
+    it "generally works" do
+      [
+        ["", false],
+        [" ", false],
+        [0, false],
+        ["0", false],
+        ["kk", false],
+        ["n", false],
+        ["N", false],
+
+        [1, true],
+        ["1", true],
+        ["y", true],
+        ["Y", true],
+        ["yes", true],
+        ["YES", true],
+        ["true", true],
+      ].each do |input, expected|
+        expect([input, described_class.env_value_truthy?(input)]).to eq [input, expected]
+      end
+    end
+  end
+
+  describe "#env_truthy?" do
+    it "generally works" do
+      r = newo(env: {
+        # Load a few values, not necessarily every possible one.
+        "na" => "",
+        "nb" => "0",
+        "nc" => "n",
+        "ya" => "1",
+        "yb" => "y",
+        "yc" => "yes",
+      })
+
+      [
+        ["na", false],
+        ["nb", false],
+        ["nc", false],
+        ["ya", true],
+        [:ya, true],
+        ["yb", true],
+        ["yc", true],
+      ].each do |k, expected|
+        expect([k, r.env_truthy?(k)]).to eq [k, expected]
+      end
+    end
+  end
+end

data/spec/lib/never_bounce/cli/script/feature/requires_job_id_spec.rb

@@ -0,0 +1,17 @@
+
+module NeverBounce; module CLI; module Script; module Feature
+  describe RequiresJobId do
+    let(:klass) do
+      feature = described_class
+      Class.new(Meaningful) do
+        feature.load(self)
+      end
+    end
+
+    it "generally works" do
+      r = klass.new(env: {})
+      expect(r.envar_text).to eq "- ID - Job ID (\"276816\")"
+      expect { r.job_id }.to raise_error Script::UsageError, /use `ID=`/
+    end
+  end
+end; end; end; end

data/spec/lib/never_bounce/cli/script/feature/uses_pagination_spec.rb

@@ -0,0 +1,21 @@
+
+module NeverBounce; module CLI; module Script; module Feature
+  describe UsesPagination do
+    let(:klass) do
+      feature = described_class
+      Class.new(Meaningful) do
+        feature.load(self)
+      end
+    end
+
+    it "generally works" do
+      r = klass.new(env: {
+        "PAGE" => "12",
+        "PER_PAGE" => "34",
+      })
+      expect(r.envar_text).to eq "- PAGE     - Fetch page number N ([1], 5)\n- PER_PAGE - Paginate results N items per page (10, [1000])"
+      expect(r.page).to eq 12
+      expect(r.per_page).to eq 34
+    end
+  end
+end; end; end; end

data/spec/lib/never_bounce/cli/script/jobs_create/supplied_input_parser_spec.rb

@@ -0,0 +1,35 @@
+
+module NeverBounce; module CLI; module Script; class JobsCreate
+  describe SuppliedInputParser do
+    include_dir_context __dir__
+
+    describe "#separator" do
+      it "generally works" do
+        expect(newo.separator).to eq /[;,\n]/
+        expect(newo(separator: ";").separator).to eq ";"
+      end
+    end
+
+    describe "#process" do
+      it "generally works" do
+        # Invalid input.
+        [
+          ["", ArgumentError, /\bempty\b/i],
+        ].each do |input, *raise_args|
+          expect {newo[input]}.to raise_error(*raise_args)
+        end
+
+        # Valid input.
+        [
+          ["abc", [["abc", ""]]],
+          ["  abc   def   ", [["abc", "def"]]],
+          ["alice@isp.com Alice Roberts;bob.smith@gmail.com Bob Smith", [["alice@isp.com", "Alice Roberts"], ["bob.smith@gmail.com", "Bob Smith"]]],
+          ["  alice@isp.com Alice Roberts  ; bob.smith@gmail.com  Bob Smith  ", [["alice@isp.com", "Alice Roberts"], ["bob.smith@gmail.com", "Bob Smith"]]],
+          ["alice@isp.com Alice  Roberts;,\n", [["alice@isp.com", "Alice  Roberts"]]],
+        ].each do |input, expected|
+          expect([input, newo[input]]).to eq [input, expected]
+        end
+      end
+    end
+  end
+end; end; end; end