usps-imis-api 0.9.7 → 0.9.9

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

@@ -2,73 +2,86 @@
 
 require 'spec_helper'
 
-describe Usps::Imis::BusinessObject do
-  let(:business_object) { described_class.new(api, 'Stub') }
-  let(:api) { Usps::Imis::Api.new }
-
-  before do
-    allow(business_object).to receive(:raw_object).and_return(
-      Usps::Imis::Data[
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-            { 'Name' => 'Stub String', 'Value' => 'something' }
-          ]
-        }
-      ]
-    )
+describe Usps::Imis::BusinessObject, :vcr do
+  describe '#put_field' do
+    let(:business_object) { api.on('ABC_ASC_Individual_Demog') }
+    let(:api) { Usps::Imis::Api.new.with(31092) }
+
+    before { business_object.put_field('TotMMS', 15) }
+
+    it 'submits the correct update request' do
+      expect { business_object['TotMMS'] = 16 }.to change { business_object['TotMMS'] }.from(15).to(16)
+    end
   end
 
-  describe '#get' do
-    it 'returns multiple values' do
-      expect(business_object.get('Stub String', 'Stub Integer')).to eq(['something', 42])
+  context 'with stubbed data' do
+    let(:business_object) { described_class.new(api, 'Stub') }
+    let(:api) { Usps::Imis::Api.new }
+
+    before do
+      allow(business_object).to receive(:raw_object).and_return(
+        Usps::Imis::Data[
+          'Properties' => {
+            '$values' => [
+              { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
+              { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
+              { 'Name' => 'Stub String', 'Value' => 'something' }
+            ]
+          }
+        ]
+      )
     end
 
-    describe 'delegation to get_fields' do
-      before { allow(business_object).to receive(:get_fields).with('Stub String', 'Stub Integer') }
+    describe '#get' do
+      it 'returns multiple values' do
+        expect(business_object.get('Stub String', 'Stub Integer')).to eq(['something', 42])
+      end
+
+      describe 'delegation to get_fields' do
+        before { allow(business_object).to receive(:get_fields).with('Stub String', 'Stub Integer') }
 
-      it 'delegates to get_fields' do
-        business_object.get('Stub String', 'Stub Integer')
+        it 'delegates to get_fields' do
+          business_object.get('Stub String', 'Stub Integer')
 
-        expect(business_object).to have_received(:get_fields).with('Stub String', 'Stub Integer')
+          expect(business_object).to have_received(:get_fields).with('Stub String', 'Stub Integer')
+        end
       end
     end
-  end
 
-  describe '#get_field' do
-    it 'returns a string value' do
-      expect(business_object.get_field('Stub String')).to eq('something')
-    end
+    describe '#get_field' do
+      it 'returns a string value' do
+        expect(business_object.get_field('Stub String')).to eq('something')
+      end
 
-    it 'returns an integer value' do
-      expect(business_object.get_field('Stub Integer')).to eq(42)
+      it 'returns an integer value' do
+        expect(business_object.get_field('Stub Integer')).to eq(42)
+      end
     end
-  end
 
-  describe '#get_fields' do
-    it 'returns multiple values' do
-      expect(business_object.get_fields('Stub String', 'Stub Integer')).to eq(['something', 42])
+    describe '#get_fields' do
+      it 'returns multiple values' do
+        expect(business_object.get_fields('Stub String', 'Stub Integer')).to eq(['something', 42])
+      end
     end
-  end
 
-  describe '#filter_fields' do
-    let(:expected) do
-      {
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-            { 'Name' => 'Stub String', 'Value' => 'other' }
-          ]
+    describe '#filter_fields' do
+      let(:expected) do
+        {
+          'Properties' => {
+            '$values' => [
+              { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
+              { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
+              { 'Name' => 'Stub String', 'Value' => 'other' }
+            ]
+          }
         }
-      }
-    end
+      end
 
-    it 'formats fields correctly' do
-      updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
+      it 'formats fields correctly' do
+        updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
 
-      expect(updated).to eq(expected)
+        expect(updated).to eq(expected)
+      end
     end
   end
 end

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

@@ -36,6 +36,15 @@ describe Usps::Imis::Data do
     end
   end
 
+  describe '#[]=' do
+    it 'does not support setting values' do
+      expect { described_class.new[:something] = :another }.to raise_error(
+        Usps::Imis::Errors::ApiError,
+        '`Data` does not support setting values. If you need to modify it, call `.raw` on it.'
+      )
+    end
+  end
+
   describe '#inspect' do
     it 'generates the correct inspect string' do
       expect(data.inspect).to eq('#<Usps::Imis::Data entity="ABC_ASC_Individual_Demog" imis_id=31092>')

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Usps::Imis::Mapper do
+describe Usps::Imis::Mapper, :vcr do
   let(:api) { described_class.new.api }
 
   describe 'initialize with imis_id' do

data/spec/lib/usps/imis/panels/base_panel_spec.rb

@@ -16,7 +16,7 @@ module Usps
   end
 end
 
-describe Usps::Imis::Panels::BasePanel do
+describe Usps::Imis::Panels::BasePanel, :vcr do
   it 'requires #business_object to be defined' do
     expect { Usps::Imis::Panels::InvalidPanel.new.get(1) }.to raise_error(
       Usps::Imis::Errors::PanelUnimplementedError,

data/spec/lib/usps/imis/panels/education_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Usps::Imis::Panels::Education do
+describe Usps::Imis::Panels::Education, :vcr do
   describe 'api example' do
     let(:education) { described_class.new }
 

data/spec/lib/usps/imis/panels/vsc_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Usps::Imis::Panels::Vsc do
+describe Usps::Imis::Panels::Vsc, :vcr do
   let(:vsc) { described_class.new }
 
   let(:details) do

data/spec/spec_helper.rb

@@ -11,6 +11,46 @@ require 'active_support/string_inquirer'
 
 ENV['TESTING'] = 'true'
 
+require 'vcr'
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+record_mode = ENV['VCR'] ? ENV['VCR'].to_sym : :once
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+  config.default_cassette_options = {
+    record: record_mode,
+    match_requests_on: %i[method uri]
+  }
+  config.configure_rspec_metadata!
+
+  config.filter_sensitive_data('<USERNAME>') { ENV.fetch('IMIS_USERNAME') }
+  config.filter_sensitive_data('<USERNAME>') { CGI.escape(ENV.fetch('IMIS_USERNAME')) }
+
+  config.filter_sensitive_data('<PASSWORD>') { ENV.fetch('IMIS_PASSWORD') }
+  config.filter_sensitive_data('<PASSWORD>') { CGI.escape(ENV.fetch('IMIS_PASSWORD')) }
+
+  config.filter_sensitive_data('<ACCESS_TOKEN>') do |interaction|
+    if interaction.response.headers['Content-Type']&.first&.include?('application/json')
+      begin
+        response_body = JSON.parse(interaction.response.body)
+        response_body['access_token']
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+
+  config.filter_sensitive_data('<BEARER_TOKEN>') do |interaction|
+    if interaction.request.headers['Authorization']
+      auth_header = interaction.request.headers['Authorization'].first
+      if (match = auth_header.match(/^Bearer\s+([^,\s]+)/))
+        match.captures.first
+      end
+    end
+  end
+end
+
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = 'tmp/.rspec_status'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.9
 platform: ruby
 authors:
 - Julian Fiander
@@ -66,6 +66,49 @@ files:
 - lib/usps/imis/query.rb
 - lib/usps/imis/requests.rb
 - lib/usps/imis/version.rb
+- spec/fixtures/vcr_cassettes/.keep
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_authorize/automatically_refreshes_an_expired_token.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_imis_id_for/gets_the_iMIS_ID.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_imis_id_for/with_a_query_error/wraps_errors.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_inspect/does_not_show_the_token_instance_variable.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_inspect/is_configured_to_exclude_the_token_instance_variable.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_on/chains_with_on_to_a_single_block.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_on/nests_on_and_with.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_on/returns_a_BusinessObject_without_a_block.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_on/sends_an_update_from_put.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_put/sends_an_update.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_put/when_receiving_a_response_error/wraps_the_error.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_query/collects_all_query_results.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_with/blocks_calling_imis_id_.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_with/blocks_calling_imis_id_for.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_with/sends_an_update_from_put.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_with/sends_an_update_from_update.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/_with/uses_a_panel_correctly.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Api/stores_the_initial_imis_id.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_BusinessObject/_put_field/submits_the_correct_update_request.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_BusinessObject/with_stubbed_data/_filter_fields/formats_fields_correctly.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_BusinessObject/with_stubbed_data/_get/delegation_to_get_fields/delegates_to_get_fields.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_BusinessObject/with_stubbed_data/_get/returns_multiple_values.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_BusinessObject/with_stubbed_data/_get_field/returns_a_string_value.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_BusinessObject/with_stubbed_data/_get_field/returns_an_integer_value.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_BusinessObject/with_stubbed_data/_get_fields/returns_multiple_values.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Mapper/_fetch/fetches_a_mapped_field.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Mapper/_fetch/raises_for_unmapped_updates.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Mapper/_fetch/supports_Hash_access_syntax.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Mapper/_fetch/supports_Hash_access_syntax_on_the_Api_directly.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Mapper/_update/raises_for_unmapped_updates.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Mapper/_update/sends_a_mapped_update.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Mapper/initialize_with_imis_id/stores_the_initial_imis_id.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_BasePanel/requires_business_object_to_be_defined.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_BasePanel/requires_payload_data_to_be_defined.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Education/api_example/_get/loads_a_specific_object.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Education/api_example/_get/returns_specific_fields.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Education/api_example/_get_field/returns_a_specific_field.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Education/api_example/_get_fields/returns_specific_fields.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Education/api_example/interacts_with_records_correctly.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Education/initialization_with_ID/can_initialize_with_an_iMIS_ID.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Vsc/_get/loads_a_specific_object.yml
+- spec/fixtures/vcr_cassettes/Usps_Imis_Panels_Vsc/handles_new_records_correctly.yml
 - spec/lib/usps/imis/api_spec.rb
 - spec/lib/usps/imis/business_object_spec.rb
 - spec/lib/usps/imis/config_spec.rb