tns_payments 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.0.5 / 2012-03-29
+
+* Tokenize credit card.
+* Request gets it's own class.
+* Raise SessionTokenException when `session_token` request is invalid.
+
 ## 0.0.4 / 2012-03-08
 
 * Check credit card token length as well as starting digit.

data/lib/tns_payments/connection.rb

@@ -1,12 +1,11 @@
 require 'base64'
-require 'json'
-require 'rest-client'
 
 module TNSPayments
   class Connection
     CREDIT_CARD_TOKEN_FORMAT = /^9\d{15}/
 
     attr_accessor :host
+    attr_reader :api_key, :merchant_id
     attr_writer :session_token
 
     def available?
@@ -28,12 +27,12 @@ module TNSPayments
       transaction_id = transaction.transaction_id
       params         = {
         'apiOperation' => 'PAY',
-        'order'        => {'reference'               => transaction.reference},
-        'cardDetails'  => {purchase_token_key(token) => token},
-        'transaction'  => {'amount'                  => transaction.amount.to_s, 'currency' => transaction.currency, 'reference' => transaction_id.to_s}
+        'cardDetails'  => card_details(token),
+        'order'        => {'reference' => transaction.reference},
+        'transaction'  => {'amount'    => transaction.amount.to_s, 'currency' => transaction.currency, 'reference' => transaction_id.to_s}
       }
 
-      request :put, "/merchant/#{@merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
+      request :put, "/merchant/#{merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
     end
 
     def refund transaction
@@ -44,52 +43,40 @@ module TNSPayments
         'transaction'  => {'amount' => transaction.amount.to_s, 'currency' => transaction.currency, 'reference' => transaction_id.to_s}
       }
 
-      request :put, "/merchant/#{@merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
+      request :put, "/merchant/#{merchant_id}/order/#{order_id}/transaction/#{transaction_id}", params
     end
 
-    def create_credit_card_token
-      request :post, "/merchant/#{@merchant_id}/token"
+    def create_credit_card_token token
+      params = {
+        'cardDetails' => card_details(token)
+      }
+
+      request :post, "/merchant/#{merchant_id}/token", params
     end
 
     def delete_credit_card_token token
-      request :delete, "/merchant/#{@merchant_id}/token/#{token}"
+      request :delete, "/merchant/#{merchant_id}/token/#{token}"
     end
 
     def session_token
       @session_token ||= begin
-        response = request :post, "/merchant/#{@merchant_id}/session"
-        response.success?? response.response['session'] : raise(response.response.inspect)
+        response = request :post, "/merchant/#{merchant_id}/session"
+        response.response.fetch('session') { raise(SessionTokenException.new, response.message) }
       end
     end
 
   private
 
-    def api_url
-      "#{host}/api/rest/version/4"
-    end
-
-    def encode_credentials
-      credentials = ['', @api_key].join(':')
-      'Basic ' << Base64.encode64(credentials)
+    def card_details token
+      {token_key(token) => token}
     end
 
-    def purchase_token_key token
+    def token_key token
       token =~ CREDIT_CARD_TOKEN_FORMAT ? 'cardToken' : 'session'
     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
+      Request.new(self, method, path, options).perform
     end
   end
 end

data/lib/tns_payments/request.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'rest-client'
+
+module TNSPayments
+  class Request
+    attr_accessor :connection, :method, :path, :options
+
+    def initialize connection, method, path, options = {}
+      self.connection, self.method, self.path, self.options = connection, method, path, options
+    end
+
+    def perform
+      authorization = options.fetch(:authorization) { true }
+      url           = "#{connection.host}/api/rest/version/4#{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 RestClient.send(method, url, *args)
+    rescue RestClient::Exception => e
+      Response.new({:result => e.message.upcase, :response => JSON.parse(e.response || '{}')}.to_json)
+    end
+
+  private
+
+    def encode_credentials
+      'Basic ' + Base64.encode64(":#{connection.api_key}")
+    end
+  end
+end

data/lib/tns_payments/response.rb

@@ -1,22 +1,26 @@
 module TNSPayments
   class Response
-    extend Forwardable
+    attr_reader :raw_response
 
-    attr_reader :response
-
-    def_delegators :credit_card, :card_type
-
-    def initialize body
-      @response = body
-      @result   = @response['result'] || @response['status']
+    def initialize response
+      @raw_response = response
     end
 
-    def credit_card
-      @credit_card ||= Tns::CreditCard.new @response['card']
+    def response
+      @response ||= JSON.parse(raw_response)
     end
 
     def success?
-      %w[SUCCESS OPERATING].include? @result
+      %w[SUCCESS OPERATING].include? response['result'] || response['status']
+    end
+
+    def message
+      result = response['response'].fetch('result') { 'SUCCESS' }
+      if result == 'ERROR'
+        response['response']['error']['explanation']
+      else
+        'Successful request'
+      end
     end
   end
 end

data/lib/tns_payments/version.rb

@@ -1,3 +1,3 @@
 module TNSPayments
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/tns_payments.rb

@@ -1,9 +1,11 @@
 require 'tns_payments/connection'
-require 'tns_payments/credit_card'
+require 'tns_payments/request'
 require 'tns_payments/response'
 require 'tns_payments/version'
 
 module TNSPayments
+  class SessionTokenException < Exception; end
+
   def self.new options = {}
     Connection.new options
   end

data/test/unit/conntection_test.rb

@@ -64,29 +64,29 @@ class TNSPayments::ConnectionTest < MiniTest::Unit::TestCase
   end
 
   def test_create_credit_card_token_successfully_stores_creditcard
-    stub_successful_create_credit_card_token_request
-    assert @gateway.create_credit_card_token.success?
+    stub_successful_create_credit_card_token_request 'SESSIONTOKEN'
+    assert @gateway.create_credit_card_token('SESSIONTOKEN').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']
+    stub_successful_create_credit_card_token_request 'SESSIONTOKEN'
+    token = @gateway.create_credit_card_token('SESSIONTOKEN').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?
+    stub_unsuccessful_create_credit_card_token_request 'SESSIONTOKEN'
+    refute @gateway.create_credit_card_token('SESSIONTOKEN').success?
   end
 
   def test_delete_credit_card_token_successfully_deletes_a_stored_credit_card_token
-    stub_successful_delete_credit_card_token_request
+    stub_successful_delete_credit_card_token_request '9123456781234567'
     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
+    stub_unsuccessful_delete_credit_card_token_request '9123456781234567'
     refute @gateway.delete_credit_card_token('9123456781234567').success?
   end
 
@@ -95,6 +95,13 @@ class TNSPayments::ConnectionTest < MiniTest::Unit::TestCase
     assert_equal 'SESSIONTOKEN', @gateway.session_token
   end
 
+  def test_unsuccessful_session_token_request_raises_an_exception
+    stub_session_token_request.to_return(:status => 400, :body => '{}')
+    assert_raises SessionTokenException do
+      @gateway.session_token
+    end
+  end
+
 private
 
   def stub_availability_request
@@ -137,23 +144,23 @@ private
       to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
   end
 
-  def stub_successful_create_credit_card_token_request
-    stub_create_credit_card_token_request.
+  def stub_successful_create_credit_card_token_request token
+    stub_create_credit_card_token_request(token).
       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.
+  def stub_unsuccessful_create_credit_card_token_request token
+    stub_create_credit_card_token_request(token).
       to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
   end
 
-  def stub_successful_delete_credit_card_token_request
-    stub_delete_credit_card_token_request.
+  def stub_successful_delete_credit_card_token_request token
+    stub_delete_credit_card_token_request(token).
       to_return(:status => 200, :body => '{"result":"SUCCESS"}', :headers => {})
   end
 
-  def stub_unsuccessful_delete_credit_card_token_request
-    stub_delete_credit_card_token_request.
+  def stub_unsuccessful_delete_credit_card_token_request token
+    stub_delete_credit_card_token_request(token).
       to_return(:status => 200, :body => '{"result":"FAILURE"}', :headers => {})
   end
 
@@ -218,14 +225,24 @@ private
            }
   end
 
-  def stub_create_credit_card_token_request
+  def stub_create_credit_card_token_request token
     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 => {})
+      with :body => JSON.generate({
+             'cardDetails' => {'session' => token}
+           }),
+           :headers => {
+             'Accept'       => '*/*',
+             'Content-Type' => 'Application/json;charset=UTF-8'
+           }
   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 => {})
+  def stub_delete_credit_card_token_request token
+    stub_request(:delete, /https:\/\/:#{@api_key}@secure\.ap\.tnspayments\.com\/api\/rest\/version\/4\/merchant\/#{@merchant_id}\/token\/#{token}/).
+      with :body    => {},
+           :headers => {
+             'Accept'       => '*/*',
+             'Content-Type' => 'Application/json;charset=UTF-8'
+           }
   end
 
   def mock_transaction

data/test/unit/response_test.rb

@@ -1,4 +1,29 @@
 require 'helper'
 
 class TNSPayments::ResponseTest < MiniTest::Unit::TestCase
+  def test_success_when_operating
+    assert Response.new({:result => 'OPERATING'}.to_json).success?
+  end
+
+  def test_success_when_success
+    assert Response.new({:result => 'SUCCESS'}.to_json).success?
+  end
+
+  def test_success_when_not_successful
+    refute Response.new({:result => '404 RESOURCE NOT FOUND'}.to_json).success?
+  end
+
+  def test_message_when_error_request
+    response = "{\"result\":\"401 UNAUTHORIZED\",\"response\":{\"error\":{\"cause\":\"INVALID_REQUEST\",\"explanation\":\"Invalid credentials.\"},\"result\":\"ERROR\"}}"
+    assert_equal 'Invalid credentials.', Response.new(response).message
+  end
+
+  def test_message_when_success_request
+    assert_equal 'Successful request', Response.new({:result => 'SUCCESS', :response => {}}.to_json).message
+  end
+
+  def test_raw_response_is_the_json
+    response = "{\"result\":\"401 UNAUTHORIZED\",\"response\":{\"error\":{\"cause\":\"INVALID_REQUEST\",\"explanation\":\"Invalid credentials.\"},\"result\":\"ERROR\"}}"
+    assert_equal response, Response.new(response).raw_response
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tns_payments
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Tim Cooper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-08 00:00:00 +10:00
+date: 2012-03-29 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -104,7 +104,7 @@ files:
 - Rakefile
 - lib/tns_payments.rb
 - lib/tns_payments/connection.rb
-- lib/tns_payments/credit_card.rb
+- lib/tns_payments/request.rb
 - lib/tns_payments/response.rb
 - lib/tns_payments/version.rb
 - test/helper.rb

data/lib/tns_payments/credit_card.rb

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