VoiceIt2 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8278a824804474f2c47ecbbc8e8a352b89149dfda4618d67f363bd61806947a
-  data.tar.gz: 0fa42e68e65e077a39600a5f6bb00ecb133db7633bcd1cfe3c85dc96912bc1ac
+  metadata.gz: 89e8809efb84e01b992459c2e063adb27cf8f90e3e77dc9bff66c95b3ab237c8
+  data.tar.gz: cdf5fcc763c49c3637d99b2a339fc4f95b95760f55802fed4f855be49a38da68
 SHA512:
-  metadata.gz: fc0041fb5a237411d89ffca61975aeffbddf6b51efcd15c2dcab19b332a0a68843354fb5509822b9bafe221046590c07653c2f17541c82977bacc7ed3805351c
-  data.tar.gz: 4e449fdbddd84fd2999a2b2a438c01714835d7e355a5fd9ba41c7b7b4ce953669ec3130c6fef6ab497e29c98352d17b178229c041d88c65c7820730cbf6b569b
+  metadata.gz: eff308a3a150d416231f13773f3e6934792fa7275a3d15a1ef2d98623a8d4c34db1510526cc17bd0fba864cf1fc0adecee572a854095e49ad776ef5cd5100dc3
+  data.tar.gz: 1ceb5dad3e9a0fe882792b2ec65284928880752787cac95215a820089c11f195fab67c2b7d8245385f6eab2386572884ddc13c9c4a417989664c0f4faa5a3bac

data/VoiceIt2.rb

@@ -1,22 +1,36 @@
 #!/usr/bin/env ruby
 require 'rest-client'
+require 'cgi'
+
 
 class VoiceIt2
 
+  BASE_URL = 'https://api.voiceit.io/'
+  VERSION = '3.2.0'
+
   def initialize(key, tok)
-    @BASE_URL = URI('https://api.voiceit.io/')
+    @notification_url = ""
     @api_key = key
     @api_token = tok
   end
 
+  def addNotificationUrl(notificationURL)
+    @notification_url = "?notificationURL=" + CGI.escape(notificationURL)
+  end
+
+  def removeNotificationUrl()
+    @notification_url = ""
+  end
+
   def getAllUsers
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'users',
+      :url => BASE_URL + 'users' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -25,11 +39,12 @@ class VoiceIt2
   def createUser
     return RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'users',
+      :url => BASE_URL + 'users' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -38,11 +53,12 @@ class VoiceIt2
   def checkUserExists(userId)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'users/' + userId,
