us_address_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b042f259b793875c82a530f33a50da311e319c87dc78af15e699e618388c95ba
+  data.tar.gz: 4444911ea6ed25edaf5b165b1f3bdad47a15fa993cc969d851dd0443a3ddd17f
+SHA512:
+  metadata.gz: 015420e49d95d20c0f64a754f01656bc22d9b6c25a26fc108cc18884a40bce5a16baf20448ee197de3359ecce2ee96f44138723989df58a45705cbf3328df893
+  data.tar.gz: 4258c022309fb3b69876f0cce661bcb245bc9eaa5184e1e7f729b93bde62ae23f2d8f12ad3980cad15b581f18d81303852b45594294799a6c407f0a8a6fb0b1c

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,165 @@
+# US Address Client
+
+Ruby Client to call the privately hosted US Postal Address Service to verify and cleanse addresses.
+
+## Status
+
+Not for production use. US Postal Address Service is not yet open source to be able to use this client.
+
+## Examples
+
+Verify and cleanse an address:
+~~~ruby
+address = USAddressClient.verify(address: "2811 Safe Harbor Drive", city: "Tampa", state: "FL", zip: "33618")
+# => #<USAddressClient::Address:0x00007feab8c06570 @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">
+  
+address.valid?
+# => true
+  
+address.city
+# => "Tampa"  
+  
+address.time_zone_offset
+# => 300
+  
+address.attributes
+# =>
+{
+                     :address => "2811 Safe Harbor Dr",
+                    :address2 => "",
+                       :suite => "",
+                        :city => "Tampa",
+                       :state => "FL",
+                         :zip => "33618",
+                       :plus4 => "4534",
+         :melissa_address_key => "",
+    :melissa_address_key_base => "",
+              :delivery_point => "33618453411",
+              :time_zone_code => "05",
+                   :time_zone => "Eastern Time",
+                :address_type => "Street",
+           :address_type_code => "S",
+                  :suite_name => "",
+                 :suite_range => "",
+               :address_range => "2811",
+               :pre_direction => "",
+              :post_direction => "",
+                 :street_name => "Safe Harbor",
+                      :suffix => "Dr",
+        :private_mailbox_name => "",
+      :private_mailbox_number => "",
+                     :garbage => "",
+                :result_codes => ["AS01"]
+}
+~~~
+
+Obtain Melissa Data Quality Suite version and licensing information:
+~~~ruby
+USAddressClient.version
+~~~
+
+Output:
+~~~ruby
+{
+    :license_expiration_date => Tue, 24 Sep 2019,
+          :initialize_status => "No error.",
+            :expiration_date => Thu, 31 Jan 2019,
+              :database_date => Mon, 15 Oct 2018,
+               :build_number => "3240"
+}
+~~~
+
+### Configuration
+
+Use Secret Config to supply the configuration settings for the Address Service. 
+`url` is mandatory, below are the default settings for the remaining values:
+
+~~~yaml
+us_address_client:
+  url:          http://address.service.test.com
+  pool_size:    100
+  open_timeout: 10
+  read_timeout: 10
+  idle_timeout: 300
+  keep_alive:   300
+  pool_timeout: 5
+  warn_timeout: 0.25
+  proxy:        :ENV
+  force_retry: true
+  mocked:      false
+~~~
+
+Mock out calls to Address Service:
+~~~yaml
+us_address_client:
+  mocked: true
+~~~
+
+#### 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
+
+The Address Service logs to `USAddressClient.logger`. The log level can be changed at any time to increase
+or decrease the logging output.
+
+Below is sample output for each log level setting.
+
+#### Info Logging
+
+~~~ruby
+USAddressClient.logger.level = :info
+~~~
+
+Output:
+
+~~~
+2018-12-19 19:30:05.257225 I [28643:70323013957920 client.rb:8] (7.351ms) USAddressClient -- #verify
+~~~
+
+#### Debug Logging
+
+~~~ruby
+USAddressClient.logger.level = :debug
+~~~
+
+Output:
+
+~~~
+2018-12-19 19:30:34.619759 D [28643:70323013957920 transport.rb:25] (8.319ms) USAddressClient -- #http_get -- { :path => "/address?address=2811+Safe+Harbor+Drive&city=Tampa&state=FL&zip=33618" }
+2018-12-19 19:30:34.620862 I [28643:70323013957920 client.rb:8] (9.562ms) 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" } }
+~~~
+
+#### Trace Logging
+
+~~~ruby
+USAddressClient.logger.level = :trace
+~~~
+
+With trace level logging PersistentHTTP and GenePool log messages are made available in the standard log files.
+
+Output:
+
+~~~
+2018-12-19 19:34:08.118208 T [28643:70323013957920 transport.rb:56] USAddressClient -- HTTP: Checkout connection HTTP:0.0.0.0:4000(70323063570580) self=connections=70323063570580 checked_out=70323063570580 with_map=
+2018-12-19 19:34:08.118455 T [28643:70323013957920 transport.rb:52] USAddressClient -- Conn close because of keep_alive_timeout
+2018-12-19 19:34:08.119208 T [28643:70323013957920 transport.rb:52] USAddressClient -- opening connection to 0.0.0.0:4000...
+2018-12-19 19:34:08.120509 T [28643:70323013957920 transport.rb:52] USAddressClient -- opened
+2018-12-19 19:34:08.121268 T [28643:70323013957920 transport.rb:52] USAddressClient -- <-
+2018-12-19 19:34:08.121478 T [28643:70323013957920 transport.rb:52] USAddressClient -- "GET /address?address=2811+Safe+Harbor+Drive&city=Tampa&state=FL&zip=33618 HTTP/1.1\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nUser-Agent: Ruby\r\nContent-Type: application/json\r\nConnection: keep-alive\r\nKeep-Alive: 300\r\nHost: 0.0.0.0:4000\r\n\r\n"
+2018-12-19 19:34:08.133798 T [28643:70323013957920 transport.rb:52] USAddressClient -- -> "HTTP/1.1 200 OK\r\n"
+2018-12-19 19:34:08.133938 T [28643:70323013957920 transport.rb:52] USAddressClient -- -> "cache-control: max-age=0, private, must-revalidate\r\n"
+2018-12-19 19:34:08.134063 T [28643:70323013957920 transport.rb:52] USAddressClient -- -> "content-length: 524\r\n"
+2018-12-19 19:34:08.134126 T [28643:70323013957920 transport.rb:52] USAddressClient -- -> "date: Wed, 19 Dec 2018 19:34:07 GMT\r\n"
+2018-12-19 19:34:08.134182 T [28643:70323013957920 transport.rb:52] USAddressClient -- -> "server: Cowboy\r\n"
+2018-12-19 19:34:08.134236 T [28643:70323013957920 transport.rb:52] USAddressClient -- -> "\r\n"
+2018-12-19 19:34:08.134361 T [28643:70323013957920 transport.rb:52] USAddressClient -- reading 524 bytes...
+2018-12-19 19:34:08.134422 T [28643:70323013957920 transport.rb:52] USAddressClient -- -> "{\"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\"}"
+2018-12-19 19:34:08.134470 T [28643:70323013957920 transport.rb:52] USAddressClient -- read 524 bytes
+2018-12-19 19:34:08.134537 T [28643:70323013957920 transport.rb:52] USAddressClient -- Conn keep-alive
+2018-12-19 19:34:08.134662 T [28643:70323013957920 transport.rb:56] USAddressClient -- HTTP: Checkin connection HTTP:0.0.0.0:4000(70323063570580) self=connections=70323063570580 checked_out= with_map=
+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" } }
+~~~

