Class: ActiveMerchant::Shipping::CPPWSTrackingResponse

Inherits:
TrackingResponse show all
Includes:
CPPWSErrorResponse
Defined in:
lib/active_shipping/shipping/carriers/canada_post_pws.rb

Constant Summary collapse

DELIVERED_EVENT_CODES =
%w(1496 1498 1499 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438)

Instance Attribute Summary collapse

Attributes included from CPPWSErrorResponse

#error_code

Attributes inherited from TrackingResponse

#actual_delivery_date, #carrier, #carrier_name, #delivery_signature, #destination, #origin, #scheduled_delivery_date, #ship_time, #shipment_events, #shipper_address, #status, #status_code, #status_description, #tracking_number

Attributes inherited from Response

#message, #params, #request, #test, #xml

Instance Method Summary collapse

Methods included from CPPWSErrorResponse

#handle_error

Methods inherited from TrackingResponse

#has_exception?, #is_delivered?, #latest_event

Methods inherited from Response

#success?, #test?

Constructor Details

#initialize(success, message, params = {}, options = {}) ⇒ CPPWSTrackingResponse

Returns a new instance of CPPWSTrackingResponse


804
805
806
807
808
809
810
811
812
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 804

def initialize(success, message, params = {}, options = {})
  handle_error(message, options)
  super
  @service_name    = options[:service_name]
  @expected_date   = options[:expected_date]
  @changed_date    = options[:changed_date]
  @change_reason   = options[:change_reason]
  @customer_number = options[:customer_number]
end

Instance Attribute Details

#change_reasonObject (readonly)

Returns the value of attribute change_reason


802
803
804
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 802

def change_reason
  @change_reason
end

#changed_dateObject (readonly)

Returns the value of attribute changed_date


802
803
804
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 802

def changed_date
  @changed_date
end

#customer_numberObject (readonly)

Returns the value of attribute customer_number


802
803
804
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 802

def customer_number
  @customer_number
end

#expected_dateObject (readonly)

Returns the value of attribute expected_date


802
803
804
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 802

def expected_date
  @expected_date
end

#service_nameObject (readonly)

Returns the value of attribute service_name


802
803
804
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 802

def service_name
  @service_name
end

Instance Method Details

#actual_delivery_timeObject


818
819
820
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 818

def actual_delivery_time
  delivered_event.time if delivered?
end

#delivered?Boolean

Returns:

  • (Boolean)

814
815
816
# File 'lib/active_shipping/shipping/carriers/canada_post_pws.rb', line 814

def delivered?
  !delivered_event.nil?
end