flexpay 0.1.0

data/lib/flexpay.rb

@@ -0,0 +1,107 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'openssl'
+require 'net/https'
+require 'uri'
+require 'date'
+require 'base64'
+
+require 'flexpay/request'
+require 'flexpay/api_module'
+
+require 'flexpay/cobranding_api/v2009_01_09'
+require 'flexpay/fps_api/v2008_09_17'
+
+require 'flexpay/util'
+require 'flexpay/exceptions'
+
+module Flexpay
+  class API
+
+    API_ENDPOINT = 'https://fps.amazonaws.com/'.freeze
+    API_SANDBOX_ENDPOINT = 'https://fps.sandbox.amazonaws.com/'.freeze
+    PIPELINE_URL = 'https://authorize.payments.amazon.com/cobranded-ui/actions/start'.freeze
+    PIPELINE_SANDBOX_URL = 'https://authorize.payments-sandbox.amazon.com/cobranded-ui/actions/start'.freeze
+    API_VERSION = Date.new(2008, 9, 17).to_s.freeze
+    SIGNATURE_VERSION = 2.freeze
+
+    attr_reader :access_key
+    attr_reader :secret_key
+    attr_reader :fps_url
+    attr_reader :pipeline_url
+    attr_reader :cobranding_version
+    attr_reader :fps_version
+
+    def initialize(params)
+      @access_key = params[:access_key]
+      @secret_key = params[:secret_key]
+      @cobranding_version = params[:cobranding_version] || "2009-01-09"
+      @fps_version = params[:fps_version] || "2008-09-17"
+      
+      if params[:sandbox].nil? or params[:sandbox] == true
+        @pipeline_url = PIPELINE_SANDBOX_URL
+        @fps_url = API_SANDBOX_ENDPOINT
+      else
+        @pipeline_url = PIPELINE_URL
+        @fps_url = API_ENDPOINT
+      end
+
+    end
+    
+    def get_recurring_pipeline
+      obj = cobranding_constant_lookup(:RecurringPipeline).new
+      supply_defaults_for_pipeline_and_return(obj)
+    end
+    
+    def get_verify_signature
+      obj = fps_constant_lookup(:VerifySignature).new
+      supply_defaults_for_fps_and_return(obj)
+    end
+    
+    def get_pay
+      obj = fps_constant_lookup(:Pay).new
+      supply_defaults_for_fps_and_return(obj)
+    end
+    
+    # def version
+    #   raise APINotConfigured if @version.nil? || @version.empty?
+    #   @version
+    # end
+    
+    def access_key
+      raise APINotConfigured if @access_key.nil? || @access_key.empty?
+      @access_key
+    end
+    
+    def secret_key
+      raise APINotConfigured if @secret_key.nil? || @secret_key.empty?
+      @secret_key
+    end
+    
+    private
+    
+    def cobranding_constant_lookup(sym)
+      Flexpay::CobrandingAPI.const_get("V#{@cobranding_version.gsub(/-/,'_')}".to_sym).specific_class(sym)
+    end
+    
+    def fps_constant_lookup(sym)
+      Flexpay::FpsAPI.const_get("V#{@fps_version.gsub(/-/,'_')}".to_sym).specific_class(sym)
+    end
+    
+    def supply_defaults_for_pipeline_and_return(obj)
+      obj.access_key = @access_key
+      obj.secret_key = @secret_key
+      obj.endpoint = @pipeline_url
+      obj.callerKey = @access_key # The pipeline API uses this alias
+      obj
+    end
+    
+    def supply_defaults_for_fps_and_return(obj)
+      obj.access_key = @access_key
+      obj.secret_key = @secret_key
+      obj.endpoint = @fps_url
+      obj
+    end
+    
+  end
+end

data/lib/flexpay/api_module.rb

@@ -0,0 +1,18 @@
+module Flexpay
+  module APIModule
+    def self.included(mod)
+      mod.class_eval do
+        self.class_variable_set(:@@included_in, {})
+
+        def self.included(mod)
+          class_variable_get(:@@included_in)[mod.to_s.split('::').last.to_sym] = mod
+        end
+
+        def self.specific_class(lookup_sym)
+          class_variable_get(:@@included_in)[lookup_sym]
+        end
+      end
+      
+    end
+  end
+end

