tns_payments 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tns.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/lib/tns_payments/connection.rb

@@ -0,0 +1,120 @@
+require 'base64'
+require 'json'
+require 'rest-client'
+
+module TNSPayments
+  class Connection
+    CREDIT_CARD_TOKEN_FORMAT = /^9/ # /\d{16}/
+
+    attr_writer :session_token
+
+    def available?
+      request(:get, '/information', :authorization => false).success?
+    end
+
+    def initialize options
+      @api_key     = options[:api_key]
+      @merchant_id = options[:merchant_id]
+    end
+
+    def payment_form_url
+      "https://secure.ap.tnspayments.com/form/#{session_token}"
+    end
+
+    def purchase amount, token, options = {}
+      if token =~ CREDIT_CARD_TOKEN_FORMAT
+        purchase_with_credit_card_token amount, token, options
+      else
+        purchase_with_session_token amount, token, options
+      end
+    end
+
+    def refund amount, options = {}
+      order_id       = create_order_id options[:order_id]
+      transaction_id = options[:transaction_id]
+      params         = {
+        'apiOperation' => 'REFUND',
+        'order'        => {'reference' => options[:order_reference]},
+        'transaction'  => {'amount'    => amount.to_s, 'currency' => 'AUD', 'reference' => transaction_id.to_s}
+      }
+
+      request :put, "/merchant/#{@merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
+    end
+
+    def create_credit_card_token
+      request :post, "/merchant/#{@merchant_id}/token"
+    end
+
+    def delete_credit_card_token token
+      request :delete, "/merchant/#{@merchant_id}/token/#{token}"
+    end
+
+    def session_token?
+      !@session_token.nil?
+    end
+
+    def session_token reload = false
+      if @session_token.nil? or reload
+        response = request :post, "/merchant/#{@merchant_id}/session"
+        @session_token = response.success?? response.response['session'] : nil
+      end
+      @session_token
+    end
+
+  private
+
+    def api_url
+      'https://secure.ap.tnspayments.com/api/rest/version/4'
+    end
+
+    def create_order_id id
+      10000000000 + id.to_i
+    end
+
+    def encode_credentials
+      credentials = ['', @api_key].join(':')
+      'Basic ' << Base64.encode64(credentials)
+    end
+
+    def purchase_with_credit_card_token amount, token, options = {}
+      order_id       = create_order_id options[:order_id]
+      transaction_id = options[:transaction_id]
+      params         = {
+        'apiOperation' => 'PAY',
+        'order'        => {'reference' => options[:order_reference]},
+        'cardDetails'  => {'cardToken' => token},
+        'transaction'  => {'amount'    => amount.to_s, 'currency' => 'AUD', 'reference' => transaction_id.to_s}
+      }
+
+      request :put, "/merchant/#{@merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
+    end
+
+    def purchase_with_session_token amount, token, options = {}
+      order_id       = create_order_id options[:order_id]
+      transaction_id = options[:transaction_id]
+      params         = {
+        'apiOperation' => 'PAY',
+        'order'        => {'reference' => options[:order_reference]},
+        'cardDetails'  => {'session'   => token},
+        'transaction'  => {'amount'    => amount.to_s, 'currency' => 'AUD', 'reference' => transaction_id.to_s}
+      }
+
+      request :put, "/merchant/#{@merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
+    end
+
+    def request method, path, options = {}
+      authorization = options.fetch(:authorization) { true }
+      url           = api_url << path
+      auth_headers  = {:Authorization => encode_credentials}
+      headers       = {:content_type => 'Application/json;charset=UTF-8', :accept => '*/*'}
+      headers.merge! auth_headers if authorization
+
+      args = [headers]
+      args.unshift(options.to_json) unless [:delete, :get, :head].include? method
+
+      Response.new JSON.parse(RestClient.send(method, url, *args))
+    rescue RestClient::Exception => e
+      Response.new 'result' => e.message.upcase, 'response' => e.response
+    end
+  end
+end

