topfunky-google-checkout 0.2.0

data/lib/google-checkout/notification.rb

@@ -0,0 +1,212 @@
+
+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 = 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
+
+  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/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"/>

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

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refund-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719">
+    <amount currency="USD">15.00</amount>
+    <comment>Discount for inconvenience; ship replacement item</comment>
+    <reason>Damaged Merchandise</reason>
+</refund-order>

data/spec/fixtures/google/commands/send-buyer-message.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<send-buyer-message xmlns="http://checkout.google.com/schema/2"
+    google-order-number="841171949013218">
+    <message>Due to high volume, your order will ship 
+    next week. Thank you for your patience.</message>
+    <send-email>true</send-email>
+</send-buyer-message>

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

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

data/spec/fixtures/google/notifications/authorization-amount-notification.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<authorization-amount-notification xmlns="http://checkout.google.com/schema/2"
+    serial-number="bea6bc1b-e1e2-44fe-80ff-0180e33a2614">
+    <google-order-number>841171949013218</google-order-number>
+    <authorization-amount currency="USD">226.06</authorization-amount>
+    <authorization-expiration-date>2006-03-18T20:25:31</authorization-expiration-date>
+    <avs-response>Y</avs-response>
+    <cvn-response>Y</cvn-response>
+    <timestamp>2006-03-18T20:25:31</timestamp>
+</authorization-amount-notification>

data/spec/fixtures/google/notifications/charge-amount-notification.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<charge-amount-notification xmlns="http://checkout.google.com/schema/2"
+    serial-number="bea6bc1b-e1e2-44fe-80ff-0180e33a2614">
+    <google-order-number>841171949013218</google-order-number>
+    <latest-charge-amount currency="USD">226.06</latest-charge-amount>
+    <total-charge-amount currency="USD">226.06</total-charge-amount>
+    <timestamp>2006-03-18T18:25:31</timestamp>
+</charge-amount-notification>

data/spec/fixtures/google/notifications/chargeback-amount-notification.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chargeback-amount-notification xmlns="http://checkout.google.com/schema/2"
+    serial-number="bea6bc1b-e1e2-44fe-80ff-0180e33a2614">
+    <google-order-number>841171949013218</google-order-number>
+    <latest-chargeback-amount currency="USD">226.06</latest-chargeback-amount>
+    <total-chargeback-amount currency="USD">226.06</total-chargeback-amount>
+    <timestamp>2006-03-18T20:25:31</timestamp>
+</chargeback-amount-notification>

data/spec/fixtures/google/notifications/new-order-notification.xml

@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<new-order-notification xmlns="http://checkout.google.com/schema/2"
+    serial-number="bea6bc1b-e1e2-44fe-80ff-0180e33a2614">
+    <google-order-number>841171949013218</google-order-number>
+    <buyer-shipping-address>
+
+        <contact-name>John Smith</contact-name>
+        <email>johnsmith@example.com</email>
+        <address1>10 Example Road</address1>
+        <city>Sampleville</city>
+        <region>CA</region>
+        <postal-code>94141</postal-code>
+        <country-code>US</country-code>
+    </buyer-shipping-address>
+    <buyer-billing-address>
+        <contact-name>Bill Hu</contact-name>
+        <email>billhu@example.com</email>
+        <address1>99 Credit Lane</address1>
+        <city>Mountain View</city>
+        <region>CA</region>
+        <postal-code>94043</postal-code>
+        <country-code>US</country-code>
+    </buyer-billing-address>
+    <buyer-id>294873009217523</buyer-id>
+    <fulfillment-order-state>NEW</fulfillment-order-state>
+    <financial-order-state>REVIEWING</financial-order-state>
+
+    <shopping-cart>
+        <cart-expiration>
+            <good-until-date>2007-12-31T23:59:59-05:00</good-until-date>
+        </cart-expiration>
+        <items>
+            <item>
+                <merchant-item-id>GGLAA1453</merchant-item-id>
+                <item-name>Dry Food Pack</item-name>
+                <item-description>One pack of nutritious dried food for emergencies.</item-description>
+                <quantity>1</quantity>
+                <tax-table-selector>food</tax-table-selector>
+                <unit-price currency="USD">4.99</unit-price>
+            </item>
+            <item>
+                <merchant-item-id>MGS2GBMP3</merchant-item-id>
+                <item-name>Megasound 2GB MP3 Player</item-name>
+                <item-description>This portable MP3 player stores 500 songs.</item-description>
+                <quantity>1</quantity>
+                <unit-price currency="USD">179.99</unit-price>
+                <merchant-private-item-data>
+                    <merchant-product-id>1234567890</merchant-product-id>
+                </merchant-private-item-data>
+            </item>
+        </items>
+        <merchant-private-data>
+            <peepcode-order-number>1234-5678-9012</peepcode-order-number>
+        </merchant-private-data>
+    </shopping-cart>
+    <order-adjustment>
+        <merchant-calculation-successful>true</merchant-calculation-successful>
+        <merchant-codes>
+            <coupon-adjustment>
+                <applied-amount currency="USD">5.00</applied-amount>
+                <code>FirstVisitCoupon</code>
+                <calculated-amount currency="USD">5.00</calculated-amount>
+                <message>You saved $5.00 for your first visit!</message>
+            </coupon-adjustment>
+            <gift-certificate-adjustment>
+                <applied-amount currency="USD">10.00</applied-amount>
+                <code>GiftCert12345</code>
+                <calculated-amount currency="USD">10.00</calculated-amount>
+                <message>You saved $10.00 with this gift certificate!</message>
+            </gift-certificate-adjustment>
+        </merchant-codes>
+        <total-tax currency="USD">0.0</total-tax>
+        <shipping>
+            <merchant-calculated-shipping-adjustment>
+                <shipping-name>SuperShip</shipping-name>
+                <shipping-cost currency="USD">9.95</shipping-cost>
+            </merchant-calculated-shipping-adjustment>
+        </shipping>
+    </order-adjustment>
+    <order-total currency="USD">190.98</order-total>
+    <buyer-marketing-preferences>
+        <email-allowed>false</email-allowed>
+    </buyer-marketing-preferences>
+    <timestamp>2006-05-03T17:32:11</timestamp>
+</new-order-notification>

data/spec/fixtures/google/notifications/order-state-change-notification.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<order-state-change-notification xmlns="http://checkout.google.com/schema/2"
+    serial-number="bea6bc1b-e1e2-44fe-80ff-0180e33a2614">
+    <google-order-number>841171949013218</google-order-number>
+    <new-financial-order-state>CHARGING</new-financial-order-state>
+    <new-fulfillment-order-state>NEW</new-fulfillment-order-state>
+    <previous-financial-order-state>CHARGEABLE</previous-financial-order-state>
+    <previous-fulfillment-order-state>NEW</previous-fulfillment-order-state>
+    <reason>The reason goes here, if there is one.</reason>
+    <timestamp>2006-05-03T17:32:11</timestamp>
+</order-state-change-notification>

data/spec/fixtures/google/notifications/refund-amount-notification.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refund-amount-notification xmlns="http://checkout.google.com/schema/2"
+    serial-number="bea6bc1b-e1e2-44fe-80ff-0180e33a2614">
+    <google-order-number>841171949013218</google-order-number>
+    <latest-refund-amount currency="USD">226.06</latest-refund-amount>
+    <total-refund-amount currency="USD">226.06</total-refund-amount>
+    <timestamp>2006-03-18T20:25:31</timestamp>
+</refund-amount-notification>