usps-imis-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08fbe2f408147a553ac2bf52e2a99d5919b6a26b3361c70455c3f231d099ec6f'
-  data.tar.gz: 2e59bcf317e9f0cff940a3da5e3d84293fd24f98d7eca489f43a074bf42525be
+  metadata.gz: ad19ed5d60abf0531fdc10f01113fada6a5bc9413574bda31783d41507000c87
+  data.tar.gz: 8d0fcf7a1881cfb262a248683346489be5e28f2d57ce8a18923210780fc9e847
 SHA512:
-  metadata.gz: d8117d16b3fa0d05e4002d0860d2ad91f282653a3b4af215bc69c67580c2dbaccc31e0b02f3a71a8bfbc136d9e76e2a64ad7c2f68a29b61511a141317ae4dc24
-  data.tar.gz: 1dcea3e725a174d1024bbd9b042afa6706599005b1f858302ebb214723df2e2cb9f8ef705f843e226ddb00aca1a545df6665806e8dc40948c1508f2873ae37d7
+  metadata.gz: 8abd5d2a143699aa7f184def0c97358bbc475c2248a1f56c5f5104ff9b9e08f917dd1f285637109ed3e0026c91e049661bf77a73f40bc56082a1d286d180951b
+  data.tar.gz: 823f16f923c71f7f0822a0d48fbe84152ea0221a96ded092570ee5554242acf9b619688625708bd9af89117f3d081c26125c02b5b879378e971072c4770cac08

data/.github/workflows/main.yml

@@ -0,0 +1,38 @@
+name: 'USPS iMIS API - Ruby'
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-24.04
+    environment: "USPS iMIS API - Ruby"
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with: { bundler-cache: true }
+      - name: Run Rubocop
+        run: bundle exec rubocop
+  rspec:
+    runs-on: ubuntu-24.04
+    environment: "USPS iMIS API - Ruby"
+    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: { 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
+          include-hidden-files: true
+          path: coverage/

data/.rubocop.yml

@@ -31,14 +31,14 @@ Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyleForEmptyBraces: no_space
 Layout/SpaceInsideArrayLiteralBrackets:
   EnforcedStyle: no_space
+Layout/LineLength:
+  Max: 100
 
 Lint/UnusedMethodArgument:
   Enabled: true
 Lint/UselessAssignment:
   Enabled: true
 
-Metrics/LineLength:
-  Max: 100
 Metrics/MethodLength:
   Enabled: true
   Max: 15
@@ -59,13 +59,15 @@ Naming/MemoizedInstanceVariableName:
   Enabled: false
 Naming/MethodParameterName:
   Enabled: false
+Naming/FileName:
+  Enabled: false
 
 Style/Documentation:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: true
 Style/NumericLiterals:
-  Enabled: true
+  Enabled: false
 Style/StringLiterals:
   EnforcedStyle: single_quotes
 Style/AndOr:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.1.1)
+    usps-imis-api (0.1.2)
 
 GEM
   remote: https://rubygems.org/

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.1.0'
+gem 'usps-imis-api', '>= 0.1.1'
 ```
 
 ## Setup
@@ -22,7 +22,7 @@ Include the library, and set the configuration:
 
 ```ruby
 require 'dotenv/load' # Optionally load environment variables from `.env` file
-require 'usps_imis_api'
+require 'usps-imis-api'
 
 Imis.configure do |config|
   config.environment = :development # Rails.env
@@ -136,6 +136,20 @@ If there is no known mapping for the requested field, the Mapper will give up, b
 you with the standard API call syntax, and will suggest you inform ITCom leadership of the new
 mapping you need.
 
+### DSL Mode
+
+Instead of manually setting the current iMIS ID, then running individual queries, you can instead
+run queries in DSL mode. This specifies the iMIS ID for the scope of the block, then reverts to the
+previous value.
+
+```ruby
+api.with(31092) do
+  # These two requests are identical:
+  put('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 })
+  mapper.update(:mm, 15)
+end
+```
+
 ## Exception Handling
 
 Exception and error response handling will be added later.
@@ -154,6 +168,10 @@ Linting is available by running:
 bundle exec rubocop
 ```
 
+### GitHub Actions
+
+Testing and linting are automatically run on every push.
+
 ## PHP
 
 This same API is

data/lib/imis/api.rb

@@ -25,6 +25,18 @@ module Imis
       @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)

data/lib/imis/mapper.rb

@@ -3,9 +3,9 @@
 module Imis
   class Mapper
     FIELD_MAPPING = {
-      vessel_examiner: ['ABC_ASC_Individual_Demog', 'Vol_Vessel_Examiner'],
-      mm: ['ABC_ASC_Individual_Demog', 'TotMMS'],
-      mm_updated: ['ABC_ASC_Individual_Demog', 'MMS_Updated']
+      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
@@ -24,18 +24,26 @@ module Imis
         business_object_name, field = FIELD_MAPPING[field_name.to_sym]
         api.put(business_object_name, { field => value })
       else
+        missing_mapping(field_name)
+      end
+    end
+
+  private
+
+    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(business_object_name, { field_name => value })  ' \
           "if you know the business object and iMIS-specific field name.\n\n"
-        ) unless ENV['TESTING']
-
-        raise(
-          Imis::Error::Mapper,
-          "Unrecognized field: \"#{field_name}\". " \
-          'Please report what data you are attempting to work with to ITCom leadership.'
         )
       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/spec/{api_spec.rb → lib/imis/api_spec.rb}

@@ -18,4 +18,10 @@ describe Imis::Api do
       expect(api.put('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 })).to be_a(Hash)
     end
   end
+
+  describe '#with' do
+    it 'sends an update' do
+      expect(api.with(31092) { put('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }).to be_a(Hash)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ end
 # SimpleCov.minimum_coverage(100)
 
 require 'dotenv/load'
-require 'usps_imis_api'
+require 'usps-imis-api'
 
 ENV['TESTING'] = 'true'
 

data/usps-imis-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'usps-imis-api'
-  s.version       = '0.1.1'
+  s.version       = '0.1.2'
   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.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Julian Fiander
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -30,8 +31,8 @@ files:
 - lib/imis/error/mapper.rb
 - lib/imis/mapper.rb
 - lib/usps-imis-api.rb
-- spec/api_spec.rb
-- spec/mapper_spec.rb
+- spec/lib/imis/api_spec.rb
+- spec/lib/imis/mapper_spec.rb
 - spec/spec_helper.rb
 - usps-imis-api.gemspec
 homepage: http://rubygems.org/gems/usps-imis-api