google4r-checkout 1.0.2 → 1.0.3

data/lib/google4r/checkout/utils.rb

@@ -0,0 +1,94 @@
+#--
+# Project:   google4r
+# File:      lib/google4r/checkout/utils.rb 
+# Author:    Tony Chan <api.htchan@gmail.com>
+# Copyright: (c) 2007 by Tony Chan
+# 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. 
+#++
+# This file contains the classes and modules that are used by the command
+# generating code.
+
+require 'cgi'
+require 'openssl'
+require 'base64'
+
+module Google4R #:nodoc:
+  module Checkout #:nodoc:
+    # HTML Signing
+    #
+    # Args:
+    # - params -- html form parameters
+    # - merchant_key -- Google Checkout merchant key
+    #
+    # Returns:
+    # - signature -- The base-64 encoded result of hashing the serialized
+    #                parameters with the merchant key
+    #
+    # Example
+    # -------
+    # require 'google4r/checkout/utils'
+    #
+    # Google4R::Checkout.sign({:a=>'123', :b=>'456'}, 'merchantkey')
+    # => "5qBQYatFZk5BMS1hm5gSUS+9yrg="
+    #
+    def self.sign(params, merchant_key)
+      raise "params must be a Hash (e.g. {param1 => value1, param2 => value2, ...})" unless params.kind_of? Hash
+      raise "merchant_key must be a String" unless merchant_key.kind_of? String
+      
+      # Remove unwanted parameters
+      params.delete_if do |key, value|
+        key = key.to_s
+        key == '_charset_' || key == 'analyticsdata' ||
+        key == 'urchindata' || key =~ /^(.+\.)*[xy]$/
+      end
+      
+      # Strip away whitespaces and url-encode the values
+      params.each do |key, value|
+        params[key] = CGI::escape(value.to_s.strip)
+      end
+      
+      # Sort parameters alphabetically by value and then key
+      params_arr = params.sort do |x, y|
+        if x[0] != y[0] then
+          x[0].to_s <=> y[0].to_s
+        else
+          x[1].to_s <=> y[1].to_s
+        end
+      end
+    
+      # Create parameter string to be hashed 
+      params_str = ''
+      params_arr.each do |x|
+        if params_str != '' then params_str += '&' end
+        params_str += x[0].to_s + '=' + x[1]
+      end
+
+      # Generate hashed signature
+      signature = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new,
+                                       merchant_key,
+                                       params_str)
+    
+      # Encode the hash value in Base64 before returning it
+      return Base64.encode64(signature).chomp
+    end
+  end
+end

data/lib/google4r/checkout/xml_generation.rb

@@ -35,6 +35,10 @@ module Google4R #:nodoc:
   module Checkout #:nodoc:
     
     class XmlGenerator
+      def initialize()
+        raise 'Cannot instantiate an abstract class.'
+      end
+      
       # Base method to generate the XML for a particular command
       def generate
         @document = REXML::Document.new
@@ -52,27 +56,35 @@ module Google4R #:nodoc:
       # The list of command tag names
       COMMAND_TO_TAG =
       {
-        ChargeOrderCommand => "charge-order",
-        RefundOrderCommand => "refund-order",
-        CancelOrderCommand => "cancel-order",
-        AuthorizeOrderCommand => "authorize-order",
-        ProcessOrderCommand => "process-order",
-        AddMerchantOrderNumberCommand => "add-merchant-order-number",
-        DeliverOrderCommand  => "deliver-order",
-        AddTrackingDataCommand => "add-tracking-data",
-        SendBuyerMessageCommand => "send-buyer-message",
-        ArchiveOrderCommand => "archive-order",
-        UnarchiveOrderCommand => "unarchive-order"
+        ChargeOrderCommand => 'charge-order',
+        RefundOrderCommand => 'refund-order',
+        CancelOrderCommand => 'cancel-order',
+        AuthorizeOrderCommand => 'authorize-order',
+        ProcessOrderCommand => 'process-order',
+        AddMerchantOrderNumberCommand => 'add-merchant-order-number',
+        DeliverOrderCommand  => 'deliver-order',
+        AddTrackingDataCommand => 'add-tracking-data',
+        SendBuyerMessageCommand => 'send-buyer-message',
+        ArchiveOrderCommand => 'archive-order',
+        UnarchiveOrderCommand => 'unarchive-order',
+        ShipItemsCommand => 'ship-items',
+        BackorderItemsCommand => 'backorder-items',
+        CancelItemsCommand => 'cancel-items',
+        ReturnItemsCommand => 'return-items',
+        ResetItemsShippingInformationCommand => 'reset-items-shipping-information'
       }
       
       def initialize(command)
-        super()
-        @command = command
+        if COMMAND_TO_TAG.has_key?(command.class)
+          @command = command
+        else
+          raise 'Cannot instantiate an abstract class.'
+        end
       end
       
       # Base method to generate the XML for a particular command
       def generate
