tns_payments 0.0.11 → 0.0.12

data/.env.example

@@ -0,0 +1,4 @@
+TNS_MERCHANT_ID=<MERCHANT_ID>
+TNS_API_KEY=<API_KEY>
+TNS_3DS_MERCHANT_ID=<3DS_MERCHANT_ID>
+TNS_3DS_API_KEY=<3DS_API_KEY>

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.env

data/lib/tns_payments/connection.rb

@@ -1,4 +1,5 @@
 require 'base64'
+require 'active_support/ordered_hash'
 
 module TNSPayments
   class Connection
@@ -11,7 +12,7 @@ module TNSPayments
     #
     # Returns a boolean.
     def available?
-      request(:get, '/information', :authorization => false).success?
+      AvailableResponse.new(request(:get, '/information')).success?
     end
 
     def initialize options
@@ -34,16 +35,17 @@ module TNSPayments
       transaction    = Transaction.new transaction
       order_id       = transaction.order_id
       transaction_id = transaction.transaction_id
-      params         = {
-        'apiOperation' => 'PAY',
-        'cardDetails'  => card_details(token),
-        'order'        => {'reference' => transaction.reference},
-        'transaction'  => {
-          'amount'    => transaction.amount.to_s,
-          'currency'  => transaction.currency,
-          'reference' => transaction.reference.to_s
-        }
-      }
+      order_params = ActiveSupport::OrderedHash.new
+      order_params['amount'] = transaction.amount.to_s
+      order_params['currency'] = transaction.currency
+      order_params['reference'] = transaction.reference
+      transaction_params = ActiveSupport::OrderedHash.new
+      transaction_params['reference'] = transaction.reference.to_s
+      params = ActiveSupport::OrderedHash.new
+      params['apiOperation'] = 'PAY'
+      params['order'] = order_params
+      params['transaction'] = transaction_params
+      params.merge!(source_of_funds(token))
 
       request :put, "/merchant/#{merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
     end
@@ -52,17 +54,16 @@ module TNSPayments
     #
     # Returns a Response object.
     def refund transaction
-      transaction    = Transaction.new transaction
-      order_id       = transaction.order_id.to_i
+      transaction = Transaction.new transaction
+      order_id = transaction.order_id.to_i
       transaction_id = transaction.transaction_id
-      params         = {
-        'apiOperation' => 'REFUND',
-        'transaction'  => {
-          'amount'    => transaction.amount.to_s,
-          'currency'  => transaction.currency,
-          'reference' => transaction.reference.to_s
-        }
-      }
+      transaction_params = ActiveSupport::OrderedHash.new
+      transaction_params['amount'] = transaction.amount.to_s
+      transaction_params['currency'] = transaction.currency
+      transaction_params['reference'] = transaction.reference.to_s
+      params = ActiveSupport::OrderedHash.new
+      params['apiOperation'] = 'REFUND'
+      params['transaction'] = transaction_params
 
       request :put, "/merchant/#{merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
     end
@@ -71,9 +72,13 @@ module TNSPayments
     #
     # Returns a Response object.
     def create_credit_card_token token
-      params = {
-        'cardDetails' => card_details(token)
-      }
+      source_of_funds_params = ActiveSupport::OrderedHash.new
+      source_of_funds_params['type'] = 'CARD'
+      session_params = ActiveSupport::OrderedHash.new
+      session_params['id'] = token
+      params = ActiveSupport::OrderedHash.new
+      params['session'] = session_params
+      params['sourceOfFunds'] = source_of_funds_params
 
       request :post, "/merchant/#{merchant_id}/token", params
     end
@@ -92,35 +97,44 @@ module TNSPayments
     # Returns a Response object.
     def session_token
       @session_token ||= begin
-        response = request :post, "/merchant/#{merchant_id}/session"
-        if response.success?
-          response.response.fetch('session')
+        result = request :post, "/merchant/#{merchant_id}/session"
+        if result.success?
+          result.response['session']['id']
         else
-          raise SessionTokenException.new, response.explanation
+          raise SessionTokenException.new, result.explanation
         end
       end
     end
 
