dbalatero-fpswax 0.0.1 → 0.0.2

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.authors = ["David Balatero"]
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('nokogiri', '>= 1.2.3')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

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

data/lib/fpswax/mixins/hmac_signature.rb

@@ -6,7 +6,7 @@ module Fpswax
     module HmacSignature
       private
       def generate_signature_for(params, secret_key)
-        query   = params.sort_by { |k,v| k.downcase }
+        query   = params.sort_by { |k,v| k.to_s.downcase }
         digest  = OpenSSL::Digest::Digest.new('sha1')
         hmac    = OpenSSL::HMAC.digest(digest, secret_key, query.to_s)
         encoded = Base64.encode64(hmac).chomp

data/lib/fpswax/pay_response.rb

@@ -0,0 +1,34 @@
+module Fpswax
+  class PayResponse < Response
+    attr_reader :transaction_id
+    attr_reader :transaction_status
+
+    def initialize(xml)
+      super(xml)
+      if valid?
+        @transaction_id = xml.css('PayResult TransactionId')[0].content rescue nil
+        @transaction_status = xml.css('PayResult TransactionStatus')[0].content rescue nil
+      end
+    end
+
+    def cancelled?
+      @transaction_status == 'Cancelled'
+    end
+
+    def failure?
+      @transaction_status == 'Failure'
+    end
+
+    def pending?
+      @transaction_status == 'Pending'
+    end
+
+    def reserved?
+      @transaction_status == 'Reserved'
+    end
+
+    def success?
+      @transaction_status == 'Success'
+    end
+  end
+end

data/lib/fpswax/response.rb

@@ -10,14 +10,14 @@ module Fpswax
       end
 
       if @errors.empty?
-        @request_id = xml.css('RequestId')[0].content
+        @request_id = xml.css('RequestId')[0].content rescue nil
       else
-        @request_id = xml.css('RequestID')[0].content
+        @request_id = xml.css('RequestID')[0].content rescue nil
       end
     end
 
     def valid?
-      @errors.empty?
+      @request_id && @errors.empty?
     end
   end
 end

data/lib/fpswax/session.rb

@@ -7,16 +7,25 @@ module Fpswax
 
     include Mixins::HmacSignature
 
+    attr_accessor :logger
+
     def initialize(access_key, secret_key, sandbox = true)
       @access_key = access_key
       @secret_key = secret_key
       @sandbox = sandbox
+
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::WARN
     end
 
     def in_sandbox?
       @sandbox
     end
 
+    def fps_url
+      @sandbox ? 'https://fps.sandbox.amazonaws.com' : 'https://fps.amazonaws.com'
+    end
+
     def api_version
       API_VERSION
     end
@@ -31,12 +40,60 @@ module Fpswax
       validate_required?(params,
                          :CallerReference,
                          :SenderTokenId,
-                         :TransactionAmount)
+                         :"TransactionAmount.CurrencyCode",
+                         :"TransactionAmount.Value")
 
-      #get_response('Pay', PayResponse, params)
+      get_response(:Pay, PayResponse, params)
     end
 
     private
+    def get_response(action, response_klass, params)
+      add_params_for_request!(action, params)
+      response = self.class.post(fps_url,
+                                 :params => params)
+
+      @logger.debug("get_response") {
+        "Got XML response:\n#{response.body}"
+      }
+
+      response_klass.new(Nokogiri::XML(response.body))
+    end
+
+    def self.post(url, options = {})
+      url = URI.parse(url) if url.is_a?(String)
+      conn = Net::HTTP.new(url.host, url.port)
+      if conn.port == 443
+        conn.use_ssl = true
+      end
+
+      req = Net::HTTP::Post.new(url.request_uri)
+      req.form_data = options[:params]
+
+      conn.start do |http|
+        http.request(req)
+      end
+    end
+
+    def add_params_for_request!(action, params)
+      # Required params for all requests:
+      # http://docs.amazonwebservices.com/AmazonFPS/latest/FPSAdvancedGuide/CommonRequestParameters.html
+      params.merge!(:Action => action,
+                    :AWSAccessKeyId => @access_key,
+                    :SignatureVersion => 1,
+                    :Timestamp => Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ'),
+                    :Version => api_version)
+
+      # Generate an HMAC signature.
+      signature = generate_signature_for(params, @secret_key)
+      params[:Signature] = signature
+
+      @logger.debug('add_params_for_request!') do
+        "Params for request (#{action}): #{params.inspect}"
+      end
+
+      params
+    end
+
     def validate_required?(hash, *args)
       args.each do |arg|
         raise(ParameterRequired, "This method requires #{arg} to be passed in!") if !hash[arg]

