simplepay 0.1.0 → 0.1.1

data/History.txt

@@ -1,4 +1,9 @@
-== 0.0.1 2008-12-05
+== 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

data/Manifest.txt

@@ -7,7 +7,9 @@ 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/standard.rb
 lib/simplepay/services/subscription.rb
@@ -24,6 +26,8 @@ script/console
 script/destroy
 script/generate
 simplepay.gemspec
+test/simplepay/helpers/test_notifier.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

data/README.rdoc

@@ -20,27 +20,44 @@ The following services are coming someday (hopefully soon):
 
 == 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'
+    (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, 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"
-  }) %>
+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"
+    }) %>
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -22,3 +22,4 @@ 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

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

data/lib/simplepay/constants.rb

@@ -17,6 +17,22 @@ module Simplepay
   
   Intervals = [Interval::Day, Interval::Week, Interval::Month, Interval::Year]
   
+  module ResponseStatusCode
+    Abandoned                 = 'A'
+    HtmlError                 = 'ME'
+    PaymentFailed             = 'PF'
+    PaymentInitiated          = 'PI'
+    PaymentReserved           = 'PR'
+    PaymentSuccessful         = 'PS'
+    SystemError               = 'SE'
+    SubscriptionFailed        = 'SF'
+    SubscriptionSuccessful    = 'SS'
+    
+    Successful  = [PaymentSuccessful, SubscriptionSuccessful]
+    Failure     = [Abandoned, HtmlError, PaymentFailed, SystemError, SubscriptionFailed]
+    Pending     = [PaymentInitiated, PaymentReserved]
+  end
+  
   module Currency
     USD   = Support::Currency.new('United States Dollar', 'USD', "%0.2f")
   end

data/lib/simplepay/helpers/notification_helper.rb

@@ -0,0 +1,49 @@
+require 'simplepay/authentication'
+
+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?(request_hash)
+        hash      = request_hash.symbolize_keys
+        signature = hash.delete(:signature) || ''
+        Simplepay::Authentication.authentic?(hash, signature)
+      end
+      
+    end
+    
+  end
+end

data/lib/simplepay/helpers/rails_helper.rb

@@ -3,8 +3,23 @@ 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 = {})
         service = get_simplepay_service(service_name)
         service.form(attributes)
@@ -14,7 +29,7 @@ module Simplepay
       private
       
       
-      def get_simplepay_service(name)
+      def get_simplepay_service(name) #:nodoc:
         service = "Simplepay::Services::#{name.to_s.camelize}".constantize
         service.new
       end
@@ -23,6 +38,3 @@ module Simplepay
     
   end
 end
-
-# Inject helper into Rails ActionView.
-ActionView::Base.__send__(:include, Simplepay::Helpers::RailsHelper)

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/simplepay.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplepay}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathaniel E. Bibler"]
   s.cert_chain = ["/Users/nathan/.gem/gem-public_cert.pem"]
-  s.date = %q{2008-12-06}
+  s.date = %q{2008-12-11}
   s.description = %q{This gem provides a Rails interface to the Amazon Simple Pay payment service.}
   s.email = ["gem@nathanielbibler.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
-  s.files = ["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", "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"]
+  s.files = ["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/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/helpers/test_notifier.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_subscription_period.rb", "test/simplepay/test_authentication.rb", "test/simplepay/test_service.rb", "test/test_helper.rb", "test/test_simplepay.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://simplepay.rubyforge.org}
   s.rdoc_options = ["--main", "README.rdoc"]
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.1}
   s.signing_key = %q{/Users/nathan/.gem/gem-private_key.pem}
   s.summary = %q{This gem provides a Rails interface to the Amazon Simple Pay payment service.}
-  s.test_files = ["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"]
+  s.test_files = ["test/simplepay/helpers/test_notifier.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_subscription_period.rb", "test/simplepay/test_authentication.rb", "test/simplepay/test_service.rb", "test/test_helper.rb", "test/test_simplepay.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/simplepay/helpers/test_notifier.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+require "simplepay/helpers/notification_helper"
+
+class TestNotificationClass
+  include Simplepay::Helpers::NotificationHelper
+  
+  def testing(request_hash = {})
+    valid_simplepay_request?(request_hash)
+  end
+end
+
+class Simplepay::Helpers::TestNotificationHelper < Test::Unit::TestCase
+  
+  context 'Simplepay::Helpers::NotificationHelper' do
+    
+    setup do
+      @notifier = TestNotificationClass.new
+    end
+    
+    should 'defer to Simplepay::Authentication.authentic?' do
+      Simplepay::Authentication.expects(:authentic?).with({:test => 'testing'}, 'signed').returns(true)
+      assert @notifier.testing({:test => 'testing', :signature => 'signed'})
+    end
+    
+    should 'work with string hash keys' do
+      Simplepay::Authentication.expects(:authentic?).with({:test => 'testing'}, 'signed').returns(true)
+      assert @notifier.testing({"test" => 'testing', "signature" => 'signed'})
+    end
+    
+  end
+  
+end

data/test/simplepay/services/test_standard.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+require 'simplepay/services/subscription'
+
+class Simplepay::Services::TestSubscription < Test::Unit::TestCase
+  
+  def self.model_class; Simplepay::Services::Standard; end
+  
+  context 'Simplepay::Services::Subscription' 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 :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 :variable_marketplace_fee,
+                              :as       => 'variableMarketplaceFee', 
+                              :required => false
+
+    should_have_service_field :fixed_marketplace_fee,
+                              :as       => 'fixedMarketplaceFee', 
+                              :required => false
+
+    should_have_service_field :donation_widget,
+                              :as       => 'isDonationWidget', 
+                              :required => false
+
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplepay
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nathaniel E. Bibler
@@ -30,7 +30,7 @@ cert_chain:
   DXxToz6dXyCgpN1XYMMB+A==
   -----END CERTIFICATE-----
 
-date: 2008-12-06 00:00:00 -05:00
+date: 2008-12-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,7 +84,9 @@ files:
 - 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/standard.rb
 - lib/simplepay/services/subscription.rb
@@ -101,6 +103,8 @@ files:
 - script/destroy
 - script/generate
 - simplepay.gemspec
+- test/simplepay/helpers/test_notifier.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
@@ -141,6 +145,8 @@ signing_key:
 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_standard.rb
 - test/simplepay/services/test_subscription.rb
 - test/simplepay/support/test_amount.rb
 - test/simplepay/support/test_billing_frequency.rb