asp-marketplace 0.1.0

data/History.txt

@@ -0,0 +1,7 @@
+== 0.1.0 2010-1-16
+
+* Initial release
+* Amazon Simple Pay Standard Marketplace Transactions.
+* Derivative Work:
+	* Amazon Simple Pay Gem - git://github.com/nbibler/asp-marketplace.git
+	* Amazon sample code - http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3007&categoryID=299 	

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/asp-marketplace.rb
+lib/asp-marketplace/helpers/form_helper.rb
+lib/asp-marketplace/helpers/notification_helper.rb
+lib/asp-marketplace/helpers/rails_helper.rb
+lib/asp-marketplace/rails.rb
+lib/asp-marketplace/service.rb
+lib/asp-marketplace/Yml.rb
+lib/asp-marketplace/signature_utils.rb
+lib/asp-marketplace/services/marketplace.rb
+lib/asp-marketplace/services/marketplacePolicy.rb
+script/console
+script/destroy
+script/generate
+asp-marketplace.gemspec
+

data/README.rdoc

@@ -0,0 +1,116 @@
+= asp-marketplace (Simple Marketplace Transactions)
+
+== DESCRIPTION:
+
+This gem provides a Rails interface to the Amazon Simple Pay marketplace service.
+
+== SYNOPSIS:
+
+Set up the gem requirement in your environment:
+
+    (in config/environment.rb)
+    
+    config.gem "asp-marketplace"
+
+Configure the gem with your Amazon credentials:
+
+    (in config/initializers/asp-marketplace.rb)
+    
+    asp-marketplace.aws_access_key_id     = 'MYAMAZONACCESSKEYID'
+    asp-marketplace.aws_secret_access_key = 'MYAMAZONSECRETACCESSKEY'
+    asp-marketplace.account_id            = 'ACCOUNTIDFORAMAZONPAYMENTS'
+
+Then, let Rails know about the asp-marketplace::Helpers:
+
+    (potentially in app/controllers/application[_controller].rb or really anywhere else)
+    
+    require 'asp-marketplace/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 
+asp-marketplace::Services), some form values will be required, while others may be 
+optional.  This is done like so:
+
+    <%= asp-marketplace_form_for(:standard, {
+      :amount       => 10.95,
+      :description  => "Profit!"
+    }) %>
+    
+    <%= asp-marketplace_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 asp-marketplace::Services::MarketplacePolicy
+service:
+
+    <%= asp-marketplace_form_for(:marketplacePolicy, {
+      :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:
+
+    <%= asp-marketplace_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 asp-marketplace
+
+== 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 newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/asp-marketplace'
+
+$hoe = Hoe.new('asp-marketplace', asp-marketplace::VERSION) do |p|
+  p.developer('Charlie White', 'charlie@fuidtickets.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]
+task :release_and_update => [:gemspec, :release, :website, :post_news]

data/asp-marketplace.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{asp-marketplace}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Charlie White"]
+  #s.cert_chain = ["/Users/nathan/.gem/gem-public_cert.pem"]
+  s.date = %q{2009-06-07}
+  s.description = %q{Rails ready gem for Marketplace Transactions using Amazon Simple Pay.}
+  s.email = ["charlie@fluidtickets.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "lib/asp-marketplace.rb", "lib/asp-marketplace/helpers/form_helper.rb", "lib/asp-marketplace/helpers/notification_helper.rb", "lib/asp-marketplace/helpers/rails_helper.rb", "lib/asp-marketplace/rails.rb", "lib/asp-marketplace/service.rb", "lib/asp-marketplace/services/marketplace.rb", "lib/asp-marketplace/services/marketplacePolicy.rb", "lib/asp-marketplace/signature_utils.rb", "lib/asp-marketplace/Yml.rb", "script/console", "script/destroy", "script/generate", "asp-marketplace.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://asp-marketplace.rubyforge.org}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{asp-marketplace}
+  s.rubygems_version = %q{1.3.2}
+  #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.}
+  
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])
+      s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+      s.add_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+    s.add_dependency(%q<newgem>, [">= 1.3.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/lib/asp-marketplace.rb

@@ -0,0 +1,28 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_support'
+require 'asp-marketplace/Yml'
+
+module asp-marketplace
+  
+  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
+  
+  Yml.load
+
+  def self.use_sandbox?
+    @@use_sandbox
+  end
+
+end
+
+require 'asp-marketplace/service'
+require 'asp-marketplace/helpers/form_helper'
+

data/lib/asp-marketplace/Yml.rb

@@ -0,0 +1,22 @@
+class Yml
+  
+  require 'yaml'
+  require 'asp-marketplace/service'
+  
+  @@yml_file = "#{RAILS_ROOT}/config/amazon_marketplace.yml"
+  @@yml = YAML::load(File.read(@@yml_file))
+  
+  def self.load
+      asp-marketplace::Service.environment = @@yml['environment']
+      asp-marketplace::Service.access_key =  @@yml['accessKey']
+      asp-marketplace::Service.secret_key =   @@yml['secretKey']
+      asp-marketplace::Service.signature_method =   @@yml['signatureMethod']
+      asp-marketplace::Services::MarketplacePolicy.return_url =   @@yml['marketplace_policy']['returnUrl']
+      asp-marketplace::Services::Marketplace.abandon_url =   @@yml['marketplace']['abandonUrl']
+      asp-marketplace::Services::Marketplace.return_url =    @@yml['marketplace']['returnUrl']
+      asp-marketplace::Services::Marketplace.immediate_return =   @@yml['marketplace']['immediateReturn']
+      asp-marketplace::Services::Marketplace.process_immediate =   @@yml['marketplace']['processImmediate']
+      asp-marketplace::Services::Marketplace.ipn_url =   @@yml['marketplace']['ipnUrl']
+      asp-marketplace::Services::Marketplace.collect_shipping_address =   @@yml['marketplace']['collectShippingAddress']
+   end
+ end

data/lib/asp-marketplace/helpers/form_helper.rb

@@ -0,0 +1,29 @@
+module asp-marketplace
+  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/asp-marketplace/helpers/notification_helper.rb

@@ -0,0 +1,49 @@
+#require 'asp-marketplace/authentication'
+
+module asp-marketplace
+  module Helpers
+    
+    ##
+    # Adds a +valid_asp-marketplace_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_asp-marketplace_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_asp-marketplace_request?(params)
+      #         ...
+      #       end
+      #     end
+      # 
+     def valid_asp-marketplace_request?(request_hash)
+        hash      = request_hash.symbolize_keys
+        signature = hash.delete(:signature) || ''
+        asp-marketplace::SignatureUtils.authentic?(hash, signature)
+      end
+      
+    end
+    
+  end
+end

data/lib/asp-marketplace/helpers/rails_helper.rb

@@ -0,0 +1,44 @@
+require 'action_view/base'
+
+module asp-marketplace
+  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 asp-marketplace::Services for available services and information
+      # specific to each.
+      # 
+      # === Example
+      # 
+      #     (in your view)
+      # 
+      #     <%= asp-marketplace_form_for(:service_name, {:attr => 'foo'}) %>
+      # 
+      def asp-marketplace_form_for(service_name, attributes = {}, submit_tag = nil)
+        service = get_asp-marketplace_service(service_name)
+        service.generate_form(attributes)
+      end
+      
+      def asp-marketplace_url_for(service_name, attributes = {}, submit_tag = nil)
+        service = get_asp-marketplace_service(service_name)
+        service.generate_url(attributes)
+      end
+      
+      
+      private
+      
+      
+      def get_asp-marketplace_service(name) #:nodoc:
+        service = "asp-marketplace::Services::#{name.to_s.camelize}".constantize
+      end
+      
+    end
+    
+  end
+end

data/lib/asp-marketplace/rails.rb

@@ -0,0 +1,9 @@
+require 'asp-marketplace'
+require 'asp-marketplace/helpers/rails_helper'
+require 'asp-marketplace/helpers/notification_helper'
+
+# Inject helper into Rails ActionView.
+ActionView::Base.__send__(:include, asp-marketplace::Helpers::RailsHelper)
+
+# Inject notification helper into ActionController
+ActionController::Base.__send__(:include, asp-marketplace::Helpers::NotificationHelper)

data/lib/asp-marketplace/service.rb

@@ -0,0 +1,156 @@
+module asp-marketplace
+  
+  ##
+  # 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 asp-marketplace.aws_access_key_id).
+  # account_id:: Your Amazon Payments account identifier (automatically filled from asp-marketplace.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
+    
+    require 'uri'
+    
+    class << self
+             attr_accessor   'environment' 
+             attr_accessor   'access_key'
+             attr_accessor  'secret_key'
+             attr_accessor   'signature_method'
+    end
+
+      @@app_name = "ASP"
+      @@ASPhttp_method = "POST"
+      @@CBUIhttp_method = "POST"
+      @@CBUI_REQUEST_URI = "/cobranded-ui/actions/start";
+      @@SANDBOX_END_POINT = "https://authorize.payments-sandbox.amazon.com/pba/paypipeline";
+      @@SANDBOX_IMAGE_LOCATION="https://authorize.payments-sandbox.amazon.com/pba/images/payNowButton.png";
+      @@SANDBOX_MP_IMAGE_LOCATION = "https://authorize.payments-sandbox.amazon.com/pba/images/MarketPlaceFeeWithLogo.png";
+
+      @@PROD_END_POINT = "https://authorize.payments.amazon.com/pba/paypipeline"; 
+      @@PROD_IMAGE_LOCATION="https://authorize.payments.amazon.com/pba/images/payNowButton.png";
+      @@PROD_MP_IMAGE_LOCATION = "https://authorize.payments.amazon.com/pba/images/MarketPlaceFeeWithLogo.png";  
+
+      @@SIGNATURE_KEYNAME = "signature"
+      @@SIGNATURE_METHOD_KEYNAME = "signatureMethod"
+      @@SIGNATURE_VERSION_KEYNAME = "signatureVersion"
+      @@SIGNATURE_VERSION = "2"
+      @@COBRANDING_STYLE = "logo"
+
+      @@HMAC_SHA256_ALGORITHM = "HmacSHA256"
+      @@HMAC_SHA1_ALGORITHM = "HmacSHA1"
+      
+     
+    
+    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 = asp-marketplace.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)
+      asp-marketplace::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 : asp-marketplace::Helpers::FormHelper.tag(:input, options)
+    end
+    
+    def set_accessor_fields
+      self.access_key = asp-marketplace.aws_access_key_id if self.respond_to?(:access_key=)
+      self.account_id = asp-marketplace.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 'asp-marketplace/services/marketplace'
+require 'asp-marketplace/services/marketplacePolicy'

data/lib/asp-marketplace/services/marketplace.rb

@@ -0,0 +1,241 @@
+module asp-marketplace
+  module Services
+  
+    ##
+    # The Amazon Simple Pay Marketplace service is used to facilitate payments for others.
+    # Use it to charge a commission fee for brokering the exchange between buyers and sellers.
+    #
+    # Note that sellers must accept your marketplace fee policy before the payment buttons
+    # for their products can be generated. This can be accomplished using the +MarketplacePolicy+
+    # service with the form helper (see examples).
+    # 
+    # === Simple Pay Marketplace Fields
+    # 
+    # ==== Required Fields
+    # 
+    # The following attributes are required when creating a Simple Pay 
+    # Marketplace form (in addition to those listed in +asp-marketplace::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.
+    # recipient_email:: The e-mail address of the seller (important and must be correct).
+    # fixed_marketplace_fee:: The fixed marketplace fee to add to each transaction.
+    # variable_marketplace_fee:: The variable percentage fee to add to each transaction.
+    # 
+    # ==== 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, sellers need to accept the marketplace fee policy using the form helper)
+    #
+    #     <%= asp-marketplace_form_for(:marketplacePolicy, {
+    #       :max_fixed_fee    => 10.00,
+    #       :max_variable_fee => 5,
+    #       :return_url       => 'http://yourservice.com'
+    #     }) %>
+    #
+    #     (in your view, payment form generated for end users using the form helper)
+    #     
+    #     <%= asp-marketplace_form_for(:standard, {
+    #       :amount                   => 34.95,
+    #       :description              => "Mutual profit!",
+    #       :recipient_email          => 'seller@gmail.com',
+    #       :fixed_marketplace_fee    => 10.00,
+    #       :variable_marketplace_fee => 5
+    #     }) %>
+    # 
+    class Marketplace < Service
+      require 'asp-marketplace/signature_utils'
+      
+      
+        
+      class << self
+      # Loaded from YML config  
+        attr_accessor 'amount'
+        attr_accessor 'description'
+        attr_accessor 'reference_id'
+        attr_accessor 'abandon_url'
+        attr_accessor 'return_url'
+        attr_accessor 'immediate_return'
+        attr_accessor 'process_immediate'
+        attr_accessor 'ipn_url'
+        attr_accessor 'collect_shipping_address'
+        attr_accessor 'recipient_email'
+        attr_accessor 'fixed_marketplace_fee'
+        attr_accessor 'variable_marketplace_fee'
+        attr_accessor 'environment'
+      end
+      
+      # Function creates a Map of key-value pairs for all valid values passed to the function 
+       # @param accessKey - Put your Access Key here  
+       # @param amount - Enter the amount you want to collect for the item
+       # @param description - description - Enter a description of the item
+       # @param referenceId - Optionally enter an ID that uniquely identifies this transaction for your records
+       # @param abandonUrl - Optionally, enter the URL where senders should be redirected if they cancel their transaction
+       # @param returnUrl - Optionally enter the URL where buyers should be redirected after they complete the transaction
+       # @param immediateReturn - Optionally, enter "1" if you want to skip the final status page in Amazon Payments, 
+       # @param processImmediate - Optionally, enter "1" if you want to settle the transaction immediately else "0". Default value is "1"
+       # @param ipnUrl - Optionally, type the URL of your host page to which Amazon Payments should send the IPN transaction information.
+       # @param collectShippingAddress - Optionally, enter "1" if you want Amazon Payments to return the buyer's shipping address as part of the transaction information.
+       # @param signatureMethod - Valid values are  HmacSHA256 and HmacSHA1
+       # @param recipientEmail - Enter the e-mail address for the seller.
+       # @param fixedMarketplaceFee - Optionally, enter the fixed market place fee
+       # @param variableMarketplaceFee - Optionally, enter the variable market place fee
+
+       # @return - A map of key of key-value pair for all non null parameters
+
+      def self.get_params(attributes)
+        form_hidden_inputs = {}
+         if (Service.access_key== nil) then
+            raise ArgumentError, 'AccessKey is required parameter'
+        else
+        form_hidden_inputs["accessKey"] = Service.access_key
+        end
+        if (attributes[:amount] == nil) then
+            raise ArgumentError, 'Amount is required parameter'
+        else                         
+        form_hidden_inputs["amount"] = attributes[:amount].to_s
+        end 
+        if (attributes[:description] == nil) then        
+        raise ArgumentError, 'Description is required parameter'
+        else
+             form_hidden_inputs["description"] = attributes[:description].to_s
+        end
+        if (Service.signature_method == nil) then
+            raise ArgumentError, 'Signature Method is required parameter'
+        else
+            form_hidden_inputs[@@SIGNATURE_METHOD_KEYNAME] = Service.signature_method.to_s
+        end
+        if ( attributes[:recipient_email] == nil) then
+            raise ArgumentError, 'Recipient Email is required parameter'
+        else
+        	form_hidden_inputs["recipientEmail"] = attributes[:recipient_email].to_s
+        end
+        form_hidden_inputs["referenceId"] = attributes[:reference_id].to_s unless attributes[:reference_id].nil?
+        form_hidden_inputs["immediateReturn"] = self.immediate_return.to_s unless self.immediate_return.nil?
+        form_hidden_inputs["returnUrl"] = self.return_url.to_s unless self.return_url.nil?
+        form_hidden_inputs["abandonUrl"] = self.abandon_url.to_s unless self.abandon_url.nil?
+        form_hidden_inputs["processImmediate"] = self.process_immediate.to_s unless self.process_immediate.nil?
+        form_hidden_inputs["ipnUrl"] = self.ipn_url.to_s unless self.ipn_url.nil?
+        form_hidden_inputs["collectShippingAddress"] = self.collect_shipping_address.to_s unless self.collect_shipping_address.nil?
+
+        form_hidden_inputs["fixedMarketplaceFee"] = attributes[:fixed_marketplace_ee].to_s unless attributes[:fixed_marketplace_fee].nil?
+        form_hidden_inputs["variableMarketplaceFee"] = attributes[:variable_marketplace_fee].to_s unless attributes[:variable_marketplace_fee].nil?
+
+        form_hidden_inputs["cobrandingStyle"] = @@COBRANDING_STYLE
+        form_hidden_inputs[@@SIGNATURE_VERSION_KEYNAME] = @@SIGNATURE_VERSION
+
+        return form_hidden_inputs
+      end
+
+      # Creates a form from the provided key-value pairs
+      # @param form_hidden_inputs
+      #            - A map of key of key-value pair for all non null parameters
+      # @param service_end_point
+      #            - The Endpoint to be used based on environment selected
+      # @param image_location
+      #            - The imagelocation based on environment
+      # @return - An html form created using the key-value pairs
+
+
+      def self.get_marketplace_pay_button_form(form_hidden_inputs,service_end_point,image_location)
+        form = "<form target='_top' action=\"" + service_end_point + "\" method=\"" + "POST" + "\">\n"
+        form += "<input type=\"image\" src=\""+image_location+"\" border=\"0\">\n"
+        form_hidden_inputs.each { |k,v|
+            form += "<input type=\"hidden\" name=\"" + k + "\" value=\"" + v + "\" >\n"
+        }
+        form += "</form>\n"
+      end
+      
+      def self.get_marketplace_pay_button_url(form_hidden_inputs,service_end_point,image_location)
+       
+
+       url = 'https://authorize.payments-sandbox.amazon.com/cobranded-ui/actions/start?'
+       form_hidden_inputs.each { |k,v|
+           url += k + "=" + v + '&'
+       }
+       return url
+
+        # Uncomment this if you want output in a file
+        # File.open('out.htm', 'w') { |f| f.write x.body }
+        
+      end
+
+
+       # @param accessKey - Put your Access Key here  
+       # @param secretKey - Put your Secret Key here
+       # @param amount - Enter the amount you want to collect for the item
+       # @param description - description - Enter a description of the item
+       # @param referenceId - Optionally enter an ID that uniquely identifies this transaction for your records
+       # @param abandonUrl - Optionally, enter the URL where senders should be redirected if they cancel their transaction
+       # @param returnUrl - Optionally enter the URL where buyers should be redirected after they complete the transaction
+       # @param immediateReturn - Optionally, enter "1" if you want to skip the final status page in Amazon Payments, 
+       # @param processImmediate - Optionally, enter "1" if you want to settle the transaction immediately else "0". Default value is "1"
+       # @param ipnUrl - Optionally, type the URL of your host page to which Amazon Payments should send the IPN transaction information.
+       # @param collectShippingAddress - Optionally, enter "1" if you want Amazon Payments to return the buyer's shipping address as part of the transaction information.
+       # @param signatureMethod - Valid values are  HmacSHA256 and HmacSHA1
+       # @param recipientEmail - Enter the e-mail address for the seller.
+       # @param fixedMarketplaceFee - Optionally, enter the fixed market place fee
+       # @param variableMarketplaceFee - Optionally, enter the variable market place fee
+       # @param environment - Valid values are "sandbox" or "prod"
+
+      def self.generate_form(attributes)
+        if (Service.environment == "prod") then
+    	    endPoint = @@PROD_END_POINT;
+    	    imageLocation = @@PROD_IMAGE_LOCATION;
+        else
+    	    endPoint = @@SANDBOX_END_POINT;
+    	    imageLocation = @@SANDBOX_IMAGE_LOCATION;	
+        end  
+        uri = URI.parse(endPoint)
+        params = get_params(attributes)
+        
+        
+        signature = SignatureUtils.sign_parameters({:parameters => params, 
+                                                   :aws_secret_key => Service.secret_key,
+                                                   :host => uri.host,
+                                                   :verb => "POST",
+                                                   :uri  => uri.path,
+              					    :algorithm => Service.signature_method  })
+        params[@@SIGNATURE_KEYNAME] = signature
+        marketplace_pay_button_form = get_marketplace_pay_button_form(params,endPoint,imageLocation)
+        return marketplace_pay_button_form
+      end
+      
+      
+      def self.generate_url(attributes)
+        if (Service.environment == "prod") then
+    	    endPoint = @@PROD_END_POINT;
+    	    imageLocation = @@PROD_IMAGE_LOCATION;
+        else
+    	    endPoint = @@SANDBOX_END_POINT;
+    	    imageLocation = @@SANDBOX_IMAGE_LOCATION;	
+        end  
+        uri = URI.parse(endPoint)
+        params = get_params(attributes)
+        
+        
+        signature = SignatureUtils.sign_parameters({:parameters => params, 
+                                                   :aws_secret_key => Service.secret_key,
+                                                   :host => uri.host,
+                                                   :verb => "POST",
+                                                   :uri  => uri.path,
+              					    :algorithm => Service.signature_method  })
+        params[@@SIGNATURE_KEYNAME] = signature
+        return get_marketplace_pay_button_url(params,endPoint,imageLocation)
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/asp-marketplace/services/marketplacePolicy.rb

@@ -0,0 +1,122 @@
+module asp-marketplace
+  module Services
+  
+    ##
+    # The Amazon Simple Pay Marketplace Policy service is used to allow sellers to acknowledge marketplace policy fees.
+    # Only once a set policy has been agreed to will marketplace transactions be able to proceed.
+    #
+    # === Simple Pay Marketplace Policy Fields
+    # 
+    # ==== Required Fields
+    # 
+    # The following attributes are required when creating a Simple Pay Marketplace policy fee acceptance form
+    # (in addition to those listed in +asp-marketplace::Service+):
+    # 
+    # max_fixed_fee:: The maximum fixed fee that will be appended to transactions.
+    # max_variable_fee:: The maximum variable fee (%) that will be calculated and added to transactions.
+    # reference_id:: A custom string used to identify this transaction, it will be returned with return data.
+    #
+    # === Example
+    # 
+    #     (in your view, using the form helper)
+    #
+    #     <%= asp-marketplace_form_for(:marketplacePolicy, {
+    #       :max_fixed_fee => 10.00,
+    #       :max_variable_fee => 5,
+    #       :reference_id => '123456789'
+    #     }) %>
+    #
+    class MarketplacePolicy < Service
+      require 'asp-marketplace/signature_utils'
+      
+      class << self
+      # Loaded from YML config
+        attr_accessor 'return_url'
+      end
+      
+       # Function creates a Map of key-value pairs for all valid values passed to the function 
+       
+
+      def self.get_params(attributes)
+        form_hidden_inputs = {}
+        if (Service.access_key== nil) then
+            raise ArgumentError, 'AccessKey is required parameter'
+        else
+            form_hidden_inputs["callerKey"] = Service.access_key.to_s
+        end
+        if (Service.signature_method == nil) then
+            raise ArgumentError, 'Signature Method is required parameter' 
+        else
+            form_hidden_inputs[@@SIGNATURE_METHOD_KEYNAME] = Service.signature_method.to_s 
+        end 
+        if (self.return_url == nil) then
+            raise ArgumentError, 'Return_url is required parameter' 
+        else
+    	      form_hidden_inputs["returnUrl"] = self.return_url.to_s
+        end
+
+        form_hidden_inputs["pipelineName"] = "Recipient"
+        form_hidden_inputs["recipientPaysFee"] = "True"
+        form_hidden_inputs["collectEmailAddress"] = "True"
+        
+        form_hidden_inputs["callerReference"] = attributes[:caller_reference].to_s
+       
+        form_hidden_inputs["maxFixedFee"] = attributes[:fixed_marketplace_fee].to_s unless attributes[:fixed_marketplace_fee].nil?
+        form_hidden_inputs["maxvariableFee"] = attributes[:variable_marketplace_fee].to_s unless attributes[:variable_marketplace_fee].nil?
+
+        form_hidden_inputs["cobrandingStyle"] = @@COBRANDING_STYLE
+        form_hidden_inputs[@@SIGNATURE_VERSION_KEYNAME] = @@SIGNATURE_VERSION
+
+        return form_hidden_inputs
+      end
+
+      # Creates a form from the provided key-value pairs
+      # @param form_hidden_inputs
+      #            - A map of key of key-value pair for all non null parameters
+      # @param service_end_point
+      #            - The Endpoint to be used based on environment selected
+      # @param image_location
+      #            - The imagelocation based on environment
+      # @return - An html form created using the key-value pairs
+
+
+      def self.get_accept_marketplace_fee_button_form(form_hidden_inputs,service_end_point,image_location,path)
+        form = "<form target='_top' action=\"https://" + service_end_point + path + "\" method=\"" + @@CBUIhttp_method + "\">\n"
+        form += "<input type=\"image\" src=\""+image_location+"\" border=\"0\">\n"
+        form_hidden_inputs.each { |k,v|
+            form += "<input type=\"hidden\" name=\"" + k + "\" value=\"" + v + "\" >\n"
+        }
+        form += "</form>\n"
+      end
+
+       # Attributes Required:
+       # callerReference -Optionally, enter an ID that uniquely identifies this transaction for callers Record
+       # fixedMarketplaceFee - Optionally, enter the fixed market place fee
+       # variableMarketplaceFee - Optionally, enter the variable market place fee
+       
+
+      def self.generate_form(attributes)
+        if (Service.environment == "prod") then
+    	endPoint = @@PROD_END_POINT;
+    	imageLocation = @@PROD_MP_IMAGE_LOCATION;
+        else
+    	 endPoint = @@SANDBOX_END_POINT;
+    	 imageLocation = @@SANDBOX_MP_IMAGE_LOCATION;	
+        end 
+        uri = URI.parse(endPoint)
+        params = get_params(attributes)
+
+        signature = SignatureUtils.sign_parameters({:parameters => params, 
+                                                :aws_secret_key => Service.secret_key,
+                                                :host => uri.host,
+                                                :verb => @@CBUIhttp_method,
+                                                :uri  => @@CBUI_REQUEST_URI,
+    					    :algorithm => Service.signature_method })
+        params[@@SIGNATURE_KEYNAME] = signature
+        accept_marketplace_fee_button_form = get_accept_marketplace_fee_button_form(params,uri.host,imageLocation,@@CBUI_REQUEST_URI)
+        return accept_marketplace_fee_button_form
+      end
+    end
+    
+  end
+end

data/lib/asp-marketplace/signature_utils.rb

@@ -0,0 +1,111 @@
+################################################################################ 
+#  Copyright 2008 Amazon Technologies, Inc.
+#  Licensed under the Apache License, Version 2.0 (the "License"); 
+#  
+#  You may not use this file except in compliance with the License. 
+#  You may obtain a copy of the License at: http://aws.amazon.com/apache2.0
+#  This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 
+#  CONDITIONS OF ANY KIND, either express or implied. See the License for the 
+#  specific language governing permissions and limitations under the License.
+################################################################################
+class SignatureUtils 
+
+require 'base64'
+require 'cgi'
+require 'openssl'
+require 'Amazonmarketplace/service'
+
+
+#
+# Copyright:: Copyright (c) 2009 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+#
+# RFC 2104-compliant HMAC signature for request parameters
+#  Implements AWS Signature, as per following spec:
+#
+# In Signature Version 2, string to sign is based on following:
+#
+#    1. The HTTP Request Method followed by an ASCII newline (%0A)
+#    2. The HTTP Host header in the form of lowercase host, followed by an ASCII newline.
+#    3. The URL encoded HTTP absolute path component of the URI
+#       (up to but not including the query string parameters);
+#       if this is empty use a forward '/'. This parameter is followed by an ASCII newline.
+#    4. The concatenation of all query string components (names and values)
+#       as UTF-8 characters which are URL encoded as per RFC 3986
+#       (hex characters MUST be uppercase), sorted using lexicographic byte ordering.
+#       Parameter names are separated from their values by the '=' character
+#       (ASCII character 61), even if the value is empty.
+#       Pairs of parameter and values are separated by the '&' character (ASCII code 38).
+#
+
+
+  SIGNATURE_KEYNAME = "signature"
+
+  HMAC_SHA256_ALGORITHM = "HmacSHA256"
+  HMAC_SHA1_ALGORITHM = "HmacSHA1"
+  
+   def authentic?(args, signature, secret_key = Service.secret_key)
+      string_to_sign = "";
+      string_to_sign = calculate_string_to_sign_v2(args)
+      return signature == compute_signature(string_to_sign, secret_key)
+    end
+
+  def self.sign_parameters(args)
+    string_to_sign = "";
+    string_to_sign = calculate_string_to_sign_v2(args)
+    return compute_signature(string_to_sign, args[:aws_secret_key],get_algorithm(args[:algorithm]))
+  end
+  
+  # Convert a string into URL encoded form.
+  def self.urlencode(plaintext)
+    CGI.escape(plaintext.to_s).gsub("+", "%20").gsub("%7E", "~")
+  end
+
+  private # All the methods below are private
+
+  def self.calculate_string_to_sign_v2(args)
+    parameters = args[:parameters]
+
+    uri = args[:uri] 
+    uri = "/" if uri.nil? or uri.empty?
+    uri = urlencode(uri).gsub("%2F", "/") 
+
+    verb = args[:verb]
+    host = args[:host].downcase
+
+
+    # exclude any existing Signature parameter from the canonical string
+    sorted = (parameters.reject { |k, v| k == SIGNATURE_KEYNAME }).sort
+    
+    canonical = "#{verb}\n#{host}\n#{uri}\n"
+    isFirst = true
+
+    sorted.each { |v|
+      if(isFirst) then
+        isFirst = false
+      else
+        canonical << '&'
+      end
+
+      canonical << urlencode(v[0])
+      unless(v[1].nil?) then
+        canonical << '='
+        canonical << urlencode(v[1])
+      end
+    }
+
+    return canonical
+  end
+
+  def self.get_algorithm(signature_method) 
+    return 'sha256' if (signature_method == HMAC_SHA256_ALGORITHM);
+    return 'sha1'
+  end
+
+  def self.compute_signature(canonical, aws_secret_key, algorithm = 'sha256')
+    digest = OpenSSL::Digest::Digest.new(algorithm)
+    return Base64.encode64(OpenSSL::HMAC.digest(digest, aws_secret_key, canonical)).chomp
+  end
+
+end
+
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/asp-marketplace.rb'}"
+puts "Loading asp-marketplace gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: asp-marketplace
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Charlie White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Rails ready gem for Marketplace Transactions using Amazon Simple Pay.
+email: 
+- charlie@fluidtickets.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/asp-marketplace.rb
+- lib/asp-marketplace/helpers/form_helper.rb
+- lib/asp-marketplace/helpers/notification_helper.rb
+- lib/asp-marketplace/helpers/rails_helper.rb
+- lib/asp-marketplace/rails.rb
+- lib/asp-marketplace/service.rb
+- lib/asp-marketplace/services/marketplace.rb
+- lib/asp-marketplace/services/marketplacePolicy.rb
+- lib/asp-marketplace/signature_utils.rb
+- lib/asp-marketplace/Yml.rb
+- script/console
+- script/destroy
+- script/generate
+- asp-marketplace.gemspec
+has_rdoc: true
+homepage: http://asp-marketplace.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: asp-marketplace
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This gem provides a Rails interface to the Amazon Simple Pay payment service.
+test_files: []
+