google4r-checkout 1.1.beta3 → 1.1.beta4

data/CHANGES

@@ -1,5 +1,17 @@
 =google4r-checkout Changelog
 
+== 1.1.beta4 (2010-07-09)
+
+* All changes in this release contributed by George Palmer (thanks very much George!)
+* Make the tax field optional as can be set at Google Account level
+* Add a new command ChargeAndShipOrder (v2.5 of the API although we ended up going with 2.4 but it was fully tested and worked)
+* Ability to get the refund amount available in RefundAmountNotification
+* Ability to get gateway fee information
+
+== 1.1.beta3 (2010-06-28)
+
+* Add required test files to the gem build
+
 == 1.1.beta2 (2010-06-23)
 
 * Make gem compatible with Money 3.x (thanks George Palmer!)

data/lib/google4r/checkout/commands.rb

@@ -263,8 +263,10 @@ module Google4R #:nodoc:
       def initialize(frontend)
         super(frontend)
         @shopping_cart = ShoppingCart.new(self)
-        @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(Time.new)
         @shipping_methods = Array.new
+        if frontend.tax_table_factory
+          @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(Time.new)
+        end
       end
       
       # Use this method to create a new shipping method. You have to pass in one of
@@ -353,6 +355,26 @@ module Google4R #:nodoc:
       end
     end
 
+    class ChargeAndShipOrderCommand < Command
+      # The amount to charge, optional, Money
+      attr_accessor :amount
+
+      # if google checkout should email buyer to ssay order is dispatched
+      attr_accessor :send_email
+      
+      # The name of the company responsible for shipping the item. Valid values
+      # for this tag are DHL, FedEx, UPS, USPS and Other.
+      attr_accessor :carrier
+      
+      # The shipper's tracking number that is associated with an order
+      attr_accessor :tracking_number
+
+      # Generates the XML for this ChargeOrderCommand
+      def to_xml
+        ChargeAndShipOrderCommandXmlGenerator.new(self).generate
+      end      
+    end
+
     # The RefundOrderCommand instructs Google Checkout to refund an order
     class RefundOrderCommand < Command
       # The amount to refund, optional, Money

data/lib/google4r/checkout/frontend.rb

@@ -116,6 +116,12 @@ module Google4R #:nodoc:
         return ChargeOrderCommand.new(self)
       end
       
+      # Factory method to create a new ChargeAndShipOrderCommand object. Use this method to 
+      # create your ChargeAndShipOrderCommand instances.
+      def create_charge_and_ship_order_command
+        return ChargeAndShipOrderCommand.new(self)
+      end
+      
       # Factory method that creates a new CheckoutCommand object. Use this method to create 
       # your CheckoutCommand instances.
       def create_checkout_command

data/lib/google4r/checkout/merchant_calculation.rb

@@ -132,7 +132,9 @@ module Google4R #:nodoc:
         @anonymous_addresses = Array.new
         @shipping_methods = Array.new
         @merchant_code_strings = Array.new
-        @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(Time.now)
+        if frontend.tax_table_factory
+          @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(Time.now)
+        end
       end
       
       # Factory method to create a new MerchantCalculationCallback object from 

data/lib/google4r/checkout/notifications.rb

@@ -207,7 +207,9 @@ module Google4R #:nodoc:
       # tax_table_factory.
       def timestamp=(time)
         @timestamp = time
-        @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(time)
+        if frontend.tax_table_factory
+          @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(time)
+        end
       end
       
       # Factory method to create a new CheckoutNotification object from the REXML:Element object
@@ -266,7 +268,9 @@ module Google4R #:nodoc:
       # tax_table_factory.
       def timestamp=(time)
         @timestamp = time
-        @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(time)
+        if frontend.tax_table_factory
+          @tax_tables = frontend.tax_table_factory.effective_tax_tables_at(time)
+        end
       end
       
       # Factory method that creates a new OrderStateChangeNotification from an REXML::Element instance.
@@ -299,6 +303,8 @@ module Google4R #:nodoc:
       
       # The total amount charged for an order (Money)
       attr_accessor :total_charge_amount
+      
+      attr_accessor :latest_charge_fee
 
       # Factory method that creates a new ChargeAmountNotification from an REXML::Element instance.
       # Use this to create instances of ChargeAmountNotification.
@@ -319,6 +325,10 @@ module Google4R #:nodoc:
         amount = (BigDecimal.new(element.elements['total-charge-amount'].text)*100).to_i
         charge.total_charge_amount = Money.new(amount, currency)  
         
+        if element.elements["latest-charge-fee"]
+          charge.latest_charge_fee = ChargeFee.create_from_element(element.elements["latest-charge-fee"])
+        end
+        
         charge.timestamp = Time.parse(element.elements['timestamp'].text)
 
         return charge
