telesign 4.0.2 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3463757a8a57c39858bf85b288758923d6e3a6180e8e2ca426c599bb305dbf9b
-  data.tar.gz: c65156570396e12f271602b11bd670ce01fab73401c5bcc8fb2f01e5e6031647
+  metadata.gz: bbde29cc0a4c91e2661d802092cbaa9ecd0e83e90884080159d909aee719f2af
+  data.tar.gz: 56451c8e2c34a5f0df35f6598a7ed0ef15e323fa7fd4158649648f03fd201aab
 SHA512:
-  metadata.gz: e804d6144ab16fa2bf88bddafbc12f1ce435ad6d1ffcbf4107dd83f21e239ff8f6f5f142dda6b260d11cb1bd5a591dffa1e49470e30dcc552c0ca1bbdc1f1ce8
-  data.tar.gz: b525752a20aa650a0ed7bb05543aac795bd0b23e2d8bae75de49a0524f1f4f846bef8934d48b552aebad1954e396483b9a188d171af20c09311ea26b19c9e041
+  metadata.gz: a6aa7c387c3e55deae57de06f8ca7bfa69cc47c9b3d968899d12a670ceb39b19b990e48e8ede2394c72821d1ffc1f8959fd58131afab6644b29347d027c6a072
+  data.tar.gz: 2c0e3ad2a77e894c455b9f8d8ad4612a1b9bd27eef8ff44527832960cc47b024043a8ea37bf8556e5362c1cd02fe94186d010ff902511b47a728aebc6744cb7b

data/lib/telesign/constants.rb

@@ -1,3 +1,3 @@
 module Telesign
-    SDK_VERSION = '4.0.2'
-end
+  SDK_VERSION = '4.1.1'.freeze
+end

data/lib/telesign/messaging.rb

@@ -1,33 +1,29 @@
 require 'telesign/rest'
 
-MESSAGING_RESOURCE = '/v1/messaging'
-MESSAGING_STATUS_RESOURCE = '/v1/messaging/%{reference_id}'
+MESSAGING_RESOURCE = '/v1/messaging'.freeze
+MESSAGING_STATUS_RESOURCE = '/v1/messaging/%{reference_id}'.freeze
 
 module Telesign
-
   # TeleSign's Messaging API allows you to easily send SMS messages. You can send alerts, reminders, and notifications,
   # or you can send verification messages containing one-time passcodes (OTP).
   class MessagingClient < RestClient
-
     # Send an SMS message to the target phone number.
     #
     # See https://developer.telesign.com/docs/messaging-api for detailed API documentation.
     def message(phone_number, message, message_type, **params)
-
-      self.post(MESSAGING_RESOURCE,
-                phone_number: phone_number,
-                message: message,
-                message_type: message_type,
-                **params)
+      post(MESSAGING_RESOURCE,
+           phone_number: phone_number,
+           message: message,
+           message_type: message_type,
+           **params)
     end
 
     # Retrieve the status of an SMS transaction.
     #
     # See https://developer.telesign.com/docs/messaging-api for detailed API documentation.
     def status(reference_id, **params)
-
-      self.get(MESSAGING_STATUS_RESOURCE % {:reference_id => reference_id},
-               **params)
+      get(format(MESSAGING_STATUS_RESOURCE, reference_id: reference_id),
+          **params)
     end
   end
 end

data/lib/telesign/phoneid.rb

@@ -1,26 +1,24 @@
 require 'telesign/rest'
 
-PHONEID_RESOURCE = '/v1/phoneid/%{phone_number}'
+PHONEID_RESOURCE = '/v1/phoneid/%{phone_number}'.freeze
 
 module Telesign
-
   # A set of APIs that deliver deep phone number data attributes that help optimize the end user
   # verification process and evaluate risk.
   class PhoneIdClient < RestClient
-
     # The PhoneID API provides a cleansed phone number, phone type, and telecom carrier information to determine the
     # best communication method - SMS or voice.
     #
     # See https://developer.telesign.com/docs/phoneid-api for detailed API documentation.
     def phoneid(phone_number, **params)
-
-      self.post(PHONEID_RESOURCE % {:phone_number => phone_number},
-                **params)
+      post(format(PHONEID_RESOURCE, phone_number: phone_number),
+           **params)
     end
 
     private
+
     def content_type
-      "application/json"
+      'application/json'
     end
   end
 end

data/lib/telesign/rest.rb

@@ -8,7 +8,6 @@ require 'net/http/persistent'
 require_relative 'constants'
 
 module Telesign