-        super()
+        super
         self.process_command(@command)
         io = StringIO.new
         @document.write(io, 0) # TODO: Maybe replace 0 by -1 so no spaces are inserted?
@@ -91,7 +103,7 @@ module Google4R #:nodoc:
         root = @document.add_element(tag_name)
         root.add_attribute('google-order-number', command.google_order_number)
         root.add_attribute('xmlns', 'http://checkout.google.com/schema/2')
-        return root;
+        return root
       end
     end
     
@@ -111,6 +123,10 @@ module Google4R #:nodoc:
     #++
     class CheckoutCommandXmlGenerator < CommandXmlGenerator
       
+      def initialize(command)
+        @command = command
+      end
+      
       protected
       
       def process_command(command)
@@ -171,6 +187,13 @@ module Google4R #:nodoc:
         command.shipping_methods.each do |shipping_method|
           self.process_shipping_method(shippings_element, shipping_method)
         end
+
+        # <analytics-data>
+        unless command.analytics_data.nil? then
+          analytics_element = flow_element.add_element('analytics-data')
+          analytics_element.text = command.analytics_data
+        end
+
       end
       
       # adds the tax-tables to the parent xml element
@@ -247,6 +270,12 @@ module Google4R #:nodoc:
           item_element.add_element('merchant-item-id').text = item.id 
         end
         
+        if not item.weight.nil? then
+          item_element.add_element('item-weight', 
+              { 'unit' => item.weight.unit,
+                'value' => item.weight.value })
+        end
+        
         if not item.private_data.nil? then
           self.process_hash(item_element.add_element('merchant-private-item-data'), item.private_data)
         end
@@ -256,6 +285,33 @@ module Google4R #:nodoc:
         if not item.tax_table.nil? then
           item_element.add_element('tax-table-selector').text = item.tax_table.name
         end
+        
+        if not item.digital_content.nil? then
+          self.process_digital_content(item_element, item.digital_content)
+        end
+      end
+      
+      # Adds a <digital-content> element to a parent (<item>) element
+      def process_digital_content(parent, digital_content)
+        digital_content_element = parent.add_element('digital-content')
+
+        if not digital_content.description.nil? then
+          digital_content_element.add_element('description').text = digital_content.description.to_s
+        end
+
+        if digital_content.email_delivery? then
+          digital_content_element.add_element('email-delivery').text = digital_content.email_delivery.to_s
+        end
+
+        if not digital_content.key.nil? then
+          digital_content_element.add_element('key').text = digital_content.key.to_s
+        end
+
+        if not digital_content.url.nil? then
+          digital_content_element.add_element('url').text = digital_content.url.to_s
+        end
+
+        digital_content_element.add_element('display-disposition').text = digital_content.display_disposition.to_s
       end
       
       # Adds an item for the given shipping method.
@@ -266,6 +322,8 @@ module Google4R #:nodoc:
           process_shipping('flat-rate-shipping', parent, shipping_method)
         elsif shipping_method.kind_of? MerchantCalculatedShipping then
           process_shipping('merchant-calculated-shipping', parent, shipping_method)
+        elsif shipping_method.kind_of? CarrierCalculatedShipping then
+          process_carrier_calculated_shipping('carrier-calculated-shipping', parent, shipping_method)
         else
           raise "Unknown ShippingMethod type of #{shipping_method.inspect}!"
         end
@@ -327,6 +385,67 @@ module Google4R #:nodoc:
         element.add_element('price', { 'currency' => shipping.price.currency }).text = shipping.price.to_s
       end
       
