active_shipping 1.0.0.pre2 → 1.0.0.pre3

data/lib/active_shipping/label_response.rb

@@ -1,7 +1,7 @@
 module ActiveShipping
+
   # This is UPS specific for now; the hash is not at all generic
   # or common between carriers.
-
   class LabelResponse < Response
     attr :params # maybe?
 

data/lib/active_shipping/rate_estimate.rb

@@ -1,18 +1,64 @@
-module ActiveShipping #:nodoc:
+module ActiveShipping
+
+  # Class representing a shipping option with estimated price.
+  #
+  # @!attribute origin
+  #   The origin of the shipment
+  #   @return [ActiveShipping::Location]
+  #
+  # @!attribute desination
+  #   The desination of the shipment
+  #   @return [ActiveShipping::Location]
+  #
+  # @!attribute package_rates
+  #   A list of rates for all the packages in the shipment.
+  #   @return [Array<{:rate => Integer, :package => ActiveShipping::Package}>]
+  #
+  # @!attribute carrier
+  #   The name of the carrier (i.e. , e.g. 'USPS', 'FedEx')
+  #   @return [String]
+  #   @see ActiveShipping::Carrier.name
+  #
+  # @!attribute service_name
+  #   The name of the shipping service (e.g. `"First Class Ground"`)
+  #   @return [String]
+  #
+  # @!attribute service_code
+  #   The code of the shipping service
+  #   @return [String]
+  #
+  # @!attribute shipping_date
+  #   The date on which the shipment will be expected. Normally, this means that the
+  #   delivery date range can only pe prmoised if the shipment is handed over on or
+  #   before this date.
+  #   @return [Date]
+  #
+  # @!attribute delivery_date
+  #   The date on which the shipment will be delivered. This is usually only availablee
+  #   for express shipments; in order cases a {#delivery_range} is given instead.
+  #   @return [Date]
+  #
+  # @!attribute delivery_range
+  #   The minimum and maximum date of when the shipment is expected to be delivered.
+  #   @return [Array<Date>]
+  #
+  # @!attribute currency
+  #   ISO4217 currency code of the quoted rate estimates, e.g. `CAD`, `EUR`, or `USD`.
+  #   @return [String]
+  #   @see http://en.wikipedia.org/wiki/ISO_4217
+  #
+  # @!attribute negotiated_rate
+  #   The negotiated rate in cents
+  #   @return [Integer]
+  #
+  # @!attribute insurance_price
+  #   The price of insurance in cents.
+  #   @return [Integer]
   class RateEstimate
-    attr_reader :origin         # Location objects
-    attr_reader :destination
-    attr_reader :package_rates  # array of hashes in the form of {:package => <Package>, :rate => 500}
-    attr_reader :carrier        # Carrier.name ('USPS', 'FedEx', etc.)
-    attr_reader :service_name   # name of service ("First Class Ground", etc.)
-    attr_reader :service_code
-    attr_reader :currency       # 'USD', 'CAD', etc.
-    # http://en.wikipedia.org/wiki/ISO_4217
-    attr_reader :shipping_date
-    attr_reader :delivery_date  # Usually only available for express shipments
-    attr_reader :delivery_range # Min and max delivery estimate in days
-    attr_reader :negotiated_rate
-    attr_reader :insurance_price
+    attr_reader :origin, :destination, :package_rates,
+                :carrier, :service_name, :service_code,
+                :shipping_date, :delivery_date, :delivery_range,
+                :currency, :negotiated_rate, :insurance_price
 
     def initialize(origin, destination, carrier, service_name, options = {})
       @origin, @destination, @carrier, @service_name = origin, destination, carrier, service_name
@@ -31,13 +77,20 @@ module ActiveShipping #:nodoc:
       @insurance_price = Package.cents_from(options[:insurance_price])
     end
 
+    # The total price of the shipments in cents.
+    # @return [Integer]
     def total_price
-      @total_price || @package_rates.sum { |p| p[:rate] }
+      @total_price || @package_rates.sum { |pr| pr[:rate] }
     rescue NoMethodError
       raise ArgumentError.new("RateEstimate must have a total_price set, or have a full set of valid package rates.")
     end
     alias_method :price, :total_price
 
