cargowise 0.7.2 → 0.8

data/CHANGELOG

@@ -1,3 +1,11 @@
+v0.8 - 9th September 2010
+* new Shipment method - Shipment#order_ref
+* new Shipment attribute - Shipment#client_reference
+
+v0.7.2 - 7th September 2010
+* new Shipment search method - Shipment.via(blah).by_masterbill_number
+* new Shipment method - Shipment#related_shipments
+
 v0.7.1 - 1st September 2010
 * new Shipment search method - Shipment.via(blah).recently_shipped
 

data/lib/cargowise.rb

@@ -4,6 +4,10 @@
 require "bigdecimal"
 require "handsoap"
 
+# gems
+require 'mechanize'
+require 'andand'
+
 module Cargowise
   DEFAULT_NS = "http://www.edi.com.au/EnterpriseService/"
 end

data/lib/cargowise/abstract_result.rb

@@ -13,6 +13,11 @@ module Cargowise
       @endpoints[name] = Endpoint.new(opts)
     end
 
+    def self.endpoint(name)
+      @endpoints ||= {}
+      @endpoints[name] 
+    end
+
     def self.via(name)
       @endpoints ||= {}
       raise ArgumentError, "#{name} is not recognised, have you registered it?" if @endpoints[name].nil?

data/lib/cargowise/shipment.rb

@@ -22,6 +22,7 @@ module Cargowise
   class Shipment < AbstractResult
 
     attr_reader :number, :housebill, :goods_description, :service_level
+    attr_reader :client_reference
     attr_reader :origin, :destination, :etd, :eta, :delivered_date
 
     attr_reader :shipper_name
@@ -37,6 +38,7 @@ module Cargowise
       @housebill = text_value("./HouseBill")
       @goods_description = text_value("./GoodsDescription")
       @service_level = text_value("./ServiceLevel")
+      @client_reference = text_value("./ClientReference")
       @origin        = text_value("./Origin")
       @destination   = text_value("./Destination")
       @etd           = time_value("./ETD")
@@ -101,5 +103,44 @@ module Cargowise
       }.compact
     end
 
+    # if this shipment has an order ref associated with it, find it.
+    #
+    # This data isn't available via the API, so we need to screen scrape the
+    # website to get it.
+    #
+    def order_ref(via)
+      if tracker_login_uri(via)
+        @order_ref ||= html_page(via).search(".//span[@id='Ztextlabel1']/text()").to_s.strip || ""
+      else
+        nil
+      end
+    end
+
+    private
+
+    # retrieve a Mechanize::Page object that containts info on this shipment
+    #
+    def html_page(via)
+      return nil unless tracker_login_uri(via)
+
+      @html_page ||= begin
+        base_uri = tracker_login_uri(via)
+        login_uri = base_uri + "/Login/Login.aspx"
+        agent = Mechanize.new
+        page  = agent.get(login_uri)
+        form  = page.forms.first
+        input_name = form.fields.detect { |field| field.name.to_s.downcase.include?("number")}.andand.name
+        form.__send__("#{input_name}=", self.number) if input_name
+        form.add_field!("ViewShipmentBtn","View Shipment")
+        agent.submit(form)
+      end
+    end
+
+    # Find a shipment with documents attached so we can discover the
+    # web interface uri
+    #
+    def tracker_login_uri(via)
+      Shipment.endpoint(via).uri.to_s[/(.+)\/WebService.+/,1]
+    end
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cargowise
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 2
-  version: 0.7.2
+  - 8
+  version: "0.8"
 platform: ruby
 authors: 
 - James Healy
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-07 00:00:00 +10:00
+date: 2010-09-09 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +49,21 @@ dependencies:
         version: 1.4.0
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id003
 description: Retrieve tracking and status information on your shipments from entpriseEDI
 email: james@yob.id.au
 executables: []