data/lib/tns_payments/credit_card.rb

@@ -0,0 +1,8 @@
+module TNSPayments
+  class CreditCard
+    FORM_RESPONSE_MAPPING = {:gatewayCardExpiryDateYear => :year, :gatewayCardExpiryDateMonth => :month, :gatewayCardNumber => :number, :gatewayCardSecurityCode => :verification_value}.freeze
+
+    def initialize args = {}
+    end
+  end
+end

data/lib/tns_payments/response.rb

@@ -0,0 +1,22 @@
+module TNSPayments
+  class Response
+    extend Forwardable
+
+    attr_reader :response
+
+    def_delegators :credit_card, :card_type
+
+    def initialize body
+      @response = body
+      @result   = @response['result'] || @response['status']
+    end
+
+    def credit_card
+      @credit_card ||= Tns::CreditCard.new @response['card']
+    end
+
+    def success?
+      %w[SUCCESS OPERATING].include? @result
+    end
+  end
+end

data/lib/tns_payments/version.rb

@@ -0,0 +1,3 @@
+module TNSPayments
+  VERSION = "0.0.1"
+end

data/lib/tns_payments.rb

@@ -0,0 +1,10 @@
+require 'tns_payments/connection'
+require 'tns_payments/credit_card'
+require 'tns_payments/response'
+require 'tns_payments/version'
+
+module TNSPayments
+  def self.new options = {}
+    Connection.new options
+  end
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'tns_payments'
+
+include TNSPayments

data/test/unit/conntection_test.rb

