lib/friendly_shipping/services/ups.rb in friendly_shipping-0.2.6 vs lib/friendly_shipping/services/ups.rb in friendly_shipping-0.3.0

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 require 'dry/monads/result'
 require 'friendly_shipping/services/ups/client'
 require 'friendly_shipping/services/ups/serialize_access_request'
+require 'friendly_shipping/services/ups/serialize_city_state_lookup_request'
+require 'friendly_shipping/services/ups/serialize_address_validation_request'
 require 'friendly_shipping/services/ups/serialize_rating_service_selection_request'
+require 'friendly_shipping/services/ups/parse_address_validation_response'
+require 'friendly_shipping/services/ups/parse_city_state_lookup_response'
 require 'friendly_shipping/services/ups/parse_rate_response'
 require 'friendly_shipping/services/ups/shipping_methods'
 
 module FriendlyShipping
   module Services
@@ -23,10 +27,12 @@
 
       TEST_URL = 'https://wwwcie.ups.com'
       LIVE_URL = 'https://onlinetools.ups.com'
 
       RESOURCES = {
+        address_validation: '/ups.app/xml/XAV',
+        city_state_lookup: '/ups.app/xml/AV',
         rates: '/ups.app/xml/Rate'
       }.freeze
 
       def initialize(key:, login:, password:, test: true, client: Client)
         @key = key
@@ -38,19 +44,59 @@
 
       def carriers
         Success([CARRIER])
       end
 
-      def rate_estimates(shipment, _carriers)
+      # Get rates for a shipment
+      # @param [Physical::Shipment] location The shipment we want to get rates for
+      # @return [Result<ApiResult<Array<Rate>>>] The rates returned from UPS encoded in a
+      #   `FriendlyShipping::ApiResult` object.
+      def rate_estimates(shipment, _options = {})
         rate_request_xml = SerializeRatingServiceSelectionRequest.call(shipment: shipment)
         url = base_url + RESOURCES[:rates]
         request = FriendlyShipping::Request.new(
           url: url,
           body: access_request_xml + 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 UPS 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)
+        url = base_url + RESOURCES[:address_validation]
+        request = FriendlyShipping::Request.new(
+          url: url,
+          body: access_request_xml + 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 UPS 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)
+        url = base_url + RESOURCES[:city_state_lookup]
+        request = FriendlyShipping::Request.new(
+          url: url,
+          body: access_request_xml + city_state_lookup_request_xml
+        )
+
+        client.post(request).bind do |response|
+          ParseCityStateLookupResponse.call(response: response, request: request, location: location)
         end
       end
 
       private