neverbounce-cli 1.0.0

data/lib/never_bounce/cli/script/jobs_create/supplied_input_parser.rb

@@ -0,0 +1,48 @@
+
+require "never_bounce/cli/feature/basic_initialize"
+
+require_relative "../jobs_create"
+
+module NeverBounce; module CLI; module Script; class JobsCreate
+  # The parser for <tt>SUPPLIED_INPUT=</tt> environment variable.
+  # @see #process
+  # @see CLI::Feature::BasicInitialize
+  class SuppliedInputParser
+    CLI::Feature::BasicInitialize.load(self)
+
+    attr_writer :separator
+
+    # @return [Regexp]
+    def separator
+      @separator ||= /[;,\n]/
+    end
+
+    #---------------------------------------
+
+    # Process content, return parsed structure.
+    #
+    # NOTE: The parser doesn't validate e-mail addresses.
+    #
+    #   process("alice@isp.com Alice Roberts;bob.smith@gmail.com Bob Smith")
+    #   # => [["alice@isp.com", "Alice Roberts"], ["bob.smith@gmail.com", "Bob Smith"]]
+    #
+    # @return [Array<email, name>]
+    def process(content)
+      # NOTE: Keep it stage-procedural for easier debugging.
+      chunks = content.split(separator).map(&:strip).reject(&:empty?)
+
+      out = chunks.map do |chunk|
+        if (chunk =~ /^(.+?)\s+(.+)$/)
+          [$1, $2]
+        else
+          [chunk, ""]
+        end
+      end
+
+      out.empty? and raise ArgumentError, "Empty content"
+
+      out
+    end
+    alias_method :[], :process
+  end
+end; end; end; end

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

