telesign_lib 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d531bc3040fa7c7d87a0d1c24c8e77cedf6c7bb
+  data.tar.gz: 2f0da94e24422ebaf88cf844bba37a842ba84810
+SHA512:
+  metadata.gz: cb9380ab2921e864af25747cb6ac777bf7c23ba98308b4757a2eaebd98b7cc12fd307c32b2ad1a02fb935fb69d22c89e844d349c60e6d34e207a54c7406e5c41
+  data.tar.gz: 5109a12a692dbb580ca62eaaf1b8fa2d5c38fb9580ab9db76bbb53520945f9c8c2478fc2d5d3e873576ef6702a9a31f2aca28e9079a304b731fa7520e1a71b38

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.ruby-version

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    telesign_lib (0.0.12)
+      faraday (~> 0.9.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.8-java)
+    json (1.8.1)
+    json (1.8.1-java)
+    method_source (0.8.2)
+    mimic (0.4.3)
+      json
+      plist
+      rack
+      sinatra
+    minitest (5.5.1)
+    multipart-post (2.0.0)
+    plist (3.1.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry (0.10.1-java)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rack (1.5.2)
+    rack-protection (1.5.2)
+      rack
+    rake (10.4.2)
+    safe_yaml (1.0.4)
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.6.0)
+    spoon (0.0.4)
+      ffi
+    tilt (1.4.1)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  mimic (~> 0.4.3)
+  minitest (~> 5.5.1)
+  pry (~> 0.10.1)
+  rake (~> 10.4.2)
+  telesign_lib!
+  webmock (~> 1.20.4)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 TeleSign Corp.
+
+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,104 @@
+telesign
+=============
+
+Ruby TeleSign SDK
+
+example
+=============
+```ruby
+require 'telesign'
+
+customer_id = 'FFFFFFFF-EEEE-DDDD-1234-AB1234567890'
+secret_key = 'EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=='
+phone_number = '4445551212'
+
+require 'TeleSign'
+
+ta = TeleSign::Api.new customer_id: customer_id,
+                            secret_key: secret_key
+
+phone_info = ta.phone_id.standard phone_number
+
+p "##################"
+p phone_info.data
+p phone_info.headers
+p phone_info.status
+p phone_info.raw_data
+p "##################"
+
+phone_info = ta.phone_id.contact phone_number, 'PWRT'
+
+p "##################"
+p phone_info.data
+p phone_info.headers
+p phone_info.status
+p phone_info.raw_data
+p "##################"
+
+phone_info = ta.phone_id.score phone_number, 'PWRT'
+
+p "##################"
+p phone_info.data
+p phone_info.headers
+p phone_info.status
+p phone_info.raw_data
+p "##################"
+
+begin
+  phone_info = ta.phone_id.live phone_number, 'RXPF'
+rescue TeleSign::AuthorizationError => e
+  puts e.message
+end
+
+p "##################"
+p phone_info.data
+p phone_info.headers
+p phone_info.status
+p phone_info.raw_data
+p "##################"
+
+phone_info = ta.verify.sms phone_number: phone_number #, verify_code: '12345'
+
+p "##################"
+p phone_info.data
+p phone_info.headers
+p phone_info.status
+p phone_info.raw_data
+p phone_info.verify_code
+p "##################"
+
+status_info = ta.verify.status phone_info.data['reference_id'], phone_info.verify_code
+# status_info = ta.verify.status phone_info.data['reference_id'], '12345'
+
+p "\n\n\n"
+p "##################"
+p status_info.data
+p status_info.headers
+p status_info.status
+p status_info.raw_data
+p status_info.verify_code
+p "##################"
+```
+
+stubs mode
+=============
+If you're running this in a Rails app, there is a stubs mode Sinatra app available.
+
+Enable it by setting ENV['TELESIGN_STUBBED'] to something truthy.
+
+The Sinatra app will run on "http://localhost:11989".
+
+Currently stubs mode supports:
+
+post '/v1/verify/sms'
+post '/v1/verify/call'
+
+Both of which always return a success response.
+
+get '/v1/verify/:reference_id'
+
+Returns VALID for any verify_code which does not contain '666'.
+
+get '/v1/phoneid/standard/:phone_number'
+
+See codes for triggering different phone-type responses.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/lib/telesign/api.rb