+      :url => BASE_URL + 'users/' + userId + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -51,11 +67,12 @@ class VoiceIt2
   def deleteUser(userId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'users/' + userId,
+      :url => BASE_URL + 'users/' + userId + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -65,11 +82,12 @@ class VoiceIt2
   def getGroupsForUser(userId)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'users/' + userId + '/groups',
+      :url => BASE_URL + 'users/' + userId + '/groups' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -79,11 +97,12 @@ class VoiceIt2
   def getAllVoiceEnrollments(userId)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'enrollments/voice/' + userId,
+      :url => BASE_URL + 'enrollments/voice/' + userId + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -93,11 +112,12 @@ class VoiceIt2
   def getAllVideoEnrollments(userId)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'enrollments/video/' + userId,
+      :url => BASE_URL + 'enrollments/video/' + userId + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -107,11 +127,12 @@ class VoiceIt2
   def deleteAllEnrollments(userId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'enrollments/' + userId + '/all',
+      :url => BASE_URL + 'enrollments/' + userId + '/all' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -121,11 +142,12 @@ class VoiceIt2
   def deleteAllVoiceEnrollments(userId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'enrollments/' + userId + '/voice',
+      :url => BASE_URL + 'enrollments/' + userId + '/voice' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -135,11 +157,12 @@ class VoiceIt2
   def deleteAllFaceEnrollments(userId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'enrollments/' + userId + '/face',
+      :url => BASE_URL + 'enrollments/' + userId + '/face' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -149,11 +172,12 @@ class VoiceIt2
   def deleteAllVideoEnrollments(userId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'enrollments/' + userId + '/video',
+      :url => BASE_URL + 'enrollments/' + userId + '/video' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -163,11 +187,12 @@ class VoiceIt2
   def getAllFaceEnrollments(userId)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'enrollments/face/' + userId,
+      :url => BASE_URL + 'enrollments/face/' + userId + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -177,11 +202,12 @@ class VoiceIt2
   def createVoiceEnrollment(userId, contentLanguage, phrase, filePath)
       return RestClient::Request.new(
         :method => :post,
-        :url => @BASE_URL.to_s + 'enrollments/voice',
+        :url => BASE_URL + 'enrollments/voice' + @notification_url,
         :user => @api_key,
         :password => @api_token,
         :headers => {
-          platformId: '35'
+          platformId: '35',
+          platformVersion: VERSION
         },
         :payload => {
           :multipart => true,
@@ -201,11 +227,12 @@ class VoiceIt2
   def createVoiceEnrollmentByUrl(userId, contentLanguage, phrase, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'enrollments/voice/byUrl',
+      :url => BASE_URL + 'enrollments/voice/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -225,11 +252,12 @@ class VoiceIt2
   def createFaceEnrollment(userId,  filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'enrollments/face',
+      :url => BASE_URL + 'enrollments/face' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -247,11 +275,12 @@ class VoiceIt2
   def createFaceEnrollmentByUrl(userId, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'enrollments/face/byUrl',
+      :url => BASE_URL + 'enrollments/face/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -265,11 +294,12 @@ class VoiceIt2
   def createVideoEnrollment(userId, contentLanguage,  phrase, filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'enrollments/video',
+      :url => BASE_URL + 'enrollments/video' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -289,11 +319,12 @@ class VoiceIt2
   def createVideoEnrollmentByUrl(userId, contentLanguage,  phrase, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'enrollments/video/byUrl',
+      :url => BASE_URL + 'enrollments/video/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -313,11 +344,12 @@ class VoiceIt2
   def deleteFaceEnrollment(userId, faceEnrollmentId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'enrollments/face/' + userId + '/' + faceEnrollmentId.to_s,
+      :url => BASE_URL + 'enrollments/face/' + userId + '/' + faceEnrollmentId.to_s + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -326,11 +358,12 @@ class VoiceIt2
   def deleteVoiceEnrollment(userId, voiceEnrollmentId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'enrollments/voice/' + userId + '/' + voiceEnrollmentId.to_s,
+      :url => BASE_URL + 'enrollments/voice/' + userId + '/' + voiceEnrollmentId.to_s + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -339,11 +372,12 @@ class VoiceIt2
   def deleteVideoEnrollment(userId, enrollmentId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'enrollments/video/' + userId + '/' + enrollmentId.to_s,
+      :url => BASE_URL + 'enrollments/video/' + userId + '/' + enrollmentId.to_s + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
 
     rescue => e
@@ -353,11 +387,12 @@ class VoiceIt2
   def getAllGroups()
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'groups',
+      :url => BASE_URL + 'groups' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -366,11 +401,12 @@ class VoiceIt2
   def getPhrases(contentLanguage)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'phrases/' + contentLanguage,
+      :url => BASE_URL + 'phrases/' + contentLanguage + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -379,11 +415,12 @@ class VoiceIt2
   def getGroup(groupId)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'groups/' + groupId,
+      :url => BASE_URL + 'groups/' + groupId + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -392,11 +429,12 @@ class VoiceIt2
   def groupExists(groupId)
     return RestClient::Request.new(
       :method => :get,
-      :url => @BASE_URL.to_s + 'groups/' + groupId + '/exists',
+      :url => BASE_URL + 'groups/' + groupId + '/exists' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -405,11 +443,12 @@ class VoiceIt2
   def createGroup(description)
     return RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'groups',
+      :url => BASE_URL + 'groups' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -422,11 +461,12 @@ class VoiceIt2
   def addUserToGroup(groupId, userId)
     return RestClient::Request.new(
       :method => :put,
-      :url => @BASE_URL.to_s + 'groups/addUser',
+      :url => BASE_URL + 'groups/addUser' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -440,11 +480,12 @@ class VoiceIt2
   def removeUserFromGroup(groupId, userId)
     return RestClient::Request.new(
       :method => :put,
-      :url => @BASE_URL.to_s + 'groups/removeUser',
+      :url => BASE_URL + 'groups/removeUser' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -458,11 +499,12 @@ class VoiceIt2
   def deleteGroup(groupId)
     return RestClient::Request.new(
       :method => :delete,
-      :url => @BASE_URL.to_s + 'groups/' + groupId,
+      :url => BASE_URL + 'groups/' + groupId + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
@@ -471,11 +513,12 @@ class VoiceIt2
   def voiceVerification(userId, contentLanguage, phrase, filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'verification/voice',
+      :url => BASE_URL + 'verification/voice' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -495,11 +538,12 @@ class VoiceIt2
   def voiceVerificationByUrl(userId, contentLanguage, phrase, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'verification/voice/byUrl',
+      :url => BASE_URL + 'verification/voice/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -519,11 +563,12 @@ class VoiceIt2
   def faceVerification(userId, filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'verification/face',
+      :url => BASE_URL + 'verification/face' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -541,11 +586,12 @@ class VoiceIt2
   def faceVerificationByUrl(userId, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'verification/face/byUrl',
+      :url => BASE_URL + 'verification/face/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -559,11 +605,12 @@ class VoiceIt2
   def videoVerification(userId, contentLanguage, phrase, filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'verification/video',
+      :url => BASE_URL + 'verification/video' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -583,11 +630,12 @@ class VoiceIt2
   def videoVerificationByUrl(userId, contentLanguage, phrase, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'verification/video/byUrl',
+      :url => BASE_URL + 'verification/video/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -607,11 +655,12 @@ class VoiceIt2
   def voiceIdentification(groupId, contentLanguage, phrase, filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'identification/voice',
+      :url => BASE_URL + 'identification/voice' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -631,11 +680,12 @@ class VoiceIt2
   def voiceIdentificationByUrl(groupId, contentLanguage, phrase, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'identification/voice/byUrl',
+      :url => BASE_URL + 'identification/voice/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -655,11 +705,12 @@ class VoiceIt2
   def faceIdentification(groupId, filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'identification/face',
+      :url => BASE_URL + 'identification/face' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -677,11 +728,12 @@ class VoiceIt2
   def faceIdentificationByUrl(groupId,fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'identification/face/byUrl',
+      :url => BASE_URL + 'identification/face/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -695,11 +747,12 @@ class VoiceIt2
   def videoIdentification(groupId, contentLanguage, phrase, filePath)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'identification/video',
+      :url => BASE_URL + 'identification/video' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -719,11 +772,12 @@ class VoiceIt2
   def videoIdentificationByUrl(groupId, contentLanguage, phrase, fileUrl)
     return  RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'identification/video/byUrl',
+      :url => BASE_URL + 'identification/video/byUrl' + @notification_url,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       },
       :payload => {
         :multipart => true,
@@ -740,17 +794,23 @@ class VoiceIt2
       end
   end
 
-  def createUserToken(userId)
+  def createUserToken(userId, timeOut)
     return RestClient::Request.new(
       :method => :post,
-      :url => @BASE_URL.to_s + 'users/' + userId + '/token',
+      :url => BASE_URL + 'users/' + userId + '/token?timeOut=' + timeOut.to_s,
       :user => @api_key,
       :password => @api_token,
       :headers => {
-        platformId: '35'
+        platformId: '35',
+        platformVersion: VERSION
       }).execute
     rescue => e
         e.response
   end
 
+  attr_reader :BASE_URL
+  attr_reader :notification_url
+  attr_reader :api_key
+  attr_reader :api_token
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: VoiceIt2
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - StephenAkers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies: []
 description: A wrapper for VoiceIt API 2
 email: stephen@voiceit.io
@@ -17,10 +17,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - "./VoiceIt2.rb"
-homepage: http://rubygems.org/gems/hola
+homepage: https://voiceit.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://api.voiceit.io?ruby
 post_install_message: 
 rdoc_options: []
 require_paths: