usps-imis-api 0.2.0 → 0.3.0

data/lib/usps/imis.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Core dependencies
+require 'net/https'
+require 'json'
+require 'time'
+require 'cgi'
+
+# Extensions
+require 'ext/hash' unless defined?(Rails)
+
+# Internal requires
+require_relative 'imis/config'
+require_relative 'imis/error/api'
+require_relative 'imis/error/mapper'
+require_relative 'imis/api'
+require_relative 'imis/mapper'
+require_relative 'imis/panel/vsc'
+
+module Usps
+  module Imis
+    class << self
+      def configuration
+        @configuration ||= Config.new
+      end
+
+      def configure
+        yield(configuration) if block_given?
+        configuration
+      end
+
+      # def mock!(value = true)
+      #   @mock = value
+      # end
+
+      # def mock
+      #   @mock || false
+      # end
+    end
+  end
+end

data/spec/lib/{imis → usps/imis}/api_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Imis::Api do
+describe Usps::Imis::Api do
   let(:api) { described_class.new }
 
   describe '#imis_id_for' do
@@ -29,5 +29,9 @@ describe Imis::Api do
     it 'sends an update from update' do
       expect(api.with(31092) { update(mm: 15) }.first).to be_a(Hash)
     end
+
+    it 'uses a panel correctly' do
+      expect(api.with(6374) { panels.vsc.get(1433) }).to be_a(Hash)
+    end
   end
 end

data/spec/lib/{imis → usps/imis}/mapper_spec.rb

@@ -2,8 +2,8 @@
 
 require 'spec_helper'
 
-describe Imis::Mapper do
-  let(:api) { Imis::Api.new }
+describe Usps::Imis::Mapper do
+  let(:api) { described_class.new.api }
 
   describe '#update' do
     before { api.imis_id = 31092 }
@@ -14,7 +14,7 @@ describe Imis::Mapper do
 
     it 'raises for unmapped updates' do
       expect { api.mapper.update(something: 'anything') }.to raise_error(
-        Imis::Error::Mapper,
+        Usps::Imis::Error::Mapper,
         'Unrecognized field: "something". ' \
         'Please report what data you are attempting to work with to ITCom leadership.'
       )

data/spec/lib/{imis → usps/imis}/panel/vsc_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Imis::Panel::Vsc do
+describe Usps::Imis::Panel::Vsc do
   let(:vsc) { described_class.new }
 
   let(:details) do

data/spec/spec_helper.rb

@@ -9,13 +9,25 @@ end
 # SimpleCov.minimum_coverage(100)
 
 require 'dotenv/load'
-require 'usps-imis-api'
+require 'usps/imis'
 
 ENV['TESTING'] = 'true'
 
 RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = 'tmp/.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expose_dsl_globally = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
   config.before(:suite) do
-    Imis.configure do |imis_config|
+    Usps::Imis.configure do |imis_config|
       imis_config.environment = :development
       imis_config.imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', '')
 

data/usps-imis-api.gemspec

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'lib/usps/imis/version'
+
 Gem::Specification.new do |s|
   s.name          = 'usps-imis-api'
-  s.version       = '0.2.0'
+  s.version       = Usps::Imis::VERSION
   s.summary       = 'iMIS API Wrapper'
   s.description   = 'A wrapper for the iMIS API.'
   s.homepage      = 'http://rubygems.org/gems/usps-imis-api'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Julian Fiander
@@ -23,18 +23,22 @@ files:
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- Rakefile
 - Readme.md
+- bin/console
+- bin/setup
 - lib/ext/hash.rb
-- lib/imis/api.rb
-- lib/imis/config.rb
-- lib/imis/error/api.rb
-- lib/imis/error/mapper.rb
-- lib/imis/mapper.rb
-- lib/imis/panel/vsc.rb
-- lib/usps-imis-api.rb
-- spec/lib/imis/api_spec.rb
-- spec/lib/imis/mapper_spec.rb
-- spec/lib/imis/panel/vsc_spec.rb
+- lib/usps/imis.rb
+- lib/usps/imis/api.rb
+- lib/usps/imis/config.rb
+- lib/usps/imis/error/api.rb
+- lib/usps/imis/error/mapper.rb
+- lib/usps/imis/mapper.rb
+- lib/usps/imis/panel/vsc.rb
+- lib/usps/imis/version.rb
+- spec/lib/usps/imis/api_spec.rb
+- spec/lib/usps/imis/mapper_spec.rb
+- spec/lib/usps/imis/panel/vsc_spec.rb
 - spec/spec_helper.rb
 - usps-imis-api.gemspec
 homepage: http://rubygems.org/gems/usps-imis-api

