usps-imis-api 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5db9ae9c192ad976e8a08ddaea01218cb36ab043e550108b08582c782cb43705
-  data.tar.gz: 52951b92b37e906ddd9faa2aedc44d3000e541301e8411227220094bb9dc9525
+  metadata.gz: a7e57bee906686721fa8b760f9fa322e04b289087e9295713283a2f6fcd5d3e6
+  data.tar.gz: 6fe2a0b3405ddf20825ae24bb8986bf4e941a5fb46e37944988047faa5eb54e4
 SHA512:
-  metadata.gz: b32e24b9550ed06bd3971d0ac9072b3011a4fc59734874bfa8e916b6d8832739f8967318e9ca9fc037e24c9b57d9cbe3f2bb37a3a649af95c24e9b5cc8b74033
-  data.tar.gz: fc1934e11eb736e2b91c48cc9a7806f8645f0a5f9b0be87a2e30b309b57b023289dd007e154ce4ba6fc880876671961823229a45cb1a4897e68cde5cb89e3c31
+  metadata.gz: e635a0d05fb1ce0139b422be14d01de9118bc2fa7474ee63eb802c5671a793e4628eea5d320ca93c59c41807419089243e6f1bd3bbc87dbda6c1baee2f06d28c
+  data.tar.gz: a098bb43500c8db276cf03dd8b5f09954431b4a6011c6672656f061d05ca600972e70bab15ddd90877b62cedabb24f73d33575ea4ef5c6ef21d72e133f837cf7

data/.rubocop.yml

@@ -32,8 +32,6 @@ Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyleForEmptyBraces: no_space
 Layout/SpaceInsideArrayLiteralBrackets:
   EnforcedStyle: no_space
-Layout/LineLength:
-  Max: 100
 
 Lint/UnusedMethodArgument:
   Enabled: true

data/Gemfile.lock