+      def process_carrier_calculated_shipping(shipping_type, parent, shipping)
+        element = parent.add_element(shipping_type)
+        options_element = element.add_element('carrier-calculated-shipping-options')
+        packages_element = element.add_element('shipping-packages')
+        shipping.carrier_calculated_shipping_options.each do | option |
+          process_carrier_calculated_shipping_option(options_element, option)
+        end
+        shipping.shipping_packages.each do | package |
+          process_shipping_package(packages_element, package)
+        end
+      end
+      
+      def process_carrier_calculated_shipping_option(parent, option)
+        element = parent.add_element('carrier-calculated-shipping-option')
+        element.add_element('price', { 'currency' => option.price.currency }).text = option.price.to_s
+        element.add_element('shipping-company').text = option.shipping_company
+        element.add_element('shipping-type').text = option.shipping_type
+        if not option.carrier_pickup.nil?
+          element.add_element('carrier-pickup').text = option.carrier_pickup
+        end
+        if not option.additional_fixed_charge.nil?
+          element.add_element('additional-fixed-charge', 
+              { 'currency' => option.additional_fixed_charge.currency }).text = 
+              option.additional_fixed_charge.to_s
+        end
+        if not option.additional_variable_charge_percent.nil?
+          element.add_element('additional-variable-charge-percent').text = 
+              option.additional_variable_charge_percent.to_s
+        end
+      end
+      
+      def process_shipping_package(parent, package)
+        element = parent.add_element('shipping-package')
+        ship_from = package.ship_from
+        ship_from_element = element.add_element('ship-from')
+        ship_from_element.add_attribute('id', ship_from.address_id)
+        ship_from_element.add_element('city').text = ship_from.city
+        ship_from_element.add_element('region').text = ship_from.region
+        ship_from_element.add_element('country-code').text = ship_from.country_code
+        ship_from_element.add_element('postal-code').text = ship_from.postal_code
+        if not package.delivery_address_category.nil?
+          element.add_element('delivery-address-category').text = 
+              package.delivery_address_category
+        end
+        if not package.height.nil?
+          height_element = element.add_element('height')
+          height_element.add_attribute('unit', package.height.unit)
+          height_element.add_attribute('value', package.height.value)
+        end
+        if not package.length.nil?
+          length_element = element.add_element('length')
+          length_element.add_attribute('unit', package.length.unit)
+          length_element.add_attribute('value', package.length.value)
+        end
+        if not package.width.nil?
+          width_element = element.add_element('width')
+          width_element.add_attribute('unit', package.width.unit)
+          width_element.add_attribute('value', package.width.value)
+        end
+      end
+      
       # Adds an appropriate tag for the given Area subclass instance to the parent Element.
       def process_area(parent, area)
         if area.kind_of? UsZipArea then
@@ -458,7 +577,7 @@ module Google4R #:nodoc:
         
         if command.comment then
           root.add_element('comment').text = command.comment
-        end        
+        end
       end
 
     end
@@ -573,7 +692,7 @@ module Google4R #:nodoc:
       end
       
       def generate()
-        super()
+        super
         process_results(@merchant_calculation_results.merchant_calculation_results)
         io = StringIO.new
         @document.write(io, 0) # TODO: Maybe replace 0 by -1 so no spaces are inserted?
@@ -629,5 +748,98 @@ module Google4R #:nodoc:
         element.add_element("message").text = merchant_code_result.message
       end
     end
+
+    class NotificationAcknowledgementXmlGenerator < XmlGenerator
+      
+      def initialize(notification_acknowledgement)
+        @notification_acknowledgement = notification_acknowledgement
+      end
+
+      def generate
+        super
+        self.process_notification_acknowledgement(@notification_acknowledgement) 
+        io = StringIO.new
+        @document.write(io, -1)
+        return io.string
+      end
+
+      def process_notification_acknowledgement(notification_acknowledgement)
+        root = @document.add_element('notification-acknowledgment')
+        root.add_attribute('xmlns', 'http://checkout.google.com/schema/2')
+        if not notification_acknowledgement.serial_number.nil?
+          root.add_attribute('serial-number', notification_acknowledgement.serial_number)
+        end
+      end
+    end
+
+    # Line-item shipping commands
+    class ItemsCommandXmlGenerator < CommandXmlGenerator
+      protected
+      
+      def process_command(command)
+        root = super
+        process_item_info_arr(root, command.item_info_arr)
+        process_send_email(root, command.send_email)
+        return root
+      end
+      
+      def process_item_info_arr(parent, item_info_arr)
+        element = parent.add_element('item-ids')
+        item_info_arr.each do |item_info|
+          item_id = element.add_element('item-id')
+          item_id.add_element('merchant-item-id').text = 
+              item_info.merchant_item_id
+        end
+      end
+      
+      def process_send_email(parent, send_email)
+        parent.add_element('send-email').text = send_email.to_s
+      end
+    end
+    
+    class ShipItemsCommandXmlGenerator < ItemsCommandXmlGenerator
+      protected
+
+      def process_item_info_arr(parent, item_info_arr)
+        e1 = parent.add_element('item-shipping-information-list')
+        item_info_arr.each do |item_info|
+          e2 = e1.add_element('item-shipping-information')
+          item_id = e2.add_element('item-id')
+          item_id.add_element('merchant-item-id').text = 
+              item_info.merchant_item_id
+          if !item_info.tracking_data_arr.nil?
+            e3 = e2.add_element('tracking-data-list')
+            item_info.tracking_data_arr.each do |tracking_data|
+              e4 = e3.add_element('tracking-data')
+              e4.add_element('carrier').text = tracking_data.carrier
+              e4.add_element('tracking-number').text = 
+                  tracking_data.tracking_number
+            end
+          end
+        end
+      end
+    end
+    
+    class BackorderItemsCommandXmlGenerator < ItemsCommandXmlGenerator
+    end
+    
+    class CancelItemsCommandXmlGenerator < ItemsCommandXmlGenerator
+      protected
+      
+      def process_command(command)
+        root = super
+        root.add_element('reason').text = command.reason
+        
+        if command.comment then
+          root.add_element('comment').text = command.comment
+        end
+      end
+    end
+    
+    class ReturnItemsCommandXmlGenerator < ItemsCommandXmlGenerator
+    end
+    
+    class ResetItemsShippingInformationCommandXmlGenerator < ItemsCommandXmlGenerator
+    end
   end
 end