+    # Adds a package to this rate estimate
+    # @param package [ActiveShipping::Package] The package to add.
+    # @param rate [#cents, Float, String, nil] The rate for this package. This is only required if
+    #   there is no total price for this shipment
+    # @return [self]
     def add(package, rate = nil)
       cents = Package.cents_from(rate)
       raise ArgumentError.new("New packages must have valid rate information since this RateEstimate has no total_price set.") if cents.nil? and total_price.nil?
@@ -45,16 +98,24 @@ module ActiveShipping #:nodoc:
       self
     end
 
+    # The list of packages for which rate estimates are given.
+    # @return [Array<ActiveShipping::Package>]
     def packages
       package_rates.map { |p| p[:package] }
     end
 
+    # The number of packages for which rate estimates are given.
+    # @return [Integer]
     def package_count
       package_rates.length
     end
 
     private
 
+    # Returns a Date object for a given input
+    # @param [String, Date, Time, DateTime, ...] The object to infer a date from.
+    # @return [Date, nil] The Date object absed on the input, or `nil` if no date
+    #   could be determined.
     def date_for(date)
       date && DateTime.strptime(date.to_s, "%Y-%m-%d")
     rescue ArgumentError

data/lib/active_shipping/rate_response.rb

@@ -1,7 +1,27 @@
 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 ane stiated price.
+  #
+  # @note Some carriers provide more information that 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

data/lib/active_shipping/response.rb

@@ -15,6 +15,7 @@ module ActiveShipping #:nodoc:
     end
   end
 
+  # Basic Response class for requests against a carrier's API.
   class Response
     attr_reader :params
     attr_reader :message
@@ -22,6 +23,16 @@ module ActiveShipping #:nodoc:
     attr_reader :xml
     attr_reader :request
 
+    # @param success [Boolean] Whether the request was considered successful, i.e. this
+    #   response object will have the expected data set.
+    # @param message [String] A status message. Usuaully set when `success` is `false`,
+    #   but can also be set for successful responses.
+    # @param params [Hash] Response parameters
+    # @param options [Hash]
+    # @option options [Boolean] :test (default: false) Whether this reponse was a result
+    #   of a request executed against the sandbox or test environment of the carrier's API.
+    # @option options [String] :xml The raw XML of the response.
+    # @option options [String] :request The payload of the request.
     def initialize(success, message, params = {}, options = {})
       @success, @message, @params = success, message, params.stringify_keys
       @test = options[:test] || false
@@ -30,10 +41,16 @@ module ActiveShipping #:nodoc:
       raise ResponseError.new(self) unless success
     end
 
+    # Whether the request was executed successfully or not.
+    # @return [Boolean] Should only return `true` if the attributes of teh response
+    #   instance are set with useful values.
     def success?
       @success ? true : false
     end
 
+    # Whether this request was executed against the sandbox or test environment instead of
+    # the production environment of the carrier.
+    # @return [Boolean]
     def test?
       @test ? true : false
     end

data/lib/active_shipping/shipment_packer.rb

@@ -7,8 +7,8 @@ module ActiveShipping
     class ExcessPackageQuantity < StandardError; end
 
     # items           - array of hashes containing quantity, grams and price.
-    #                   ex. [{:quantity => 2, :price => 1.0, :grams => 50}]
-    # dimensions      - [5.0, 15.0, 30.0]
+    #                   ex. `[{:quantity => 2, :price => 1.0, :grams => 50}]`
+    # dimensions      - `[5.0, 15.0, 30.0]`
     # maximum_weight  - maximum weight in grams
     # currency        - ISO currency code
     def self.pack(items, dimensions, maximum_weight, currency)

data/lib/active_shipping/shipping_response.rb

@@ -1,8 +1,30 @@
 module ActiveShipping
