bborn-simplepay 0.2.2

data/lib/simplepay/helpers/rails_helper.rb

@@ -0,0 +1,40 @@
+require 'action_view/base'
+
+module Simplepay
+  module Helpers
+    
+    ##
+    # Adds helpers to your views for generating the correct HTML forms and 
+    # valid signatures.
+    # 
+    module RailsHelper
+      
+      ##
+      # This is the general interface for generating your Simple Pay service
+      # forms.  See Simplepay::Services for available services and information
+      # specific to each.
+      # 
+      # === Example
+      # 
+      #     (in your view)
+      # 
+      #     <%= simplepay_form_for(:service_name, {:attr => 'foo'}) %>
+      # 
+      def simplepay_form_for(service_name, attributes = {}, submit_tag = nil)
+        service = get_simplepay_service(service_name)
+        service.form(attributes, submit_tag)
+      end
+      
+      
+      private
+      
+      
+      def get_simplepay_service(name) #:nodoc:
+        service = "Simplepay::Services::#{name.to_s.camelize}".constantize
+        service.new
+      end
+      
+    end
+    
+  end
+end

data/lib/simplepay/rails.rb

@@ -0,0 +1,9 @@
+require 'simplepay'
+require 'simplepay/helpers/rails_helper'
+require 'simplepay/helpers/notification_helper'
+
+# Inject helper into Rails ActionView.
+ActionView::Base.__send__(:include, Simplepay::Helpers::RailsHelper)
+
+# Inject notification helper into ActionController
+ActionController::Base.__send__(:include, Simplepay::Helpers::NotificationHelper)

data/lib/simplepay/service.rb

@@ -0,0 +1,133 @@
+module Simplepay
+  
+  ##
+  # This is a base class from which to inherit functionality for all Amazon
+  # Simple Pay services (Subscriptions, Marketplace Buttons, etc.)
+  # 
+  # === Required Fields
+  # 
+  # The following fields are required for all Simple Pay services:
+  # 
+  # access_key:: Your Amazon Web Service (AWS) access key (automatically filled from Simplepay.aws_access_key_id).
+  # account_id:: Your Amazon Payments account identifier (automatically filled from Simplepay.account_id)
+  # signature:: The validation string, guaranteeing that you are the one generating the request and that the values were not tampered with enroute (automatically generated by the form generators)
+  # 
+  class Service
+
+    # Fully-qualified URL for the production endpoint for the service.
+    ENDPOINT_URL  = 'https://authorize.payments.amazon.com/pba/paypipeline'
+
+    # Fully-qualified URL for the sandbox (test) endpoint for the service.
+    SANDBOX_URL   = 'https://authorize.payments-sandbox.amazon.com/pba/paypipeline'
+    
+    class << self
+      
+      ##
+      # Defines a field for the service.
+      # 
+      # === Usage
+      # 
+      #     class Foo < Service
+      #       field :access_key
+      #       field :amount,    :class => Amount, :map_to => :value
+      #     end
+      # 
+      def field(name, options = {})
+        field = Support::Field.new(self, name, options)
+        define_method("#{name.to_s.underscore}=", Proc.new { |value| self.fields.detect { |f| f.name == name }.value = value })
+        self.fields << field
+        field
+      end
+      
+      ##
+      # Optional convenience method for:
+      # 
+      #     field :field_name, :required => true
+      # 
+      # Any other +options+ given will be still be passed through.
+      # 
+      def required_field(name, options = {})
+        field(name, options.merge(:required => true))
+      end
+      
+      ##
+      # Returns the collection of fields defined by the service class.
+      # 
+      def fields
+        @fields ||= []
+      end
+      
+      def set_submit_tag(value)
+        @submit_tag = value
+      end
+      
+      def submit_tag
+        @submit_tag
+      end
+      
+    end
+    
+    
+    ##
+    # Returns the fields for the service instance.
+    # 
+    def fields
+      @fields ||= self.class.fields.collect { |f| f.clone_for(self) }
+    end
+    
+    ##
+    # Returns the URL for the service endpoint to use.  If +sandbox+ is true,
+    # the SANDBOX_URL will be used.  Otherwise, the ENDPOINT_URL will be used.
+    # 
+    def url(sandbox = Simplepay.use_sandbox?)
+      sandbox ? self.class.const_get(:SANDBOX_URL) : self.class.const_get(:ENDPOINT_URL)
+    end
+    
+    def form(attributes = {}, submit = nil)
+      set_accessor_fields
+      set_fields(attributes)
+      set_signature
+      content = generate_input_fields + generate_submit_field(submit)
+      Simplepay::Helpers::FormHelper.content_tag(:form, content, {:method => 'post', :action => url})
+    end
+    
+    
+    private
+    
+    
+    def generate_input_fields
+      self.fields.collect { |f| f.to_input }.join
+    end
+    
+    def generate_submit_field(submit)
+      options = {:type => 'submit'}
+      options.merge!(:value => self.class.submit_tag) if self.class.submit_tag
+      submit ? submit.to_s : Simplepay::Helpers::FormHelper.tag(:input, options)
+    end
+    
+    def set_accessor_fields
+      self.access_key = Simplepay.aws_access_key_id if self.respond_to?(:access_key=)
+      self.account_id = Simplepay.account_id if self.respond_to?(:account_id=)
+    end
+    
+    def set_fields(hash)
+      hash.each_pair do |key, value|
+        self.send("#{key}=", value) if self.respond_to?("#{key}=")
+      end
+    end
+    
+    def set_signature
+      fields = {}
+      self.fields.each { |f| fields[f.service_name] = f.value unless f.service_name == 'signature' }
+      self.signature = Signature.new(URI.parse(url), fields).sign if self.respond_to?(:signature=)
+    end
+    
+  end
+  
+end
+
+require 'simplepay/services/subscription'
+require 'simplepay/services/standard'
+require 'simplepay/services/donation'
+require 'simplepay/services/marketplace'
+require 'simplepay/services/marketplace_policy'

