temando 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in temando.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jason Stirk
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Temando
+
+The `temando` gem provides a Ruby interface to the
+[Temando](https://www.temando.com/) shipping fulfilment provider.
+
+Currently, it only supports fetching quotes from the API and returning
+them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'temando'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install temando
+
+## Usage
+
+Temando authentication details should be set before calling any methods :
+
+```ruby
+ Temando::Api::Base.config.username = 'myuser@example.com'
+ Temando::Api::Base.config.password = 'sekrit'
+```
+
+Example:
+
+``ruby
+request = Temando::Request.new
+
+# Add the items to be shipped
+request.items << Temando::Item::GeneralGoods.new(...)
+request.items << Temando::Item::GeneralGoods.new(...)
+
+# Add the details for the actual shipment method and its locations
+anywhere = Temando::Delivery::DoorToDoor.new
+anywhere.origin      = Temando::Location.new(...)
+anywhere.destination = Temando::Location.new(...)
+
+# Ask the server for the quotes
+quotes = request.quotes_for(anywhere)
+
+quotes.first # => #<Temando::Quote>
+```
+
+## Tests
+
+`rake spec` to run the tests.
+
+`rake spec:remote` to run the remote specs.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.rspec_opts = '-t ~remote'
+end
+
+RSpec::Core::RakeTask.new('spec:remote') do |t|
+  t.rspec_opts = '-t remote'
+end
+
+task :default => :spec

data/lib/temando.rb

@@ -0,0 +1,27 @@
+require "typhoeus"
+
+require "temando/version"
+
+require "temando/location"
+
+require "temando/item/base"
+require "temando/item/general_goods"
+
+require "temando/delivery/base"
+require "temando/delivery/door_to_door"
+
+require "temando/quote"
+
+require "temando/api/soap_client"
+require "temando/api/base"
+require "temando/api/entities/anything"
+require "temando/api/entities/anywhere"
+require "temando/api/entities/quote"
+require "temando/api/get_quotes_by_request"
+
+require "temando/api/exceptions/soap_error"
+
+require "temando/request"
+
+module Temando
+end

data/lib/temando/api/base.rb

@@ -0,0 +1,40 @@
+require 'active_support/configurable'
+require 'nokogiri'
+
+module Temando
+  module Api
+    # Provides the low-level SOAP formatting functionality.
+    class Base
+      include ActiveSupport::Configurable
+
+      config_accessor :username, :password, :logger
+
+      TEMANDO_NAMESPACE = "http://api.temando.com/schema/2009_06/server.xsd"
+
+      def soap_boilerplate(&block)
+        data = Nokogiri::XML::Builder.new do |xml|
+          xml.Envelope("xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/",
+                                   "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+                                   "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance") do
+
+            # Ensure that the "Envelope" namespace absolutely must be soapenv, otherwise we will get soap:VersionMismatch errors
+            xml.parent.namespace = xml.parent.namespace_definitions.find { |x| x.prefix == 'soapenv' }
+            xml['soapenv'].Header do
+              xml.Security("xmlns:wsse" => "http://schemas.xmlsoap.org/ws/2002/04/secext") do
+                xml.parent.namespace = xml.parent.namespace_definitions.find { |x| x.prefix == 'wsse' }
+                xml['wsse'].UsernameToken do
+                  xml['wsse'].Username Temando::Api::Base.username
+                  xml['wsse'].Password Temando::Api::Base.password
+                end
+              end
+            end
+            xml['soapenv'].Body(&block)
+          end
+        end
+
+        data.to_xml(:indent => 2, :encoding => 'UTF-8')
+      end
+
+    end
+  end
+end

data/lib/temando/api/entities/anything.rb

@@ -0,0 +1,26 @@
+module Temando::Api
+  module Entities
+    class Anything
+      def initialize(anything)
+        @anything = anything
+      end
+
+      def build_xml(xml)
+        xml.anything do
+          xml.class_ @anything.shipping_class
+          xml.subclass @anything.shipping_subclass
+          xml.packaging @anything.shipping_packaging
+          xml.qualifierFreightGeneralFragile(@anything.fragile ? 'Y' : 'N')
+          xml.distanceMeasurementType 'Centimetres'
+          xml.weightMeasurementType 'Kilograms'
+          xml.length((@anything.length.to_f * 100).ceil)
+          xml.width((@anything.width.to_f * 100).ceil)
+          xml.height((@anything.height.to_f * 100).ceil)
+          xml.weight @anything.weight.ceil
+          xml.quantity @anything.quantity
+          xml.description @anything.description
+        end
+      end
+    end
+  end
+end

data/lib/temando/api/entities/anywhere.rb

@@ -0,0 +1,29 @@
+module Temando::Api
+  module Entities
+    class Anywhere
+      def initialize(anywhere)
+        @anywhere = anywhere
+      end
+
+      def build_xml(xml)
+        xml.anywhere do
+          xml.parent.namespace = nil
+          xml.itemNature @anywhere.shipping_nature
+          xml.itemMethod @anywhere.shipping_method
+          xml.originCountry @anywhere.origin.country
+          xml.originCode @anywhere.origin.postcode
+          xml.originSuburb @anywhere.origin.suburb
+          xml.destinationCountry @anywhere.destination.country
+          xml.destinationCode @anywhere.destination.postcode
+          xml.destinationSuburb @anywhere.destination.suburb
+          xml.destinationIs 'Residence'
+          xml.destinationResNotifyBefore 'N'
+          xml.destinationResLimitedAccess 'N'
+          xml.originIs 'Business'
+          xml.originBusNotifyBefore 'Y'
+          xml.originBusLimitedAccess 'N'
+        end
+      end
+    end
+  end
+end

data/lib/temando/api/entities/quote.rb

@@ -0,0 +1,30 @@
+require 'active_support/core_ext/hash/conversions'
+require 'bigdecimal'
+
+module Temando::Api
+  module Entities
+    # Handles turning a SOAP <quote> element into a Temando::Quote and
+    # back again.
+    class Quote
+      def self.parse_xml(quote_xml)
+        hash = Hash.from_xml(quote_xml)['quote']
+        quote = Temando::Quote.new
+
+        quote.total_price = BigDecimal.new(hash['totalPrice'])
+        quote.base_price  = BigDecimal.new(hash['basePrice'])
+        quote.tax         = BigDecimal.new(hash['tax'])
+        quote.currency    = hash['currency']
+
+        quote.name        = hash['deliveryMethod']
+
+        quote.minimum_eta = hash['etaFrom'].to_i
+        quote.maximum_eta = hash['etaTo'].to_i
+        quote.guaranteed_eta = (hash['guaranteedEta'] == 'Y')
+
+        quote.carrier_id  = hash['carrier']['id']
+
+        quote
+      end
+    end
+  end
+end

data/lib/temando/api/exceptions/soap_error.rb

@@ -0,0 +1,14 @@
+module Temando::Api
+  module Exceptions
+    # Raised when the ASI returns a SOAP Fault object.
+    class SoapError < StandardError
+      attr_reader :last_request, :last_response
+
+      def initialize(message, last_request, last_response)
+        @last_request  = last_request
+        @last_response = last_response
+        super(message)
+      end
+    end
+  end
+end

data/lib/temando/api/get_quotes_by_request.rb

@@ -0,0 +1,48 @@
+module Temando
+  module Api
+    # Abstracts generating the request for the SOAP API's
+    # getQuotesByRequest method, and parsing the response.
+    class GetQuotesByRequest < Temando::Api::Base
+
+      def initialize(items, delivery)
+        @items = items
+        @delivery = delivery
+
+        @items.each { |item| validate_item(item) }
+      end
+
+      def request_xml
+        soap_boilerplate do |xml|
+          xml.getQuotesByRequest('xmlns:tem' => TEMANDO_NAMESPACE) do
+            xml.parent.namespace = xml.parent.namespace_definitions.find { |x| x.prefix == 'tem' }
+
+            xml.anythings do
+              xml.parent.namespace = nil
+              @items.each do |anything|
+                Temando::Api::Entities::Anything.new(anything).build_xml(xml)
+              end
+            end
+
+            Temando::Api::Entities::Anywhere.new(@delivery).build_xml(xml)
+
+            # TODO: anytime
+            # TODO: general
+          end
+        end
+      end
+
+      def parse_response(response_xml)
+        xml = Nokogiri::XML(response_xml)
+        quotes = xml.xpath('//quote').collect do |result|
+          Temando::Api::Entities::Quote.parse_xml(result.to_xml)
+        end
+      end
+
+    private
+
+      def validate_item(item)
+        raise ArgumentError, "#{item.inspect} is not valid" unless item.valid?
+      end
+    end
+  end
+end

data/lib/temando/api/soap_client.rb

@@ -0,0 +1,64 @@
+require 'active_support/configurable'
+
+module Temando
+  module Api
+    class SoapClient
+      include ActiveSupport::Configurable
+
+      attr_reader :last_request, :last_response
+      config_accessor :service_url
+
+      config.service_url = "https://api.temando.com/soapServer.html"
+
+      def dispatch(request_xml)
+        response = ''
+
+        @last_request = request_xml
+
+        process_response(perform_request(request_xml))
+      end
+
+    private
+
+      def logger
+        Temando::Api::Base.logger
+      end
+
+      def perform_request(request_xml)
+        logger.debug request_xml if logger.present?
+        Typhoeus::Request.post(service_url,
+                               :body => request_xml,
+                               :headers => {'Content-Type' => "text/xml; charset=utf-8"}
+                              )
+      end
+
+      # Processes the response and decides whether to handle an error or whether to return the content
+      def process_response(response)
+        @last_response = response.body
+
+        logger.debug @last_response if logger.present?
+
+        if response.body =~ /:Fault>/ then
+          handle_error(response)
+        else
+          response.body
+        end
+      end
+
+      # Parses a soap:Fault error and raises it as a Temando::SoapError
+      def handle_error(response)
+        xml = Nokogiri::XML(response.body)
+        xpath = '/SOAP-ENV:Envelope/SOAP-ENV:Body/SOAP-ENV:Fault//faultstring'
+        msg = xml.xpath(xpath).text
+
+        if msg.to_s.strip == '' then
+          xpath = '/SOAP-ENV:Envelope/SOAP-ENV:Body/SOAP-ENV:Fault//faultcode'
+          msg = xml.xpath(xpath).text
+        end
+
+        # It was a real error - raise the exception
+        raise Temando::Api::Exceptions::SoapError.new("Error from server: #{msg}", self.last_request, self.last_response)
+      end
+    end
+  end
+end

data/lib/temando/delivery/base.rb

@@ -0,0 +1,27 @@
+module Temando
+  module Delivery
+    # A Temando::Delivery::Base represents ways of shipping
+    # items.
+    #
+    # The Temando API refers to a delivery action as an "Anywhere".
+    #
+    # This is a base class for the delivery mechanisms,
+    # Temando::Delivery::DoorToDoor and Temando::Delivery::DepotToDepot
+    class Base
+      attr_reader :origin, :destination
+
+      def initialize(origin = nil, destination = nil)
+        self.origin = origin
+        self.destination = destination
+      end
+
+      def origin=(location)
+        @origin = location
+      end
+
+      def destination=(location)
+        @destination = location
+      end
+    end
+ end
+end

data/lib/temando/delivery/door_to_door.rb

@@ -0,0 +1,16 @@
+module Temando
+  module Delivery
+    # A Temando::Delivery::DoorToDoor represents the collection of a
+    # shipment from physical premises (eg. home or office) and shipping
+    # them to other physical premises.
+    class DoorToDoor < Temando::Delivery::Base
+      def shipping_nature
+        'Domestic'
+      end
+
+      def shipping_method
+        'Door to Door'
+      end
+    end
+  end
+end

data/lib/temando/item/base.rb

@@ -0,0 +1,29 @@
+require 'active_model'
+
+module Temando
+  module Item
+    # A Temando::Item::Base is a physical item (or a quantity of the
+    # same item) which are to be shipped.
+    #
+    # The Temando API refers to these as "Anythings".
+    #
+    # We don't ship a Temando::Item::Base itself, but rather its
+    # subclasses, Temando::Item::GeneralGoods, Temando::Item::Freight,
+    # etc.
+    class Base
+
+      include ActiveModel::Validations
+
+      attr_accessor :length, :width, :height, :weight, :quantity, :description
+
+      validates_numericality_of :length, :width, :height
+      validates_numericality_of :quantity, :greater_than => 0, :only_integer => true
+
+      def initialize(attributes={})
+        attributes.each do |key, value|
+          self.send("#{key}=".intern, value)
+        end
+      end
+    end
+ end
+end

data/lib/temando/item/general_goods.rb

@@ -0,0 +1,22 @@
+module Temando
+  module Item
+    # A GeneralGood is a type of item that can be shipped by Temando.
+    class GeneralGoods < Temando::Item::Base
+      def shipping_class
+        'General Goods'
+      end
+
+      def shipping_subclass
+        'Household Goods'
+      end
+
+      def shipping_packaging
+        'Parcel'
+      end
+
+      def fragile
+        false
+      end
+    end
+   end
+end

data/lib/temando/location.rb

@@ -0,0 +1,13 @@
+module Temando
+  # A Temando::Location represents address and contact details for
+  # pickup or delivery of a shipment.
+  class Location
+    attr_accessor :country, :postcode, :suburb, :contact, :state, :street, :phone1, :phone2, :email, :company
+
+    def initialize(attributes={})
+      attributes.each do |key, value|
+        self.send("#{key}=".intern, value)
+      end
+    end
+  end
+end

data/lib/temando/quote.rb

@@ -0,0 +1,7 @@
+module Temando
+  # A Quote is a representation of the shipping quote provided by one of
+  # Temando's suppliers.
+  class Quote
+    attr_accessor :total_price, :tax, :currency, :minimum_eta, :maximum_eta, :name, :base_price, :guaranteed_eta, :carrier_id
+  end
+end

data/lib/temando/request.rb

@@ -0,0 +1,49 @@
+module Temando
+  # Temando::Request represents a request for a quotation from the
+  # Temando API.
+  #
+  # It is used to construct the parameters for a quotation, send them
+  # off to the API and return the available quotes.
+  #
+  # Example:
+  #   request = Temando::Request.new
+  #
+  #   # Add the items to be shipped
+  #   request.items << Temando::Item::GeneralGoods.new(...)
+  #   request.items << Temando::Item::GeneralGoods.new(...)
+  #
+  #   # Add the details for the actual shipment method and its locations
+  #   anywhere = Temando::Delivery::DoorToDoor.new
+  #   anywhere.origin      = Temando::Location.new(...)
+  #   anywhere.destination = Temando::Location.new(...)
+  #
+  #   # Ask the server for the quotes
+  #   quotes = request.quotes_for(anywhere)
+  #
+  #   quotes.first # => #<Temando::Quote>
+  #
+  # Temando authentication details should be set before calling these methods :
+  #
+  #   Temando::Api::Base.config.username = 'myuser@example.com'
+  #   Temando::Api::Base.config.password = 'sekrit'
+  class Request
+
+    attr_accessor :items
+
+    def initialize
+      @items = []
+    end
+
+    def quotes_for(delivery)
+      # Construct the request, dispatch it off to the server and return
+      # the result.
+      formatter = Temando::Api::GetQuotesByRequest.new(@items, delivery)
+      response  = client.dispatch(formatter.request_xml)
+      formatter.parse_response(response)
+    end
+
+    def client
+      @client ||= Temando::Api::SoapClient.new
+    end
+  end
+end

data/lib/temando/rspec.rb

@@ -0,0 +1,15 @@
+# RSpec helpers for Temando.
+module Temando
+  module RSpecHelpers
+    # Stubs the SOAP response data for a get_quotes request for a
+    # Temando::Response object.
+    def stub_temando_request(request, fixture_content)
+      request.client.should_receive(:dispatch).with(anything()).and_return(fixture_content)
+    end
+  end
+end
+if defined?(RSpec) then
+  RSpec.configure do |c|
+    c.include Temando::RSpecHelpers
+  end
+end

data/lib/temando/version.rb

@@ -0,0 +1,3 @@
+module Temando
+  VERSION = "0.1.0"
+end

data/spec/fixtures/xml/exceptions/failed_auth.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+  <SOAP-ENV:Body>
+    <SOAP-ENV:Fault>
+      <faultcode>Err_Access03</faultcode>
+      <faultstring>The login details you have provided are either not a valid Username and Password combination or an invalid id.</faultstring>
+      <faultactor>https://api.temando.com/soapServer.html</faultactor>
+    </SOAP-ENV:Fault>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>

data/spec/fixtures/xml/get_quotes_by_request/request.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Header>
+    <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">
+      <wsse:UsernameToken>
+        <wsse:Username>username</wsse:Username>
+        <wsse:Password>password</wsse:Password>
+      </wsse:UsernameToken>
+    </wsse:Security>
+  </soapenv:Header>
+  <soapenv:Body>
+    <tem:getQuotesByRequest xmlns:tem="http://api.temando.com/schema/2009_06/server.xsd">
+      <anythings>
+        <anything>
+          <class>General Goods</class>
+          <subclass>Household Goods</subclass>
+          <packaging>Parcel</packaging>
+          <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
+          <distanceMeasurementType>Centimetres</distanceMeasurementType>
+          <weightMeasurementType>Kilograms</weightMeasurementType>
+          <length>10</length>
+          <width>10</width>
+          <height>10</height>
+          <weight>1</weight>
+          <quantity>2</quantity>
+          <description>Contains hats.</description>
+        </anything>
+      </anythings>
+      <anywhere>
+        <itemNature>Domestic</itemNature>
+        <itemMethod>Door to Door</itemMethod>
+        <originCountry>AU</originCountry>
+        <originCode>4000</originCode>
+        <originSuburb>Brisbane</originSuburb>
+        <destinationCountry>AU</destinationCountry>
+        <destinationCode>2000</destinationCode>
+        <destinationSuburb>Sydney</destinationSuburb>
+        <destinationIs>Residence</destinationIs>
+        <destinationResNotifyBefore>N</destinationResNotifyBefore>
+        <destinationResLimitedAccess>N</destinationResLimitedAccess>
+        <originIs>Business</originIs>
+        <originBusNotifyBefore>Y</originBusNotifyBefore>
+        <originBusLimitedAccess>N</originBusLimitedAccess>
+      </anywhere>
+    </tem:getQuotesByRequest>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/xml/get_quotes_by_request/response.xml

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <SOAP-ENV:Header/>
+  <SOAP-ENV:Body>
+    <ns1:getQuotesByRequestResponse xmlns:ns1="http://api.temando.com/schema/2009_06/server.xsd">
+      <quote>
+        <generated>Automatically</generated>
+        <accepted>N</accepted>
+        <totalPrice>11.00</totalPrice>
+        <basePrice>10.00</basePrice>
+        <tax>1.00</tax>
+        <currency>AUD</currency>
+        <deliveryMethod>Off-peak</deliveryMethod>
+        <usingGeneralRail>N</usingGeneralRail>
+        <usingGeneralRoad>Y</usingGeneralRoad>
+        <usingGeneralSea>N</usingGeneralSea>
+        <usingExpressAir>N</usingExpressAir>
+        <usingExpressRoad>N</usingExpressRoad>
+        <etaFrom>2</etaFrom>
+        <etaTo>3</etaTo>
+        <guaranteedEta>Y</guaranteedEta>
+        <adjustments>
+          <adjustment>
+            <description>Credit Card Payment Adjustment</description>
+            <amount>0.20</amount>
+            <tax>0.02</tax>
+          </adjustment>
+          <adjustment>
+            <description>Credit Payment Adjustment</description>
+            <amount>-0.20</amount>
+            <tax>-0.02</tax>
+          </adjustment>
+        </adjustments>
+        <inclusions><inclusion><summary>Tracking available</summary><details>Tracking information will be available for this quote.
+          </details></inclusion>
+     <inclusion><summary>Automatic Booking</summary><details>Automatic booking generated.</details></inclusion>
+     <inclusion><summary>Automatic Consignment</summary><details>Automatic consignment note generated.</details></inclusion>
+    </inclusions>
+        <extras>
+          <extra>
+            <summary>Insurance</summary>
+            <details>Insurance cover up to $5,000.</details>
+            <totalPrice>2.20</totalPrice>
+            <basePrice>2.00</basePrice>
+            <tax>0.20</tax>
+            <mandatory>Y</mandatory>
+            <adjustments>
+              <adjustment>
+                <description>Credit Card Payment Adjustment</description>
+                <amount>0.04</amount>
+                <tax>0.00</tax>
+              </adjustment>
+            </adjustments>
+          </extra>
+        </extras>
+        <carrier>
+          <id>654321</id>
+          <companyName>ZYX Transport</companyName>
+          <companyContact>John Doe</companyContact>
+          <streetAddress>1 Transport Street</streetAddress>
+          <streetSuburb>Brisbane</streetSuburb>
+          <streetCity>Brisbane</streetCity>
+          <streetState>QLD</streetState>
+          <streetCode>4000</streetCode>
+          <streetCountry>AU</streetCountry>
+          <postalAddress>PO Box 1111</postalAddress>
+          <postalSuburb>Brisbane</postalSuburb>
+          <postalCity>Brisbane</postalCity>
+          <postalState>QLD</postalState>
+          <postalCode>4001</postalCode>
+          <postalCountry>AU</postalCountry>
+          <phone1>(07) 3333 3333</phone1>
+          <email>john.doe@zyxtransport.com.au</email>
+          <website>https://www.zyxtransport.com.au</website>
+          <conditions>Our conditions include: lots of text.</conditions>
+        </carrier>
+      </quote>
+    </ns1:getQuotesByRequestResponse>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>

data/spec/integration/get_quotes_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "Get Quotes" do
+
+  it "can get the quotes from Temando" do
+    request = Temando::Request.new
+    request.items << valid_temando_item
+
+    anywhere = Temando::Delivery::DoorToDoor.new
+    anywhere.origin = Temando::Location.new(:contact => "Joe Bloggs",
+                                            :company => "Bloggs Inc.",
+                                            :street => "123 Test Street",
+                                            :suburb => "Sydney",
+                                            :state => "NSW",
+                                            :postcode => "2000",
+                                            :phone1 => Faker::PhoneNumber.phone_number,
+                                            :email => Faker::Internet.email,
+                                            :country => "AU"
+                                           )
+
+    anywhere.destination = Temando::Location.new(:contact => "Joe Bloggs",
+                                                 :company => "Bloggs Inc.",
+                                                 :street => "123 Test Street",
+                                                 :suburb => "Sydney",
+                                                 :state => "NSW",
+                                                 :postcode => "2000",
+                                                 :phone1 => Faker::PhoneNumber.phone_number,
+                                                 :email => Faker::Internet.email,
+                                                 :country => "AU"
+                                                )
+
+    stub_temando_request(request, xml_fixture('get_quotes_by_request/response'))
+
+    quotes = request.quotes_for(anywhere)
+    quotes.should be_a(Array)
+    quotes.count.should == 1
+
+    quote = quotes.first
+    quote.should be_a(Temando::Quote)
+  end
+end

data/spec/remote/remote_request_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Temando::Request, :remote => true do
+
+  describe ".quotes_for" do
+    let(:item) { valid_temando_item }
+    let(:origin) { Temando::Location.new(:country => 'AU',
+                                         :suburb => 'Brisbane',
+                                         :postcode => '4000'
+                                        ) }
+    let(:destination) { Temando::Location.new(:country => 'AU',
+                                         :suburb => 'Sydney',
+                                         :postcode => '2000'
+                                        ) }
+    let(:delivery) { Temando::Delivery::DoorToDoor.new(origin, destination) }
+    let(:request) { subject.items << item; subject }
+
+    it "dispatches the data in and out from Temando::Api::GetQuotesByRequest" do
+      pending "provide real API details"
+      Temando::Api::Base.config.username = 'username'
+      Temando::Api::Base.config.password = 'password'
+
+      response = request.quotes_for(delivery)
+
+      response.should be_a(Array)
+      response.first.should be_a(Temando::Quote)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'bundler/setup'
+require 'temando'
+require 'temando/rspec'
+require 'faker'
+
+Dir[File.join(File.dirname(__FILE__), "/support/**/*.rb")].each {|f| require f}
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:each) do
+    Temando::Api::Base.config.username = 'username'
+    Temando::Api::Base.config.password = 'password'
+  end
+end

data/spec/support/default_disable_remote.rb

@@ -0,0 +1,14 @@
+module DefaultDisableRemote
+  def stub_remote!
+    Temando::Api::SoapClient.any_instance.stub(:perform_request).and_return { raise "External requests are disabled, but have not been correctly stubbed" }
+  end
+end
+
+RSpec.configure do |config|
+  config.include DefaultDisableRemote
+  config.before(:each) do
+    unless example.metadata[:remote] || (example.metadata[:disable_remote] == false)
+      stub_remote!
+    end
+  end
+end

data/spec/support/factories/item_factory.rb

@@ -0,0 +1,9 @@
+module ItemFactory
+  def valid_temando_item(options={})
+    Temando::Item::GeneralGoods.new({:length => 0.1, :width => 0.1, :height => 0.1, :weight => 1.0, :quantity => 1, :description => 'Hats'}.merge(options))
+  end
+end
+
+RSpec.configure do |c|
+  c.include ItemFactory
+end

data/spec/support/xml_fixtures.rb

@@ -0,0 +1,9 @@
+module XmlFixtures
+  def xml_fixture(name)
+    File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', 'xml', name.to_s + '.xml'))
+  end
+end
+
+RSpec.configure do |c|
+  c.include XmlFixtures
+end

data/spec/units/api/entities/quote_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Temando::Api::Entities::Quote do
+
+  describe ".parse_xml" do
+    it "parses a <quote> entity into a Temando::Quote object" do
+      xml = Nokogiri::XML(xml_fixture('get_quotes_by_request/response'))
+      input_xml = xml.xpath('//quote').first.to_xml
+
+      quote = Temando::Api::Entities::Quote.parse_xml(input_xml)
+      quote.should be_a(Temando::Quote)
+      quote.total_price.should == 11.00
+      quote.tax.should == 1.0
+      quote.base_price.should == 10.00
+      quote.currency.should == 'AUD'
+      quote.minimum_eta.should == 2
+      quote.maximum_eta.should == 3
+      quote.guaranteed_eta.should be_true
+      quote.carrier_id.should == '654321'
+    end
+  end
+
+end

data/spec/units/api/get_quotes_by_request_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Temando::Api::GetQuotesByRequest do
+  let(:subject) { Temando::Api::GetQuotesByRequest.new([item], delivery) }
+  let(:item) { valid_temando_item(:description => 'Contains hats.', :quantity => 2) }
+  let(:origin) { Temando::Location.new(:country => 'AU',
+                                       :suburb => 'Brisbane',
+                                       :postcode => '4000'
+                                      ) }
+  let(:destination) { Temando::Location.new(:country => 'AU',
+                                       :suburb => 'Sydney',
+                                       :postcode => '2000'
+                                      ) }
+
+  let(:delivery) { Temando::Delivery::DoorToDoor.new(origin, destination) }
+
+  describe ".request_xml" do
+    it "generates a SOAP request" do
+      subject.request_xml.should == xml_fixture('get_quotes_by_request/request')
+    end
+  end
+
+  describe ".parse_response" do
+    it "decodes the SOAP response" do
+      Temando::Api::Entities::Quote.should_receive(:parse_xml).with(anything()).exactly(:once)
+      result = subject.parse_response(xml_fixture('get_quotes_by_request/response'))
+    end
+  end
+end

data/spec/units/api/soap_client_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Temando::Api::SoapClient do
+
+  describe ".dispatch", :disable_remote => false do
+    let(:ok_response)  { r = mock(Typhoeus::Response); r.stub(:body).and_return(xml_fixture('get_quotes_by_request/response')); r }
+    let(:bad_response) { r = mock(Typhoeus::Response); r.stub(:body).and_return(xml_fixture('exceptions/failed_auth')); r }
+
+    it "sends a request to the server" do
+      Typhoeus::Request.should_receive(:post).and_return(ok_response)
+
+      subject.dispatch('XML')
+    end
+
+    it "raises exceptions on soapfault responses" do
+      subject.should_receive(:perform_request).and_return(bad_response)
+      lambda { subject.dispatch('XML') }.should raise_exception(Temando::Api::Exceptions::SoapError)
+    end
+
+    it "returns the XML data on successful responses" do
+      subject.should_receive(:perform_request).and_return(ok_response)
+      subject.dispatch('XML').should =~ /getQuotesByRequestResponse/
+    end
+  end
+
+end

data/spec/units/delivery/door_to_door_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Temando::Delivery::DoorToDoor do
+
+  describe ".origin" do
+    it { should respond_to(:origin) }
+
+    it "accepts Temando::Location" do
+      lambda { subject.origin = Temando::Location.new }.should_not raise_exception
+    end
+  end
+
+  describe ".destination" do
+    it { should respond_to(:destination) }
+
+    it "accepts Temando::Location" do
+      lambda { subject.destination = Temando::Location.new }.should_not raise_exception
+    end
+  end
+
+end

data/spec/units/item/general_goods_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Temando::Item::GeneralGoods do
+  let(:valid_item) { valid_temando_item }
+
+  describe ".valid?" do
+    it "should be valid" do
+      valid_item.should be_valid
+    end
+
+    it "is invalid with a blank quantity" do
+      valid_item.quantity = nil
+      valid_item.should_not be_valid
+    end
+
+    it "is invalid with a blank length" do
+      valid_item.length = nil
+      valid_item.should_not be_valid
+    end
+  end
+end

data/spec/units/request_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Temando::Request do
+
+  describe ".items" do
+    it { should respond_to(:items) }
+  end
+
+  describe ".quotes_for" do
+    let(:item) { valid_temando_item }
+    let(:delivery) { Temando::Delivery::DoorToDoor.new }
+    let(:request) { subject.items << item; subject }
+
+    it "dispatches the data in and out from Temando::Api::GetQuotesByRequest" do
+      format = mock(Temando::Api::GetQuotesByRequest)
+      Temando::Api::GetQuotesByRequest.should_receive(:new).with([item], delivery).and_return(format)
+      format.should_receive(:request_xml).and_return('REQUEST XML')
+
+      response = [ Temando::Quote.new ]
+
+      format.should_receive(:parse_response).with('RESPONSE XML').and_return(response)
+      request.client.should_receive(:dispatch).with('REQUEST XML').and_return('RESPONSE XML')
+
+      request.quotes_for(delivery).should == response
+    end
+  end
+
+  describe ".dispatch_request" do
+
+  end
+
+end

data/temando.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/temando/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jason Stirk"]
+  gem.email         = ["jason@reinteractive.net"]
+  gem.description   = %q{Ruby API to Temando - an Australian transport fulfilment broker}
+  gem.summary       = %q{Ruby API to Temando - an Australian transport fulfilment broker}
+  gem.homepage      = "http://github.com/reInteractive-open/temando"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "temando"
+  gem.require_paths = ["lib"]
+  gem.version       = Temando::VERSION
+
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'typhoeus', '~> 0.4.2'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'activemodel'
+
+  gem.add_development_dependency 'rspec', '~> 2.11.0'
+  gem.add_development_dependency 'faker'
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: temando
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Stirk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby API to Temando - an Australian transport fulfilment broker
+email:
+- jason@reinteractive.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/temando.rb
+- lib/temando/api/base.rb
+- lib/temando/api/entities/anything.rb
+- lib/temando/api/entities/anywhere.rb
+- lib/temando/api/entities/quote.rb
+- lib/temando/api/exceptions/soap_error.rb
+- lib/temando/api/get_quotes_by_request.rb
+- lib/temando/api/soap_client.rb
+- lib/temando/delivery/base.rb
+- lib/temando/delivery/door_to_door.rb
+- lib/temando/item/base.rb
+- lib/temando/item/general_goods.rb
+- lib/temando/location.rb
+- lib/temando/quote.rb
+- lib/temando/request.rb
+- lib/temando/rspec.rb
+- lib/temando/version.rb
+- spec/fixtures/xml/exceptions/failed_auth.xml
+- spec/fixtures/xml/get_quotes_by_request/request.xml
+- spec/fixtures/xml/get_quotes_by_request/response.xml
+- spec/integration/get_quotes_spec.rb
+- spec/remote/remote_request_spec.rb
+- spec/spec_helper.rb
+- spec/support/default_disable_remote.rb
+- spec/support/factories/item_factory.rb
+- spec/support/xml_fixtures.rb
+- spec/units/api/entities/quote_spec.rb
+- spec/units/api/get_quotes_by_request_spec.rb
+- spec/units/api/soap_client_spec.rb
+- spec/units/delivery/door_to_door_spec.rb
+- spec/units/item/general_goods_spec.rb
+- spec/units/request_spec.rb
+- temando.gemspec
+homepage: http://github.com/reInteractive-open/temando
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Ruby API to Temando - an Australian transport fulfilment broker
+test_files:
+- spec/fixtures/xml/exceptions/failed_auth.xml
+- spec/fixtures/xml/get_quotes_by_request/request.xml
+- spec/fixtures/xml/get_quotes_by_request/response.xml
+- spec/integration/get_quotes_spec.rb
+- spec/remote/remote_request_spec.rb
+- spec/spec_helper.rb
+- spec/support/default_disable_remote.rb
+- spec/support/factories/item_factory.rb
+- spec/support/xml_fixtures.rb
+- spec/units/api/entities/quote_spec.rb
+- spec/units/api/get_quotes_by_request_spec.rb
+- spec/units/api/soap_client_spec.rb
+- spec/units/delivery/door_to_door_spec.rb
+- spec/units/item/general_goods_spec.rb
+- spec/units/request_spec.rb