harleytt-simplepay 0.2.2

data/History.txt

@@ -0,0 +1,25 @@
+== 0.2.2 2009-06-07
+
+* Added Donation service support.
+
+== 0.2.1 2009-01-06
+
+* Maintenance release for missing files.
+
+== 0.2.0 2009-01-03
+
+* Added Marketplace Service support [Nick Plante (zapnap)]
+* Added Standard and Subscription documentation.
+* Added a submit tag override to simplepay_form_for helper.
+* Added a Simplepay::ResponseStatusCode::All shortcut.
+
+== 0.1.1 2008-12-11
+
+* Added a NotificationHelper to aid with Amazon IPN validation.
+* Updated the Rails helper and added more detailed documentation.
+
+== 0.1.0 2008-12-05
+
+* Initial release
+* Supports Amazon Simple Pay Standard and the-soon-to-be-released Subscriptions
+* Generates your dynamic service HTML forms automatically.

data/Manifest.txt

@@ -0,0 +1,50 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/simplepay.rb
+lib/simplepay/authentication.rb
+lib/simplepay/constants.rb
+lib/simplepay/errors.rb
+lib/simplepay/helpers/form_helper.rb
+lib/simplepay/helpers/notification_helper.rb
+lib/simplepay/helpers/rails_helper.rb
+lib/simplepay/rails.rb
+lib/simplepay/service.rb
+lib/simplepay/services/donation.rb
+lib/simplepay/services/marketplace.rb
+lib/simplepay/services/marketplace_policy.rb
+lib/simplepay/services/standard.rb
+lib/simplepay/services/subscription.rb
+lib/simplepay/support.rb
+lib/simplepay/support/amount.rb
+lib/simplepay/support/billing_frequency.rb
+lib/simplepay/support/boolean.rb
+lib/simplepay/support/currency.rb
+lib/simplepay/support/epoch.rb
+lib/simplepay/support/field.rb
+lib/simplepay/support/interval.rb
+lib/simplepay/support/simple_amount.rb
+lib/simplepay/support/subscription_period.rb
+script/console
+script/destroy
+script/generate
+simplepay.gemspec
+test/simplepay/helpers/test_notifier.rb
+test/simplepay/services/test_donation.rb
+test/simplepay/services/test_marketplace.rb
+test/simplepay/services/test_marketplace_policy.rb
+test/simplepay/services/test_standard.rb
+test/simplepay/services/test_subscription.rb
+test/simplepay/support/test_amount.rb
+test/simplepay/support/test_billing_frequency.rb
+test/simplepay/support/test_boolean.rb
+test/simplepay/support/test_epoch.rb
+test/simplepay/support/test_field.rb
+test/simplepay/support/test_interval.rb
+test/simplepay/support/test_simple_amount.rb
+test/simplepay/support/test_subscription_period.rb
+test/simplepay/test_authentication.rb
+test/simplepay/test_service.rb
+test/test_helper.rb
+test/test_simplepay.rb

data/README.rdoc

