usps-imis-api 1.0.0.pre.rc.8 → 1.0.0.pre.rc.10

data/lib/usps/imis/query.rb

@@ -2,7 +2,7 @@
 
 module Usps
   module Imis
-    # API wrapper for IQA Queries
+    # API wrapper for IQA and Business Object Queries
     #
     class Query
       include Enumerable
@@ -10,7 +10,7 @@ module Usps
 
       # Endpoint for IQA query requests
       #
-      QUERY_PATH = 'api/Query'
+      IQA_PATH = 'api/Query'
 
       # The parent +Api+ object
       #
@@ -24,26 +24,46 @@ module Usps
       #
       attr_reader :query_params
 
+      # Current page size for paging through the Query
+      #
+      attr_accessor :page_size
+
       # Current offset for paging through the Query
       #
-      attr_reader :offset
+      attr_accessor :offset
+
+      # Count of records processed
+      #
+      attr_reader :count
+
+      # Whether the current query has a next page
+      #
+      attr_reader :next_page
 
       # A new instance of +Query+
       #
       # @param api [Api] Parent to use for making requests
       # @param query_name [String] Full path of the query in IQA, e.g. +$/_ABC/Fiander/iMIS_ID+
-      # @query_params [Hash] Conforms to pattern +{ param_name => param_value }+
+      # @param page_size [Integer] Number of records to return on each request page
+      # @param offset [Integer] Offset index of records to return on next request page
+      # @param query_params [Hash] Conforms to pattern +{ param_name => param_value }+
       #
-      def initialize(api, query_name, query_params)
+      def initialize(api, query_name, page_size: 100, offset: nil, **query_params)
         @api = api
         @query_name = query_name
         @query_params = query_params
+        @query_params.merge!(QueryName: query_name) if iqa?
+        @page_size = page_size
+        @offset = offset
+        @count = 0
+
+        logger.debug "URI: #{uri}"
       end
 
       # Iterate through all results from the query
       #
       def each(&)
-        logger.info 'Running IQA Query on iMIS'
+        logger.info 'Running'
 
         items = []
         find_each { items << it }
@@ -53,26 +73,56 @@ module Usps
       # Iterate through all results from the query, fetching one page at a time
       #
       def find_each(&)
-        result = { 'HasNext' => true }
-        count = 0
+        reset!
+
+        while page?
+          fetch_next.tap do |result_page|
+            result_page['Items']['$values'].map { it.except('$type') }.each(&)
+          end
+        end
+
+        nil
+      end
 
-        while result['HasNext']
-          logger.info 'Fetching IQA Query page'
+      # Fetch a filtered query page, and update the current offset
+      #
+      def page = fetch_next['Items']['$values'].map { iqa? ? it.except('$type') : Imis::Data[it] }
 
-          result = fetch
+      # Fetch the next raw query page, and update the current offset
+      #
+      def fetch_next
+        return unless page?
 
-          count += result['Count'] || 0
-          logger.info "  -> #{count} / #{result['TotalCount']} #{'item'.pluralize(count)}"
-          logger.debug '  -> Query page data:'
-          JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
+        logger.info "Fetching #{query_type} Query page"
 
-          items = result['Items']['$values'].map { it.except('$type') }
-          @offset = result['NextOffset']
+        result = fetch
 
-          items.each(&)
-        end
+        @count += result['Count'] || 0
+        total = result['TotalCount']
+        logger.info "  -> #{@count} / #{total} #{'item'.pluralize(total)}"
+        logger.debug '  -> Query page data:'
+        JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
 
-        nil
+        @offset = result['NextOffset']
+        @next_page = result['HasNext']
+
+        result
+      end
+
+      # Fetch a raw query page
+      #
+      def fetch = JSON.parse(submit(uri, authorize(http_get)).body)
+
+      # Reset query paging progress
+      #
+      def reset!
+        return if next_page.nil?
+
+        logger.debug 'Resetting progress'
+
+        @count = 0
+        @offset = 0
+        @next_page = nil
       end
 
       # Ruby 3.5 instance variable filter
@@ -81,14 +131,17 @@ module Usps
 
     private
 
-      def token = api.token
-      def token_expiration = api.token_expiration
+      # Only skip if explicitly set
+      def page? = next_page.nil? || next_page
 
