saferpay 0.1.0.pre

data/spec/saferpay/api_responses_spec.rb

@@ -0,0 +1,83 @@
+shared_examples_for 'the get payment url response' do
+  let(:response) { subject.get_payment_url(options) }
+
+  it 'is a string' do
+    expect(response).to be_a String
+  end
+
+  it 'contains the payment url' do
+    expect(response).to match /^https:\/\/www.saferpay.com\/.+/
+  end
+end
+
+shared_examples_for 'the verify pay confirm response' do
+  let(:response) { subject.handle_pay_confirm(options) }
+
+  it 'is an hash' do
+    expect(response).to be_an Hash
+  end
+
+  it 'contains normalized keys' do
+    expect(response.keys).to include(:id, :callback_data, :token)
+  end
+
+  it 'contains the id' do
+    expect(response[:id]).to match /\w{28}/
+  end
+
+  it 'contains callback data' do
+    expect(response[:callback_data]).not_to be_nil
+  end
+
+  describe 'the callback data' do
+    let(:callback_data) { response[:callback_data] }
+
+    it 'is an hash' do
+      expect(callback_data).to be_an Hash
+    end
+
+    it 'contains normalized keys' do
+      expect(callback_data.keys).to include(:data, :signature)
+    end
+
+    it 'contains the XML data' do
+      expect(callback_data[:data]).to be_an Hash
+    end
+
+    it 'contains the expected Message Type' do
+      expect(callback_data[:data][:msgtype]).to eq 'PayConfirm'
+    end
+
+    it 'contains the expected Account ID' do
+      expect(callback_data[:data][:accountid]).to eq subject.account_id
+    end
+
+    it 'contains the expected Amount' do
+      expect(callback_data[:data][:amount]).to eq '1000'
+    end
+  end
+end
+
+shared_examples_for 'the complete payment response' do
+  let(:response) { subject.complete_payment(options) }
+
+  it 'is an hash' do
+    expect(response).to be_an Hash
+  end
+
+  it 'contains normalized keys' do
+    expect(response.keys).to include(:id, :successful, :result, :msgtype)
+  end
+
+  it 'contains the id' do
+    expect(response[:id]).to eq options['ID']
+  end
+
+  it 'specifies if the request was successfully processed' do
+    expect(response[:successful]).to be_true
+  end
+
+  it 'contains the expected Message Type' do
+    expect(response[:msgtype]).to eq 'PayConfirm'
+  end
+end

data/spec/saferpay/api_spec.rb