@@ -0,0 +1,127 @@
+= simplepay (Rails Amazon Simple Pay Interface)
+
+http://simplepay.rubyforge.org
+
+== DESCRIPTION:
+
+This gem provides a Rails interface to the Amazon Simple Pay payment service.
+
+== FEATURES/PROBLEMS:
+
+Supports the following Amazon Simple Pay services:
+
+* Standard
+* Subscription
+* Marketplace
+* Donation
+
+== SYNOPSIS:
+
+Set up the gem requirement in your environment:
+
+    (in config/environment.rb)
+    
+    config.gem "simplepay"
+
+Configure the gem with your Amazon credentials:
+
+    (in config/initializers/simplepay.rb)
+    
+    Simplepay.aws_access_key_id     = 'MYAMAZONACCESSKEYID'
+    Simplepay.aws_secret_access_key = 'MYAMAZONSECRETACCESSKEY'
+    Simplepay.account_id            = 'ACCOUNTIDFORAMAZONPAYMENTS'
+
+Then, let Rails know about the Simplepay::Helpers:
+
+    (potentially in app/controllers/application[_controller].rb or really anywhere else)
+    
+    require 'simplepay/rails'
+
+
+=== Generating your Simple Pay forms
+
+Generally, this library will then be used directly from one (or more) of your 
+views.  Depending on the type of Simple Pay service you're using (see 
+Simplepay::Services), some form values will be required, while others may be 
+optional.  This is done like so:
+
+    <%= simplepay_form_for(:standard, {
+      :amount       => 10.95,
+      :description  => "Profit!"
+    }) %>
+    
+    <%= simplepay_form_for(:subscription, {
+      :amount                 => 10.95,
+      :description            => "MORE Profit!",
+      :recurring_frequency    => "1 month"
+    }) %>
+
+
+=== Marketplace forms
+
+Amazon Simple Pay Marketplace makes it easy to facilitate payments between
+buyers and sellers, and to charge a fee for the transaction. If you're building
+a marketplace application, your sellers must first agree to the policy that you
+set. You can do this by specifying the Simplepay::Services::MarketplacePolicy
+service:
+
+    <%= simplepay_form_for(:marketplace_policy, {
+      :max_fixed_fee => 5.00,
+      :max_variable_fee => 5,
+      :return_url => 'http://yourservice.com',
+      :reference_id => '1234567890'
+    }) %>
+
+The user will be prompted to login to their Amazon account and accept the policy
+you propose. After they complete the process, they'll be returned to the return_url
+specified. Amazon will also provide a recipientEmail parameter that will contain
+the seller email here (you may want to craft your return url so that it contains the
+reference_id value and use this to 'acknowledge' a sellers consent and record their
+Amazon recipient email address).
+
+Only once this is done will you be able to offer marketplace checkout options for
+that sellers items:
+
+    <%= simplepay_form_for(:marketplace, {
+      :amount                   => 34.95,
+      :description              => "Mutual profit!",
+      :recipient_email          => 'seller@gmail.com',
+      :fixed_marketplace_fee    => 10.00,
+      :variable_marketplace_fee => 5
+    }) %>
+
+
+== REQUIREMENTS:
+
+1. You must have an Amazon Payments <b>business account</b>.
+2. You must know your Amazon Payments <b>account identifier</b> [instructions to come]
+3. You must know your Amazon Web Services <b>access key</b> and <b>secret access key</b>.
+
+== INSTALL:
+
+    sudo gem install simplepay
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Nathaniel E. Bibler
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+%w[rubygems rake rake/clean fileutils hoe newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/simplepay'
+
+$hoe = Hoe.new('simplepay', Simplepay::VERSION) do |p|
+  p.developer('Nathaniel E. Bibler', 'gem@nathanielbibler.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name
+  p.extra_deps         = [
+    ['activesupport','~> 2.3.9']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = ''
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:test]
+task :release_and_update => [:gemspec, :release, :website, :post_news]

data/lib/simplepay.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_support'
+
+module Simplepay
+  
+  VERSION = '0.2.2' unless const_defined?(:VERSION)
+
+  mattr_accessor :aws_access_key_id
+  mattr_accessor :aws_secret_access_key
+  mattr_accessor :account_id
+
+  mattr_accessor :use_sandbox
+  @@use_sandbox = true
+
+  def self.use_sandbox?
+    @@use_sandbox
+  end
+
+end
+
+require 'simplepay/constants'
+require 'simplepay/support'
+require 'simplepay/authentication'
+require 'simplepay/service'
+require 'simplepay/helpers/form_helper'

data/lib/simplepay/authentication.rb

@@ -0,0 +1,41 @@
+require 'openssl'
+require 'base64'
+require 'uri'
+require 'cgi'
+
+module Simplepay
+
+  class Signature
+
+    def initialize(uri, params, secret_key = Simplepay.aws_secret_access_key)
+      @uri = uri
+      @params = params
+      @secret_key = secret_key
+    end
+
+    def sign
+      make_canonical_string
+      compute_signature
+    end
+
+    private
+
+    def compute_signature
+      digest = OpenSSL::Digest::Digest.new('sha256')
+      Base64.encode64(OpenSSL::HMAC.digest(digest, @secret_key, @canonical)).chomp
+    end
+
+    def make_canonical_string
+      @canonical = "POST\n#{@uri.host}\n#{@uri.path}\n"
+      params = @params.reject{|k,v| v.blank? }.inject({}) { |a, (k,v)| a[k.to_s] = v; a }
+      params = params.sort.inject([]) { |a, v| a << urlencode(v[0]) + '=' + urlencode(v[1]) }.join('&')
+      @canonical += params
+    end
+
+    def urlencode(plaintext)
+      CGI.escape(plaintext.to_s).gsub('+', '%20').gsub('%7E', '~')
+    end
+
+  end
+
+end

data/lib/simplepay/constants.rb

@@ -0,0 +1,64 @@
+require 'simplepay/errors'
+require 'simplepay/support/currency'
+
+module Simplepay
+  
+  module Boolean
+    True  = '1'
+    False = '0'
+  end
+  
+  module Interval
+    Day   = 'day'
+    Week  = 'week'
+    Month = 'month'
+    Year  = 'year'
+  end
+  
+  Intervals = [Interval::Day, Interval::Week, Interval::Month, Interval::Year]
+
+  ##
+  # Amazon Status Codes (FPS Basic)
+  #  SA  Success status for the ABT payment method.
+  #  SB  Success status for the ACH (bank account) payment method.
+  #  SC  Success status for the credit card payment method.
+  #  SE  System error.
+  #  A   Buyer abandoned the pipeline.
+  #  CE  Specifies a caller exception.
+  #  PE  Payment Method Mismatch Error: Specifies that the buyer does not have the payment method you requested.
+  #  NP  This account type does not support the specified payment method.
+  #  NM  You are not registered as a third-party caller to make this transaction. Contact Amazon Payments for more information.
+  #
+  module ResponseStatusCode
+    SuccessfulABT             = 'SA'
+    SuccessfulACH             = 'SB'
+    SuccessfulCC              = 'SC'
+    Abandoned                 = 'A'
+    CallerException           = 'CE'
+    PaymentMismatch           = 'PE'
+    NotSupported              = 'NP'
+    NotRegistered             = 'NM'
+    
+    # These haven't been verified so I'll leave them in for the time being
+    HtmlError                 = 'ME'
+    PaymentFailed             = 'PF'
+    PaymentInitiated          = 'PI'
+    PaymentReserved           = 'PR'
+    PaymentSuccessful         = 'PS'
+    SystemError               = 'SE'
+    SubscriptionFailed        = 'SF'
+    SubscriptionSuccessful    = 'SS'
+    
+    Successful  = [SuccessfulABT, SuccessfulACH, SuccessfulCC, PaymentSuccessful, SubscriptionSuccessful]
+    Failure     = [Abandoned, CallerException, PaymentMismatch, NotSupported, NotRegistered, HtmlError, PaymentFailed, SystemError, SubscriptionFailed]
+    Pending     = [PaymentInitiated, PaymentReserved]
+    All         = [Successful, Failure, Pending].flatten
+  end
+  
+  module Currency
+    USD   = Support::Currency.new('United States Dollar', 'USD', "%0.2f")
+  end
+  
+  Currencies = [Currency::USD]
+  
+end

data/lib/simplepay/errors.rb

@@ -0,0 +1,16 @@
+module Simplepay
+  
+  ##
+  # All SimplePay errors will inherit from the base Simplepay::Error.
+  # 
+  class Error < RuntimeError; end
+  
+  #:stopdoc:
+  
+  class RequiredFieldMissing < Error; end
+  class InvalidOptions < Error; end
+  class ParseError < Error; end
+  
+  #:startdoc:
+  
+end

data/lib/simplepay/helpers/form_helper.rb

@@ -0,0 +1,29 @@
+module Simplepay
+  module Helpers
+    
+    module FormHelper
+      
+      def self.tag(name, options = nil, open = false)
+        "<#{name}#{tag_options(options) if options}" + (open ? ">" : " />")
+      end
+      
+      def self.content_tag(name, content, options = nil)
+        "<#{name}#{tag_options(options)}>#{content}</#{name}>"
+      end
+      
+      
+      private
+      
+      
+      def self.tag_options(options)
+        unless options.blank?
+          attrs = []
+          attrs = options.map { |key, value| %(#{key}="#{value}") }
+          " #{attrs.sort * ' '}" unless attrs.empty?
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/simplepay/helpers/notification_helper.rb

@@ -0,0 +1,54 @@
+require 'cgi'
+require 'open-uri'
+
+module Simplepay
+  module Helpers
+    
+    ##
+    # Adds a +valid_simplepay_request?+ method to your ActionControllers.
+    # 
+    # In order to use this, you should just directly hand your +params+ into
+    # the method:
+    # 
+    #     class FooController < ApplicationController
+    #     
+    #       def receive_ipn
+    #         if valid_simplepay_request?(params)
+    #           ... record something useful ...
+    #         else
+    #           ... maybe log a bad request? ...
+    #         end
+    #       end
+    #     
+    #     end
+    # 
+    module NotificationHelper
+      
+      protected
+      
+      
+      ##
+      # Authenticates the incoming request by validating the +signature+ 
+      # provided.
+      # 
+      #     (from within your controller)
+      #     def receive_ipn
+      #       if valid_simplepay_request?(params)
+      #         ...
+      #       end
+      #     end
+      # 
+      def valid_simplepay_request?(endpoint, query)
+        url = Simplepay.use_sandbox ? 'https://fps.sandbox.amazonaws.com' : 'https://fps.amazonaws.com'
+        endpoint = CGI.escape(endpoint)
+        query = CGI.escape(query)
+
+        url_and_query = url + "/?Action=VerifySignature&Version=2008-09-17&UrlEndPoint=#{endpoint}&HttpParameters=#{query}"
+        result = open(url_and_query) rescue false
+        result.read =~ /Success/ ? true : false
+      end
+
+    end
+
+  end
+end