-      def path = "#{QUERY_PATH}?#{query_params.merge(QueryName: query_name, Offset: offset).to_query}"
+      def iqa? = query_name.match?(/^\$/)
+      def query_type = iqa? ? :IQA : :'Business Object'
+      def path_params = query_params.merge({ Offset: offset, Limit: page_size }.compact)
+      def endpoint = iqa? ? IQA_PATH : "#{Imis::BusinessObject::API_PATH}/#{query_name}"
+      def path = "#{endpoint}?#{path_params.to_query}"
       def uri = URI(File.join(Imis.configuration.hostname, path))
-      def fetch = JSON.parse(submit(uri, authorize(Net::HTTP::Get.new(uri))).body)
 
-      def logger = Imis.logger('Query')
+      def logger = Imis.logger("#{query_type} Query")
     end
   end
 end

data/lib/usps/imis/requests.rb

@@ -9,6 +9,15 @@ module Usps
 
       def logger = Imis.logger
 
+      def token = api.token
+      def token_expiration = api.token_expiration
+      def authenticate = api.send(:authenticate)
+
+      def http_get = Net::HTTP::Get.new(uri)
+      def http_put = Net::HTTP::Put.new(uri)
+      def http_post = Net::HTTP::Post.new(uri(id: ''))
+      def http_delete = Net::HTTP::Delete.new(uri)
+
       def client(uri)
         Net::HTTP.new(uri.host, uri.port).tap do |http|
           http.use_ssl = true
@@ -21,7 +30,7 @@ module Usps
       # If the current token is missing/expired, request a new one
       #
       def authorize(request)
-        if token_expiration < Time.now
+        if token_expiration.nil? || token_expiration < Time.now
           logger.debug 'Token expired: re-authenticating with iMIS'
           authenticate
         end
@@ -45,9 +54,8 @@ module Usps
         body = request.body.dup
 
         Imis.config.filtered_parameters.each do |parameter|
-          body =
-            body.gsub(Imis.config.public_send(parameter), '[FILTERED]')
-                .gsub(CGI.escape(Imis.config.public_send(parameter)), '[FILTERED]')
+          body.gsub!(Imis.config.public_send(parameter), '[FILTERED]')
+          body.gsub!(CGI.escape(Imis.config.public_send(parameter)), '[FILTERED]')
         end
 
         body

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '1.0.0-rc.8'
+    VERSION = '1.0.0-rc.10'
   end
 end

