Class: FreightKit::OTCL

Inherits:
Carrier show all
Defined in:
lib/freight_kit/carriers/otcl.rb

Constant Summary collapse

REACTIVE_FREIGHT_CARRIER = 
true
XML_HEADERS = 
{
  Accept: 'application/xml',
  charset: 'utf-8',
  'Content-Type': 'application/xml'
}.freeze

Constants inherited from Carrier

Carrier::BOL_NUMBER_TRACKING_URL_TEMPLATE, Carrier::NUMBERS, Carrier::ORDER_NUMBER_TRACKING_URL_TEMPLATE, Carrier::PICKUP_NUMBER_TRACKING_URL_TEMPLATE, Carrier::PO_NUMBER_TRACKING_URL_TEMPLATE, Carrier::TRACKING_NUMBER_TRACKING_URL_TEMPLATE, Carrier::VALID_BOL_NUMBER_REGEX, Carrier::VALID_ORDER_NUMBER_REGEX, Carrier::VALID_PICKUP_NUMBER_REGEX, Carrier::VALID_PO_NUMBER_REGEX, Carrier::VALID_TRACKING_NUMBER_REGEX

Class Attribute Summary collapse

Attributes inherited from Carrier

#conf, #credentials, #customer_location, #last_request, #rates_with_excessive_length_fees, #tariff, #tmpdir

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Carrier

#available_services, #bol, bol_requires_tracking_number?, #cancel_shipment, default_location, #fetch_credential, #find_estimate, #find_locations, #find_tracking_info, #find_tracking_number_from_pickup_number, implemented?, #initialize, maximum_address_field_length, #overlength_fee, #pod, #scanned_bol, tracking_url_template, #valid_credentials?, valid_number_regex, #valid_tracking_number?, #validate_packages

Constructor Details

This class inherits a constructor from FreightKit::Carrier

Class Attribute Details

.name ⇒ Object (readonly)

Returns the value of attribute name.



42
43
44
 
# File 'lib/freight_kit/carriers/otcl.rb', line 42

def name
  @name
end

.scac ⇒ Object (readonly)

Returns the value of attribute scac.



42
43
44
 
# File 'lib/freight_kit/carriers/otcl.rb', line 42

def scac
  @scac
end

Class Method Details

.find_rates_with_declared_value? ⇒ Boolean

Returns:

  • (Boolean) 


6
7
8
 
# File 'lib/freight_kit/carriers/otcl.rb', line 6

def find_rates_with_declared_value?
  true
end

.maximum_height ⇒ Object 



10
11
12
 
# File 'lib/freight_kit/carriers/otcl.rb', line 10

def maximum_height
  Measured::Length.new(105, :inches)
end

.maximum_weight ⇒ Object 



14
15
16
 
# File 'lib/freight_kit/carriers/otcl.rb', line 14

def maximum_weight
  Measured::Weight.new(150, :pounds)
end

.minimum_length_for_overlength_fees ⇒ Object 



18
19
20
 
# File 'lib/freight_kit/carriers/otcl.rb', line 18

def minimum_length_for_overlength_fees
  Measured::Length.new(6, :feet)
end

.overlength_fees_require_tariff? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/freight_kit/carriers/otcl.rb', line 22

def overlength_fees_require_tariff?
  false
end

.pickup_number_is_tracking_number? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/freight_kit/carriers/otcl.rb', line 26

def pickup_number_is_tracking_number?
  true
end

.required_credential_types ⇒ Object 



30
31
32
 
# File 'lib/freight_kit/carriers/otcl.rb', line 30

def required_credential_types
  %i[api_key]
end

.requirements ⇒ Object 



34
35
36
 
# File 'lib/freight_kit/carriers/otcl.rb', line 34

def requirements
  %i[credentials]
end

Instance Method Details

#create_pickup(delivery_from:, delivery_to:, dispatcher:, pickup_from:, pickup_to:, scac:, service:, shipment:) ⇒ Object

Pickups



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/freight_kit/carriers/otcl.rb', line 82

def create_pickup(
  delivery_from:,
  delivery_to:,
  dispatcher:,
  pickup_from:,
  pickup_to:,
  scac:,
  service:,
  shipment:
)
  request = build_shipment_request(
    delivery_from:,
    delivery_to:,
    dispatcher:,
    pickup_from:,
    pickup_to:,
    scac:,
    service:,
    shipment:,
  )

  labels = parse_shipment_response(commit(request))

  request = build_pickup_request(
    delivery_from:,
    delivery_to:,
    dispatcher:,
    pickup_from:,
    pickup_to:,
    scac:,
    service:,
    shipment:,
  )

  parse_pickup_response(response: commit(request), labels:)
end

#find_rates(shipment:) ⇒ Object

Rates



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/freight_kit/carriers/otcl.rb', line 121

def find_rates(shipment:)
  begin
    validate_packages(shipment.packages)
  rescue UnserviceableError => e
    return RateResponse.new(error: e)
  end

  request = build_rate_request(shipment:)
  parse_rate_response(shipment:, response: commit(request))
end

#serviceable_accessorials?(accessorials) ⇒ Boolean

Override Carrier#serviceable_accessorials? since we have separate delivery/pickup accessorials

Returns:

  • (Boolean) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/freight_kit/carriers/otcl.rb', line 54

def serviceable_accessorials?(accessorials)
  return true if accessorials.blank?

  if !self.class::REACTIVE_FREIGHT_CARRIER ||
     !@conf.dig(:accessorials, :mappable) ||
     !@conf.dig(:accessorials, :unquotable) ||
     !@conf.dig(:accessorials, :unserviceable)
    raise NotImplementedError, "#{self.class.name}: #serviceable_accessorials? not supported"
  end

  serviceable_accessorials = @conf.dig(:accessorials, :mappable).keys +
                             @conf.dig(:accessorials, :unquotable)
  serviceable_count = (serviceable_accessorials & accessorials).size

  unserviceable_accessorials = @conf.dig(:accessorials, :unserviceable)
  unserviceable_count = (unserviceable_accessorials & accessorials).size

  if serviceable_count != accessorials.size || !unserviceable_count.zero?
    raise FreightKit::UnserviceableError, "#{self.class.name}: Some accessorials unserviceable"
  end

  true
end