vizjerai-google-checkout 0.0.5

data/lib/google-checkout/merchant_calculation.rb

@@ -0,0 +1,30 @@
+module GoogleCheckout
+  class MerchantCalculation
+
+    attr_accessor :doc
+
+    def self.parse(raw_xml)
+      doc = Hpricot.XML(raw_xml)
+      return new(doc)
+    end
+
+    def initialize(doc) # :nodoc:
+      @doc = doc
+    end
+
+    def address_id
+      @doc.at('anonymous-address').attributes['id']
+    end
+
+    def method_missing(method_name, *args)
+      element_name = method_name.to_s.gsub(/_/, '-')
+      if element = (@doc.at element_name)
+        if element.respond_to?(:inner_html)
+          return element.inner_html
+        end
+      end
+      super
+    end
+
+  end
+end

data/lib/google-checkout/notification.rb

@@ -0,0 +1,352 @@
+
+module GoogleCheckout
+
+  ##
+  # Base notification class. Parses incoming XML and returns a class
+  # matching the kind of notification being received.
+  #
+  # This makes it easy to handle events in your code.
+  #
+  #   notification = GoogleCheckout::Notification.parse(request.raw_post)
+  #   case notification
+  #   when GoogleCheckout::NewOrderNotification
+  #     do_something_with_new_order
+  #   end
+  #
+  # TODO Document field access and Hpricot object access.
+  #
+  # For the details, see http://code.google.com/apis/checkout/developer/index.html
+
+  class Notification
+
+    # The Hpricot XML document received from Google.
+    attr_accessor :doc
+
+    ##
+    # The entry point for notifications.
+    #
+    # Returns a corresponding notification object based on
+    # the XML received.
+
+    def self.parse(raw_xml)
+      doc = Hpricot.XML(raw_xml)
+
+      # Convert +request-received+ to +request_received+,
+      # then to a +RequestReceived+ object of the proper class 
+      # which will be created and returned.
+      const_name = ActiveSupport::Inflector.camelize(doc.root.name.gsub('-', '_'))
+      if GoogleCheckout.const_get(const_name)
+        return GoogleCheckout.const_get(const_name).new(doc)
+      end
+    end
+
+    def initialize(doc) # :nodoc:
+      @doc = doc
+    end
+
+    ##
+    # Returns the financial-order-state (or new-financial-order-state).
+    #
+    # This is a shortcut since this state will be accessed frequently.
+    #
+    # The fulfillment-order-state (and variations) can be accessed
+    # with the more explicit syntax:
+    #
+    #   notification.fulfillment_order_state
+    #
+    # The following is from http://code.google.com/apis/checkout/developer/index.html
+    #
+    # The <financial-order-state> tag identifies the financial status of an order. Valid values for this tag are:
+    #
+    #   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>.
+    #
+    # Please see the Order States section for more information about these states.
+
+    def state
+      if (@doc.at 'financial-order-state')
+        return (@doc/'financial-order-state').inner_html
+      elsif (@doc.at 'new-financial-order-state')
+        return (@doc/'new-financial-order-state').inner_html
+      end
+    end
+
+    ##
+    # Returns the serial number from the root element.
+    
+    def serial_number
+      doc.root['serial-number']
+    end
+
+    ##
+    # Returns an XML string that can be sent back to Google to
+    # communicate successful receipt of the notification.
+
+    def acknowledgment_xml
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      @xml = xml.tag!('notification-acknowledgment', {
+        :xmlns => "http://checkout.google.com/schema/2"
+      })
+      @xml
+    end
+
+    ##
+    # Returns true if this is a GoogleCheckout::Error object.
+    
+    def error?
+      self.class == GoogleCheckout::Error
+    end
+
+    ##
+    # Take requests for an XML element and returns its value.
+    #
+    #   notification.google_order_number
+    #   => Returns value of '<google-order-number>'
+    #
+    # Because of how Hpricot#at works, it will even dig into subtags
+    # and return the value of the first matching tag. For example,
+    # there is an +email+ field in +buyer-shipping-address+ and also
+    # in +buyer-billing-address+, but only the first will be returned.
+    #
+    # If you want to get at a value explicitly, use +notification.doc+
+    # and search the Hpricot document manually.
+
+    def method_missing(method_name, *args)
+      element_name = method_name.to_s.gsub(/_/, '-')
+      if element = (@doc.at element_name)
+        if element.respond_to?(:inner_html)
+          return element.inner_html
+        end
+      end
+      super
+    end
+
+  end
+
+  class AuthorizationAmountNotification < Notification; end
+
+  class ChargeAmountNotification < Notification
+
+    def latest_charge_amount
+      (@doc/"latest-charge-amount").to_money
+    end
+
+    def total_charge_amount
+      (@doc/"total-charge-amount").to_money
+    end
+
+  end
+
+  class ChargebackAmountNotification < Notification; end
+
+  class NewOrderNotification < Notification
+
+    ##
+    # Returns a Money object representing the total price of the order.
+    
+    def order_total
+      (@doc/"order-total").to_money
+    end
+
+    ##
+    # Returns a Money object representing the total tax added.
+    
+    def total_tax
+      (@doc/"total-tax").to_money
+    end
+
+    ##
+    # Returns true if the buyer wants to received marketing emails.
+    
+    def email_allowed
+      (@doc/"buyer-marketing-preferences"/"email-allowed").to_boolean
+    end
+
+    ##
+    # Returns billing name.
+
+    def billing_name
+      (@doc/"buyer-billing-address"/"contact-name").inner_html
+    end
+
+    ##
+    # Returns billing email
+
+    def billing_email
+      (@doc/"buyer-billing-address"/"email").inner_html
+    end
+
+    ##
+    # Returns billing address1
+
+    def billing_address1
+      (@doc/"buyer-billing-address"/"address1").inner_html
+    end
+
+    ##
+    # Returns billing city
+
+    def billing_city
+      (@doc/"buyer-billing-address"/"city").inner_html
+    end
+
+    ##
+    # Returns billing region
+
+    def billing_region
+      (@doc/"buyer-billing-address"/"region").inner_html
+    end
+
+    ##
+    # Returns billing postal code
+
+    def billing_postal_code
+      (@doc/"buyer-billing-address"/"postal-code").inner_html
+    end
+
+    ##
+    # Returns billing country code
+
+    def billing_country_code
+      (@doc/"buyer-billing-address"/"country-code").inner_html
+    end
+
+    ##
+    # Returns billing phone
+
+    def billing_phone
+      (@doc/"buyer-billing-address"/"phone").inner_html
+    end
+
+    ##
+    # Returns billing first name
+
+    def billing_first_name
+      (@doc/"buyer-billing-address"/"structured-name"/"first-name").inner_html
+    end
+
+    ##
+    # Returns billing last name
+
+    def billing_last_name
+      (@doc/"buyer-billing-address"/"structured-name"/"last-name").inner_html
+    end
+
+    ##
+    # Returns shipping contact name
+
+    def shipping_name
+      (@doc/"buyer-shipping-address"/"contact-name").inner_html
+    end
+
+    ##
+    # Returns shipping email
+
+    def shipping_email
+      (@doc/"buyer-shipping-address"/"email").inner_html
+    end
+
+    ##
+    # Returns shipping address1
+
+    def shipping_address1
+      (@doc/"buyer-shipping-address"/"address1").inner_html
+    end
+
+    ##
+    # Returns shipping city
+
+    def shipping_city
+      (@doc/"buyer-shipping-address"/"city").inner_html
+    end
+
+    ##
+    # Returns shipping region
+
+    def shipping_region
+      (@doc/"buyer-shipping-address"/"region").inner_html
+    end
+
+    ##
+    # Returns shipping postal code
+
+    def shipping_postal_code
+      (@doc/"buyer-shipping-address"/"postal-code").inner_html
+    end
+
+    ##
+    # Returns shipping country code
+
+    def shipping_country_code
+      (@doc/"buyer-shipping-address"/"country-code").inner_html
+    end
+
+    ##
+    # Returns shipping phone
+
+    def shipping_phone
+      (@doc/"buyer-shipping-address"/"phone").inner_html
+    end
+
+    ##
+    # Returns shipping first name
+
+    def shipping_first_name
+      (@doc/"buyer-shipping-address"/"structured-name"/"first-name").inner_html
+    end
+
+    ##
+    # Returns shipping last name
+
+    def shipping_last_name
+      (@doc/"buyer-shipping-address"/"structured-name"/"last-name").inner_html
+    end
+
+  end
+
+  class OrderStateChangeNotification < Notification; end
+
+  class RefundAmountNotification < Notification; end
+
+  class RiskInformationNotification < Notification; end
+
+  class CheckoutRedirect < Notification
+
+    ##
+    # Returns redirect-url with ampersands escaped, as specified by Google API docs.
+
+    def redirect_url
+      (@doc/"redirect-url").inner_html.gsub(/&amp;/, '&')
+    end
+
+  end
+
+  class Error < Notification
+
+    ##
+    # Alias for +error_message+
+
+    def message
+      (@doc/'error-message').inner_html
+    end
+
+  end
+
+  class RequestReceived < Notification; end
+
+end

data/lib/google-checkout/shipping/filters.rb

@@ -0,0 +1,32 @@
+module GoogleCheckout
+  module Shipping
+    module Filters
+
+      attr_accessor :address_filters
+
+      def address_filters?
+        @address_filters != {:allowed => [], :excluded => [], :allow_us_po_box => true}
+      end
+
+      def address_filters_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('address-filters') do
+          xml.tag!('allowed-areas') do
+            @address_filters[:allowed].each do |area|
+              xml << area.to_xml
+            end
+          end unless @address_filters[:allowed].empty?
+          xml.tag!('excluded-areas') do
+            @address_filters[:excluded].each do |area|
+              xml << area.to_xml
+            end
+          end unless @address_filters[:excluded].empty?
+          xml.tag!('allow-us-po-box') do
+            xml.text! 'false'
+          end unless @address_filters[:allow_us_po_box]
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/shipping/flat_rate.rb

@@ -0,0 +1,26 @@
+module GoogleCheckout
+  module Shipping
+    class FlatRate < Method
+
+      include Restrictions
+
+      attr_accessor :name, :price, :currency
+
+      def initialize(name, price, currency = 'USD')
+        @name = name
+        @price = price
+        @currency = currency
+        @shipping_restrictions = {:allowed => [], :excluded => [], :allow_us_po_box => true}
+      end
+
+      def to_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('flat-rate-shipping', :name => name) do
+          xml.tag!('price', price, :currency => currency)
+          xml << shipping_restrictions_xml if shipping_restrictions?
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/shipping/merchant_calculated.rb

