tokenex 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4672a0ace60e8132c8e064ace265829936ea45c3
-  data.tar.gz: bf2bddca1e836838bb39476b8bc7f0315ba61e30
+  metadata.gz: cd3be0f56b6f26df13c7c3df0468a3b2d5b520f9
+  data.tar.gz: c94fe90b7592994bf323fdee7c0f4f40fe32db51
 SHA512:
-  metadata.gz: 317a60967808c3c295137e4a5feee09f284989d1e9db0151fd6e266b89e0043d672685696c412f6102d252623a0356fec479997094bdeaf6b89291a93a555959
-  data.tar.gz: 2634b73416da8f12cb776c49091b1b9a3a65c9bb78b8ff14e67f9bfcd37517f2849571e03cd3d231c45972d891363a96b73fa46b3b6e4973f0c98263cb56f27d
+  metadata.gz: 24590d36757a638d6b2641a223d1af0c02ee1e3e2196bf43ef6687f8d7569bc9566b1fe1fafe1fd76d39236b082dd82a390589014950d196db8f5da8820a3bf8
+  data.tar.gz: d8f411289d0d5aef513e7265d0c5f2bacd352e7dcc5a24d70b6aacdbc7540c7d49653743694a7bf0873841634484e56f69703f3ef0b56452eb79b4ca4acdaa3f

data/README.md

@@ -58,8 +58,26 @@ token = tokenex.token_from_ccnum(4242424242424242)
 tokenex.delete_token(token)
 ```
 
+
+#### Errors and References
+
+Each action call will return a reference ID that can be used to lookup a call in
+the TokenEx dashboard. Unsuccessful calls will also return an error describing
+the problem. Each can be accessed via:
+```ruby
+tokenex.error
+tokenex.reference_number
+```
+
 ## Development
 
+Before proceeding, make sure the following environment variables are set (they are required for running the specs):
+```
+TOKENEX_API_BASE_URL=https://test-api.tokenex.com/TokenServices.svc/REST/
+TOKENEX_ID=<YOUR TOKENEX_ID>
+TOKENEX_API_KEY=<YOUR TOKENEX_API_KEY>
+```
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/tokenex.rb

@@ -1,4 +1,6 @@
 require "tokenex/version"
+require "tokenex/token_action"
+require "tokenex/token_params"
 require "tokenex/token_scheme"
 require "tokenex/environment"
 

data/lib/tokenex/environment.rb

@@ -4,6 +4,7 @@ require "uri"
 
 module Tokenex
     class Environment
+        attr_reader :error, :reference_number
 
         def initialize(api_base_url, tokenex_id, api_key, options={})
             @api_base_url = api_base_url
@@ -19,65 +20,60 @@ module Tokenex
         end
 
         def tokenize(data, token_scheme = TOKEN_SCHEME[:GUID])
-            action = "Tokenize"
             request_parameters = {
-                "Data" => data,
-                "TokenScheme" => token_scheme
+                REQUEST_PARAMS[:Data] => data,
+                REQUEST_PARAMS[:TokenScheme] => token_scheme
             }
 
-            response = send_request(action, request_parameters)
-            throw :tokenex_cannot_tokenize_data unless is_valid_response(response)
-
-            response['Token']
+            catch (:tokenex_invalid_response) do
+                return send_request(TOKEN_ACTION[:Tokenize], request_parameters)
+            end
+            throw :tokenex_cannot_tokenize_data
         end
 
         def tokenize_from_encrypted_value(encrypted_data, token_scheme)
-            action = "TokenizeFromEncryptedValue"
             request_parameters = {
-                "EcryptedData" => encrypted_data,
-                "TokenScheme" => token_scheme
+                REQUEST_PARAMS[:EncryptedData] => encrypted_data,
+                REQUEST_PARAMS[:TokenScheme] => token_scheme
             }
 
-            response = send_request(action, request_parameters)
-            throw :tokenex_cannot_tokenize_from_encrypted_value unless is_valid_response(response)
-
-            response['Token']
+            catch (:tokenex_invalid_response) do
+                return send_request(TOKEN_ACTION[:TokenizeFromEncryptedValue], request_parameters)
+            end
+            throw :tokenex_cannot_tokenize_from_encrypted_value
         end
 
         def detokenize(token)
-            action = "Detokenize"
             request_parameters = {
-                "Token" => token
+                REQUEST_PARAMS[:Token] => token
             }
 
-            response = send_request(action, request_parameters)
-            throw :tokenex_invalid_token unless is_valid_response(response)
-
-            response['Value']
+            catch (:tokenex_invalid_response) do
+                return send_request(TOKEN_ACTION[:Detokenize], request_parameters)
+            end
+            throw :tokenex_invalid_token
         end
 
         def validate_token(token)
-            action = "ValidateToken"
             request_parameters = {
-                "Token" => token
+                REQUEST_PARAMS[:Token] => token
             }
 
-            response = send_request(action, request_parameters)
-            throw :tokenex_invalid_token unless is_valid_response(response)
-
-            response['Valid']
+            catch (:tokenex_invalid_response) do
+                return send_request(TOKEN_ACTION[:ValidateToken], request_parameters)
+            end
+            throw :tokenex_invalid_token
         end
 
         def delete_token(token)
-            action = "DeleteToken"
             request_parameters = {
-                "Token" => token
+                REQUEST_PARAMS[:Token] => token
             }
 
-            response = send_request(action, request_parameters)
-            throw :tokenex_invalid_token unless is_valid_response(response)
-
-            response['Success']
+            catch (:tokenex_invalid_response) do
+                return send_request(TOKEN_ACTION[:DeleteToken], request_parameters)
+            end
+            throw :tokenex_invalid_token
         end
 
         private
@@ -88,31 +84,32 @@ module Tokenex
             }
         end
 
-        def build_request_array(data)
-            request_array = {
-                "APIKey" => @api_key,
-                "TokenExID" => @tokenex_id
+        def request(data)
+            {
+                REQUEST_PARAMS[:APIKey] => @api_key,
+                REQUEST_PARAMS[:TokenExID] => @tokenex_id
             }.merge(data)
-
-            request_array
         end
 
         def send_request(action, data)
-            request_body = build_request_array(data).to_json
-
-            uri = URI.parse("#{@api_base_url}#{action}")
+            uri = URI.parse("#{@api_base_url}#{action[:Name]}")
             http = Net::HTTP.new(uri.host, uri.port)
             http.use_ssl = true
             http.verify_mode = OpenSSL::SSL::VERIFY_PEER
 
             request = Net::HTTP::Post.new(uri, initheader = headers)
-            request.body = request_body
+            request.body = request(data).to_json
             response = http.request(request)
-            JSON.parse(response.body)
+            return_data = JSON.parse(response.body)
+            throw :tokenex_invalid_response unless is_valid_response(return_data)
+
+            return_data[action[:Key]]
         end
 
         def is_valid_response(response)
-            !response['Success'].nil? && response['Success'] == true
+            @error = response[RESPONSE_PARAMS[:Error]].empty? ? nil : response[RESPONSE_PARAMS[:Error]]
+            @reference_number = response[RESPONSE_PARAMS[:ReferenceNumber]].empty? ? nil : response[RESPONSE_PARAMS[:ReferenceNumber]]
+            !response[RESPONSE_PARAMS[:Success]].nil? && response[RESPONSE_PARAMS[:Success]] == true
         end
 
     end

data/lib/tokenex/token_action.rb

@@ -0,0 +1,24 @@
+module Tokenex
+  TOKEN_ACTION = {
+    Tokenize: {
+        Name: 'Tokenize',
+        Key: 'Token'
+    },
+    TokenizeFromEncryptedValue: {
+        Name: 'TokenizeFromEncryptedValue',
+        Key: 'Token'
+    },
+    ValidateToken: {
+        Name: 'ValidateToken',
+        Key: 'Valid'
+    },
+    Detokenize: {
+        Name: 'Detokenize',
+        Key: 'Value'
+    },
+    DeleteToken: {
+        Name: 'DeleteToken',
+        Key: 'Success'
+    }
+  }
+end

data/lib/tokenex/token_params.rb

@@ -0,0 +1,19 @@
+module Tokenex
+  REQUEST_PARAMS = {
+    APIKey: 'APIKey',
+    Data: 'Data',
+    EncryptedData: 'EcryptedData',
+    Token: 'Token',
+    TokenExID: 'TokenExID',
+    TokenScheme: 'TokenScheme',
+  }
+
+  RESPONSE_PARAMS = {
+    Token: 'Token',
+    Success: 'Success',
+    ReferenceNumber: 'ReferenceNumber',
+    Error: 'Error',
+    Valid: 'Valid',
+    Value: 'Value'
+  }
+end

data/lib/tokenex/version.rb

@@ -1,3 +1,3 @@
 module Tokenex
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokenex
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Michael Clifford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,8 @@ files:
 - bin/setup
 - lib/tokenex.rb
 - lib/tokenex/environment.rb
+- lib/tokenex/token_action.rb
+- lib/tokenex/token_params.rb
 - lib/tokenex/token_scheme.rb
 - lib/tokenex/version.rb
 - tokenex.gemspec
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Provides a Ruby wrapper for the TokenEx API