+    # Public: Request to update a session token with card data.
+    #
+    # Returns a response object.
+    def update_session_with_card(token, card)
+      source_of_funds_params = ActiveSupport::OrderedHash.new
+      source_of_funds_params['type'] = 'CARD'
+      source_of_funds_params['provided'] = {'card' => card}
+      params = {'sourceOfFunds' => source_of_funds_params}
+
+      UpdateSessionResponse.new(request(:put, "/merchant/#{merchant_id}/session/#{token}", params))
+    end
+
     # Public: Request to check a cardholder's enrollment in the 3DSecure scheme.
     #
     # Returns a Response object.
     def check_enrollment transaction, token, postback_url
-      params = {
-        '3DSecure'     => {
-          'authenticationRedirect' => {
-            'pageGenerationMode'   => 'CUSTOMIZED',
-            'responseUrl'          => postback_url
-          }
-        },
-        'apiOperation' => 'CHECK_3DS_ENROLLMENT',
-        'cardDetails'  => card_details(token),
-        'transaction'  => {
-          'amount'   => transaction.amount.to_s,
-          'currency' => transaction.currency
-        }
-      }
-
-      request :put, "/merchant/#{merchant_id}/3DSecureId/#{transaction.three_domain_id}", params
+      redirect_params = ActiveSupport::OrderedHash.new
+      redirect_params['pageGenerationMode'] = 'CUSTOMIZED'
+      redirect_params['responseUrl'] = postback_url
+      order_params = ActiveSupport::OrderedHash.new
+      order_params['amount'] = transaction.amount.to_s
+      order_params['currency'] = transaction.currency
+      params = ActiveSupport::OrderedHash.new
+      params['apiOperation'] = 'CHECK_3DS_ENROLLMENT'
+      params['3DSecure'] = {'authenticationRedirect' => redirect_params}
+      params['session'] = {'id' => token}
+      params['order'] = order_params
+
+      ThreeDomainSecureResponse.new(request(:put, "/merchant/#{merchant_id}/3DSecureId/#{transaction.three_domain_id}", params))
     end
 
     # Public: Interprets the authentication response returned from the card
@@ -134,21 +148,29 @@ module TNSPayments
         'apiOperation' => 'PROCESS_ACS_RESULT'
       }
 
-      request :post, "/merchant/#{merchant_id}/3DSecureId/#{three_domain_id}", params
+      ThreeDomainSecureResponse.new(request(:post, "/merchant/#{merchant_id}/3DSecureId/#{three_domain_id}", params))
     end
 
   private
 
-    def card_details token
-      {token_key(token) => token}
-    end
+    def source_of_funds(token)
+      params = ActiveSupport::OrderedHash.new
+      funds = ActiveSupport::OrderedHash.new
+      funds['type'] = 'CARD'
+
+      if token =~ CREDIT_CARD_TOKEN_FORMAT
+        funds['token'] = token
+        params['sourceOfFunds'] = funds
+      else
+        params['sourceOfFunds'] = funds
+        params['session'] = {'id' => token}
+      end
 
-    def token_key token
-      token =~ CREDIT_CARD_TOKEN_FORMAT ? 'cardToken' : 'session'
+      params
     end
 
-    def request method, path, options = {}
-      Request.new(self, method, path, options).perform
+    def request(*args)
+      Request.new(self, *args).perform
     end
   end
 end

data/lib/tns_payments/request.rb

@@ -5,7 +5,7 @@ module TNSPayments
   class Request
     attr_accessor :connection, :method, :path, :payload
 
-    def initialize connection, method, path, payload = {}
+    def initialize connection, method, path, payload = nil
       self.connection = connection
       self.method     = method
       self.path       = path
@@ -19,7 +19,7 @@ module TNSPayments
       headers = {}
       headers[:accept]        = '*/*'
       headers[:content_type]  = 'Application/json;charset=UTF-8'
-      headers[:Authorization] = encode_credentials if authorization
+      headers[:Authorization] = encode_credentials
       headers
     end
 
@@ -30,17 +30,17 @@ module TNSPayments
       args = {
         :method       => method,
         :url          => url,
-        :payload      => payload.to_json,
         :headers      => headers,
         :timeout      => 120,
         :open_timeout => 30
       }
+      args[:payload] = payload.to_json if payload
 
       Response.new RestClient::Request.execute(args)
     rescue RestClient::Exception => e
       response = e.response
 
