Sha256: 6ede39fcd1fa88a40690c941af3cf9a9a292947a0abf47dade09ddaaa20f4453

Contents?: true

Size: 1.27 KB

Versions: 21

Compression:

Stored size: 1.27 KB

Contents

module ActiveShipping

  # The `RateResponse` object is returned by the {ActiveShipping::Carrier#find_rates}
  # call. The most important method is {#rates}, which will return a list of possible
  # shipping options with an estimated price.
  #
  # @note Some carriers provide more information than others, so not all attributes
  #   will be set, depending on what carrier you are using.
  #
  # @!attribute rates
  #    The available rate options for the shipment, with an estimated price.
  #    @return [Array<ActiveShipping::RateEstimate>]
  class RateResponse < Response

    attr_reader :rates

    # Initializes a new RateResponse instance.
    #
    # @param success (see ActiveShipping::Response#initialize)
    # @param message (see ActiveShipping::Response#initialize)
    # @param params (see ActiveShipping::Response#initialize)
    # @option options (see ActiveShipping::Response#initialize)
    # @option options [Array<ActiveShipping::RateEstimate>] :rates The rate estimates to
    #   populate the {#rates} method with.
    def initialize(success, message, params = {}, options = {})
      @rates = Array(options[:estimates] || options[:rates] || options[:rate_estimates])
      super
    end

    alias_method :estimates, :rates
    alias_method :rate_estimates, :rates
  end
end

Version data entries

21 entries across 21 versions & 1 rubygems

Version Path
active_shipping-2.1.1 lib/active_shipping/rate_response.rb
active_shipping-2.1.0 lib/active_shipping/rate_response.rb
active_shipping-2.0.1 lib/active_shipping/rate_response.rb
active_shipping-2.0.0 lib/active_shipping/rate_response.rb
active_shipping-1.14.2 lib/active_shipping/rate_response.rb
active_shipping-1.14.1 lib/active_shipping/rate_response.rb
active_shipping-1.14.0 lib/active_shipping/rate_response.rb
active_shipping-1.13.4 lib/active_shipping/rate_response.rb
active_shipping-1.13.3 lib/active_shipping/rate_response.rb
active_shipping-1.13.2 lib/active_shipping/rate_response.rb
active_shipping-1.13.1 lib/active_shipping/rate_response.rb
active_shipping-1.13.0 lib/active_shipping/rate_response.rb
active_shipping-1.12.1 lib/active_shipping/rate_response.rb
active_shipping-1.12.0 lib/active_shipping/rate_response.rb
active_shipping-1.11.1 lib/active_shipping/rate_response.rb
active_shipping-1.11.0 lib/active_shipping/rate_response.rb
active_shipping-1.10.1 lib/active_shipping/rate_response.rb
active_shipping-1.9.2 lib/active_shipping/rate_response.rb
active_shipping-1.9.1 lib/active_shipping/rate_response.rb
active_shipping-1.9.0 lib/active_shipping/rate_response.rb