@@ -0,0 +1,264 @@
+require 'spec_helper'
+require 'saferpay'
+
+shared_examples_for 'default redefinition' do
+  context 'when account_id is redefined' do
+    let (:redefined_options) { options.merge( {'ACCOUNTID' => 'random-ID'} ) }
+    
+    it 'uses the new value instead of the default' do
+      expect(subject.class).to receive(:get).with anything, { :query => redefined_options }
+      subject.send(testing_method, redefined_options) rescue nil # don't care if it fails after
+    end
+  end
+end
+
+describe Saferpay::API do
+  subject { Saferpay::API.new }
+
+  before do
+    VCR.insert_cassette 'saferpay_api', :record => :new_episodes
+  end
+ 
+  after do
+    VCR.eject_cassette
+  end
+  
+  describe 'configuration' do
+    context 'by default' do
+      Saferpay::Configuration::DEFAULTS.each do |key, val|
+        its(key) { should eq(val) }
+      end
+    end
+
+    context 'with a custom global configuration' do
+      Saferpay::Configuration::VALID_CONFIG_KEYS.each do |key|
+        before(:each) { Saferpay.configure { |config| config.send "#{key}=", key } }
+
+        it "passes the user-defined global #{key} to the API instance" do
+          expect(subject.send(key)).to eq(key)
+        end
+      end
+    end
+  end
+
+  describe 'HTTParty configuration' do
+    subject { Saferpay::API }
+    
+    it 'includes HTTParty' do
+      expect(subject).to include(HTTParty)
+    end
+
+    context 'with default endpoint' do
+      subject { Saferpay::API.new.class }
+      its(:base_uri) { should eq Saferpay::Configuration::DEFAULTS[:endpoint] }
+    end
+
+    context 'with custom endpoint (via params)' do
+      subject { Saferpay::API.new(:endpoint => 'http://example.com').class }
+      its(:base_uri) { should_not eq 'http://example.com' }
+    end
+  end
+
+  describe 'GET payment url' do
+
+    context 'when amount is missing' do
+      let (:options) { {} }
+      it 'raises Missing AMOUNT error' do
+        expect { subject.get_payment_url(options) }.to raise_error(Saferpay::Error::BadRequest, 'Missing AMOUNT attribute')
+      end
+    end
+
+    context 'when currency is missing' do
+      let (:options) { {'AMOUNT' => 1000} }
+      it 'raises Missing CURRENCY error' do
+        expect { subject.get_payment_url(options) }.to raise_error(Saferpay::Error::BadRequest, 'Missing CURRENCY attribute')
+      end
+    end
+
+    context 'when description is missing' do
+      let (:options) { {'AMOUNT' => 1000, 'CURRENCY' => 'EUR'} }
+      it 'raises Missing DESCRIPTION error' do
+        expect { subject.get_payment_url(options) }.to raise_error(Saferpay::Error::BadRequest, 'Missing DESCRIPTION attribute')
+      end
+    end
+
+    context 'when amount, currency and description are defined' do
+      let (:options) { {'AMOUNT' => 1000, 'CURRENCY' => 'EUR', 'DESCRIPTION' => 'Test description.'} }
+
+      it 'does not raise an error' do
+        expect { subject.get_payment_url(options) }.not_to raise_error
+      end
+
+      it_behaves_like 'the get payment url response'
+
+      include_examples 'default redefinition' do
+        let (:testing_method) { :get_payment_url }
+      end
+    end
+
+  end
+
+  context 'when directly accessing a non-existent URL' do
+
+    %w(GET POST HEAD).each do |method|
+      context "via #{method}" do
+        it 'raises 404 NotFound error' do
+          expect { subject.class.send(method.downcase, '/foobar') }.to raise_error(Saferpay::Error::NotFound, 'Not Found')
+        end
+      end
+    end
+
+    %w(PUT DELETE MOVE COPY).each do |method|
+      context "via #{method}" do
+        it 'raises 405 MethodNotAllowed error' do
+          expect { subject.class.send(method.downcase, '/foobar') }.to raise_error(Saferpay::Error, 'Method Not Allowed')
+        end
+      end
+    end
+  end
+
+  describe 'GET verify pay confirm' do
+
+    context 'when data is missing' do
+      let (:options) { {} }
+      it 'raises Missing DATA error' do
+        expect { subject.handle_pay_confirm(options) }.to raise_error(Saferpay::Error::BadRequest, 'Missing DATA attribute')
+      end
+    end
+
+    context 'when signature is missing' do
+      let (:options) { {'DATA' => 'test-data'} }
+      it 'raises Missing SIGNATURE error' do
+        expect { subject.handle_pay_confirm(options) }.to raise_error(Saferpay::Error::BadRequest, 'Missing SIGNATURE attribute')
+      end
+    end
+
+    context 'when data and signature are defined' do
+
+      context 'when data is not valid XML' do
+        let (:options) { {'DATA' => 'test-data', 'SIGNATURE' => 'test-signature'} }
+        it 'raises could not load DATA XML error' do
+          expect { subject.handle_pay_confirm(options) }.to raise_error(Saferpay::Error::BadRequest, 'Could not load DATA XML')
+        end
+      end
+
+      context 'when data and signature don\'t match' do
+        let (:options) { {'DATA' => URI.encode('<IDP MSGTYPE="PayConfirm" TOKEN="(unused)" VTVERIFY="(obsolete)" KEYID="1-0" ID="A668MSAprOj4tAzv7G9lAQUfUr3A" ACCOUNTID="99867-94913159" PROVIDERID="90" PROVIDERNAME="Saferpay Test Card" ORDERID="123456789-001" AMOUNT="1000" CURRENCY="EUR" IP="193.247.180.193" IPCOUNTRY="CH" CCCOUNTRY="XX" MPI_LIABILITYSHIFT="yes" MPI_TX_CAVV="AAABBIIFmAAAAAAAAAAAAAAAAAA=" MPI_XID="CxMTYwhoUXtCBAEndBULcRIQaAY=" ECI="1" CAVV="AAABBIIFmAAAAAAAAAAAAAAAAAA=" XID="CxMTYwhoUXtCBAEndBULcRIQaAY=" />'), 'SIGNATURE' => 'test-signature'} }
+        it 'raises generic error' do
+          expect { subject.handle_pay_confirm(options) }.to raise_error(Saferpay::Error::BadRequest, 'An Error occurred')
+        end
+      end
+
+      context 'when data and signature match' do
+        let (:options) { {'DATA' => URI.encode('<IDP MSGTYPE="PayConfirm" TOKEN="(unused)" VTVERIFY="(obsolete)" KEYID="1-0" ID="A668MSAprOj4tAzv7G9lAQUfUr3A" ACCOUNTID="99867-94913159" PROVIDERID="90" PROVIDERNAME="Saferpay Test Card" ORDERID="123456789-001" AMOUNT="1000" CURRENCY="EUR" IP="193.247.180.193" IPCOUNTRY="CH" CCCOUNTRY="XX" MPI_LIABILITYSHIFT="yes" MPI_TX_CAVV="AAABBIIFmAAAAAAAAAAAAAAAAAA=" MPI_XID="CxMTYwhoUXtCBAEndBULcRIQaAY=" ECI="1" CAVV="AAABBIIFmAAAAAAAAAAAAAAAAAA=" XID="CxMTYwhoUXtCBAEndBULcRIQaAY=" />'), 'SIGNATURE' => '7b2bb163f4ef86d969d992b4e2d61ad48d3b9022e0ec68177e35fe53184e6b3399730d1a3641d2a984ce38699daad72ab006d5d6a9565c5ae1cff8bdc8a1eb63'} }
+        
+        it 'does not raise an error' do
+          expect { subject.handle_pay_confirm(options) }.not_to raise_error
+        end
+
+        it_behaves_like 'the verify pay confirm response'
+
+        describe 'the original options parameter' do
+          subject { Saferpay::API.new(:account_id => '99867-94913159') }
+
+          context 'when nothing matches' do
+            subject { Saferpay::API.new(:account_id => '123123') }
+            let (:original_options) { {} }
+            it 'raises Possible Manipulation error' do
+              expect { subject.handle_pay_confirm(options, original_options) }.to raise_error(Saferpay::Error::BadRequest, 'Possible manipulation - AMOUNT, CURRENCY, ORDERID, ACCOUNTID not matching')
+            end
+          end
+
+          context 'when amount doesn\'t match' do
+            let (:original_options) { { 'CURRENCY' => 'EUR', 'ORDERID' => '123456789-001' } }
+            it 'raises Possible Manipulation error' do
+              expect { subject.handle_pay_confirm(options, original_options) }.to raise_error(Saferpay::Error::BadRequest, 'Possible manipulation - AMOUNT not matching')
+            end
+          end
+
+          context 'when currency doesn\'t match' do
+            let (:original_options) { { 'AMOUNT' => '1000', 'ORDERID' => '123456789-001' } }
+            it 'raises Possible Manipulation error' do
+              expect { subject.handle_pay_confirm(options, original_options) }.to raise_error(Saferpay::Error::BadRequest, 'Possible manipulation - CURRENCY not matching')
+            end
+          end
+
+          context 'when orderid doesn\'t match' do
+            let (:original_options) { { 'AMOUNT' => '1000', 'CURRENCY' => 'EUR', 'ORDERID' => 'random' } }
+            it 'raises Possible Manipulation error' do
+              expect { subject.handle_pay_confirm(options, original_options) }.to raise_error(Saferpay::Error::BadRequest, 'Possible manipulation - ORDERID not matching')
+            end
+          end
+
+          context 'when account_id doesn\'t match' do
+            subject { Saferpay::API.new(:account_id => '123123') }
+            let (:original_options) { { 'AMOUNT' => '1000', 'CURRENCY' => 'EUR', 'ORDERID' => '123456789-001' } }
+            it 'raises Possible Manipulation error' do
+              expect { subject.handle_pay_confirm(options, original_options) }.to raise_error(Saferpay::Error::BadRequest, 'Possible manipulation - ACCOUNTID not matching')
+            end
+          end
+
+          context 'when everything matches' do
+            let (:original_options) { { 'AMOUNT' => '1000', 'CURRENCY' => 'EUR', 'ORDERID' => '123456789-001' } }
+            it 'does not raise an error' do
+              expect { subject.handle_pay_confirm(options, original_options) }.not_to raise_error
+            end
+          end
+
+        end
+      end
+
+      context 'when more than data and signature are defined' do
+        let (:options) { {:id => 1, :controller => 'test', 'DATA' => URI.encode('<IDP MSGTYPE="PayConfirm" TOKEN="(unused)" VTVERIFY="(obsolete)" KEYID="1-0" ID="A668MSAprOj4tAzv7G9lAQUfUr3A" ACCOUNTID="99867-94913159" PROVIDERID="90" PROVIDERNAME="Saferpay Test Card" ORDERID="123456789-001" AMOUNT="1000" CURRENCY="EUR" IP="193.247.180.193" IPCOUNTRY="CH" CCCOUNTRY="XX" MPI_LIABILITYSHIFT="yes" MPI_TX_CAVV="AAABBIIFmAAAAAAAAAAAAAAAAAA=" MPI_XID="CxMTYwhoUXtCBAEndBULcRIQaAY=" ECI="1" CAVV="AAABBIIFmAAAAAAAAAAAAAAAAAA=" XID="CxMTYwhoUXtCBAEndBULcRIQaAY=" />'), 'SIGNATURE' => '7b2bb163f4ef86d969d992b4e2d61ad48d3b9022e0ec68177e35fe53184e6b3399730d1a3641d2a984ce38699daad72ab006d5d6a9565c5ae1cff8bdc8a1eb63'} }
+        
+        it 'does not raise an error' do
+          expect { subject.handle_pay_confirm(options) }.not_to raise_error
+        end
+
+        it_behaves_like 'the verify pay confirm response'
+
+        include_examples 'default redefinition' do
+          let (:testing_method) { :handle_pay_confirm }
+        end
+      end
+    end
+
+  end
+
+  describe 'GET complete payment' do
+    let (:default_options) { {'spPassword' => 'XAjc3Kna'} }   # only for test account on PayComplete method (via HTTPs interface)
+
+    context 'when id is missing' do
+      let (:options) { default_options.merge({}) }
+      it 'raises Missing ID error' do
+        expect { subject.complete_payment(options) }.to raise_error(Saferpay::Error::BadRequest, 'Missing ID attribute')
+      end
+    end
+
+    context 'when id is defined' do
+
+      context 'when id is not valid' do
+        let (:options) { default_options.merge({'ID' => 'test-id'}) }
+        it 'raises invalid ID error' do
+          expect { subject.complete_payment(options) }.to raise_error(Saferpay::Error::BadRequest, 'Transaction not available')
+        end
+      end
+
+      context 'when id is valid' do
+        let (:options) { default_options.merge({'ID' => 'WxWrIlA48W06rAjKKOp5bzS80E5A'}) }
+        
+        it 'does not raise an error' do
+          expect { subject.complete_payment(options) }.not_to raise_error
+        end
+
+        it_behaves_like 'the complete payment response'
+
+        include_examples 'default redefinition' do
+          let (:testing_method) { :complete_payment }
+        end
+      end
+    end
+
+  end
+
+end

