google4r-checkout 1.1.6 → 1.2.0

data/CHANGES

@@ -1,5 +1,9 @@
 =google4r-checkout Changelog
 
+== 1.2.0 (2013-04-09)
+
+* Support for the Polling API, contributed by Chance Downs and Jacob Comer
+
 == 1.1.6 (2012-08-01)
 
 * Bugfixes when creating recurring subscriptions parsed from XML, contributed by James Martin

data/README.md

@@ -34,19 +34,21 @@ You have to place a file called 'frontend_configuration.rb' in the directory'tes
 
 The file should contain content similar to:
 
-    # Uncomment the following line if you are using Google Checkout in Great Britain
-    # and adjust it if you want to test google4r-checkout against any other (future)
-    # Google Checkout service.
+```ruby
+# Uncomment the following line if you are using Google Checkout in Great Britain
+# and adjust it if you want to test google4r-checkout against any other (future)
+# Google Checkout service.
     
-    # Money.default_currency = 'GBP'
-    
-    # The test configuration for the Google4R::Checkout::Frontend class.
-    FRONTEND_CONFIGURATION = 
-      { 
-        :merchant_id => '<your merchant id>', 
-        :merchant_key => '<your merchant key>',
-        :use_sandbox => true
-      }
+# Money.default_currency = 'GBP'
+
+# The test configuration for the Google4R::Checkout::Frontend class.
+FRONTEND_CONFIGURATION = 
+  { 
+    :merchant_id => '<your merchant id>', 
+    :merchant_key => '<your merchant key>',
+    :use_sandbox => true
+  }
+```
 
 ## Sending Commands to Google Checkout
 
@@ -54,28 +56,38 @@ To send commands to Google Checkout, use a Google4R::Checkout::Frontend object.
 
 Here's an example:
 
-      # Create the Frontend from our configuration
-      frontend = Google4R::Checkout::Frontend.new(
-        :merchant_id => conf['merchant_id'],
-        :merchant_key => conf['merchant_key'],
-        :use_sandbox => conf['use_sandbox']
-      )
+```ruby
+# Create the Frontend from our configuration
+frontend = Google4R::Checkout::Frontend.new(
+  :merchant_id => conf['merchant_id'],
+  :merchant_key => conf['merchant_key'],
+  :use_sandbox => conf['use_sandbox']
+)
       
-      # Create a new checkout command (to place an order)
-      cmd = frontend.create_checkout_command
+# Create a new checkout command (to place an order)
+cmd = frontend.create_checkout_command
       
-      # Add an item to the command's shopping cart
-      cmd.shopping_cart.create_item do |item|
-        item.name = "2-liter bottle of Diet Pepsi"
-        item.quantity = 100
-        item.unit_price = Money.new(1.99, "USD")
-      end
+# Add an item to the command's shopping cart
+cmd.shopping_cart.create_item do |item|
+  item.name = "2-liter bottle of Diet Pepsi"
+  item.quantity = 100
+  item.unit_price = Money.new(1.99, "USD")
+end
       
-      # Send the command to Google and capture the HTTP response
-      response = cmd.send_to_google_checkout
+# Send the command to Google and capture the HTTP response
+begin
+  response = cmd.send_to_google_checkout
+rescue Net::HTTPServerError => e
+  # Sometimes Google Checkout is unavailable for internal reasons.
+  # Because of this, it's a good idea to catch Net::HTTPServerError
+  # and retry.
+  
+  response = cmd.send_to_google_checkout
+end
       
-      # Redirect the user to Google Checkout to complete the transaction
-      redirect_to response.redirect_url
+# Redirect the user to Google Checkout to complete the transaction
+redirect_to response.redirect_url
+```
 
 For more information, see the Frontend class's RDocs and the Google Checkout API documentation.
 
@@ -87,51 +99,53 @@ It's a good idea to verify the HTTP authentication headers for incoming requests
 
 Here is an example of how one might do this in Rails:
 