-
   # The TeleSign RestClient is a generic HTTP REST client that can be extended to make requests against any of
   # TeleSign's REST API endpoints.
   #
@@ -17,19 +16,17 @@ module Telesign
   #
   # See https://developer.telesign.com for detailed API documentation.
   class RestClient
-
     # A simple HTTP Response object to abstract the underlying net/http library response.
 
     # * +http_response+ - A net/http response object.
     class Response
-
       attr_accessor :status_code, :headers, :body, :ok, :json
 
       def initialize(http_response)
         @status_code = http_response.code
         @headers = http_response.to_hash
         @body = http_response.body
-        @ok = http_response.kind_of? Net::HTTPSuccess
+        @ok = http_response.is_a? Net::HTTPSuccess
 
         begin
           @json = JSON.parse(http_response.body)
@@ -53,23 +50,20 @@ module Telesign
                    source: 'ruby_telesign',
                    sdk_version_origin: Telesign::SDK_VERSION,
                    sdk_version_dependency: nil)
-
       @customer_id = customer_id
       @api_key = api_key
       @rest_endpoint = rest_endpoint
 
       @user_agent = "TeleSignSDK/ruby Ruby/#{RUBY_VERSION} net:http:persistent/#{Net::HTTP::VERSION} OriginatingSDK/#{source} SDKVersion/#{sdk_version_origin}"
 
-      if (source != 'ruby_telesign' && !sdk_version_dependency.nil?)
-        @user_agent += " DependencySDKVersion/#{sdk_version_dependency}"
-      end
+      @user_agent += " DependencySDKVersion/#{sdk_version_dependency}" if source != 'ruby_telesign' && !sdk_version_dependency.nil?
 
       @http = Net::HTTP::Persistent.new(name: 'telesign', proxy: proxy)
 
-      unless timeout.nil?
-        @http.open_timeout = timeout
-        @http.read_timeout = timeout
-      end
+      return if timeout.nil?
+
+      @http.open_timeout = timeout
+      @http.read_timeout = timeout
     end
 
     # Generates the TeleSign REST API headers used to authenticate requests.
@@ -98,16 +92,11 @@ module Telesign
                                        nonce: nil,
                                        user_agent: nil,
                                        auth_method: 'HMAC-SHA256')
+      date_rfc2616 = Time.now.httpdate if date_rfc2616.nil?
 
-      if date_rfc2616.nil?
-        date_rfc2616 = Time.now.httpdate
-      end
-
-      if nonce.nil?
-        nonce = SecureRandom.uuid
-      end
+      nonce = SecureRandom.uuid if nonce.nil?
 
-      content_type = (%w[POST PUT PATCH].include? method_name) ? content_type : ''
+      content_type = %w[POST PUT PATCH].include?(method_name) ? content_type : ''
 
       if auth_method == 'HMAC-SHA256'
 
@@ -121,9 +110,7 @@ module Telesign
 
         string_to_sign << "\nx-ts-nonce:#{nonce}"
 
-        if !content_type.empty? and !encoded_fields.empty?
-          string_to_sign << "\n#{encoded_fields}"
-        end
+        string_to_sign << "\n#{encoded_fields}" if !content_type.empty? && !encoded_fields.empty?
 
         string_to_sign << "\n#{resource}"
 
@@ -135,27 +122,22 @@ module Telesign
         authorization = "TSA #{customer_id}:#{signature}"
       else
         credentials = Base64.strict_encode64("#{customer_id}:#{api_key}")
-        
+
         authorization = "Basic #{credentials}"
       end
 
       headers = {
-          'Authorization'=>authorization,
-          'Date'=>date_rfc2616,
-          'x-ts-auth-method'=>auth_method,
-          'x-ts-nonce'=>nonce
+        'Authorization' => authorization,
+        'Date' => date_rfc2616,
+        'x-ts-auth-method' => auth_method,
+        'x-ts-nonce' => nonce
       }
 
-      unless user_agent.nil?
-        headers['User-Agent'] = user_agent
-      end
+      headers['User-Agent'] = user_agent unless user_agent.nil?
 
-      if !content_type.empty?
-        headers['Content-Type'] = content_type
-      end
+      headers['Content-Type'] = content_type unless content_type.empty?
 
       headers
-
     end
 
     # Generic TeleSign REST API POST handler.
@@ -163,9 +145,7 @@ module Telesign
     # * +resource+ - The partial resource URI to perform the request against, as a string.
     # * +params+ - Body params to perform the POST request with, as a hash.
     def post(resource, **params)