@@ -0,0 +1,224 @@
+require 'helper'
+require 'webmock/minitest'
+
+class TNSPayments::ConnectionTest < MiniTest::Unit::TestCase
+  def setup
+    @api_key     = '123api456'
+    @merchant_id = 'MERCHANT'
+    @gateway     = Connection.new :api_key => @api_key, :merchant_id => @merchant_id
+  end
+
+  def test_available_is_true_when_tns_gateway_is_operating
+    stub_availability_request.
+      to_return(:status => 200, :body => '{"status":"OPERATING"}', :headers => {})
+    assert @gateway.available?
+  end
+
+  def test_available_is_false_when_tns_gateway_is_not_operating
+    stub_availability_request.
+      to_return(:status => 200, :body => '{"status":"EPIC_FAIL"}', :headers => {})
+    refute @gateway.available?
+  end
+
+  def test_purchase_with_session_token_makes_a_successful_purchase
+    stub_successful_session_token_purchase_request :amount => 100, :token => 'SESSIONTOKEN', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    response = @gateway.purchase 100, 'SESSIONTOKEN', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    assert response.success?
+  end
+
+  def test_purchase_with_session_token_makes_an_unsuccessful_purchase
+    stub_unsuccessful_session_token_purchase_request :amount => 100, :token => 'SESSIONTOKEN', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    response = @gateway.purchase 100, 'SESSIONTOKEN', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    refute response.success?
+  end
+
+  def test_purchase_with_session_token_can_deal_with_timeout_errors
+    stub_session_token_purchase_request(:amount => 100, :token => 'SESSIONTOKEN', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123').
+      to_timeout
+    response = @gateway.purchase 100, 'SESSIONTOKEN', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    refute response.success?
+  end
+
+  def test_purchase_with_credit_card_token_makes_a_successful_purchase
+    stub_successful_credit_card_token_purchase_request(:amount => 100, :token => '9111111111111111', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123')
+    assert @gateway.purchase(100, '9111111111111111', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123').success?
+  end
+
+  def test_purchase_with_credit_card_token_makes_an_unsuccessful_purchase
+    stub_unsuccessful_credit_card_token_purchase_request :amount => 100, :token => '9111111111111111', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    response = @gateway.purchase 100, '9111111111111111', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    refute response.success?
+  end
+
+  def test_purchase_with_credit_card_token_can_deal_with_timeout_errors
+    stub_credit_card_token_purchase_request(:amount => 100, :token => '9111111111111111', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123').
+      to_timeout
+    response = @gateway.purchase 100, '9111111111111111', :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    refute response.success?
+  end
+
+  def test_refund_makes_successful_refund
+    stub_successful_refund_request :amount => 100, :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    response = @gateway.refund 100, :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    assert response.success?
+  end
+
+  def test_refund_makes_unsuccessful_refund
+    stub_unsuccessful_refund_request :amount => 100, :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    response = @gateway.refund 100, :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    refute response.success?
+  end
+
+  def test_refund_can_deal_with_timeout_errors
+    stub_refund_request(:amount => 100, :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123').
+      to_timeout
+    response = @gateway.refund 100, :order_id => 1, :transaction_id => 1, :order_reference => 'AUD123'
+    refute response.success?
+  end
+
+  def test_create_credit_card_token_successfully_stores_creditcard
+    stub_successful_create_credit_card_token_request
+    assert @gateway.create_credit_card_token.success?
+  end
+
+  def test_create_credit_card_token_returns_valid_card_token_when_successful
+    stub_successful_create_credit_card_token_request
+    token = @gateway.create_credit_card_token.response['cardToken']
+    assert_equal 16, token.size
+    assert_match Connection::CREDIT_CARD_TOKEN_FORMAT, token
+  end
+
+  def test_create_credit_card_token_unsuccessfully_attempts_to_store_credit_card
+    stub_unsuccessful_create_credit_card_token_request
+    refute @gateway.create_credit_card_token.success?
+  end
+
+  def test_delete_credit_card_token_successfully_deletes_a_stored_credit_card_token
+    stub_successful_delete_credit_card_token_request
+    assert @gateway.delete_credit_card_token('9123456781234567').success?
+  end
+
+  def test_delete_credit_card_token_unsuccessfully_attempts_to_delete_a_stored_credit_card
+    stub_unsuccessful_delete_credit_card_token_request
+    refute @gateway.delete_credit_card_token('9123456781234567').success?
+  end
+
+private
+
+  def stub_availability_request
+    stub_request(:get, "https://secure.ap.tnspayments.com/api/rest/version/4/information").
+      with(:headers => {'Accept'=>'*/*', 'Content-Type'=>'Application/json;charset=UTF-8'})
+  end
+
+  def stub_successful_refund_request options = {}
+    stub_refund_request(options).
+      to_return :status => 200, :headers => {}, :body => <<-EOS
+         {"merchant":"#{@merchant_id}","order":{"id":#{@gateway.send(:create_order_id, options[:order_id])},"totalAuthorizedAmount":0.00,"totalCapturedAmount":0.00,"totalRefundedAmount":0.00},
+          "response":{"acquirerCode":"00","gatewayCode":"APPROVED"},"result":"SUCCESS","transaction":{"acquirer":{"id":"STGEORGE"},
+          "amount":#{options[:amount]},"authorizationCode":"000582","batch":20110707,"currency":"AUD","id":"#{options[:transaction_id]}",
+          "receipt":"110707000582","source":"INTERNET","terminal":"08845778","type":"REFUND"}}
+          EOS
+  end
+
+  def stub_unsuccessful_refund_request options = {}
+    stub_refund_request(options).
+      to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
+  end
+
+  def stub_successful_credit_card_token_purchase_request options = {}
+    stub_credit_card_token_purchase_request(options).
+      to_return(:status => 200, :body => %[{"card":{"expiry":{"month":"5","year":"13"},"number":"xxxxxxxxxxxxxxxx","scheme":"MASTERCARD"},"merchant":"","order":{"id":"#{@gateway.send(:create_order_id, options[:order_id])}","totalAuthorizedAmount":0.00,"totalCapturedAmount":0.00,"totalRefundedAmount":0.00},"response":{"acquirerCode":"00","gatewayCode":"APPROVED"},"result":"SUCCESS","transaction":{"acquirer":{"id":"STGEORGE"},"amount":"#{options[:amount]}","authorizationCode":"000576","batch":20110707,"currency":"AUD","frequency":"SINGLE","id":"72637779534c67696c54b26f220dc4d3","receipt":"110707000576","source":"INTERNET","terminal":"08845778","type":"PAYMENT"}}], :headers => {})
+  end
+
+  def stub_unsuccessful_credit_card_token_purchase_request options = {}
+    stub_credit_card_token_purchase_request(options).
+      to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
+  end
+
+  def stub_successful_session_token_purchase_request options = {}
+    stub_session_token_purchase_request(options).
+      to_return(:status => 200, :body => %[{"card":{"expiry":{"month":"5","year":"13"},"number":"xxxxxxxxxxxxxxxx","scheme":"MASTERCARD"},"merchant":"","order":{"id":"#{@gateway.send(:create_order_id, options[:order_id])}","totalAuthorizedAmount":0.00,"totalCapturedAmount":0.00,"totalRefundedAmount":0.00},"response":{"acquirerCode":"00","gatewayCode":"APPROVED"},"result":"SUCCESS","transaction":{"acquirer":{"id":"STGEORGE"},"amount":"#{options[:amount]}","authorizationCode":"000576","batch":20110707,"currency":"AUD","frequency":"SINGLE","id":"72637779534c67696c54b26f220dc4d3","receipt":"110707000576","source":"INTERNET","terminal":"08845778","type":"PAYMENT"}}], :headers => {})
+  end
+
+  def stub_unsuccessful_session_token_purchase_request options = {}
+    stub_session_token_purchase_request(options).
+      to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
+  end
+
+  def stub_successful_create_credit_card_token_request
+    stub_create_credit_card_token_request.
+      to_return(:status => 200, :body => %{{"result":"SUCCESS", "response":{"gatewayCode":"BASIC_VERIFICATION_SUCCESSFUL"}, "card":{"number":"xxxxxxxxxxxxxxxx", "scheme":"MASTERCARD", "expiry":{"month":"5", "year":"13"}}, "cardToken":"9102370788509763"}}, :headers => {})
+  end
+
+  def stub_unsuccessful_create_credit_card_token_request
+    stub_create_credit_card_token_request.
+      to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
+  end
+
+  def stub_successful_delete_credit_card_token_request
+    stub_delete_credit_card_token_request.
+      to_return(:status => 200, :body => '{"result":"SUCCESS"}', :headers => {})
+  end
+
+  def stub_unsuccessful_delete_credit_card_token_request
+    stub_delete_credit_card_token_request.
+      to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
+  end
+
+  def stub_session_token_purchase_request options = {}
+    stub_request(:put, /https:\/\/:#{@api_key}@secure\.ap\.tnspayments\.com\/api\/rest\/version\/4\/merchant\/#{@merchant_id}\/order\/#{@gateway.send(:create_order_id, options[:order_id])}\/transaction\/#{options[:transaction_id]}/).
+      with :body => JSON.generate({
+             'apiOperation' => 'PAY',
+             'order'        => {'reference' => options[:order_reference].to_s},
+             'cardDetails'  => {'session' => options[:token].to_s},
+             'transaction'  => {'amount' => options[:amount].to_s, 'currency' => 'AUD', 'reference' => options[:transaction_id].to_s}
+           }),
+           :headers => {
+             'Accept' => '*/*',
+             'Accept-Encoding' => 'gzip, deflate',
+             'Content-Length'  => '158',
+             'Content-Type'    => 'Application/json;charset=UTF-8'
+           }
+  end
+
+  def stub_credit_card_token_purchase_request options = {}
+    stub_request(:put, /https:\/\/:#{@api_key}@secure\.ap\.tnspayments\.com\/api\/rest\/version\/4\/merchant\/#{@merchant_id}\/order\/#{@gateway.send(:create_order_id, options[:order_id])}\/transaction\/#{options[:transaction_id]}/).
+      with :body => JSON.generate({
+             'apiOperation' => 'PAY',
+             'order'        => {'reference' => options[:order_reference].to_s},
+             'cardDetails'  => {'cardToken' => options[:token].to_s},
+             'transaction'  => {'amount' => options[:amount].to_s, 'currency' => 'AUD', 'reference' => options[:transaction_id].to_s}
+           }),
+           :headers => {
+             'Accept' => '*/*',
+             'Accept-Encoding' => 'gzip, deflate',
+             'Content-Length'  => '164',
+             'Content-Type'    => 'Application/json;charset=UTF-8'
+           }
+  end
+
+  def stub_refund_request options = {}
+    stub_request(:put, /https:\/\/:#{@api_key}@secure\.ap\.tnspayments\.com\/api\/rest\/version\/4\/merchant\/#{@merchant_id}\/order\/#{@gateway.send(:create_order_id, options[:order_id])}\/transaction\/#{options[:transaction_id]}/).
+      with :body => JSON.generate({
+             'apiOperation' => 'REFUND',
+             'order'        => {'reference' => options[:order_reference].to_s},
+             'transaction'  => {'amount' => options[:amount].to_s, 'currency' => 'AUD', 'reference' => options[:transaction_id].to_s}
+           }),
+           :headers => {
+             'Accept'          => '*/*',
+             'Accept-Encoding' => 'gzip, deflate',
+             'Content-Length'  => '120',
+             'Content-Type'    => 'Application/json;charset=UTF-8'
+           }
+  end
+
+  def stub_create_credit_card_token_request
+    stub_request(:post, /https:\/\/:#{@api_key}@secure\.ap\.tnspayments\.com\/api\/rest\/version\/4\/merchant\/#{@merchant_id}\/token/).
+      with(:headers => {'Accept'=>'*/*', 'Content-Type'=>'Application/json;charset=UTF-8'}, :body => {})
+  end
+
+  def stub_delete_credit_card_token_request
+    stub_request(:delete, /https:\/\/:#{@api_key}@secure\.ap\.tnspayments\.com\/api\/rest\/version\/4\/merchant\/#{@merchant_id}\/token\/\d{16}/).
+      with(:headers => {'Accept'=>'*/*', 'Content-Type'=>'Application/json;charset=UTF-8'}, :body => {})
+  end
+end

data/test/unit/response_test.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TNSPayments::ResponseTest < MiniTest::Unit::TestCase
+end

data/tns_payments.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tns_payments/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tns_payments"
+  s.version     = TNSPayments::VERSION
+  s.authors     = ["Tim Cooper"]
+  s.email       = ["coop@latrobest.com"]
+  s.homepage    = ""
+  s.summary     = %q{Integration with TNS Payments Gateway}
+  s.description = %q{Integration with TNS Payments Gateway}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency     'json'
+  s.add_runtime_dependency     'rest-client'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: tns_payments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tim Cooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70141552320780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70141552320780
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70141552319900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70141552319900
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70141552335720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70141552335720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70141552335100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70141552335100
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70141552333420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70141552333420
+description: Integration with TNS Payments Gateway
+email:
+- coop@latrobest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/tns_payments.rb
+- lib/tns_payments/connection.rb
+- lib/tns_payments/credit_card.rb
+- lib/tns_payments/response.rb
+- lib/tns_payments/version.rb
+- test/helper.rb
+- test/unit/conntection_test.rb
+- test/unit/response_test.rb
+- tns_payments.gemspec
+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'
+      segments:
+      - 0
+      hash: -1671981607314652405
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1671981607314652405
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Integration with TNS Payments Gateway
+test_files:
+- test/helper.rb
+- test/unit/conntection_test.rb
+- test/unit/response_test.rb