data/spec/saferpay/configuration_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'saferpay'
+
+describe Saferpay do
+  subject { Saferpay }
+  
+  describe 'configuration' do
+    context 'by default' do
+      Saferpay::Configuration::VALID_CONFIG_KEYS.each do |key|
+        its(key) { should eq Saferpay::Configuration::DEFAULTS[key] }
+      end
+    end
+
+    describe '.configure' do
+      Saferpay::Configuration::VALID_CONFIG_KEYS.each do |key|
+        it "sets #{key}" do
+          Saferpay.configure do |config|
+            config.send("#{key}=", key)
+            expect(Saferpay.send(key)).to eq(key)
+          end
+        end
+      end
+    end
+
+    describe '.reset' do
+
+      Saferpay::Configuration::VALID_CONFIG_KEYS.each do |key|
+
+        it "resets #{key} to default value" do
+          subject.configure { |config| config.send "#{key}=", key }
+          subject.reset
+
+          expect(subject.send(key)).to eq Saferpay::Configuration::DEFAULTS[key]
+        end
+      end
+    end
+
+    describe 'DEFAULTS hash' do
+
+      Saferpay::Configuration::VALID_CONFIG_KEYS.each do |key|
+        it "does not allow direct manipulation of #{key}" do
+          expect { subject.options[key] = 'someothervalue' }.to raise_error
+        end
+      end
+    end
+  end
+
+end