data/lib/flexpay/cobranding_api/v2009_01_09.rb

@@ -0,0 +1,9 @@
+module Flexpay
+  module CobrandingAPI
+    module V2009_01_09
+      include Flexpay::APIModule
+    end
+  end
+end
+
+require 'flexpay/cobranding_api/v2009_01_09/pipelines'

data/lib/flexpay/cobranding_api/v2009_01_09/pipelines.rb

@@ -0,0 +1,19 @@
+module Flexpay
+  module CobrandingAPI
+    module V2009_01_09
+      class RecurringPipeline
+        include Flexpay::CobrandingAPI::V2009_01_09
+        include Flexpay::AmazonFPSRequest
+      
+        required_parameters "pipelineName","callerReference", "recipientToken", "transactionAmount", "recurringPeriod", "returnURL",
+            "version", "callerKey"
+      
+        def initialize
+          self.pipelineName = "Recurring"
+          self.version = "2009-01-09"
+        end
+      
+      end
+    end
+  end
+end

data/lib/flexpay/exceptions.rb

@@ -0,0 +1,3 @@
+class APINotConfigured < Exception
+  
+end

data/lib/flexpay/fps_api/v2008_09_17.rb

@@ -0,0 +1,10 @@
+module Flexpay
+  module FpsAPI
+    module V2008_09_17
+      include Flexpay::APIModule
+    end
+  end
+end
+
+require 'flexpay/fps_api/v2008_09_17/verify_signature'
+require 'flexpay/fps_api/v2008_09_17/pay'

data/lib/flexpay/fps_api/v2008_09_17/pay.rb

@@ -0,0 +1,21 @@
+module Flexpay
+  module FpsAPI
+    module V2008_09_17
+      class Pay
+        include Flexpay::FpsAPI::V2008_09_17
+        include Flexpay::AmazonFPSRequest
+      
+        required_parameters "CallerReference", "SenderTokenId", "TransactionAmount_Value", "TransactionAmount_CurrencyCode", "Action", "AWSAccessKeyId", "Timestamp", "Version"
+      
+        response_parameters :TransactionId => "/'PayResponse'/'PayResult'/'TransactionId'",
+                            :TransactionStatus => "/'PayResponse'/'PayResult'/'TransactionStatus'"
+      
+        def initialize
+          self.Action = "Pay"
+          self.Version = "2008-09-17"
+        end
+      
+      end
+    end
+  end
+end

data/lib/flexpay/fps_api/v2008_09_17/verify_signature.rb

@@ -0,0 +1,20 @@
+module Flexpay
+  module FpsAPI
+    module V2008_09_17
+      class VerifySignature
+        include Flexpay::FpsAPI::V2008_09_17
+        include Flexpay::AmazonFPSRequest
+      
+        required_parameters "UrlEndPoint", "HttpParameters", "Action", "Version"
+      
+        response_parameters :VerificationStatus => "/'VerifySignatureResponse'/'VerifySignatureResult'/'VerificationStatus'"
+      
+        def initialize
+          self.Action = "VerifySignature"
+          self.Version = "2008-09-17"
+        end
+      
+      end
+    end
+  end
+end

data/lib/flexpay/request.rb

