usps-imis-api 0.9.8 → 0.9.10.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80cb6198e125d3dc201641a6a70c639c8890094582fe6c293c807fb212a59738
-  data.tar.gz: e5382f2b08c9bffd26204cd06c3d55bc8604e7fa62ebc612a5b88a42a4029ab1
+  metadata.gz: b481e216a4b7c245599a7086834c243178c30aeb2d1891370150e466b5f8ba25
+  data.tar.gz: cb1b01a149cbe94dac703a2be902a52a1810da7326d06410b159195f5f0bb69b
 SHA512:
-  metadata.gz: ba2f8613ca13a61eda5d8a0c5a229e09d8226e74ca8611f83e80d6d3259e2f120f6fddab9ee2eb7740c0de150de8462537219147fe7d3c2aceafc5e0c8652dfc
-  data.tar.gz: 472196fce4e1a5e05287889b6d70e56bc72f5326944dafd114527865688d82f3208d7e4ae38b4161a176ea43663a7981eee196e145bbeac3d62f9c2f9b941713
+  metadata.gz: 51d505d17d527c20112d7a5b81932bf8e28949a5515ab6ae1c6660687dd2d56227aa4b8d4883111b5724bf24e2f49efe6b37322dd0c627f66587a935b8b6f13b
+  data.tar.gz: 9878ebd3710155ee8ea752337155d8f88eec75a07d228fc2d2462da8bbd57e2e8e44a80f6fc94965c1cc33435bd0efc585d79db5ee96c26c04d250a236bad83c

data/Readme.md

@@ -377,6 +377,8 @@ Testing is available by running:
 bundle exec rspec
 ```
 
+API web requests are sanitized and recorded using VCR.
+
 Linting is available by running:
 
 ```ruby

data/lib/usps/imis/api.rb

@@ -36,11 +36,10 @@ module Usps
 
       # A new instance of +Api+
       #
-      # @param skip_authentication [bool] Skip authentication on initialization (used for tests)
       # @param imis_id [Integer, String] iMIS ID to select immediately on initialization
       #
-      def initialize(skip_authentication: false, imis_id: nil)
-        authenticate unless skip_authentication
+      def initialize(imis_id: nil)
+        authenticate
         self.imis_id = imis_id if imis_id
       end
 
@@ -104,9 +103,7 @@ module Usps
       #
       # @return [Hash] Response data from the API
       #
-      def query(query_name, query_params = {})
-        Query.new(self, query_name, query_params)
-      end
+      def query(query_name, query_params = {}) = Query.new(self, query_name, **query_params)
 
       # Run requests as DSL, with specific +BusinessObject+ only maintained for this scope
       #
@@ -162,20 +159,22 @@ module Usps
       def authenticate
         logger.debug 'Authenticating with iMIS'
 
-        uri = URI(File.join(Imis.configuration.hostname, AUTHENTICATION_PATH))
-        req = Net::HTTP::Post.new(uri)
-        authentication_data = {
+        request = http_post
+        request.body = URI.encode_www_form(
           grant_type: 'password',
           username: Imis.configuration.username,
           password: Imis.configuration.password
-        }
-        req.body = URI.encode_www_form(authentication_data)
-        result = submit(uri, req)
+        )
+        result = submit(uri, request)
         json = JSON.parse(result.body)
 
         @token = json['access_token']
         @token_expiration = Time.parse(json['.expires'])
       end
+
+      # URI for the authentication endpoint
+      #
+      def uri(...) = URI(File.join(Imis.configuration.hostname, AUTHENTICATION_PATH))
     end
   end
 end

data/lib/usps/imis/business_object.rb

@@ -93,7 +93,7 @@ module Usps
       #
       # @return [Usps::Imis::Data] Response data from the API
       #
-      def put(body) = put_object(Net::HTTP::Put.new(uri), body)
+      def put(body) = put_object(http_put, body)
       alias update put
 
       # Create a business object for the current member
@@ -102,14 +102,14 @@ module Usps
       #
       # @return [Usps::Imis::Data] Response data from the API
       #
-      def post(body) = put_object(Net::HTTP::Post.new(uri(id: '')), body)
+      def post(body) = put_object(http_post, body)
       alias create post
 
       # Remove a business object for the current member
       #
       # @return [true] Only on success response (i.e. blank string from the API)
       #
-      def delete = submit(uri, authorize(Net::HTTP::Delete.new(uri))).body == '' # rubocop:disable Naming/PredicateMethod
+      def delete = submit(uri, authorize(http_delete)).body == '' # rubocop:disable Naming/PredicateMethod
       alias destroy delete
 
       # Ruby 3.5 instance variable filter
@@ -118,9 +118,6 @@ module Usps
 
     private
 
-      def token = api.token
-      def token_expiration = api.token_expiration
-
       def logger = Imis.logger('BusinessObject')
 
       # Construct a business object API endpoint address
@@ -173,9 +170,8 @@ module Usps
       # Useful for stubbing data in tests
       #
       def raw_object
-        request = Net::HTTP::Get.new(uri)
-        result = submit(uri, authorize(request))
-        result = Data.from_json(result.body)
+        response = submit(uri, authorize(http_get))
+        result = Data.from_json(response.body)
         JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
         result
       end
@@ -184,8 +180,8 @@ module Usps
       #
       def put_object(request, body)
         request.body = JSON.dump(body)
