google4r-checkout 1.0.1 → 1.0.2

data/lib/google4r/checkout/shared.rb

@@ -440,9 +440,8 @@ module Google4R #:nodoc:
       end
     end
     
-    # Abstract class for shipping methods. Do not use this class directly but only
-    # one of its subclasses.
-    class ShippingMethod
+    # Abstract class for delivery methods
+    class DeliveryMethod
       # The name of the shipping method (string, required).
       attr_accessor :name
       
@@ -465,54 +464,78 @@ module Google4R #:nodoc:
       end
     end
     
-    # A class that represents the "pickup" shipping method.
-    class PickupShipping < ShippingMethod
-      def initialize
-      end
-    end
-    
-    # A class that represents the "flat_rate" shipping method.
-    class FlatRateShipping < ShippingMethod
-      # An Array of allowed areas for this flat_rate shipping instance. Use 
+    # Abstract class for shipping methods. Do not use this class directly but only
+    # one of its subclasses.
+    class ShippingMethod < DeliveryMethod
+      # An Array of allowed areas for shipping-restrictions of this shipping instance. Use 
       # #create_allowed_area to add to this area but do not change it directly.
-      attr_reader :allowed_areas
+      attr_reader :shipping_restrictions_allowed_areas
       
-      # An Array of excluded areas for this flat_rate shipping instance. Use
+      # An Array of excluded areas for shipping-restrictions of this shipping instance. Use
       # #create_excluded_area to add to this area but do not change it directly.
-      attr_reader :excluded_areas
+      attr_reader :shipping_restrictions_excluded_areas
       
       def initialize
-        @allowed_areas = Array.new
-        @excluded_areas = Array.new
+        @shipping_restrictions_allowed_areas = Array.new
+        @shipping_restrictions_excluded_areas = Array.new
       end
       
-      # Creates a new Area, adds it to the internal list of allowed areas for this
-      # shipping types. If you passed a block (preferred) then the block is called
-      # with the Area as the only parameter.c
+      # This method create a new instance of subclass of Area and put it
+      # in the array determined by the two symbols provided.  The valid
+      # symbols for the first two parameters are:
       #
-      # The area to be created depends on the given parameter clazz. It can be one
+      # type  : :shipping_restrictions, :address_filters
+      # areas : :allowed_areas, :excluded_areas
+      #
+      # The third parameter clazz is used to specify the type of
+      # Area you want to create.  It can be one
       # of { PostalArea, UsCountryArea, UsStateArea, UsZipArea, WorldArea }.
       #
       # Raises a RuntimeError if the parameter clazz is invalid.
       #
+      # If you passed a block (preferred) then the block is called
+      # with the Area as the only parameter.
+      #
       # === Example
       #
-      #    method = FlatRateShipping.new
-      #    method.create_allowed_area(UsCountryArea) do |area|
+      #    method = MerchantCalculatedShipping.new
+      #    method.create_area(:shipping_restrictions, :allowed_areas, UsCountryArea) do |area|
       #       area.area = UsCountryArea::ALL
       #    end
-      def create_allowed_area(clazz, &block)
+      def create_area(type, areas, clazz, &block)
+        areas_array_name = "@#{type.to_s + '_' + areas.to_s}"
+        areas = instance_variable_get(areas_array_name)
+        raise "Undefined instance variable: #{areas_array_name}" unless areas.nil? == false
         raise "Invalid Area class: #{clazz}!" unless [ PostalArea, UsCountryArea, UsStateArea, UsZipArea, WorldArea ].include?(clazz)
         area = clazz.new
-        @allowed_areas << area
+        areas << area
 
         yield(area) if block_given?
         
         return area
       end
       
-      # Creates a new Area, adds it to the internal list of excluded areas for this
-      # shipping types. If you passed a block (preferred) then the block is called
+      # Creates a new Area, adds it to the internal list of allowed areas for this
+      # shipping type. If you passed a block (preferred) then the block is called
+      # with the Area as the only parameter.
+      #
+      # The area to be created depends on the given parameter clazz. It can be one
+      # of { PostalArea, UsCountryArea, UsStateArea, UsZipArea, WorldArea }.
+      #
+      # Raises a RuntimeError if the parameter clazz is invalid.
+      #
+      # === Example
+      #
+      #    method = FlatRateShipping.new
+      #    method.create_allowed_area(UsCountryArea) do |area|
+      #       area.area = UsCountryArea::ALL
+      #    end
+      def create_allowed_area(clazz, &block)
+        return create_area(:shipping_restrictions, :allowed_areas, clazz, &block)
+      end
+      
+      # Creates a new Area, adds it to the internal list of excluded areas for shipping
+      # restrictions. If you passed a block (preferred) then the block is called
       # with the Area as the only parameter. The created area is returned in any case.
       #
       # The area to be created depends on the given parameter clazz. It can be one
