simplepay-rails4 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e42f97931af0e65beccc52d2d544f2cbf8c2815d
+  data.tar.gz: bdea7625587ce52b6f579e1b65fe82d888352d17
+SHA512:
+  metadata.gz: 391e3464befaf62006b0adcbc4f81e31738cc45b1db0ad4737654d09cdc10ee0242b78c6426ec8c3f5886533acc2801cdeb8c112c18e885ebf72c5998b3d235f
+  data.tar.gz: f8d320f3c25251a44a33fca8b5dfe6eb36d58154a7d623a55a434be7cf16347528392edce8b89b1b98f2466033c260fe5dd4a7825fe7f08de07d125ddc4816e1

data/.gitignore

@@ -0,0 +1,8 @@
+.rvmrc
+.DS_Store
+*~
+coverage
+doc
+pkg
+.ruby-version
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+== 0.4.0 2014-07-05
+
+* Stripping gem to bare essentials
+
+== 0.2.3 2011-2-10
+
+* Supports Amazon Signature Version 2
+* Updated for Rails 3
+
+== 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/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rails", "~> 4.1.0"
+gem 'rake'
+gem 'minitest-spec-rails'
+gem "mocha"

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    simplepay-rails4 (0.4.0)
+      nokogiri (~> 1.6)
+      rails (~> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.4)
+      actionpack (= 4.1.4)
+      actionview (= 4.1.4)
+      mail (~> 2.5.4)
+    actionpack (4.1.4)
+      actionview (= 4.1.4)
+      activesupport (= 4.1.4)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+    activerecord (4.1.4)
+      activemodel (= 4.1.4)
+      activesupport (= 4.1.4)
+      arel (~> 5.0.0)
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.4)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    minitest (5.3.5)
+    minitest-spec-rails (5.0.4)
+      minitest (~> 5.0)
+      rails (~> 4.1.0.rc2)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.4)
+      actionmailer (= 4.1.4)
+      actionpack (= 4.1.4)
+      actionview (= 4.1.4)
+      activemodel (= 4.1.4)
+      activerecord (= 4.1.4)
+      activesupport (= 4.1.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.4)
+      sprockets-rails (~> 2.0)
+    railties (4.1.4)
+      actionpack (= 4.1.4)
+      activesupport (= 4.1.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest-spec-rails
+  mocha
+  rails (~> 4.1.0)
+  rake
+  simplepay-rails4!

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Nathaniel E. Bibler
+Copyright (c) 2011 Derrick Parkhurst
+Copyright (c) 2014 Charles DuBose
+
+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
+NONINFRINGEMENT. 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/README.md

@@ -0,0 +1,106 @@
+= simplepay (Rails Amazon Simple Pay Interface)
+
+== DESCRIPTION:
+
+This gem provides a Rails 4 interface to the Amazon Simple Pay payment service.
+
+== FEATURES/PROBLEMS:
+
+Supports the following Amazon Simple Pay services:
+
+* Standard
+* Subscription
+* Marketplace
+* Donation
+
+== SYNOPSIS:
+
+Add simplepay to your Bundler Gemfile
+
+    (in Gemfile)
+    
+    gem "simplepay-rails4", :require => 'simplepay'
+
+Configure the gem with your Amazon Web Services credentials:
+
+    (in config/initializers/simplepay.rb)
+    
+    Simplepay.aws_access_key_id     = 'MYAMAZONACCESSKEYID'
+    Simplepay.aws_secret_access_key = 'MYAMAZONSECRETACCESSKEY'
+
+=== Obtaining Amazon Web Services Credentials
+    
+1) Create an Amazon Payments Personal Account
+    https://payments.amazon.com/sdui/sdui/basicaccount
+    or on Sandbox:
+    https://payments-sandbox.amazon.com/sdui/sdui/basicaccount
+
+2) Create an Amazon Payments Business Account
+    https://payments.amazon.com/sdui/sdui/premiumaccount
+    or in the sandbox for testing 
+    https://payments-sandbox.amazon.com/sdui/sdui/premiumaccount
+    
+3)  Create an Amazon Web Services Account  
+    https://aws-portal.amazon.com/gp/aws/developer/registration/index.html
+
+4)  Retrieve the Access Key ID and Secret Access Key
+    https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8&action=access-key
+
+Note that the AWS Access Key ID and Secret Access Key is good for both testing in the sandbox and for production use.
+
+=== 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
+    }) %>
+      
+== INSTALL:
+
+    sudo gem install simplepay-rails4
+

data/Rakefile

@@ -0,0 +1,13 @@
+%w[rubygems rake rake/clean rake/testtask fileutils].each { |f| require f }
+#require File.dirname(__FILE__) + '/lib/simplepay'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/test_*.rb'
+  t.libs << 'app'
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.verbose = true
+end
+
+task :default => [:test]
+#task :release_and_update => [:gemspec, :release, :website, :post_news]

data/app/helpers/rails_helper.rb

@@ -0,0 +1,38 @@
+module Simplepay
+  module Rails
+    
+    ##
+    # Adds helpers to your views for generating the correct HTML forms and 
+    # valid signatures.
+    # 
+    module SimplepayHelper
+      
+      ##
+      # 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).html_safe
+      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/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.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,31 @@
+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)
+        tag = "<#{name}#{tag_options(options)}>#{content}</#{name}>"
+        tag = tag.html_safe if tag.respond_to?(:html_safe)
+        tag
+      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/rails.rb

@@ -0,0 +1,2 @@
+
+

data/lib/simplepay/service.rb

@@ -0,0 +1,133 @@
+require 'simplepay/helpers/form_helper'
+
+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).
+  # 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=)
+    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'