usps-imis-api 0.9.11 → 0.9.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb22ca224852ea6118af6df2c429bfa597903c4fe4583243ea3a28b6886a21db
-  data.tar.gz: 606da2d8b21e9008b402bf66cacee53de74ebec860141b5a960690fa8364ab3a
+  metadata.gz: 53c6da160ddc5b59bd09e067311d706ca8b6bf97f1f96b82b9213f5617cd518e
+  data.tar.gz: 95454c52fcdf4f17a7a81009c863d0ef7691dc3e5346f094df9340c39c25185a
 SHA512:
-  metadata.gz: a347f809fa6eba2e229fcbb1cdc0107ca2797d56950190ad299495c8525f9d858e78e8953aa53dd871906e5b8a95899e64837f31a298cca00e215835d1198aed
-  data.tar.gz: 5768933b5586148a67abd45236e7cbcf7084cb25e8ed7c4c8e509fb9fe9f23f1225c6b5d0f7fecf3be350f48459edbee6f6ec80626f70c041c7de6ee3998a429
+  metadata.gz: 138797b4b4593c275e540e3c5eb2960cd948ba3653bb3d8ac8349ab3f808038c2aa1059dd45e569cd801e6c268232f5844dbf918a0fc9b7107d67b9064c5c1bd
+  data.tar.gz: c4817cf8e7ba625e6ed89cb36dc6cff7ac3a7bf630b710e9f7b4de825c30b8251b5e31565a2f1272cb52696d141ec1868b299e8632f27bbe12a4ae9599541c12

data/Readme.md

@@ -365,6 +365,41 @@ allow(api).to(
 )
 ```
 
+### VCR
+
+If you would like to use the included VCR config, make sure your Gemfile includes the required gems:
+
+```ruby
+gem 'cgi' # 2025-10-27 - Currently required for Ruby 3.5
+gem 'vcr'
+gem 'webmock'
+```
+
+In `spec_helper.rb`, add the following:
+
+```ruby
+require 'usps/vcr'
+Usps::Vcr::Config.configure!
+```
+
+You can also pass additional VCR config options through:
+
+```ruby
+Usps::Vcr::Config.configure! do |config|
+  config.ignore_localhost = true
+end
+```
+
+If you have any tests that are dependent on ordering to (re-)generate cassettes, a helper is also
+available to support adding example metadata, which will use a fixed order when the environment
+varialbe `VCR=all` is set:
+
+```ruby
+describe 'examples that care about order', order: Usps::Vcr::Config.vcr_record_ordered do
+  # ...
+end
+```
+
 ## Exception Handling
 
 All internal exceptions inherit from `Usps::Imis::Error`.

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.9.11'
+    VERSION = '0.9.13'
   end
 end

data/spec/support/usps/vcr/config.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Usps
+  module Vcr
+    module Config
+      class << self
+        def configure!
+          WebMock.disable_net_connect!
+
+          VCR.configure do |config|
+            config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+            config.hook_into :webmock
+            default_options(config)
+            config.configure_rspec_metadata!
+            apply_filters(config)
+
+            yield(config) if block_given?
+          end
+        end
+
+        def vcr_record_ordered
+          ENV['VCR'] == 'all' ? :defined : :random
+        end
+
+      private
+
+        def default_options(config)
+          config.default_cassette_options = {
+            record: ENV['VCR'] ? ENV['VCR'].to_sym : :once,
+            match_requests_on: %i[method uri]
+          }
+        end
+
+        def apply_filters(config)
+          Filters.apply!(
+            config,
+            *%i[
+              username password access_token bearer_token
+              ignore_response_headers cf_ray cookie date
+              issued expires
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/support/usps/vcr/filters.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Usps
+  module Vcr
+    module Filters
+      class << self
+        def apply!(config, *filters)
+          filters.each { public_send(it, config) }
+        end
+
+        def username(config)
+          value = ENV.fetch('IMIS_USERNAME', '<USERNAME>')
+          config.filter_sensitive_data('<USERNAME>') { value }
+          config.filter_sensitive_data('<USERNAME>') { CGI.escape(value) }
+          config.filter_sensitive_data('<USERNAME>') { value.upcase }
+          config.filter_sensitive_data('<USERNAME>') { CGI.escape(value).upcase }
+        end
+
+        def password(config)
+          value = ENV.fetch('IMIS_PASSWORD', '<PASSWORD>')
+          config.filter_sensitive_data('<PASSWORD>') { value }
+          config.filter_sensitive_data('<PASSWORD>') { CGI.escape(value) }
+        end
+
+        def access_token(config)
+          filter_json_field(config, 'access_token', '<ACCESS_TOKEN>')
+        end
+
+        def bearer_token(config)
+          config.filter_sensitive_data('<BEARER_TOKEN>') do |interaction|
+            if interaction.request.headers['Authorization']
+              authorization = interaction.request.headers['Authorization'].first
+              if (match = authorization.match(/^Bearer\s+([^,\s]+)/))
+                match.captures.first
+              end
+            end
+          end
+        end
+
+        def ignore_response_headers(config)
+          config.before_record do |interaction|
+            interaction.response.headers.delete('Report-To')
+            interaction.response.headers.delete('Content-Security-Policy-Report-Only')
+          end
+        end
+
+        def cf_ray(config)
+          config.filter_sensitive_data('<CF_RAY>') do |interaction|
+            interaction.response.headers['Cf-Ray']&.first
+          end
+        end
+
+        def cookie(config)
+          config.filter_sensitive_data('<COOKIE>') do |interaction|
+            interaction.response.headers['Set-Cookie']&.first
+          end
+        end
+
+        def date(config)
+          config.filter_sensitive_data('<DATE>') do |interaction|
+            interaction.response.headers['Date']&.first
+          end
+        end
+
+        def issued(config)
+          filter_json_field(config, '.issued', '<ISSUED>')
+        end
+
+        def expires(config)
+          filter_json_field(config, '.expires', '<EXPIRES>')
+        end
+
+      private
+
+        def filter_json_field(config, field_name, placeholder)
+          config.filter_sensitive_data(placeholder) do |interaction|
+            if interaction.response.headers['Content-Type']&.first&.include?('application/json')
+              begin
+                JSON.parse(interaction.response.body)[field_name]
+              rescue JSON::ParserError
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/usps/vcr.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'vcr'
+require 'webmock/rspec'
+
+require_relative 'vcr/filters'
+require_relative 'vcr/config'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.9.11
+  version: 0.9.13
 platform: ruby
 authors:
 - Julian Fiander
@@ -55,6 +55,9 @@ files:
 - lib/usps/imis/query.rb
 - lib/usps/imis/requests.rb
 - lib/usps/imis/version.rb
+- spec/support/usps/vcr.rb
+- spec/support/usps/vcr/config.rb
+- spec/support/usps/vcr/filters.rb
 homepage: https://github.com/unitedstatespowersquadrons/imis-api-ruby
 licenses: []
 metadata:
@@ -62,6 +65,7 @@ metadata:
 rdoc_options: []
 require_paths:
 - lib
+- spec/support
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="