data/lib/simplepay/services/donation.rb

@@ -0,0 +1,91 @@
+module Simplepay
+  module Services
+  
+    ##
+    # The Amazon Simple Pay Donation service is used to facilitate the collection 
+    # of donations to your organization, or another's organization via the 
+    # marketplace functionality.  When used through the marketplace functionality,
+    # you may charge a commission fee for brokering the exchange.
+    # 
+    # Note that donation recipients must accept your marketplace fee policy before
+    # the payment buttons for their donations may be generated.   This can be 
+    # accomplished using the +MarketplacePolicy+ service with the form helper 
+    # (see examples).
+    # 
+    # === Simple Pay Donation Fields
+    # 
+    # ==== Required Fields
+    # 
+    # The following attributes are required when generating a Simple Pay Donation
+    # form (in addition to those listed in +SimplePay::Service+):
+    # 
+    # amount:: The dollar value you'd like to collect
+    # 
+    # ==== Optional Fields
+    # 
+    # immediate_return:: Immediately returns the customer to your +return_url+ directly after payment.
+    # ipn_url:: Fully-qualified URL to which Amazon will POST instant payment notifications.
+    # process_immediately:: Instructs Amazon to immediately process the payment.
+    # reference_id:: A custom string your can set to identify this transaction, it will be returned with the IPNs and other returned data.
+    # return_url:: Fully-qualified URL for where to send your customer following payment.
+    # 
+    # ===== Marketplace Fields
+    # 
+    # recipient_email:: The email address of the donation recipient (important and must be correct)
+    # fixed_marketplace_fee::  The fixed marketplace fee to add to each transaction
+    # variable_marketplace_fee:: The variable marketplace fee to add to each transaction
+    # 
+    # === Example
+    # 
+    #     (in your view, sellers need to accept the marketplace fee policy using the form helper)
+    #
+    #     <%= simplepay_form_for(:marketplace_policy, {
+    #       :max_fixed_fee    => 10.00,
+    #       :max_variable_fee => 5,
+    #       :return_url       => 'http://yourservice.com'
+    #     }) %>
+    #
+    #     (in your view, payment form generated for end users using the form helper)
+    #     
+    #     <%= simplepay_form_for(:donation, {
+    #       :amount                   => 34.95,
+    #       :description              => "Mutual profit!",
+    #       :recipient_email          => 'seller@gmail.com',
+    #       :fixed_marketplace_fee    => 10.00,
+    #       :variable_marketplace_fee => 5
+    #     }) %>
+    # 
+    class Donation < Service
+
+      required_field :access_key
+      required_field :signature
+      required_field :account_id,           :as     => :amazon_payments_account_id
+      required_field :signature_method, :value => 'HmacSHA256'
+      required_field :signature_version, :value => '2'
+      
+
+      required_field :description
+      required_field :amount,               :class  => Support::Amount
+      required_field :cobranding_style,     :value  => 'logo'
+      required_field :donation_widget,      :as     => :is_donation_widget,
+                                            :value  => '1'
+      
+      field :reference_id
+      field :immediate_return,              :class  => Support::Boolean
+      field :collect_shipping_address,      :class  => Support::Boolean
+      field :process_immediately,           :class  => Support::Boolean,
+                                            :as     => :process_immediate
+
+      field :return_url
+      field :ipn_url
+      field :abandon_url
+      
+      # Marketplace inputs (recipient email required when using)
+      field :fixed_marketplace_fee,         :class  => Support::Amount
+      field :variable_marketplace_fee
+      field :recipient_email
+      
+    end
+    
+  end
+end