@@ -336,6 +346,9 @@ module Google4R #:nodoc:
       # The total amount refunded for an order (Money)
       attr_accessor :total_refund_amount
 
+      # The amount of the fee refunded by Google (Money)
+      attr_accessor :latest_fee_refund_amount
+
       # Factory method that creates a new RefundAmountNotification from an REXML::Element instance.
       # Use this to create instances of RefundAmountNotification.
       #
@@ -355,6 +368,10 @@ module Google4R #:nodoc:
         amount = (BigDecimal.new(element.elements['total-refund-amount'].text)*100).to_i
         refund.total_refund_amount = Money.new(amount, currency)
         
+        currency = element.elements['latest-fee-refund-amount'].attributes['currency']
+        amount = (BigDecimal.new(element.elements['latest-fee-refund-amount'].text)*100).to_i
+        refund.latest_fee_refund_amount = Money.new(amount, currency)
+        
         refund.timestamp = Time.parse(element.elements['timestamp'].text)
 
         return refund

data/lib/google4r/checkout/shared.rb

@@ -1261,6 +1261,26 @@ module Google4R #:nodoc:
       end
     end
     
+    # ChargeFee instances are used in the ChargeAmountNotifications
+    class ChargeFee
+      # The flat portion of the fee (Money)
+      attr_accessor :flat
+      
+      # The percentage of the transaction value (Float)
+      attr_accessor :percentage
+      
+      # The total fee (Money)
+      attr_accessor :total
+      
+      def self.create_from_element(element)
+        result = ChargeFee.new
+        result.flat = Money.new(element.elements['flat'].text.to_f * 100, nil)
+        result.percentage = element.elements['percentage'].text.to_f
+        result.total = Money.new(element.elements['total'].text.to_f * 100, nil)
+        result
+      end
+    end
+    
     # financial_state
     # REVIEWING - Google Checkout is reviewing the order.
     # CHARGEABLE - The order is ready to be charged.

data/lib/google4r/checkout/xml_generation.rb

@@ -57,6 +57,7 @@ module Google4R #:nodoc:
       # The list of command tag names
       COMMAND_TO_TAG =
       {
+        ChargeAndShipOrderCommand => "charge-and-ship-order",
         ChargeOrderCommand => 'charge-order',
         RefundOrderCommand => 'refund-order',
         CancelOrderCommand => 'cancel-order',
@@ -618,6 +619,33 @@ module Google4R #:nodoc:
         amount_element.add_attribute('currency', money.currency.to_s)
       end
     end
+    
+    class ChargeAndShipOrderCommandXmlGenerator < CommandXmlGenerator
+      
+      protected
+      
+      def process_command(command)
+        root = super
+        process_money(root, command.amount) if command.amount
+        process_tracking_data(root, command.carrier, command.tracking_number)
+        root.add_element('send-email').text = command.send_email.to_s if command.send_email
+      end
+      
+      def process_money(parent, money)
+        amount_element = parent.add_element('amount')
+        amount_element.text = money.to_s
+        amount_element.add_attribute('currency', money.currency.to_s)
+      end
+
+      def process_tracking_data(parent, carrier, tracking_number)
+        if carrier and tracking_number then
+          e1 = parent.add_element('tracking-data-list')
+          e2 = e1.add_element('tracking-data')
+          e2.add_element('carrier').text = carrier
+          e2.add_element('tracking-number').text = tracking_number
+        end
+      end
+    end
 
     class RefundOrderCommandXmlGenerator < CommandXmlGenerator
 

data/test/unit/charge_amount_notification_test.rb

@@ -46,6 +46,11 @@ class Google4R::Checkout::ChargeAmountNotificationTest < Test::Unit::TestCase
   <google-order-number>722226456784742</google-order-number>
   <latest-charge-amount currency="GBP">1.23</latest-charge-amount>
   <total-charge-amount currency="GBP">9.99</total-charge-amount>
+  <latest-charge-fee>
+    <total>1.21</total>
+    <flat>0.2</flat>
+    <percentage>3.4</percentage>
+  </latest-charge-fee>
 </charge-amount-notification>
 }
   end
@@ -60,5 +65,8 @@ class Google4R::Checkout::ChargeAmountNotificationTest < Test::Unit::TestCase
     assert_equal Time.parse('2007-05-06T18:41:21.000Z'), notification.timestamp
     assert_equal(Money.new(999, 'GBP'), notification.total_charge_amount)
     assert_equal(Money.new(123, 'GBP'), notification.latest_charge_amount)
+    assert_equal(Money.new(20, nil), notification.latest_charge_fee.flat)
+    assert_equal(3.4, notification.latest_charge_fee.percentage)
+    assert_equal(Money.new(121, nil), notification.latest_charge_fee.total)
   end
 end

data/test/unit/charge_and_ship_order_command_test.rb