-    class PaymentNotificationController < ApplicationController
-      before_filter :verify_merchant_credentials, :only => [:google]
+```ruby
+class PaymentNotificationController < ApplicationController
+  before_filter :verify_merchant_credentials, :only => [:google]
   
-      def google
-        frontend = Google4R::Checkout::Frontend.new(
-          :merchant_id => conf['merchant_id'],
-          :merchant_key => conf['merchant_key'],
-          :use_sandbox => conf['use_sandbox']
-        )
-        handler = frontend.create_notification_handler
-        
-        begin
-           notification = handler.handle(request.raw_post) # raw_post contains the XML
-        rescue Google4R::Checkout::UnknownNotificationType
-           # This can happen if Google adds new commands and Google4R has not been
-           # upgraded yet. It is not fatal.
-           logger.warn "Unknown notification type"
-           return render :text => 'ignoring unknown notification type', :status => 200
-        end
-        
-        case notification
-        when Google4R::Checkout::NewOrderNotification then
-          
-          # handle a NewOrderNotification
-          
-        when Google4R::Checkout::OrderStateChangeNotification then
-          
-          # handle an OrderStateChangeNotification
-          
-        else
-          return head :text => "I don't know how to handle a #{notification.class}", :status => 500
-        end
+  def google
+    frontend = Google4R::Checkout::Frontend.new(
+      :merchant_id => conf['merchant_id'],
+      :merchant_key => conf['merchant_key'],
+      :use_sandbox => conf['use_sandbox']
+    )
+    handler = frontend.create_notification_handler
     
-        notification_acknowledgement = Google4R::Checkout::NotificationAcknowledgement.new(notification)
-        render :xml => notification_acknowledgement, :status => 200
-      end
-  
-      private
-      # make sure the request authentication headers use the right merchant_id and merchant_key
-      def verify_merchant_credentials
-        authenticate_or_request_with_http_basic("Google Checkout notification endpoint") do |merchant_id, merchant_key|
-          (conf['merchant_id'].to_s == merchant_id.to_s) and (conf['merchant_key'].to_s == merchant_key.to_s)
-        end
-      end
+    begin
+       notification = handler.handle(request.raw_post) # raw_post contains the XML
+    rescue Google4R::Checkout::UnknownNotificationType
+       # This can happen if Google adds new commands and Google4R has not been
+       # upgraded yet. It is not fatal.
+       logger.warn "Unknown notification type"
+       return render :text => 'ignoring unknown notification type', :status => 200
+    end
+    
+    case notification
+    when Google4R::Checkout::NewOrderNotification then
+      
+      # handle a NewOrderNotification
+      
+    when Google4R::Checkout::OrderStateChangeNotification then
+      
+      # handle an OrderStateChangeNotification
+      
+    else
+      return head :text => "I don't know how to handle a #{notification.class}", :status => 500
+    end
+
+    notification_acknowledgement = Google4R::Checkout::NotificationAcknowledgement.new(notification)
+    render :xml => notification_acknowledgement.to_xml, :status => 200
+  end
+
+  private
+  # make sure the request authentication headers use the right merchant_id and merchant_key
+  def verify_merchant_credentials
+    authenticate_or_request_with_http_basic("Google Checkout notification endpoint") do |merchant_id, merchant_key|
+      (conf['merchant_id'].to_s == merchant_id.to_s) and (conf['merchant_key'].to_s == merchant_key.to_s)
     end
+  end
+end
+```
 
 ## Dependencies
 

data/lib/google4r/checkout/commands.rb

@@ -50,6 +50,7 @@ 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'
+      POLLING_API_URL = 'api/checkout/v2/reports/Merchant/%s'
 
       # Donations
       DONATE_CHECKOUT_API_URL = 'api/checkout/v2/merchantCheckout/Donations/%s'
@@ -108,6 +109,8 @@ module Google4R #:nodoc:
               CHECKOUT_API_URL
             elsif self.class == OrderReportCommand || self.class == NotificationHistoryRequestCommand then
               ORDER_REPORT_API_URL
+            elsif self.class == NotificationDataRequestCommand || self.class == NotificationDataTokenRequestCommand then
+              POLLING_API_URL
             else
               ORDER_PROCESSING_API_URL
             end
@@ -189,6 +192,33 @@ module Google4R #:nodoc:
                   end
                 end
                 { :notifications => notifications, :next_page_token => next_page_token }
+              when 'notification-data-token-response'
+                serial_number = xml_doc.elements['/notification-data-token-response'].attributes['serial-number']
+                continue_token = xml_doc.root.elements['continue-token/text()'].value
+                { :continue_token => continue_token, :serial_number => serial_number}
+              when 'notification-data-response'
+                serial_number = xml_doc.elements['/notification-data-response'].attributes['serial-number']
+                continue_token = xml_doc.root.elements['continue-token/text()'].value
+                has_more_notifications = xml_doc.root.elements['has-more-notifications/text()'].value
+                notifications = xml_doc.root.elements['notifications'].elements.map do |element|
+                  case element.name
+                    when 'new-order-notification'
+                      NewOrderNotification.create_from_element element, @frontend
+                    when 'risk-information-notification'
+                      RiskInformationNotification.create_from_element element, @frontend
+                    when 'order-state-change-notification'
+                      OrderStateChangeNotification.create_from_element element, @frontend
+                    when 'charge-amount-notification'
+                      ChargeAmountNotification.create_from_element element, @frontend
+                    when 'authorization-amount-notification'
+                      AuthorizationAmountNotification.create_from_element element, @frontend
+                    when 'refund-amount-notification'
+                      RefundAmountNotification.create_from_element element, @frontend
+                    when 'chargeback-amount-notification'
+                      ChargebackAmountNotification.create_from_element element, @frontend
+                  end
+                end
+                { :notifications => notifications, :continue_token => continue_token, :serial_number => serial_number, :has_more_notifications => has_more_notifications }
             else
                 raise "Unknown response:\n--\n#{xml_doc.to_s}\n--"
             end