data/lib/simplepay/services/marketplace.rb

@@ -0,0 +1,89 @@
+module Simplepay
+  module Services
+  
+    ##
+    # The Amazon Simple Pay Marketplace service is used to facilitate payments for others.
+    # Use it to charge a commission fee for brokering the exchange between buyers and sellers.
+    #
+    # Note that sellers must accept your marketplace fee policy before the payment buttons
+    # for their products can be generated. This can be accomplished using the +MarketplacePolicy+
+    # service with the form helper (see examples).
+    # 
+    # === Simple Pay Marketplace Fields
+    # 
+    # ==== Required Fields
+    # 
+    # The following attributes are required when creating a Simple Pay 
+    # Marketplace form (in addition to those listed in +Simplepay::Service+):
+    # 
+    # amount:: The dollar value you'd like to collect.
+    # description:: A summary of the reason for the payment, this is displayed to your customer during checkout.
+    # recipient_email:: The e-mail address of the seller (important and must be correct).
+    # fixed_marketplace_fee:: The fixed marketplace fee to add to each transaction.
+    # variable_marketplace_fee:: The variable percentage fee to add to each transaction.
+    # 
+    # ==== Optional Fields
+    # 
+    # abandon_url:: The fully-qualified URL to send your custom if they cancel during payment.
+    # cobranding_style:: Defines the type of cobranding to use during the checkout process.
+    # collect_shipping_address:: Tells Amazon whether or not to ask for shipping address and contact information.
+    # immediate_return:: Immediately returns the customer to your +return_url+ directly after payment.
+    # ipn_url:: Fully-qualified URL to which Amazon will POST instant payment notifications.
+    # process_immediately:: Instructs Amazon to immediately process the payment.
+    # reference_id:: A custom string your can set to identify this transaction, it will be returned with the IPNs and other returned data.
+    # return_url:: Fully-qualified URL for where to send your customer following payment.
+    # 
+    # === Example
+    # 
+    #     (in your view, sellers need to accept the marketplace fee policy using the form helper)
+    #
+    #     <%= simplepay_form_for(:marketplace_policy, {
+    #       :max_fixed_fee    => 10.00,
+    #       :max_variable_fee => 5,
+    #       :return_url       => 'http://yourservice.com'
+    #     }) %>
+    #
+    #     (in your view, payment form generated for end users using the form helper)
+    #     
+    #     <%= simplepay_form_for(:standard, {
+    #       :amount                   => 34.95,
+    #       :description              => "Mutual profit!",
+    #       :recipient_email          => 'seller@gmail.com',
+    #       :fixed_marketplace_fee    => 10.00,
+    #       :variable_marketplace_fee => 5
+    #     }) %>
+    # 
+    class Marketplace < Service
+      
+      required_field :access_key
+      required_field :signature
+      required_field :account_id,               :as     => :amazon_payments_account_id
+      required_field :signature_method, :value => 'HmacSHA256'
+      required_field :signature_version, :value => '2'
+      
+      
+      required_field :description
+      required_field :amount,                   :class  => Support::Amount
+      required_field :fixed_marketplace_fee,    :class  => Support::Amount
+      required_field :variable_marketplace_fee
+      required_field :cobranding_style,         :value  => 'logo'
+      required_field :recipient_email
+      
+      field :reference_id
+      field :immediate_return,                  :class  => Support::Boolean
+      field :collect_shipping_address,          :class  => Support::Boolean
+      field :process_immediately,               :class  => Support::Boolean,
+                                                :as     => :process_immediate
+
+      field :return_url
+      field :ipn_url
+      field :abandon_url
+      
+      # These fields are not currently utilized by the service
+      field :donation_widget,               :as     => :is_donation_widget,
+                                            :value  => '0'
+      
+    end
+    
+  end
+end