+
+  # Responce object class for calls to {ActiveShipping::Carrier#create_shipment}.
+  #
+  # @note Some carriers provide more information that others, so not all attributes
+  #   will be set, depending on what carrier you are using.
+  #
+  # @!attribute shipping_id
+  #   The unique identifier of the shipment, which can be used to further interact
+  #   with the carrier's API.
+  #   @return [String]
+  #
+  # @!attribute tracking_number
+  #   The tracking number of the shipments, witch can be shared with the customer and
+  #   be used for {ActiveShipping::Carrier#find_tracking_info}.
+  #   @return [String]
   class ShippingResponse < Response
-    attr_reader :shipping_id # string
-    attr_reader :tracking_number # string
+    attr_reader :shipping_id, :tracking_number
 
+    # Initializes a new ShippingResponse 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 [String] :shipping_id Populates {#shipping_id}.
+    # @option options [String] :tracking_number Populates {#tracking_number}.
     def initialize(success, message, params = {}, options = {})
       @shipping_id = options[:shipping_id]
       @tracking_number = options[:tracking_number]

data/lib/active_shipping/tracking_response.rb

@@ -1,18 +1,59 @@
 module ActiveShipping
+
+  # Represents the response to a {ActiveShipping::Carrier#find_tracking_info} call.
+  #
+  # @note Some carriers provide more information that others, so not all attributes
+  #   will be set, depending on what carrier you are using.
+  #
+  # @!attribute carrier
+  #   @return [Symbol]
+  #
+  # @!attribute carrier_name
+  #   @return [String]
+  #
+  # @!attribute status
+  #   @return [Symbol]
+  #
+  # @!attribute status_code
+  #   @return [string]
+  #
+  # @!attribute status_description
+  #   @return [String]
+  #
+  # @!attribute ship_time
+  #   @return [Date, Time]
+  #
+  # @!attribute scheduled_delivery_date
+  #   @return [Date, Time]
+  #
+  # @!attribute actual_delivery_date
+  #   @return [Date, Time]
+  #
+  # @!attribute delivery_signature
+  #   @return [String]
+  #
+  # @!attribute tracking_number
+  #   @return [String]
+  #
+  # @!attribute shipment_events
+  #   @return [Array<ActiveShipping::ShipmentEvent>]
+  #
+  # @!attribute shipper_address
+  #   @return [ActiveShipping::Location]
+  #
+  # @!attribute origin
+  #   @return [ActiveShipping::Location]
+  #
+  # @!attribute destination
+  #   @return [ActiveShipping::Location]
   class TrackingResponse < Response
-    attr_reader :carrier # symbol
-    attr_reader :carrier_name # string
-    attr_reader :status # symbol
-    attr_reader :status_code # string
-    attr_reader :status_description # string
-    attr_reader :ship_time # time
-    attr_reader :scheduled_delivery_date # time
-    attr_reader :actual_delivery_date # time
-    attr_reader :delivery_signature # string
-    attr_reader :tracking_number # string
-    attr_reader :shipment_events # array of ShipmentEvents in chronological order
-    attr_reader :shipper_address, :origin, :destination # Location objects
+    attr_reader :carrier,:carrier_name,
+                :status,:status_code, :status_description,
+                :ship_time, :scheduled_delivery_date, :actual_delivery_date,
+                :delivery_signature, :tracking_number, :shipment_events,
+                :shipper_address, :origin, :destination
 
+    # @params (see ActiveShipping::Response#initialize)
     def initialize(success, message, params = {}, options = {})
       @carrier = options[:carrier].parameterize.to_sym
       @carrier_name = options[:carrier]
@@ -31,22 +72,29 @@ module ActiveShipping
       super
     end
 
+    # The latest tracking event for this shipment, i.e. the current status.
+    # @return [ActiveShipping::ShipmentEvent]
     def latest_event
       @shipment_events.last
     end
 
+    # Returns `true` if something the shipment has arrived at the destination.
+    # @return [Boolean]
     def is_delivered?
       @status == :delivered
     end
 
+    # Returns `true` if something out of the ordinary has happened during
+    # the delivery of this package.
+    # @return [Boolean]
     def has_exception?
       @status == :exception
     end
 