-        result = submit(uri, authorize(request))
-        result = Data.from_json(result.body)
+        response = submit(uri, authorize(request))
+        result = Data.from_json(response.body)
         JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
         result
       end

data/lib/usps/imis/config.rb

@@ -44,7 +44,7 @@ module Usps
 
       # Ruby 3.5 instance variable filter
       #
-      def instance_variables_to_inspect = %i[@environment @imis_id_query_name @username @logger_level]
+      def instance_variables_to_inspect = instance_variables - %i[@password @logger]
 
       # Parameters to filter out of logging
       #

data/lib/usps/imis/data.rb

@@ -50,6 +50,10 @@ module Usps
           .index_with { self[it] }
       end
 
+      def []=(...)
+        raise Errors::ApiError, '`Data` does not support setting values. If you need to modify it, call `.raw` on it.'
+      end
+
       def inspect
         stringio = StringIO.new
         PP.pp(self, stringio)

data/lib/usps/imis/error.rb

@@ -18,7 +18,7 @@ module Usps
         super(message)
         @metadata = metadata
 
-        Imis.logger.debug self
+        Imis.logger(self.class.name).error self
       end
 
       # Additional metadata to include in Bugsnag reports

data/lib/usps/imis/query.rb

@@ -24,20 +24,32 @@ 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
 
       # 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
+        @page_size = page_size
+        @offset = offset
       end
 
       # Iterate through all results from the query
@@ -53,26 +65,37 @@ module Usps
       # Iterate through all results from the query, fetching one page at a time
       #
       def find_each(&)
-        result = { 'HasNext' => true }
-        count = 0
+        result = reset!
 
         while result['HasNext']
-          logger.info 'Fetching IQA Query page'
+          result = fetch_next.tap do |result_page|
+            result_page['Items']['$values'].map { it.except('$type') }.each(&)
+          end
+        end
+
+        nil
+      end
+
+      # Fetch a raw query page
+      #
+      def fetch = JSON.parse(submit(uri, authorize(http_get)).body)
 
-          result = fetch
+      # Fetch the next raw query page, and update the current offset
+      #
+      def fetch_next
+        logger.info 'Fetching IQA Query 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}" }
+        result = fetch
 
-          items = result['Items']['$values'].map { it.except('$type') }
-          @offset = result['NextOffset']
+        @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}" }
 
-          items.each(&)
-        end
+        @offset = result['NextOffset']
 
-        nil
+        result
       end
 
       # Ruby 3.5 instance variable filter
@@ -81,14 +104,20 @@ module Usps
 
     private
 
-      def token = api.token
-      def token_expiration = api.token_expiration
-
-      def path = "#{QUERY_PATH}?#{query_params.merge(QueryName: query_name, Offset: offset).to_query}"
+      def path_params = query_params.merge(QueryName: query_name).merge({ Offset: offset, Limit: page_size }.compact)
+      def path = "#{QUERY_PATH}?#{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 reset!
+        logger.debug 'Resetting Query progress'
+
+        @count = 0
+        @offset = 0
+
+        { 'HasNext' => true }
+      end
     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
@@ -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 = '0.9.8'
+    VERSION = '0.9.10-1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.10.pre.1
 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
@@ -66,21 +55,6 @@ 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
 homepage: https://github.com/unitedstatespowersquadrons/imis-api-ruby
 licenses: []
 metadata:

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'

data/Gemfile.lock

@@ -1,129 +0,0 @@
-PATH
-  remote: .
-  specs:
-    usps-imis-api (0.9.8)
-      activesupport (~> 8.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (8.1.0)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      json
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
-    ast (2.4.3)
-    base64 (0.3.0)
-    bigdecimal (3.3.1)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.4)
-    date (3.4.1)
-    diff-lcs (1.6.2)
-    docile (1.4.1)
-    dotenv (3.1.8)
-    drb (2.2.3)
-    erb (5.1.1)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
-    io-console (0.8.1)
-    irb (1.15.2)
-      pp (>= 0.6.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    json (2.15.1)
-    language_server-protocol (3.17.0.5)
-    lint_roller (1.1.0)
-    logger (1.7.0)
-    minitest (5.26.0)
-    parallel (1.27.0)
-    parser (3.3.9.0)
-      ast (~> 2.4.1)
-      racc
-    pp (0.6.3)
-      prettyprint
-    prettyprint (0.2.0)
-    prism (1.6.0)
-    psych (5.2.6)
-      date
-      stringio
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.3.0)
-    rdoc (6.15.0)
-      erb
-      psych (>= 4.0.0)
-      tsort
-    regexp_parser (2.11.3)
-    reline (0.6.2)
-      io-console (~> 0.5)
-    rspec (3.13.2)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.6)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.6)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
-    rubocop (1.81.6)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.47.1)
-      parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-rspec (3.7.0)
-      lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
-    ruby-progressbar (1.13.0)
-    securerandom (0.4.1)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.2)
-    simplecov_json_formatter (0.1.4)
-    stringio (3.1.7)
-    tsort (0.2.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
-    uri (1.0.4)
-
-PLATFORMS
-  arm64-darwin-23
-  ruby
-
-DEPENDENCIES
-  dotenv (>= 3.1.4)
-  irb (>= 1.15.2)
-  rake (>= 13.2.1)
-  rspec (>= 3.13.0)
-  rubocop (>= 1.66.1)
-  rubocop-rspec (>= 3.1.0)
-  simplecov (>= 0.22.0)
-  usps-imis-api!
-
-BUNDLED WITH
-   2.5.6