google4r-checkout 1.0.3 → 1.0.6

data/CHANGES

@@ -1,5 +1,20 @@
 =google4r-checkout Changelog
 
+== 1.0.6 (2010-04-01)
+
+* Added beta Subscriptions API support.
+* Fixed email-delivery XML generation bug.
+
+== 1.0.5 (2008-9-17)
+
+* Added Order Report API support.  Thanks to Daniel Pirone!
+* Added unit tests for OrderReportCommand.  Added validation checks fro start_date, end_date, financial_state and fulfillment_state.
+
+== 1.0.4 (2008-09-02)
+
+* Fixed undefined email_delivery? method bug
+* Added unit test to cover digital content creation
+
 == 1.0.3 (2008-08-08)
 
 * Added analytics_data support.  Thanks to Will Schwenk!

data/lib/google4r/checkout/commands.rb

@@ -49,6 +49,9 @@ module Google4R #:nodoc:
       CHECKOUT_API_URL = 'api/checkout/v2/merchantCheckout/Merchant/%s'
       
       ORDER_PROCESSING_API_URL = 'api/checkout/v2/request/Merchant/%s'
+
+      ORDER_REPORT_API_URL = 'api/checkout/v2/reports/Merchant/%s'
+
       
       # The Frontent class that was used to create this CheckoutCommand and whose
       # configuration will be used.
@@ -79,6 +82,7 @@ module Google4R #:nodoc:
       # TODO: The send-and-expect-response part should be adaptable to other commands and responses.
       #++
       def send_to_google_checkout
+        xml_response = (self.class == OrderReportCommand) ? false : true        
         # Create HTTP(S) POST command and set up Basic Authentication.
         url_str = 
           if frontend.configuration[:use_sandbox] then
@@ -89,6 +93,8 @@ module Google4R #:nodoc:
         url_str += 
           if self.class == CheckoutCommand then
             CHECKOUT_API_URL
+          elsif self.class == OrderReportCommand then
+            ORDER_REPORT_API_URL
           else
             ORDER_PROCESSING_API_URL
           end
@@ -110,18 +116,23 @@ module Google4R #:nodoc:
         
         case result
         when Net::HTTPSuccess then
-          xml_doc = REXML::Document.new(result.body)
-          
-          case xml_doc.root.name
-          when 'checkout-redirect'
-            serial_number = xml_doc.elements['/checkout-redirect'].attributes['serial-number']
-            redirect_url = xml_doc.elements['/checkout-redirect/redirect-url/text()'].value
-            return CheckoutRedirectResponse.new(serial_number, redirect_url)
-          when 'request-received'
-            serial_number = xml_doc.elements['/request-received'].attributes['serial-number']
-            return serial_number
+          if ( xml_response ) then
+            xml_doc = REXML::Document.new(result.body)
+             
+            case xml_doc.root.name
+            when 'checkout-redirect'
+                serial_number = xml_doc.elements['/checkout-redirect'].attributes['serial-number']
+                redirect_url = xml_doc.elements['/checkout-redirect/redirect-url/text()'].value
+                return CheckoutRedirectResponse.new(serial_number, redirect_url)
+            when 'request-received'
+                serial_number = xml_doc.elements['/request-received'].attributes['serial-number']
+                return serial_number
+            else
+                raise "Unknown response:\n--\n#{xml_doc.to_s}\n--"
+            end
           else
-            raise "Unknown response:\n--\n#{xml_doc.to_s}\n--"
+            # handle the CSV output of the order-report-list command
+            return result.body
           end
         when Net::HTTPClientError then
           xml_doc = REXML::Document.new(result.body)
@@ -296,6 +307,28 @@ module Google4R #:nodoc:
         return @redirect_url
       end
     end
+    
+    # SubscriptionRequestReceivedResponse instances are returned when a 
+    # CreateOrderRecurrenceRequestCommand is successfully processed by Google Checkout.
+    class SubscriptionRequestReceivedResponse
+      # The serial number of the <subscription-request-received> response.
+      attr_reader :serial_number
+      
+      # The new order number that was generated for this request.
+      attr_reader :new_google_order_number
+      
+      # Create a new SubscriptionRequestReceivedResponse with the given serial number and Google
+      # order number.  Do not create SubscriptionRequestReceivedResponse instances in your own
+      # code.  Google4R creates them for you.
+      def initialize(serial_number, new_google_order_number)
+        @serial_number = serial_number
+        @new_google_order_number = new_google_order_number
+      end
+      
+      def to_s
+        return @new_google_order_number
+      end
+    end
 
     #
     # The ChargeOrderCommand instructs Google Checkout to charge the buyer for a
@@ -426,6 +459,24 @@ module Google4R #:nodoc:
       end
     end
     
+    # The <create-order-recurrence-request> tag contains a request to charge a customer for one or more items in a subscription.
+    class CreateOrderRecurrenceRequestCommand < Command
+      # The ID that uniquely identifies this order
+      attr_accessor :google_order_number
+      
+      attr_reader :shopping_cart
+      
+      # Initialize a new CreateOrderRecurrenceRequestCommand with a fresh ShoppingCart.
+      def initialize(frontend)
+        super(frontend)
+        @shopping_cart = ShoppingCart.new(self)
+      end
+      
+      def to_xml
+        CreateOrderRecurrenceRequestCommandXmlGenerator.new(self).generate
+      end
+    end
+    
     #
     # XML API Commands for Line-item Shipping
     #
