topfunky-google-checkout 0.2.0

data/History.txt

@@ -0,0 +1,14 @@
+== 0.2.0 / 2007-08-14
+
+* Significant rewrite!
+  * Added rSpec specifications.
+  * Added level 2 integration for sending and
+    and parsing notifications from Google.
+  * Shipping temporarily hard-coded to 
+    "Digital Download"
+  * Added merchant-private-data for sending
+    one's own tracking number to Google.
+  * Defaults to live system but you can call
+    GoogleCheckout.use_sandbox to use the
+    sandbox instead.
+  * Fixtures for Google commands and notifications.

data/MIT-LICENSE.txt

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2006-2008 Peter Elmore (pete.elmore at gmail.com) and Topfunky Corporation
+
+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.
+

data/Manifest.txt

@@ -0,0 +1,40 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/duck_punches/hpricot.rb
+lib/google-checkout.rb
+lib/google-checkout/cart.rb
+lib/google-checkout/command.rb
+lib/google-checkout/notification.rb
+spec/fixtures/google/checkout-shopping-cart.xml
+spec/fixtures/google/commands/add-merchant-order-number.xml
+spec/fixtures/google/commands/add-tracking-data.xml
+spec/fixtures/google/commands/archive-order.xml
+spec/fixtures/google/commands/authorize-order.xml
+spec/fixtures/google/commands/cancel-order.xml
+spec/fixtures/google/commands/charge-order.xml
+spec/fixtures/google/commands/deliver-order.xml
+spec/fixtures/google/commands/process-order.xml
+spec/fixtures/google/commands/refund-order.xml
+spec/fixtures/google/commands/send-buyer-message.xml
+spec/fixtures/google/commands/unarchive-order.xml
+spec/fixtures/google/notifications/authorization-amount-notification.xml
+spec/fixtures/google/notifications/charge-amount-notification.xml
+spec/fixtures/google/notifications/chargeback-amount-notification.xml
+spec/fixtures/google/notifications/new-order-notification.xml
+spec/fixtures/google/notifications/order-state-change-notification.xml
+spec/fixtures/google/notifications/refund-amount-notification.xml
+spec/fixtures/google/notifications/risk-information-notification.xml
+spec/fixtures/google/responses/checkout-redirect.xml
+spec/fixtures/google/responses/error.xml
+spec/fixtures/google/responses/request-received.xml
+spec/google-checkout/cart_spec.rb
+spec/google-checkout/command_spec.rb
+spec/google-checkout/notification_spec.rb
+spec/google-checkout/response_spec.rb
+spec/google-checkout_spec.rb
+spec/spec_helper.rb
+support/cacert.pem
+examples/google_notifications_controller.rb
+MIT-LICENSE.txt

data/README.txt