@@ -0,0 +1,52 @@
+require 'faraday'
+require 'json'
+
+module TeleSign
+  class Api
+    #    * - Attributes
+    #      -
+    #    * - `customer_id`
+    #      - A string value that identifies your TeleSign account.
+    #    * - `secret_key`
+    #      - A base64-encoded string value that validates your access to the TeleSign web services.
+    #    * - `ssl`
+    #      - Specifies whether to use a secure connection with the TeleSign server. Defaults to *true*.
+    #    * - `api_host`
+    #      - The Internet host used in the base URI for REST web services.
+    #         The default is *rest.telesign.com* (and the base URI is https://rest.telesign.com/).
+    #    * - `proxy_host`
+    #      - The host and port when going through a proxy server. ex: "localhost:8080. The default to no proxy.
+
+    # NOTE
+    #    You can obtain both your Customer ID and Secret Key from the
+    #    TeleSign Customer Portal <https://portal.telesign.com/account_profile_api_auth.php>
+
+    attr_accessor :verify, :phone_id
+
+    def initialize opts = {}
+      @customer_id = opts[:customer_id]
+      @secret_key = opts[:secret_key]
+      api_host = opts[:api_host] || 'rest.telesign.com'
+      ssl = opts[:ssl].nil? ? true : opts[:ssl]
+      proxy_host = opts[:proxy_host] || nil
+
+      http_root = ssl ? 'https' : 'http'
+      proxy = proxy_host ? "#{http_root}://#{proxy_host}" : nil
+      url = "#{http_root}://#{api_host}"
+
+      @conn = Faraday.new(url: url) do |faraday|
+        faraday.request  :url_encoded
+        if defined? Rails
+          faraday.response :logger, Rails.logger
+        else
+          faraday.response :logger                  # log requests to STDOUT
+        end
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+
+      @verify = Verify.new(conn: @conn, customer_id: opts[:customer_id], secret_key: opts[:secret_key])
+      @phone_id = PhoneId.new(conn: @conn, customer_id: opts[:customer_id], secret_key: opts[:secret_key])
+    end
+
+  end
+end

data/lib/telesign/auth.rb

@@ -0,0 +1,67 @@
+# Authorization header definitions
+
+require 'securerandom'
+require 'base64'
+require 'uri'
+require 'openssl'
+
+# NOTE: the following is the TeleSign crew who made the python version
+#       from which this codes was inspired
+
+# __author__ = "Jeremy Cunningham, Michael Fox, and Radu Maierean"
+# __copyright__ = "Copyright 2012, TeleSign Corp."
+# __credits__ = ["Jeremy Cunningham", "Radu Maierean", "Michael Fox", "Nancy Vitug", "Humberto Morales"]
+# __license__ = "MIT"
+
+AUTH_METHOD = {
+    sha1: {hash: OpenSSL::Digest::SHA1, name: 'HMAC-SHA1'},
+    sha256: {hash: OpenSSL::Digest::SHA256, name: 'HMAC-SHA256'}
+}
+
+module TeleSign
+  class Auth
+    def self.generate_auth_headers(opts = {})
+      content_type = opts[:content_type] ? opts[:content_type] : ''
+      auth_method = opts[:auth_method] ? opts[:auth_method] : :sha1
+      fields = opts[:fields] ? opts[:fields] : nil
+
+      customer_id = opts[:customer_id]
+      secret_key = opts[:secret_key]
+      resource = opts[:resource]
+      method = opts[:method]
+
+      current_date = Time.now.strftime("%a, %d %b %Y %H:%M:%S %z")
+      nonce = SecureRandom.uuid
+
+      if %w(POST PUT).include? method
+        content_type = "application/x-www-form-urlencoded"
+      end
+
+      string_to_sign = "%s\n%s\n\nx-ts-auth-method:%s\nx-ts-date:%s\nx-ts-nonce:%s" % [
+              method,
+              content_type,
+              AUTH_METHOD[auth_method][:name],
+              current_date,
+              nonce]
+
+      if fields
+        string_to_sign += "\n%s" % URI.encode_www_form(fields)
+      end
+
+      string_to_sign += "\n%s" % resource
+
+      digest = AUTH_METHOD[auth_method][:hash].new
+      signer = OpenSSL::HMAC.digest digest, Base64.decode64(secret_key), string_to_sign
+
+      signature = Base64.encode64 signer
+
+      {
+        'Authorization' => "TSA %s:%s" % [customer_id, signature],
+        'x-ts-date' => current_date,
+        'x-ts-auth-method' => AUTH_METHOD[auth_method][:name],
+        'x-ts-nonce' => nonce
+      }
+    end
+  end
+end
+

data/lib/telesign/authorization_error.rb