@@ -527,14 +550,131 @@ module Google4R #:nodoc:
       #       area.area = UsCountryArea::ALL
       #    end
       def create_excluded_area(clazz, &block)
-        raise "Invalid Area class: #{clazz}!" unless [ PostalArea, UsCountryArea, UsStateArea, UsZipArea, WorldArea ].include?(clazz)
+        return create_area(:shipping_restrictions, :excluded_areas, clazz, &block)
+      end      
+    end
+    
+    # A class that represents the "pickup" shipping method.
+    class PickupShipping < DeliveryMethod
+      def initialize
+      end
+    end
+    
+    # A class that represents the "flat_rate" shipping method.
+    class FlatRateShipping < ShippingMethod
+      def initialize
+        super
+      end
+    end
+    
+    # A class that represents the "merchant-calculated" shipping method
+    class MerchantCalculatedShipping < ShippingMethod
+      
+      # An Array of allowed areas for address-filters of this shipping instance. Use 
+      # #create_allowed_area to add to this area but do not change it directly.
+      attr_reader :address_filters_allowed_areas
+      
+      # An Array of excluded areas for address-filters of this shipping instance. Use
+      # #create_excluded_area to add to this area but do not change it directly.
+      attr_reader :address_filters_excluded_areas
+      
+      def initialize
+        super
+        @address_filters_allowed_areas = Array.new
+        @address_filters_excluded_areas = Array.new
+      end
+      
+    end
+    
+    # This address is used in merchant calculation callback
+    class AnonymousAddress
+      
+      # The address ID (String)
+      attr_accessor :address_id
+      
+      # The buyer's city name (String).
+      attr_accessor :city
+      
+      # The buyers postal/zip code (String).
+      attr_accessor :postal_code
+      
+      # The buyer's geographical region (String).
+      attr_accessor :region
+      
+      # The buyer's country code (String, 2 chars, ISO 3166).
+      attr_accessor :country_code
+      
+      # Creates a new AnonymousAddress from the given REXML::Element instance.
+      def self.create_from_element(element)
+        result = AnonymousAddress.new
+        
+        result.address_id = element.attributes['id']
+        result.city = element.elements['city'].text
+        result.country_code = element.elements['country-code'].text
+        result.postal_code = element.elements['postal-code'].text
+        result.region = element.elements['region'].text
+        return result
+      end
+    end
 
-        area = clazz.new
-        @excluded_areas << area
+    # Address instances are used in NewOrderNotification objects for the buyer's billing
+    # and buyer's shipping address.
+    class Address < AnonymousAddress
+      # Contact name (String, optional).
+      attr_accessor :contact_name
+      
+      # Second Address line (String).
+      attr_accessor :address1
+
+      # Second Address line (String optional).
+      attr_accessor :address2
+      
+      # The buyer's city name (String).
+      # attr_accessor :city
+      # Now inherit from AnonymousAddress
+      
+      # The buyer's company name (String; optional).
+      attr_accessor :company_name
+      
+      # The buyer's country code (String, 2 chars, ISO 3166).
+      # attr_accessor :country_code
+      # Now inherit from AnonymousAddress
+      
+      # The buyer's email address (String; optional).
+      attr_accessor :email
+      
+      # The buyer's phone number (String; optional).
+      attr_accessor :fax
+      
+      # The buyer's phone number (String; Optional, can be enforced in CheckoutCommand).)
+      attr_accessor :phone
+      
+      # The buyers postal/zip code (String).
+      # attr_accessor :postal_code
+      # Now inherit from AnonymousAddress
+      
+      
+      # The buyer's geographical region (String).
+      # attr_accessor :region
+      # Now inherit from AnonymousAddress
+      
+      # Creates a new Address from the given REXML::Element instance.
+      def self.create_from_element(element)
+        result = Address.new
         
-        yield(area) if block_given?
+        result.address1 = element.elements['address1'].text
+        result.address2 = element.elements['address2'].text rescue nil
+        result.city = element.elements['city'].text
+        result.company_name = element.elements['company-name'].text rescue nil
+        result.contact_name = element.elements['contact-name'].text rescue nil
+        result.country_code = element.elements['country-code'].text
+        result.email = element.elements['email'].text rescue nil
+        result.fax = element.elements['fax'].text rescue nil
+        result.phone = element.elements['phone'].text rescue nil
+        result.postal_code = element.elements['postal-code'].text
+        result.region = element.elements['region'].text
         
