usps-imis-api 0.10.4 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b058c2109e980f6706a58b10847ec6d68c943b44c6de7d5c6dbf44d00b5095e9
-  data.tar.gz: 4b49c8c39e215e09add71b36d68e86a3a3b6b6f10f999010c9d858787feaa1cc
+  metadata.gz: 6a938a3621c6e575ac4d205495bbdccf39b4579a986a4431730d366bee510824
+  data.tar.gz: 7cfbacbf135e1f9899510fc54ff05aa079bf70f24b1c93b81de0bcd78fc26218
 SHA512:
-  metadata.gz: e646b741b55e2f25395004da9ca74c3bed8a44d7a645e8a0434ec74d38315f0d9e91bbfd17c53111069627ef0ff946eb5f0075df35d375e69cc9ebdc3edfcc7e
-  data.tar.gz: 42650930b35cdef5a05bc361796d2665ff16ca50a005a268551220d2ba6dd2983d451dfa3dd3ebb00886229224078a6ba44eeabf27aad03e5a32d52e4e8ea417
+  metadata.gz: 679178e131a5fa45915738be179b82173fa8383c0109ba6fe5e2d73b9f85c1ecdb6bc160e94ed385866371ed10e465de17a05409b55de64e015f8d44d4b12c0a
+  data.tar.gz: 66466bcfca8c602e00a04a3f52599cf96f0bae5d64065542e615bbb8acb9cab27fd5b44552e9367ecdb8ef3004ac9a40e3417a5ec8bc6a46b8ffb04cff7aed96

