telesignenterprise 2.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84ebab8b70f95eaecfe9cf0e17b8320aab52e53b
+  data.tar.gz: 0aec257beb29fd28e9d4f45e46ec3bc082efa9fb
+SHA512:
+  metadata.gz: 87ddacee0f5a9d339d048f9823f86f24e8ee1d411d82c2a25e6d32541bcaa05f3c1229b663ffd518310f5c713ba32ff2bbf9693b30ec21314dccc541d5af143d
+  data.tar.gz: 9f36c4c9a1ad8d15abe232778657f64f3356031f492abd1caa4b06cd787f90b12375acf596e4ee4db7b9c833999afbaa82ffd891817290b7f5d17f32cf5bb9e8

data/lib/telesignenterprise.rb

@@ -0,0 +1,7 @@
+require 'telesignenterprise/phoneid'
+require 'telesignenterprise/telebureau'
+require 'telesignenterprise/verify'
+require 'telesignenterprise/score'
+require 'telesignenterprise/messaging'
+require 'telesignenterprise/voice'
+require 'telesignenterprise/appverify'

data/lib/telesignenterprise/appverify.rb

@@ -0,0 +1,21 @@
+require 'telesign'
+
+module TelesignEnterprise
+
+  # App Verify is a secure, lightweight SDK that integrates a frictionless user verification process into existing
+  # native mobile applications.
+  class AppVerifyClient < Telesign::AppVerifyClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://rest-ww.telesign.com',
+                   timeout: nil)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout)
+    end
+
+  end
+end

data/lib/telesignenterprise/messaging.rb

@@ -0,0 +1,20 @@
+require 'telesign'
+
+module TelesignEnterprise
+
+  # 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 < Telesign::MessagingClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://rest-ww.telesign.com',
+                   timeout: nil)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout)
+    end
+  end
+end

data/lib/telesignenterprise/phoneid.rb

@@ -0,0 +1,85 @@
+require 'telesign/phoneid'
+
+PHONEID_STANDARD_RESOURCE = '/v1/phoneid/standard/%{phone_number}'
+PHONEID_SCORE_RESOURCE = '/v1/phoneid/score/%{phone_number}'
+PHONEID_CONTACT_RESOURCE = '/v1/phoneid/contact/%{phone_number}'
+PHONEID_LIVE_RESOURCE = '/v1/phoneid/live/%{phone_number}'
+PHONEID_NUMBER_DEACTIVATION_RESOURCE = '/v1/phoneid/number_deactivation/%{phone_number}'
+
+module TelesignEnterprise
+
+  # A set of APIs that deliver deep phone number data attributes that help optimize the end user
+  # verification process and evaluate risk.
+  #
+  # TeleSign PhoneID provides a wide range of risk assessment indicators on the number to help confirm user identity,
+  # delivering real-time decision making throughout the number lifecycle and ensuring only legitimate users are
+  # creating accounts and accessing your applications.
+  class PhoneIdClient < Telesign::PhoneIdClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://rest-ww.telesign.com',
+                   timeout: nil)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout)
+    end
+
+    # The PhoneID Standard API that provides phone type and telecom carrier information to identify which phone
+    # numbers can receive SMS messages and/or a potential fraud risk.
+    #
+    # See https://developer.telesign.com/docs/rest_phoneid-standard for detailed API documentation.
+    def standard(phone_number, **params)
+
+      self.get(PHONEID_STANDARD_RESOURCE % {:phone_number => phone_number},
+               **params)
+    end
+
+    # Score is an API that delivers reputation scoring based on phone number intelligence, traffic patterns, machine
+    # learning, and a global data consortium.
+    #
+    # See https://developer.telesign.com/docs/rest_api-phoneid-score for detailed API documentation.
+    def score(phone_number, ucid, **params)
+
+      self.get(PHONEID_SCORE_RESOURCE % {:phone_number => phone_number},
+               ucid: ucid,
+               **params)
+    end
+
+    # The PhoneID Contact API delivers contact information related to the subscriber's phone number to provide another
+    # set of indicators for established risk engines.
+    #
+    # See https://developer.telesign.com/docs/rest_api-phoneid-contact for detailed API documentation.
+    def contact(phone_number, ucid, **params)
+
+      self.get(PHONEID_CONTACT_RESOURCE % {:phone_number => phone_number},
+               ucid: ucid,
+               **params)
+    end
+
+    # The PhoneID Live API delivers insights such as whether a phone is active or disconnected, a device is reachable
+    # or unreachable and its roaming status.
+    #
+    # See https://developer.telesign.com/docs/rest_api-phoneid-live for detailed API documentation.
+    def live(phone_number, ucid, **params)
+
+      self.get(PHONEID_LIVE_RESOURCE % {:phone_number => phone_number},
+               ucid: ucid,
+               **params)
+    end
+
+    # The PhoneID Number Deactivation API determines whether a phone number has been deactivated and when, based on
+    # carriers' phone number data and TeleSign's proprietary analysis.
+    #
+    # See https://developer.telesign.com/docs/rest_api-phoneid-number-deactivation for detailed API documentation.
+    def number_deactivation(phone_number, ucid, **params)
+
+      self.get(PHONEID_NUMBER_DEACTIVATION_RESOURCE % {:phone_number => phone_number},
+               ucid: ucid,
+               **params)
+    end
+
+  end
+end