@@ -465,8 +516,7 @@ module Google4R #:nodoc:
     # The <cancel-items> command lets you specify that one or more
     # specific items in an order have been cancelled, meaning they 
     # will not be delivered to the customer.
-    class CancelItemsCommand < ItemsCommand
-      
+    class CancelItemsCommand < ItemsCommand  
       # The reason that you are canceling one or more line items
       attr_accessor :reason
       
@@ -493,5 +543,65 @@ module Google4R #:nodoc:
         ResetItemsShippingInformationCommandXmlGenerator.new(self).generate
       end
     end
+
+    # The <order-list-request> command lets you to download a list of 
+    # Google Checkout orders into a comma-separated file. 
+    # The API will return a list of orders for a period of up to 31 days, 
+    # and you can limit results to orders that have specific financial or 
+    # fulfillment order states.
+    # http://code.google.com/apis/checkout/developer/Google_Checkout_XML_API_Order_Report_API.html
+    class OrderReportCommand < Command
+      # The earliest time that an order could have been submitted to be
+      # included in the API response (Time)
+      attr_reader :start_date
+      
+      # The time before which an order must have been sent to be included
+      # in the API response (Time)
+      attr_reader :end_date
+      
+      # The financial status of an order
+      attr_accessor :financial_state
+      
+      # The fulfillment status of an order
+      attr_accessor :fulfillment_state
+      
+      # The time zone that will be associated with the start date and
+      # end date for the report
+      attr_accessor :date_time_zone
+      
+      def initialize(frontend, start_date, end_date)
+        super frontend
+        raise 'start_date has to be of type Time' unless start_date.class == Time
+        raise 'end_date has to be of type Time' unless start_date.class == Time
+        raise 'end_date has to be before start_date' unless
+            end_date >= start_date
+        @start_date = start_date
+        @end_date = end_date
+      end
+
+      def start_date
+        return @start_date.strftime('%Y-%m-%dT%H:%M:%S')
+      end
+      
+      def end_date
+        return @end_date.strftime('%Y-%m-%dT%H:%M:%S')
+      end
+      
+      def financial_state=(financial_state)
+        raise 'Invalid financial state %s' % financial_state unless
+            FinancialState.constants.include?(financial_state)
+        @financial_state = financial_state
+      end
+      
+      def fulfillment_state=(fulfillment_state)
+        raise 'Invalid fulfillment state %s' % fulfillment_state unless
+            FulfillmentState.constants.include?(fulfillment_state)
+        @fulfillment_state = fulfillment_state
+      end
+      
+      def to_xml
+        ReturnOrderReportCommandXmlGenerator.new(self).generate
+      end
+    end
   end
 end

data/lib/google4r/checkout/frontend.rb

@@ -170,6 +170,12 @@ module Google4R #:nodoc:
         return UnarchiveOrderCommand.new(self)
       end
       
+      # Factory method to create a new CreateOrderRecurrenceRequestCommand object. Use this method to create
+      # your CreateOrderRecurrenceRequestCommand instances.
+      def create_create_order_recurrence_request_command
+        return CreateOrderRecurrenceRequestCommand.new(self)
+      end
+      
       # Factory method to create a new ShipItemsCommand object. Use this method to create
       # your ShipItemsCommand instances.
       def create_ship_items_command
@@ -199,6 +205,12 @@ module Google4R #:nodoc:
       def create_reset_items_shipping_information_command
         return ResetItemsShippingInformationCommand.new(self)
       end
+
+      # Factory method that creates a new OrderReportCommand object. Use this method to create 
+      # your OrderReportCommand instances.
+      def create_order_report_command(start_date, end_date)
+        return OrderReportCommand.new(self, start_date, end_date)
+      end
     end
   end
 end

data/lib/google4r/checkout/notifications.rb

@@ -132,6 +132,8 @@ module Google4R #:nodoc:
           ChargebackAmountNotification.create_from_element(root, frontend)
         when 'authorization-amount-notification' then
           AuthorizationAmountNotification.create_from_element(root, frontend)
+        when 'cancelled-subscription-notification' then
+          CancelledSubscriptionNotification.create_from_element(root, frontend)
         else
           raise UnknownNotificationType, "Unknown notification type: #{root.name}"
         end
@@ -487,6 +489,33 @@ module Google4R #:nodoc:
       end
     end
     