data/lib/usps/imis/command_line/interface.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module CommandLine
+      # Command line interface for the Api
+      #
+      class Interface
+        NAME = 'USPS iMIS API - Ruby'
+
+        attr_reader :options
+
+        def self.run(...) = new(...).run
+
+        def initialize(**)
+          @options = input_options.merge(**)
+          validate_options!
+          configure! if options[:config]
+          logging!
+        end
+
+        def run
+          set_member
+
+          result = simplify(perform!)
+
+          output { result }
+
+          result
+        end
+
+      private
+
+        # :nocov:
+        def input_options
+          if ENV.fetch('CI', false)
+            defaults = {
+              raw: false,
+              quiet: false,
+              log: false,
+              log_level: 'info',
+              version: false,
+              help: false
+            }
+            return defaults
+          end
+
+          OptionsParser.new.options
+        end
+        # :nocov:
+
+        def api
+          @api ||= Usps::Imis::Api.new
+        end
+
+        def set_member
+          case options
+          in certificate: then api.imis_id_for(certificate)
+          in id: then api.imis_id = id
+          else
+            # Query
+          end
+        end
+
+        # rubocop:disable Metrics
+        def perform!
+          case options
+          in map:, data: then api.mapper[map.to_sym] = data
+          in map: then api.mapper[map.to_sym]
+
+          in on:, delete: true then api.on(on).delete
+          in on:, data:, post: true then api.on(on).post(data)
+          in on:, data:, field: then api.on(on).put_field(field, data)
+          in on:, data: then api.on(on).put_fields(data)
+          in on:, fields: then api.on(on).get_fields(*fields)
+          in on:, field: then api.on(on).get_field(field)
+          in on: then api.on(on).get
+
+          in panel:, ordinal:, delete: true then api.panels.public_send(panel).delete(ordinal)
+          in panel:, data:, post: true then api.panels.public_send(panel).post(data)
+          in panel:, ordinal:, data:, field: then api.panels.public_send(panel).put_field(ordinal, field, data)
+          in panel:, ordinal:, data: then api.panels.public_send(panel).put_fields(ordinal, data)
+          in panel:, ordinal:, fields: then api.panels.public_send(panel).get_fields(ordinal, *fields)
+          in panel:, ordinal:, field: then api.panels.public_send(panel).get_field(ordinal, field)
+          in panel:, ordinal: then api.panels.public_send(panel).get(ordinal)
+
+          in query:, data: then api.query(query, data)
+          in query: then api.query(query)
+          end
+        rescue NoMatchingPatternError => e
+          raise Errors::CommandLineError, "Unable to match pattern from options: #{e.message}"
+        end
+        # rubocop:enable Metrics
+
+        def simplify(data)
+          return data.to_a if data.is_a?(Query)
+          return data if options[:raw]
+          return data unless data.is_a?(Hash) # Includes Usps::Imis::Data
+
+          data.properties(include_ids: options[:include_ids])
+        end
+
+        # :nocov:
+        def output(&block)
+          return if ENV.fetch('SUPPRESS_OUTPUT', false)
+
+          puts JSON.dump(block.call) if block_given?
+        end
+        # :nocov:
+
+        def configure!
+          json_config = JSON.parse(File.read(options[:config]))
+
+          Usps::Imis.configure do |config|
+            json_config.each do |key, value|
+              config.public_send("#{key}=", value)
+            end
+          end
+        end
+
+        def logging!
+          Usps::Imis.configure do |config|
+            # :nocov:
+            if options[:quiet] || ENV.fetch('SUPPRESS_OUTPUT', false)
+              config.logger = ActiveSupport::TaggedLogging.new(Logger.new(nil))
+            elsif options[:log]
+              # Use default
+            else
+              config.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr))
+            end
+            # :nocov:
+
+            config.logger.level = options[:log_level]
+          end
+        end
+
+        def validate_options!
+          if options[:log_level] == 'info' && options.except(:log_level, :quiet).values.none?
+            raise Errors::CommandLineError, 'No options provided'
+          end
+
+          return if options[:query].nil? || options[:query].start_with?('$/')
+
+          raise Errors::CommandLineError, 'Invalid IQA Query name'
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/command_line/options_parser.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module CommandLine
+      # Command line options parser
+      #
+      class OptionsParser
+        OPTIONS = {
+          certificate: ['Member certificate number', { type: :string }],
+          id: ['Member iMIS ID', { type: :integer }],
+          on: ['Business Object name', { type: :string }],
+          panel: ['Panel name', { type: :string }],
+          ordinal: ['Ordinal ID within a Panel', { type: :integer }],
+          query: ['IQA Query name', { type: :string, short: :Q }],
+          post: ["Send a #{'POST'.cyan} request", { short: :P }],
+          delete: ["Send a #{'DELETE'.cyan} request", { short: :D }],
+          field: ['Specific field to return or update', { type: :string }],
+          fields: ['Specific field(s) to return', { type: :strings, short: :F }],
+          map: ['Mapped field name to return or update', { type: :string }],
+          data: ['JSON string input', { type: :string }],
+          config: ['Path to the JSON config file to use', { type: :string, short: :C }],
+          raw: ['Return raw JSON output, rather than simplified data', { short: :R }],
+          include_ids: ['Include ID properties in returned data'],
+          quiet: ['Suppress logging to STDERR'],
+          log: ['Redirect logging to STDOUT'],
+          log_level: ['Set the logging level', { type: :string, default: 'info', short: :L }]
+        }.freeze
+
+        CONFLICTING_OPTION_GROUPS = [
+          %i[certificate id],
+          %i[on panel query map],
+          %i[field fields map query]
+        ].freeze
+
+        attr_reader :arguments, :options
+
+        def self.banner_contents
+          <<~BANNER
+            Usage:
+              imis.rb #{'[options]'.gray}
+
+              The default HTTP verb is #{'GET'.cyan}.
+              If #{'--data'.green}/#{'-d'.green} is provided, the default HTTP verb is #{'PUT'.cyan}.
+
+              #{'--data'.green}/#{'-d'.green} is used to provide field(s) data for #{'PUT'.cyan}
+              requests and mapper updates, object data for #{'POST'.cyan},
+              and to provide any query params.
+
+              Configuration can be specified with #{'--config'.green}/#{'-C'.green}, or by setting
+              the following environment variables:
+                #{'IMIS_ENVIRONMENT'.yellow}
+                #{'IMIS_USERNAME'.yellow}
+                #{'IMIS_PASSWORD'.yellow}
+                #{'IMIS_ID_QUERY_NAME'.yellow}
+
+            Options:
+          BANNER
+        end
+
+        def initialize
+          @options = parse_options.compact
+          @arguments = ARGV # Not currently used
+
+          # :nocov:
+          @options[:data] = JSON.parse(read_stdin) if stdin?
+          # :nocov:
+        end
+
+      private
+
+        def parse_options
+          Optimist.options do
+            version "#{Interface::NAME} (v#{Usps::Imis::VERSION})"
+
+            banner "#{version.bold.blue}\n \n"
+            banner OptionsParser.banner_contents
+
+            OPTIONS.each { |option, data| opt(option, *data) }
+            CONFLICTING_OPTION_GROUPS.each { |group| conflicts(*group) }
+
+            educate_on_error
+          end
+        end
+
+        # :nocov:
+        def stdin? = $stdin.wait_readable(0)
+        def read_stdin = $stdin.read.chomp
+        # :nocov:
+      end
+    end
+  end
+end

