payex 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+ruby '1.9.3'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    payex (0.0.1)
+      nori (~> 1.1)
+      savon (~> 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.5)
+    guard (1.3.2)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-rspec (1.2.1)
+      guard (>= 1.1)
+    gyoku (0.4.6)
+      builder (>= 2.1.2)
+    httpi (1.1.1)
+      rack
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    nokogiri (1.5.5)
+    nori (1.1.3)
+    rack (1.4.1)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    savon (1.1.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 0.4.5)
+      httpi (~> 1.1.0)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.1.0)
+      wasabi (~> 2.5.0)
+    savon_spec (1.3.0)
+      rspec (>= 2.0.0)
+      savon (~> 1.0)
+    terminal-notifier-guard (1.5.3)
+    thor (0.16.0)
+    wasabi (2.5.1)
+      httpi (~> 1.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard (~> 1.3)
+  guard-bundler (~> 1.0)
+  guard-rspec (~> 1.2)
+  payex!
+  rspec (~> 2.11)
+  savon_spec (~> 1.3)
+  terminal-notifier-guard (~> 1.5)

data/Guardfile

@@ -0,0 +1,10 @@
+# -*- ruby -*-
+
+guard :bundler do
+  watch 'Gemfile'
+  watch 'payex.gemspec'
+end
+
+guard :rspec, cli: '--color', bundler: false do
+  watch(%r'^(lib|spec)/') { 'spec' }
+end

data/README

@@ -0,0 +1,34 @@
+# -*- ruby -*-
+require 'payex'
+
+# This is how a basic PayEx transaction works:
+
+PayEx.account_number = 123456789
+PayEx.encryption_key = 'e4939be3910ebu194'
+
+PayEx.return_url = 'http://example.com/payex-return'
+PayEx.cancel_url = 'http://example.com/payex-cancel'
+
+local_order_id = 'c704acc45a4bec4c8cd50b73fb01a7c7'
+
+payment_url = PayEx.authorize_transaction! local_order_id,
+  product_number: '123456',
+  product_description: 'Brief product description',
+  price: 14900, # Price in cents
+  customer_ip: '12.34.56.78'
+
+# After sending the customer to `payment_url`, they will enter their
+# payment details before being redirected back to `PayEx.return_url`
+# with an `orderRef` parameter appended to the query string:
+#
+#   <http://example.com/payex-return?orderRef=9b4031c19960da92d>
+#
+# By giving the `orderRef` value to `PayEx.complete_transaction!` you
+# retreive your local order ID and your app can proceed from there.
+
+begin
+  local_order_id = PayEx.complete_transaction! '9b4031c19960da92d'
+  # [transaction successful]
+rescue PayEx::Error => error
+  # [transaction unsucessful]
+end

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'

data/lib/payex/api.rb

@@ -0,0 +1,101 @@
+require 'nori'
+require 'savon'
+
+module PayEx::API
+  extend self
+
+  class ParamError < StandardError; end
+
+  def invoke! wsdl, name, params, specs
+    body = get_request_body(params, specs)
+    response = invoke_raw! wsdl, name, body
+
+    # Unwrap e.g. <Initialize8Response>
+    response = response[response.keys.first]
+    # Unwrap e.g. <Initialize8Result>
+    response = response[response.keys.first]
+    # Parse embedded XML document
+    response = Nori.parse(response)
+    # Unwrap <payex>
+    response = response[response.keys.first]
+
+    if ok = response[:status][:code] == 'OK' rescue false
+      response
+    elsif defined? response[:status][:description]
+      raise PayEx::Error, response[:status][:description]
+    else
+      raise PayEx::Error, %{invalid response: #{response.inspect}}
+    end
+  end
+
+  def invoke_raw! wsdl, name, body
+    Savon.client(wsdl).request(name, body: body) {
+      http.headers.delete('SOAPAction')
+    }.body
+  end
+
+  def signed_hash(string)
+    Digest::MD5.hexdigest(string + PayEx.encryption_key!)
+  end
+
+  def get_request_body(params, specs)
+    parse_params(params, specs).tap do |params|
+      params['hash'] = sign_params(params, specs)
+    end
+  end
+
+  def sign_params(params, specs)
+    signed_hash(hashed_params(params, specs).join)
+  end
+
+  def hashed_params(params, specs)
+    specs.select { |key, options| options[:signed] }.
+      keys.map { |key| params[key] }
+  end
+
+  def parse_params(params, specs)
+    stringify_keys(params).tap do |result|
+      _parse_params! result, specs
+      result.select! { |k, v| v != nil }
+    end
+  end
+
+  def stringify_keys(hash)
+    Hash[*hash.map { |k, v| [k.to_s, v] }.flatten]
+  end
+
+  def _parse_params!(params, specs)
+    for name, options in specs
+      begin
+        params[name] = parse_param(params[name], options)
+      rescue PayEx::API::ParamError => error
+        param_error! %{#{name.inspect}: #{error.message}}
+      end
+    end
+  end
+
+  def parse_param(param, options)
+    unless options.is_a? Hash
+      raise ArgumentError, %{expected Hash, got #{options.inspect}}
+    end
+
+    if param != nil
+      result = param
+    elsif options.include? :default
+      result = options[:default]
+      result = result.call if result.is_a? Proc
+    else
+      param_error! 'parameter required'
+    end
+
+    if options.include?(:format) and not options[:format] === result
+      param_error! %{must match #{options[:format].inspect}}
+    else
+      result
+    end
+  end
+
+  def param_error! message
+    raise ParamError, message
+  end
+end

data/lib/payex/pxorder.rb

@@ -0,0 +1,94 @@
+module PayEx::PxOrder
+  extend self
+
+  def wsdl
+    '%s/pxorder/pxorder.asmx?WSDL' % PayEx.base_url
+  end
+
+  def Initialize7(params)
+    PayEx::API.invoke! wsdl, 'Initialize7', params, {
+      'accountNumber' => {
+        signed: true,
+        default: proc { PayEx.account_number! }
+      },
+      'purchaseOperation' => {
+        signed: true
+      },
+      'price' => {
+        signed: true,
+        format: Integer
+      },
+      'priceArgList' => {
+        signed: true,
+        default: ''
+      },
+      'currency' => {
+        signed: true,
+        default: proc { PayEx.default_currency }
+      },
+      'vat' => {
+        signed: true,
+        format: Integer,
+        default: 0
+      },
+      'orderID' => {
+        signed: true,
+        format: /^[a-z0-9]{,50}$/i
+      },
+      'productNumber' => {
+        signed: true,
+        format: /^[A-Z0-9]{,50}$/
+      },
+      'description' => {
+        signed: true,
+        format: /^.{,160}$/
+      },
+      'clientIPAddress' => {
+        signed: true
+      },
+      'clientIdentifier' => {
+        signed: true,
+        default: ''
+      },
+      'additionalValues' => {
+        signed: true,
+        default: ''
+      },
+      'externalID' => {
+        signed: true,
+        default: ''
+      },
+      'returnUrl' => {
+        signed: true
+      },
+      'view' => {
+        signed: true,
+        default: 'CREDITCARD'
+      },
+      'agreementRef' => {
+        signed: true,
+        default: ''
+      },
+      'cancelUrl' => {
+        signed: true,
+        default: ''
+      },
+      'clientLanguage' => {
+        signed: true,
+        default: ''
+      }
+    }
+  end
+
+  def Complete(params)
+    PayEx::API.invoke! wsdl, 'Complete', params, {
+      'accountNumber' => {
+        signed: true,
+        default: proc { PayEx.account_number! }
+      },
+      'orderRef' => {
+        signed: true
+      }
+    }
+  end
+end

data/lib/payex.rb

@@ -0,0 +1,78 @@
+module PayEx
+  extend self
+
+  TEST_URL = 'https://test-external.payex.com'
+  LIVE_URL = 'https://external.payex.com'
+
+  class Error < StandardError; end
+
+  attr_accessor :default_currency
+  attr_accessor :base_url
+
+  attr_accessor :account_number
+  attr_accessor :encryption_key
+
+  attr_accessor :return_url
+  attr_accessor :cancel_url
+end
+
+PayEx.default_currency = 'SEK'
+PayEx.base_url = PayEx::TEST_URL
+
+require 'payex/api'
+require 'payex/pxorder'
+
+def PayEx.account_number!
+  PayEx.account_number or fail 'Please set PayEx.account_number'
+end
+
+def PayEx.encryption_key!
+  PayEx.encryption_key or fail 'Please set PayEx.encryption_key'
+end
+
+def PayEx.authorize_transaction! order_id, params
+  response = PayEx::PxOrder.Initialize7 \
+    orderID: order_id,
+    purchaseOperation: 'AUTHORIZATION',
+    productNumber: params[:product_number],
+    description: params[:product_description],
+    price: params[:price],
+    clientIPAddress: params[:customer_ip],
+    returnUrl: PayEx.return_url,
+    cancelUrl: PayEx.cancel_url
+
+  response[:redirect_url]
+end
+
+def PayEx.complete_transaction! id
+  response = PayEx::PxOrder.Complete(orderRef: id)
+
+  status = response[:transaction_status]
+  status = PayEx.parse_transaction_status(status)
+
+  case status
+  when :sale, :authorize
+    response[:order_id]
+  when :initialize
+    raise PayEx::Error, 'Transaction not completed'
+  when :failure
+    message = response[:error_details][:third_party_error] rescue nil
+    raise PayEx::Error, message
+  else
+    raise PayEx::Error, 'Unexpected transaction status: ' +
+      status.to_s.upcase
+  end
+end
+
+def PayEx.parse_transaction_status(status)
+  case status.to_s
+  when '0' then :sale
+  when '1' then :initialize
+  when '2' then :credit
+  when '3' then :authorize
+  when '4' then :cancel
+  when '5' then :failure
+  when '6' then :capture
+  else status.to_s
+  end
+end

data/payex.gemspec

@@ -0,0 +1,19 @@
+# -*- ruby; coding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name = 'payex'
+  gem.version = '0.0.1'
+  gem.summary = 'PayEx SOAP API glue'
+  gem.author = 'Daniel Brockman'
+  gem.files = `git ls-files 2>/dev/null`.split($\)
+
+  gem.add_dependency 'nori', '~> 1.1'
+  gem.add_dependency 'savon', '~> 1.1'
+
+  gem.add_development_dependency 'guard', '~> 1.3'
+  gem.add_development_dependency 'guard-bundler', '~> 1.0'
+  gem.add_development_dependency 'guard-rspec', '~> 1.2'
+  gem.add_development_dependency 'rspec', '~> 2.11'
+  gem.add_development_dependency 'savon_spec', '~> 1.3'
+  gem.add_development_dependency 'terminal-notifier-guard', '~> 1.5'
+end

data/spec/api_unit_spec.rb

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+require 'payex'
+require 'spec_helper'
+
+describe PayEx::API do
+  before {
+    PayEx.encryption_key = 'foo'
+  }
+
+  it 'should know how to stringify keys' do
+    PayEx::API.stringify_keys(a: 1, b: 2).
+      should == { 'a' => 1, 'b' => 2 }
+  end
+
+  it 'should know how to sign params' do
+    param_hash, specs, param_array = {}, {}, []
+
+    for name in 'a'..'z'
+      if rand < 0.5
+        param_hash[name] = rand
+        param_array << param_hash[name]
+        specs[name] = { signed: true }
+      else
+        param_hash[name] = rand
+      end
+    end
+
+    actual = PayEx::API.sign_params(param_hash, specs)
+
+    to_sign = param_array.join + PayEx.encryption_key
+    expected = Digest::MD5.hexdigest(to_sign)
+
+    actual.should == expected
+  end
+
+  it 'should know how to add defaults' do
+    PayEx::API.parse_param(nil, { default: 2 }).should == 2
+  end
+
+  it 'should know how to call default procs' do
+    PayEx::API.parse_param(nil, { default: proc { 2 } }).should == 2
+  end
+
+  it 'should reject wrong type of value' do
+    proc {
+      PayEx::API.parse_param('foobar', { format: Integer })
+    }.should raise_error PayEx::API::ParamError
+  end
+
+  it 'should reject strings based on regular expressions' do
+    proc {
+      PayEx::API.parse_param('foobar', { format: /^.{,3}$/ })
+    }.should raise_error PayEx::API::ParamError
+  end
+
+  it 'should stringify keys when parsing params' do
+    PayEx::API.parse_params({ a: 1 }, { 'b' => { default: 2 } }).
+      should == { 'a' => 1, 'b' => 2 }
+  end
+end

data/spec/fixtures/Initialize7/initialize_ok.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
+              xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <env:Body>
+    <Initialize7Response xmlns="http://external.payex.com/PxOrder/">
+      <Initialize7Result>
+        <![CDATA[
+          <?xml version="1.0" encoding="utf-8"?>
+          <payex>
+            <header name="Payex Header v1.0">
+              <id>4e0fbe36b146452b8ce7b87e6186a3e3</id>
+              <date>2010-11-10 06:13:48</date>
+            </header>
+            <status>
+              <code>OK</code>
+              <description>OK</description>
+              <errorCode>OK</errorCode>
+              <paramName/>
+              <thirdPartyError/>
+            </status>
+            <orderRef>b93d29bf7df3424cac23407a987c0be9</orderRef>
+            <sessionRef>7807accc0e7e4d069e1d92ec5680d0cc</sessionRef>
+            <redirectUrl>https://test-confined.payex.com/PxOrderCC.aspx?orderRef=b93d29bf7df3424cac23407a987c0be9</redirectUrl>
+          </payex>
+        ]]>
+      </Initialize7Result>
+    </Initialize7Response>
+  </env:Body>
+</env:Envelope>

data/spec/integration_spec.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+require 'payex'
+require 'spec_helper'
+
+describe PayEx do
+  before {
+    PayEx.account_number = 'foo-account'
+    PayEx.encryption_key = 'foo-secret'
+    PayEx.return_url = 'http://example.com/payex-callback'
+  }
+
+  it 'should send request and parse response' do
+    expected = {
+      'accountNumber' => 'foo-account',
+      'purchaseOperation' => 'AUTHORIZATION',
+      'price' => 12300,
+      'priceArgList' => '',
+      'currency' => 'SEK',
+      'vat' => 0,
+      'orderID' => 'order123',
+      'productNumber' => 'PRODUCT123',
+      'description' => 'Product description',
+      'clientIPAddress' => '12.34.56.78',
+      'clientIdentifier' => '',
+      'additionalValues' => '',
+      'externalID' => '',
+      'returnUrl' => 'http://example.com/payex-callback',
+      'view' => 'CREDITCARD',
+      'agreementRef' => '',
+      'cancelUrl' => '',
+      'clientLanguage' => ''
+    }
+
+    expected['hash'] = PayEx::API.signed_hash(expected.values.join)
+    savon.expects('Initialize7').with(expected).returns(:initialize_ok)
+
+    href = PayEx.authorize_transaction! 'order123',
+      product_number: 'PRODUCT123',
+      product_description: 'Product description',
+      price: 12300,
+      customer_ip: '12.34.56.78'
+
+    href.should include 'http'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'savon_spec'
+
+Savon::Spec::Fixture.path =
+  File.expand_path('../fixtures', __FILE__)
+
+RSpec.configure do |config|
+  config.include Savon::Spec::Macros
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: payex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Brockman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: savon_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README
+- Rakefile
+- lib/payex.rb
+- lib/payex/api.rb
+- lib/payex/pxorder.rb
+- payex.gemspec
+- spec/api_unit_spec.rb
+- spec/fixtures/Initialize7/initialize_ok.xml
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: PayEx SOAP API glue
+test_files: []