+    # CancelledSubscriptionNotification objects contain information about the
+    # cancellation of a subscription, including the item-ids, google order number,
+    # reason, and timestamp.
+    class CancelledSubscriptionNotification < Notification
+      
+      # The reason for the cancellation (String, can be nil.)
+      attr_accessor :reason
+      
+      # The ids of the items being cancelled (Array of Strings)
+      attr_accessor :item_ids
+      
+      # The google order number of the subscription being cancelled
+      attr_accessor :google_order_number
+      
+      def self.create_from_element(element, frontend)
+        csn = CancelledSubscriptionNotification.new(frontend)
+        
+        csn.serial_number = element.attributes['serial-number']
+        csn.timestamp = Time.parse(element.elements['timestamp'].text)
+        csn.reason = element.elements['reason'].text rescue nil
+        csn.item_ids = element.elements['item-ids/item-id/merchant-item-id'].collect {|i| i.text} rescue []
+        csn.google_order_number = element.elements['google-order-number'].text
+        
+        return csn
+      end
+    end
+    
     # Container for the valid financial order states as defined in the 
     # Google Checkout API.
     module FinancialOrderState

data/lib/google4r/checkout/shared.rb

@@ -266,6 +266,26 @@ module Google4R #:nodoc:
         return @digital_content
       end
       
+      # Subscription information for this item. Optional.
+      attr_reader :subscription
+      
+      def create_subscription(subscription=nil, &block)
+        
+        if @subscription.nil?
+          if subscription.nil?
+            @subscription = Subscription.new
+          else
+            @subscription = subscription
+          end
+        end
+        
+        if block_given?
+          yield @subscription
+        end
+        
+        return @subscription
+      end
+      
       # Create a new Item in the given Cart. You should not instantize this class directly
       # but use Cart#create_item instead.
       def initialize(shopping_cart)
@@ -365,6 +385,179 @@ module Google4R #:nodoc:
           return result
         end
       end
+      
+      class Subscription
+        
+        # Constants for period
+        DAILY = 'DAILY'
+        WEEKLY = 'WEEKLY'
+        SEMI_MONTHLY = 'SEMI_MONTHLY'
+        MONTHLY = 'MONTHLY'
+        EVERY_TWO_MONTHS = 'EVERY_TWO_MONTHS'
+        QUARTERLY = 'QUARTERLY'
+        YEARLY = 'YEARLY'
+        
+        # Constants for type
+        MERCHANT = 'merchant'
+        GOOGLE = 'google'
+        
+        # Optional. The no-charge-after attribute specifies the latest date and time that 
+        # you can charge the customer for the subscription. This element can help you to 
+        # ensure that you do not overcharge your customers.
+        attr_accessor :no_charge_after
+        
+        # Required. The period attribute specifies how frequently you will charge the 
+        # customer for the subscription. Valid values for this attribute are DAILY, 
+        # WEEKLY, SEMI_MONTHLY, MONTHLY, EVERY_TWO_MONTHS, QUARTERLY, and YEARLY.
+        attr_reader :period
+        
+        def period=(period)
+          unless [DAILY, WEEKLY, SEMI_MONTHLY, MONTHLY, EVERY_TWO_MONTHS, QUARTERLY, YEARLY].include?(period)
+            raise "period can only be set to DAILY, WEEKLY, SEMI_MONTHLY, MONTHLY, EVERY_TWO_MONTHS, QUARTERLY, or YEARLY"
+          end
+          @period = period
+        end
+        
+        # Optional. The start-date attribute specifies the date that the subscription's 
+        # recurrence period will begin. Like all dates in Checkout, this is in ISO 8601
+        # format. If you set the <unit-price> tag's value to a nonzero value, then the 
+        # start-date for the subscription will automatically be set to the time that is 
+        # exactly one recurrence period after the order is placed.
+        attr_accessor :start_date
+        
+        # Required. The type attribute identifies the type of subscription that you are 
+        # creating. The valid values for this attribute are merchant and google, and this 
+        # specifies who handles the recurrences. The merchant value specifies 
+        # Merchant-Handled recurrences, and the google value specifies Google-Handled 
+        # recurrences.
+        attr_reader :type
+        
+        def type=(type)
+          unless [MERCHANT, GOOGLE].include?(type)
+            raise "type can only be set to MERCHANT or GOOGLE"
+          end
+          @type = type
+        end
+        
+        # Container for payments
+        attr_reader :payments
+        
+        def add_payment(&block)
+          payment = SubscriptionPayment.new(self)
+          @payments << payment
+
+          # Pass the newly generated payment to the given block to set its attributes.
+          yield(payment) if block_given?
+        
+          return payment
+        end
+        
+        # Container for recurrent items
+        attr_reader :recurrent_items
+
+        def add_recurrent_item(&block)
+          item = RecurrentItem.new(self)
+          @recurrent_items << item
+          
+          # Pass the newly generated item to the given block to set its attributes.
+          yield(item) if block_given?
+          
+          return item
+        end
+        
+        def initialize
+          @payments = []
+          @recurrent_items = []
+        end
+        
+        def self.create_from_element(element)
+          result = Subscription.new
+          result.no_charge_after = Time.iso8601(element.attributes['no-charge-after']) rescue nil
+          result.period = element.attributes['period'] rescue nil
+          result.start_date = Time.iso8601(element.attributes['start-date']) rescue nil
+          result.type = element.attributes['type'] rescue nil
+          
+          element.elements['payments/subscription-payment'].each do |payment_element|
+            result.payments << SubscriptionPayment.create_from_element(subscription, payment_element)
+          end
+          
+          element.elements['recurrent-item'].each do |item_element|
+            result.recurrent_items << Item.create_from_element(item_element)
+          end
+          
+          return result
+        end
+        
+        class SubscriptionPayment
+          
+          attr_accessor :subscription
+          
+          # Optional. The times attribute indicates how many times you will charge the 
+          # customer for a defined subscription payment. A subscription may have multiple 
+          # payment schedules, and the times attribute lets you indicate how many times 
+          # each charge will be assessed. For example, you might charge the customer a 
+          # reduced rate for the first three months of a subscription and then charge the 
+          # standard rate each month thereafter.
+          attr_accessor :times
+          
+          # The maximum amount that you will be allowed to charge the customer, including
+          # tax, for all recurrences (Money instance, required).
+          attr_reader :maximum_charge
+          
+          def initialize(subscription)
+            @subscription = subscription
+          end
+    
+          # Sets the maximum charge for this subscription payment. money must respond to
+          # :cents and :currency as the Money class does.
+          def maximum_charge=(money)
+            if not (money.respond_to?(:cents) and money.respond_to?(:currency)) then
+              raise "Invalid price - does not respond to :cents and :currency - #{money.inspect}."
+            end
+            
+            @maximum_charge = money
+          end
+          
+          def self.create_from_element(subscription, element)
+            result = SubscriptionPayment.new
+            result.subscription = subscription
+            result.times = element.attributes['times'].to_i rescue nil
+            
+            maximum_charge = (element.elements['maximum-charge'].text.to_f * 100).to_i
+            maximum_charge_currency = element.elements['maximum-charge'].attributes['currency']
+            result.maximum_charge = Money.new(maximum_charge, maximum_charge_currency)
+            
+            return result
+          end
+        end
+        
+        class RecurrentItem < Item
+          
+          attr_accessor :subscription
+          
+          def initialize(subscription)
+            @subscription = subscription
+          end
+          
+          def self.create_from_element(element, subscription)
+            item = super(element, nil)
+            
+            result = RecurrentItem.new(subscription)
+            result.description = item.description
+            result.digital_content = item.digital_content
+            result.id = item.id
+            result.name = item.name
+            result.private_data = item.private_data
+            result.quantity = item.quantity
+            result.tax_table = item.tax_table
+            result.unit_price = item.unit_price
+            result.weight = item.weight
+            
+            return result
+          end
+          
+        end
+      end
     end
     
     # A TaxTable is an ordered array of TaxRule objects. You should create the TaxRule