-        return area
+        return result
       end
     end
   end

data/lib/google4r/checkout/xml_generation.rb

@@ -1,7 +1,8 @@
 #--
 # Project:   google4r
 # File:      lib/google4r/checkout/xml_generation.rb
-# Author:    Manuel Holtgrewe <purestorm at ggnore dot net>
+# Authors:   Manuel Holtgrewe <purestorm at ggnore dot net>
+#            Tony Chan <api.htchan at gmail dot com>
 # Copyright: (c) 2007 by Manuel Holtgrewe
 # License:   MIT License as follows:
 #
@@ -33,9 +34,20 @@ require 'rexml/document'
 module Google4R #:nodoc:
   module Checkout #:nodoc:
     
+    class XmlGenerator
+      # Base method to generate the XML for a particular command
+      def generate
+        @document = REXML::Document.new
+        
+        declaration = REXML::XMLDecl.new
+        declaration.encoding = 'utf-8'
+        @document << declaration
+      end
+    end
+    
     # Abstract super class for all CommandXmlGenerators
     # It should never be instantiated directly
-    class CommandXmlGenerator
+    class CommandXmlGenerator < XmlGenerator
       
       # The list of command tag names
       COMMAND_TO_TAG =
@@ -54,19 +66,14 @@ module Google4R #:nodoc:
       }
       
       def initialize(command)
+        super()
         @command = command
       end
-
+      
       # Base method to generate the XML for a particular command
       def generate
-        @document = REXML::Document.new
-        
-        declaration = REXML::XMLDecl.new
-        declaration.encoding = 'utf-8'
-        @document << declaration
-        
+        super()
         self.process_command(@command)
-        
         io = StringIO.new
         @document.write(io, 0) # TODO: Maybe replace 0 by -1 so no spaces are inserted?
         return io.string
@@ -138,6 +145,26 @@ module Google4R #:nodoc:
               "false"
             end
         end
+       
+        # <merchant-calculations>
+        if not command.merchant_calculations_url.nil? then
+          merchant_calculations = flow_element.add_element('merchant-calculations')
+          merchant_calculations.add_element('merchant-calculations-url').text =
+            command.merchant_calculations_url
+          if not command.accept_merchant_coupons.nil? then
+            merchant_calculations.add_element('accept-merchant-coupons').text =
+              command.accept_merchant_coupons.to_s
+          end
+          if not command.accept_gift_certificates.nil? then
+            merchant_calculations.add_element('accept-gift-certificates').text =
+              command.accept_gift_certificates.to_s
+          end
+        end
+        
+        # <platform-id>
+        if not command.platform_id.nil? then
+          flow_element.add_element('platform-id').text = command.platform_id
+        end
         
         # <shipping-methods>
         shippings_element = flow_element.add_element('shipping-methods')
@@ -234,41 +261,67 @@ module Google4R #:nodoc:
       # Adds an item for the given shipping method.
       def process_shipping_method(parent, shipping_method)
         if shipping_method.kind_of? PickupShipping then
-          process_pickup_shipping(parent, shipping_method)
+          process_pickup(parent, shipping_method)
         elsif shipping_method.kind_of? FlatRateShipping then
-          process_flat_rate_shipping(parent, shipping_method)
+          process_shipping('flat-rate-shipping', parent, shipping_method)
+        elsif shipping_method.kind_of? MerchantCalculatedShipping then
+          process_shipping('merchant-calculated-shipping', parent, shipping_method)
         else
           raise "Unknown ShippingMethod type of #{shipping_method.inspect}!"
         end
       end
       
-      def process_flat_rate_shipping(parent, shipping)
-        element = parent.add_element('flat-rate-shipping')
+      def process_shipping(shipping_type, parent, shipping)
+        element = parent.add_element(shipping_type)
         element.add_attribute('name', shipping.name)
         element.add_element('price', { 'currency' => shipping.price.currency }).text = shipping.price.to_s
         
-        if shipping.excluded_areas.length + shipping.allowed_areas.length > 0 then
-          restrictions_tag = element.add_element('shipping-restrictions')
+        if shipping.shipping_restrictions_excluded_areas.length + 
+           shipping.shipping_restrictions_allowed_areas.length > 0 then
+          shipping_restrictions_tag = element.add_element('shipping-restrictions')
           
-          if shipping.allowed_areas.length > 0 then
-            allowed_tag = restrictions_tag.add_element('allowed-areas')
+          if shipping.shipping_restrictions_allowed_areas.length > 0 then
+            allowed_tag = shipping_restrictions_tag.add_element('allowed-areas')
             
