usps.rb in friendly_shipping-0.3.0

- old
+ new

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 require 'friendly_shipping/services/usps/client'
 require 'friendly_shipping/services/usps/shipping_methods'
+require 'friendly_shipping/services/usps/serialize_address_validation_request'
+require 'friendly_shipping/services/usps/serialize_city_state_lookup_request'
 require 'friendly_shipping/services/usps/serialize_rate_request'
+require 'friendly_shipping/services/usps/parse_address_validation_response'
+require 'friendly_shipping/services/usps/parse_city_state_lookup_response'
 require 'friendly_shipping/services/usps/parse_rate_response'
 
 module FriendlyShipping
   module Services
     class Usps
@@ -21,11 +25,13 @@
 
       TEST_URL = 'https://stg-secure.shippingapis.com/ShippingAPI.dll'
       LIVE_URL = 'https://secure.shippingapis.com/ShippingAPI.dll'
 
       RESOURCES = {
-        rates: 'RateV4',
+        address_validation: 'Verify',
+        city_state_lookup: 'CityStateLookup',
+        rates: 'RateV4'
       }.freeze
 
       def initialize(login:, test: true, client: Client)
         @login = login
         @test = test
@@ -49,15 +55,49 @@
       #   to get rates for.
       #
       # @return [Result<Array<FriendlyShipping::Rate>>] When successfully parsing, an array of rates in a Success Monad.
       #   When the parsing is not successful or USPS can't give us rates, a Failure monad containing something that
       #   can be serialized into an error message using `to_s`.
-      def rate_estimates(shipment, _carriers, shipping_method: nil)
-        rate_request_xml = SerializeRateRequest.call(shipment: shipment, login: login, shipping_method: shipping_method)
+      def rate_estimates(shipment, options = {})
+        rate_request_xml = SerializeRateRequest.call(shipment: shipment, login: login, shipping_method: options[:shipping_method])
         request = FriendlyShipping::Request.new(url: base_url, body: "API=#{RESOURCES[:rates]}&XML=#{CGI.escape rate_request_xml}")
 
         client.post(request).bind do |response|
           ParseRateResponse.call(response: response, request: request, shipment: shipment)
+        end
+      end
+
+      # Validate an address.
+      # @param [Physical::Location] location The address we want to verify
+      # @return [Result<ApiResult<Array<Physical::Location>>>] The response data from UPS encoded in a
+      #   `Physical::Location` object. Name and Company name are always nil, the
+      #   address lines will be made conformant to what USPS considers right. The returned location will
+      #   have the address_type set if possible.
+      def address_validation(location)
+        address_validation_request_xml = SerializeAddressValidationRequest.call(location: location, login: login)
+        request = FriendlyShipping::Request.new(
+          url: base_url,
+          body: "API=#{RESOURCES[:address_validation]}&XML=#{CGI.escape address_validation_request_xml}"
+        )
+
+        client.post(request).bind do |response|
+          ParseAddressValidationResponse.call(response: response, request: request)
+        end
+      end
+
+      # Find city and state for a given ZIP code
+      # @param [Physical::Location] location A location object with country and ZIP code set
+      # @return [Result<ApiResult<Array<Physical::Location>>>] The response data from USPS encoded in a
+      #   `Physical::Location` object. Country, City and ZIP code will be set, everything else nil.
+      def city_state_lookup(location)
+        city_state_lookup_request_xml = SerializeCityStateLookupRequest.call(location: location, login: login)
+        request = FriendlyShipping::Request.new(
+          url: base_url,
+          body: "API=#{RESOURCES[:city_state_lookup]}&XML=#{CGI.escape city_state_lookup_request_xml}"
+        )
+
+        client.post(request).bind do |response|
+          ParseCityStateLookupResponse.call(response: response, request: request)
         end
       end
 
       private
 