module Deliveries::Courier
Public Instance Methods
config(key, default: nil)
click to toggle source
Get configuration value by key.
@param key [String, Symbol Dot notation string or array of symbols. @param default [Mixed]
@return [Mixed]
# File lib/deliveries/courier.rb, line 22 def config(key, default: nil) raise 'Courier not configured' unless configured? key = key.split('.').map(&:to_sym) if key.is_a? String @config.dig(*key) || default end
configure() { |config| ... }
click to toggle source
# File lib/deliveries/courier.rb, line 7 def configure @config ||= ancestors.first::Config.new yield @config end
configured?()
click to toggle source
# File lib/deliveries/courier.rb, line 12 def configured? @config.present? end
create_pickup(sender:, receiver:, parcels:, reference_code:, pickup_date: nil, remarks: nil, language: nil)
click to toggle source
# File lib/deliveries/courier.rb, line 49 def create_pickup(sender:, receiver:, parcels:, reference_code:, pickup_date: nil, remarks: nil, language: nil) raise NotImplementedError end
create_shipment(sender:, receiver:, collection_point:, parcels:, reference_code:, shipment_date: nil, remarks: nil, language: nil)
click to toggle source
# File lib/deliveries/courier.rb, line 45 def create_shipment(sender:, receiver:, collection_point:, parcels:, reference_code:, shipment_date: nil, remarks: nil, language: nil) raise NotImplementedError end
get_collection_point(global_point_id:)
click to toggle source
# File lib/deliveries/courier.rb, line 37 def get_collection_point(global_point_id:) raise NotImplementedError end
get_collection_points(country:, postcode:)
click to toggle source
# File lib/deliveries/courier.rb, line 41 def get_collection_points(country:, postcode:) raise NotImplementedError end
get_label(tracking_code:, language: nil)
click to toggle source
# File lib/deliveries/courier.rb, line 53 def get_label(tracking_code:, language: nil) raise NotImplementedError end
get_labels(tracking_codes:, language: nil)
click to toggle source
# File lib/deliveries/courier.rb, line 57 def get_labels(tracking_codes:, language: nil) raise NotImplementedError end
live?()
click to toggle source
# File lib/deliveries/courier.rb, line 33 def live? Deliveries.live? end
pickup_info(tracking_code:, language: nil)
click to toggle source
# File lib/deliveries/courier.rb, line 65 def pickup_info(tracking_code:, language: nil) raise NotImplementedError end
shipment_info(tracking_code:, language: nil)
click to toggle source
# File lib/deliveries/courier.rb, line 61 def shipment_info(tracking_code:, language: nil) raise NotImplementedError end
test?()
click to toggle source
# File lib/deliveries/courier.rb, line 29 def test? Deliveries.test? end