usps-imis-api 0.1.0 → 0.1.1.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af49f754c17bf49128b5e71d515f75066ab62cd56573a846b3fb50fa951324ef
-  data.tar.gz: b0df9cc67032d9d40a474fe119deb0c70d0374358425ef6817d91398698cfd92
+  metadata.gz: 6547c9f21c818bf196c1679ba6f34380d87499148212b4257c12a66d938fd3d1
+  data.tar.gz: e68b6e5d91999b9e4a94b31303528a019b626724bec05df11fe84137c1430782
 SHA512:
-  metadata.gz: 8a26ceb0adc52557754fce7207a32f5e26eeb445c98f328d04d99dfb8c478daa47a124f5cae59d22661c302d33242ad67883d7fc0e4ae77ee77ee55dc5473177
-  data.tar.gz: da23f2bd903cf74d4b74e4d2b4324557662366e37cdb5acc299dc208231e64ed4c8f477649b2e2a53db2db03b9d51b4fa692507b49abfce5ea18f1156c7ca436
+  metadata.gz: 8deac689f8ef2fa6d5330df7790d178f9240e6d0da994c203877bb58585fc7865aa5f48c1e4959ba9b580f245f20f6516fab408eabc250b650b973da80fbe3b4
+  data.tar.gz: 5ceac354048e28443019fe0286b60275c2333c0ad9c6700710d823b500b53a2805941fe2add4f2e5e372719e29723474f2ca1cbfe0416cfae72e0e5c221b6915

data/.gitignore

@@ -1,3 +1,4 @@
 coverage/
 tmp/
 .env
+*.gem

data/Gemfile.lock

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

data/Readme.md

@@ -0,0 +1,160 @@
+# USPS iMIS API for Ruby
+
+![Gem Version](https://img.shields.io/gem/v/usps-imis-api)
+
+## Installation
+
+Run this command:
+
+```ruby
+gem install usps-imis-api
+```
+
+or add this line to your Gemfile:
+
+```ruby
+gem 'usps-imis-api', '>= 0.1.0'
+```
+
+## Setup
+
+Include the library, and set the configuration:
+
+```ruby
+require 'dotenv/load' # Optionally load environment variables from `.env` file
+require 'usps_imis_api'
+
+Imis.configure do |config|
+  config.environment = :development # Rails.env
+  config.imis_id_query_name = ENV['IMIS_ID_QUERY_NAME']
+
+  config.username = ENV['IMIS_USERNAME']
+  config.password = ENV['IMIS_PASSWORD']
+end
+```
+
+Instantiate the API object:
+
+```ruby
+api = Imis::Api.new
+```
+
+### Authentication
+
+If a token is not available, this will automatically fetch one when needed. As long as that token
+should still be valid, it will reuse the same token. If the token should expire, this will
+automatically request a new token.
+
+## Usage
+
+### iMIS ID
+
+To act on member data, you need to have the iMIS ID. If you already have access to that from the
+database, you can skip this step.
+
+To convert a member's certificate number into their iMIS ID, run the following method:
+
+```ruby
+api.get_imis_id(certificate)
+```
+
+This will both return the ID, and store it for use with other requests. If you need to change which
+member you are working with, just run this method again with the new certificate number.
+
+### General API Requests
+
+#### GET
+
+To fetch member data, run e.g.:
+
+```ruby
+api.imis_id = 31092
+
+data = api.get('ABC_ASC_Individual_Demog')
+```
+
+#### PUT
+
+To update member data, run e.g.:
+
+```ruby
+api.imis_id = 31092
+
+data = { 'MMS_Updated' => Time.now.strftime('%Y-%m-%dT%H:%M:%S'), 'TotMMS' => new_total }
+update = api.put_object_fields('ABC_ASC_Individual_Demog', data)
+```
+
+This method fetches the current data structure, and filters it down to just what you want to
+update, to reduce the likelihood of update collisions or type validation failures.
+
+### Public Methods
+
+Convert a member's certificate number into an iMIS ID number
+
+```ruby
+api.get_imis_id(certificate)
+```
+
+Manually set the current ID, if you already have it for a given member
+
+```ruby
+api.imis_id = imis_id
+```
+
+GET a business object for the current member
+
+```ruby
+api.get(business_object_name)
+```
+
+Update only specific fields on a business object for the current member
+
+`fields` is a hash of shape: `{ field_name => new_value }`
+
+```ruby
+api.put(business_object_name, fields)
+```
+
+Run an IQA Query
+
+`query_params` is a hash of shape: `{ param_name => param_value }`
+
+```ruby
+api.query(query_name, query_params)
+```
+
+### Field Mapper
+
+For fields that have already been mapped between the ITCom database and iMIS, you can use the
+Mapper class to further simplify the update interface:
+
+```ruby
+api.mapper.update(:mm, 15)
+```
+
+If there is no known mapping for the requested field, the Mapper will give up, but will provide
+you with the standard API call syntax, and will suggest you inform ITCom leadership of the new
+mapping you need.
+
+## Exception Handling
+
+Exception and error response handling will be added later.
+
+## Automated Testing and Linting
+
+Testing is available by running:
+
+```ruby
+bundle exec rspec
+```
+
+Linting is available by running:
+
+```ruby
+bundle exec rubocop
+```
+
+## PHP
+
+This same API is
+[available for PHP](https://github.com/unitedstatespowersquadrons/imis-api).

data/usps-imis-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'usps-imis-api'
-  s.version       = '0.1.0'
+  s.version       = '0.1.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.0
+  version: 0.1.1.pre.2
 platform: ruby
 authors:
 - Julian Fiander
@@ -22,13 +22,14 @@ files:
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- Readme.md
 - 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/usps_imis_api.rb
+- lib/usps-imis-api.rb
 - spec/api_spec.rb
 - spec/mapper_spec.rb
 - spec/spec_helper.rb