data/spec/support/usps/vcr/config.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Usps
+  module Vcr
+    module Config
+      class << self
+        def configure!
+          WebMock.disable_net_connect!
+
+          VCR.configure do |config|
+            config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+            config.hook_into :webmock
+            default_options(config)
+            config.configure_rspec_metadata!
+            apply_filters(config)
+
+            yield(config) if block_given?
+          end
+        end
+
+        def vcr_record_ordered
+          ENV['VCR'] == 'all' ? :defined : :random
+        end
+
+      private
+
+        def default_options(config)
+          config.default_cassette_options = {
+            record: ENV['VCR'] ? ENV['VCR'].to_sym : :once,
+            match_requests_on: %i[method uri]
+          }
+        end
+
+        def apply_filters(config)
+          Filters.apply!(
+            config,
+            *%i[
+              username password access_token bearer_token
+              ignore_response_headers cf_ray cookie date
+              issued expires
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/support/usps/vcr/filters.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Usps
+  module Vcr
+    module Filters
+      class << self
+        def apply!(config, *filters)
+          filters.each { public_send(it, config) }
+        end
+
+        def username(config)
+          value = Usps::Imis.config.username || '<USERNAME>'
+          config.filter_sensitive_data('<USERNAME>') { value }
+          config.filter_sensitive_data('<USERNAME>') { CGI.escape(value) }
+          config.filter_sensitive_data('<USERNAME>') { value.upcase }
+          config.filter_sensitive_data('<USERNAME>') { CGI.escape(value).upcase }
+        end
+
+        def password(config)
+          value = Usps::Imis.config.password || '<PASSWORD>'
+          config.filter_sensitive_data('<PASSWORD>') { value }
+          config.filter_sensitive_data('<PASSWORD>') { CGI.escape(value) }
+        end
+
+        def access_token(config)
+          filter_json_field(config, 'access_token', '<ACCESS_TOKEN>')
+        end
+
+        def bearer_token(config)
+          config.filter_sensitive_data('<BEARER_TOKEN>') do |interaction|
+            if interaction.request.headers['Authorization']
+              authorization = interaction.request.headers['Authorization'].first
+              if (match = authorization.match(/^Bearer\s+([^,\s]+)/))
+                match.captures.first
+              end
+            end
+          end
+        end
+
+        def ignore_response_headers(config)
+          config.before_record do |interaction|
+            interaction.response.headers.delete('Report-To')
+            interaction.response.headers.delete('Content-Security-Policy-Report-Only')
+          end
+        end
+
+        def cf_ray(config)
+          config.filter_sensitive_data('<CF_RAY>') do |interaction|
+            interaction.response.headers['Cf-Ray']&.first
+          end
+        end
+
+        def cookie(config)
+          config.filter_sensitive_data('<COOKIE>') do |interaction|
+            interaction.response.headers['Set-Cookie']&.first
+          end
+        end
+
+        def date(config)
+          config.filter_sensitive_data('<DATE>') do |interaction|
+            interaction.response.headers['Date']&.first
+          end
+        end
+
+        def issued(config)
+          filter_json_field(config, '.issued', '<ISSUED>')
+        end
+
+        def expires(config)
+          filter_json_field(config, '.expires', '<EXPIRES>')
+        end
+
+      private
+
+        def filter_json_field(config, field_name, placeholder)
+          config.filter_sensitive_data(placeholder) do |interaction|
+            if interaction.response.headers['Content-Type']&.first&.include?('application/json')
+              begin
+                JSON.parse(interaction.response.body)[field_name]
+              rescue JSON::ParserError
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/usps/vcr.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'vcr'
+require 'webmock/rspec'
+require 'usps/imis'
+
+require_relative 'vcr/filters'
+require_relative 'vcr/config'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.8
+  version: 1.0.0.pre.rc.10
 platform: ruby
 authors:
 - Julian Fiander
@@ -29,18 +29,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".simplecov"
-- Gemfile
-- Gemfile.lock
-- Rakefile
 - Readme.md
-- bin/console
-- bin/setup
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
 - lib/usps/imis/business_object.rb
@@ -51,6 +40,7 @@ files:
 - lib/usps/imis/errors/config_error.rb
 - lib/usps/imis/errors/locked_id_error.rb
 - lib/usps/imis/errors/mapper_error.rb
+- lib/usps/imis/errors/missing_id_error.rb
 - lib/usps/imis/errors/not_found_error.rb
 - lib/usps/imis/errors/panel_unimplemented_error.rb
 - lib/usps/imis/errors/response_error.rb
@@ -66,21 +56,9 @@ files:
 - lib/usps/imis/query.rb
 - lib/usps/imis/requests.rb
 - lib/usps/imis/version.rb
-- spec/lib/usps/imis/api_spec.rb
-- spec/lib/usps/imis/business_object_spec.rb
-- spec/lib/usps/imis/config_spec.rb
-- spec/lib/usps/imis/data_spec.rb
-- spec/lib/usps/imis/error_spec.rb
-- spec/lib/usps/imis/errors/response_error_spec.rb
-- spec/lib/usps/imis/mapper_spec.rb
-- spec/lib/usps/imis/mocks/business_object_spec.rb
-- spec/lib/usps/imis/panels/base_panel_spec.rb
-- spec/lib/usps/imis/panels/education_spec.rb
-- spec/lib/usps/imis/panels/vsc_spec.rb
-- spec/lib/usps/imis/properties_spec.rb
-- spec/lib/usps/imis_spec.rb
-- spec/spec_helper.rb
-- usps-imis-api.gemspec
+- spec/support/usps/vcr.rb
+- spec/support/usps/vcr/config.rb
+- spec/support/usps/vcr/filters.rb
 homepage: https://github.com/unitedstatespowersquadrons/imis-api-ruby
 licenses: []
 metadata:
@@ -88,6 +66,7 @@ metadata:
 rdoc_options: []
 require_paths:
 - lib
+- spec/support
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/main.yml

@@ -1,57 +0,0 @@
-name: 'USPS iMIS API - Ruby'
-on:
-  push:
-    paths:
-      - '**.rb'
-      - '**.yml'
-      - '**.json'
-      - 'Gemfile'
-      - '.simplecov'
-    branches:
-      - 'main'
-      - '**'
-  workflow_dispatch:
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-24.04
-    environment: "USPS iMIS API - Ruby"
-    strategy:
-      matrix:
-        ruby: ['3.4', head]
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run Rubocop
-        run: bundle exec rubocop
-  rspec:
-    runs-on: ubuntu-24.04
-    environment: "USPS iMIS API - Ruby"
-    strategy:
-      matrix:
-        ruby: ['3.4', head]
-    env:
-      IMIS_USERNAME: ${{ secrets.IMIS_USERNAME }}
-      IMIS_PASSWORD: ${{ secrets.IMIS_PASSWORD }}
-      IMIS_ID_QUERY_NAME: ${{ secrets.IMIS_ID_QUERY_NAME }}
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run Rspec
-        run: bundle exec rspec --format documentation --order rand --color --tty
-      - name: Store Coverage
-        uses: actions/upload-artifact@v4
-        with:
-          name: coverage-rspec-${{ matrix.ruby }}
-          include-hidden-files: true
-          path: coverage/

data/.gitignore

@@ -1,5 +0,0 @@
-coverage/
-tmp/
-.env
-*.gem
-.yardoc

data/.rspec

@@ -1,2 +0,0 @@
---require spec_helper
---order rand

data/.rubocop.yml

@@ -1,89 +0,0 @@
-plugins:
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 3.4
-  Exclude:
-    - bin/**/*
-    - config/**/*
-    - db/**/*
-    - vendor/**/*
-    - tmp/**/*
-  NewCops: enable
-  SuggestExtensions: false
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-Layout/AccessModifierIndentation:
-  EnforcedStyle: outdent
-Layout/EmptyLinesAroundAccessModifier:
-  Enabled: true
-Layout/ArrayAlignment:
-  Enabled: true
-Layout/HashAlignment:
-  Enabled: true
-Layout/EmptyLineAfterGuardClause:
-  Enabled: true
-Layout/SpaceInsideBlockBraces:
-  EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: no_space
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: no_space
-Layout/SpaceInsideArrayLiteralBrackets:
-  EnforcedStyle: no_space
-
-Lint/UnusedMethodArgument:
-  Enabled: true
-Lint/UselessAssignment:
-  Enabled: true
-
-Metrics/MethodLength:
-  Enabled: true
-  Max: 15
-Metrics/ClassLength:
-  Enabled: true
-  Max: 150
-Metrics/ModuleLength:
-  Max: 150
-Metrics/ParameterLists:
-  Enabled: true
-Metrics/CyclomaticComplexity:
-  Enabled: true
-Metrics/AbcSize:
-  Enabled: true
-  Max: 30
-
-Naming/MemoizedInstanceVariableName:
-  Enabled: false
-Naming/MethodParameterName:
-  Enabled: false
-Naming/FileName:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: true
-Style/NumericLiterals:
-  Enabled: false
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-Style/AndOr:
-  Enabled: true
-Style/ClassCheck:
-  Enabled: true
-Style/GuardClause:
-  Enabled: true
-Style/OptionalBooleanParameter:
-  Enabled: false
-
-Security/Eval:
-  Enabled: true
-Security/JSONLoad:
-  Enabled: true
-Security/YAMLLoad:
-  Enabled: true
-
-RSpec/NestedGroups:
-  Max: 4

data/.ruby-version

@@ -1 +0,0 @@
-3.5-dev

data/.simplecov

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-SimpleCov.start do
-  enable_coverage :branch
-  primary_coverage :branch
-
-  add_filter '/spec'
-end

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-gemspec
-
-gem 'dotenv',        '>= 3.1.4'
-gem 'irb',           '>= 1.15.2'
-gem 'rake',          '>= 13.2.1'
-gem 'rspec',         '>= 3.13.0'
-gem 'rubocop',       '>= 1.66.1'
-gem 'rubocop-rspec', '>= 3.1.0'
-gem 'simplecov',     '>= 0.22.0'