data/lib/telesignenterprise/score.rb

@@ -0,0 +1,20 @@
+require 'telesign'
+
+module TelesignEnterprise
+
+  # Score provides risk information about a specified phone number.
+  class ScoreClient < Telesign::ScoreClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://rest-ww.telesign.com',
+                   timeout: nil)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout)
+    end
+
+  end
+end

data/lib/telesignenterprise/telebureau.rb

@@ -0,0 +1,57 @@
+require 'telesign/rest'
+
+TELEBUREAU_CREATE_RESOURCE = '/v1/telebureau/event'
+TELEBUREAU_RETRIEVE_RESOURCE = '/v1/telebureau/event/%{reference_id}'
+TELEBUREAU_DELETE_RESOURCE = '/v1/telebureau/event/%{reference_id}'
+
+module TelesignEnterprise
+
+  # TeleBureau is a service is based on TeleSign's watchlist, which is a proprietary database containing verified phone
+  # numbers of users known to have committed online fraud. TeleSign crowd-sources this information from its customers.
+  # Participation is voluntary, but you have to contribute in order to benefit.
+  class TelebureauClient < Telesign::RestClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://rest-ww.telesign.com',
+                   timeout: nil)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout)
+    end
+
+    # Creates a telebureau event corresponding to supplied data.
+    #
+    # See https://developer.telesign.com/docs/telebureau-api for detailed API documentation.
+    def create_event(phone_number, fraud_type, occurred_at, **params)
+
+      self.post(TELEBUREAU_CREATE_RESOURCE,
+                phone_number: phone_number,
+                fraud_type: fraud_type,
+                occured_at: occurred_at,
+                **params)
+    end
+
+    # Retrieves the fraud event status. You make this call in your web application after completion of create
+    # transaction for a telebureau event.
+    #
+    # See https://developer.telesign.com/docs/telebureau-api for detailed API documentation.
+    def retrieve_event(reference_id, **params)
+
+      self.get(TELEBUREAU_RETRIEVE_RESOURCE % {:reference_id => reference_id},
+               **params)
+    end
+
+    # Deletes a previously submitted fraud event. You make this call in your web application after completion of the
+    # create transaction for a telebureau event.
+    #
+    # See https://developer.telesign.com/docs/telebureau-api for detailed API documentation.
+    def delete_event(reference_id, **params)
+
+      self.delete(TELEBUREAU_DELETE_RESOURCE % {:reference_id => reference_id},
+                  **params)
+    end
+  end
+end

data/lib/telesignenterprise/verify.rb