data/lib/fpswax.rb

@@ -1,7 +1,11 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
+require 'logger'
 require 'openssl'
 require 'nokogiri'
+require 'net/http'
+require 'net/https'
+require 'uri'
 
 require 'fpswax/mixins/hmac_signature'
 
@@ -10,5 +14,7 @@ require 'fpswax/ipn_request'
 require 'fpswax/response'
 require 'fpswax/session'
 
+require 'fpswax/pay_response'
+
 module Fpswax
 end

data/spec/fixtures/pay/cancelled.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<PayResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/"><PayResult><TransactionId>145ST343M4FVUENSE545EV1BL7H6OU421QP</TransactionId><TransactionStatus>Cancelled</TransactionStatus></PayResult><ResponseMetadata><RequestId>49da36a0-732a-4180-b0dd-c22fe2e0dd0b:0</RequestId></ResponseMetadata></PayResponse>

data/spec/fixtures/pay/error.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: NOGNOOLIE</Message></Error></Errors><RequestID>92c73846-af37-4b36-8f31-78a26d6ea65c</RequestID></Response>

data/spec/fixtures/pay/failure.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<PayResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/"><PayResult><TransactionId>145ST343M4FVUENSE545EV1BL7H6OU421QP</TransactionId><TransactionStatus>Failure</TransactionStatus></PayResult><ResponseMetadata><RequestId>49da36a0-732a-4180-b0dd-c22fe2e0dd0b:0</RequestId></ResponseMetadata></PayResponse>

data/spec/fixtures/pay/pending.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<PayResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/"><PayResult><TransactionId>145ST343M4FVUENSE545EV1BL7H6OU421QP</TransactionId><TransactionStatus>Pending</TransactionStatus></PayResult><ResponseMetadata><RequestId>49da36a0-732a-4180-b0dd-c22fe2e0dd0b:0</RequestId></ResponseMetadata></PayResponse>

data/spec/fixtures/pay/reserved.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<PayResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/"><PayResult><TransactionId>145ST343M4FVUENSE545EV1BL7H6OU421QP</TransactionId><TransactionStatus>Reserved</TransactionStatus></PayResult><ResponseMetadata><RequestId>49da36a0-732a-4180-b0dd-c22fe2e0dd0b:0</RequestId></ResponseMetadata></PayResponse>

data/spec/fixtures/pay/success.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<PayResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/"><PayResult><TransactionId>145ST343M4FVUENSE545EV1BL7H6OU421QP</TransactionId><TransactionStatus>Success</TransactionStatus></PayResult><ResponseMetadata><RequestId>49da36a0-732a-4180-b0dd-c22fe2e0dd0b:0</RequestId></ResponseMetadata></PayResponse>

data/spec/fpswax/mixins/hmac_signature_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Fpswax::Mixins::HmacSignature do
+  include Fpswax::Mixins::HmacSignature
+
+  describe "generate_signature_for" do
+    it "should accept symboled keys" do
+      lambda {
+        generate_signature_for({:key1 => 'ok'}, 'my key')
+      }.should_not raise_error
+    end
+  end
+end

data/spec/fpswax/pay_response_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Fpswax::PayResponse do
+  it "should be a Response" do
+    pay = Fpswax::PayResponse.new(mock_xml)
+    pay.should be_a_kind_of(Fpswax::Response)
+  end
+
+  it "should handle errors correctly" do
+    pay = Fpswax::PayResponse.new(fixture_raw_xml('pay/error.xml'))
+    pay.should_not be_valid
+    pay.errors.should have(1).thing
+  end
+
+  describe "any pay response" do
+    before(:each) do
+      @pay = Fpswax::PayResponse.new(fixture_raw_xml('pay/pending.xml'))
+    end
+
+    it "should have its transaction status" do
+      @pay.transaction_status.should == 'Pending'
+    end
+
+    it "should have its transaction ID" do
+      @pay.transaction_id.should == '145ST343M4FVUENSE545EV1BL7H6OU421QP'
+    end
+  end
+
+  ['cancelled', 'failure', 'pending', 'reserved', 'success'].each do |status|
+    describe "a pending pay response" do
+      before(:each) do
+        @pay = Fpswax::PayResponse.new(fixture_raw_xml("pay/#{status}.xml"))
+      end
+
+      it "should be valid" do
+        @pay.should be_valid
+      end
+
+      it "should be #{status}" do
+        @pay.send("#{status}?".to_sym).should be_true
+      end
+    end
+  end
+end