@@ -0,0 +1,29 @@
+module GoogleCheckout
+  module Shipping
+    class MerchantCalculated < Method
+
+      include Restrictions
+      include Filters
+
+      attr_accessor :name, :price, :currency
+
+      def initialize(name, price, currency = 'USD')
+        @name = name
+        @price = price
+        @currency = currency
+        @shipping_restrictions = {:allowed => [], :excluded => [], :allow_us_po_box => true}
+        @address_filters = {:allowed => [], :excluded => [], :allow_us_po_box => true}
+      end
+
+      def to_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('merchant-calculated-shipping', :name => name) do
+          xml.tag!('price', price, :currency => currency)
+          xml << shipping_restrictions_xml if shipping_restrictions?
+          xml << address_filters_xml if address_filters?
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/shipping/method.rb

@@ -0,0 +1,11 @@
+module GoogleCheckout
+  module Shipping
+    class Method
+
+      def to_xml
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/google-checkout/shipping/pickup.rb

@@ -0,0 +1,22 @@
+module GoogleCheckout
+  module Shipping
+    class Pickup < Method
+
+      attr_accessor :name, :price, :currency
+
+      def initialize(name, price = '0.00', currency = 'USD')
+        @name = name
+        @price = price
+        @currency = currency
+      end
+
+      def to_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('pickup', :name => name) do
+          xml.tag!('price', price, :currency => currency)
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/shipping/restrictions.rb

@@ -0,0 +1,32 @@
+module GoogleCheckout
+  module Shipping
+    module Restrictions
+
+      attr_accessor :shipping_restrictions
+
+      def shipping_restrictions?
+        @shipping_restrictions != {:allowed => [], :excluded => [], :allow_us_po_box => true}
+      end
+
+      def shipping_restrictions_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('shipping-restrictions') do
+          xml.tag!('allowed-areas') do
+            @shipping_restrictions[:allowed].each do |area|
+              xml << area.to_xml
+            end
+          end unless @shipping_restrictions[:allowed].empty?
+          xml.tag!('excluded-areas') do
+            @shipping_restrictions[:excluded].each do |area|
+              xml << area.to_xml
+            end
+          end unless @shipping_restrictions[:excluded].empty?
+          xml.tag!('allow-us-po-box') do
+            xml.text! 'false'
+          end unless @shipping_restrictions[:allow_us_po_box]
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/shipping.rb

@@ -0,0 +1,8 @@
+require 'google-checkout/shipping/method'
+
+require 'google-checkout/shipping/restrictions'
+require 'google-checkout/shipping/filters'
+
+require 'google-checkout/shipping/pickup'
+require 'google-checkout/shipping/flat_rate'
+require 'google-checkout/shipping/merchant_calculated'

data/lib/google-checkout.rb

@@ -0,0 +1,65 @@
+##
+# 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/merchant_calculation'
+require 'google-checkout/command'
+require 'google-checkout/cart'
+
+require 'google-checkout/shipping'
+require 'google-checkout/geography'
+
+##
+# 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

data/spec/fixtures/google/checkout-shopping-cart.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<checkout-shopping-cart xmlns="http://checkout.google.com/schema/2">
+  <shopping-cart>
+    <items>
+      <item>
+        <item-name>HelloWorld 2GB MP3 Player</item-name>
+        <item-description>HelloWorld, the simple MP3 player</item-description>
+        <unit-price currency="USD">159.99</unit-price>
+        <quantity>1</quantity>
+      </item>
+    </items>
+  </shopping-cart>
+  <checkout-flow-support>
+    <merchant-checkout-flow-support>
+      <shipping-methods>
+        <flat-rate-shipping name="SuperShip Ground">
+          <price currency="USD">9.99</price>
+        </flat-rate-shipping>
+      </shipping-methods>
+    </merchant-checkout-flow-support>
+  </checkout-flow-support>
+</checkout-shopping-cart>

data/spec/fixtures/google/commands/add-merchant-order-number.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<add-merchant-order-number xmlns="http://checkout.google.com/schema/2"
+    google-order-number="841171949013218">
+    <merchant-order-number>P6502-53-7861SBJD</merchant-order-number>
+</add-merchant-order-number>

data/spec/fixtures/google/commands/add-tracking-data.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<add-tracking-data xmlns="http://checkout.google.com/schema/2"
+    google-order-number="841171949013218">
+    <tracking-data>
+        <carrier>UPS</carrier>
+        <tracking-number>Z9842W69871281267</tracking-number>
+    </tracking-data>
+</add-tracking-data>

data/spec/fixtures/google/commands/archive-order.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<archive-order xmlns="http://checkout.google.com/schema/2"
+    google-order-number="841171949013218" />

data/spec/fixtures/google/commands/authorize-order.xml

@@ -0,0 +1,2 @@
+<authorize-order xmlns="http://checkout.google.com/schema/2"
+      google-order-number="6014423719"/>

data/spec/fixtures/google/commands/cancel-order.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<cancel-order xmlns="http://checkout.google.com/schema/2" google-order-number="841171949013218">
+    <reason>Buyer cancelled the order.</reason>
+    <comment>Buyer ordered another item.</comment>
+</cancel-order>

data/spec/fixtures/google/commands/charge-order.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<charge-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719">
+    <amount currency="USD">335.55</amount>
+</charge-order>

data/spec/fixtures/google/commands/deliver-order.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<deliver-order xmlns="http://checkout.google.com/schema/2"
+    google-order-number="841171949013218">
+    <tracking-data>
+        <carrier>UPS</carrier>
+        <tracking-number>Z5498W45987123684</tracking-number>
+    </tracking-data>
+    <send-email>false</send-email>
+</deliver-order>

data/spec/fixtures/google/commands/process-order.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<process-order xmlns="http://checkout.google.com/schema/2" google-order-number="841171949013218"/>