simplepay 0.1.0

data.tar.gz.sig

@@ -0,0 +1,2 @@
+C�9��l��"�E�>�(Ϳ��=+fp�}t?8�}���Q<��;���(-���tԮ�����S�FxED|��i��9ߓ_;*,�r���=/<��
+x���8�"�.lS�׿����޽����fQ�:����.R-����U���.C�=��H��&�,��G�=���r��J��*�Bs�[���Ot���$�5mI���1�W �@����IL1~�ڗ���+w�~F��rpJ]CP�-T�~�(�?V�7�

data/History.txt

@@ -0,0 +1,5 @@
+== 0.0.1 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,38 @@
+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/rails_helper.rb
+lib/simplepay/service.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/subscription_period.rb
+script/console
+script/destroy
+script/generate
+simplepay.gemspec
+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_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,78 @@
+= 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
+
+The following services are coming someday (hopefully soon):
+
+* Donation
+* Marketplace
+
+== SYNOPSIS:
+
+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'
+
+Generally, this library will then be used directly from one (or more) of your 
+views, 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"
+  }) %>
+
+== 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,24 @@
+%w[rubygems rake rake/clean fileutils 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.0.2']
+  ]
+  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]

data/lib/simplepay.rb

@@ -0,0 +1,26 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_support'
+
+module Simplepay
+  
+  VERSION = '0.1.0' 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/service'
+require 'simplepay/helpers/form_helper'

data/lib/simplepay/authentication.rb

@@ -0,0 +1,69 @@
+require 'openssl'
+require 'base64'
+
+module Simplepay
+  
+  ##
+  # This module generates RFC-2104-compliant HMAC signatures.  These 
+  # signatures are used by both Amazon and you to determine whether or not
+  # data transmitted is authentic.  The hash is based on the amazon secret
+  # access key, which is a trusted secret between both parties.
+  # 
+  # === HMAC (RFC-2104 Specification)
+  # 
+  # For more information about the RFC-2104 spec, 
+  # see http://www.ietf.org/rfc/rfc2104.txt
+  #
+  module Authentication
+    
+    class << self
+      
+      def generate(hash_data, secret_access_key = Simplepay.aws_secret_access_key)
+        encode(digest(convert_to_string(hash_data), secret_access_key))
+      end
+      
+      def authentic?(hash_data, signature, secret_access_key = Simplepay.aws_secret_access_key)
+        signature == generate(hash_data, secret_access_key)
+      end
+      
+      
+      private
+      
+      
+      ##
+      # Converts a Hash of key-value pairs into an Amazon compliant block of
+      # signature text.
+      # 
+      #=== Example
+      # 
+      #     {:key1 => 'Value1', 'foo' => 3 }
+      # 
+      # would become
+      # 
+      #     "foo3key1Value1"
+      # 
+      def convert_to_string(hash)
+        raise(ArgumentError, "Expected a Hash of data") unless hash.kind_of?(Hash)
+        data    = hash.stringify_keys
+        string  = ''
+        data.keys.sort.each { |k| string += "#{k}#{data[k]}" unless data[k].blank? }
+        string
+      end
+      
+      ##
+      # Generate an RFC-2104-compliant HMAC
+      # 
+      def digest(value, secret_access_key)
+        digest = OpenSSL::Digest::Digest.new('sha1')
+        OpenSSL::HMAC.digest(digest, secret_access_key, value)
+      end
+      
+      def encode(value)
+        Base64.encode64(value).chomp
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/simplepay/constants.rb

@@ -0,0 +1,26 @@
+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]
+  
+  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/rails_helper.rb

@@ -0,0 +1,28 @@
+require 'action_view/base'
+
+module Simplepay
+  module Helpers
+    
+    module RailsHelper
+      
+      def simplepay_form_for(service_name, attributes = {})
+        service = get_simplepay_service(service_name)
+        service.form(attributes)
+      end
+      
+      
+      private
+      
+      
+      def get_simplepay_service(name)
+        service = "Simplepay::Services::#{name.to_s.camelize}".constantize
+        service.new
+      end
+      
+    end
+    
+  end
+end
+
+# Inject helper into Rails ActionView.
+ActionView::Base.__send__(:include, Simplepay::Helpers::RailsHelper)

data/lib/simplepay/service.rb

@@ -0,0 +1,122 @@
+module Simplepay
+  
+  ##
+  # This is a base class from which to inherit functionality for all Amazon
+  # Simple Pay services (Subscriptions, Marketplace Buttons, etc.)
+  # 
+  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 = Authentication.generate(fields) if self.respond_to?(:signature=)
+    end
+    
+  end
+  
+end
+
+require 'simplepay/services/subscription'
+require 'simplepay/services/standard'