Class: Ontrac::WebServices::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/ontrac/web_services/service.rb

Defined Under Namespace

Classes: Credentials

Constant Summary collapse

API_BASE_URL =
"https://www.shipontrac.net/OnTracWebServices/OnTracServices.svc/V2"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials, debug_output = nil) ⇒ Service

Returns a new instance of Service.



19
20
21
22
# File 'lib/ontrac/web_services/service.rb', line 19

def initialize(credentials, debug_output = nil)
  @credentials = credentials
  self.debug_output = debug_output
end

Instance Attribute Details

#debug_outputObject

Returns the value of attribute debug_output.



17
18
19
# File 'lib/ontrac/web_services/service.rb', line 17

def debug_output
  @debug_output
end

Instance Method Details

#post_shipments(shipment_requests) ⇒ Object



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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/ontrac/web_services/service.rb', line 30

def post_shipments(shipment_requests)
  shipment_requests.map do |shipment_request|
    shipment_request.shipper.Contact ||= ""
    shipment_request.shipper.Phone ||= ""

    shipment_request.consignee.Addr2 ||= ""
    shipment_request.consignee.Addr3 ||= ""
    shipment_request.consignee.Contact ||= ""
    shipment_request.consignee.Phone ||= ""

    shipment_request.UID = SecureRandom.hex(16)
    shipment_request.COD ||= 0
    shipment_request.CODType ||= Definitions::COD_TYPE_NONE
    shipment_request.BillTo ||= 0
    shipment_request.Instructions ||= ""
    shipment_request.Reference ||= ""
    shipment_request.Reference2 ||= ""
    shipment_request.Reference3 ||= ""
    shipment_request.Tracking ||= ""
    shipment_request.DIM ||= Definitions::Dim.new(0, 0, 0)
    shipment_request.ShipEmail ||= ""
    shipment_request.DelEmail ||= ""
  end

  xml_builder = Nokogiri::XML::Builder.new
  xml_builder.OnTracShipmentRequest do |xml|
    xml.Shipments do |xml|
      shipment_requests.each do |shipment_request|
        xml.parent << shipment_request.to_xml("Shipment")
      end
    end
  end

  response_xml = issue_request('shipments', xml_builder.doc)
  shipment_requests.map do |request|
    uid = request.UID
    shipment_response = response_xml.xpath(
      "/OnTracShipmentResponse/Shipments/Shipment[./UID = '#{uid}']"
    ).first or raise ServiceException.new("Missing package response for #{uid}")

    label = shipment_response.xpath("Label").text
    label = Base64.decode64(label) if (request.LabelType == Definitions::LABEL_TYPE_PDF)
    [
      shipment_response.xpath("Tracking").text,
      label,
      Float(shipment_response.xpath("TotalChrg").text)
    ]
  end
end

#service_url(service_name) ⇒ Object



24
25
26
27
28
# File 'lib/ontrac/web_services/service.rb', line 24

def service_url(service_name)
  "%s/%s/%s?pw=%s" % [
    API_BASE_URL, @credentials., service_name, CGI.escape(@credentials.password)
  ]
end