-      if response.message == 'Request Timeout'
+      if e.is_a?(RestClient::RequestTimeout)
         response = JSON.generate({:error => {:cause => 'REQUEST_TIMEDOUT'}})
       end
 
@@ -49,16 +49,14 @@ module TNSPayments
 
   private
 
-    def authorization
-      payload.fetch(:authorization) { true }
-    end
-
     def encode_credentials
-      'Basic ' + Base64.encode64(":#{connection.api_key}")
+      credentials = ["merchant.#{connection.merchant_id}:#{connection.api_key}"].pack("m*").delete("\n")
+
+      "Basic #{credentials}"
     end
 
     def url
-      "#{connection.host}/api/rest/version/4#{path}"
+      "#{connection.host}/api/rest/version/32#{path}"
     end
   end
 end

data/lib/tns_payments/response.rb

@@ -1,3 +1,5 @@
+require 'delegate'
+
 module TNSPayments
   class Response
     attr_reader :raw_response
@@ -17,13 +19,7 @@ module TNSPayments
     #
     # Returns a string.
     def result
-      if response.has_key?('status')
-        response['status'] == 'OPERATING' ? 'SUCCESS' : 'ERROR'
-      elsif response.has_key?('3DSecure')
-        'SUCCESS'
-      else
-        response['result']
-      end
+      response.fetch('result') { 'UNKNOWN' }
     end
 
     # Public: Check if the request was successful.
@@ -44,4 +40,28 @@ module TNSPayments
       end
     end
   end
+
+  class UpdateSessionResponse < SimpleDelegator
+    def success?
+      update_status == 'SUCCESS'
+    end
+
+    private
+
+    def update_status
+      response['session']['updateStatus']
+    end
+  end
+
+  class AvailableResponse < SimpleDelegator
+    def success?
+      response['status'] == 'OPERATING'
+    end
+  end
+
+  class ThreeDomainSecureResponse < SimpleDelegator
+    def success?
+      response.has_key?("3DSecure")
+    end
+  end
 end

data/lib/tns_payments/test_support/card_session.rb

@@ -0,0 +1,77 @@
+# https://secure.ap.tnspayments.com/api/documentation/integrationGuidelines/supportedFeatures/testAndGoLive.html?locale=en_US
+module TNSPayments
+  module TestSupport
+    class CardSession
+      SAMPLE_CARDS = {
+        :mastercard => {
+          :number => "5123456789012346",
+          :expiry => {
+            :month => "5",
+            :year => "17",
+          },
+          :securityCode => "123",
+        },
+        :amex => {
+          :number => "345678901234564",
+          :expiry => {
+            :month => "5",
+            :year => "17",
+          },
+          :securityCode => "1234",
+        },
+        :visa => {
+          :number => "4005550000000001",
+          :expiry => {
+            :month => "5",
+            :year => "17",
+          },
+          :securityCode => "123",
+        },
+        :visa_enrolled_3ds => {
+          :number => "4508750015741019",
+          :expiry => {
+            :month => "05",
+            :year => "17",
+          },
+          :securityCode => "123",
+        },
+        :visa_not_enrolled_3ds => {
+          :number => "4005550000000001",
+          :expiry => {
+            :month => "05",
+            :year => "17",
+          },
+          :securityCode => "123",
+        },
+      }
+
+      def self.sample_card(card_type = :visa)
+        SAMPLE_CARDS.fetch(card_type)
+      end
+
+      def self.sample(card_type = :visa, *args)
+        sessionize(sample_card(card_type), *args)
+      end
+
+      def self.sessionize(card, *args)
+        session = new(*args)
+        session.store(card)
+        session.token
+      end
+
+      def initialize(tns)
+        @tns = tns
+      end
+
+      def token
+        @token ||= @tns.session_token
+      end
+
+      def store(card)
+        response = @tns.update_session_with_card(token, card)
+        raise response.response.inspect unless response.success?
+        response
+      end
+    end
+  end
+end

data/lib/tns_payments/version.rb

@@ -1,3 +1,3 @@
 module TNSPayments
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/test/cassettes/test_amex_successful_purchase.yml

