mlins-google-checkout 0.0.2

data/lib/google-checkout/geography.rb

@@ -0,0 +1,7 @@
+require 'google-checkout/geography/area'
+
+require 'google-checkout/geography/world'
+require 'google-checkout/geography/postal'
+require 'google-checkout/geography/us_country'
+require 'google-checkout/geography/us_state'
+require 'google-checkout/geography/us_zip'

data/lib/google-checkout/geography/area.rb

@@ -0,0 +1,11 @@
+module GoogleCheckout
+  module Geography
+    class Area
+
+      def to_xml
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/google-checkout/geography/postal.rb

@@ -0,0 +1,26 @@
+module GoogleCheckout
+  module Geography
+    class Postal < Area
+
+      attr_accessor :country, :postal_pattern
+
+      def initialize(country, postal_pattern=nil)
+        @country = country
+        @postal_pattern = postal_pattern
+      end
+
+      def to_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('postal-area') do
+          xml.tag!('country-code') do
+            xml.text! @country
+          end
+          xml.tag!('postal-code-pattern') do
+            xml.text! @postal_pattern
+          end if @postal_pattern
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/geography/us_country.rb

@@ -0,0 +1,24 @@
+module GoogleCheckout
+  module Geography
+    class UsCountry < Area
+
+      VALID_REGIONS = [:continental_48, :full_50_states, :all]
+
+      attr_accessor :region
+
+      def initialize(region)
+        self.region = region
+      end
+
+      def to_xml
+        unless VALID_REGIONS.include?(@region.to_sym)
+          raise ArgumentError,
+            ":#{@region.to_s} is not a valid region. You may use :continental_48, :full_50_states or :all"
+        end
+        xml = Builder::XmlMarkup.new
+        xml.tag!('us-country-area', 'country-area' => @region.to_s.upcase)
+      end
+
+    end
+  end
+end

data/lib/google-checkout/geography/us_state.rb

@@ -0,0 +1,22 @@
+module GoogleCheckout
+  module Geography
+    class UsState < Area
+
+      attr_accessor :state
+
+      def initialize(state)
+        @state = state
+      end
+
+      def to_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('us-state-area') do
+          xml.tag!('state') do
+            xml.text! @state
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/geography/us_zip.rb

@@ -0,0 +1,22 @@
+module GoogleCheckout
+  module Geography
+    class UsZip < Area
+
+      attr_accessor :zip_pattern
+
+      def initialize(zip_pattern)
+        @zip_pattern = zip_pattern
+      end
+
+      def to_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('us-zip-area') do
+          xml.tag!('zip-pattern') do
+            xml.text! @zip_pattern
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/google-checkout/geography/world.rb

@@ -0,0 +1,12 @@
+module GoogleCheckout
+  module Geography
+    class World < Area
+
+      def to_xml
+        xml = Builder::XmlMarkup.new
+        xml.tag!('world-area')
+      end
+
+    end
+  end
+end

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,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 = 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
+
+  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.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/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