@@ -1,17 +1,39 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.6.0)
+    usps-imis-api (0.6.2)
+      activesupport (~> 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (8.0.3)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.3.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
     date (3.4.1)
     diff-lcs (1.5.1)
     docile (1.4.1)
     dotenv (3.1.4)
+    drb (2.2.3)
     erb (5.0.3)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
     io-console (0.8.1)
     irb (1.15.2)
       pp (>= 0.6.0)
@@ -19,6 +41,8 @@ GEM
       reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
+    logger (1.7.0)
+    minitest (5.26.0)
     parallel (1.26.3)
     parser (3.3.5.0)
       ast (~> 2.4.1)
@@ -67,6 +91,7 @@ GEM
     rubocop-rspec (3.1.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -75,7 +100,10 @@ GEM
     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 (2.6.0)
+    uri (1.0.4)
 
 PLATFORMS
   arm64-darwin-23

data/Readme.md

@@ -13,7 +13,7 @@ gem install usps-imis-api
 or add this line to your Gemfile:
 
 ```ruby
-gem 'usps-imis-api', '>= 0.4.0'
+gem 'usps-imis-api', '~> 0.6.1'
 ```
 
 ## Setup
@@ -25,9 +25,11 @@ require 'dotenv/load' # Optionally load environment variables from `.env` file
 require 'usps/imis'
 
 Usps::Imis.configure do |config|
-  config.environment = :development # Rails.env
-  config.imis_id_query_name = ENV['IMIS_ID_QUERY_NAME']
+  # This will default to `Rails.env` if available.
+  config.environment = :development
 
+  # These options will default to the listed `ENV` variable if available.
+  config.imis_id_query_name = ENV['IMIS_ID_QUERY_NAME']
   config.username = ENV['IMIS_USERNAME']
   config.password = ENV['IMIS_PASSWORD']
 end
@@ -222,10 +224,7 @@ end
 
 ## Exception Handling
 
-Exception and error response handling will be added later.
-
-To print exception information to STDERR when raising, set the environment
-variable `IMIS_ERROR_LOG_TO_STDERR=true`.
+All internal exceptions inherit from `Usps::Imis::ApiError`.
 
 ## Automated Testing and Linting
 
@@ -241,6 +240,8 @@ Linting is available by running:
 bundle exec rubocop
 ```
 
+100% branch coverage is enforced on the test suite.
+
 ### GitHub Actions
 
 Testing and linting are automatically run on every push.

data/lib/usps/imis/business_object.rb

@@ -40,6 +40,19 @@ module Usps
         JSON.parse(result.body)
       end
 
+      # Get a single named field from a business object for the current member
+      #
+      # @param name [String] Field name to return
+      #
+      # @return [Hash] Response data from the API
+      #
+      def get_field(name)
+        values = get['Properties']['$values']
+        value = values.find { |hash| hash['Name'] == name }['Value']
+
+        value.is_a?(String) ? value : value['$value']
+      end
+
       # Update only specific fields on a business object for the current member
       #
       # @param fields [Hash] Conforms to pattern +{ field_key => value }+

data/lib/usps/imis/config.rb

@@ -8,25 +8,31 @@ module Usps
       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
+      attr_accessor :imis_id_query_name, :username, :password
+      attr_reader :environment
 
       def initialize
+        @environment = defined?(Rails) ? Rails.env : ActiveSupport::StringInquirer.new('development')
+        @imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', nil)
+        @username = ENV.fetch('IMIS_USERNAME', nil)
+        @password = ENV.fetch('IMIS_PASSWORD', nil)
+
         yield self if block_given?
       end
 
+      def environment=(env)
+        @environment = ActiveSupport::StringInquirer.new(env.to_s)
+      end
+
       # Environment-specific API endpoint hostname
       #
       # @return The API hostname for the current environment
       #
       def hostname
-        case environment.to_sym
-        when :production
-          IMIS_ROOT_URL_PROD
-        when :development
-          IMIS_ROOT_URL_DEV
-        else
-          raise Error::ApiError, "Unexpected API environment: #{environment}"
-        end
+        return IMIS_ROOT_URL_PROD if environment.production?
+        return IMIS_ROOT_URL_DEV if environment.development?
+
+        raise Error::ApiError, "Unexpected API environment: #{environment}"
       end
 
       # Ruby 3.5 instance variable filter

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.0'
+    VERSION = '0.6.2'
   end
 end

data/spec/lib/usps/imis/business_object_spec.rb

@@ -6,31 +6,41 @@ describe Usps::Imis::BusinessObject do
   let(:business_object) { described_class.new(api, 'Stub') }
   let(:api) { Usps::Imis::Api.new }
 
-  describe '#filter_fields' do
-    let(:expected) do
-      {
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-            { 'Name' => 'Stub String', 'Value' => 'other' }
-          ]
-        }
+  let(:expected) do
+    {
+      'Properties' => {
+        '$values' => [
+          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
+          { 'Name' => 'Stub String', 'Value' => 'other' }
+        ]
+      }
+    }
+  end
+
+  before do
+    allow(business_object).to receive(:get).and_return({
+      'Properties' => {
+        '$values' => [
+          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
+          { 'Name' => 'Stub String', 'Value' => 'something' }
+        ]
       }
+    })
+  end
+
+  describe '#get_field' do
+    it 'returns a string value' do
+      expect(business_object.get_field('Stub String')).to eq('something')
     end
 
-    before do
-      allow(business_object).to receive(:get).and_return({
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-            { 'Name' => 'Stub String', 'Value' => 'something' }
-          ]
-        }
-      })
+    it 'returns an integer value' do
+      expect(business_object.get_field('Stub Integer')).to eq(42)
     end
+  end
 
+  describe '#filter_fields' do
     it 'formats fields correctly' do
       updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
 

data/spec/lib/usps/imis/config_spec.rb

@@ -5,10 +5,36 @@ require 'spec_helper'
 describe Usps::Imis::Config do
   let(:config) { described_class.new }
 
-  it 'sets values on initialize' do
-    config = described_class.new { |c| c.environment = 'test' }
+  describe 'environment' do
+    subject { config.environment }
 
-    expect(config.environment).to eq('test')
+    let(:config) { described_class.new }
+
+    context 'when not specified' do
+      it { is_expected.to be_development }
+    end
+
+    context 'when specified' do
+      before { config.environment = 'something' }
+
+      it { is_expected.to be_something }
+    end
+
+    context 'when specified on initialize' do
+      subject { config.environment }
+
+      let(:config) do
+        described_class.new { |c| c.environment = 'test' }
+      end
+
+      it { is_expected.to be_test }
+    end
+
+    context 'when in Rails' do
+      before { stub_const('Rails', Struct.new(:env).new(ActiveSupport::StringInquirer.new('qa'))) }
+
+      it { is_expected.to be_qa }
+    end
   end
 
   describe '#hostname' do

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ SimpleCov.minimum_coverage(line: 100, branch: 100)
 
 require 'dotenv/load'
 require 'usps/imis'
+require 'active_support/string_inquirer'
 
 ENV['TESTING'] = 'true'
 

data/usps-imis-api.gemspec

@@ -15,4 +15,6 @@ Gem::Specification.new do |s|
   s.metadata['rubygems_mfa_required'] = 'true'
 
   s.required_ruby_version = '>= 3.4'
+
+  s.add_dependency 'activesupport', '~> 8.0'
 end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Julian Fiander
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description: A wrapper for the iMIS API.
 email: jsfiander@gmail.com
 executables: []