textkey_rest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c918a5c5d0b323764790abb656360b2afa93cc98
+  data.tar.gz: 34796a2bcd7384ffe2d02ffa53be2f28a1a0ad1a
+SHA512:
+  metadata.gz: 8db6085be1a1baf6503e266ad6ecc94b69ec1515a5b491ca7b0fac0ee807f323b34047d197a6ae0a52c56d156bf0409de30e24e3d51c8c2ea62c7196d6d72d6a
+  data.tar.gz: 2df70a6ad089d39abd7d0caf7931a9c63e8593216d2f0e4e94ad98e7711705c0d2cf3847e82c3124f48ea7f2ee3e7a57d8c81845f6a385f8d5a8c2ab33ec2a5e

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Macisms
+*.DS_Store
+
+# Any Gem files        
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TextPower, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+TextKey REST Library
+====================
+
+This Ruby library allows you to use TextKey's REST API calls server-side from a Ruby backend.
+
+Common use-Case
+---------------
+
+To ensure a secure environment, you don't want to use APIs directly from the front-end, but rather through web-services inside your Ruby backend.
+
+More Information
+----------------
+
+To get more detailed information on the TextKey API Services or to investigate the API in more detail, you can refer to the following:
+
+* [TextKey Developer Site](http://developer.textkey.com)
+* [TextKey API Call Documentation](http://developer.textkey.com/apidocumentation.php)
+* [Test All TextKey API Calls](http://developer.textkey.com/apitestapicalls.php)
+* [TextKey Sample Site](http://developer.textkey.com/apitextkeyexample.php)
+
+Installing the Library
+----------------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'textkey_rest'
+```
+
+Or install it from the command line:
+
+    $ gem install textkey_rest
+
+Building the textkey_rest GEM
+-----------------------------
+
+From the root directory, run the following:
+
+    $ gem build textkey_rest.gemspec
+
+Then you can install it yourself locally:
+
+    $ gem install ./textkey_rest-X.X.X.gem
+
+How to use it?
+--------------
+
+The simple use case is to create a textkey object, call the appropriate API method and handle the returned object payload. The class will handle the details between the request and response and will return an object to work with.
+
+For example, here is a use case to check if a user has already been registered using the `doesRegistrationUserIDExist` API Call.
+
+```ruby
+# TestDoesRegistrationUserIdExist.rb
+# 
+require 'json'
+require 'textkey_rest'
+
+# Setup
+apiKey = "PUT API KEY HERE"
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+userID = "BobSmithUID"
+isHashed = "TRUE"
+
+# Make the API Call
+response = textkey.perform_DoesRegistrationUserIDExist(userID, isHashed)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data
+```
+
+Initialization
+---------------
+
+The basic initialize step consists of including the REST Library and then creating a textkey object.
+
+```ruby
+require 'json'
+require 'textkey_rest'
+
+# Setup
+apiKey = "PUT API KEY HERE"
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+```
+
+Making the API Call
+-------------------
+
+Once initialized, you can now make a call out to the specific TextKey API using the textkey object you just created.
+
+```ruby
+# Setup the API parameters
+userID = "BobSmithUID"
+isHashed = "TRUE"
+
+# Make the API Call
+response = textkey.perform_DoesRegistrationUserIDExist(userID, isHashed)
+```
+
+Handling the resulting payload
+------------------------------
+
+The API call will return back a JSON string with all of the API fields included. It is wrapped in the `d` parent element so that wrapper should be removed.
+
+```ruby
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data
+```
+
+NOTE: If there is an error, the `errorDescr` field of the returned JSON payload will contain a value.
+
+Sample/Test Code
+----------------
+
+There is sample/test code in the [test Folder](https://github.com/TEXTPOWER/RESTLibrary-ruby/tree/master/test) for each TextKey API call using the shared library. Just set your API Key in the configuration.rb file in the test folder. To run all of the tests, run TestAll.rb.
+
+Contributing to this SDK
+------------------------
+
+**Issues**
+
+Please discuss issues and features on Github Issues. We'll be happy to answer to your questions and improve the SDK based on your feedback.
+
+**Pull requests**
+
+You are welcome to fork this SDK and to make pull requests on Github. We'll review each of them, and integrate in a future release if they are relevant.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/textkey_rest.rb

@@ -0,0 +1,5 @@
+require "textkey_rest/version"
+require "textkey_rest/textkey"
+
+module TextkeyRest
+end

data/lib/textkey_rest/configuration.rb

@@ -0,0 +1,5 @@
+module TextkeyRest
+ module Config
+    TK_BASE  = { :rest_url =>  "https://secure.textkey.com/REST/TKRest.asmx/" }
+  end
+end

data/lib/textkey_rest/textkey.rb

@@ -0,0 +1,417 @@
+#
+# textkey.rb
+# 
+# This library allows for making RESTful API requests
+# to the TextKey REST API Service
+#
+# Author::  Stan Shaul
+# Copyright:: Copyright (c) 2014 TextPower, Inc.
+# License::   Distributes under the same terms as Ruby
+
+require 'rest_client'
+require 'json'
+require 'textkey_rest/configuration'
+
+class TextKeyRest
+  @authKey
+  @displayInfo
+
+  # constructor
+  def initialize(authKey, displayInfo=false)
+	# Set the API Key
+    @authKey = authKey
+	
+	# Set the display options
+    @displayInfo = displayInfo
+  end
+
+  # 
+  # performs the POST request
+  # 
+  # * *Args* :
+  #   - +url+ -> The TextKey REST URL
+  #   - +postdata+ -> The post data for the request
+  # 
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  # * *Raises* :
+  # 
+  def sendAPIRequest(url, postdata)
+    # If show flag is set show the parameters
+    if @displayInfo
+      puts 'url: ' + url
+      puts 'Payload:'
+      puts JSON.pretty_generate postdata
+    end
+	
+    # Send the API request
+    response = RestClient.post(url, 
+                               postdata.to_json, 
+                               :content_type => 'application/json')
+
+    # If show flag is set show the return payload
+    if @displayInfo
+      puts 'Results:'
+      puts JSON.pretty_generate JSON.parse(response)
+    end
+	
+    return response.body
+  end
+
+  # 
+  # perform_GetTempAPI_Key - Sends the gettempAPIKey API Request and return the results
+  # 
+  # * *Args* :
+  #   - +minutesDuration+ -> The number of minutes that this API key will be valid
+  # 
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  # * *Raises* :
+  # 
+  def perform_GetTempAPI_Key(minutesDuration)
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "gettempAPIKey";
+	
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :minutesDuration => minutesDuration } }
+	
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_registerTextKeyUser - Send the perform_registerTextKeyUser API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +command+ -> The register command	
+  #   - +cellNumber+ -> The Cell Number that you are registering	
+  #   - +ownerFName+ -> User's First Name
+  #   - +ownerLName+ -> User's Last Name
+  #   - +suppl1+ -> An additional identifier chosen by the customer
+  #   - +suppl2+ -> Another additional identifier chosen by the customer
+  #   - +userID+ -> The user id that the end user has entered on the web site login page
+  #   - +isHashed+ -> Is the user id hashed
+  #   - +pinCode+ -> The numeric Pin Code
+  #   - +distressPinCode+ -> The numeric Distress Pin Code 
+  #   - +textKeyMode+ -> The TextKey validation mode
+  #   - +receiveMode+ -> The TextKey receive mode
+  # 
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_registerTextKeyUser(command, cellNumber, ownerFName, ownerLName, suppl1, suppl2, userID, isHashed, pinCode, distressPinCode, textKeyMode, receiveMode)		
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "registerTextKeyUser";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :command => command, :cellNumber => cellNumber, :ownerFName => ownerFName, :ownerLName => ownerLName, :suppl1 => suppl1, :suppl2 => suppl2, :userID => userID, :isHashed => isHashed, :pinCode => pinCode, :distresspinCode => distressPinCode, :textKeyMode => textKeyMode, :receiveMode => receiveMode } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_registerTextKeyUserCSA - Send the perform_registerTextKeyUserCSA API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +command+ -> The register command	
+  #   - +cellNumber+ -> The Cell Number that you are registering	
+  #   - +ownerFName+ -> User's First Name
+  #   - +ownerLName+ -> User's Last Name
+  #   - +suppl1+ -> An additional identifier chosen by the customer
+  #   - +suppl2+ -> Another additional identifier chosen by the customer
+  #   - +ownerBirthDate+ -> Users birth date. The format should be MM/DD/YYYY (i.e. 12/25/1984)
+  #   - +gender+ -> The users gender. The values should be either M or F.
+  #   - +userID+ -> The user id that the end user has entered on the web site login page
+  #   - +isHashed+ -> Is the user id hashed
+  #   - +pinCode+ -> The numeric Pin Code
+  #   - +q1+ -> The first user profile question. 
+  #   - +a1+ -> The answer to the first user question.
+  #   - +q2+ -> The second user profile question. 
+  #   - +a2+ -> The answer to the second user question.
+  #   - +q3+ -> The third user profile question. 
+  #   - +a3+ -> The answer to the third user question.
+  #   - +textKeyMode+ -> The TextKey validation mode
+  #   - +receiveMode+ -> The TextKey receive mode.
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_registerTextKeyUserCSA(command,
+                                     cellNumber, 
+                                     ownerFName, 
+                                     ownerLName, 
+                                     suppl1, 
+                                     suppl2, 
+                                     ownerBirthDate, 
+                                     gender, 											     
+                                     userID, 
+                                     isHashed, 
+                                     pinCode, 
+                                     distressPinCode, 
+                                     q1, 
+                                     a1, 
+                                     q2, 
+                                     a2, 
+                                     q3, 
+                                     a3, 
+                                     textKeyMode, 
+                                     receiveMode)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "registerTextKeyUser";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :command => command, :cellNumber => cellNumber, :ownerFName => ownerFName, :ownerLName => ownerLName, :suppl1 => suppl1, :suppl2 => suppl2, :ownerBirthDate => ownerBirthDate, :ownergender => gender, :userID => userID, :isHashed => isHashed, :pinCode => pinCode, :distresspinCode => distressPinCode, :q1 => q1, :a1 => a1, :q2 => q2, :a2 => a2, :q3 => q3, :a3 => a3, :textKeyMode => textKeyMode, :receiveMode => receiveMode } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_IssueTextKeyFromUserId - Send the perform_IssueTextKeyFromUserId API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +userID+ -> The unique identifier that was used when the user was registered with
+  #   - +isHashed+ -> Indicates if the userID was hashed before the user was registered.
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_IssueTextKeyFromUserId(userID, 
+                                     isHashed)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "issueTextKeyFromUserId";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :userID => userID, :isHashed => isHashed } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_IssueTextKeyFromUserId - Send the perform_IssueTextKeyFromUserId API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +retrieveBy+ -> Defines the type of retrieve option to use
+  #   - +cellNumber+ -> The Cell Number that you are registering	
+  #   - +suppl1+ -> The suppl1 field value that you are searching for
+  #   - +suppl2+ -> The suppl2 field value that you are searching fo
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_getTextKeyRegistration(retrieveBy,
+                                     cellNumber, 
+                                     suppl1, 
+                                     suppl2)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "getTextKeyRegistration";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :retrieveBy => retrieveBy, :cellNumber => cellNumber, :suppl1 => suppl1, :suppl2 => suppl2 } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_DoesRegistrationUserIDExist - Send the perform_DoesRegistrationUserIDExist API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +userID+ -> The unique identifier that was used when the user was registered with
+  #   - +isHashed+ -> Indicates if the userID was hashed before the user was registered.
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_DoesRegistrationUserIDExist(userID, 
+                                          isHashed)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "doesRegistrationUserIdExist";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :userID => userID, :isHashed => isHashed } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_DoesRegistrationCellNumberExist - Send the doesRegistrationcellNumberExist API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +cellNumber+ -> The Cell Number that was used when the user was registered with
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_DoesRegistrationCellNumberExist(cellNumber)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "doesRegistrationcellNumberExist";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :cellNumber => cellNumber } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+	
+  #
+  # perform_CreateNewCellNumberProxy - Send the createNewcellNumberProxy API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +cellNumber+ -> The Cell Number that was used when the user was registered with
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_CreateNewCellNumberProxy(cellNumber)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "createNewcellNumberProxy";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :truecellNumber => cellNumber } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_RemoveTempAPIKey - Send the removetempAPIKey API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +tempAPIKey+ -> The temporary API Key to remove
+  #   - +minutesDuration+ -> This parameter is ignored but still must still be passed in with an integer value
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_RemoveTempAPIKey(tempAPIKey,
+                               minutesDuration)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "removetempAPIKey";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :apiKey => tempAPIKey, :minutesDuration => minutesDuration } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+	
+  #
+  # perform_IssueTextKeyFromCellNumber - Send the issueTextKeyFromcellNumber API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +cellNumber+ -> The Cell Number that was used when the user was registered with
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_IssueTextKeyFromCellNumber(cellNumber)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "issueTextKeyFromcellNumber";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :cellNumber => cellNumber } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_PollForIncomingTextKey - Send the pollForIncomingTextKey API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +TextKey+ -> The TextKey to check for
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_PollForIncomingTextKey(textKey)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "pollForIncomingTextKey";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :textKey => textKey } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_ValidateTextKeyFromUserId - Send the validateTextKeyFromUserId API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +userID+ -> The unique identifier that was used when the user was registered with
+  #   - +TextKey+ -> The TextKey to check for
+  #   - +TextKeyVC+ -> The TextKey Validation Code to check for
+  #   - +isHashed+ -> Indicates if the userID was hashed before the user was registered.
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_ValidateTextKeyFromUserId(userID,
+                                        textKey,
+                                        textKeyVC,
+                                        isHashed)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "validateTextKeyFromUserId";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :userID => userID, :textKey => textKey, :validationCode => textKeyVC, :isHashed => isHashed } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+  #
+  # perform_ValidateTextKeyFromCellNumber - Send the validateTextKeyFromcellNumber API Request 
+  # and return the results
+  # 
+  # * *Args* :
+  #   - +cellNumber+ -> The Cell Number that was used when the user was registered with
+  #   - +TextKey+ -> The TextKey to check for
+  #   - +TextKeyVC+ -> The TextKey Validation Code to check for
+  #  
+  # * *Returns* :
+  #   - +The returned JSON payload as a string
+  # 
+  def perform_ValidateTextKeyFromCellNumber(cellNumber,
+                                            textKey,
+                                            textKeyVC)		
+
+    # Build the URL
+    resturl = TextkeyRest::Config::TK_BASE[:rest_url] + "validateTextKeyFromcellNumber";
+		
+    # Setup the payload
+    restpayload = { :DataIn  => { :apiKey => @authKey, :cellNumber => cellNumber, :textKey => textKey, :validationCode => textKeyVC } }
+		
+    # Make the API request
+    return sendAPIRequest(resturl, restpayload)
+  end
+
+end

data/lib/textkey_rest/version.rb

@@ -0,0 +1,3 @@
+module TextkeyRest
+  VERSION = "1.0.0"
+end

data/test/TestAll.rb

@@ -0,0 +1,10 @@
+# TestAll.rb
+# 
+Dir.glob("test_*.rb") do |file|
+  puts "--------------------------------------------------------------------------------"
+  puts "Testing: " + file
+  puts "--------------------------------------------------------------------------------"
+
+  # process
+  load file
+end

data/test/configuration.rb

@@ -0,0 +1,5 @@
+module TextkeyRestTest
+ module Config
+    API_KEY  = "9021fa44-f1bc-4590-b975-42fee031e078"
+  end
+end

data/test/test_CreateNewCellNumberProxy.rb

@@ -0,0 +1,25 @@
+# TestCreateNewCellNumberProxy.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+cellNumber = "8054100577"
+
+# Make the API Call
+response = textkey.perform_CreateNewCellNumberProxy(cellNumber)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_DoesRegistrationCellNumberExist.rb

@@ -0,0 +1,25 @@
+# TestDoesRegistrationCellNumberExist.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+cellNumber = "8054100577"
+
+# Make the API Call
+response = textkey.perform_DoesRegistrationCellNumberExist(cellNumber)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_DoesRegistrationUserIdExist.rb

@@ -0,0 +1,26 @@
+# TestDoesRegistrationUserIdExist.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+userID = "Stan"
+isHashed = "TRUE"
+
+# Make the API Call
+response = textkey.perform_DoesRegistrationUserIDExist(userID, isHashed)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_GetTempAPIKey.rb

@@ -0,0 +1,25 @@
+# TextGetTempAPI_Key.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+minutesDuration = 2
+
+# Make the API Call
+response = textkey.perform_GetTempAPI_Key(minutesDuration)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_GetTextKeyRegistration.rb

@@ -0,0 +1,31 @@
+# TestGetTextKeyRegistration.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+retrieveBy = 0
+cellNumber = "8054100577"
+suppl1 = ""
+suppl2 = ""
+
+# Make the API Call
+response = textkey.perform_getTextKeyRegistration(retrieveBy,
+												  cellNumber, 
+												  suppl1, 
+												  suppl2)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_IssueTextKeyFromCellNumber.rb

@@ -0,0 +1,25 @@
+# TestIssueTextKeyFromCellNumber.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+cellNumber = "8054100577"
+
+# Make the API Call
+response = textkey.perform_IssueTextKeyFromCellNumber(cellNumber)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_IssueTextKeyFromUserId.rb

@@ -0,0 +1,26 @@
+# TestIssueTextKeyFromUserId.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+userID = "Stan"
+isHashed = "TRUE"
+
+# Make the API Call
+response = textkey.perform_IssueTextKeyFromUserId(userID, isHashed)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_PollForIncomingTextKey.rb

@@ -0,0 +1,25 @@
+# TestPollForIncomingTextKey.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+textKey = "5347788"
+
+# Make the API Call
+response = textkey.perform_PollForIncomingTextKey(textKey)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_RegisterTextKeyUser.rb

@@ -0,0 +1,47 @@
+# TestRegisterTextKeyUser.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+command = 0
+cellNumber = "8054100577"
+ownerFName = ""
+ownerLName = ""
+suppl1 = ""
+suppl2 = ""
+userID = ""
+isHashed = "TRUE"
+pinCode = "" 
+distressPinCode = ""
+textKeyMode = 0
+receiveMode = 0
+
+# Make the API Call
+response = textkey.perform_registerTextKeyUser(command,
+											   cellNumber, 
+											   ownerFName, 
+											   ownerLName, 
+											   suppl1, 
+											   suppl2, 
+											   userID, 
+											   isHashed, 
+											   pinCode, 
+											   distressPinCode, 
+											   textKeyMode, 
+											   receiveMode)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_RegisterTextKeyUserCSA.rb

@@ -0,0 +1,63 @@
+# TestRegisterTextKeyUserCSA.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+command = 1
+cellNumber = "8054100577"
+ownerFName = "Stan"
+ownerLName = ""
+suppl1 = "Suppl1"
+suppl2 = "Suppl2"
+ownerBirthDate = "01/01/1970"
+ownerGender = "M"
+userID = "Stan"
+isHashed = "TRUE"
+pinCode = "1234" 
+distressPinCode = "4321"
+q1 = "Question 1"
+a1 = "Answer 1"
+q2 = "Question 2"
+a2 = "Answer 2"
+q3 = "Question 3"
+a3 = "Answer 3"
+textKeyMode = 0
+receiveMode = 0
+
+# Make the API Call
+response = textkey.perform_registerTextKeyUserCSA(command,
+												  cellNumber, 
+												  ownerFName, 
+												  ownerLName, 
+												  suppl1, 
+												  suppl2,
+												  ownerBirthDate,
+												  ownerGender,
+												  userID, 
+												  isHashed, 
+												  pinCode, 
+												  distressPinCode, 
+												  q1,
+												  a1,
+												  q2,
+												  a2,
+												  q3,
+												  a3,
+												  textKeyMode, 
+												  receiveMode)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_RemoveTempAPIKey.rb

@@ -0,0 +1,37 @@
+# TestRemoveTempAPIKey.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+minutesDuration = 2
+
+# Make the API Call to get an API Key
+response = textkey.perform_GetTempAPI_Key(minutesDuration)
+
+# If show flag is set show the return payload
+if response
+	# Pull out the data from the response
+	response_obj = JSON.parse(response)
+	tempAPI = response_obj['d']['apiKey']
+	
+	if response
+		# Make the API Call to release the API Key
+		response = textkey.perform_RemoveTempAPIKey(tempAPI, minutesDuration)
+		
+		# Pull out the data from the response
+		response_obj = JSON.parse(response)
+		response_data = response_obj['d']
+	end
+end
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_ValidateTextKeyFromCellNumber.rb

@@ -0,0 +1,29 @@
+# TestValidateTextKeyFromCellNumber.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+cellNumber = "8054100577"
+textKey = "4819399"
+textKeyVC = "57G14"
+
+# Make the API Call
+response = textkey.perform_ValidateTextKeyFromCellNumber(cellNumber, 
+														 textKey,
+														 textKeyVC)
+
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/test/test_ValidateTextKeyFromUserId.rb

@@ -0,0 +1,30 @@
+# TestValidateTextKeyFromUserId.rb
+# 
+require 'json'
+require 'textkey_rest'
+require './configuration'
+
+# Setup
+apiKey = TextkeyRestTest::Config::API_KEY
+
+# Create the textkey object
+textkey = TextKeyRest.new(apiKey, false)
+
+# Setup the API parameters
+userID = "Stan"
+isHashed = "TRUE"
+textKey = "5233019"
+textKeyVC = "4DE30"
+
+# Make the API Call
+response = textkey.perform_ValidateTextKeyFromUserId(userID, 
+													textKey,
+													textKeyVC,
+													isHashed)
+# Pull out the data from the response
+response_obj = JSON.parse(response)
+response_data = response_obj['d']
+
+# Display the response 
+puts "TextKey Results:"
+puts JSON.pretty_generate response_data

data/textkey_rest.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'textkey_rest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "textkey_rest"
+  spec.version       = TextkeyRest::VERSION
+  spec.authors       = ["Stan Shaul"]
+  spec.email         = ["textkey@textpower.com"]
+  spec.summary       = %q{Allows use of all of TextKey's REST API calls.}
+  spec.description   = %q{TextKey is an award winning, patent-pending next-generation omni-factor authenticationTM (seven-factors of authentication) system that is highly secure, simple to install and easy to use. It can be used to protect web sites, mobile devices, virtual private networks (VPNs) or any other data that requires privacy, confidentiality or restricted access. It works by having users send a simple text message (SMS) FROM their cell phones INTO the TextKeyTM system to authenticate their identity.}
+  spec.homepage      = "http://developer.textkey.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "json", "~> 0"
+  spec.add_development_dependency "rest-client", "~> 0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: textkey_rest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stan Shaul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: TextKey is an award winning, patent-pending next-generation omni-factor
+  authenticationTM (seven-factors of authentication) system that is highly secure,
+  simple to install and easy to use. It can be used to protect web sites, mobile devices,
+  virtual private networks (VPNs) or any other data that requires privacy, confidentiality
+  or restricted access. It works by having users send a simple text message (SMS)
+  FROM their cell phones INTO the TextKeyTM system to authenticate their identity.
+email:
+- textkey@textpower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/textkey_rest.rb
+- lib/textkey_rest/configuration.rb
+- lib/textkey_rest/textkey.rb
+- lib/textkey_rest/version.rb
+- test/TestAll.rb
+- test/configuration.rb
+- test/test_CreateNewCellNumberProxy.rb
+- test/test_DoesRegistrationCellNumberExist.rb
+- test/test_DoesRegistrationUserIdExist.rb
+- test/test_GetTempAPIKey.rb
+- test/test_GetTextKeyRegistration.rb
+- test/test_IssueTextKeyFromCellNumber.rb
+- test/test_IssueTextKeyFromUserId.rb
+- test/test_PollForIncomingTextKey.rb
+- test/test_RegisterTextKeyUser.rb
+- test/test_RegisterTextKeyUserCSA.rb
+- test/test_RemoveTempAPIKey.rb
+- test/test_ValidateTextKeyFromCellNumber.rb
+- test/test_ValidateTextKeyFromUserId.rb
+- textkey_rest.gemspec
+homepage: http://developer.textkey.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allows use of all of TextKey's REST API calls.
+test_files:
+- test/TestAll.rb
+- test/configuration.rb
+- test/test_CreateNewCellNumberProxy.rb
+- test/test_DoesRegistrationCellNumberExist.rb
+- test/test_DoesRegistrationUserIdExist.rb
+- test/test_GetTempAPIKey.rb
+- test/test_GetTextKeyRegistration.rb
+- test/test_IssueTextKeyFromCellNumber.rb
+- test/test_IssueTextKeyFromUserId.rb
+- test/test_PollForIncomingTextKey.rb
+- test/test_RegisterTextKeyUser.rb
+- test/test_RegisterTextKeyUserCSA.rb
+- test/test_RemoveTempAPIKey.rb
+- test/test_ValidateTextKeyFromCellNumber.rb
+- test/test_ValidateTextKeyFromUserId.rb