simplepay-rails4 0.4.0

data/lib/simplepay/support/field.rb

@@ -0,0 +1,147 @@
+require 'active_support'
+
+module Simplepay
+  module Support
+    
+    ##
+    # Represents a data field which will ultimately populate a Simple Pay 
+    # form.  These fields are often unique to their service.
+    # 
+    class Field
+      include Comparable
+      
+      ALLOWED_OPTIONS = [:as, :class, :required, :value]
+      
+      # The parent service of the field
+      attr_reader :service
+      
+      # The name of the field used in your local program (may be different than the service name)
+      attr_reader :name
+      
+      ##
+      # name:: Name which is used when referring to this field in the code.
+      # options:: An optional hash of field options.
+      # 
+      # === Options
+      # 
+      # as:: Overrides the +name+ when used by the service to the exact string or symbol (camelized) given.
+      # class:: Delegate the value mechanics to a separate class.
+      # required:: Tells whether or not this field is required for its service.
+      # value:: Set the value of the field at initialization.
+      # 
+      # === Example
+      # 
+      #     Field.new(:example, :required => true, :as => 'ExAmplE')
+      #     Field.new(:delegated, :class => Simplepay::Support::Boolean, :value => true)
+      # 
+      def initialize(service, name, options)
+        @service, @name, @options = service, name, normalize_options!(options)
+        @delegate   = options[:class]
+        @value      = nil
+        self.value  = options[:value] if options[:value]
+      end
+      
+      ##
+      # Returns the name of the field used by the service.  This may be 
+      # different than the Ruby name given to the field.
+      # 
+      # Symbol names (or :as options) are camelized.  If this is not desired,
+      # use a String, instead.
+      # 
+      def service_name
+        source = @options[:as] || @name
+        case source
+        when Symbol
+          source.to_s.camelize(:lower)
+        else
+          source
+        end
+      end
+      alias :to_s :service_name
+      
+      ##
+      # Returns +true+ if the field is required for the service.
+      # 
+      def required?
+        @options[:required] ? true : false
+      end
+      
+      ##
+      # Converts a Field into an HTML HIDDEN INPUT element as a string.
+      # 
+      def to_input
+        raise(RequiredFieldMissing, "Missing Required Field value for #{name}") if required? && value.blank?
+        value.blank? ? '' : html_input_tag
+      end
+      
+      def delegated? #:nodoc:
+        @delegate
+      end
+      
+      def value=(v) #:nodoc:
+        @value = delegated? ? @delegate.new(v) : v
+      end
+      
+      def value #:nodoc:
+        if delegated?
+          @value.to_s
+        else
+          case @value
+          when Proc
+            @value.call(self)
+          else
+            @value
+          end
+        end
+      end
+      
+      ##
+      # Sorting is based solely by +service_name+.
+      # 
+      def <=>(o)
+        self.service_name <=> o.service_name
+      end
+      
+      def ==(o) #:nodoc:
+        self.service  == o.service &&
+        self.name     == o.name
+      end
+      
+      def inspect #:nodoc:
+        %|#<#{self.class.name} Name:"#{@name}"#{" ServiceName:\"#{service_name}\"" if service_name != @name}#{" REQUIRED" if required?}>|
+      end
+      
+      def clone_for(o) #:nodoc:
+        self.class.new(o, deep_clone(@name), deep_clone(@options))
+      end
+      
+      def delegate #:nodoc:
+        @delegate
+      end
+      
+      
+      private
+      
+      
+      def html_input_tag #:nodoc:
+        Simplepay::Helpers::FormHelper.tag(:input, {
+          :name   => service_name,
+          :value  => value,
+          :type   => 'hidden'
+        })
+      end
+      
+      def normalize_options!(options) #:nodoc:
+        options.symbolize_keys!
+        raise(InvalidOptions, "Unrecognized options passed: #{(options.keys - ALLOWED_OPTIONS).join(', ')}") unless (options.keys - ALLOWED_OPTIONS).empty?
+        options
+      end
+      
+      def deep_clone(o)
+        Marshal::load(Marshal.dump(o))
+      end
+      
+    end
+    
+  end
+end

data/lib/simplepay/support/interval.rb

@@ -0,0 +1,145 @@
+require 'simplepay/constants'
+
+module Simplepay
+  module Support
+    
+    class Interval
+      
+       # If set, limits the quantity to a value within this range
+      ALLOWED_QUANTITY_RANGE  = nil
+      
+      # If set, limits the interval set to a value within this array
+      ALLOWED_INTERVALS       = nil
+      
+      # Sets the default quantity value for new instances
+      DEFAULT_QUANTITY        = nil
+      
+      # Sets the default interval value for new instances
+      DEFAULT_INTERVAL        = nil
+      
+      # The numeric number of intervals
+      attr_reader :quantity
+      
+      # The interval, or "period", of time
+      attr_reader :interval
+      
+      
+      class << self
+        
+        def allowed_intervals
+          const_get(:ALLOWED_INTERVALS)
+        end
+        
+        def allowed_quantity_range
+          const_get(:ALLOWED_QUANTITY_RANGE)
+        end
+        
+        def default_quantity
+          const_get(:DEFAULT_QUANTITY)
+        end
+        
+        def default_interval
+          const_get(:DEFAULT_INTERVAL)
+        end
+        
+      end
+      
+      
+      ##
+      # Creates an instance of the Interval.  This can be called in one of 
+      # several ways:
+      # 
+      # no arguments:: Creates a new interval instance with default values.
+      # one argument, string:: Creates a new interval by parsing the given string to set both the quantity and interval.  Must be formatted as: "3 day" (quantity, space, interval)
+      # one argument, hash:: Creates a new interval and populates it with the given :quantity and :interval.  Uses defaults if not given.
+      # two arguments:: Creates a new interval with the first argument as the quantity, second argument as the interval.
+      # 
+      # === Examples
+      # 
+      # All of these are equivalent:
+      # 
+      #     Interval.new("3 day")
+      #     Interval.new({:quantity => 3, :interval => 'day'})
+      #     Interval.new(3, 'day')
+      # 
+      def initialize(*args)
+        parse_arguments(*args)
+      end
+      
+      ##
+      # Set the interval.
+      # 
+      def interval=(i)
+        raise(ArgumentError, "Interval '#{i}' should be one of: #{allowed_intervals.join(', ')}") if i && allowed_intervals && !allowed_intervals.include?(i)
+        @interval = i
+      end
+      
+      ##
+      # Set the quantity.
+      # 
+      def quantity=(q)
+        raise(ArgumentError, "Quantity '#{q}' should be in #{allowed_quantity_range}") if q && allowed_quantity_range && !allowed_quantity_range.include?(q)
+        @quantity = q
+      end
+      
+      ##
+      # Converts the interval into an Amazon-ready string.
+      # 
+      #     Interval.new(3, 'day').to_s # => "3 day"
+      # 
+      def to_s
+        "#{quantity} #{interval}" if interval
+      end
+      
+      def allowed_intervals #:nodoc:
+        self.class.allowed_intervals
+      end
+      
+      def allowed_quantity_range #:nodoc:
+        self.class.allowed_quantity_range
+      end
+      
+      def default_quantity #:nodoc:
+        self.class.default_quantity
+      end
+      
+      def default_interval #:nodoc:
+        self.class.default_interval
+      end
+      
+      
+      private
+      
+      
+      def parse_arguments(*args)
+        case args.size
+        when 0
+          self.quantity = self.default_quantity
+          self.interval = self.default_interval
+        when 1
+          case args.first
+          when String
+            parse_values_from(args.first)
+          when Hash
+            self.quantity = args.first[:quantity] || self.default_quantity
+            self.interval = args.first[:interval] || self.default_interval
+          end
+        else
+          self.quantity = args.first
+          self.interval = args[1]
+        end
+      end
+      
+      def parse_values_from(s)
+        if s =~ /\A([\d]+)\s+([\w]+)\Z/
+          self.quantity = $1.to_i
+          self.interval = $2
+        else
+          raise ArgumentError, "Unrecognzied initialization string given: #{s.inspect}"
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/simplepay/support/simple_amount.rb

@@ -0,0 +1,37 @@
+require 'bigdecimal'
+
+module Simplepay
+  module Support
+    
+    ##
+    # In new Amazon API requests the amount does not include the currency, SimpleAmount is used for this, for now.
+    # 
+    # At the present time, Amazon only uses USD.
+    # 
+    class SimpleAmount
+      
+      attr_reader :amount
+      
+      def initialize(amount)
+        self.amount   = amount
+      end
+      
+      
+      ##
+      # Sets the amount of the currency value, such as "1" for 1 USD.  This
+      # amount cannot be negative.
+      # 
+      def amount=(amount)
+        raise(ArgumentError, "Amount cannot be nil") unless amount
+        raise(ArgumentError, "Amount cannot be negative") if amount < 0
+        @amount = BigDecimal.new(amount.to_s)
+      end
+      
+      def to_s
+        "#{'%0.2f' % amount}"
+      end
+      
+    end
+    
+  end
+end

data/lib/simplepay/support/subscription_period.rb

@@ -0,0 +1,25 @@
+require 'simplepay/support/interval'
+
+module Simplepay
+  module Support
+    
+    class SubscriptionPeriod < Interval
+      ALLOWED_INTERVALS       = Simplepay::Intervals + ['forever']
+      
+      # Limited to 3 digits.
+      ALLOWED_QUANTITY_RANGE  = (1...1000)
+      
+      ##
+      # See Simplepay::Support::Interval.to_s for more information.
+      # 
+      # If the subscription lasts "forever" then Amazon does not need an
+      # interval string.
+      # 
+      def to_s
+        super unless interval == 'forever'
+      end
+      
+    end
+    
+  end
+end

data/lib/simplepay/support.rb

@@ -0,0 +1,16 @@
+require 'simplepay/support/amount'
+require 'simplepay/support/billing_frequency'
+require 'simplepay/support/boolean'
+require 'simplepay/support/currency'
+require 'simplepay/support/epoch'
+require 'simplepay/support/field'
+require 'simplepay/support/interval'
+require 'simplepay/support/simple_amount'
+require 'simplepay/support/subscription_period'
+
+module Simplepay
+  
+  module Support
+  end
+  
+end

data/lib/simplepay/validator.rb

@@ -0,0 +1,59 @@
+require 'cgi'
+require 'nokogiri'
+require 'open-uri'
+
+module Simplepay    
+  module Validator
+    extend ActiveSupport::Concern
+    
+    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?(params, endpoint = request.url[/\A[^?]+/])
+      host    = Simplepay.use_sandbox ? "https://fps.sandbox.amazonaws.com" :
+                                        "https://fps.amazonaws.com"
+      query   = build_simplepay_query_string( params.except( :controller,
+                                                             :action,
+                                                             :id ) )
+      request = { "Action"         => "VerifySignature",
+                  "Version"        => "2008-09-17",
+                  "UrlEndPoint"    => endpoint,
+                  "HttpParameters" => query }
+      url     = "#{host}/?#{build_simplepay_query_string(request)}"
+      
+      uri               = URI.parse(url)
+      http              = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl      = true
+      http.ca_file      = File.join(File.dirname(__FILE__), "ca-bundle.crt")
+      http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
+      http.verify_depth = 5
+
+      response = http.start { |session|
+        get = Net::HTTP::Get.new("#{uri.path}?#{uri.query}")
+        session.request(get)
+      }
+
+      xml = Nokogiri.XML(response.body)
+      xml && xml.xpath( "//xmlns:VerificationStatus/text()",
+                        xml.namespaces ).to_s == "Success"
+    rescue
+      false
+    end
+    
+    def build_simplepay_query_string(params)
+      params.map { |k, v|
+        "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+      }.join("&")
+    end
+  end
+end

data/lib/simplepay/version.rb

@@ -0,0 +1,3 @@
+module Simplepay
+  VERSION = '0.4.0'
+end

data/lib/simplepay.rb

@@ -0,0 +1,29 @@
+require 'rails'
+require 'active_support/dependencies'
+
+module Simplepay
+  autoload :Constants, 'simplepay/constants'
+  autoload :Support, 'simplepay/support'
+  autoload :Authentication, 'simplepay/authentication'
+  autoload :Service, 'simplepay/service'
+  autoload :Validator, 'simplepay/validator'
+    
+  mattr_accessor :aws_access_key_id
+  @@aws_access_key_id = '' 
+  mattr_accessor :aws_secret_access_key
+  @@aws_secret_access_key = ''  
+  mattr_accessor :use_sandbox
+  @@use_sandbox = true
+
+  def self.use_sandbox?
+    @@use_sandbox
+  end
+
+  def self.setup
+    yield self
+  end
+  
+  ActiveSupport.on_load(:action_controller) do
+    include ::Simplepay::Validator
+  end
+end

data/simplepay.gemspec

@@ -0,0 +1,27 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "simplepay-rails4"
+  s.version = "0.4.0"
+
+  s.authors = ["Nathaniel E. Bibler", "Derrick Parkhurst", "Charles DuBose"]
+  s.email = ['gem@nathanielbibler.com', 'gem@dubo.se']
+  
+  s.summary = "Amazon SimplePay helpers for Rails 4"
+  s.description = "Creates buttons to manage paying with amazon payments. Can be used for direct payments or merchant payments"
+  
+  s.homepage = 'https://github.com/Yakrware/simplepay'
+  s.license  = 'MIT'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  
+  s.add_dependency('rails', '~>4')
+  s.add_runtime_dependency('nokogiri', '~>1.6')
+end
+

data/test/simplepay/services/test_donation.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+require 'simplepay/services/donation'
+
+class Simplepay::Services::TestDonation < ActiveSupport::TestCase
+  
+  def self.model_class; Simplepay::Services::Donation; end
+  
+  context 'Simplepay::Services::Donation' do
+    
+    should_have_service_field :access_key,
+                              :as       => 'accessKey', 
+                              :required => true
+    
+    should_have_service_field :signature,
+                              :as       => 'signature', 
+                              :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 => false
+
+    should_have_service_field :fixed_marketplace_fee,
+                              :as       => 'fixedMarketplaceFee',
+                              :required => false,
+                              :class    => Simplepay::Support::Amount
+
+    should_have_service_field :variable_marketplace_fee,
+                              :as       => 'variableMarketplaceFee',
+                              :required => false
+
+    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 => true
+    
+  end
+  
+end

data/test/simplepay/services/test_marketplace.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+require 'simplepay/services/marketplace'
+
+class Simplepay::Services::TestMarketplace < ActiveSupport::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 :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