@@ -0,0 +1,95 @@
+require 'telesign/rest'
+
+VERIFY_SMS_RESOURCE = '/v1/verify/sms'
+VERIFY_VOICE_RESOURCE = '/v1/verify/call'
+VERIFY_SMART_RESOURCE = '/v1/verify/smart'
+VERIFY_PUSH_RESOURCE = '/v2/verify/push'
+VERIFY_STATUS_RESOURCE = '/v1/verify/%{reference_id}'
+VERIFY_COMPLETION_RESOURCE = '/v1/verify/completion/%{reference_id}'
+
+module TelesignEnterprise
+
+  # The Verify API delivers phone-based verification and two-factor authentication using a time-based, one-time passcode
+  # sent via SMS message, Voice call or Push Notification.
+  class VerifyClient < Telesign::RestClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://rest-ww.telesign.com',
+                   timeout: nil)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout)
+    end
+
+    # The SMS Verify API delivers phone-based verification and two-factor authentication using a time-based,
+    # one-time passcode sent over SMS.
+    #
+    # See https://developer.telesign.com/docs/rest_api-verify-sms for detailed API documentation.
+    def sms(phone_number, **params)
+
+      self.post(VERIFY_SMS_RESOURCE,
+                phone_number: phone_number,
+                **params)
+    end
+
+    # The Voice Verify API delivers patented phone-based verification and two-factor authentication using a one-time
+    # passcode sent over voice message.
+    #
+    # See https://developer.telesign.com/docs/rest_api-verify-call for detailed API documentation.
+    def voice(phone_number, **params)
+
+      self.post(VERIFY_VOICE_RESOURCE,
+                phone_number: phone_number,
+                **params)
+    end
+
+    # The Smart Verify web service simplifies the process of verifying user identity by integrating several TeleSign
+    # web services into a single API call. This eliminates the need for you to make multiple calls to the TeleSign
+    # Verify resource.
+    #
+    # See https://developer.telesign.com/docs/rest_api-smart-verify for detailed API documentation.
+    def smart(phone_number, ucid, **params)
+
+      self.post(VERIFY_SMART_RESOURCE,
+                phone_number: phone_number,
+                ucid: ucid,
+                **params)
+    end
+
+    # The Push Verify web service allows you to provide on-device transaction authorization for your end users. It
+    # works by delivering authorization requests to your end users via push notification, and then by receiving their
+    # permission responses via their mobile device's wireless Internet connection.
+    #
+    # See https://developer.telesign.com/docs/rest_api-verify-push for detailed API documentation.
+    def push(phone_number, ucid, **params)
+
+      self.post(VERIFY_PUSH_RESOURCE,
+                phone_number: phone_number,
+                ucid: ucid,
+                **params)
+    end
+
+    # Retrieves the verification result for any verify resource.
+    #
+    # See https://developer.telesign.com/docs/rest_api-verify-transaction-callback for detailed API documentation.
+    def status(reference_id, **params)
+
+      self.get(VERIFY_STATUS_RESOURCE % {:reference_id => reference_id},
+               **params)
+    end
+
+    # Notifies TeleSign that a verification was successfully delivered to the user in order to help improve the
+    # quality of message delivery routes.
+    #
+    # See https://developer.telesign.com/docs/completion-service-for-verify-products for detailed API documentation.
+    def completion(reference_id, **params)
+
+      self.put(VERIFY_COMPLETION_RESOURCE % {:reference_id => reference_id},
+               **params)
+    end
+
+  end
+end

data/lib/telesignenterprise/voice.rb

@@ -0,0 +1,20 @@
+require 'telesign'
+
+module TelesignEnterprise
+
+  # 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 < Telesign::VoiceClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://rest-ww.telesign.com',
+                   timeout: nil)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout)
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: telesignenterprise
+version: !ruby/object:Gem::Version
+  version: 2.2.1
+platform: ruby
+authors:
+- TeleSign
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: telesign
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: uuid
+  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: mocha
+  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: webmock
+  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: codecov
+  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: simplecov
+  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: test-unit
+  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: TeleSign Enterprise Ruby SDK
+email: support@telesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/telesignenterprise.rb
+- lib/telesignenterprise/appverify.rb
+- lib/telesignenterprise/messaging.rb
+- lib/telesignenterprise/phoneid.rb
+- lib/telesignenterprise/score.rb
+- lib/telesignenterprise/telebureau.rb
+- lib/telesignenterprise/verify.rb
+- lib/telesignenterprise/voice.rb
+homepage: http://rubygems.org/gems/telesign
+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.6.14.4
+signing_key: 
+specification_version: 4
+summary: TeleSign Enterprise Ruby SDK
+test_files: []