spree_temando 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,71 @@
+# SpreeTemando
+
+`spree_temando` adds support to Spree to calculate a shipping quote
+using [Temando](https://www.temando.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spree_temando'
+
+And then execute:
+
+    $ bundle
+    $ rake spree_temando:install:migrations
+    $ rake db:migrate
+
+Or install it yourself as:
+
+    $ gem install spree_temando
+
+Finally, in an initializer, set up your authentication keys :
+
+```ruby
+Temando::Api::Base.config.username = ENV['TEMANDO_USERNAME']
+Temando::Api::Base.config.password = ENV['TEMANDO_PASSWORD']
+```
+
+## Usage
+
+The extension adds a new Shipping calculator.
+
+Add a new Shipping Method from the Spree Admin (under Configuration >
+Shipping Methods), and you can set the relevant calculator type to
+`Temando`.
+
+There are a few options you must fill out :
+
+* `Origin Suburb` - the suburb you will be shipping from.
+* `Origin Postcode` - the postcode you will be shipping from.
+* `Express` - select this to find the fastest & cheapest shipping quote.
+
+It is possible to create multiple calculators with different settings -
+for example, a "Regular" method with Express disabled, and an "Express"
+method with Express enabled.
+
+In the calculations, the extension always attempts to find the cheapest
+quote, but when `Express` is selected, only the quotes with the smallest
+`maximum_eta` are considered.
+
+## Notes
+
+The extension only makes requests to the Temando API when the order
+changes in some way - either address details, line items, or the like.
+This ensures that a customer going back and forth between the Address
+and Delivery pages does not bombard the Temando API with spurious
+requests.
+
+However, each time the calculator is used *does* cause another request.
+For example, the example of two shipping methods above will cause two
+requests to the API for the relevant quotes, even though they expect the
+same data.
+
+
+## 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,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SpreeTemando'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/controllers/spree_temando/application_controller.rb

@@ -0,0 +1,4 @@
+module SpreeTemando
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/spree_temando/application_helper.rb

@@ -0,0 +1,4 @@
+module SpreeTemando
+  module ApplicationHelper
+  end
+end

data/app/models/spree/calculator/temando_quote.rb

@@ -0,0 +1,88 @@
+module Spree
+  class Calculator::TemandoQuote < Calculator
+    # TODO: Add option to select insured
+
+    preference :origin_suburb, :string
+    preference :origin_postcode, :string
+    preference :express, :boolean
+
+    attr_accessible :preferred_origin_suburb, :preferred_origin_postcode, :preferred_express
+
+    def self.description
+      I18n.t(:temando)
+    end
+
+    def self.available?(object)
+      true
+    end
+
+    def cheapest(destination, line_items)
+      quotes = find_quotes(destination, line_items)
+      cheapest = quotes.sort_by { |q| q.total_price }.first
+      { :price => cheapest.total_price, :minimum_eta => cheapest.minimum_eta, :maximum_eta => cheapest.maximum_eta, :quote => cheapest }
+    end
+
+    def fastest(destination, line_items)
+      quotes = find_quotes(destination, line_items)
+      fastest_eta = quotes.collect(&:maximum_eta).min
+      cheapest = quotes.reject { |q| q.maximum_eta > fastest_eta }.sort_by { |q| q.total_price }.first
+      { :price => cheapest.total_price, :minimum_eta => cheapest.minimum_eta, :maximum_eta => cheapest.maximum_eta, :quote => cheapest }
+    end
+
+    def temando_origin
+      Temando::Location.new(:suburb => preferred_origin_suburb, :postcode => preferred_origin_postcode, :country => 'AU')
+    end
+
+    def compute(object)
+      if object.is_a?(Spree::Shipment) && object.temando_quotes.blank? then
+        object.temando_quotes = object.order.temando_quotes
+      end
+
+      existing_quote = object.temando_quotes.find_by_calculator_id(self.id)
+
+      if existing_quote.blank? || existing_quote.outdated? then
+        Spree::Order.transaction do
+          destination = case object
+                        when Spree::Order
+                          object.shipping_address
+                        when Spree::Shipment
+                          object.address
+                        else
+                          raise "Unknown object: #{object.inspect}"
+                        end
+
+          if preferred_express then
+            data = fastest(destination.to_temando_location, object.line_items)
+          else
+            data = cheapest(destination.to_temando_location, object.line_items)
+          end
+
+          quote = Spree::TemandoQuote.new_or_update_from_quote(self, object, data[:quote], destination)
+
+          # Store the Quote data against the Order and these LineItems if they are persisted
+          if object.persisted? then
+            quote.save!
+
+            object.line_items
+          end
+
+          existing_quote = quote
+        end
+      end
+
+      existing_quote.total_price
+    end
+
+private
+    def find_quotes(destination, line_items)
+      delivery = Temando::Delivery::DoorToDoor.new(self.temando_origin, destination)
+
+      request = Temando::Request.new
+      line_items.reject { |i| i.quantity < 1 }.each do |item|
+        request.items << item.to_temando_item
+      end
+
+      request.quotes_for(delivery)
+    end
+  end
+end

data/app/models/spree/temando_quote.rb

@@ -0,0 +1,49 @@
+require 'digest/sha1'
+
+module Spree
+  # TemandoQuote object is a representation of the selected Quote provided by
+  # the Temando API.
+  class TemandoQuote < ActiveRecord::Base
+    belongs_to :order
+    belongs_to :shipment
+    belongs_to :address
+    belongs_to :calculator
+
+    def outdated?
+      self.current_items_hash != self.cached_items_hash
+    end
+
+    def calculator_hash
+      Digest::SHA1.hexdigest(self.calculator.preferences.to_s)
+    end
+
+    def address_hash
+      Digest::SHA1.hexdigest(self.address.attributes.to_s)
+    end
+
+    def current_items_hash
+      data = (shipment || order).line_items.order(:variant_id).collect { |li| [ li.variant_id, li.quantity ].join(',') }.join(';')
+      Digest::SHA1.hexdigest(calculator_hash + address_hash + data)
+    end
+
+    def self.new_or_update_from_quote(calculator, object, quote, address)
+      q = object.temando_quotes.find_by_calculator_id(calculator.id) || object.temando_quotes.new
+      q.calculator = calculator
+
+      if object.is_a?(Spree::Order) then
+        q.order = object
+      else
+        q.shipment = object
+      end
+
+      [ :total_price, :tax, :currency, :minimum_eta, :maximum_eta, :name, :base_price, :guaranteed_eta, :carrier_id ].each do |field|
+        q.send("#{field}=".to_sym, quote.send(field))
+      end
+
+      q.address = address
+      q.cached_items_hash = q.current_items_hash
+
+      q
+    end
+  end
+end

data/app/models/spree_temando/address_decorator.rb

@@ -0,0 +1,22 @@
+module SpreeTemando
+  module AddressDecorator
+    def to_temando_location
+      location = Temando::Location.new
+      location.postcode = self.zipcode
+      location.suburb   = self.city
+      location.contact  = "#{self.firstname} #{self.lastname}"
+      location.state    = self.state.name
+      location.street   = [ self.address1, self.address2 ].compact.join(' , ')
+      location.phone1   = self.phone
+      location.phone2   = self.alternative_phone
+      location.company  = self.company
+
+      raise 'Temando only ships to Australia' unless self.country.try(:name) == 'Australia'
+      location.country = 'AU'
+
+      location
+    end
+
+  end
+end
+Spree::Address.send(:include, SpreeTemando::AddressDecorator)

data/app/models/spree_temando/line_item_shipping_decorator.rb

@@ -0,0 +1,10 @@
+module SpreeTemando
+  module LineItemShippingDecorator
+    def to_temando_item
+      item = self.variant.to_temando_item
+      item.quantity = self.quantity
+      item
+    end
+  end
+end
+Spree::LineItem.send(:include, SpreeTemando::LineItemShippingDecorator)

data/app/models/spree_temando/order_shipping_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Order.class_eval do
+  has_many :temando_quotes
+end

data/app/models/spree_temando/shipment_shipping_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Shipment.class_eval do
+  has_many :temando_quotes
+end

data/app/models/spree_temando/variant_shipping_decorator.rb

@@ -0,0 +1,16 @@
+module SpreeTemando
+  module VariantShippingDecorator
+    def to_temando_item
+      item = Temando::Item::GeneralGoods.new
+      # NOTE: All the distances in Temando are in metres
+      item.height = (self.height / 100.0)
+      item.length = (self.depth / 100.0)
+      item.width  = (self.width / 100.0)
+      item.weight = self.weight
+      item.quantity = 1
+      item.description = self.name
+      item
+    end
+  end
+end
+Spree::Variant.send(:include, SpreeTemando::VariantShippingDecorator)

data/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  temando: Temando

data/config/routes.rb

@@ -0,0 +1,2 @@
+SpreeTemando::Engine.routes.draw do
+end

data/db/migrate/20121011082400_create_spree_temando_quotes.rb

@@ -0,0 +1,25 @@
+class CreateSpreeTemandoQuotes < ActiveRecord::Migration
+  def self.up
+    create_table :spree_temando_quotes do |t|
+      t.decimal :total_price,    :scale => 2, :precision => 6
+      t.decimal :base_price,     :scale => 2, :precision => 6
+      t.decimal :tax,            :scale => 2, :precision => 6
+      t.string  :currency
+      t.integer :minimum_eta
+      t.integer :maximum_eta
+
+      t.string  :name
+
+      t.string  :delivery_method
+      t.boolean :guaranteed_eta
+      t.string  :carrier_id
+
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table :spree_temando_quotes
+  end
+end

data/db/migrate/20121011083400_add_orders_temando_quote_id.rb

@@ -0,0 +1,9 @@
+class AddOrdersTemandoQuoteId < ActiveRecord::Migration
+  def self.up
+    add_column :spree_orders, :temando_quote_id, :integer
+  end
+
+  def self.down
+    remove_column :spree_orders, :temando_quote_id
+  end
+end

data/db/migrate/20121011084600_add_temando_quote_address_id.rb

@@ -0,0 +1,9 @@
+class AddTemandoQuoteAddressId < ActiveRecord::Migration
+  def self.up
+    add_column :spree_temando_quotes, :address_id, :integer
+  end
+
+  def self.down
+    remove_column :spree_temando_quotes, :address_id
+  end
+end

data/db/migrate/20121011084900_add_line_items_temando_quote_id.rb

@@ -0,0 +1,9 @@
+class AddLineItemsTemandoQuoteId < ActiveRecord::Migration
+  def self.up
+    add_column :spree_line_items, :temando_quote_id, :integer
+  end
+
+  def self.down
+    remove_column :spree_line_items, :temando_quote_id
+  end
+end

data/db/migrate/20121011092000_add_shipment_temando_quote_id.rb

@@ -0,0 +1,9 @@
+class AddShipmentTemandoQuoteId < ActiveRecord::Migration
+  def self.up
+    add_column :spree_shipments, :temando_quote_id, :integer
+  end
+
+  def self.down
+    remove_column :spree_shipments, :temando_quote_id
+  end
+end

data/db/migrate/20121011104200_add_cached_items_hash_to_temando_quote.rb

@@ -0,0 +1,9 @@
+class AddCachedItemsHashToTemandoQuote < ActiveRecord::Migration
+  def self.up
+    add_column :spree_temando_quotes, :cached_items_hash, :string
+  end
+
+  def self.down
+    remove_column :spree_temando_quotes, :cached_items_hash
+  end
+end

data/db/migrate/20121011115000_remove_temando_quote_delivery_method.rb

@@ -0,0 +1,9 @@
+class RemoveTemandoQuoteDeliveryMethod < ActiveRecord::Migration
+  def self.up
+    remove_column :spree_temando_quotes, :delivery_method
+  end
+
+  def self.down
+    add_column :spree_temando_quotes, :delivery_method, :string
+  end
+end

data/db/migrate/20121017165000_fix_temando_quote_associations.rb

@@ -0,0 +1,16 @@
+class FixTemandoQuoteAssociations < ActiveRecord::Migration
+  def self.up
+    Spree::TemandoQuote.delete_all
+
+    add_column :spree_temando_quotes, :calculator_id, :integer, :null => false
+    add_column :spree_temando_quotes, :order_id, :integer
+    add_column :spree_temando_quotes, :shipment_id, :integer
+
+    remove_column :spree_orders, :temando_quote_id
+    remove_column :spree_shipments, :temando_quote_id
+  end
+
+  def self.down
+    raise ActiveRecord::IrreversableMigration
+  end
+end

data/lib/spree_temando.rb

@@ -0,0 +1,4 @@
+require "spree_temando/engine"
+
+module SpreeTemando
+end

data/lib/spree_temando/engine.rb

@@ -0,0 +1,21 @@
+module SpreeTemando
+  class Engine < ::Rails::Engine
+    isolate_namespace SpreeTemando
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+      Temando::Api::Base.logger = Rails.logger
+    end
+
+    initializer "spree_temando.register.shipping_calculators" do |app|
+      app.config.spree.calculators.shipping_methods << Spree::Calculator::TemandoQuote
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_temando/version.rb

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

data/lib/tasks/spree_temando_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :spree_temando do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: spree_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: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: temando
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.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: Adds temando shipping support to Spree
+email:
+- jason@reinteractive.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/spree_temando/application_controller.rb
+- app/helpers/spree_temando/application_helper.rb
+- app/models/spree/calculator/temando_quote.rb
+- app/models/spree/temando_quote.rb
+- app/models/spree_temando/address_decorator.rb
+- app/models/spree_temando/line_item_shipping_decorator.rb
+- app/models/spree_temando/order_shipping_decorator.rb
+- app/models/spree_temando/shipment_shipping_decorator.rb
+- app/models/spree_temando/variant_shipping_decorator.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20121011082400_create_spree_temando_quotes.rb
+- db/migrate/20121011083400_add_orders_temando_quote_id.rb
+- db/migrate/20121011084600_add_temando_quote_address_id.rb
+- db/migrate/20121011084900_add_line_items_temando_quote_id.rb
+- db/migrate/20121011092000_add_shipment_temando_quote_id.rb
+- db/migrate/20121011104200_add_cached_items_hash_to_temando_quote.rb
+- db/migrate/20121011115000_remove_temando_quote_delivery_method.rb
+- db/migrate/20121017165000_fix_temando_quote_associations.rb
+- lib/spree_temando/engine.rb
+- lib/spree_temando/version.rb
+- lib/spree_temando.rb
+- lib/tasks/spree_temando_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/reInteractive/spree_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: Adds temando shipping support to Spree
+test_files: []