cargowise 0.6 → 0.7

data/CHANGELOG

@@ -1,3 +1,10 @@
+v0.7 - 31st August 2010
+* new attribute Shipment#consols
+* new method Shipment#transport_mode
+* new method Shipment#orders
+* new attribute Order#invoice_number
+* new Order search method - Order.via(blah).by_shipment_number
+
 v0.6 - 31st August 2010
 * new methods Order#to_xml and Shipment#to_xml
 * new attribute Shipment#invoices

data/README.markdown

@@ -32,10 +32,10 @@ need to register the URI and authentication details for the company you want to
                                     :user => "user@example.com",
                                     :password => "secret")
 
-    Cargowise::Order.register(:ijs, :uri  => "http://visibility.ijsglobal.com/Tracker/WebService/ShipmentService.asmx",
-                                    :code => "company_code",
-                                    :user => "user@example.com",
-                                    :password => "secret")
+    Cargowise::Shipment.register(:ijs, :uri  => "http://visibility.ijsglobal.com/Tracker/WebService/ShipmentService.asmx",
+                                       :code => "company_code",
+                                       :user => "user@example.com",
+                                       :password => "secret")
 
 In a rails app the registration should be done in a file like
 config/initializers/cargowise.rb.

data/lib/cargowise.rb

@@ -15,6 +15,7 @@ require 'cargowise/shipments_client'
 require 'cargowise/abstract_result'
 require 'cargowise/order'
 require 'cargowise/shipment'
+require 'cargowise/consol'
 require 'cargowise/document'
 require 'cargowise/invoice'
 require 'cargowise/endpoint'

data/lib/cargowise/consol.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module Cargowise
+
+  # Extra shipping detail associated with a Shipment. Not built
+  # directly, but available via the consols() attribute
+  # of the Shipment model.
+  #
+  class Consol < AbstractResult
+
+    attr_reader :master_bill, :console_mode, :transport_mode
+    attr_reader :vessel_name, :voyage_flight
+    attr_reader :load_port, :discharge_port
+
+    def initialize(node)
+      @node = node
+
+      @master         = text_value("./MasterBill")
+      @console_mode   = text_value("./ConsolMode")
+      @transport_mode = text_value("./TransportMode")
+      @vessel_name    = text_value("./VesselName")
+      @voyage_flight  = text_value("./VoyageFlight")
+      @load_port      = text_value("./LoadPort")
+      @discharge_port = text_value("./DischargePort")
+    end
+  end
+end

data/lib/cargowise/order.rb

@@ -23,6 +23,7 @@ module Cargowise
 
     attr_reader :order_number, :order_status, :description, :datetime
     attr_reader :order_total, :transport_mode, :container_mode
+    attr_reader :invoice_number
 
     attr_reader :buyer_name
 
@@ -34,6 +35,7 @@ module Cargowise
       @node = node
 
       @order_number = text_value("./OrderIdentifier/OrderNumber")
+      @invoice_number = text_value("./OrderDetail/InvoiceNumber")
       @order_status = text_value("./OrderDetail/OrderStatus")
       @description  = text_value("./OrderDetail/Description")
       @datetime     = time_value("./OrderDetail/OrderDateTime")

data/lib/cargowise/order_search.rb

@@ -19,6 +19,21 @@ module Cargowise
       OrdersClient.get_order_list(ep.code, ep.user, ep.password, filter_hash)
     end
 
+    # find all orders with a ShipmentNumber that matches ref
+    #
+    def by_shipment_number(ref)
+      filter_hash = {
+        "tns:Filter" => {
+          "tns:Number" => {
+            "tns:NumberSearchField" => "ShipmentNumber",
+            "tns:NumberValue" => ref
+          }
+        }
+      }
+      OrdersClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
+      OrdersClient.get_order_list(ep.code, ep.user, ep.password, filter_hash)
+    end
+
     # find all orders still marked as incomplete.
     #
     def incomplete

data/lib/cargowise/shipment.rb

@@ -28,7 +28,7 @@ module Cargowise
 
     attr_reader :consignee_name
 
-    attr_reader :documents, :invoices
+    attr_reader :consols, :documents, :invoices
 
     def initialize(node)
       @node = node
@@ -47,6 +47,10 @@ module Cargowise
 
       @consignee_name = text_value("./Consignee/OrganisationDetails/Name")
 
+      @consols = node_array("./Consols/Consol").map { |node|
+        Consol.new(node)
+      }
+
       @documents = node_array("./DocumentLinks/DocumentLink").map { |node|
         Document.new(node)
       }.sort_by { |doc|
@@ -60,9 +64,26 @@ module Cargowise
       }
     end
 
+    # returns the raw XML string this shipment is based on
+    #
     def to_xml
       @node.to_xml
     end
 
+    # returns a space separated string with all transport modes being used
+    # to move this shipment
+    #
+    def transport_mode
+      @consols.map { |con| con.transport_mode }.uniq.sort.join(" ")
+    end
+
+    # lookup full Cargowise::Order objects for each order on this shipment.
+    #
+    # 'via' is a symbol indicating which API endpoint to lookup.
+    #
+    def orders(via)
+      @orders ||= Cargowise::Order.via(via).by_shipment_number(self.number)
+    end
+
   end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cargowise
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
-  - 6
-  version: "0.6"
+  - 7
+  version: "0.7"
 platform: ruby
 authors: 
 - James Healy
@@ -60,6 +60,7 @@ extra_rdoc_files: []
 files: 
 - lib/cargowise/shipment.rb
 - lib/cargowise/shipments_client.rb
+- lib/cargowise/consol.rb
 - lib/cargowise/invoice.rb
 - lib/cargowise/abstract_client.rb
 - lib/cargowise/abstract_search.rb