@@ -0,0 +1,69 @@
+#--
+# Project:   google_checkout4r 
+# File:      test/unit/charge_order_command_test.rb
+# Author:    George Palmer <george.palmer at gmail dot com>
+# Copyright: (c) 2010 by George Palmer
+# License:   MIT License as follows:
+#
+# 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. 
+#++
+
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+
+# Tests for the ChargeOrderCommand class.
+class Google4R::Checkout::ChargeAndShipOrderCommandTest < Test::Unit::TestCase
+  include Google4R::Checkout
+
+  def setup
+    @frontend = Frontend.new(FRONTEND_CONFIGURATION)
+    @command = @frontend.create_charge_and_ship_order_command
+    @command.google_order_number = '1234-5678-ABCD-1234'
+    @command.amount = Money.new(1000, 'GBP')
+  end
+  
+  def test_behaves_correctly
+    [ :google_order_number, :amount, :send_email, :carrier, :tracking_number ].each do |symbol|
+      assert_respond_to @command, symbol
+    end
+  end
+
+  def test_xml_without_amount
+    @command.amount = nil
+    assert_no_command_element_exists("amount", @command)
+  end
+
+  def test_accessors
+    assert_equal('1234-5678-ABCD-1234', @command.google_order_number)
+    assert_equal(Money.new(1000, 'GBP'), @command.amount)
+  end
+
+  def test_xml_generation
+    assert_command_element_text_equals("10.00", "> amount[currency=GBP]", @command)
+  end
+
+  def test_to_xml_does_not_raise_exception
+    assert_nothing_raised { @command.to_xml }
+  end
+
+end

data/test/unit/charge_fee_test.rb

@@ -0,0 +1,53 @@
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+#--
+# Project:   google_checkout4r 
+# File:      test/unit/tracking_data_test.rb
+# Author:    George Palmer <george.palmer at gmail dot com>
+# Copyright: (c) 2007 by George Palmer
+# License:   MIT License as follows:
+#
+# 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. 
+#++
+
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+
+# Test for the class TrackingData.
+class Google4R::Checkout::ChargeFeeTest < Test::Unit::TestCase
+  include Google4R::Checkout
+
+  def setup
+    @charge_fee = ChargeFee.new
+    @charge_fee.flat = 0.5
+    @charge_fee.percentage = 5.0
+    @charge_fee.total = 12.10
+  end
+  
+  def test_responds_correctly 
+    [ :flat, :percentage, :total].each do |sym|
+      assert_respond_to @charge_fee, sym
+    end
+  end
+end

data/test/unit/refund_amount_notification_test.rb

@@ -46,6 +46,7 @@ class Google4R::Checkout::RefundAmountNotificationTest < Test::Unit::TestCase
   <google-order-number>841171949013218</google-order-number>
   <latest-refund-amount currency="GBP">226.06</latest-refund-amount>
   <total-refund-amount currency="GBP">226.06</total-refund-amount>
+  <latest-fee-refund-amount>5.04</latest-fee-refund-amount>
   <timestamp>2006-03-18T20:25:31</timestamp>
 </refund-amount-notification>
 }
@@ -61,5 +62,6 @@ class Google4R::Checkout::RefundAmountNotificationTest < Test::Unit::TestCase
     assert_equal Time.parse('2006-03-18T20:25:31'), notification.timestamp
     assert_equal(Money.new(22606, 'GBP'), notification.total_refund_amount)
     assert_equal(Money.new(22606, 'GBP'), notification.latest_refund_amount)
+    assert_equal(Money.new(504, nil), notification.latest_fee_refund_amount)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google4r-checkout
 version: !ruby/object:Gem::Version 
-  hash: -1848230121
+  hash: -1848230124
   prerelease: true
   segments: 
   - 1
   - 1
-  - beta3
-  version: 1.1.beta3
+  - beta4
+  version: 1.1.beta4
 platform: ruby
 authors: 
 - Tony Chan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-28 00:00:00 -04:00
+date: 2010-07-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,6 +69,8 @@ files:
 - test/unit/cancel_order_command_test.rb
 - test/unit/carrier_calculated_shipping_test.rb
 - test/unit/charge_amount_notification_test.rb
+- test/unit/charge_and_ship_order_command_test.rb
+- test/unit/charge_fee_test.rb
 - test/unit/charge_order_command_test.rb
 - test/unit/chargeback_amount_notification_test.rb
 - test/unit/checkout_command_test.rb
@@ -173,6 +175,8 @@ test_files:
 - test/unit/cancel_order_command_test.rb
 - test/unit/carrier_calculated_shipping_test.rb
 - test/unit/charge_amount_notification_test.rb
+- test/unit/charge_and_ship_order_command_test.rb
+- test/unit/charge_fee_test.rb
 - test/unit/charge_order_command_test.rb
 - test/unit/chargeback_amount_notification_test.rb
 - test/unit/checkout_command_test.rb