class FriendlyShipping::Services::Usps::ParseRateResponse

Constants

PACKAGE_NODE_XPATH
SERVICE_NODE_NAME

Public Class Methods

call(request:, response:, shipment:, options:) click to toggle source

Parse a response from USPS' rating API

@param [FriendlyShipping::Request] request The request that was used to obtain this Response @param [FriendlyShipping::Response] response The response that USPS returned @param [Physical::Shipment] shipment The shipment object we're trying to get results for @param [FriendlyShipping::Services::Usps::RateEstimateOptions] options The options we sent with this request @return [Result<ApiResult<Array<FriendlyShipping::Rate>>>] When successfully parsing, an array of rates in a Success Monad.

# File lib/friendly_shipping/services/usps/parse_rate_response.rb, line 21
def call(request:, response:, shipment:, options:)
  # Filter out error responses and directly return a failure
  parsing_result = ParseXMLResponse.call(
    request: request,
    response: response,
    expected_root_tag: 'RateV4Response'
  )
  parsing_result.fmap do |xml|
    # Get all the possible rates for each package
    rates_by_package = rates_from_response_node(xml, shipment, options)

    rates = SHIPPING_METHODS.map do |shipping_method|
      # For every package ...
      matching_rates = rates_by_package.map do |package, package_rates|
        # ... choose the rate that fits this package best.

        package_options = options.options_for_package(package)

        ChoosePackageRate.call(shipping_method, package_rates, package_options)
      end.compact # Some shipping rates are not available for every shipping method.

      # in this case, go to the next shipping method.
      next if matching_rates.empty?

      # return one rate for all packages with the amount keys being the package IDs.
      FriendlyShipping::Rate.new(
        amounts: matching_rates.map(&:amounts).reduce({}, :merge),
        shipping_method: shipping_method,
        data: matching_rates.first.data
      )
    end.compact

    ApiResult.new(
      rates,
      original_request: request,
      original_response: response
    )
  end
end

Private Class Methods

rates_from_response_node(xml, shipment, options) click to toggle source

Iterate over all packages and parse the rates for each package

@param [Nokogiri::XML::Node] xml The XML document containing packages and rates @param [Physical::Shipment] shipment The shipment we're trying to get rates for

@return [Hash<Physical::Package => Array<FriendlyShipping::Rate>>]

# File lib/friendly_shipping/services/usps/parse_rate_response.rb, line 72
def rates_from_response_node(xml, shipment, options)
  xml.xpath(PACKAGE_NODE_XPATH).each_with_object({}) do |package_node, result|
    package_id = package_node['ID']
    corresponding_package = shipment.packages[package_id.to_i]
    package_options = options.options_for_package(corresponding_package)
    # There should always be a package in the original shipment that corresponds to the package ID
    # in the USPS response.
    raise BoxNotFoundError if corresponding_package.nil?

    result[corresponding_package] = package_node.xpath(SERVICE_NODE_NAME).map do |service_node|
      ParsePackageRate.call(service_node, corresponding_package, package_options)
    end
  end
end