@@ -1052,5 +1245,35 @@ module Google4R #:nodoc:
         @tracking_number = tracking_number.to_s
       end
     end
+    
+    # financial_state
+    # REVIEWING - Google Checkout is reviewing the order.
+    # CHARGEABLE - The order is ready to be charged.
+    # CHARGING - The order is being charged; you may not refund or cancel an order until is the charge is completed.
+    # CHARGED - The order has been successfully charged; if the order was only partially charged, the buyer's account page will reflect the partial charge.
+    # PAYMENT_DECLINED - The charge attempt failed.
+    # CANCELLED - The seller canceled the order; an order's financial state cannot be changed after the order is canceled.
+    # CANCELLED_BY_GOOGLE - Google canceled the order. Google may cancel orders due to a failed charge without a replacement credit card being provided within a set period of time or due to a failed risk check. If Google cancels an order, you will be notified of the reason the order was canceled in the <reason> tag of an <order-state-change-notification>.
+    class FinancialState
+      REVIEWING = 'REVIEWING'
+      CHARGEABLE = 'CHARGEABLE'
+      CHARGING = 'CHARGING'
+      CHARGED = 'CHARGED'
+      PAYMENT_DECLINED = 'PAYMENT_DECLINED'
+      CANCELLED = 'CANCELLED'
+      CANCELLED_BY_GOOGLE = 'CANCELLED_BY_GOOGLE'
+    end
+    
+    # fulfillment_state
+    # NEW - The order has been received but not prepared for shipping.
+    # PROCESSING - The order is being prepared for shipping.
+    # DELIVERED - The seller has shipped the order.
+    # WILL_NOT_DELIVER - The seller will not ship the order; this status is used for canceled orders.
+    class FulfillmentState
+      NEW = 'NEW'
+      PROCESSING = 'PROCESSING'
+      DELIVERED = 'DELIVERED'
+      WILL_NOT_DELIVER = 'WILL_NOT_DELIVER'
+    end
   end
 end

data/lib/google4r/checkout/xml_generation.rb

@@ -30,6 +30,7 @@
 
 require 'stringio'
 require 'rexml/document'
+require 'time'
 
 module Google4R #:nodoc:
   module Checkout #:nodoc:
@@ -67,11 +68,13 @@ module Google4R #:nodoc:
         SendBuyerMessageCommand => 'send-buyer-message',
         ArchiveOrderCommand => 'archive-order',
         UnarchiveOrderCommand => 'unarchive-order',
+        CreateOrderRecurrenceRequestCommand => 'create-order-recurrence-request',
         ShipItemsCommand => 'ship-items',
         BackorderItemsCommand => 'backorder-items',
         CancelItemsCommand => 'cancel-items',
         ReturnItemsCommand => 'return-items',