-
       execute(Net::HTTP::Post, 'POST', resource, **params)
-
     end
 
     # Generic TeleSign REST API GET handler.
@@ -173,9 +153,7 @@ module Telesign
     # * +resource+ - The partial resource URI to perform the request against, as a string.
     # * +params+ - Body params to perform the GET request with, as a hash.
     def get(resource, **params)
-
       execute(Net::HTTP::Get, 'GET', resource, **params)
-
     end
 
     # Generic TeleSign REST API PUT handler.
@@ -183,9 +161,7 @@ module Telesign
     # * +resource+ - The partial resource URI to perform the request against, as a string.
     # * +params+ - Body params to perform the PUT request with, as a hash.
     def put(resource, **params)
-
       execute(Net::HTTP::Put, 'PUT', resource, **params)
-
     end
 
     # Generic TeleSign REST API DELETE handler.
@@ -193,9 +169,7 @@ module Telesign
     # * +resource+ - The partial resource URI to perform the request against, as a string.
     # * +params+ - Body params to perform the DELETE request with, as a hash.
     def delete(resource, **params)
-
       execute(Net::HTTP::Delete, 'DELETE', resource, **params)
-
     end
 
     # Generic Telesign REST API PATCH handler.
@@ -204,12 +178,11 @@ module Telesign
     # * +auth_method+ - Method to auth.
     # * +params+ - Body params to perform the PATCH request with, as a hash.
     def patch(resource, auth_method: 'HMAC-SHA256', **params)
-
       execute(Net::HTTP::Patch, 'PATCH', resource, auth_method: auth_method, **params)
-    
     end
 
     private
+
     # Generic TeleSign REST API request handler.
     #
     # * +method_function+ - The net/http request to perform the request.
@@ -217,13 +190,12 @@ module Telesign
     # * +resource+ - The partial resource URI to perform the request against, as a string.
     # * +params+ - Body params to perform the HTTP request with, as a hash.
     def execute(method_function, method_name, resource, auth_method: 'HMAC-SHA256', **params)
-
       resource_uri = URI.parse("#{@rest_endpoint}#{resource}")
 
       encoded_fields = ''
       if %w[POST PUT PATCH].include? method_name
         request = method_function.new(resource_uri.request_uri)
-        if content_type == "application/x-www-form-urlencoded"
+        if content_type == 'application/x-www-form-urlencoded'
           unless params.empty?
             encoded_fields = URI.encode_www_form(params, Encoding::UTF_8)
             request.set_form_data(params)
@@ -231,7 +203,7 @@ module Telesign
         else
           encoded_fields = params.to_json
           request.body = encoded_fields
-          request.set_content_type("application/json")
+          request.set_content_type('application/json')
         end
       else
         resource_uri.query = URI.encode_www_form(params, Encoding::UTF_8)
@@ -257,7 +229,7 @@ module Telesign
     end
 
     def content_type
-      "application/x-www-form-urlencoded"
+      'application/x-www-form-urlencoded'
     end
   end
 end

data/lib/telesign/score.rb

@@ -1,16 +1,15 @@
 require 'telesign/rest'
 
-DETECT_HOST = 'https://detect.telesign.com'
-INTELLIGENCE_RESOURCE = '/intelligence/phone'
+DETECT_HOST = 'https://detect.telesign.com'.freeze
+INTELLIGENCE_RESOURCE = '/intelligence/phone'.freeze
+EMAIL_INTELLIGENCE_RESOURCE = '/intelligence/email'.freeze
 
 module Telesign
-
   # Obtain a risk recommendation for a phone number using TeleSign Intelligence Cloud API.
   # Supports POST /intelligence/phone endpoint (Cloud migration).
   # Sends phone number and parameters in request body as form-urlencoded.
   # See https://developer.telesign.com/enterprise/reference/submitphonenumberforintelligencecloud for detailed API documentation.
   class ScoreClient < RestClient
-
     def initialize(customer_id, api_key, rest_endpoint: DETECT_HOST, **kwargs)
       super(customer_id, api_key, rest_endpoint: rest_endpoint, **kwargs)
     end
@@ -24,9 +23,30 @@ module Telesign
       raise ArgumentError, 'account_lifecycle_event cannot be null or empty' if account_lifecycle_event.nil? || account_lifecycle_event.empty?
 
       params[:phone_number] = phone_number