data/lib/imis/api.rb

@@ -1,192 +0,0 @@
-# frozen_string_literal: true
-
-module Imis
-  class Api
-    AUTHENTICATION_PATH = 'Token'
-    API_PATH = 'api'
-    QUERY_PATH = 'api/Query'
-
-    attr_reader :token, :token_expiration, :imis_id
-
-    def initialize(skip_authentication: false)
-      authenticate unless skip_authentication
-    end
-
-    # Manually set the current ID, if you already have it for a given member
-    #
-    def imis_id=(id)
-      @imis_id = id.to_s
-    end
-
-    # Convert a member's certificate number into an iMIS ID number
-    #
-    def imis_id_for(certificate)
-      result = query(Imis.configuration.imis_id_query_name, { certificate: certificate })
-      @imis_id = result['Items']['$values'][0]['ID']
-    end
-
-    # Run requests as DSL, with specific iMIS ID only maintained for this scope
-    #
-    # This should be used with methods that do not change the value of `imis_id`
-    #
-    def with(id, &block)
-      old_id = imis_id
-      self.imis_id = id
-      instance_eval(&block)
-    ensure
-      self.imis_id = old_id
-    end
-
-    # Get a business object for the current member
-    #
-    def get(business_object_name, url_id: nil)
-      uri = uri_for(business_object_name, url_id: url_id)
-      request = Net::HTTP::Get.new(uri)
-      result = submit(uri, authorize(request))
-      JSON.parse(result.body)
-    end
-
-    # Update only specific fields on a business object for the current member
-    #
-    #   fields - hash of shape: { field_name => new_value }
-    #
-    def put_fields(business_object_name, fields, url_id: nil)
-      updated = filter_fields(business_object_name, fields)
-      put(business_object_name, updated, url_id: url_id)
-    end
-
-    # Update a business object for the current member
-    #
-    def put(business_object_name, body, url_id: nil)
-      uri = uri_for(business_object_name, url_id: url_id)
-      request = Net::HTTP::Put.new(uri)
-      request.body = JSON.dump(body)
-      result = submit(uri, authorize(request))
-      JSON.parse(result.body)
-    end
-
-    # Create a business object for the current member
-    #
-    def post(business_object_name, body, url_id: nil)
-      uri = uri_for(business_object_name, url_id: url_id)
-      request = Net::HTTP::Post.new(uri)
-      request.body = JSON.dump(body)
-      result = submit(uri, authorize(request))
-      JSON.parse(result.body)
-    end
-
-    # Remove a business object for the current member
-    #
-    # Returns empty string on success
-    #
-    def delete(business_object_name, url_id: nil)
-      uri = uri_for(business_object_name, url_id: url_id)
-      request = Net::HTTP::Delete.new(uri)
-      result = submit(uri, authorize(request))
-      result.body
-    end
-
-    # Run an IQA Query
-    #
-    #   query_name   - the full path of the query in IQA, e.g. `$/_ABC/Fiander/iMIS_ID`
-    #   query_params - hash of shape: { param_name => param_value }
-    #
-    def query(query_name, query_params = {})
-      query_params[:QueryName] = query_name
-      path = "#{QUERY_PATH}?#{query_params.to_query}"
-      uri = URI(File.join(imis_hostname, path))
-      request = Net::HTTP::Get.new(uri)
-      result = submit(uri, authorize(request))
-      JSON.parse(result.body)
-    end
-
-    def mapper
-      @mapper ||= Mapper.new(self)
-    end
-
-    def update(data)
-      mapper.update(data)
-    end
-
-  private
-
-    def client(uri)
-      Net::HTTP.new(uri.host, uri.port).tap do |http|
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      end
-    end
-
-    def imis_hostname
-      Imis.configuration.hostname
-    end
-
-    # Authorize a request prior to submitting
-    #
-    # If the current token is missing/expired, request a new one
-    #
-    def authorize(request)
-      authenticate if token_expiration < Time.now
-      request.tap { |r| r.add_field('Authorization', "Bearer #{token}") }
-    end
-
-    # Construct a business object API endpoint address
-    #
-    def uri_for(business_object_name, url_id: nil)
-      url_id ||= imis_id
-      url_id = CGI.escape(url_id)
-      URI(File.join(imis_hostname, "#{API_PATH}/#{business_object_name}/#{url_id}"))
-    end
-
-    def submit(uri, request)
-      client(uri).request(request).tap do |result|
-        raise Error::Api.from(result) unless result.is_a?(Net::HTTPSuccess)
-      end
-    end
-
-    # Authenticate to the iMIS API, and store the access token and expiration time
-    #
-    def authenticate
-      uri = URI(File.join(imis_hostname, AUTHENTICATION_PATH))
-      req = Net::HTTP::Post.new(uri)
-      authentication_data = {
-        grant_type: 'password',
-        username: Imis.configuration.username,
-        password: Imis.configuration.password
-      }
-      req.body = URI.encode_www_form(authentication_data)
-      result = submit(uri, req)
-      json = JSON.parse(result.body)
-
-      @token = json['access_token']
-      @token_expiration = Time.parse(json['.expires'])
-    end
-
-    # Manually assemble the matching data structure, with fields in the correct order
-    #
-    def filter_fields(business_object_name, fields)
-      existing = get(business_object_name)
-
-      JSON.parse(JSON.dump(existing)).tap do |updated|
-        # The first property is always the iMIS ID again
-        updated['Properties']['$values'] = [existing['Properties']['$values'][0]]
-
-        # Iterate through all existing fields
-        existing['Properties']['$values'].each do |value|
-          next unless fields.keys.include?(value['Name'])
-
-          # Strings are not wrapped in the type definition structure
-          new_value = fields[value['Name']]
-          if new_value.is_a?(String)
-            value['Value'] = new_value
-          else
-            value['Value']['$value'] = new_value
-          end
-
-          # Add the completed field with the updated value
-          updated['Properties']['$values'] << value
-        end
-      end
-    end
-  end
-end

data/lib/imis/config.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Imis
-  class Config
-    IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
-    IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
-
-    attr_accessor :environment, :imis_id_query_name, :username, :password
-
-    def initialize
-      yield self if block_given?
-    end
-
-    def hostname
-      case environment.to_sym
-      when :production
-        IMIS_ROOT_URL_PROD
-      when :development
-        IMIS_ROOT_URL_DEV
-      else
-        raise "Unexpected API environment: #{environment}"
-      end
-    end
-  end
-end

data/lib/imis/error/api.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module Imis
-  module Error
-    class Api < StandardError
-      attr_reader :response
-      attr_accessor :metadata
-
-      def self.from(response)
-        new('The iMIS API returned an error.', response)
-      end
-
-      def initialize(message, response, metadata = {})
-        super(message)
-        @metadata = metadata
-        @response = response
-      end
-
-      def bugsnag_meta_data
-        { api: { status: status, body: body }.merge!(metadata) }
-      end
-
-    private
-
-      def status
-        @status ||=
-          case response.code
-          when '400'
-            :bad_request
-          when '401'
-            :unauthorized # RequestVerificationToken invalid
-          when '404'
-            :not_found
-          when '422'
-            :unprocessable_entity # validation error
-          when /^50\d$/
-            :internal_server_error # error within iMIS
-          end
-      end
-
-      def response_body
-        @response_body ||= JSON.parse(response.body)
-      rescue StandardError
-        @response_body ||= response.body
-      end
-
-      def body
-        return response_body unless response_body.is_a?(Hash)
-
-        case response_body['error']
-        when 'invalid_grant'
-          response_body['error_description']
-        else
-          # Unknown error type: just use the raw response
-          response.body
-        end
-      end
-    end
-  end
-end

data/lib/imis/error/mapper.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Imis
-  module Error
-    class Mapper < StandardError; end
-  end
-end

data/lib/imis/mapper.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Imis
-  class Mapper
-    FIELD_MAPPING = {
-      vessel_examiner: %w[ABC_ASC_Individual_Demog Vol_Vessel_Examiner],
-      mm: %w[ABC_ASC_Individual_Demog TotMMS],
-      mm_updated: %w[ABC_ASC_Individual_Demog MMS_Updated]
-    }.freeze
-
-    attr_reader :api
-
-    def initialize(api = nil)
-      @api = api || Api.new
-    end
-
-    # Update a member's data on multiple affected business objects by arbitrary field names
-    # Does not require knowing which business object / iMIS-specific field name to use
-    #
-    # Only available for previously-mapped fields
-    #
-    #  `data` is a hash of shape { field_key => value }
-    #
-    def update(data)
-      updates = data.each_with_object({}) do |(field_key, value), hash|
-        map_update(field_key) do |business_object_name, field|
-          hash[business_object_name] ||= {}
-          hash[business_object_name][field] = value
-        end
-      end
-
-      updates.map do |business_object_name, field_updates|
-        api.put_fields(business_object_name, field_updates)
-      end
-    end
-
-  private
-
-    def map_update(field_name)
-      if FIELD_MAPPING.key?(field_name.to_sym)
-        business_object_name, field = FIELD_MAPPING[field_name.to_sym]
-        yield(business_object_name, field)
-      else
-        missing_mapping(field_name)
-      end
-    end
-
-    def missing_mapping(field_name)
-      unless ENV['TESTING']
-        warn(
-          "Mapper does not know how to handle field \"#{field_name}\".\n\n" \
-          'You can use api.put_fields(business_object_name, { field_name => value })  ' \
-          "if you know the business object and iMIS-specific field name.\n\n"
-        )
-      end
-
-      raise(
-        Imis::Error::Mapper,
-        "Unrecognized field: \"#{field_name}\". " \
-        'Please report what data you are attempting to work with to ITCom leadership.'
-      )
-    end
-  end
-end

