simplepay 0.1.1 → 0.2.0

data/History.txt

@@ -1,3 +1,10 @@
+== 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.

data/README.rdoc

@@ -12,11 +12,11 @@ Supports the following Amazon Simple Pay services:
 
 * Standard
 * Subscription
+* Marketplace
 
 The following services are coming someday (hopefully soon):
 
 * Donation
-* Marketplace
 
 == SYNOPSIS:
 
@@ -59,6 +59,41 @@ optional.  This is done like so:
       :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>.
@@ -92,4 +127,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/simplepay.rb

@@ -5,7 +5,7 @@ require 'active_support'
 
 module Simplepay
   
-  VERSION = '0.1.1' unless const_defined?(:VERSION)
+  VERSION = '0.2.0' unless const_defined?(:VERSION)
 
   mattr_accessor :aws_access_key_id
   mattr_accessor :aws_secret_access_key

data/lib/simplepay/constants.rb

@@ -31,6 +31,7 @@ module Simplepay
     Successful  = [PaymentSuccessful, SubscriptionSuccessful]
     Failure     = [Abandoned, HtmlError, PaymentFailed, SystemError, SubscriptionFailed]
     Pending     = [PaymentInitiated, PaymentReserved]
+    All         = [Successful, Failure, Pending].flatten
   end
   
   module Currency

data/lib/simplepay/helpers/rails_helper.rb

@@ -4,7 +4,7 @@ module Simplepay
   module Helpers
     
     ##
-    # Adds helpers to your views for generating the correct HTML FORMs and 
+    # Adds helpers to your views for generating the correct HTML forms and 
     # valid signatures.
     # 
     module RailsHelper
@@ -20,9 +20,9 @@ module Simplepay
       # 
       #     <%= simplepay_form_for(:service_name, {:attr => 'foo'}) %>
       # 
-      def simplepay_form_for(service_name, attributes = {})
+      def simplepay_form_for(service_name, attributes = {}, submit_tag = nil)
         service = get_simplepay_service(service_name)
-        service.form(attributes)
+        service.form(attributes, submit_tag)
       end
       
       

data/lib/simplepay/service.rb

@@ -4,6 +4,14 @@ 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.
@@ -120,3 +128,5 @@ end
 
 require 'simplepay/services/subscription'
 require 'simplepay/services/standard'
+require 'simplepay/services/marketplace'
+require 'simplepay/services/marketplace_policy'

data/lib/simplepay/services/standard.rb

@@ -4,6 +4,36 @@ module Simplepay
     ##
     # 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

data/lib/simplepay/services/subscription.rb

@@ -6,11 +6,46 @@ module Simplepay
     # charged every interval (Simplepay::Support::BillingFrequency) until
     # a limiting period (Simplepay::Support::SubscriptionPeriod) is met.
     # 
-    # For example, you may charge your customer:
+    # With this type of payment, for example, you may charge your customer:
     # 
     #     $10.00 every 3 days until 9 days.
     #     $9.95 every 1 month until forever.
     # 
+    # === Simple Pay Subscription Fields
+    # 
+    # === Required Fields
+    # 
+    # The following attributes are required when creating a Simple Pay 
+    # Subscription 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.
+    # recurring_frequency:: Defines how often to charge your customer (ex. "1 month")
+    # 
+    # ==== Optional Fields
+    # 
+    # abandon_url:: The fully-qualified URL to send your custom if they cancel during payment.
+    # auto_renew:: Instructs Amazon to automatically renew the subscription after the +subscription_period+ ends.
+    # 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.
+    # start_date:: Instructs Amazon with the timestamp to start the recurring subscription charges.
+    # subscription_period:: Defines the expiration window of the subscription (i.e. charge +amount+ every +recurring_frequency+ for "36 months")
+    # 
+    # === Example
+    # 
+    #     (in your view, using the form helper)
+    #     
+    #     <%= simplepay_form_for(:subscription, {
+    #           :amount               => 12.95,
+    #           :recurring_frequency  => "1 year",
+    #           :description          => "My.Url Yearly Dues"
+    #     }) %>
+    # 
     class Subscription < Service
       
       required_field :access_key

data/simplepay.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplepay}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathaniel E. Bibler"]