data/Rakefile

@@ -0,0 +1,25 @@
+# Setup bundler to avoid having to run bundle exec all the time.
+require "rubygems"
+require "bundler/setup"
+
+require "rake/testtask"
+require_relative "lib/us_address_client/version"
+
+task :gem do
+  system "gem build us_address_client.gemspec"
+end
+
+task publish: :gem do
+  system "git tag -a v#{USAddressClient::VERSION} -m 'Tagging #{USAddressClient::VERSION}'"
+  system "git push --tags"
+  system "gem push us_address_client-#{USAddressClient::VERSION}.gem"
+  system "rm us_address_client-#{USAddressClient::VERSION}.gem"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+  t.warning = false
+end
+
+task default: :test

data/lib/us_address_client/address.rb

@@ -0,0 +1,98 @@
+module USAddressClient
+  class Address
+    TIME_ZONES = {
+      "04" => "Atlantic/Bermuda",
+      "05" => "US/Eastern",
+      "06" => "US/Central",
+      "07" => "US/Mountain",
+      "08" => "US/Pacific",
+      "09" => "US/Alaska",
+      "10" => "US/Hawaii",
+      "11" => "US/Samoa",
+      "13" => "Pacific/Majuro",
+      "14" => "Pacific/Guam",
+      "15" => "Pacific/Palau"
+    }.freeze
+
+    # See  http://wiki.melissadata.com/index.php?title=Result_Code_Details#Address_Object
+    def good_codes
+      @good_codes ||= SecretConfig.fetch(
+        "us_address_client/good_codes",
+        default:   %w[AS01 AS02 AS03],
+        separator: ","
+      ).freeze
+    end
+
+    def bad_codes
+      @bad_codes ||= SecretConfig.fetch(
+        "us_address_client/bad_codes",
+        default:   %w[AC02 AC03],
+        separator: ","
+      ).freeze
+    end
+
+    ATTRIBUTES = %i[
+      address
+      address2
+      suite
+      city
+      state
+      zip
+      plus4
+      address_key
+      delivery_point
+      time_zone_code
+      time_zone
+      address_type
+      address_type_code
+      suite_name
+      suite_range
+      address_range
+      pre_direction
+      post_direction
+      street_name
+      suffix
+      private_mailbox_name
+      private_mailbox_number
+      garbage
+      result_codes
+    ].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    def initialize(attributes = {}, safe = false)
+      safe ? safe_assign_attributes(attributes) : self.attributes = attributes
+    end
+
+    # At least 1 good code and no bad codes
+    def valid?
+      (result_codes & good_codes).present? && (result_codes & bad_codes).empty?
+    end
+
+    def time_zone_offset
+      time_zone = TIME_ZONES[time_zone_code]
+      return unless time_zone
+
+      time_zone = "US/Arizona" if state == "AZ"
+      Time.now.in_time_zone(time_zone).utc_offset / -60
+    end
+
+    def attributes=(attributes)
+      attributes.each_pair { |key, value| public_send("#{key}=".to_sym, value) }
+    end
+
+    def attributes
+      ATTRIBUTES.each_with_object({}) { |key, attributes| attributes[key] = public_send(key) }
+    end
+
+    private
+
+    def safe_assign_attributes(attributes)
+      attributes.each_pair do |key, value|
+        next unless ATTRIBUTES.include?(key.to_sym)
+
+        public_send("#{key}=".to_sym, value)
+      end
+    end
+  end
+end