@@ -0,0 +1,157 @@
+
+require "neverbounce"
+
+require_relative "request_maker"
+
+module NeverBounce; module CLI; module Script
+  class JobsCreate < RequestMaker
+    require_relative "jobs_create/supplied_input_parser"
+
+    attr_writer :auto_parse, :auto_start, :filename, :input, :input_location, :now, :remote_input, :run_sample, :supplied_input, :supplied_input_array, :supplied_input_parser
+
+    envar "AUTO_PARSE", "Start parsing the job immediately after creation", ["y", "n"]
+    envar "FILENAME", "Original CSV filename", [{default: "YYYYMMDD-HHMMSS.csv"}, "My data.csv"]
+    envar "REMOTE_INPUT", "Remote URL with CSV of e-mails to verify", ["http://site.com/emails.csv"]
+    envar "SUPPLIED_INPUT", "List of e-mails to verify", ["alice@isp.com Alice Roberts;bob.smith@gmail.com Bob Smith"]
+    envar (k = "AUTO_START"), *SHARED_ENVARS[k]
+    envar (k = "RUN_SAMPLE"), *SHARED_ENVARS[k]
+
+    # @return [true]
+    # @return [false]
+    # @return [nil]
+    def auto_parse
+      igetset(:auto_parse) do
+        if env.has_key?(k = "AUTO_PARSE")
+          env_truthy?(k)
+        end
+      end
+    end
+
+    # @return [true]
+    # @return [false]
+    # @return [nil]
+    def auto_start
+      igetset(:auto_start) do
+        if env.has_key?(k = "AUTO_START")
+          env_truthy?(k)
+        end
+      end
+    end
+
+    def filename
+      igetset(:filename) { env["FILENAME"] || now.strftime("%Y%m%d-%H%M%S.csv") }
+    end
+
+    # @return [String] An URL if remote input.
+    # @return [Array] An array of e-mails if supplied input.
+    def input
+      input_location    # Touch for sanity/completeness checks etc.
+      remote_input || supplied_input_array
+    end
+
+    # @return [String] <tt>"remote_url"</tt> or <tt>"supplied"</tt>
+    def input_location
+      @input_location ||= begin
+        # Sanity check.
+        raise UsageError, "`REMOTE_INPUT` and `SUPPLIED_INPUT` can't both be given" if remote_input? && supplied_input?
+
+        if remote_input?
+          "remote_url"
+        elsif supplied_input?
+          "supplied"
+        else
+          raise UsageError, "Input not given, use `REMOTE_INPUT=` or `SUPPLIED_INPUT=`"
+        end
+      end
+    end
+
+    def now
+      @now ||= Time.now
+    end
+
+    def remote_input
+      igetset(:remote_input) { env["REMOTE_INPUT"] }
+    end
+
+    def remote_input?
+      !!remote_input
+    end
+
+    # @return [true]
+    # @return [false]
+    # @return [nil]
+    def run_sample
+      igetset(:run_sample) do
+        if env.has_key?(k = "RUN_SAMPLE")
+          env_truthy?(k)
+        end
+      end
+    end
+
+    def supplied_input
+      igetset(:supplied_input) { env["SUPPLIED_INPUT"] }
+    end
+
+    def supplied_input?
+      !!supplied_input
+    end
+
+    def supplied_input_array
+      @supplied_input_array ||= require_attr(:supplied_input_parser)[require_attr(:supplied_input)]
+    end
+
+    def supplied_input_parser
+      @supplied_input_parser ||= SuppliedInputParser.new
+    end
+
+    # An <tt>API::Request::JobsCreate</tt>.
+    # @!attribute request
+    # @return [Object]
+    def request
+      @request ||= API::Request::JobsCreate.new({
+        api_key: api_key,
+        auto_parse: auto_parse,
+        auto_start: auto_start,
+        filename: filename,
+        input: input,
+        input_location: input_location,
+        run_sample: run_sample,
+      })
+    end
+
+    #--------------------------------------- Manifest
+
+    # @!attribute manifest
+    # @return [Manifest]
+    def manifest
+      @manifest ||= Manifest.new(
+        name: "nb-jobs-create",
+        function: "Create a job",
+        cmdline: "[options] [VAR1=value] [VAR2=value] ...",
+      )
+    end
+
+    #--------------------------------------- Main
+
+    # @return [Integer]
+    def slim_main
+      "Response".tap do |label|
+        headings = [
+          ["JobId", :job_id],
+
+          ["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/script/jobs_delete.rb

@@ -0,0 +1,55 @@
+
+require "neverbounce"
+
+require "never_bounce/cli/script/feature/requires_job_id"
+
+require_relative "request_maker"
+
+module NeverBounce; module CLI; module Script
+  class JobsDelete < RequestMaker
+    Script::Feature::RequiresJobId.load(self)
+
+    # An <tt>API::Request::JobsDelete</tt>.
+    # @!attribute request
+    # @return [Object]
+    def request
+      @request ||= API::Request::JobsDelete.new({
+        api_key: api_key,
+        job_id: job_id,
+      })
+    end
+
+    #--------------------------------------- Manifest
+
+    # @!attribute manifest
+    # @return [Manifest]
+    def manifest
+      @manifest ||= Manifest.new(
+        name: "nb-jobs-delete",
+        function: "Delete a job",
+        cmdline: "[options] [VAR1=value] [VAR2=value] ...",
+      )
+    end
+
+    #--------------------------------------- Main
+
+    # @return [Integer]
+    def slim_main
+      "Response".tap do |label|
+        headings = [
+          ["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/script/jobs_download.rb

@@ -0,0 +1,44 @@
+
+require "neverbounce"
+
+require "never_bounce/cli/script/feature/requires_job_id"
+
+require_relative "request_maker"
+
+module NeverBounce; module CLI; module Script
+  class JobsDownload < RequestMaker
+    Script::Feature::RequiresJobId.load(self)
+
+    # An <tt>API::Request::JobsDownload</tt>.
+    # @!attribute request
+    # @return [Object]
+    def request
+      @request ||= API::Request::JobsDownload.new({
+        api_key: api_key,
+        job_id: job_id,
+      })
+    end
+
+    #--------------------------------------- Manifest
+
+    # @!attribute manifest
+    # @return [Manifest]
+    def manifest
+      @manifest ||= Manifest.new(
+        name: "nb-jobs-download",
+        function: "Download job results as CSV",
+        cmdline: "[options] [VAR1=value] [VAR2=value] ...",
+      )
+    end
+
+    #--------------------------------------- Main
+
+    # @return [Integer]
+    def slim_main
+      # Print CSV as is.
+      stdout.puts server_raw
+
+      0
+    end
+  end
+end; end; end

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

@@ -0,0 +1,73 @@
+
+require "neverbounce"
+
+require "never_bounce/cli/script/feature/requires_job_id"
+
+require_relative "request_maker"
+
+module NeverBounce; module CLI; module Script
+  class JobsParse < RequestMaker
+    Script::Feature::RequiresJobId.load(self)
+
+    attr_writer :auto_start
+
+    envar (k = "AUTO_START"), *SHARED_ENVARS[k]
+
+    # @return [true]
+    # @return [false]
+    # @return [nil]
+    def auto_start
+      igetset(:auto_start) do
+        if env.has_key?(k = "AUTO_START")
+          env_truthy?(k)
+        end
+      end
+    end
+
+    # An <tt>API::Request::JobsParse</tt>.
+    # @!attribute request
+    # @return [Object]
+    def request
+      @request ||= API::Request::JobsParse.new({
+        api_key: api_key,
+        auto_start: auto_start,
+        job_id: job_id,
+      })
+    end
+
+    #--------------------------------------- Manifest
+
+    # @!attribute manifest
+    # @return [Manifest]
+    def manifest
+      @manifest ||= Manifest.new(
+        name: "nb-jobs-parse",
+        function: "Issue a job parse command to the server",
+        cmdline: "[options] [VAR1=value] [VAR2=value] ...",
+      )
+    end
+
+    #--------------------------------------- Main
+
+    # @return [Integer]
+    def slim_main
+      "Response".tap do |label|
+        headings = [
+          ["QueueId", :queue_id],
+
+          ["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/script/jobs_results.rb

@@ -0,0 +1,105 @@
+
+require "neverbounce"
+
+require "never_bounce/cli/script/feature/requires_job_id"
+require "never_bounce/cli/script/feature/uses_pagination"
+
+require_relative "request_maker"
+
+module NeverBounce; module CLI; module Script
+  class JobsResults < RequestMaker
+    Script::Feature::RequiresJobId.load(self)
+    Script::Feature::UsesPagination.load(self)
+
+    # An <tt>API::Request::JobsResults</tt>.
+    # @!attribute request
+    # @return [Object]
+    def request
+      @request ||= API::Request::JobsResults.new({
+        api_key: api_key,
+        job_id: job_id,
+        page: page,
+        per_page: per_page,
+      })
+    end
+
+    #--------------------------------------- Manifest
+
+    # @!attribute manifest
+    # @return [Manifest]
+    def manifest
+      @manifest ||= Manifest.new(
+        name: "nb-jobs-results",
+        function: "Get job execution results",
+        cmdline: "[options] [VAR1=value] [VAR2=value] ...",
+      )
+    end
+
+    #--------------------------------------- Main
+
+    # @return [Integer]
+    def slim_main
+      "Response".tap do |label|
+        headings = [
+          ["nPages", :total_pages, :right],
+          ["nResults", :total_results, :right],
+
+          ["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
+
+      "Query".tap do |label|
+        headings = [
+          ["JobId", :job_id, :right],
+          ["Page", :page, :right],
+          ["PerPage", :items_per_page, :right],
+        ]
+
+        table = Table.new(
+          headings: headings.map { |ar| ar[0] },
+          rows: [headings.map { |ar| get_table_value(response.query, ar) }],
+        ).align!(headings)
+
+        stdout.puts "\n#{label}:"
+        stdout.puts table
+      end
+
+      "Results".tap do |label|
+        headings = [
+          ["Email", :email],
+          ["Result", :result, :center],
+
+          [
+            "Flags",
+            ->(r) { r.flags.sort.join("\n") },
+          ],
+
+          ["SuggCorr", :suggested_correction],
+        ]
+
+        table = Table.new(
+          headings: headings.map { |ar| ar[0] },
+          rows: response.items.map do |r|
+            headings.map do |ar|
+              get_table_value(r, ar)
+            end
+          end,
+        ).align!(headings)
+
+        stdout.puts "\n#{label}:"
+        stdout.puts table
+      end
+
+
+      0
+    end
+  end
+end; end; end