-    alias_method(:exception_event, :latest_event)
-    alias_method(:delivered?, :is_delivered?)
-    alias_method(:exception?, :has_exception?)
-    alias_method(:scheduled_delivery_time, :scheduled_delivery_date)
-    alias_method(:actual_delivery_time, :actual_delivery_date)
+    alias_method :exception_event, :latest_event
+    alias_method :delivered?, :is_delivered?
+    alias_method :exception?, :has_exception?
+    alias_method :scheduled_delivery_time, :scheduled_delivery_date
+    alias_method :actual_delivery_time, :actual_delivery_date
   end
 end

data/lib/active_shipping/version.rb

@@ -1,3 +1,3 @@
 module ActiveShipping
-  VERSION = "1.0.0.pre2"
+  VERSION = "1.0.0.pre3"
 end

data/shipit.rubygems.yml

@@ -0,0 +1 @@
+# using the default shipit config

data/test/credentials.yml

@@ -0,0 +1,47 @@
+usps:
+  login: APIKey
+ups:
+  key: XmlAccessKey
+  login: UPSDotComLogin
+  password: UPSDotComPassword
+
+fedex:
+  account: FedExAccountNumber
+  login: FedExMeterNumber
+  password: FedExMeterPassword
+  test: true
+  key: FedExDeveloperKey
+
+fedex_freight:
+  account: FedExFreightAccountNumber
+  shipping_address1: FedExShippingAddress1
+  shipping_address2: FedExShippingAddress2
+  shipping_city: FedExShippingCity
+  shipping_postal_code: FedExShippingPostalCode
+  shipping_state: FedExShippingState
+  shipping_country: FedExShippingCountry
+  billing_address1: FedExBillingAddress1
+  billing_address2: FedExBillingAddress2
+  billing_city: FedExBillingCity
+  billing_postal_code: FedExBillingPostalCode
+  billing_state: FedExBillingState
+  billing_country: FedExBillingCountry
+  payment_type: SENDER
+  freight_class: CLASS_050
+  packaging: PALLET
+  role: SHIPPER
+
+shipwire:
+  login: EmailAddress
+  password: Password
+
+canada_post:
+  login: CPC_DEMO_XML
+
+new_zealand_post:
+  key: '4d9dc0f0-dda0-012e-066f-000c29b44ac0'
+
+canada_post_pws:
+  platform_id: 12345678
+  api_key: 1234789
+  secret: 1245743

data/test/fixtures/json/newzealandpost/domestic_book.json