@@ -0,0 +1,112 @@
+--- 
+recorded_with: VCR 2.9.3
+http_interactions: 
+- request: 
+    method: post
+    uri: https://merchant.<TNS_MERCHANT_ID>:<TNS_API_KEY>@secure.ap.tnspayments.com/api/rest/version/32/merchant/<TNS_MERCHANT_ID>/session
+    body: 
+      string: ""
+    headers: 
+      Accept: 
+      - "*/*"
+      Content-Type: 
+      - Application/json;charset=UTF-8
+      Accept-Encoding: 
+      - gzip, deflate
+  response: 
+    status: 
+      code: 201
+      message: Created
+    headers: 
+      Content-Length: 
+      - "149"
+      Content-Type: 
+      - application/json;charset=UTF-8
+      Date: 
+      - Mon, 11 Jan 2016 23:51:04 GMT
+      Pragma: 
+      - no-cache
+      Expires: 
+      - "0"
+      Set-Cookie: 
+      - TS018aacab=01c9ad79a0777676190757f71bce1b77e026c4ec88a6e8088ae37b951e999fdf69ef2438b0; Path=/
+      Cache-Control: 
+      - no-cache, no-store, must-revalidate
+    body: 
+      string: "{\"merchant\":\"<TNS_MERCHANT_ID>\",\"result\":\"SUCCESS\",\"session\":{\"id\":\"SESSION0002414369440E9534413G26\",\"updateStatus\":\"NO_UPDATE\",\"version\":\"c1669f4301\"}}"
+    http_version: 
+  recorded_at: Mon, 11 Jan 2016 23:51:05 GMT
+- request: 
+    method: put
+    uri: https://merchant.<TNS_MERCHANT_ID>:<TNS_API_KEY>@secure.ap.tnspayments.com/api/rest/version/32/merchant/<TNS_MERCHANT_ID>/session/SESSION0002414369440E9534413G26
+    body: 
+      string: "{\"sourceOfFunds\":{\"type\":\"CARD\",\"provided\":{\"card\":{\"number\":\"345678901234564\",\"expiry\":{\"month\":\"5\",\"year\":\"17\"},\"securityCode\":\"1234\"}}}}"
+    headers: 
+      Accept: 
+      - "*/*"
+      Content-Length: 
+      - "139"
+      Content-Type: 
+      - Application/json;charset=UTF-8
+      Accept-Encoding: 
+      - gzip, deflate
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Content-Length: 
+      - "337"
+      Content-Type: 
+      - application/json;charset=UTF-8
+      Date: 
+      - Mon, 11 Jan 2016 23:51:04 GMT
+      Pragma: 
+      - no-cache
+      Expires: 
+      - "0"
+      Set-Cookie: 
+      - TS018aacab=01c9ad79a00b36c4299550473029df7107a8073c81d7d5bcee01337bec979dba1ac9e1adff; Path=/
+      Cache-Control: 
+      - no-cache, no-store, must-revalidate
+    body: 
+      string: "{\"merchant\":\"<TNS_MERCHANT_ID>\",\"session\":{\"id\":\"SESSION0002414369440E9534413G26\",\"updateStatus\":\"SUCCESS\",\"version\":\"1b64e1a902\"},\"sourceOfFunds\":{\"provided\":{\"card\":{\"brand\":\"AMEX\",\"expiry\":{\"month\":\"5\",\"year\":\"17\"},\"fundingMethod\":\"CREDIT\",\"number\":\"345678xxxxx4564\",\"scheme\":\"AMEX\",\"securityCode\":\"xxxx\"}},\"type\":\"CARD\"},\"version\":\"32\"}"
+    http_version: 
+  recorded_at: Mon, 11 Jan 2016 23:51:05 GMT
+- request: 
+    method: put
+    uri: https://merchant.<TNS_MERCHANT_ID>:<TNS_API_KEY>@secure.ap.tnspayments.com/api/rest/version/32/merchant/<TNS_MERCHANT_ID>/order/10000001603/transaction/PAY
+    body: 
+      string: "{\"apiOperation\":\"PAY\",\"order\":{\"amount\":\"100.00\",\"currency\":\"EUR\",\"reference\":\"PAY\"},\"transaction\":{\"reference\":\"PAY\"},\"sourceOfFunds\":{\"type\":\"CARD\"},\"session\":{\"id\":\"SESSION0002414369440E9534413G26\"}}"
+    headers: 
+      Accept: 
+      - "*/*"
+      Content-Length: 
+      - "202"
+      Content-Type: 
+      - Application/json;charset=UTF-8
+      Accept-Encoding: 
+      - gzip, deflate
+  response: 
+    status: 
+      code: 201
+      message: Created
+    headers: 
+      Content-Length: 
+      - "1658"
+      Content-Type: 
+      - application/json;charset=UTF-8
+      Date: 
+      - Mon, 11 Jan 2016 23:51:05 GMT
+      Pragma: 
+      - no-cache
+      Expires: 
+      - "0"
+      Set-Cookie: 
+      - TS018aacab=01c9ad79a05005d6ce0661f0ff61ffd29ca1e182415e883508eb3c057212ebcb105ce187bc; Path=/
+      Cache-Control: 
+      - no-cache, no-store, must-revalidate
+    body: 
+      string: "{\"authorizationResponse\":{\"posData\":\"1605S0100130\",\"transactionIdentifier\":\"AmexTidTest\"},\"gatewayEntryPoint\":\"AUTO\",\"merchant\":\"<TNS_MERCHANT_ID>\",\"order\":{\"amount\":100.00,\"creationTime\":\"2016-01-11T23:51:05.330Z\",\"currency\":\"EUR\",\"id\":\"10000001603\",\"reference\":\"PAY\",\"status\":\"CAPTURED\",\"totalAuthorizedAmount\":100.00,\"totalCapturedAmount\":100.00,\"totalRefundedAmount\":0.00},\"response\":{\"acquirerCode\":\"000\",\"acquirerMessage\":\"Successful request\",\"cardSecurityCode\":{\"acquirerCode\":\"N\",\"gatewayCode\":\"NO_MATCH\"},\"gatewayCode\":\"APPROVED\"},\"result\":\"SUCCESS\",\"risk\":{\"response\":{\"gatewayCode\":\"ACCEPTED\",\"review\":{\"decision\":\"NOT_REQUIRED\"},\"rule\":[{\"data\":\"345678\",\"name\":\"MERCHANT_BIN_RANGE\",\"recommendation\":\"NO_ACTION\",\"type\":\"MERCHANT_RULE\"},{\"data\":\"N\",\"name\":\"MERCHANT_CSC\",\"recommendation\":\"NO_ACTION\",\"type\":\"MERCHANT_RULE\"},{\"name\":\"SUSPECT_CARD_LIST\",\"recommendation\":\"NO_ACTION\",\"type\":\"MERCHANT_RULE\"},{\"name\":\"TRUSTED_CARD_LIST\",\"recommendation\":\"NO_ACTION\",\"type\":\"MERCHANT_RULE\"},{\"data\":\"345678\",\"name\":\"MSO_BIN_RANGE\",\"recommendation\":\"NO_ACTION\",\"type\":\"MSO_RULE\"},{\"data\":\"N\",\"name\":\"MSO_CSC\",\"recommendation\":\"NO_ACTION\",\"type\":\"MSO_RULE\"}]}},\"sourceOfFunds\":{\"provided\":{\"card\":{\"brand\":\"AMEX\",\"expiry\":{\"month\":\"5\",\"year\":\"17\"},\"fundingMethod\":\"CREDIT\",\"number\":\"345678xxxxx4564\",\"scheme\":\"AMEX\"}},\"type\":\"CARD\"},\"timeOfRecord\":\"2016-01-11T23:51:05.376Z\",\"transaction\":{\"acquirer\":{\"batch\":1,\"id\":\"AMEXGWS\",\"merchantId\":\"9442891578\"},\"amount\":100.00,\"authorizationCode\":\"029328\",\"currency\":\"EUR\",\"frequency\":\"SINGLE\",\"id\":\"PAY\",\"receipt\":\"16011171\",\"reference\":\"PAY\",\"source\":\"MOTO\",\"terminal\":\"31208585\",\"type\":\"CAPTURE\"},\"version\":\"32\"}"
+    http_version: 
+  recorded_at: Mon, 11 Jan 2016 23:51:06 GMT