Class: ShipmentTrackingNumber

Inherits:
Object
  • Object
show all
Defined in:
app/models/shipment_tracking_number.rb

Overview

A simple ruby object to provide parsing and interpretation of tracking numbers
normalizes courier code
parses tracking number and extract information when possible
offers access to tracking link

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tracking_number, options = {}) ⇒ ShipmentTrackingNumber

Returns a new instance of ShipmentTrackingNumber.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'app/models/shipment_tracking_number.rb', line 9

def initialize(tracking_number, options={})
  require 'tracking_number'

  @tracking_number = tracking_number
  if options[:courier_code].present?
    # We will normalize at least the courier code
    @shipment_courier = ShipmentCourier.new(options[:courier_code])
    @courier_code = @shipment_courier.courier_code
  elsif @tracking_number.present? && (@tn = TrackingNumber.new(@tracking_number)) && @tn.valid?
    # We use our tracking number gem to partse the tracking number, if it is succesful, we
    # use it as authoritative
    @courier_code = tn.courier_code
    @courier_name = tn.courier_name
    @service_type = tn.service_type
    @shipment_courier = ShipmentCourier.new(@courier_code)
  end
  @options = options
end

Instance Attribute Details

#courier_code ⇒ Object (readonly)

Returns the value of attribute courier_code.



7
8
9
 
# File 'app/models/shipment_tracking_number.rb', line 7

def courier_code
  @courier_code
end

#courier_name ⇒ Object (readonly)

Returns the value of attribute courier_name.



7
8
9
 
# File 'app/models/shipment_tracking_number.rb', line 7

def courier_name
  @courier_name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



7
8
9
 
# File 'app/models/shipment_tracking_number.rb', line 7

def options
  @options
end

#service_type ⇒ Object (readonly)

Returns the value of attribute service_type.



7
8
9
 
# File 'app/models/shipment_tracking_number.rb', line 7

def service_type
  @service_type
end

#shipment_courier ⇒ Object (readonly)

Returns the value of attribute shipment_courier.



7
8
9
 
# File 'app/models/shipment_tracking_number.rb', line 7

def shipment_courier
  @shipment_courier
end

#tn ⇒ Object (readonly)

Returns the value of attribute tn.



7
8
9
 
# File 'app/models/shipment_tracking_number.rb', line 7

def tn
  @tn
end

#tracking_number ⇒ Object (readonly)

Returns the value of attribute tracking_number.



7
8
9
 
# File 'app/models/shipment_tracking_number.rb', line 7

def tracking_number
  @tracking_number
end

Instance Method Details

#==(other) ⇒ Object 



62
63
64
 
# File 'app/models/shipment_tracking_number.rb', line 62

def ==(other)
  tracking_number == other.tracking_number && courier_code == other.courier_code
end

#tracking_url ⇒ Object

Todo, this info is in the tracking data json supplied by tracking_number gem



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
58
59
60
 
# File 'app/models/shipment_tracking_number.rb', line 29

def tracking_url
  # We use our own if we have it
  case courier_code
  when :fedex, :fedexfreight
    "https://www.fedex.com/fedextrack/?trknbr=#{tracking_number}"
  when :ups
    "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=en_US&track.x=0&track.y=0&InquiryNumber1=#{tracking_number}"
  when :purolator
    "https://www.purolator.com/purolator/ship-track/tracking-details.page?pin=#{tracking_number}"
  when :canada_post
    "https://www.canadapost-postescanada.ca/track-reperage/en#/details/#{tracking_number}"
  when :canpar
    "https://www.canpar.com/en/track/TrackingAction.do?locale=en&type=0&reference=#{tracking_number}"
  when :usps
    "https://tools.usps.com/go/TrackConfirmAction.action?tRef=fullpage&tLc=1&text28777=&tLabels=#{tracking_number}"
  when :freightquote
    "https://online.chrobinson.com/tracking/#/#{tracking_number}"
  when :speedee
    "http://speedeedelivery.com/track-a-shipment/?v=detail&barcode=#{tracking_number}"
  when :rlcarriers
    "https://www.rlcarriers.com/freight/shipping/shipment-tracing?tracking_number=#{tracking_number}"
  when :yrc
    "https://my.yrc.com/tools/track/shipments?referenceNumberType=PRO&referenceNumber=#{tracking_number}"
  else
    if @tn&.valid?
      # If our TN is matched,we use the tracking url from the gem
      @tn.tracking_url
    else
      '#'
    end
  end
end