data/lib/us_address_client/address_mock.rb

@@ -0,0 +1,29 @@
+require "active_support"
+require "active_support/core_ext"
+
+module USAddressClient
+  class AddressMock < Address
+    def initialize(fields)
+      @result_codes   = ["AS01"]
+      @address_type   = "Street"
+      @time_zone_code = "05"
+      @plus4          = "1234"
+      super(fields)
+    end
+
+    def valid?
+      zip.present?
+    end
+
+    def delivery_point
+      return if zip.blank?
+
+      delivery_point_code = zip[3..5]
+      "#{zip}#{plus4}#{delivery_point_code}"
+    end
+
+    def address_key
+      delivery_point
+    end
+  end
+end

data/lib/us_address_client/client.rb

@@ -0,0 +1,39 @@
+require "date"
+
+module USAddressClient
+  class Client
+    # Ensure that only one instance is created by using a mutex.
+    # 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,
+        error_class:          ServiceError
+      )
+    end
+
+    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)
+      USAddressClient.logger.trace(payload: hash)
+      Address.new(hash, true)
+    end
+
+    def self.version
+      if USAddressClient.mocked?
+        return {
+          license_expiration_date: Date.today + 365,
+          expiration_date:         Date.today + 365,
+          mock:                    true
+        }
+      end
+
+      response = http.get(action: "version")
+      Parser.parse_version_response(response)
+    end
+  end
+end

data/lib/us_address_client/parser.rb

@@ -0,0 +1,28 @@
+require "date"
+module USAddressClient
+  class Parser
+    def self.parse_verify_response(response)
+      hash                = JSON.parse(response, symbolize_names: true)
+      hash[:result_codes] = hash[:result_codes].split(",") if hash.key?(:result_codes)
+      hash
+    rescue StandardError => e
+      message = "Invalid data returned from Address Service. #{e.class.name}: #{e.message}"
+      USAddressClient.logger.error(message: message, metric: "Supplier/USAddressClient/exception", exception: e, payload: hash)
+      raise(ServiceError, message)
+    end
+
+    def self.parse_version_response(response)
+      hash                           = JSON.parse(response, symbolize_names: true)
+      hash[:database_date]           = Date.parse(hash[:database_date])
+      # Date when the current U.S. data files expire. This date enables you to confirm that the
+      # data files you are using are the latest available.
+      hash[:expiration_date]         = Date.strptime(hash[:expiration_date], "%m-%d-%Y")
+      hash[:license_expiration_date] = Date.parse(hash[:license_expiration_date])
+      hash
+    rescue StandardError => e
+      message = "Invalid data returned from Address Service#verify. #{e.class.name}: #{e.message}"
+      USAddressClient.logger.error(message: message, metric: "Supplier/USAddressClient/exception", exception: e, payload: hash)
+      raise(ServiceError, message)
+    end
+  end
+end

