dbalatero-fpswax 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Balatero <david@bitwax.cd>
+
+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
+NONINFRINGEMENT. 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/README.rdoc

@@ -0,0 +1,9 @@
+= fpswax
+
+This allows for integration with Amazon FPS in the common-case. 
+This is not a full implementation yet. Remit has *an* implementation,
+but it is highly out of date, and a bit too clever for my taste.
+
+== Copyright
+
+Copyright (c) 2009 David Balatero. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fpswax"
+    gem.summary = %Q{A library for interfacing with Amazon FPS, without any "cleverness".}
+    gem.email = "david@bitwax.cd"
+    gem.homepage = "http://github.com/dbalatero/fpswax"
+    gem.authors = ["David Balatero"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fpswax #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 1
+:major: 0

data/lib/fpswax/error.rb

@@ -0,0 +1,9 @@
+module Fpswax
+  class Error
+    attr_reader :code, :message
+    def initialize(code, message)
+      @code = code
+      @message = message
+    end
+  end
+end

data/lib/fpswax/ipn_request.rb

@@ -0,0 +1,24 @@
+module Fpswax
+  class IpnRequest
+    include Mixins::HmacSignature
+
+    def initialize(params, secret_key)
+      @signature = params.delete('signature')
+      strip_keys_from!(params, 'action', 'controller')
+      @params = params
+      @secret_key = secret_key
+    end
+
+    def valid?
+      return false if !@signature
+      generate_signature_for(@params, @secret_key) == @signature
+    end
+
+    private
+    def strip_keys_from!(hash, *keys)
+      keys.each do |key|
+        hash.delete(key)
+      end
+    end
+  end
+end

data/lib/fpswax/mixins/hmac_signature.rb

@@ -0,0 +1,16 @@
+require 'base64'
+require 'openssl/digest'
+
+module Fpswax
+  module Mixins
+    module HmacSignature
+      private
+      def generate_signature_for(params, secret_key)
+        query   = params.sort_by { |k,v| k.downcase }
+        digest  = OpenSSL::Digest::Digest.new('sha1')
+        hmac    = OpenSSL::HMAC.digest(digest, secret_key, query.to_s)
+        encoded = Base64.encode64(hmac).chomp
+      end
+    end
+  end
+end

data/lib/fpswax/response.rb

@@ -0,0 +1,23 @@
+module Fpswax
+  class Response
+    attr_reader :request_id, :errors
+    def initialize(xml)
+      # parse any errors
+      @errors = xml.css('Response Errors Error').map do |error|
+        code = error.css('Code')[0].content
+        message = error.css('Message')[0].content
+        Fpswax::Error.new(code, message)
+      end
+
+      if @errors.empty?
+        @request_id = xml.css('RequestId')[0].content
+      else
+        @request_id = xml.css('RequestID')[0].content
+      end
+    end
+
+    def valid?
+      @errors.empty?
+    end
+  end
+end

data/lib/fpswax/session.rb

@@ -0,0 +1,50 @@
+module Fpswax
+  class Session
+    class ParameterRequired < ArgumentError; end
+
+    API_VERSION = '2008-09-17'
+    CBUI_API_VERSION = '2009-01-09'
+
+    include Mixins::HmacSignature
+
+    def initialize(access_key, secret_key, sandbox = true)
+      @access_key = access_key
+      @secret_key = secret_key
+      @sandbox = sandbox
+    end
+
+    def in_sandbox?
+      @sandbox
+    end
+
+    def api_version
+      API_VERSION
+    end
+
+    def cbui_api_version
+      CBUI_API_VERSION
+    end
+
+    # operations
+    # See: http://docs.amazonwebservices.com/AmazonFPS/2008-09-17/FPSAdvancedGuide/Pay.html
+    def pay(params)
+      validate_required?(params,
+                         :CallerReference,
+                         :SenderTokenId,
+                         :TransactionAmount)
+
+      #get_response('Pay', PayResponse, params)
+    end
+
+    private
+    def validate_required?(hash, *args)
+      args.each do |arg|
+        raise(ParameterRequired, "This method requires #{arg} to be passed in!") if !hash[arg]
+      end
+    end
+
+    def make_request(params)
+
+    end
+  end
+end

data/lib/fpswax.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require 'openssl'
+require 'nokogiri'
+
+require 'fpswax/mixins/hmac_signature'
+
+require 'fpswax/error'
+require 'fpswax/ipn_request'
+require 'fpswax/response'
+require 'fpswax/session'
+
+module Fpswax
+end

data/spec/fixtures/raw/errors.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<Response><Errors><Error><Code>InvalidParams</Code><Message>"senderTokenId" has to be a valid token ID. Specified value: MY_TESTING_BAD_VALUE</Message></Error></Errors><RequestID>22dd4385-c7ac-4ea4-813f-e1452694abcc</RequestID></Response>

data/spec/fixtures/raw/request_id.xml

@@ -0,0 +1,9 @@
+<PayResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
+  <PayResult>
+    <TransactionId>13N8UPFET32I4I7FCF9T4ZKFETETINTK56Q</TransactionId>
+    <TransactionStatus>Pending</TransactionStatus>
+  </PayResult>
+  <ResponseMetadata>
+    <RequestId>b415f09d-5924-4315-b31a-21c977c85c39:0</RequestId>
+  </ResponseMetadata>
+</PayResponse>

data/spec/fpswax/error_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Fpswax::Error do
+  describe "initialize" do
+    it "should require a code and a message" do
+      lambda {
+        Fpswax::Error.new('code', 'message')
+      }.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe "code" do
+    it "should be whatever is passed into the constructor" do
+      error = Fpswax::Error.new('mycode', 'msg')
+      error.code.should == 'mycode'
+    end
+  end
+
+  describe "message" do
+    it "should be whatever is passed into the constructor" do
+      error = Fpswax::Error.new('mycode', 'msg')
+      error.message.should == 'msg'
+    end
+  end
+end

data/spec/fpswax/ipn_request_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Fpswax::IpnRequest do
+  before(:each) do
+    @test_key = 'mykey'
+  end
+
+  describe "initialize" do
+    it "should require a params hash and secret key" do
+      lambda {
+        Fpswax::IpnRequest.new({}, @test_key)
+      }.should_not raise_error
+    end
+  end
+
+  describe "valid?" do
+    it "should be false if no signature is provided" do
+      req = Fpswax::IpnRequest.new({}, @test_key)
+      req.should_not be_valid
+    end
+
+    it "should be false if the signature doesn't match up" do
+      req = Fpswax::IpnRequest.new({'signature' => 'bad', 'param1' => 'ok'}, @test_key)
+      req.should_not be_valid
+    end
+
+    it "should be true if the signature does match up" do
+      good_params = {
+        "tokenID" => "N1CHGCG13NNB4JMVJN1Q1JXIKBQDO4DQ595NRSCTILAU47P7GA7JVQMMJNXRUJFM", 
+        "callerReference" => "44441234567fdsa44",
+        "action" => "amazon_return",
+        "signature" => "uoOmSftU4gnUMK6Q1ylyGnr5hEw=",
+        "controller" => "checkout",
+        "expiry" => "10/2014",
+        "status" => "SC"
+      }
+
+      req = Fpswax::IpnRequest.new(good_params, @test_key)
+      req.should be_valid
+    end
+  end
+end

data/spec/fpswax/response_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Fpswax::Response do
+  describe "request_id" do
+    it "should successfully be parsed from a response" do
+      xml = fixture_raw_xml('raw/request_id.xml')
+      response = Fpswax::Response.new(xml)
+      response.request_id.should == 'b415f09d-5924-4315-b31a-21c977c85c39:0'
+      response.should be_valid
+    end
+  end
+
+  describe "errors" do
+    it "should return any errors that were present in the XML response" do
+      xml = fixture_raw_xml('raw/errors.xml')
+      response = Fpswax::Response.new(xml)
+
+      response.errors.should have_at_least(1).thing
+    end
+  end
+
+  describe "valid" do
+    it "should be true if there are no errors" do
+      xml = fixture_raw_xml('raw/request_id.xml')
+      response = Fpswax::Response.new(xml)
+      response.should be_valid
+    end
+
+    it "should be false if there are errors" do
+      xml = fixture_raw_xml("raw/errors.xml")
+      response = Fpswax::Response.new(xml)
+      response.should_not be_valid
+    end
+  end
+end

data/spec/fpswax/session_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Fpswax::Session do
+  describe "initialize" do
+    it "should take an access key, private key" do
+      lambda {
+        Fpswax::Session.new('a', 'b')
+      }.should_not raise_error
+    end
+
+    it "should also be allowed to operate in sandbox mode" do
+      lambda {
+        Fpswax::Session.new('a', 'b', true)
+      }.should_not raise_error
+    end
+  end
+
+  describe "in_sandbox?" do
+    it "should by default be in sandbox mode" do
+      session = Fpswax::Session.new('a', 'b')
+      session.should be_in_sandbox
+    end
+
+    it "should not be in sandbox if sandbox is passed in as false" do
+      session = Fpswax::Session.new('a', 'b', false)
+      session.should_not be_in_sandbox
+    end
+  end
+
+  describe "api_version" do
+    it "should be 2008-09-17" do
+      session = Fpswax::Session.new('a', 'b', false)
+      session.api_version.should == '2008-09-17'
+    end
+  end
+
+  describe "cbui_api_version" do
+    session = Fpswax::Session.new('a', 'b', false)
+    session.cbui_api_version.should == '2009-01-09'
+  end
+
+  describe "pay" do
+    before(:each) do
+      @session = Fpswax::Session.new('a', 'b', true)
+      @valid_params = { 
+        :CallerReference => 'a',
+        :SenderTokenId => 'b',
+        :TransactionAmount => 'c'
+      }
+    end
+
+    it "should return a PayResponse" do
+      pending
+      response = @session.pay(@valid_params)
+      response.should be_an_instance_of(PayResponse)
+    end
+
+    describe "should validate parameters" do
+      it "and raise an error if no valid params are passed" do
+        @valid_params.keys.each do |key|
+          bad_params = @valid_params.dup
+          bad_params.delete(key)
+          lambda {
+            @session.pay(bad_params)
+          }.should raise_error(Fpswax::Session::ParameterRequired)
+        end
+      end
+
+      it "and not raise an error if valid params are passed" do
+        lambda {
+          @session.pay(@valid_params)
+        }.should_not raise_error(Fpswax::Session::ParameterRequired)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'fpswax'
+
+Spec::Runner.configure do |config|
+  
+end
+
+def fixture_path(path)
+  File.join(File.dirname(__FILE__), "fixtures", path)
+end
+
+def fixture_raw_xml(path)
+  Nokogiri::XML(File.read(fixture_path(path)))
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: dbalatero-fpswax
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Balatero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: david@bitwax.cd
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/fpswax.rb
+- lib/fpswax/error.rb
+- lib/fpswax/ipn_request.rb
+- lib/fpswax/mixins/hmac_signature.rb
+- lib/fpswax/response.rb
+- lib/fpswax/session.rb
+- spec/fixtures/raw/errors.xml
+- spec/fixtures/raw/request_id.xml
+- spec/fpswax/error_spec.rb
+- spec/fpswax/ipn_request_spec.rb
+- spec/fpswax/response_spec.rb
+- spec/fpswax/session_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dbalatero/fpswax
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A library for interfacing with Amazon FPS, without any "cleverness".
+test_files: 
+- spec/fpswax/error_spec.rb
+- spec/fpswax/ipn_request_spec.rb
+- spec/fpswax/response_spec.rb
+- spec/fpswax/session_spec.rb
+- spec/spec_helper.rb