Class: ActiveMerchant::Shipping::TrackingResponse

Inherits:
Response show all
Defined in:
lib/active_shipping/shipping/tracking_response.rb

Direct Known Subclasses

CPPWSTrackingResponse

Instance Attribute Summary collapse

Attributes inherited from Response

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

Instance Method Summary collapse

Methods inherited from Response

#success?, #test?

Constructor Details

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

Returns a new instance of TrackingResponse.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 18

def initialize(success, message, params = {}, options = {})
  @carrier = options[:carrier].parameterize.to_sym
  @carrier_name = options[:carrier]
  @status = options[:status]
  @status_code = options[:status_code]
  @status_description = options[:status_description]
  @ship_time = options[:ship_time]
  @scheduled_delivery_date = options[:scheduled_delivery_date]
  @actual_delivery_date = options[:actual_delivery_date]
  @delivery_signature = options[:delivery_signature]
  @tracking_number = options[:tracking_number]
  @shipment_events = Array(options[:shipment_events])
  @shipper_address = options[:shipper_address]
  @origin = options[:origin]
  @destination = options[:destination]
  super
end

Instance Attribute Details

#actual_delivery_date ⇒ Object (readonly) Also known as: actual_delivery_time

time



12
13
14
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 12

def actual_delivery_date
  @actual_delivery_date
end

#carrier ⇒ Object (readonly)

symbol



5
6
7
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 5

def carrier
  @carrier
end

#carrier_name ⇒ Object (readonly)

string



6
7
8
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 6

def carrier_name
  @carrier_name
end

#delivery_signature ⇒ Object (readonly)

string



13
14
15
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 13

def delivery_signature
  @delivery_signature
end

#destination ⇒ Object (readonly)

Location objects



16
17
18
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 16

def destination
  @destination
end

#origin ⇒ Object (readonly)

Location objects



16
17
18
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 16

def origin
  @origin
end

#scheduled_delivery_date ⇒ Object (readonly) Also known as: scheduled_delivery_time

time



11
12
13
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 11

def scheduled_delivery_date
  @scheduled_delivery_date
end

#ship_time ⇒ Object (readonly)

time



10
11
12
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 10

def ship_time
  @ship_time
end

#shipment_events ⇒ Object (readonly)

array of ShipmentEvents in chronological order



15
16
17
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 15

def shipment_events
  @shipment_events
end

#shipper_address ⇒ Object (readonly)

Location objects



16
17
18
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 16

def shipper_address
  @shipper_address
end

#status ⇒ Object (readonly)

symbol



7
8
9
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 7

def status
  @status
end

#status_code ⇒ Object (readonly)

string



8
9
10
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 8

def status_code
  @status_code
end

#status_description ⇒ Object (readonly)

string



9
10
11
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 9

def status_description
  @status_description
end

#tracking_number ⇒ Object (readonly)

string



14
15
16
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 14

def tracking_number
  @tracking_number
end

Instance Method Details

#has_exception? ⇒ Boolean Also known as: exception?

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 44

def has_exception?
  @status == :exception
end

#is_delivered? ⇒ Boolean Also known as: delivered?

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 40

def is_delivered?
  @status == :delivered
end

#latest_event ⇒ Object Also known as: exception_event 



36
37
38
 
# File 'lib/active_shipping/shipping/tracking_response.rb', line 36

def latest_event
  @shipment_events.last
end