data/test/integration/checkout_command_test.rb

@@ -49,6 +49,22 @@ class Google4R::Checkout::CheckoutCommandIntegrationTest < Test::Unit::TestCase
     assert_kind_of CheckoutRedirectResponse, result
   end
   
+  def test_sending_to_google_works_with_merchant_calculated_shipping
+    setup_command(@command, MerchantCalculatedShipping)
+    result = @command.send_to_google_checkout
+    assert_kind_of CheckoutRedirectResponse, result
+  end
+  
+  def test_sending_to_google_works_with_carrier_calculated_shipping
+    setup_command(@command, CarrierCalculatedShipping)
+    result = @command.send_to_google_checkout
+    # Uncomment the two lines below to see the shopping cart xml and
+    # the redirect URL
+    #puts @command.to_xml
+    #puts result
+    assert_kind_of CheckoutRedirectResponse, result
+  end
+  
   def test_using_invalid_credentials_raise_google_checkout_error
     invalid_patches = [ [ :merchant_id, 'invalid' ], [ :merchant_key, 'invalid' ] ]
     
@@ -77,9 +93,11 @@ class Google4R::Checkout::CheckoutCommandIntegrationTest < Test::Unit::TestCase
   
   protected
   
-    # Sets up the given CheckoutCommand so it contains some
-    # shipping methods and its cart contains some items.
-    def setup_command(command)
+  # Sets up the given CheckoutCommand so it contains some
+  # shipping methods and its cart contains some items.
+  def setup_command(command, shipping_type=FlatRateShipping)
+    
+    if shipping_type == FlatRateShipping
       # Add shipping methods.
       command.create_shipping_method(FlatRateShipping) do |shipping|
         shipping.name = 'UPS Ground Shipping'
@@ -88,16 +106,59 @@ class Google4R::Checkout::CheckoutCommandIntegrationTest < Test::Unit::TestCase
           area.area = UsCountryArea::ALL
         end
       end
+    end
+    
+    if shipping_type == MerchantCalculatedShipping
+      command.merchant_calculations_url = 'http://www.example.com'
       
-      # Add items to the cart.
-      1.upto(5) do |i|
-        command.shopping_cart.create_item do |item|
-          item.name = "Test Item #{i}"
-          item.description = "This is a test item (#{i})"
-          item.unit_price = Money.new(350)
-          item.quantity = i * 3
-          item.id = "test-#{i}-123456789"
+      command.create_shipping_method(MerchantCalculatedShipping) do |shipping|
+        shipping.name = 'International Shipping'
+        shipping.price = Money.new(2000)
+        shipping.create_address_filters_allowed_area(PostalArea) do |area|
+          area.country_code = 'US'
+          area.postal_code_pattern = '12*'
+        end
+      end
+    end
+    
+    if shipping_type == CarrierCalculatedShipping
+      command.create_shipping_method(CarrierCalculatedShipping) do |shipping|
+        shipping.create_carrier_calculated_shipping_option do | option |
+          option.shipping_company = 
+              CarrierCalculatedShipping::CarrierCalculatedShippingOption::FEDEX
+          option.price = Money.new(3000)
+          option.shipping_type = 'Priority Overnight'
+          option.carrier_pickup = 'REGULAR_PICKUP'
+          option.additional_fixed_charge = Money.new(500)
+          option.additional_variable_charge_percent = 15.5
+        end
+        shipping.create_shipping_package do | package |
+          ship_from = AnonymousAddress.new
+          ship_from.address_id = 'ABC'
+          ship_from.city = 'Ann Arbor'
+          ship_from.region = 'MI'
+          ship_from.country_code = 'US'
+          ship_from.postal_code = '48104'
+          package.ship_from = ship_from
+          package.delivery_address_category = 
+              CarrierCalculatedShipping::ShippingPackage::COMMERCIAL
+          package.height = Dimension.new(1)
+          package.length = Dimension.new(2)
+          package.width = Dimension.new(3)
         end
       end
     end
+    
+    # Add items to the cart.
+    1.upto(5) do |i|
+      command.shopping_cart.create_item do |item|
+        item.name = "Test Item #{i}"
+        item.description = "This is a test item (#{i})"
+        item.unit_price = Money.new(350)
+        item.quantity = i * 3
+        item.id = "test-#{i}-123456789"
+        item.weight = Weight.new(2.2)
+      end
+    end
+  end
 end