Class: FreightKit::CLNI

Inherits:
Carrier show all
Includes:
Rateable
Defined in:
lib/freight_kit/carriers/clni.rb

Constant Summary collapse

REACTIVE_FREIGHT_CARRIER =
true

Constants inherited from Carrier

FreightKit::Carrier::BOL_NUMBER_TRACKING_URL_TEMPLATE, FreightKit::Carrier::NUMBERS, FreightKit::Carrier::ORDER_NUMBER_TRACKING_URL_TEMPLATE, FreightKit::Carrier::PICKUP_NUMBER_TRACKING_URL_TEMPLATE, FreightKit::Carrier::PO_NUMBER_TRACKING_URL_TEMPLATE, FreightKit::Carrier::TRACKING_NUMBER_TRACKING_URL_TEMPLATE, FreightKit::Carrier::VALID_BOL_NUMBER_REGEX, FreightKit::Carrier::VALID_ORDER_NUMBER_REGEX, FreightKit::Carrier::VALID_PICKUP_NUMBER_REGEX, FreightKit::Carrier::VALID_PO_NUMBER_REGEX, FreightKit::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 included from Rateable

#find_rates

Methods inherited from Carrier

#available_services, #bol, bol_requires_tracking_number?, #cancel_shipment, #create_pickup, default_location, #fetch_credential, #find_estimate, #find_locations, #find_rates, #find_tracking_info, #find_tracking_number_from_pickup_number, implemented?, #initialize, maximum_address_field_length, #overlength_fee, pickup_number_is_tracking_number?, #serviceable_accessorials?, tracking_url_template, #valid_credentials?, valid_number_regex, #valid_tracking_number?

Constructor Details

This class inherits a constructor from FreightKit::Carrier

Class Attribute Details

.nameObject (readonly)

Returns the value of attribute name.



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

def name
  @name
end

.scacObject (readonly)

Returns the value of attribute scac.



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

def scac
  @scac
end

Class Method Details

.find_rates_with_declared_value?Boolean

Note:

Explicitly set to ‘false` because though API allows this, it “doesn’t quote correctly” per customer

service

Returns:

  • (Boolean)


8
9
10
# File 'lib/freight_kit/carriers/clni.rb', line 8

def find_rates_with_declared_value?
  false
end

.maximum_heightObject



12
13
14
# File 'lib/freight_kit/carriers/clni.rb', line 12

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

.maximum_weightObject



16
17
18
# File 'lib/freight_kit/carriers/clni.rb', line 16

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

.minimum_length_for_overlength_feesObject



20
21
22
# File 'lib/freight_kit/carriers/clni.rb', line 20

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

.overlength_fees_require_tariff?Boolean

Returns:

  • (Boolean)


24
25
26
# File 'lib/freight_kit/carriers/clni.rb', line 24

def overlength_fees_require_tariff?
  false
end

.required_credential_typesObject



28
29
30
# File 'lib/freight_kit/carriers/clni.rb', line 28

def required_credential_types
  %i[api website]
end

.requirementsObject



32
33
34
# File 'lib/freight_kit/carriers/clni.rb', line 32

def requirements
  %i[credentials]
end

Instance Method Details

#pod(tracking_number) ⇒ Object

Documents



49
50
51
# File 'lib/freight_kit/carriers/clni.rb', line 49

def pod(tracking_number)
  parse_document_response(:pod, tracking_number)
end

#scanned_bol(tracking_number) ⇒ Object



53
54
55
# File 'lib/freight_kit/carriers/clni.rb', line 53

def scanned_bol(tracking_number)
  parse_document_response(:bol, tracking_number)
end

#validate_packages(packages, tariff = nil) ⇒ Object

Rates

Raises:



59
60
61
62
63
# File 'lib/freight_kit/carriers/clni.rb', line 59

def validate_packages(packages, tariff = nil)
  raise UnserviceableError, 'Must be fewer than 10 items altogether' if packages.sum(&:quantity) > 10

  super
end