us_address_client 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b042f259b793875c82a530f33a50da311e319c87dc78af15e699e618388c95ba
-  data.tar.gz: 4444911ea6ed25edaf5b165b1f3bdad47a15fa993cc969d851dd0443a3ddd17f
+  metadata.gz: 27acc4f00de10dcbcec7f1663cc173a66bc8ee64902d1ea994b41f5608ae4c1d
+  data.tar.gz: 2991960b197b2691b9df07a3782fe34f1d2e954391902f189cc223c73313a7d4
 SHA512:
-  metadata.gz: 015420e49d95d20c0f64a754f01656bc22d9b6c25a26fc108cc18884a40bce5a16baf20448ee197de3359ecce2ee96f44138723989df58a45705cbf3328df893
-  data.tar.gz: 4258c022309fb3b69876f0cce661bcb245bc9eaa5184e1e7f729b93bde62ae23f2d8f12ad3980cad15b581f18d81303852b45594294799a6c407f0a8a6fb0b1c
+  metadata.gz: 793452b1d5f58647a6310145d8c22a7b72f8baef055a7384532f1c5d116ead042f45fbcf22ce99a8e36eba7fd83c91f2a1bdc02e609ca868b7fff5aec93c604e
+  data.tar.gz: d402b97533741a2cd7f17a433c023939f0bfec85a3e597e8bf3a46a20c358656057fd85b2aeb483631544d5669a8cd1a21f38c559385aee8c8dad83d3d96c6de

data/README.md

@@ -97,7 +97,6 @@ us_address_client:
 
 #### Notes:
 
-- If `url` is not supplied then it will fall back to the local melissa data installation using the `melissa` gem. 
 - Configuration changes _must_ be made prior to any calls being made to this service.
 
 ### Logging
@@ -163,3 +162,32 @@ Output:
 2018-12-19 19:34:08.134716 D [28643:70323013957920 transport.rb:25] (16.6ms) USAddressClient -- #http_get -- { :path => "/address?address=2811+Safe+Harbor+Drive&city=Tampa&state=FL&zip=33618" }
 2018-12-19 19:34:08.134845 I [28643:70323013957920 client.rb:8] (16.8ms) USAddressClient -- #verify -- { :input => { :address => "2811 Safe Harbor Drive", :city => "Tampa", :state => "FL", :zip => "33618" }, :output => { :zip => "33618", :time_zone_code => "05", :time_zone => "Eastern Time", :suite_range => "", :suite_name => "", :suite => "", :suffix => "Dr", :street_name => "Safe Harbor", :state => "FL", :result_codes => [ "AS01" ], :private_mailbox_number => "", :private_mailbox_name => "", :pre_direction => "", :post_direction => "", :plus4 => "4534", :melissa_address_key_base => "", :melissa_address_key => "", :garbage => "", :delivery_point => "33618453411", :city => "Tampa", :address_type_code => "S", :address_type => "Street", :address_range => "2811", :address2 => "", :address => "2811 Safe Harbor Dr" } }
 ~~~
+
+## Customizing what is a good or bad address
+
+Melissa Data returns good and bad codes after verifying the address. 
+
+By default the following codes need to be returned before the address is considered valid: 
+- AS01 
+- AS02 
+- AS03
+
+To override these codes, set the `good_codes` value in secret config as a list of comma separated values:
+
+~~~yaml
+us_address_client:
+  url:          http://address.service.test.com
+  good_codes:   "AS01, AS02, AS03, AS20"
+~~~
+
+Even if a good code is returned, by default the following codes will force the result to be considered invalid: 
+- AC02
+- AC03 
+
+To override these codes, set the `bad_codes` value in secret config as a list of comma separated values:
+
+~~~yaml
+us_address_client:
+  url:          http://address.service.test.com
+  bad_codes:    "AS03, AS09, AS16, AS17, AS24, AE01, AE02, AE03, AE04, AE05, AE07, AE10, AE11, AE12, AE13, AE14"
+~~~

data/lib/us_address_client/client.rb

@@ -1,4 +1,5 @@
 require "date"
+require "sync_attr"
 
 module USAddressClient
   class Client
@@ -6,7 +7,6 @@ module USAddressClient
     # Once created a mutex is not used again since there is no writer accessor.
     sync_cattr_reader :http do
       OpinionatedHTTP.new(
-        header:               {"Content-Type" => "application/json"},
         secret_config_prefix: "us_address_client",
         metric_prefix:        "USAddressClient",
         logger:               USAddressClient.logger,
@@ -17,8 +17,8 @@ module USAddressClient
     def self.verify(input_address)
       return AddressMock.new(input_address) if USAddressClient.mocked?
 
-      response = http.get(action: "address", parameters: input_address)
-      hash     = Parser.parse_verify_response(response)
+      response = http.get(action: "address", parameters: input_address, headers: {"Content-Type" => "application/json"})
+      hash     = Parser.parse_verify_response(response.body!)
       USAddressClient.logger.trace(payload: hash)
       Address.new(hash, true)
     end
@@ -32,8 +32,8 @@ module USAddressClient
         }
       end
 
-      response = http.get(action: "version")
-      Parser.parse_version_response(response)
+      response = http.get(action: "version", headers: {"Content-Type" => "application/json"})
+      Parser.parse_version_response(response.body!)
     end
   end
 end

data/lib/us_address_client/version.rb

@@ -1,3 +1,3 @@
 module USAddressClient
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
 end

data/test/test_helper.rb

@@ -5,7 +5,6 @@ ENV["SECRET_CONFIG_PATH"] = "test"
 require "yaml"
 require "minitest/autorun"
 require "amazing_print"
-require "sync_attr"
 require "semantic_logger"
 require "us_address_client"
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: us_address_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opinionated_http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: secret_config
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: US Address Service Client