@@ -0,0 +1,100 @@
+require 'rest_client'
+require 'logger'
+require 'cgi'
+require 'uri'
+require 'hpricot'
+
+module Flexpay
+  module Flexpay::AmazonFPSRequest
+    
+    def self.included(mod)
+      mod.class_eval do
+        
+        @param_list
+        @response_parameters
+        
+        attr_accessor :access_key
+        attr_accessor :secret_key
+        attr_accessor :endpoint
+        
+        def self.required_parameters(*params)
+          @param_list = params
+          params.each do |p|
+            attr_accessor p.to_sym
+          end
+        end
+        
+        def self.response_parameters(params)
+          @response_parameters = {}
+          params.each do |k,v|
+            @response_parameters[k] = v
+          end
+        end
+        
+        def self.get_required_parameters
+          @param_list
+        end
+        
+        def self.get_response_parameters
+          @response_parameters
+        end
+      end
+    end
+    
+    def generate_url(signed_request=true)
+      params = generate_parameters
+      params = sign_parameters(params) if signed_request == true
+      
+      "#{@endpoint}?#{build_query_string(params)}"
+    end
+    
+    def go!(signed=true)
+      url = generate_url(signed)
+      
+      RestClient.log = "stdout"
+      response = RestClient.get url
+      
+      doc = Hpricot.XML(response)
+      
+      result = {}
+      self.class.get_response_parameters.each do |k,v|
+        result[k] = eval("(doc#{v}).innerHTML")
+      end
+      result
+    end
+    
+    private
+    
+    def build_query_string(params)
+      params.sort.collect {|i| i.join("=") }.join("&")
+    end
+    
+    def sign_parameters(params)
+      ###  Horrible kludge.  TODO Remove
+      if params.has_key?("Action")
+        params.merge!({"SignatureVersion" => 2.to_s, "SignatureMethod" => "HmacSHA256"})
+      else
+        params.merge!({"signatureVersion" => 2.to_s, "signatureMethod" => "HmacSHA256"})
+      end
+      
+      u = URI.parse(URI.escape("#{@endpoint}?#{build_query_string(params)}"))
+      sig = Flexpay::Signature.generate_signature('GET',u.host,u.path,params, @secret_key)
+        
+      if params.has_key?("Action") 
+        params.merge({"Signature" => CGI.escape(sig)})
+      else
+        params.merge({"signature" => CGI.escape(sig)})
+      end
+    end
+    
+    def generate_parameters
+      params = {}
+      self.class.get_required_parameters.each do |p|
+        val = self.send(p)
+        params[p.gsub('_','.')] = val unless val.nil? || val.empty?
+      end
+      params
+    end
+    
+  end
+end

data/lib/flexpay/util.rb