-      params[:account_lifecycle_event] = account_lifecycle_event 
+      params[:account_lifecycle_event] = account_lifecycle_event
+
+      post(INTELLIGENCE_RESOURCE, **params)
+    end
+
+    def email_intelligence(email_address, account_lifecycle_event, **params)
+      # Obtain a risk recommendation for this email address, as well as
+      # other relevant information using Email Intelligence API.
+      #
+      # Required parameters:
+      # - email_address
+      # - account_lifecycle_event ("create", "sign-in", "transact", "update", "delete")
+
+      raise ArgumentError, 'email_address cannot be null or empty' if email_address.nil? || email_address.to_s.strip.empty?
+
+      raise ArgumentError, 'account_lifecycle_event cannot be null or empty' if account_lifecycle_event.nil? || account_lifecycle_event.to_s.strip.empty?
+
+      email_address = email_address.to_s.strip.downcase
+      account_lifecycle_event = account_lifecycle_event.to_s.strip.downcase
+
+      params[:email_address] = email_address
+      params[:account_lifecycle_event] = account_lifecycle_event
 
-      self.post(INTELLIGENCE_RESOURCE, **params)
+      post(EMAIL_INTELLIGENCE_RESOURCE, **params)
     end
   end
 end

data/lib/telesign/util.rb

@@ -3,10 +3,11 @@ require 'openssl'
 require 'securerandom'
 
 module Telesign
+  # Util/helper class.
   class Util
-
-    def self.random_with_n_digits(n)
-      n.times.map { SecureRandom.random_number(10) }.join
+    # Generate a random number with n digits.
+    def self.random_with_n_digits(length)
+      length.times.map { SecureRandom.random_number(10) }.join
     end
 
     # Verify that a callback was made by TeleSign and was not sent by a malicious client by verifying the signature.
@@ -15,22 +16,17 @@ module Telesign
     # * +signature+ - the TeleSign Authorization header value supplied in the callback, as a string.
     # * +json_str+ - the POST body text, that is, the JSON string sent by TeleSign describing the transaction status.
     def verify_telesign_callback_signature(api_key, signature, json_str)
-
       digest = OpenSSL::Digest.new('sha256')
       key = Base64.decode64(api_key)
 
       your_signature = Base64.encode64(OpenSSL::HMAC.digest(digest, key, json_str)).strip
 
-      unless signature.length == your_signature.length
-        return false
-      end
+      return false unless signature.length == your_signature.length
 
       # avoid timing attack with constant time equality check
       signatures_equal = true
       signature.split('').zip(your_signature.split('')).each do |x, y|
-        unless x == y
-          signatures_equal = false
-        end
+        signatures_equal = false unless x == y
       end
 
       signatures_equal

data/lib/telesign/voice.rb

@@ -1,33 +1,29 @@
 require 'telesign/rest'
 
-VOICE_RESOURCE = '/v1/voice'
-VOICE_STATUS_RESOURCE = '/v1/voice/%{reference_id}'
+VOICE_RESOURCE = '/v1/voice'.freeze
+VOICE_STATUS_RESOURCE = '/v1/voice/%{reference_id}'.freeze
 
 module Telesign
-
   # TeleSign's Voice API allows you to easily send voice messages. You can send alerts, reminders, and notifications,
   # or you can send verification messages containing time-based, one-time passcodes (TOTP).
   class VoiceClient < RestClient
-
     # Send a voice call to the target phone_number.
     #
     # See https://developer.telesign.com/docs/voice-api for detailed API documentation.
     def call(phone_number, message, message_type, **params)
-
-      self.post(VOICE_RESOURCE,
-                phone_number: phone_number,
-                message: message,
-                message_type: message_type,
-                **params)
+      post(VOICE_RESOURCE,
+           phone_number: phone_number,
+           message: message,
+           message_type: message_type,
+           **params)
     end
 
     # Retrieves the current status of the voice call.
     #
     # See https://developer.telesign.com/docs/voice-api for detailed API documentation.
     def status(reference_id, **params)
-
-      self.get(VOICE_STATUS_RESOURCE % {:reference_id => reference_id},
-               **params)
+      get(format(VOICE_STATUS_RESOURCE, reference_id: reference_id),
+          **params)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telesign
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.1
 platform: ruby
 authors:
 - Telesign
@@ -10,41 +10,41 @@ cert_chain: []
 date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: net-http-persistent
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: base64
+  name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -58,21 +58,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: uuid
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,7 +86,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,7 +100,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,7 +114,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: uuid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -128,19 +128,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.18.0
 description: Telesign Ruby SDK
 email: support@telesign.com
 executables: []
@@ -166,14 +166,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Telesign Ruby SDK
 test_files: []