@@ -0,0 +1 @@
+{"courier_defaulting_to_nationwide":false,"post_defaulting_to_nationwide":false,"post_large_delivery_type":"within_island","info":{"lat_long_src":"-41.2829189300537,174.7841796875","dimensions":"Weight 0.25kg; Volumetric Weight 0.1064kg; 190.0x140.0x20.0","resolved_postcode_dest":"1010","resolved_postcode_src":"6011","resolved_dest_txt":"1010","lat_long_dest":"-36.8051338195801,174.981109619141","resolved_source_txt":"6011"},"products":[{"size":"C5","cost":"3.00","code":"PKTC5","image_url":null,"product_url":null,"delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"165*235*70 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=5-c5-PKTC5","service_code":"PKPC5","height":165,"service_group_description":"ParcelPost","packaging":"postage_only","speed_description":"1 - 3 working days","length":235,"description":"C5 Postage Only","width":70},{"size":"C5","cost":"3.60","code":"PKTC5,PKTEF","image_url":null,"product_url":null,"delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"165*235*70 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=6-c5-PKTC5,PKTEF","service_code":"PKFC5","height":165,"service_group_description":"ParcelPost Fast","packaging":"postage_only","speed_description":"Next working day","length":235,"description":"C5 Postage Only","width":70},{"size":"C5","cost":"4.00","code":"PIKFC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2086/pikfc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/13-c5-PIKFC5","delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost","packaging":"flat","speed_description":"1 - 3 working days","length":270,"description":"C5 Flat Bag","width":null},{"size":"C5","cost":"4.20","code":"PCB3C5","image_url":null,"product_url":null,"delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"165*235*70 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=21-c5-PCB3C5","service_code":"PCM3C5","height":165,"service_group_description":"ParcelPost Tracked","packaging":"postage_only","speed_description":"1 - 3 working days","length":235,"description":"C5 Postage Only - Tracked","width":70},{"size":"C5","cost":"4.50","code":"PIFFC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2090/piffc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/15-c5-PIFFC5","delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Fast","packaging":"flat","speed_description":"Next working day","length":270,"description":"C5 Flat Bag","width":null},{"size":"C5","cost":"4.50","code":"PIKBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2088/pikbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/14-c5-PIKBC5","delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost","packaging":"bubble","speed_description":"1 - 3 working days","length":270,"description":"C5 Bubble Bag","width":null},{"size":"C5","cost":"5.00","code":"PICFC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2095/picfc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/26-c5-PICFC5","delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"185*270* 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Tracked","packaging":"flat","speed_description":"1 - 3 working days","length":270,"description":"C5 Flat Bag - Tracked","width":null},{"size":"C5","cost":"5.00","code":"PIFBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2092/pifbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/16-c5-PIFBC5","delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Fast","packaging":"bubble","speed_description":"Next working day","length":270,"description":"C5 Bubble Bag","width":null},{"size":"C5","cost":"5.50","code":"PICBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2099/picbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/27-c5-PICBC5","delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"185*270* 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Tracked","packaging":"bubble","speed_description":"1 - 3 working days","length":270,"description":"C5 Bubble Bag - Tracked","width":null},{"size":"C5","cost":"6.55","code":"NZPROA5","image_url":null,"product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/44-c5-NZPROA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":false,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"flat","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Flat Bag","width":null},{"size":"C5","cost":"7.15","code":"NZPRBA5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2040/nzprba5.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/46-c5-NZPRBA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":false,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"bubble","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Bubble Bag","width":null},{"size":"C5","cost":"8.80","code":"NZSROA5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2039/nzproa5.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/45-c5-NZSROA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":true,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"flat","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Flat Bag S/R","width":null},{"size":"C5","cost":"8.90","code":"NZSRBA5","image_url":null,"product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/47-c5-NZSRBA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":true,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"bubble","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Bubble Bag S/R","width":null}],"courier_large_delivery_type":null,"status":"success"}

data/test/fixtures/json/newzealandpost/domestic_default.json

@@ -0,0 +1 @@
+{"courier_defaulting_to_nationwide":false,"post_defaulting_to_nationwide":false,"post_large_delivery_type":"within_island","info":{"lat_long_src":"-41.2829189300537,174.7841796875","dimensions":"Weight 0.0kg; Volumetric Weight 0.0kg; 0.0x0.0x0.0","resolved_postcode_dest":"1010","resolved_postcode_src":"6011","resolved_dest_txt":"1010","lat_long_dest":"-36.8051338195801,174.981109619141","resolved_source_txt":"6011"},"products":[{"size":"DLE","cost":"2.40","code":"PKTDLE","image_url":null,"product_url":null,"delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"130*235*70 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=1-dle-PKTDLE","service_code":"PKPDLE","height":130,"service_group_description":"ParcelPost","packaging":"postage_only","speed_description":"1 - 3 working days","length":235,"description":"DLE Postage Only","width":70},{"size":"DLE","cost":"3.00","code":"PKTDLE,PKTEF","image_url":null,"product_url":null,"delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"130*235*70 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=2-dle-PKTDLE,PKTEF","service_code":"PKFDLE","height":130,"service_group_description":"ParcelPost Fast","packaging":"postage_only","speed_description":"Next working day","length":235,"description":"DLE Postage Only","width":70},{"size":"C5","cost":"4.00","code":"PIKFC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2086/pikfc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/13-c5-PIKFC5","delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost","packaging":"flat","speed_description":"1 - 3 working days","length":270,"description":"C5 Flat Bag","width":null},{"size":"C5","cost":"4.20","code":"PCB3C5","image_url":null,"product_url":null,"delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"165*235*70 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=21-c5-PCB3C5","service_code":"PCM3C5","height":165,"service_group_description":"ParcelPost Tracked","packaging":"postage_only","speed_description":"1 - 3 working days","length":235,"description":"C5 Postage Only - Tracked","width":70},{"size":"DLE","cost":"4.50","code":"PICFDLE","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2094/picfdle_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/25-dle-PICFDLE","delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"125*230* 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":125,"service_group_description":"ParcelPost Tracked","packaging":"flat","speed_description":"1 - 3 working days","length":230,"description":"DLE Flat Bag - Tracked","width":null},{"size":"C5","cost":"4.50","code":"PIFFC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2090/piffc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/15-c5-PIFFC5","delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Fast","packaging":"flat","speed_description":"Next working day","length":270,"description":"C5 Flat Bag","width":null},{"size":"C5","cost":"4.50","code":"PIKBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2088/pikbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/14-c5-PIKBC5","delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost","packaging":"bubble","speed_description":"1 - 3 working days","length":270,"description":"C5 Bubble Bag","width":null},{"size":"C5","cost":"5.00","code":"PIFBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2092/pifbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/16-c5-PIFBC5","delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Fast","packaging":"bubble","speed_description":"Next working day","length":270,"description":"C5 Bubble Bag","width":null},{"size":"C5","cost":"5.50","code":"PICBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2099/picbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/27-c5-PICBC5","delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"185*270* 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Tracked","packaging":"bubble","speed_description":"1 - 3 working days","length":270,"description":"C5 Bubble Bag - Tracked","width":null},{"size":"DLE","cost":"5.89","code":"NZPRODL","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2037/nzprodl.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/42-dle-NZPRODL","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"130*240* 3000gms","priority":"courier","signature":false,"carrier":"courierpost","label_url":null,"service_code":null,"height":130,"service_group_description":"Courier","packaging":"flat","speed_description":"Next working day","length":240,"description":"DLE Ready To Go Courier Flat Bag","width":null},{"size":"C5","cost":"7.15","code":"NZPRBA5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2040/nzprba5.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/46-c5-NZPRBA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":false,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"bubble","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Bubble Bag","width":null},{"size":"DLE","cost":"8.30","code":"NZSRODL","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2038/nzprodl.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/43-dle-NZSRODL","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"130*240* 3000gms","priority":"courier","signature":true,"carrier":"courierpost","label_url":null,"service_code":null,"height":130,"service_group_description":"Courier","packaging":"flat","speed_description":"Next working day","length":240,"description":"DLE Ready To Go Courier Flat Bag S/R","width":null},{"size":"C5","cost":"8.90","code":"NZSRBA5","image_url":null,"product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/47-c5-NZSRBA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":true,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"bubble","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Bubble Bag S/R","width":null}],"courier_large_delivery_type":null,"status":"success"}

data/test/fixtures/json/newzealandpost/domestic_error.json

@@ -0,0 +1 @@
+{"errors":["Weight can only be between 0 and 25kg"],"message":"Weight can only be between 0 and 25kg","status":"failure"}

data/test/fixtures/json/newzealandpost/domestic_poster.json

@@ -0,0 +1 @@
+{"courier_defaulting_to_nationwide":false,"post_defaulting_to_nationwide":false,"post_large_delivery_type":"within_island","info":{"lat_long_src":"-41.2829189300537,174.7841796875","dimensions":"Weight 0.1kg; Volumetric Weight 0.0kg; 930.0x0.0x0.0","resolved_postcode_dest":"1010","resolved_postcode_src":"6011","resolved_dest_txt":"1010","lat_long_dest":"-36.8051338195801,174.981109619141","resolved_source_txt":"6011"},"products":[{"size":null,"cost":"7.50","code":"PCBWI","image_url":null,"product_url":null,"delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked_zonal","weight":25.0,"product_max_dimensions":"15000*15000*15000 25000gms","priority":"parcel_post_tracked_zonal","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=37--PCBWI","service_code":"PCMW5","height":15000,"service_group_description":"ParcelPost Tracked Zonal","packaging":"postage_only","speed_description":"1 - 2 working days","length":15000,"description":"Postage Only - Zonal - Within Island - Tracked","width":15000}],"courier_large_delivery_type":null,"status":"success"}

data/test/fixtures/json/newzealandpost/domestic_small_half_pound.json

@@ -0,0 +1 @@
+{"courier_defaulting_to_nationwide":false,"post_defaulting_to_nationwide":false,"post_large_delivery_type":"within_island","info":{"lat_long_src":"-41.2829189300537,174.7841796875","dimensions":"Weight 0.226796185kg; Volumetric Weight 0.0032774128kg; 25.4x25.4x25.4","resolved_postcode_dest":"1010","resolved_postcode_src":"6011","resolved_dest_txt":"1010","lat_long_dest":"-36.8051338195801,174.981109619141","resolved_source_txt":"6011"},"products":[{"size":"DLE","cost":"2.40","code":"PKTDLE","image_url":null,"product_url":null,"delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"130*235*70 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=1-dle-PKTDLE","service_code":"PKPDLE","height":130,"service_group_description":"ParcelPost","packaging":"postage_only","speed_description":"1 - 3 working days","length":235,"description":"DLE Postage Only","width":70},{"size":"DLE","cost":"3.00","code":"PKTDLE,PKTEF","image_url":null,"product_url":null,"delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"130*235*70 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=2-dle-PKTDLE,PKTEF","service_code":"PKFDLE","height":130,"service_group_description":"ParcelPost Fast","packaging":"postage_only","speed_description":"Next working day","length":235,"description":"DLE Postage Only","width":70},{"size":"C5","cost":"4.00","code":"PIKFC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2086/pikfc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/13-c5-PIKFC5","delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost","packaging":"flat","speed_description":"1 - 3 working days","length":270,"description":"C5 Flat Bag","width":null},{"size":"C5","cost":"4.20","code":"PCB3C5","image_url":null,"product_url":null,"delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"165*235*70 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":"https://www.nzpost.co.nz/cart/checkout?code=21-c5-PCB3C5","service_code":"PCM3C5","height":165,"service_group_description":"ParcelPost Tracked","packaging":"postage_only","speed_description":"1 - 3 working days","length":235,"description":"C5 Postage Only - Tracked","width":70},{"size":"DLE","cost":"4.50","code":"PICFDLE","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2094/picfdle_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/25-dle-PICFDLE","delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"125*230* 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":125,"service_group_description":"ParcelPost Tracked","packaging":"flat","speed_description":"1 - 3 working days","length":230,"description":"DLE Flat Bag - Tracked","width":null},{"size":"C5","cost":"4.50","code":"PIFFC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2090/piffc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/15-c5-PIFFC5","delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Fast","packaging":"flat","speed_description":"Next working day","length":270,"description":"C5 Flat Bag","width":null},{"size":"C5","cost":"4.50","code":"PIKBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2088/pikbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/14-c5-PIKBC5","delivery_rank":1.5,"tracked":false,"service":"parcel_post","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost","packaging":"bubble","speed_description":"1 - 3 working days","length":270,"description":"C5 Bubble Bag","width":null},{"size":"C5","cost":"5.00","code":"PIFBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2092/pifbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/16-c5-PIFBC5","delivery_rank":1,"tracked":false,"service":"parcel_post_fast","weight":1.5,"product_max_dimensions":"185*270* 1500gms","priority":"parcel_post_fast","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Fast","packaging":"bubble","speed_description":"Next working day","length":270,"description":"C5 Bubble Bag","width":null},{"size":"C5","cost":"5.50","code":"PICBC5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2099/picbc5_0.gif","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/27-c5-PICBC5","delivery_rank":1.5,"tracked":true,"service":"parcel_post_tracked","weight":3.0,"product_max_dimensions":"185*270* 3000gms","priority":"parcel_post_tracked","signature":false,"carrier":"nzpost","label_url":null,"service_code":null,"height":185,"service_group_description":"ParcelPost Tracked","packaging":"bubble","speed_description":"1 - 3 working days","length":270,"description":"C5 Bubble Bag - Tracked","width":null},{"size":"DLE","cost":"5.89","code":"NZPRODL","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2037/nzprodl.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/42-dle-NZPRODL","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"130*240* 3000gms","priority":"courier","signature":false,"carrier":"courierpost","label_url":null,"service_code":null,"height":130,"service_group_description":"Courier","packaging":"flat","speed_description":"Next working day","length":240,"description":"DLE Ready To Go Courier Flat Bag","width":null},{"size":"C5","cost":"7.15","code":"NZPRBA5","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2040/nzprba5.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/46-c5-NZPRBA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":false,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"bubble","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Bubble Bag","width":null},{"size":"DLE","cost":"8.30","code":"NZSRODL","image_url":"http://www.nzpost.co.nz/sites/default/files/imagecache/product_full/product/2038/nzprodl.jpg","product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/43-dle-NZSRODL","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"130*240* 3000gms","priority":"courier","signature":true,"carrier":"courierpost","label_url":null,"service_code":null,"height":130,"service_group_description":"Courier","packaging":"flat","speed_description":"Next working day","length":240,"description":"DLE Ready To Go Courier Flat Bag S/R","width":null},{"size":"C5","cost":"8.90","code":"NZSRBA5","image_url":null,"product_url":"http://www.nzpost.co.nz/products-services/postage-packaging/47-c5-NZSRBA5","delivery_rank":1,"tracked":true,"service":"courier","weight":3.0,"product_max_dimensions":"185*280* 3000gms","priority":"courier","signature":true,"carrier":"courierpost","label_url":null,"service_code":null,"height":185,"service_group_description":"Courier","packaging":"bubble","speed_description":"Next working day","length":280,"description":"C5 Ready To Go Courier Bubble Bag S/R","width":null}],"courier_large_delivery_type":null,"status":"success"}

data/test/fixtures/json/newzealandpost/international_book.json

@@ -0,0 +1 @@
+{"products":[{"group":"International Express Courier","price":"65.25","name":"Int Express Pcl Zone C 500gm","code":"ICPNC500","max_delivery_target":5,"signature_required":true,"min_delivery_target":1,"has_tracking":true},{"group":"International Economy Courier","price":"42.5","name":"Int Econ Cour Pcl Zn C 500gm","code":"IEZPC500","max_delivery_target":6,"signature_required":true,"min_delivery_target":2,"has_tracking":true},{"group":"International Air","price":"12.5","name":"Zone C AirPost Cust Pcl 500gm","code":"IACNC500","max_delivery_target":10,"signature_required":false,"min_delivery_target":3,"has_tracking":false},{"group":"International Economy","price":"11.25","name":"Zone C EconomyPost Pcl 500gm","code":"IECNC500","max_delivery_target":25,"signature_required":false,"min_delivery_target":10,"has_tracking":false}],"status":"success"}

data/test/fixtures/json/newzealandpost/international_new_zealand_wii.json

@@ -0,0 +1 @@
+{"products":[{"group":"International Express Courier","price":"130.73","name":"Int Express Pcl Zone C 3.5kg","code":"ICPNC35","max_delivery_target":5,"signature_required":true,"min_delivery_target":1,"has_tracking":true}],"status":"success"}

data/test/fixtures/json/newzealandpost/international_small_half_pound.json

@@ -0,0 +1 @@
+{"products":[{"group":"International Express Courier","price":"65.25","name":"Int Express Pcl Zone C 500gm","code":"ICPNC500","max_delivery_target":5,"signature_required":true,"min_delivery_target":1,"has_tracking":true},{"group":"International Economy Courier","price":"42.5","name":"Int Econ Cour Pcl Zn C 500gm","code":"IEZPC500","max_delivery_target":6,"signature_required":true,"min_delivery_target":2,"has_tracking":true},{"group":"International Air","price":"12.1","name":"Zone C AirPost Cust Pcl 500gm","code":"IACNC500","max_delivery_target":10,"signature_required":false,"min_delivery_target":3,"has_tracking":false},{"group":"International Economy","price":"10.89","name":"Zone C EconomyPost Pcl 500gm","code":"IECNC500","max_delivery_target":25,"signature_required":false,"min_delivery_target":10,"has_tracking":false}],"status":"success"}