data/lib/usps/imis/command_line.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'optimist'
+require 'colorize'
+
+module Usps
+  module Imis
+    # Wrapper for the command line interface
+    #
+    module CommandLine; end
+  end
+end
+
+require_relative 'command_line/options_parser'
+require_relative 'command_line/interface'

data/lib/usps/imis/config.rb

@@ -12,7 +12,7 @@ module Usps
       attr_reader :environment, :logger, :logger_level
 
       def initialize
-        @environment = defined?(::Rails) ? ::Rails.env : ActiveSupport::StringInquirer.new('development')
+        @environment = default_environment
         @imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', nil)
         @username = ENV.fetch('IMIS_USERNAME', nil)
         @password = ENV.fetch('IMIS_PASSWORD', nil)
@@ -53,6 +53,14 @@ module Usps
       # Parameters to filter out of logging
       #
       def filtered_parameters = %i[password]
+
+    private
+
+      def default_environment
+        return ::Rails.env if defined?(::Rails)
+
+        ActiveSupport::StringInquirer.new(ENV.fetch('IMIS_ENVIRONMENT', 'development'))
+      end
     end
   end
 end

data/lib/usps/imis/data.rb

@@ -36,7 +36,7 @@ module Usps
         return if property.nil?
 
         value = property['Value']
-        value.is_a?(String) ? value : value['$value']
+        value.nil? || value.is_a?(String) ? value : value['$value']
       end
 
       # Hash of all property names to values

data/lib/usps/imis/error.rb

@@ -52,3 +52,4 @@ require_relative 'errors/not_found_error'
 require_relative 'errors/response_error'
 require_relative 'errors/panel_unimplemented_error'
 require_relative 'errors/unexpected_property_type_error'
+require_relative 'errors/command_line_error'

data/lib/usps/imis/errors/command_line_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Errors
+      # Exception raised by the command line interface
+      #
+      class CommandLineError < Error; end
+    end
+  end
+end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.10.4'
+    VERSION = '0.11.0'
   end
 end

data/lib/usps/imis.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # Core dependencies
@@ -20,6 +21,7 @@ require_relative 'imis/error'
 require_relative 'imis/api'
 require_relative 'imis/properties'
 require_relative 'imis/panels'
+require_relative 'imis/command_line'
 require_relative 'imis/mocks'
 require_relative 'imis/version'
 
@@ -56,3 +58,9 @@ module Usps
     end
   end
 end
+
+# Invoke CLI, only if invoked from the command line
+#
+# :nocov:
+Usps::Imis::CommandLine::Interface.run if __FILE__ == $PROGRAM_NAME
+# :nocov:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.11.0
 platform: ruby
 authors:
 - Julian Fiander
@@ -23,6 +23,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 description: A wrapper for the iMIS API.
 email: jsfiander@gmail.com
 executables: []
@@ -33,10 +61,14 @@ files:
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
 - lib/usps/imis/business_object.rb
+- lib/usps/imis/command_line.rb
+- lib/usps/imis/command_line/interface.rb
+- lib/usps/imis/command_line/options_parser.rb
 - lib/usps/imis/config.rb
 - lib/usps/imis/data.rb
 - lib/usps/imis/error.rb
 - lib/usps/imis/errors/api_error.rb
+- lib/usps/imis/errors/command_line_error.rb
 - lib/usps/imis/errors/config_error.rb
 - lib/usps/imis/errors/locked_id_error.rb
 - lib/usps/imis/errors/mapper_error.rb