-        ResetItemsShippingInformationCommand => 'reset-items-shipping-information'
+        ResetItemsShippingInformationCommand => 'reset-items-shipping-information',
+        OrderReportCommand => 'order-list-request',
       }
       
       def initialize(command)
@@ -289,6 +292,66 @@ module Google4R #:nodoc:
         if not item.digital_content.nil? then
           self.process_digital_content(item_element, item.digital_content)
         end
+        
+        if not (item.kind_of? Item::Subscription::RecurrentItem or item.subscription.nil?) then
+          self.process_subscription(item_element, item.subscription)
+        end
+      end
+      
+      # Adds a <subscription> element to a parent (<item>) element
+      def process_subscription(parent, subscription)
+        subscription_element = parent.add_element('subscription')
+        
+        if not subscription.no_charge_after.nil? then
+          subscription_element.attributes['no-charge-after'] = subscription.no_charge_after.xmlschema
+        end
+        
+        if not subscription.period.nil? then
+          subscription_element.attributes['period'] = subscription.period.to_s
+        end
+        
+        if not subscription.start_date.nil? then
+          subscription_element.attributes['start-date'] = subscription.start_date.xmlschema
+        end
+        
+        if not subscription.type.nil? then
+          subscription_element.attributes['type'] = subscription.type.to_s
+        end
+        
+        if subscription.payments.length > 0
+          payments_element = subscription_element.add_element('payments')
+          
+          subscription.payments.each do |payment|
+            self.process_subscription_payment(payments_element, payment)
+          end
+        end
+        
+        if subscription.recurrent_items.length > 0
+          # this is a little bit of a hack; we use the normal way of generating items
+          # for a shopping cart, and then rename the elements to 'recurrent-item'
+          # after the fact
+          
+          subscription.recurrent_items.each do |item|
+            self.process_item(subscription_element, item)
+          end
+          
+          subscription_element.elements.each('item') do |item_element|
+            item_element.name = 'recurrent-item'
+          end
+        end
+      end
+      
+      # Adds a <subcription-payment> element to a parent (<payments>) element
+      def process_subscription_payment(parent, payment)
+        payment_element = parent.add_element('subscription-payment')
+        
+        if not payment.times.nil? then
+          payment_element.attributes['times'] = payment.times.to_s
+        end
+        
+        if not payment.maximum_charge.nil? then
+          payment_element.add_element('maximum-charge', { 'currency' => payment.maximum_charge.currency }).text = payment.maximum_charge.to_s
+        end
       end
       
       # Adds a <digital-content> element to a parent (<item>) element
@@ -299,7 +362,7 @@ module Google4R #:nodoc:
           digital_content_element.add_element('description').text = digital_content.description.to_s
         end
 
-        if digital_content.email_delivery? then
+        if not digital_content.email_delivery.nil? then
           digital_content_element.add_element('email-delivery').text = digital_content.email_delivery.to_s
         end
 
@@ -432,17 +495,17 @@ module Google4R #:nodoc:
         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)
+          height_element.add_attribute('value', package.height.value.to_s)
         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)
+          length_element.add_attribute('value', package.length.value.to_s)
         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)
+          width_element.add_attribute('value', package.width.value.to_s)
         end
       end
       
@@ -685,6 +748,19 @@ module Google4R #:nodoc:
       end
     end
     
+    class CreateOrderRecurrenceRequestCommandXmlGenerator < CheckoutCommandXmlGenerator
+      
+      protected
+      
+      def process_command(command)
+        root = @document.add_element("create-order-recurrence-request" , { 'xmlns' => 'http://checkout.google.com/schema/2' })
+        
+        root.attributes['google-order-number'] = command.google_order_number
+        
+        self.process_shopping_shopping_cart(root, command.shopping_cart)
+      end
+    end
+    
     class MerchantCalculationResultsXmlGenerator < XmlGenerator
       
       def initialize(merchant_calculation_results)
@@ -841,5 +917,39 @@ module Google4R #:nodoc:
     
     class ResetItemsShippingInformationCommandXmlGenerator < ItemsCommandXmlGenerator
     end
+
+    class ReturnOrderReportCommandXmlGenerator < CommandXmlGenerator
+      def initialize(command)
+        @command = command
+      end
+      
+      protected
+      
+      def process_command(command)
+        root = super
+        # TODO - sanity check format ?
+        root.add_attribute('start-date', command.start_date.to_s)
+        root.add_attribute('end-date', command.end_date.to_s)
+        flow_element = root
+
+        # <financial-state>
+        if command.financial_state then
+          financial_state_element = flow_element.add_element('financial-state')
+          financial_state_element.text = command.financial_state.to_s
+        end
+        
+        # <fulfillment-state>
+        if command.fulfillment_state then
+          fulfillment_state_element = flow_element.add_element('fulfillment-state')
+          fulfillment_state_element.text = command.fulfillment_state.to_s
+        end
+        
+        # <date-time-zone>
+        if command.date_time_zone then
+          dtz_element = flow_element.add_element('date-time-zone')
+          dtz_element.text = command.date_time_zone.to_s
+        end
+      end
+    end
   end
 end