-            shipping.allowed_areas.each do |area|
+            shipping.shipping_restrictions_allowed_areas.each do |area|
               self.process_area(allowed_tag, area)
             end
           end
         
-          if shipping.excluded_areas.length > 0 then
-            excluded_tag = restrictions_tag.add_element('excluded-areas')
+          if shipping.shipping_restrictions_excluded_areas.length > 0 then
+            excluded_tag = shipping_restrictions_tag.add_element('excluded-areas')
 
-            shipping.excluded_areas.each do |area|
+            shipping.shipping_restrictions_excluded_areas.each do |area|
               self.process_area(excluded_tag, area)
             end
           end
         end
+
+        if shipping.kind_of? MerchantCalculatedShipping then
+          if shipping.address_filters_excluded_areas.length + 
+             shipping.address_filters_allowed_areas.length > 0 then
+            address_filters_tag = element.add_element('address-filters')
+            
+            if shipping.address_filters_allowed_areas.length > 0 then
+              allowed_tag = address_filters_tag.add_element('allowed-areas')
+              
+              shipping.address_filters_allowed_areas.each do |area|
+                self.process_area(allowed_tag, area)
+              end
+            end
+          
+            if shipping.address_filters_excluded_areas.length > 0 then
+              excluded_tag = address_filters_tag.add_element('excluded-areas')
+  
+              shipping.address_filters_excluded_areas.each do |area|
+                self.process_area(excluded_tag, area)
+              end
+            end
+          end
+        end
       end
       
-      def process_pickup_shipping(parent, shipping)
+      def process_pickup(parent, shipping)
         element = parent.add_element('pickup')
         element.add_attribute('name', shipping.name)
         element.add_element('price', { 'currency' => shipping.price.currency }).text = shipping.price.to_s
@@ -483,7 +536,7 @@ module Google4R #:nodoc:
     end
     
     class SendBuyerMessageCommandXmlGenerator < CommandXmlGenerator
-
+      
       protected
 
       def process_command(command)        
@@ -513,5 +566,68 @@ module Google4R #:nodoc:
       end
     end
     
+    class MerchantCalculationResultsXmlGenerator < XmlGenerator
+      
+      def initialize(merchant_calculation_results)
+        @merchant_calculation_results = merchant_calculation_results
+      end
+      
+      def generate()
+        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?
+        return io.string
+      end
+      
+      protected
+      
+      def process_results(merchant_calculation_results)
+        root = @document.add_element("merchant-calculation-results" , { 'xmlns' => 'http://checkout.google.com/schema/2' })
+        results = root.add_element("results")
+        for merchant_calculation_result in merchant_calculation_results do
+          process_result(results, merchant_calculation_result)
+        end
+      end
+      
+      def process_result(parent, merchant_calculation_result)
+        element = parent.add_element("result")
+        element.add_attribute("shipping-name", merchant_calculation_result.shipping_name)
+        element.add_attribute("address-id", merchant_calculation_result.address_id)
+        shipping_rate = element.add_element("shipping-rate")
+        shipping_rate.text = merchant_calculation_result.shipping_rate.to_s
+        shipping_rate.add_attribute("currency", merchant_calculation_result.shipping_rate.currency)
+        element.add_element("shippable").text = merchant_calculation_result.shippable.to_s
+        if (!merchant_calculation_result.total_tax.nil?)
+          total_tax = element.add_element("total-tax")
+          total_tax.text = merchant_calculation_result.total_tax.to_s
+          total_tax.add_attribute("currency", merchant_calculation_result.total_tax.currency)
+        end
+        process_code_results(element, merchant_calculation_result.merchant_code_results)
+      end
+      
+      def process_code_results(parent, merchant_code_results)
+        element = parent.add_element("merchant-code-results")
+        for merchant_code_result in merchant_code_results do
+          process_merchant_code_result(element, merchant_code_result)
+        end
+      end
+      
+      def process_merchant_code_result(parent, merchant_code_result)
+        if merchant_code_result.kind_of?(CouponResult)
+          element = parent.add_element("coupon-result")
+        elsif merchant_code_result.kind_of?(GiftCertificateResult)
+          element = parent.add_element("gift-certificate-result")
+        else
+          raise "Code of unknown type: #{merchant_code_result.inspect}."
+        end
+        element.add_element("valid").text = merchant_code_result.valid.to_s
+        element.add_element("code").text = merchant_code_result.code.to_s
+        calculated_amount = element.add_element("calculated-amount")
+        calculated_amount.text = merchant_code_result.calculated_amount.to_s
+        calculated_amount.add_attribute("currency", merchant_code_result.calculated_amount.currency)
+        element.add_element("message").text = merchant_code_result.message
+      end
+    end
   end
 end