@@ -0,0 +1,139 @@
+google-checkout
+    by Peter Elmore and Geoffrey Grosenbach
+    http://rubyforge.org/projects/google-checkout
+
+== DESCRIPTION:
+  
+Experimental library for working with GoogleCheckout. Currently in use for
+payment at http://peepcode.com.
+
+== Installation
+
+  sudo gem install google-checkout
+
+== What is Google Checkout?
+
+Well, according to Google, "Google Checkout helps you increase sales.  And
+process them for free when you advertise with Google."  What it really amounts
+to is that Google will process your orders for a 10% fee and you get a little
+shopping cart icon in your ad if you advertise through AdWords.  The fee can
+be paid by running AdWords ads on your site.  You can read about it and get an
+account at http://checkout.google.com/sell.
+
+== What is google-checkout?
+
+google-checkout is a module for working with the Google Checkout API
+(http://code.google.com/apis/checkout/index.html).  Specifically, if you have
+a Google Checkout account, you can use this module to do things like add
+"Checkout" and "Buy Now" buttons to your site.
+
+== Brief Example
+
+  require 'rubygems'
+  require 'google-checkout'
+
+  merchant_id = 'Your merchant id.'
+  merchant_key = 'Your merchant key.  Keep this a secret!'
+
+  cart = GoogleCheckout::Cart.new(merchant_id, merchant_key)
+  cart.add_item(:name => 'Chair', :description => 'A sturdy, wooden chair',
+                :price => 44.99)
+  puts cart.checkout_button
+
+== Usage
+
+First, you'll need a merchant ID and a merchant key, which you can get from
+the Google Checkout site once you have an account.  After you have that, you
+can start writing code.  
+
+The class you'll be working with is GoogleCheckout::Cart.  Of course, it
+represents a cart, and you can fill it with items.  
+
+  cart = GoogleCheckout::Cart.new(merchant_id, merchant_key, item1, item2)
+  cart.add_item item3
+
+The items you put into the cart should be one of two types:
+* A Hash containing the following
+** :name
+** :description
+** :price
+** :quantity (default 1)
+** :currency (default 'USD')
+** :regular_shipping, the shipping cost (default $0)
+* Or any Object that has a method called to_google_product that returns a hash
+  like the one described.
+
+Once you have a cart full of items, you can generate the XML for the API call
+by calling Cart#checkout_xml, although you'll probably just want to add a
+checkout button to your page with Cart#checkout_button.  This method generates
+HTML for a form containing a button and the hidden inputs necessary to call
+Google Checkout.  Cart#checkout_button has plenty of options for controlling
+the look of the button.  Once again, the arguments are passed as a hash,
+although the defaults are usually reasonable so you might not need to pass
+anything.
+
+* :size is the size of the button, one of :small, :medium, or :large.  Google
+  is picky about the sizes of these buttons.  See GoogleCheckout::ButtonSizes
+  for more information.  The default is :medium.
+* :variant is one of 'disabled' or 'text'.  'disabled' means that the button 
+  should be greyed-out; it is used in cases that the item you are selling
+  cannot be bought via Google Checkout.  (There's a long list of items that
+  are not allowed at https://checkout.google.com/seller/content_policies.html
+* :buy_or_checkout must be one of :buy_now or :checkout .  This determines the
+  look of the button that will be displayed.  The default is to use :checkout
+  if there are two or more items in the cart.
+* :style must be one of 'white' or 'trans'.  'white' gets you a white button,
+  while 'trans' gets you a transparent button suitable for use on non-white
+  backgrounds.  The default is 'white'.
+
+  cart.checkout_button :size => :small, :style => 'trans'
+
+When users click the button, they will be taken to the Google Checkout page
+with a cart full of the products you specified, and your work is done.
+
+== Missing Features
+
+* Level 1 integration is complete except for tax tables
+* Level 2 integration has been partly implemented and is in use at http://peepcode.com.  
+
+See
+http://checkout.google.com/support/sell/bin/answer.py?answer=42917&topic=8671
+for more information about the two integration levels.
+
+If there are missing features I haven't thought of, let me know.
+
+== Bugs
+
+No 'hard' bugs, I hope.  Pete's contact information is at the bottom of the page if you find one.  There may be more subjective bugs (e.g., design issues); feel free to tell me about these, too.
+
+== Contact Information
+
+The home page is at http://debu.gs/google-checkout .  You can email me at pete
+dot elmore at gmail dot com.  Try to mention Google Checkout in the subject
+line.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2006-2007 Peter Elmore (pete.elmore at gmail.com) and Topfunky Corporation
+
+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.
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'google-checkout'
+
+Hoe.new('google-checkout', GoogleCheckout::VERSION) do |p|
+  p.name = "google-checkout"
+  p.author = ["Peter Elmore", "Geoffrey Grosenbach"]
+  p.email = 'boss@topfunky.com'
+  p.summary = "An experimental library for sending payment requests to Google Checkout."
+  p.description = p.paragraphs_of('README.txt', 1..1).join("\n\n")
+  p.url = "http://rubyforge.org/projects/google-checkout"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = '' # Release docs to root
+  p.extra_deps = ['ruby-hmac']
+end
+
+desc "Run specs"
+task :default do
+  system 'spec spec --format specdoc --color'
+end

data/examples/google_notifications_controller.rb

@@ -0,0 +1,159 @@
+##
+# Skeleton for handing Level 2 notifications from GoogleCheckout with Rails.
+#
+# You'll need to write the individual handlers. SSL is required.
+#
+# SAMPLE ONLY! Modify for your own use. Extra error handling may be needed.
+
+class GoogleNotificationsController < ApplicationController
+
+  before_filter :verify_access
+  after_filter  :log_google_notification
+
+  ##
+  # Google calls this with notifications.
+
+  def create
+    @notification = GoogleCheckout::Notification.parse(request.raw_post)
+
+    case @notification
+    when GoogleCheckout::NewOrderNotification
+      handle_new_order_notification(@notification)
+
+    when GoogleCheckout::OrderStateChangeNotification
+      handle_order_state_change_notification(@notification)
+
+    when GoogleCheckout::RiskInformationNotification
+      handle_risk_information_notification(@notification)
+
+    when GoogleCheckout::ChargeAmountNotification
+      handle_charge_amount_notification(@notification)
+
+    when GoogleCheckout::AuthorizationAmountNotification
+      handle_authorization_amount_notification(@notification)
+
+    when GoogleCheckout::ChargebackAmountNotification
+      handle_chargeback_amount_notification(@notification)
+
+    when GoogleCheckout::RefundAmountNotification
+      handle_refund_amount_notification(@notification)
+    end
+
+    render :xml => @notification.acknowledgment_xml
+  end
+
+  private
+
+  ##
+  # Use basic authentication in my realm to get a user object.
+  # Since this is a security filter - return false if the user is not authenticated.
+
+  def verify_access
+    return false unless (request.ssl? || (RAILS_ENV == 'development') || (RAILS_ENV == 'test'))
+    authenticate_or_request_with_http_basic("PeepCode") do |merchant_id, merchant_key|
+      (merchant_id == GOOGLE_ID) && (merchant_key == GOOGLE_KEY)
+    end
+  end
+
+  ##
+  #
+
+  def log_google_notification
+    # TODO Write to your log or to a DB table
+  end
+
+  ##
+  #
+
+  def handle_new_order_notification(notification)
+    logger.info "Got NewOrderNotification"
+
+    # NOTE You should have passed your own order number to Google when
+    #      making the initial order. Subsequent notifications will use
+    #      Google's order number instead.
+    @order = Order.find_by_order_number(notification.my_order_number)
+    if @order
+      # NOTE You may want to check the amount being charged vs. the amount
+      #      you expected the user to pay.
+
+      @order.google_order_number = notification.google_order_number
+      @order.email  = notification.email
+
+      # Fee is 20 cents plus 2% of total.
+      @order.fee_cents   = (20 + (notification.order_total.cents * 0.02)).round
+      @order.gross_cents = notification.order_total.cents
+      @order.net_cents   = @order.gross_cents - @order.fee_cents
+
+      # NOTE Also of interest is notification.email_allowed, a boolean
+      @order.save
+      @order.new_order!
+    end
+  end
+
+  ##
+  #
+
+  def handle_order_state_change_notification(notification)
+    @order = Order.find_for_notification(notification)
+    @order.update_attribute(:google_state, notification.state)
+
+    case notification.state
+    when "REVIEWING"            # Initial state of orders. Rarely seen by client.
+
+    when "CHARGEABLE"           # You can now charge the customer for the order.
+      @order.chargeable!
+    when "CHARGING"             # Google is charging the customer.
+      @order.charging!
+    when "CHARGED"              # You have charged the customer.
+      @order.charged!
+    when "PAYMENT_DECLINED"     # Google was unable to charge the client
+      @order.denied!
+    when "CANCELLED"            # Order was cancelled by the merchant
+      @order.denied!
+      @order.update_attribute(:payment_note, notification.reason) rescue nil
+    when "CANCELLED_BY_GOOGLE"  # Order was cancelled by Google
+      @order.denied!
+      # notification.reason
+    end
+  end
+
+  ##
+  #
+
+  def handle_risk_information_notification(notification)
+    logger.info "Got RiskInformationNotification"
+
+    @order = Order.find_for_notification(notification)
+    @order.risk!
+
+    # TODO You need to ping Google after this to trigger the next state.
+    #      Do this in the model, but for reference, here's the basic code.
+    if @order.google_state == "CHARGEABLE"
+      charge_order_command = GoogleCheckout::ChargeOrder.new(GOOGLE_ID, GOOGLE_KEY, @order.google_order_number)
+      # To string, to float in order to get a float representation of the money
+      charge_order_command.amount = total_price.to_s.to_f
+      # Will throw error on failure
+      notification = charge_order_command.post
+    else
+      logger.error("Order was not in CHARGEABLE state")
+    end
+  end
+
+  ##
+  #
+
+  def handle_charge_amount_notification(notification)
+    @order = Order.find_for_notification(notification)
+    @order.charge!
+  end
+
+  ##
+  #
+
+  def handle_refund_amount_notification(notification)
+    # NOTE Notification includes amount refunded.
+    @order = Order.find_for_notification(notification)
+    @order.refund!
+  end
+
+end

data/lib/duck_punches/hpricot.rb

@@ -0,0 +1,24 @@
+
+class Hpricot::Elements
+
+  ##
+  # Assume a Google standard money node with a currency attribute.
+  #
+  # Returns a Ruby Money object.
+  
+  def to_money
+    dollar_amount = inner_html
+    cents = (dollar_amount.to_f * 100).round
+    currency = first[:currency]
+    Money.new(cents, currency)    
+  end
+
+  ##
+  # Return boolean true if the value of an element is the 
+  # string 'true'.
+  
+  def to_boolean
+    inner_html == 'true'
+  end
+  
+end

data/lib/google-checkout.rb

@@ -0,0 +1,61 @@
+##
+# Ref:
+#
+#  https://sandbox.google.com/checkout/cws/v2/Merchant/MERCHANT_ID/merchantCheckout
+#  https://checkout.google.com/cws/v2/Merchant/MERCHANT_ID/merchantCheckout
+
+$: << File.dirname(__FILE__)
+$: << File.dirname(__FILE__) + "/vendor/ruby-hmac/lib"
+
+require 'rubygems'
+
+require 'hmac-sha1'
+require 'base64'
+require 'builder/xmlmarkup'
+require 'hpricot'
+require 'money'
+require 'net/https'
+require 'active_support'
+
+require 'duck_punches/hpricot'
+require 'google-checkout/notification'
+require 'google-checkout/command'
+require 'google-checkout/cart'
+
+##
+# TODO
+# 
+#   * Analytics integration
+#     http://code.google.com/apis/checkout/developer/checkout_analytics_integration.html
+
+module GoogleCheckout
+
+  VERSION = '0.2.0'
+
+  @@live_system = true
+  
+  ##
+  # Submit commands to the Google Checkout test servers.
+  
+  def self.use_sandbox
+    @@live_system = false
+  end
+  
+  ##
+  # The default.
+  
+  def self.use_production
+    @@live_system = true
+  end
+
+  def self.sandbox?
+    !@@live_system
+  end
+
+  def self.production?
+    @@live_system
+  end
+
+  class APIError < Exception; end
+
+end