data/test/integration/checkout_command_test.rb

@@ -62,6 +62,85 @@ class Google4R::Checkout::CheckoutCommandIntegrationTest < Test::Unit::TestCase
     # the redirect URL
     #puts @command.to_xml
     #puts result
+
+    assert_kind_of CheckoutRedirectResponse, result
+  end
+  
+  def test_sending_to_google_works_with_google_handled_subscription
+    setup_command(@command)
+    
+    @command.shopping_cart.create_item do |item|
+      item.name = "Test subscription"
+      item.description = "12 month subscription"
+      item.unit_price = Money.us_dollar(0)
+      item.quantity = 1
+      item.private_data = { :id => 123456 }
+      
+      item.create_subscription do |subscription|
+        subscription.type = "google"
+        subscription.period = "MONTHLY"
+        
+        subscription.add_payment do |payment|
+          payment.times = 12
+          payment.maximum_charge = Money.us_dollar(1200)
+        end
+        
+        subscription.add_recurrent_item do |rec_item|
+          rec_item.name = "Usage of My Awesome Website for One Month"
+          rec_item.description = "Your flat charge for accessing my web site"
+          rec_item.quantity = 1
+          rec_item.unit_price = Money.us_dollar(1200)
+          
+          rec_item.create_digital_content do |content|
+            content.display_disposition = "OPTIMISTIC"
+            content.url = "http://mywebsite.example.com"
+            content.description = "Pie is found at this web site!"
+          end
+        end
+        
+        item.create_digital_content do |content|
+          content.display_disposition = "OPTIMISTIC"
+          content.description = "Congratulations!  Your subscription is being set up.  Feel free to log onto" + 
+                                "<a href=\"http://mywebsite.example.com\">My website</a>."
+        end
+      end
+    end
+    
+    result = @command.send_to_google_checkout
+    assert_kind_of CheckoutRedirectResponse, result
+  end
+  
+  def test_sending_to_google_works_with_merchant_handled_subscription
+    setup_command(@command)
+    
+    @command.shopping_cart.create_item do |item|
+      item.name = "Test subscription"
+      item.description = "12 month subscription"
+      item.unit_price = Money.us_dollar(0)
+      item.quantity = 1
+      item.private_data = { :id => 123456 }
+      
+      item.create_subscription do |subscription|
+        subscription.type = "merchant"
+        subscription.period = "MONTHLY"
+        subscription.start_date = Time.new
+        subscription.start_date += (60 * 60 * 24 * 30)
+        subscription.no_charge_after = subscription.start_date + (60 * 60 * 24 * 365)
+        
+        subscription.add_payment do |payment|
+          payment.times = 12
+          payment.maximum_charge = Money.us_dollar(1200)
+        end
+        
+        item.create_digital_content do |content|
+          content.display_disposition = "OPTIMISTIC"
+          content.description = "Congratulations!  Your subscription is being set up.  Feel free to log onto" + 
+                                "<a href=\"http://mywebsite.example.com\">My website</a>."
+        end
+      end
+    end
+    
+    result = @command.send_to_google_checkout
     assert_kind_of CheckoutRedirectResponse, result
   end
   
@@ -158,6 +237,16 @@ class Google4R::Checkout::CheckoutCommandIntegrationTest < Test::Unit::TestCase
         item.quantity = i * 3
         item.id = "test-#{i}-123456789"
         item.weight = Weight.new(2.2)
+        if (i == 5)
+          item.create_digital_content do |dc|
+            dc.display_disposition = 
+                Google4R::Checkout::Item::DigitalContent::OPTIMISTIC
+            dc.description = "Information on how to get your content"
+            dc.url = "http://my.domain.com/downloads"
+            dc.key = "abcde12345"
+            dc.email_delivery = false
+          end
+        end
       end
     end
   end

data/test/unit/frontend_test.rb

@@ -55,7 +55,8 @@ class Google4R::Checkout::FrontendTest < Test::Unit::TestCase
       :create_add_tracking_data_command, :create_archive_order_command,
       :create_unarchive_order_command, :create_ship_items_command,
       :create_backorder_items_command, :create_return_items_command,
-      :create_cancel_items_command, :create_reset_items_shipping_information_command
+      :create_cancel_items_command, :create_reset_items_shipping_information_command,
+      :create_order_report_command
     ].each do |symbol|
       assert_respond_to @frontend, symbol
     end
@@ -130,7 +131,14 @@ class Google4R::Checkout::FrontendTest < Test::Unit::TestCase
   end
   
   def test_create_reset_items_shipping_information_command_works_correctly
-    assert_kind_of ResetItemsShippingInformationCommand, @frontend.create_reset_items_shipping_information_command
+    assert_kind_of ResetItemsShippingInformationCommand, 
+        @frontend.create_reset_items_shipping_information_command
   end
 
+  def test_create_order_report_command_works_correctly
+    assert_kind_of OrderReportCommand,
+        @frontend.create_order_report_command(
+            Time.utc(2007, 9, 1, 0, 0, 0),
+            Time.utc(2007, 9, 30, 23, 59, 59))
+  end
 end