data/spec/fpswax/response_spec.rb

@@ -31,5 +31,10 @@ describe Fpswax::Response do
       response = Fpswax::Response.new(xml)
       response.should_not be_valid
     end
+
+    it "should be false if there was no parsed request id" do
+      response = Fpswax::Response.new(mock_xml)
+      response.should_not be_valid
+    end
   end
 end

data/spec/fpswax/session_spec.rb

@@ -1,6 +1,10 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Fpswax::Session do
+  before(:each) do
+    FakeWeb.clean_registry
+  end
+
   describe "initialize" do
     it "should take an access key, private key" do
       lambda {
@@ -45,14 +49,18 @@ describe Fpswax::Session do
       @valid_params = { 
         :CallerReference => 'a',
         :SenderTokenId => 'b',
-        :TransactionAmount => 'c'
+        :"TransactionAmount.CurrencyCode" => 'USD',
+        :"TransactionAmount.Value" => 'c'
       }
     end
 
     it "should return a PayResponse" do
-      pending
+      FakeWeb.register_uri(:post,
+                           'https://fps.sandbox.amazonaws.com:443/',
+                           :file => fixture_path('pay/success.xml'))
       response = @session.pay(@valid_params)
-      response.should be_an_instance_of(PayResponse)
+      response.should be_an_instance_of(Fpswax::PayResponse)
+      response.should be_valid
     end
 
     describe "should validate parameters" do
@@ -72,5 +80,35 @@ describe Fpswax::Session do
         }.should_not raise_error(Fpswax::Session::ParameterRequired)
       end
     end
+
+    describe "fps_url" do
+      it "should point at the production API if we are in production" do
+        session = Fpswax::Session.new('a', 'b', false)
+        session.should_not be_in_sandbox
+        session.fps_url.should == 'https://fps.amazonaws.com'
+      end
+
+      it "should point at the sandbox API if we aren't in production" do
+        session = Fpswax::Session.new('a', 'b', true)
+        session.should be_in_sandbox
+        session.fps_url.should == 'https://fps.sandbox.amazonaws.com'
+      end
+    end
+
+    describe "logger" do
+      before(:each) do
+        @session = Fpswax::Session.new('a', 'b')
+      end
+
+      it "should return a logger object" do
+        @session.logger.should be_a_kind_of(Logger)
+      end
+
+      it "should be able to be set to something else" do
+        lambda {
+          @session.logger = Logger.new(STDOUT)
+        }.should_not raise_error
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,13 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'fpswax'
 
+begin
+  require 'fakeweb'
+  FakeWeb.allow_net_connect = false
+rescue LoadError
+  abort "You need fakeweb installed to run specs. gem install fakeweb."
+end
+
 Spec::Runner.configure do |config|
   
 end
@@ -15,3 +22,7 @@ end
 def fixture_raw_xml(path)
   Nokogiri::XML(File.read(fixture_path(path)))
 end
+
+def mock_xml
+  Nokogiri::XML("<id>2</id>")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dbalatero-fpswax
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Balatero
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-23 00:00:00 -07:00
+date: 2009-05-25 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
 description: 
 email: david@bitwax.cd
 executables: []
@@ -31,12 +40,21 @@ files:
 - lib/fpswax/error.rb
 - lib/fpswax/ipn_request.rb
 - lib/fpswax/mixins/hmac_signature.rb
+- lib/fpswax/pay_response.rb
 - lib/fpswax/response.rb
 - lib/fpswax/session.rb
+- spec/fixtures/pay/cancelled.xml
+- spec/fixtures/pay/error.xml
+- spec/fixtures/pay/failure.xml
+- spec/fixtures/pay/pending.xml
+- spec/fixtures/pay/reserved.xml
+- spec/fixtures/pay/success.xml
 - spec/fixtures/raw/errors.xml
 - spec/fixtures/raw/request_id.xml
 - spec/fpswax/error_spec.rb
 - spec/fpswax/ipn_request_spec.rb
+- spec/fpswax/mixins/hmac_signature_spec.rb
+- spec/fpswax/pay_response_spec.rb
 - spec/fpswax/response_spec.rb
 - spec/fpswax/session_spec.rb
 - spec/spec_helper.rb
@@ -69,6 +87,8 @@ 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/mixins/hmac_signature_spec.rb
+- spec/fpswax/pay_response_spec.rb
 - spec/fpswax/response_spec.rb
 - spec/fpswax/session_spec.rb
 - spec/spec_helper.rb