data/test/simplepay/services/test_marketplace.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+require 'simplepay/services/marketplace'
+
+class Simplepay::Services::TestMarketplace < Test::Unit::TestCase
+  
+  def self.model_class; Simplepay::Services::Marketplace; end
+  
+  context 'Simplepay::Services::Marketplace' do
+    
+    should_have_service_field :access_key,
+                              :as       => 'accessKey', 
+                              :required => true
+
+    should_have_service_field :signature,
+                              :as       => 'signature', 
+                              :required => true
+
+    should_have_service_field :account_id,
+                              :as       => 'amazonPaymentsAccountId', 
+                              :required => true
+
+    should_have_service_field :description,
+                              :as       => 'description', 
+                              :required => true
+
+    should_have_service_field :amount,
+                              :as       => 'amount', 
+                              :required => true,
+                              :class    => Simplepay::Support::Amount
+
+    should_have_service_field :recipient_email,
+                              :as       => 'recipientEmail',
+                              :required => true
+
+    should_have_service_field :fixed_marketplace_fee,
+                              :as       => 'fixedMarketplaceFee',
+                              :required => true,
+                              :class    => Simplepay::Support::Amount
+
+    should_have_service_field :variable_marketplace_fee,
+                              :as       => 'variableMarketplaceFee',
+                              :required => true
+
+    should_have_service_field :cobranding_style,
+                              :as       => 'cobrandingStyle', 
+                              :required => true
+
+    should_have_service_field :reference_id,
+                              :as       => 'referenceId', 
+                              :required => false
+
+    should_have_service_field :immediate_return,
+                              :as       => 'immediateReturn', 
+                              :required => false,
+                              :class    => Simplepay::Support::Boolean
+
+    should_have_service_field :collect_shipping_address,
+                              :as       => 'collectShippingAddress', 
+                              :required => false,
+                              :class    => Simplepay::Support::Boolean
+
+    should_have_service_field :process_immediately,
+                              :as       => 'processImmediate', 
+                              :required => false,
+                              :class    => Simplepay::Support::Boolean
+
+    should_have_service_field :return_url,
+                              :as       => 'returnUrl', 
+                              :required => false
+
+    should_have_service_field :abandon_url,
+                              :as       => 'abandonUrl', 
+                              :required => false
+
+    should_have_service_field :ipn_url,
+                              :as       => 'ipnUrl', 
+                              :required => false
+
+    should_have_service_field :donation_widget,
+                              :as       => 'isDonationWidget', 
+                              :required => false
+
+  end
+  
+end

data/test/simplepay/services/test_marketplace_policy.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+require 'simplepay/services/marketplace_policy'
+
+class Simplepay::Services::TestMarketplacePolicy < Test::Unit::TestCase
+  
+  def self.model_class; Simplepay::Services::MarketplacePolicy; end
+  
+  context 'Simplepay::Services::MarketplacePolicy' do
+    
+    should_have_service_field :access_key,
+                              :as       => 'callerKey', 
+                              :required => true
+
+    should_have_service_field :signature,
+                              :as       => 'awsSignature', 
+                              :required => true
+
+    should_have_service_field :account_id,
+                              :as       => 'callerAccountId', 
+                              :required => true
+
+    should_have_service_field :max_fixed_fee,
+                              :as       => 'maxFixedFee', 
+                              :required => true
+
+    should_have_service_field :max_variable_fee,
+                              :as       => 'maxVariableFee', 
+                              :required => true
+
+    should_have_service_field :return_url,
+                              :as       => 'returnUrl', 
+                              :required => true
+
+    should_have_service_field :recipient_pays_fee,
+                              :as       => 'recipientPaysFee',
+                              :required => true
+
+    should_have_service_field :reference_id,
+                              :as       => 'callerReference',
+                              :required => true
+
+    should_have_service_field :collect_email_address,
+                              :as       => 'collectEmailAddress', 
+                              :required => true
+
+    should_have_service_field :pipeline_name,
+                              :as       => 'pipelineName', 
+                              :required => true
+
+  end
+  
+end

data/test/simplepay/services/test_standard.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/../../test_helper'
 require 'simplepay/services/subscription'
 
-class Simplepay::Services::TestSubscription < Test::Unit::TestCase
+class Simplepay::Services::TestStandard < Test::Unit::TestCase
   
   def self.model_class; Simplepay::Services::Standard; end
   
-  context 'Simplepay::Services::Subscription' do
+  context 'Simplepay::Services::Standard' do
     
     should_have_service_field :access_key,
                               :as       => 'accessKey', 
@@ -77,4 +77,4 @@ class Simplepay::Services::TestSubscription < Test::Unit::TestCase
 
   end
   
-end
+end

data/test/simplepay/test_service.rb

@@ -64,12 +64,12 @@ class Simplepay::TestService < Test::Unit::TestCase
     
     should 'generate an HTML FORM' do
       @service.required = 'set'
-      assert_match /\A<form/i, @service.form
-      assert_match /<\/form>\Z/i, @service.form
+      assert_match(/\A<form/i, @service.form)
+      assert_match(/<\/form>\Z/i, @service.form)
     end
     
     should 'post the form to the endpoint' do
-      assert_match /<form action="#{Regexp.escape('http://test.host.url/sandbox')}" method="post"/, @service.form({:required => 'set'})
+      assert_match(/<form action="#{Regexp.escape('http://test.host.url/sandbox')}" method="post"/, @service.form({:required => 'set'}))
     end
     
     should 'generate HIDDEN HTML INPUTs for each non-empty field' do
@@ -115,4 +115,4 @@ class Simplepay::TestService < Test::Unit::TestCase
     
   end
   
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplepay
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nathaniel E. Bibler
@@ -30,7 +30,7 @@ cert_chain:
   DXxToz6dXyCgpN1XYMMB+A==
   -----END CERTIFICATE-----
 
-date: 2008-12-11 00:00:00 -05:00
+date: 2009-01-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -146,6 +146,8 @@ specification_version: 2
 summary: This gem provides a Rails interface to the Amazon Simple Pay payment service.
 test_files: 
 - test/simplepay/helpers/test_notifier.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