Class: ShipEngine::Domain::Tracking

Inherits:
Object
  • Object
show all
Defined in:
lib/shipengine/domain/tracking.rb,
lib/shipengine/domain/tracking/track_using_label_id.rb,
lib/shipengine/domain/tracking/track_using_carrier_code_and_tracking_number.rb

Defined Under Namespace

Modules: TrackUsingCarrierCodeAndTrackingNumber, TrackUsingLabelId

Instance Method Summary collapse

Constructor Details

#initialize(internal_client) ⇒ Tracking

Returns a new instance of Tracking.

Parameters:



13
14
15
 
# File 'lib/shipengine/domain/tracking.rb', line 13

def initialize(internal_client)
  @internal_client = internal_client
end

Instance Method Details

#track_using_carrier_code_and_tracking_number(carrier_code, tracking_number, config) ⇒ ShipEngine::Domain::Tracking::TrackUsingCarrierCodeAndTrackingNumber::Response

Parameters:

  • carrier_code (String)
  • tracking_number (String)
  • config (Hash?)

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/shipengine/domain/tracking.rb', line 66

def track_using_carrier_code_and_tracking_number(carrier_code, tracking_number, config)
  response = @internal_client.get('/v1/tracking', { carrier_code:, tracking_number: }, config)
  tracking_api_result = response.body
  mash_result = Hashie::Mash.new(tracking_api_result)

  events = mash_result.events.map do |event|
    TrackUsingCarrierCodeAndTrackingNumber::Event.new(
      occurred_at: event.occurred_at,
      carrier_occurred_at: event.carrier_occurred_at,
      description: event.description,
      city_locality: event.city_locality,
      state_province: event.state_province,
      postal_code: event.postal_code,
      country_code: event.country_code,
      company_name: event.company_name,
      signer: event.signer,
      event_code: event.event_code,
      latitude: event.latitude,
      longitude: event.longitude
    )
  end

  TrackUsingCarrierCodeAndTrackingNumber::Response.new(
    tracking_number: mash_result.tracking_number,
    status_code: mash_result.status_code,
    status_description: mash_result.status_description,
    carrier_status_code: mash_result.carrier_status_code,
    carrier_status_description: mash_result.carrier_status_description,
    shipped_date: mash_result.shipped_date,
    estimated_delivery_date: mash_result.estimated_delivery_date,
    actual_delivery_date: mash_result.actual_delivery_date,
    exception_description: mash_result.exception_description,
    events:
  )
end

#track_using_label_id(label_id, config) ⇒ ShipEngine::Domain::Tracking::TrackUsingLabelId::Response

Parameters:

  • label_id (String)
  • config (Hash?)

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/shipengine/domain/tracking.rb', line 23

def track_using_label_id(label_id, config)
  response = @internal_client.get("/v1/labels/#{label_id}/track", {}, config)
  tracking_api_result = response.body
  mash_result = Hashie::Mash.new(tracking_api_result)

  events = mash_result.events.map do |event|
    TrackUsingLabelId::Event.new(
      occurred_at: event.occurred_at,
      carrier_occurred_at: event.carrier_occurred_at,
      description: event.description,
      city_locality: event.city_locality,
      state_province: event.state_province,
      postal_code: event.postal_code,
      country_code: event.country_code,
      company_name: event.company_name,
      signer: event.signer,
      event_code: event.event_code,
      latitude: event.latitude,
      longitude: event.longitude
    )
  end

  TrackUsingLabelId::Response.new(
    tracking_number: mash_result.tracking_number,
    status_code: mash_result.status_code,
    status_description: mash_result.status_description,
    carrier_status_code: mash_result.carrier_status_code,
    carrier_status_description: mash_result.carrier_status_description,
    shipped_date: mash_result.shipped_date,
    estimated_delivery_date: mash_result.estimated_delivery_date,
    actual_delivery_date: mash_result.actual_delivery_date,
    exception_description: mash_result.exception_description,
    events:
  )
end