data/test/unit/order_report_command_test.rb

@@ -0,0 +1,111 @@
+#--
+# Project:   google_checkout4r 
+# File:      test/unit/order_report_command_test.rb
+# Author:    Tony Chan <api.htchan at gmail dot com>
+# Copyright: (c) 2007 by Dan Dukeson
+# 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 CancelItemsCommand class.
+class Google4R::Checkout::OrderReportCommandTest < Test::Unit::TestCase
+  include Google4R::Checkout
+
+  def setup
+    @frontend = Frontend.new(FRONTEND_CONFIGURATION)
+    @command = @frontend.create_order_report_command(
+        Time.utc(2007, 9, 1, 0, 0, 0),
+        Time.utc(2007, 9, 30, 23, 59, 59))
+    @command.financial_state = 'CHARGED'
+    @command.fulfillment_state = 'NEW'
+    @command.date_time_zone = 'America/New_York'
+    
+    @sample_xml=%Q{<?xml version='1.0' encoding='UTF-8'?>
+<order-list-request end-date='2007-09-30T23:59:59' start-date='2007-09-01T00:00:00' xmlns='http://checkout.google.com/schema/2'>
+  <financial-state>CHARGED</financial-state>
+  <fulfillment-state>NEW</fulfillment-state>
+  <date-time-zone>America/New_York</date-time-zone>
+</order-list-request>}
+  end
+
+  def test_behaves_correctly
+    [ :start_date, :end_date,
+      :financial_state, :financial_state=,
+      :fulfillment_state, :fulfillment_state=,
+      :date_time_zone, :date_time_zone= ].each do |symbol|
+      assert_respond_to @command, symbol
+    end
+  end
+
+  def test_to_xml
+    assert_strings_equal(@sample_xml, @command.to_xml)
+  end
+
+  def test_accessors
+    assert_equal('2007-09-01T00:00:00', @command.start_date)
+    assert_equal('2007-09-30T23:59:59', @command.end_date)
+    assert_equal('CHARGED', @command.financial_state)
+    assert_equal('NEW', @command.fulfillment_state)
+    assert_equal('America/New_York', @command.date_time_zone)
+  end
+  
+  def test_good_dates
+    assert_nothing_raised RuntimeError do
+      @frontend.create_order_report_command(
+          Time.utc(2007, 9, 1, 0, 0, 0),
+          Time.utc(2007, 9, 30, 23, 59, 59))
+    end
+  end
+  
+  def test_dates_should_not_be_string
+    assert_raise RuntimeError do
+      @frontend.create_order_report_command(
+          '2007-09-01T00:00:00',
+          '2007-09-30T23:59:59')
+    end
+  end
+  
+  def test_end_date_before_start_date
+    assert_raise RuntimeError do
+      @frontend.create_order_report_command(
+          Time.utc(2007, 9, 1, 0, 0, 0),
+          Time.utc(2006, 9, 30, 23, 59, 59))
+    end
+  end
+  
+  def test_financial_state
+    assert_raise RuntimeError do
+      @command.financial_state = 'DUMMY'
+    end
+  end
+  
+  def test_fulfillment_state
+    assert_raise RuntimeError do
+      @command.fulfillment_state = 'DUMMY'
+    end
+  end
+end

metadata

@@ -1,125 +1,149 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: google4r-checkout
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
-date: 2008-08-12 00:00:00 -07:00
-summary: Ruby library to access the Google Checkout service and implement notification handlers.
-require_paths: 
-- lib
-email: 
-homepage: 
-rubyforge_project: 
-description: Ruby library to access the Google Checkout service and implement notification handlers.
-autorequire: ""
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.4
-  version: 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 6
+  version: 1.0.6
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Tony Chan
+autorequire: ""
+bindir: bin
+cert_chain: []
+
+date: 2010-04-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: money
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 7
+        - 1
+        version: 1.7.1
+  type: :runtime
+  version_requirements: *id001
+description: Ruby library to access the Google Checkout service and implement notification handlers.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- CHANGES
 files: 
-- lib/google4r/checkout/commands.rb
+- lib/google4r/checkout.rb
 - lib/google4r/checkout/frontend.rb
-- lib/google4r/checkout/merchant_calculation.rb
-- lib/google4r/checkout/notifications.rb
 - lib/google4r/checkout/shared.rb
+- lib/google4r/checkout/notifications.rb
 - lib/google4r/checkout/utils.rb
 - lib/google4r/checkout/xml_generation.rb
-- lib/google4r/checkout.rb
+- lib/google4r/checkout/commands.rb
+- lib/google4r/checkout/merchant_calculation.rb
 - var/cacert.pem
 - README
 - LICENSE
 - CHANGES
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 4
+      version: 1.8.4
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby library to access the Google Checkout service and implement notification handlers.
 test_files: 
 - test/integration/checkout_command_test.rb
