google_checkout 0.1.0 → 0.1.1

data/lib/google-checkout.rb

@@ -21,9 +21,6 @@ require 'builder/xmlmarkup'
 # GoogleCheckout::Cart, Cart#add_item, Cart#checkout_xml, and
 # Cart#checkout_button.
 module GoogleCheckout
-	CheckoutURL = "checkout.google.com"
-	SubmitURL = "https://#{CheckoutURL}/cws/v2/Merchant"
-
 
 	# These are the only sizes allowed by Google.  These shouldn't be needed
 	# by most people; just specify the :size and :buy_or_checkout options to
@@ -67,10 +64,33 @@ module GoogleCheckout
 		def initialize(merchant_id, merchant_key, *items)
 			@merchant_id = merchant_id
 			@merchant_key = merchant_key
+			@live_system = true
 			@contents = []
 			items.each { |i| add_item i }
 		end
 
+		def use_sandbox
+			@live_system = false
+		end
+
+		# This method sets the flat rate shipping for the entire cart.
+		# If set, it will over ride the per product flat rate shipping.
+		# +frs_options+ should be a hash containing the following options:
+		# * price
+		# You may fill an some optional values as well:
+		# * currency (defaults to 'USD')
+		def flat_rate_shipping(frs_options)
+			# We need to check that the necessary keys are in the hash,
+			# Otherwise the error will happen in the middle of checkout_xml,
+			# and the bug will be harder to track.
+			unless frs_options.include? :price
+				raise ArgumentError, 
+					"Required keys missing: :price"
+			end
+
+			@flat_rate_shipping = {:currency => 'USD'}.merge(frs_options)
+		end
+
 		def empty?
 			@contents.empty?
 		end
@@ -79,10 +99,17 @@ module GoogleCheckout
 		def size
 			@contents.size
 		end
+
+		def submit_domain 
+			(@live_system ? 'checkout' : 'sandbox') + ".google.com"
+		end
 		  
 		# This method returns the URL to which the form should be submitted.
 		def submit_url 
-			[SubmitURL, @merchant_id, 'checkout'].join('/')
+			["https://#{submit_domain}/cws/v2/Merchant", 
+			 @merchant_id, 
+			 'checkout'
+			].join('/')
 		end
 
 		# This method puts items in the cart.
@@ -153,16 +180,7 @@ module GoogleCheckout
 					xml.tag!('merchant-checkout-flow-support') {
 						xml.tag!('shipping-methods') {
 							xml.tag!('flat-rate-shipping', :name =>'Shipping') {
-								currency = 'USD'
-								shipping = @contents.inject(0) { |total,i| 
-									# Mixing currency not allowed; this library
-									# can't convert between currencies.
-									currency = i[:currency] || currency
-									total + i[:regular_shipping].to_i
-								}.to_s
-								xml.price(:currency => currency) {
-									xml.text! shipping
-								}
+								shipping_cost_xml
 							}
 						}
 					}
@@ -171,13 +189,49 @@ module GoogleCheckout
 			@xml.dup
 		end
 
+		# Generates the XML for the shipping cost, conditional on
+		# @flat_rate_shipping being set.
+		def shipping_cost_xml
+			xml = Builder::XmlMarkup.new
+			if @flat_rate_shipping
+				xml.price(:currency => currency) {
+					xml.text! @flat_rate_shipping[:price].to_s
+				}
+			else
+				xml.price(:currency => @currency) {
+					xml.text! shipping_cost.to_s
+				}
+			end
+		end
+
+		# Returns the shipping cost for the contents of the cart.
+		def shipping_cost
+			currency = 'USD'
+			shipping = @contents.inject(0) { |total,item| 
+				total + item[:regular_shipping].to_i
+			}.to_s
+		end
+
+		# Returns the currency for the cart.  Mixing currency not allowed; this
+		# library can't convert between currencies.
+		def currency
+			# Mixing currency not allowed; this
+			# library can't convert between
+			# currencies.
+			@currency ||= 
+				(@contents.map { |item|
+					item.currency
+				}.uniq.first rescue nil) ||
+				'USD'
+		end
+
 		# Returns the signature for the cart XML.
 		def signature
 			@xml or checkout_xml
 			HMAC::SHA1.digest(@merchant_key, @xml)
 		end
 
-		# Returns HTML for a checkout form for buying all the items in the 
+		# Returns HTML for a checkout form for buying all the items in the
 		# cart.  
 		def checkout_button(button_opts = {})
 			@xml or checkout_xml
@@ -202,13 +256,12 @@ module GoogleCheckout
 		# The options are the same as those specified on
 		# http://checkout.google.com/seller/checkout_buttons.html , with a
 		# couple of extra options for convenience.  Rather than specifying the
-		# width and  height  manually, you may specify :size to be one of
-		# :small, :medium,  or :large,  and that you may set :buy_or_checkout
-		# to :buy_now or  :checkout to get  a 'Buy Now' button versus a
-		# 'Checkout' button.  If  you don't specify  :buy_or_checkout, the Cart
-		# will try to guess based  on if the cart has  more than one item in
-		# it.  Whatever you don't pass will be filled in with the defaults from
-		# DefaultButtonOpts.
+		# width and height manually, you may specify :size to be one of :small,
+		# :medium, or :large, and that you may set :buy_or_checkout to :buy_now
+		# or :checkout to get a 'Buy Now' button versus a 'Checkout' button. If
+		# you don't specify :buy_or_checkout, the Cart will try to guess based
+		# on if the cart has more than one item in it.  Whatever you don't pass
+		# will be filled in with the defaults from DefaultButtonOpts.
 		def button_url(opts = {})
 			opts = DefaultButtonOpts.merge opts
 			opts[:buy_or_checkout] ||= @contents.size > 1 ? :checkout : 
@@ -222,7 +275,7 @@ module GoogleCheckout
 
 			path = opts.map { |k,v| "#{k}=#{v}" }.join('&')
 
-			"http://#{CheckoutURL}/buttons/#{bname}?#{path}"
+			"http://#{submit_domain}/buttons/#{bname}?#{path}"
 		end
 	end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.8
 specification_version: 1
 name: google_checkout
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-12-17
+  version: 0.1.1
+date: 2006-12-18
 summary: An interface to the Google Checkout API.
 require_paths: 
 - lib