data/lib/imis/panel/vsc.rb

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-module Imis
-  module Panel
-    class Vsc
-      BUSINESS_OBJECT = 'ABC_ASC_Vessel_Safety_Checks'
-
-      attr_reader :api
-
-      def initialize(api = nil)
-        @api = api || Api.new
-      end
-
-      def get(ordinal)
-        api.get(BUSINESS_OBJECT, url_id: "~#{api.imis_id}|#{ordinal}")
-      end
-
-      def create(data)
-        api.post(BUSINESS_OBJECT, payload(data), url_id: '')
-      end
-
-      def update(data)
-        api.put(BUSINESS_OBJECT, payload(data), url_id: "~#{api.imis_id}|#{data[:ordinal]}")
-      end
-
-      def destroy(ordinal)
-        api.delete(BUSINESS_OBJECT, url_id: "~#{api.imis_id}|#{ordinal}")
-      end
-
-    private
-
-      # rubocop:disable Metrics/MethodLength
-      def payload(data)
-        {
-          '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
-          'EntityTypeName' => 'ABC_ASC_Vessel_Safety_Checks',
-          'PrimaryParentEntityTypeName' => 'Party',
-          'Identity' => {
-            '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-            'EntityTypeName' => 'ABC_ASC_Vessel_Safety_Checks',
-            'IdentityElements' => {
-              '$type' =>
-                'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib',
-              '$values' => [api.imis_id]
-            }
-          },
-          'PrimaryParentIdentity' => {
-            '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-            'EntityTypeName' => 'Party',
-            'IdentityElements' => {
-              '$type' =>
-                'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib',
-              '$values' => [api.imis_id]
-            }
-          },
-          'Properties' => {
-            '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
-            '$values' => [
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'ID',
-                'Value' => api.imis_id
-              },
-              (
-                if data[:ordinal]
-                  {
-                    '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                    'Name' => 'Ordinal',
-                    'Value' => {
-                      '$type' => 'System.Int32',
-                      '$value' => data[:ordinal]
-                    }
-                  }
-                end
-              ),
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'Source_System',
-                'Value' => 'Manual ITCom Entry'
-              },
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'ABC_ECertificate',
-                'Value' => data[:certificate]
-              },
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'Activity_Type',
-                'Value' => 'VSC'
-              },
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'Description',
-                'Value' => 'Vessel Safety Checks'
-              },
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'Effective_Date',
-                'Value' => "#{data[:year]}-12-01T00:00:00"
-              },
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'Quantity',
-                'Value' => {
-                  '$type' => 'System.Int32',
-                  '$value' => data[:count]
-                }
-              },
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'Thru_Date',
-                'Value' => "#{data[:year]}-12-31T00:00:00"
-              },
-              {
-                '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-                'Name' => 'Transaction_Date',
-                'Value' => Time.now.strftime('%Y-%m-%dT%H:%M:%S')
-              }
-            ].compact
-          }
-        }
-      end
-      # rubocop:enable Metrics/MethodLength
-    end
-  end
-end

data/lib/usps-imis-api.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-# Core dependencies
-require 'net/https'
-require 'json'
-require 'time'
-require 'cgi'
-
-# Extensions
-require 'ext/hash' unless defined?(Rails)
-
-# Internal requires
-require 'imis/config'
-require 'imis/error/api'
-require 'imis/error/mapper'
-require 'imis/api'
-require 'imis/mapper'
-require 'imis/panel/vsc'
-
-module Imis
-  class << self
-    def configuration
-      @configuration ||= Imis::Config.new
-    end
-
-    def configure
-      yield(configuration) if block_given?
-      configuration
-    end
-
-    # def mock!(value = true)
-    #   @mock = value
-    # end
-
-    # def mock
-    #   @mock || false
-    # end
-  end
-end