@@ -0,0 +1,26 @@
+require 'openssl'
+require 'base64'
+require 'uri'
+
+module Flexpay
+  class Signature
+    def self.generate_signature(http_method, host, request_uri, params, secret_key)
+      method = http_method.to_s.upcase
+
+      #Place in canonical order and URI encode
+      encoded_data = params.sort.collect {|i| i.join("=") }.join("&")
+
+      data = "#{http_method}\n#{host}\n#{request_uri}\n#{modified_URL_encoding(encoded_data)}"
+      digest = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, secret_key, data)
+      Base64.encode64(digest).strip
+    end
+    
+    private
+    
+    ## These are the modified encoding rules proposed by Amazon. Not quite URL encoding
+    def self.modified_URL_encoding(string)
+      URI.escape(string).gsub(/\+/, '%20').gsub(/\*/, '%2A').gsub("%7E","~").gsub(/:/,'%3A').gsub(/\//,'%2F')
+    end
+    
+  end
+end

data/spec/integrations/integrations_helper.rb

@@ -0,0 +1,8 @@
+ACCESS_KEY = ENV['AWS_ACCESS_KEY'] || ENV['AMAZON_ACCESS_KEY_ID']
+SECRET_KEY = ENV['AWS_SECRET_KEY'] || ENV['AMAZON_SECRET_ACCESS_KEY']
+
+unless ACCESS_KEY and SECRET_KEY
+  raise RuntimeError, "You must set your AWS_ACCESS_KEY and AWS_SECRET_KEY environment variables to run integration tests"
+end
+
+require File.dirname(__FILE__) + '/../spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/flexpay'

data/spec/units/api_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe Flexpay::Signature do
+  before(:each) do
+    @api = Flexpay::API.new(:access_key => ACCESS_KEY, :secret_key => SECRET_KEY)
+  end
+  
+  it "should complain if key values aren't specified" do
+    @api = Flexpay::API.new(:secret_key => SECRET_KEY)
+    lambda { @api.access_key }.should raise_error(APINotConfigured)
+    @api = Flexpay::API.new(:access_key => ACCESS_KEY)
+    lambda { @api.secret_key }.should raise_error(APINotConfigured)
+  end
+  
+  it "should return a recurring pipeline based on API version" do
+    @api.get_recurring_pipeline.should be_a(Flexpay::CobrandingAPI::V2009_01_09::RecurringPipeline)
+  end
+  
+  it "should return a verify signature based on API version" do
+    @api.get_verify_signature.should be_a(Flexpay::FpsAPI::V2008_09_17::VerifySignature)
+  end
+  
+end

data/spec/units/pay_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe 'Pay' do
+  before(:each) do
+  end
+  
+  it "should correctly build a request" do
+    pay = Flexpay::API.new(:access_key => ACCESS_KEY, :secret_key => SECRET_KEY).get_pay
+    
+    body =<<HEREDOC 
+    <PayResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
+       <PayResult>
+          <TransactionId>14GK6BGKA7U6OU6SUTNLBI5SBBV9PGDJ6UL</TransactionId>
+          <TransactionStatus>Pending</TransactionStatus>
+       </PayResult>
+       <ResponseMetadata>
+          <RequestId>c21e7735-9c08-4cd8-99bf-535a848c79b4:0</RequestId>
+       </ResponseMetadata>
+    </PayResponse>
+HEREDOC
+    
+    RestClient.stub!(:get).and_return(body)
+    
+    pay.CallerReference = Time.now.to_i.to_s
+    pay.SenderTokenId = "U65I5X19A9HS8DD8MEIH7ASGRQMVTCPNCPKG4ML8Z8NDGGCLU265KXSILUF8SXIA"
+    pay.TransactionAmount_Value = "10"
+    pay.TransactionAmount_CurrencyCode = "USD"
+    pay.AWSAccessKeyId = ACCESS_KEY
+    pay.Timestamp = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+    
+    result = pay.go!
+    result.should have_key(:TransactionId)
+    result.should have_key(:TransactionStatus)
+  end
+  
+end

data/spec/units/recurring_pipeline_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe "Recurring pipeline" do
+  before(:each) do
+  end
+  
+  it "should generate a pipeline" do
+    pipeline = Flexpay::API.new(:access_key => ACCESS_KEY, :secret_key => SECRET_KEY).get_recurring_pipeline
+    pipeline.should_not be_nil
+  end
+  
+  it "should respond to all required parameters" do
+    pipeline = Flexpay::API.new(:access_key => ACCESS_KEY, :secret_key => SECRET_KEY).get_recurring_pipeline
+    
+    Flexpay::CobrandingAPI::V2009_01_09::RecurringPipeline::get_required_parameters.each do |p|
+      pipeline.should respond_to(p)
+    end
+  end
+  
+  it "should correctly build a parameter hash" do
+    pipeline = Flexpay::API.new(:access_key => ACCESS_KEY, :secret_key => SECRET_KEY).get_recurring_pipeline
+    
+    pipeline.callerReference = Time.now.to_i.to_s
+    pipeline.transactionAmount = "10"
+    pipeline.recurringPeriod = "1 month"
+    pipeline.returnURL = "http://127.0.0.1:3000"
+    # pipeline.callerKey = "AKIAICO3MHOOXACSG2VQ"
+    
+    url = pipeline.generate_url
+    url.should_not be_empty
+  end
+  
+end

data/spec/units/signature_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe Flexpay::Signature do
+  before(:each) do
+    
+  end
+  
+  it "calculate signatures" do
+    
+    params = {"Action" => "Pay", "AWSAccessKeyId" => "AKIAIIFXJCFIHITREP4Q", "CallerDescription" => "MyWish",
+      "CallerReference" => "CallerReference02", "SenderTokenId" => "553ILMLCG6Z8J431H7BX3UMN3FFQU8VSNTSRNCTAASDJNX66LNZLKSZU3PI7TXIH",
+      "SignatureMethod" => "HmacSHA256", "SignatureVersion" => 2, "Timestamp" => "2009-10-06T05%3A49%3A52.843Z",
+      "TransactionAmount.CurrencyCode" => "USD", "TransActionAmount.Value" => 1, "Version" => "2008-09-17",}
+    
+    sig = Flexpay::Signature.generate_signature('GET','fps.sandbox.amazonaws.com',
+      'https://fps.sandbox.amazonaws.com',params, SECRET_KEY)
+      
+    sig.should_not be_empty
+  end
+end

data/spec/units/units_helper.rb

@@ -0,0 +1,5 @@
+ACCESS_KEY = 'foo'
+SECRET_KEY = 'bar'
+API_VERSION = "2009-01-09"
+
+require File.dirname(__FILE__) + '/../spec_helper'

data/spec/units/verify_signature_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe 'VerifySignature' do
+  before(:each) do
+  end
+  
+  it "should correctly build a request" do
+    verify = Flexpay::API.new(:access_key => ACCESS_KEY, :secret_key => SECRET_KEY).get_verify_signature
+    
+    body =<<HEREDOC 
+        <VerifySignatureResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
+          <VerifySignatureResult>
+            <VerificationStatus>Success</VerificationStatus>
+          </VerifySignatureResult>
+          <ResponseMetadata>
+            <RequestId>197e2085-1ed7-47a2-93d8-d76b452acc74:0</RequestId>
+          </ResponseMetadata>
+        </VerifySignatureResponse>
+HEREDOC
+
+    RestClient.stub!(:get).and_return(body)
+    
+    verify.UrlEndPoint = "http%3A%2F%2Fvamsik.desktop.amazon.com%3A8080%2Fipn.jsp"
+    timestamp = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+    verify.HttpParameters = "expiry%3D08%252F2015%26signature%3DynDukZ9%252FG77uSJVb5YM0cadwHVwYKPMKOO3PNvgADbv6VtymgBxeOWEhED6KGHsGSvSJnMWDN%252FZl639AkRe9Ry%252F7zmn9CmiM%252FZkp1XtshERGTqi2YL10GwQpaH17MQqOX3u1cW4LlyFoLy4celUFBPq1WM2ZJnaNZRJIEY%252FvpeVnCVK8VIPdY3HMxPAkNi5zeF2BbqH%252BL2vAWef6vfHkNcJPlOuOl6jP4E%252B58F24ni%252B9ek%252FQH18O4kw%252FUJ7ZfKwjCCI13%252BcFybpofcKqddq8CuUJj5Ii7Pdw1fje7ktzHeeNhF0r9siWcYmd4JaxTP3NmLJdHFRq2T%252FgsF3vK9m3gw%253D%253D%26signatureVersion%3D2%26signatureMethod%3DRSA-SHA1%26certificateUrl%3Dhttps%253A%252F%252Ffps.sandbox.amazonaws.com%252Fcerts%252F090909%252FPKICert.pem%26tokenID%3DA5BB3HUNAZFJ5CRXIPH72LIODZUNAUZIVP7UB74QNFQDSQ9MN4HPIKISQZWPLJXF%26status%3DSC%26callerReference%3DcallerReferenceMultiUse1&AWSAccessKeyId=AKIAJGC2KB2QP7MVBLYQ&Timestamp=#{timestamp.gsub(':','%3A')}&Version=2008-09-17&SignatureVersion=2&SignatureMethod=HmacSHA256&Signature=fKRGL42K7nduDA47g6bJCyUyF5ZvkBotXE5jVcgyHvE%3D"
+    
+    result = verify.go!(false)
+    result.should have_key(:VerificationStatus)
+    result[:VerificationStatus].should == "Success"
+  end
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: flexpay
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Chandler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: chris@flatterline.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flexpay.rb
+- lib/flexpay/api_module.rb
+- lib/flexpay/cobranding_api/v2009_01_09.rb
+- lib/flexpay/cobranding_api/v2009_01_09/pipelines.rb
+- lib/flexpay/exceptions.rb
+- lib/flexpay/fps_api/v2008_09_17.rb
+- lib/flexpay/fps_api/v2008_09_17/pay.rb
+- lib/flexpay/fps_api/v2008_09_17/verify_signature.rb
+- lib/flexpay/request.rb
+- lib/flexpay/util.rb
+has_rdoc: true
+homepage: http://github.com/cchandler/flexpay
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An API for using the Amazon Flexible Payment Service (FPS).
+test_files: 
+- spec/units/api_spec.rb
+- spec/units/pay_spec.rb
+- spec/units/recurring_pipeline_spec.rb
+- spec/units/signature_spec.rb
+- spec/units/verify_signature_spec.rb
+- spec/integrations/integrations_helper.rb
+- spec/spec_helper.rb
+- spec/units/units_helper.rb