data/lib/us_address_client/service_error.rb

@@ -0,0 +1,4 @@
+module USAddressClient
+  class ServiceError < StandardError
+  end
+end

data/lib/us_address_client/version.rb

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

data/lib/us_address_client.rb

@@ -0,0 +1,36 @@
+require "us_address_client/version"
+require "opinionated_http"
+require "secret_config"
+module USAddressClient
+  autoload :Address, "us_address_client/address"
+  autoload :AddressMock, "us_address_client/address_mock"
+  autoload :Client, "us_address_client/client"
+  autoload :Parser, "us_address_client/parser"
+  autoload :ServiceError, "us_address_client/service_error"
+
+  include SemanticLogger::Loggable
+
+  # Verify, and cleanse the address, also returning the delivery_point.
+  #
+  # Example:
+  #   USAddressClient.verify(address: "2811 Safe Harbor Drive", city: "Tampa", state: "FL", zip: "33618")
+  def self.verify(address)
+    Client.verify(address)
+  rescue ServiceError
+    # Fallback to no delivery_point and continue processing as though the address was not matched.
+    Address.new(address, true)
+  end
+
+  # Returns version and license information from the Address Service.
+  #
+  # Example:
+  #   USAddressClient.version
+  def self.version
+    Client.version
+  end
+
+  # Returns whether to use mocked calls for address verification.
+  def self.mocked?
+    SecretConfig.fetch("us_address_client/mocked", type: :boolean, default: false)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+ENV["TZ"]                 = "UTC"
+ENV["SECRET_CONFIG_PATH"] = "test"
+
+require "yaml"
+require "minitest/autorun"
+require "amazing_print"
+require "sync_attr"
+require "semantic_logger"
+require "us_address_client"
+
+SemanticLogger.add_appender(file_name: "test.log", formatter: :color)
+SemanticLogger.default_level = :debug

data/test/us_address_client_test.rb

@@ -0,0 +1,42 @@
+require "net/http"
+require "json"
+require_relative "test_helper"
+
+class USAddressClientTest < Minitest::Test
+  describe USAddressClient do
+    it "successful verify" do
+      address  = {address: "2811 Safe Harbor Dr", city: "Tampa", state: "FL", zip: "33618"}
+      body     = address.to_json
+      response = stub_request(Net::HTTPSuccess, 200, "OK", body) do
+        USAddressClient.verify(address)
+      end
+      expected = USAddressClient::Address.new(address: "2811 Safe Harbor Dr", city: "Tampa", state: "FL", zip: "33618")
+      assert_equal expected.attributes, response.attributes
+    end
+
+    it "failed verify" do
+      address  = {address: "2811 Safe Harbor Dr", city: "Tampa", state: "FL", zip: "33618"}
+      response = stub_request(Net::HTTPInternalServerError, 500, "ERROR", "") do
+        USAddressClient.verify(address)
+      end
+      expected = USAddressClient::Address.new(address: "2811 Safe Harbor Dr", city: "Tampa", state: "FL", zip: "33618")
+      assert_equal expected.attributes, response.attributes
+    end
+
+    it "successful version" do
+      response = USAddressClient::Client.version
+      assert response[:mock]
+      assert response[:license_expiration_date]
+      assert response[:expiration_date]
+    end
+
+    def stub_request(klass, code, msg, body, &block)
+      response = klass.new("1.1", code, msg)
+      response.stub(:body, body) do
+        USAddressClient.stub(:mocked?, false) do
+          USAddressClient::Client.http.driver.stub(:request, response, &block)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: us_address_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Reid Morrison
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-10 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: secret_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sync_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: US Address Client that calls the privately hosted US Address Service
+  that calls Melissa Data Address Object
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/us_address_client.rb
+- lib/us_address_client/address.rb
+- lib/us_address_client/address_mock.rb
+- lib/us_address_client/client.rb
+- lib/us_address_client/parser.rb
+- lib/us_address_client/service_error.rb
+- lib/us_address_client/version.rb
+- test/test_helper.rb
+- test/us_address_client_test.rb
+homepage: https://github.com/reidmorrison/us_address_client
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: US Address Service Client
+test_files:
+- test/test_helper.rb
+- test/us_address_client_test.rb