@@ -741,5 +771,37 @@ module Google4R #:nodoc:
         NotificationHistoryReportCommandXmlGenerator.new(self).generate
       end
     end
+
+
+    class NotificationDataRequestCommand < Command
+
+      attr_reader :continue_token
+
+      def initialize(frontend, continue_token)
+        super frontend
+
+        @continue_token = continue_token
+      end
+
+      def to_xml
+        NotificationDataRequestCommandXmlGenerator.new(self).generate
+      end
+    end
+
+
+    class NotificationDataTokenRequestCommand < Command
+      # The earliest time that an order could have been submitted to be
+      # included in the API response (Time)
+      attr_reader :start_time
+
+      def initialize(frontend, options = {})
+        super frontend
+        @start_time = options[:start_time] if options.has_key?(:start_time)
+      end
+
+      def to_xml
+        NotificationDataTokenRequestCommandXmlGenerator.new(self).generate
+      end
+    end
   end
 end

data/lib/google4r/checkout/frontend.rb

@@ -235,6 +235,14 @@ module Google4R #:nodoc:
       def create_notification_history_request_command(serial_number)
         return NotificationHistoryRequestCommand.new(self, serial_number)
       end
+
+      def create_notification_data_request_command(continue_token)
+        return NotificationDataRequestCommand.new(self, continue_token)
+      end
+
+      def create_notification_data_token_request_command(options={})
+        return NotificationDataTokenRequestCommand.new(self, options)
+      end
     end
   end
 end

data/lib/google4r/checkout/notifications.rb

@@ -774,7 +774,6 @@ module Google4R #:nodoc:
             # ignore
           end
         end
-        
         return result
       end
     end

data/lib/google4r/checkout/xml_generation.rb

@@ -77,6 +77,8 @@ module Google4R #:nodoc:
         ResetItemsShippingInformationCommand => 'reset-items-shipping-information',
         OrderReportCommand => 'order-list-request',
         NotificationHistoryRequestCommand => 'notification-history-request',
+        NotificationDataTokenRequestCommand => 'notification-data-token-request',
+        NotificationDataRequestCommand => 'notification-data-request'
       }
       
       def initialize(command)
@@ -1070,5 +1072,43 @@ module Google4R #:nodoc:
 
       end
     end
+
+    class NotificationDataRequestCommandXmlGenerator < CommandXmlGenerator
+
+      def initialize(command)
+        @command = command
+      end
+
+      protected
+
+      def process_command(command)
+        root = super
+
+        if command.continue_token
+          element = root.add_element('continue-token')
+          element.text = command.continue_token
+        end
+
+      end
+    end
+
+    class NotificationDataTokenRequestCommandXmlGenerator < CommandXmlGenerator
+
+      def initialize(command)
+        @command = command
+      end
+
+      protected
+
+      def process_command(command)
+        root = super
+
+        if command.start_time
+          element = root.add_element('start-time')
+          element.text = command.start_time.xmlschema
+        end
+
+      end
+    end
   end
 end

data/test/test_helper.rb

@@ -37,6 +37,7 @@ Bundler.setup(:default, :test)
 
 require 'mocha'
 require 'nokogiri'
+require 'pry'
 
 class Array
   # Returns the "power set" for this Array. This means that an array with all

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: google4r-checkout
 version: !ruby/object:Gem::Version
-  version: 1.1.6
   prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Tony Chan
@@ -16,75 +16,93 @@ authors:
 - Paul Schreiber
 - Ben Hutton
 - James Martin
+- Jacob Comer
+- Chance Downs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-01 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: money
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
+    none: false
+  name: money
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: mocha
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: nokogiri
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
   name: rake
+  type: :development
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: pry
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 description: ! "  google4r-checkout is a lightweight, framework-agnostic Ruby library
   to access the Google Checkout service and implement \n  notification handlers. It
   exposes object-oriented wrappers for all of Google Checkout's API commands and notifications.\n"
@@ -181,17 +199,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.4
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -265,4 +283,3 @@ test_files:
 - test/unit/us_zip_area_test.rb
 - test/unit/world_area_test.rb
 - test/test_helper.rb
-has_rdoc: