spree_temando 0.1.4 → 0.2.0

data/README.md

@@ -55,6 +55,78 @@ It's important to note that all products in the cart must have their
 dimensions filled out (height, length, depth, weight), otherwise Temando
 will not be able to quote.
 
+## Customisations
+
+To simplify all the options for feeding product data to Temando, you can
+define the `Spree::Variant#populate_temando_item` method, which will be
+called back after the Variant has been turned into a Temando Item.
+
+A few examples are included below to give you a hint at the
+possibilities.
+
+### Shipping Optimisations
+
+The temando API allows for items to be identified as eligible for
+optimisation (ie. they can be grouped together in a defined packaging
+size), or ineligible for optimisation (ie. already packed and can't be
+combined).
+
+Because there are numerous different ways you might want to implement
+this logic in your site, you must calculate this from the
+`Spree::Variant#populate_temando_item` callback.
+
+```ruby
+module VariantDecorator
+
+  def populate_temando_item(item)
+    item.packaging_optimization = %w( Bundle Free ).include?(product.shipping_category.try(:name)) ? "Y" : "N"
+
+    item
+  end
+
+end
+Spree::Variant.send(:include, VariantDecorator)
+```
+
+The above example assumes that you're using a shipping category to
+decide, and products in the "Bundle" or "Free" categories are
+optimisable.
+
+### Packaging Types
+
+A similar situation arises with the shipping packaging. Because
+different shipping methods are defined against different packaging types
+(eg. parcels, pallets, etc) you often need to drive these from the
+product categories.
+
+To do this, you can adjust the Item returned by and set the correct
+`shipping_packaging`. (See the Temando API for details on valid values).
+
+The Temando gem defaults to `Parcel` packaging type if nothing is
+explicitly set.
+
+```ruby
+module VariantDecorator
+
+  def populate_temando_item(item)
+    case product.shipping_category.try(:name)
+    when 'Pallet'
+      item.shipping_packaging = 'Pallet'
+      item.pallet_type        = 'Plain'
+      item.pallet_nature      = 'Not Required'
+    when 'Box'
+      item.shipping_packaging = 'Box'
+    else
+      item.shipping_packaging = 'Parcel'
+    end
+
+    item
+  end
+
+end
+Spree::Variant.send(:include, VariantDecorator)
+```
+
 ## Notes
 
 The extension only makes requests to the Temando API when the order

data/app/models/spree_temando/variant_shipping_decorator.rb

@@ -10,7 +10,12 @@ module SpreeTemando
     def to_temando_item
       return nil unless self.temando_quotable?
       item = Temando::Item::GeneralGoods.new
-      item.packaging_optimization = self.packaging_optimization
+
+      if self.respond_to?(:packaging_optimization) then
+        Rails.logger.warn 'DEPRECATED: Spree::Variant#packaging_optimization. Use #populate_temando_item instead'
+        item.packaging_optimization = self.packaging_optimization
+      end
+
       # NOTE: All the distances in Temando are in metres
       item.height = (self.height / 100.0)
       item.length = (self.depth / 100.0)
@@ -18,6 +23,9 @@ module SpreeTemando
       item.weight = self.weight
       item.quantity = 1
       item.description = self.name
+
+      item = populate_temando_item(item) if self.respond_to?(:populate_temando_item)
+
       item
     end
   end

data/lib/spree_temando/version.rb

@@ -1,3 +1,3 @@
 module SpreeTemando
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_temando
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2012-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,23 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
-  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'
-- !ruby/object:Gem::Dependency
-  name: pry-remote
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: