tokenex 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f44d917728afc03538828d627a7ab0e43039cfc0
-  data.tar.gz: b4a804d98951c854dfa62a9e24e73e0946de5f5b
+  metadata.gz: 4672a0ace60e8132c8e064ace265829936ea45c3
+  data.tar.gz: bf2bddca1e836838bb39476b8bc7f0315ba61e30
 SHA512:
-  metadata.gz: 0e96c22a74e3602dafe94ea18a6b89c01e1f6b7fb63bfad3767b09b5cd414a12ad27ceb48613e9da9ff4d7be7c626906f9e356c751a5e3344e4e1ef7eb2ad024
-  data.tar.gz: 7e1e551740ed8bb415a7f4af2bd9275cc720b1ef652dae431cb2a25edfcbf74c857f4b86e5e618d73b21ac87b0c73ed1b01d229d202cb66b383af7b8a836060f
+  metadata.gz: 317a60967808c3c295137e4a5feee09f284989d1e9db0151fd6e266b89e0043d672685696c412f6102d252623a0356fec479997094bdeaf6b89291a93a555959
+  data.tar.gz: 2634b73416da8f12cb776c49091b1b9a3a65c9bb78b8ff14e67f9bfcd37517f2849571e03cd3d231c45972d891363a96b73fa46b3b6e4973f0c98263cb56f27d

data/README.md

@@ -22,17 +22,39 @@ Or install it yourself as:
 
 ### Tokenization
 
-Let's start with a simple tokenization and detokenization of a credit card record:
+#### Initialize your TokenEx object
+
+The examples below require you first instantiate a new TokenEx object
 
 ```ruby
 tokenex = Tokenex::Environment.new(api_base_url, token_ex_id, api_key)
+```
+
+#### Tokenize a credit card number
+```ruby
+token = tokenex.token_from_ccnum(4242424242424242)
+```
+
+#### Tokenize arbitrary data
+```ruby
+token = tokenex.tokenize("This is random data containing 3 numbers less than 10")
+```
+
+#### Detokenize a token
+```ruby
+token = tokenex.token_from_ccnum(4242424242424242)
+data = tokenex.detokenize(token)
+```
+
+#### Validate a token
+```ruby
+token = tokenex.token_from_ccnum(4242424242424242)
+token_is_valid = tokenex.validate_token(token)
+```
+
+#### Delete a token
+```ruby
 token = tokenex.token_from_ccnum(4242424242424242)
-ccnum = tokenex.detokenize(token)
-is_valid_token = tokenex.validate_token(token)
-tokenex.delete_token(token)
-arbitrary_data = "This is my string with 3 numbers less than 10"
-token = tokenex.tokenize(arbitrary_data)
-arbitrary_data = tokenex.detokenize(token)
 tokenex.delete_token(token)
 ```
 
@@ -50,4 +72,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/radpad
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/tokenex.rb

@@ -1,6 +1,7 @@
 require "tokenex/version"
+require "tokenex/token_scheme"
 require "tokenex/environment"
 
 module Tokenex
-  
+
 end

data/lib/tokenex/environment.rb

@@ -11,14 +11,14 @@ module Tokenex
             @api_key = api_key
         end
 
-        def token_from_ccnum(ccnum, token_scheme = 3)
+        def token_from_ccnum(ccnum, token_scheme = TOKEN_SCHEME[:TOKENfour])
             catch (:tokenex_cannot_tokenize_data) do
                 return tokenize(ccnum, token_scheme)
             end
             throw :tokenex_invalid_ccnum
         end
 
-        def tokenize(data, token_scheme = 4)
+        def tokenize(data, token_scheme = TOKEN_SCHEME[:GUID])
             action = "Tokenize"
             request_parameters = {
                 "Data" => data,
@@ -28,7 +28,7 @@ module Tokenex
             response = send_request(action, request_parameters)
             throw :tokenex_cannot_tokenize_data unless is_valid_response(response)
 
-            return response['Token']
+            response['Token']
         end
 
         def tokenize_from_encrypted_value(encrypted_data, token_scheme)
@@ -41,7 +41,7 @@ module Tokenex
             response = send_request(action, request_parameters)
             throw :tokenex_cannot_tokenize_from_encrypted_value unless is_valid_response(response)
 
-            return response['Token']
+            response['Token']
         end
 
         def detokenize(token)
@@ -53,7 +53,7 @@ module Tokenex
             response = send_request(action, request_parameters)
             throw :tokenex_invalid_token unless is_valid_response(response)
 
-            return response['Value']
+            response['Value']
         end
 
         def validate_token(token)
@@ -65,7 +65,7 @@ module Tokenex
             response = send_request(action, request_parameters)
             throw :tokenex_invalid_token unless is_valid_response(response)
 
-            return response['Valid']
+            response['Valid']
         end
 
         def delete_token(token)
@@ -77,7 +77,7 @@ module Tokenex
             response = send_request(action, request_parameters)
             throw :tokenex_invalid_token unless is_valid_response(response)
 
-            return response['Success']
+            response['Success']
         end
 
         private
@@ -94,7 +94,7 @@ module Tokenex
                 "TokenExID" => @tokenex_id
             }.merge(data)
 
-            return request_array
+            request_array
         end
 
         def send_request(action, data)
@@ -108,11 +108,11 @@ module Tokenex
             request = Net::HTTP::Post.new(uri, initheader = headers)
             request.body = request_body
             response = http.request(request)
-            return JSON.parse(response.body)
+            JSON.parse(response.body)
         end
 
         def is_valid_response(response)
-            return !response['Success'].nil? && response['Success'] === true
+            !response['Success'].nil? && response['Success'] == true
         end
 
     end

data/lib/tokenex/token_scheme.rb

@@ -0,0 +1,23 @@
+module Tokenex
+  # http://docs.tokenex.com/#appendix-token-schemes
+  TOKEN_SCHEME = {
+    sixTokenfour: 1,
+    fourTOKENfour: 2,
+    TOKENfour: 3,
+    GUID: 4,
+    SSN: 5,
+    nGUID: 6,
+    nTOKENfour: 7,
+    nTOKEN: 8,
+    sixANTOKENfour: 9,
+    fourANTOKENfour: 10,
+    ANTOKENfour: 11,
+    ANTOKEN: 12,
+    ANTOKENAUTO: 13,
+    ASCIITOKENfour: 14,
+    ASCIITOKEN: 15,
+    sixASCIITOKENfour: 16,
+    fourASCIITOKENfour: 17,
+    ASCIITOKENAUTO: 18
+  }
+end

data/lib/tokenex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokenex
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Michael Clifford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,7 @@ files:
 - bin/setup
 - lib/tokenex.rb
 - lib/tokenex/environment.rb
+- lib/tokenex/token_scheme.rb
 - lib/tokenex/version.rb
 - tokenex.gemspec
 homepage: https://github.com/radpad/tokenex-gem