@@ -0,0 +1,19 @@
+module TeleSign
+  class AuthorizationError < TeleSignError
+    # """
+    # Either the client failed to authenticate with the REST API server, or the service cannot be executed using the specified credentials.
+
+    #    * - Attributes
+    #      -
+    #    * - `data`
+    #      - The data returned by the service, in a dictionary form.
+    #    * - `http_response`
+    #      - The full HTTP Response object, including the HTTP status code, headers, and raw returned data.
+
+    # """
+
+    def initialize errors, http_response
+      super
+    end
+  end
+end

data/lib/telesign/helpers.rb

@@ -0,0 +1,22 @@
+module TeleSign
+  module Helpers
+    def random_with_N_digits n
+      range_start = 10 ** (n - 1)
+      range_end = (10 ** n) - 1
+      Random.new.rand(range_start...range_end)
+    end
+
+    def validate_response response
+      resp_obj = JSON.load response.body
+      if response.status != 200
+        if response.status == 401
+          raise AuthorizationError.new resp_obj, response
+        else
+          raise TeleSignError.new resp_obj, response
+        end
+      end
+
+      resp_obj
+    end
+  end
+end

data/lib/telesign/mock_service/fake_server.rb

@@ -0,0 +1,215 @@
+if defined? Rails
+  Rails.logger.info '***************************'
+  Rails.logger.info 'Starting fake telesign server'
+  Rails.logger.info '***************************'
+end
+
+require 'mimic'
+require 'json'
+require 'securerandom'
+
+Mimic.mimic port: (ENV['TELESIGN_PORT'].to_i || 11989), host: (ENV['TELESIGN_URL'] || 'localhost'), fork: false do
+  # 'https://rest.telesign.com/v1/verify/sms'
+  # params['phone_number']
+  # params['language']
+  # params['verify_code']
+  # params['template']
+  post '/v1/verify/sms' do
+    http_status = 200
+    headers = StdHelpers.standard_headers
+
+    response_body = StdHelpers.std_response_body StdHelpers.std_reference_id
+
+    content_type :json
+    [http_status, headers, response_body.to_json]
+  end
+
+  # 'https://rest.telesign.com/v1/verify/call'
+  # params['phone_number']
+  # params['language']
+  # params['verify_code']
+  post '/v1/verify/call' do
+    http_status = 200
+    headers = StdHelpers.standard_headers
+    response_body = StdHelpers.std_response_body StdHelpers.std_reference_id
+
+    content_type :json
+    [http_status, headers, response_body.to_json]
+  end
+
+  # 'https://rest.telesign.com/v1/verify/%s' % @expected_ref_id
+  # params[:reference_id]
+  # params[:verify_code]
+  get '/v1/verify/:reference_id' do
+    http_status = 200
+    headers = StdHelpers.standard_headers
+
+    status_code = if params[:verify_code] =~ /666/
+      'INVALID'
+    else
+      'VALID'
+    end
+
+    response_body = StdHelpers.std_response_body params[:reference_id], status_code
+
+    content_type :json
+    [http_status, headers, response_body.to_json]
+  end
+
+  # not using phoneid calls yet, but here are the stubs
+  # # 'https://rest.telesign.com/v1/phoneid/%s/%s'
+
+  # '/v1/phoneid/standard/%s' % phone_number
+  get '/v1/phoneid/standard/:phone_number' do
+    http_status = 200
+    headers = StdHelpers.standard_headers
+
+    phone_type_hash = if params[:phone_number] =~ /111/
+      {'code' =>'1', 'description' =>'FIXED'}
+    elsif params[:phone_number] =~ /222/
+      {'code' =>'2', 'description' =>'MOBILE'}
+    elsif params[:phone_number] =~ /333/
+      {'code' =>'3', 'description' =>'PREPAID'}
+    elsif params[:phone_number] =~ /444/
+      {'code' =>'4', 'description' =>'TOLLFREE'}
+    elsif params[:phone_number] =~ /555/ # this could be problematic
+      {'code' =>'5', 'description' =>'VOIP'}
+    elsif params[:phone_number] =~ /666/
+      {'code' =>'6', 'description' =>'PAGER'}
+    elsif params[:phone_number] =~ /777/
+      {'code' =>'7', 'description' =>'PAYPHONE'}
+    elsif params[:phone_number] =~ /888/
+      {'code' =>'8', 'description' =>'INVALID'}
+    elsif params[:phone_number] =~ /999/
+      {'code' =>'9', 'description' =>'RESTRICTED'}
+    elsif params[:phone_number] =~ /101010/
+      {'code' =>'10', 'description' =>'PERSONAL'}
+    elsif params[:phone_number] =~ /110110/
+      {'code' =>'11', 'description' =>'VOICEMAIL'}
+    else
+      {'code' =>'20', 'description' =>'OTHER'}
+    end
+
+    response_body = StdHelpers.std_standard_body params[:phone_number], phone_type_hash
+
+    content_type :json
+    [http_status, headers, response_body.to_json]
+  end
+
+  # # /v1/phoneid/score/%s' % phone_number
+  # get '/v1/phoneid/score/:phone_number' do
+
+  # end
+
+  # # /v1/phoneid/contact/%s' % phone_number
+  # get '/v1/phoneid/contact/:phone_number' do
+
+  # end
+
+  # # /v1/phoneid/live/%s' % phone_number
+  # get '/v1/phoneid/live/:phone_number' do
+
+  # end
+end
+
+BEGIN {
+  class StdHelpers
+    class << self
+      def standard_headers
+        # scraped from TeleSign api response
+        { 'date' =>Time.now.strftime('%a, %d %b %Y %H:%M:%S %z'),
+          'server' =>'Apache',
+          'allow' =>'GET,POST,HEAD',
+          'connection' =>'close',
+          'content-type' =>'application/json'}
+      end
+
+      def std_response_body reference_id, status_code = 'UNKNOWN'
+        # scraped from TeleSign api response
+        { 'reference_id' => reference_id,
+          'resource_uri' => '/v1/verify/#{reference_id}',
+          'sub_resource' => 'sms',
+          'errors' => [],
+          'status' => {
+            'updated_on' => standard_updated_on,
+            'code' => 290,
+            'description' => 'Message in progress'
+            },
+          'verify' => {
+            'code_state' => status_code,
+            'code_entered' => ''
+            }
+          }
+      end
+
+      def std_standard_body phone_number, phone_type_hash
+        simple_phone = phone_number[0]=='1' ? phone_number.slice(1..-1) : phone_number
+        { 'reference_id' => std_reference_id,
+          'resource_uri' => nil,
+          'sub_resource' => 'standard',
+          'status' => {
+            'updated_on' => standard_updated_on,
+            'code' => 300,
+            'description' => 'Transaction successfully completed'
+            },
+          'errors' => [],
+          'location' => {
+            'city' => 'Reno',
+            'state' => 'NV',
+            'zip' => '89501',
+            'metro_code' => '6720',
+            'county' => '',
+            'country' => {
+              'name' => 'United States',
+              'iso2' => 'US',
+              'iso3' => 'USA'
+              },
+            'coordinates' => {
+              'latitude' => 39.52598,
+              'longitude' => -119.80796
+              },
+            'time_zone' => {
+              'name' =>' America/Los_Angeles',
+              'utc_offset_min' => '-8',
+              'utc_offset_max' => '-8'
+              }
+            },
+          'numbering' => {
+            'original' => {
+              'complete_phone_number' => '1'+simple_phone,
+              'country_code' => '1',
+              'phone_number' => simple_phone
+              },
+            'cleansing' => {
+              'call' => {
+                'country_code' => '1',
+                'phone_number' => simple_phone,
+                'cleansed_code' => 100,
+                'min_length' => 10,
+                'max_length' => 10},
+                'sms' => {
+                  'country_code' => '1',
+                  'phone_number' => simple_phone,
+                  'cleansed_code' => 100,
+                  'min_length' => 10,
+                  'max_length' => 10
+                  }
+                }
+              },
+          'phone_type' => phone_type_hash,
+          'carrier' => {
+            'name' => 'AT&T - PSTN'
+          }
+        }
+      end
+
+      def std_reference_id
+        SecureRandom.uuid.gsub('-','').upcase
+      end
+
+      def standard_updated_on
+        Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%6N')
+      end
+    end
+  end
+}

data/lib/telesign/mock_service/railtie.rb

@@ -0,0 +1,9 @@
+module TeleSign
+  module MockService
+    class Railtie < ::Rails::Railtie
+      initializer 'telesign_railtie.configure_rails_initialization' do
+        require 'telesign/mock_service/spin_up'
+      end
+    end
+  end
+end

data/lib/telesign/mock_service/spin_up.rb

@@ -0,0 +1,18 @@
+module TeleSign
+  module MockService
+    module SpinUp
+      if ENV['TELESIGN_STUBBED']
+        port = (ENV['TELESIGN_PORT'].to_i || 11989)
+        if `lsof -i :#{port}`.blank? # no process running on #port
+          Process.detach(pid = Process.fork do
+            require 'telesign/mock_service/fake_server'
+          end)
+        else
+          Rails.logger.warn "TELESIGN STUB MODE FAILED TO START\nProcess already listening on #{port}"
+        end
+      end
+
+      at_exit { pid && `kill #{pid}` }
+    end
+  end
+end