data/spec/saferpay/saferpay_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'saferpay'
+
+describe Saferpay do
+  subject { Saferpay }
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'saferpay'
+require 'vcr'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.after(:each) do
+    Saferpay.reset
+  end
+end

data/spec/support/vcr_setup.rb

@@ -0,0 +1,7 @@
+VCR.configure do |c|
+  #the directory where your cassettes will be saved
+  c.cassette_library_dir = 'spec/fixtures/vcr'
+
+  # your HTTP request service. You can also use fakeweb, webmock, and more
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: saferpay
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Pedro Gaspar
+- Whitesmith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: Interact with Saferpay's HTTPS Interface with an object-oriented API
+  wrapper built with HTTParty.
+email:
+- me@pedrogaspar.com
+- info@whitesmith.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/saferpay.rb
+- lib/saferpay/client.rb
+- lib/saferpay/configuration.rb
+- lib/saferpay/error.rb
+- lib/saferpay/version.rb
+- saferpay.gemspec
+- spec/fixtures/vcr/saferpay_api.yml
+- spec/saferpay/api_responses_spec.rb
+- spec/saferpay/api_spec.rb
+- spec/saferpay/configuration_spec.rb
+- spec/saferpay/saferpay_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr_setup.rb
+homepage: http://github.com/whitesmith/saferpay-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A Ruby Saferpay API wrapper
+test_files:
+- spec/fixtures/vcr/saferpay_api.yml
+- spec/saferpay/api_responses_spec.rb
+- spec/saferpay/api_spec.rb
+- spec/saferpay/configuration_spec.rb
+- spec/saferpay/saferpay_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr_setup.rb