-- test/unit/add_merchant_order_number_command_test.rb
-- test/unit/add_tracking_data_command_test.rb
-- test/unit/address_test.rb
-- test/unit/anonymous_address_test.rb
-- test/unit/archive_order_command_test.rb
-- test/unit/area_test.rb
-- test/unit/authorization_amount_notification_test.rb
+- test/unit/order_adjustment_test.rb
+- test/unit/pickup_shipping_test.rb
+- test/unit/merchant_code_test.rb
+- test/unit/chargeback_amount_notification_test.rb
 - test/unit/authorize_order_command_test.rb
+- test/unit/merchant_calculation_results_test.rb
+- test/unit/risk_information_notification_test.rb
+- test/unit/ship_items_command_test.rb
+- test/unit/tax_table_test.rb
 - test/unit/backorder_items_command_test.rb
+- test/unit/flat_rate_shipping_test.rb
+- test/unit/refund_order_command_test.rb
+- test/unit/merchant_code_result_test.rb
 - test/unit/callback_handler_test.rb
-- test/unit/cancel_items_command_test.rb
-- test/unit/cancel_order_command_test.rb
-- test/unit/carrier_calculated_shipping_test.rb
-- test/unit/charge_amount_notification_test.rb
 - test/unit/charge_order_command_test.rb
-- test/unit/chargeback_amount_notification_test.rb
-- test/unit/checkout_command_test.rb
-- test/unit/checkout_command_xml_generator_test.rb
-- test/unit/command_test.rb
-- test/unit/deliver_order_command_test.rb
-- test/unit/delivery_method_test.rb
-- test/unit/digital_content_test.rb
-- test/unit/flat_rate_shipping_test.rb
+- test/unit/charge_amount_notification_test.rb
+- test/unit/carrier_calculated_shipping_test.rb
+- test/unit/return_items_command_test.rb
+- test/unit/add_merchant_order_number_command_test.rb
+- test/unit/authorization_amount_notification_test.rb
 - test/unit/frontend_test.rb
+- test/unit/add_tracking_data_command_test.rb
+- test/unit/address_test.rb
 - test/unit/item_info_test.rb
+- test/unit/order_state_change_notification_test.rb
+- test/unit/us_state_area_test.rb
+- test/unit/notification_handler_test.rb
+- test/unit/us_country_area_test.rb
+- test/unit/shopping_cart_test.rb
+- test/unit/reset_items_shipping_information_command_test.rb
+- test/unit/order_report_command_test.rb
+- test/unit/send_buyer_message_command_test.rb
 - test/unit/item_test.rb
-- test/unit/marketing_preferences_test.rb
+- test/unit/deliver_order_command_test.rb
+- test/unit/cancel_order_command_test.rb
+- test/unit/archive_order_command_test.rb
+- test/unit/world_area_test.rb
+- test/unit/new_order_notification_test.rb
+- test/unit/private_data_parser_test.rb
 - test/unit/merchant_calculated_shipping_test.rb
-- test/unit/merchant_calculation_callback_test.rb
+- test/unit/cancel_items_command_test.rb
+- test/unit/checkout_command_test.rb
+- test/unit/area_test.rb
 - test/unit/merchant_calculation_result_test.rb
-- test/unit/merchant_calculation_results_test.rb
-- test/unit/merchant_code_result_test.rb
-- test/unit/merchant_code_test.rb
-- test/unit/new_order_notification_test.rb
+- test/unit/marketing_preferences_test.rb
 - test/unit/notification_acknowledgement_test.rb
-- test/unit/notification_handler_test.rb
-- test/unit/order_adjustment_test.rb
-- test/unit/order_state_change_notification_test.rb
-- test/unit/pickup_shipping_test.rb
-- test/unit/postal_area_test.rb
-- test/unit/private_data_parser_test.rb
 - test/unit/refund_amount_notification_test.rb
-- test/unit/refund_order_command_test.rb
-- test/unit/reset_items_shipping_information_command_test.rb
-- test/unit/return_items_command_test.rb
-- test/unit/risk_information_notification_test.rb
-- test/unit/send_buyer_message_command_test.rb
-- test/unit/ship_items_command_test.rb
-- test/unit/shipping_adjustment_test.rb
-- test/unit/shopping_cart_test.rb
 - test/unit/tax_rule_test.rb
-- test/unit/tax_table_test.rb
-- test/unit/tracking_data_test.rb
 - test/unit/unarchive_order_command_test.rb
-- test/unit/us_country_area_test.rb
-- test/unit/us_state_area_test.rb
+- test/unit/delivery_method_test.rb
+- test/unit/checkout_command_xml_generator_test.rb
+- test/unit/shipping_adjustment_test.rb
+- test/unit/tracking_data_test.rb
+- test/unit/postal_area_test.rb
+- test/unit/anonymous_address_test.rb
 - test/unit/us_zip_area_test.rb
-- test/unit/world_area_test.rb
-rdoc_options: []
-
-extra_rdoc_files: 
-- README
-- LICENSE
-- CHANGES
-executables: []
-
-extensions: []
-
-requirements: []
-
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: money
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.7.1
-    version: 
+- test/unit/digital_content_test.rb
+- test/unit/command_test.rb
+- test/unit/merchant_calculation_callback_test.rb