data/lib/simplepay/services/marketplace_policy.rb

@@ -0,0 +1,54 @@
+module Simplepay
+  module Services
+  
+    ##
+    # The Amazon Simple Pay Marketplace Policy service is used to allow sellers to acknowledge marketplace policy fees.
+    # Only once a set policy has been agreed to will marketplace transactions be able to proceed.
+    #
+    # === Simple Pay Marketplace Policy Fields
+    # 
+    # ==== Required Fields
+    # 
+    # The following attributes are required when creating a Simple Pay Marketplace policy fee acceptance form
+    # (in addition to those listed in +Simplepay::Service+):
+    # 
+    # max_fixed_fee:: The maximum fixed fee that will be appended to transactions.
+    # max_variable_fee:: The maximum variable fee (%) that will be calculated and added to transactions.
+    # return_url:: Fully-qualified URL for where to send they buyer following payment.
+    # reference_id:: A custom string used to identify this transaction, it will be returned with return data.
+    #
+    # === Example
+    # 
+    #     (in your view, using the form helper)
+    #
+    #     <%= simplepay_form_for(:marketplace_policy, {
+    #       :max_fixed_fee => 10.00,
+    #       :max_variable_fee => 5,
+    #       :return_url => 'http://yourservice.com',
+    #       :reference_id => '123456789'
+    #     }) %>
+    #
+    class MarketplacePolicy < Service
+      
+      required_field :access_key, :as => :caller_key
+      required_field :signature,  :as => :aws_signature
+      required_field :account_id, :as => :caller_account_id
+      required_field :signature_method, :value => 'HmacSHA256'
+      required_field :signature_version, :value => '2'
+      
+      
+      required_field :max_fixed_fee
+      required_field :max_variable_fee
+      required_field :return_url
+
+      required_field :reference_id,          :as => :caller_reference
+      required_field :collect_email_address, :value => 'True'
+      required_field :pipeline_name,         :value => 'Recipient'
+
+      # These fields are not currently utilized by the service
+      required_field :recipient_pays_fee,    :value => 'True'
+      
+    end
+    
+  end
+end

data/lib/simplepay/services/standard.rb

@@ -0,0 +1,58 @@
+module Simplepay
+  module Services
+  
+    ##
+    # The Amazon Simple Pay Standard service is used for one-time payments.
+    # 
+    # === Simple Pay Standard Fields
+    # 
+    # ==== Required Fields
+    # 
+    # The following attributes are required when creating a Simple Pay 
+    # Standard form (in addition to those listed in +Simplepay::Service+):
+    # 
+    # amount:: The dollar value you'd like to collect.
+    # description:: A summary of the reason for the payment, this is displayed to your customer during checkout.
+    # 
+    # ==== Optional Fields
+    # 
+    # abandon_url:: The fully-qualified URL to send your custom if they cancel during payment.
+    # cobranding_style:: Defines the type of cobranding to use during the checkout process.
+    # collect_shipping_address:: Tells Amazon whether or not to ask for shipping address and contact information.
+    # immediate_return:: Immediately returns the customer to your +return_url+ directly after payment.
+    # ipn_url:: Fully-qualified URL to which Amazon will POST instant payment notifications.
+    # process_immediately:: Instructs Amazon to immediately process the payment.
+    # reference_id:: A custom string your can set to identify this transaction, it will be returned with the IPNs and other returned data.
+    # return_url:: Fully-qualified URL for where to send your customer following payment.
+    # 
+    # === Example
+    # 
+    #     (in your view, using the form helper)
+    #     
+    #     <%= simplepay_form_for(:standard, {
+    #       :amount       => 34.95,
+    #       :description  => "I want my money NOW!"
+    #     }) %>
+    # 
+    class Standard < Service
+
+      required_field :access_key
+      required_field :amount
+      required_field :description
+      required_field :signature
+      required_field :signature_method, :value => 'HmacSHA256'
+      required_field :signature_version, :value => '2'
+
+      field :abandon_url
+      field :cobranding_style, :value => 'logo'
+      field :collect_shipping_address, :class => Support::Boolean
+      field :immediate_return, :class => Support::Boolean
+      field :ipn_url
+      field :process_immediate, :class => Support::Boolean
+      field :reference_id
+      field :return_url
+
+    end
+
+  end
+end