railsware-telesign 0.0.2

data/lib/telesign/lib/exceptions.rb

@@ -0,0 +1,28 @@
+module Telesign
+  module Exceptions
+    class TelesignError < StandardError; end
+    
+    [ :InvalidParameter, :InvalidCustomerID, :InvalidReferenceID,
+      :StatusUnavailable, :MaxRetriesReached, :AccountSuspended, 
+      :SystemUnavailable ].each do |name|
+      const_set(name, Class.new(TelesignError))
+    end
+    
+    EXCEPTIONAL_ERRORS = {
+      -10001 => InvalidParameter,
+      -20001 => InvalidCustomerID,
+      -20002 => InvalidReferenceID,
+      -30001 => AccountSuspended,
+      -40001 => StatusUnavailable,
+      -50001 => MaxRetriesReached,
+      -80001 => SystemUnavailable,
+      -90001 => SystemUnavailable
+    }
+    
+    def self.raise_if_error(api_error)
+      if api_error && EXCEPTIONAL_ERRORS[api_error.code]
+        raise EXCEPTIONAL_ERRORS[api_error.code].new(api_error.message)
+      end
+    end
+  end
+end

data/lib/telesign/lib/language.rb

@@ -0,0 +1,67 @@
+module Telesign
+  module Language
+    ARABIC          = "arabic"
+    AUSTRALIAN      = "australian"
+    CANADIAN_FRENCH = "canadianfrench"
+    CANTONESE       = "cantonese"
+    CHINESE         = "chinese"
+    CROATIAN        = "croatian"
+    CZECH           = "czech"
+    DANISH          = "danish"
+    DUTCH           = "dutch"
+    EGYPTIAN        = "egyptian"
+    ENGLISH_UK      = "englishuk"
+    ESTONIAN        = "estonian"
+    FINNISH         = "finnish"
+    FRENCH          = "french"
+    GERMAN          = "german"
+    GREEK           = "greek"
+    HEBREW          = "hebrew"
+    HINDI           = "hindi"
+    HUNGARIAN       = "hungarian"
+    INDONESIAN      = "indonesian"
+    ITALIAN         = "italian"
+    JAPANESE        = "japanese"
+    KOREAN          = "korean"
+    NORWEGIAN       = "norwegian"
+    POLISH          = "polish"
+    PORTUGUESE      = "portuguese"
+    PORTUGUESE_EU   = "portugueseeu"
+    ROMANIAN        = "romanian"
+    RUSSIAN         = "russian"
+    SLOVAK          = "slovak"
+    SPANISH         = "spanish"
+    SPANISH_EU      = "spanisheu"
+    SWEDISH         = "swedish"
+    THAI            = "thai"
+    TURKISH         = "turkish"
+    UKRAINIAN       = "ukrainian"
+    VIETNAMESE      = "vietnamese"
+    
+    LOCALE_LANGUAGES = {
+      :"ar-AR" => ARABIC,
+      :"da-DK" => DANISH,
+      :"de-DE" => GERMAN,
+      :"el-EL" => GREEK,
+      :"en-US" => nil,
+      :"es-ES" => SPANISH_EU,
+      :"es-LA" => SPANISH,
+      :"fr-FR" => FRENCH,
+      :"it-IT" => ITALIAN,
+      :"iw-IW" => HEBREW,
+      :"ja-JP" => JAPANESE,
+      :"ko-KR" => KOREAN,
+      :"nl-NL" => DUTCH,
+      :"pl-PL" => POLISH,
+      :"pt-BR" => PORTUGUESE,
+      :"ru-RU" => RUSSIAN,
+      :"sv-SE" => SWEDISH,
+      :"tr-TR" => TURKISH,
+      :"zh-CN" => CHINESE
+    }
+    
+    def self.for_locale(locale)
+      LOCALE_LANGUAGES[locale.to_sym]
+    end
+  end
+end

data/lib/telesign/lib/phone_type.rb

@@ -0,0 +1,29 @@
+module Telesign
+  module PhoneType
+    
+    types = %w(UNDETERMINED FIXED_LINE MOBILE PREPAID_MOBILE TOLL_FREE NON_FIXED_VOIP PAGER PAYPHONE INVALID RESTRICTED PERSONAL VOICEMAIL OTHER)
+    types.each do |type|
+      const_set(type, type)
+    end
+    
+    CODES = {
+      300 => UNDETERMINED,    
+      301 => FIXED_LINE,      
+      302 => MOBILE,          
+      303 => PREPAID_MOBILE,  
+      304 => TOLL_FREE,       
+      305 => NON_FIXED_VOIP,  
+      306 => PAGER,           
+      307 => PAYPHONE,        
+      308 => INVALID,         
+      309 => RESTRICTED,      
+      310 => PERSONAL,        
+      311 => VOICEMAIL,       
+      320 => OTHER           
+    }
+    
+    def self.type_for_code(code)
+      CODES[code.to_i]
+    end
+  end
+end

data/lib/telesign/phone.rb

@@ -0,0 +1,11 @@
+module Telesign
+  class Phone
+    
+    attr_accessor :number, :country_code
+    
+    def initialize(number, country = "US")
+      self.number = number
+      self.country_code = Country::country_code_for_name(country.to_s)
+    end
+  end
+end

data/lib/telesign/phone_id/request.rb

@@ -0,0 +1,18 @@
+module Telesign
+  module PhoneID
+    class Request < ApiRequest
+  
+      request_method :requestPhoneID
+            
+      attr_accessor :phone_number, :country_code
+      
+      alias_method :phoneNumber, :phone_number
+      alias_method :countryCode, :country_code
+      
+      def initialize(phone)
+        self.country_code = phone.country_code
+        self.phone_number = phone.number
+      end      
+    end
+  end
+end

data/lib/telesign/phone_id/response.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+module Telesign
+  module PhoneID
+    class Response < ApiResponse
+      
+      response_method :requestPhoneIDResult
+      
+      def_delegators :@response, :city, :county, :zip, :state, :country, :countryName, :timeZone, :latitude, :longitude, 
+                     :aPIError, :cleansedCode, :maxNumLength, :referenceID, :timeZoneUTCMin, :timeZoneUTCMax, 
+                     :primaryMetroCode, :originalPhoneNumber, :cleansedPhoneNumber
+      
+      alias_method :time_zone,             :timeZone
+      alias_method :api_error,             :aPIError
+      alias_method :country_name,          :countryName
+      alias_method :cleansed_code,         :cleansedCode
+      alias_method :max_num_length,        :maxNumLength
+      alias_method :reference_id,          :referenceID
+      alias_method :time_zone_utc_min,     :timeZoneUTCMin
+      alias_method :time_zone_utc_max,     :timeZoneUTCMax
+      alias_method :primary_metro_code,    :primaryMetroCode
+      alias_method :original_phone_number, :originalPhoneNumber
+      alias_method :cleansed_phone_number, :cleansedPhoneNumber
+
+      attr_reader :phone_type
+    
+      def after_initialize
+        @phone_type = Telesign::PhoneType.type_for_code(@response.typeofPhone)
+      end
+    end
+  end
+end

data/lib/telesign/phone_verification/request.rb

@@ -0,0 +1,25 @@
+module Telesign
+  module PhoneVerification    
+    class Request < ApiRequest
+      
+      attr_accessor :country_code, :phone_number, :delay_time, :radial_count, 
+                    :extension_content, :extension_type, :call_type, :caller_id, :priority,
+                    :message, :project, :additional, :verification_code
+                   
+      alias_method :countryCode, :country_code 
+      alias_method :phoneNumber, :phone_number
+      alias_method :delayTime, :delay_time
+      alias_method :redialCount, :radial_count
+      alias_method :extensionContent, :extension_content
+      alias_method :extensionType, :extension_type
+      alias_method :callType, :call_type
+      alias_method :callerID, :caller_id
+      alias_method :verificationCode, :verification_code
+
+      def initialize(phone)
+        self.phone_number = phone.number
+        self.country_code = phone.country_code
+      end
+    end
+  end
+end

data/lib/telesign/phone_verification/response.rb

@@ -0,0 +1,11 @@
+module Telesign
+  module PhoneVerification
+    class Response < ApiResponse
+
+      def_delegators :@response, :aPIError, :referenceID
+      
+      alias_method :api_error, :aPIError
+      alias_method :reference_id, :referenceID
+    end 
+  end
+end

data/lib/telesign/sms/request.rb

@@ -0,0 +1,14 @@
+module Telesign
+  module SMS
+    class Request < PhoneVerification::Request
+
+      request_method :requestSMS
+      
+      def self.message_format=(format)
+        define_method(:message) do 
+          format % verification_code
+        end
+      end
+    end
+  end
+end

data/lib/telesign/sms/response.rb

@@ -0,0 +1,7 @@
+module Telesign
+  module SMS
+    class Response < PhoneVerification::Response
+      response_method :requestSMSResult
+    end
+  end
+end

data/lib/telesign/status/request.rb

@@ -0,0 +1,17 @@
+module Telesign
+  module Status
+    class Request < ApiRequest
+      
+      request_method :requestSTATUS
+            
+      attr_accessor :reference_id, :verification_code
+      
+      alias_method :referenceID, :reference_id
+      alias_method :verificationCode, :verification_code
+      
+      def initialize(reference_id)
+        self.reference_id = reference_id
+      end      
+    end
+  end
+end

data/lib/telesign/status/response.rb

@@ -0,0 +1,36 @@
+module Telesign
+  module Status
+    class Response < ApiResponse
+
+      response_method :requestSTATUSResult
+      
+      module StatusCode
+        ANSWERED             = "100"
+        NOT_ANSWERED         = "101"
+        DISCONNECTED         = "102"
+        IN_PROGRESS          = "103"
+        INVALID_PHONE_NUMBER = "104"
+        NOT_YET_ATTEMPTED    = "105"
+        FAILED               = "106"
+        LINE_BUSY            = "107"
+        SMS_DELIVERED        = "203"
+        SMS_NOT_DELIVERED    = "207"
+      end
+      
+      def_delegators :@response, :aPIError, :referenceID, :statusCode
+      
+      alias_method :api_error, :aPIError
+      alias_method :reference_id, :referenceID
+      alias_method :status_code, :statusCode
+      
+      def answered?
+        [ StatusCode::ANSWERED, StatusCode::SMS_DELIVERED ].include?(status_code)
+      end
+      alias_method :delivered?, :answered?
+      
+      def verification_code_valid?
+        @response.verificationCodeValid == "0"
+      end
+    end 
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: railsware-telesign
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- pcunnane
+autorequire: telesign
+bindir: bin
+cert_chain: []
+date: 2011-08-05 00:00:00.000000000 +07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railsware-soap4r
+  requirement: &70328359147360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70328359147360
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- MIT-LICENSE
+- lib/telesign.rb
+- lib/telesign/api/default.rb
+- lib/telesign/api/defaultDriver.rb
+- lib/telesign/api/defaultMappingRegistry.rb
+- lib/telesign/call/request.rb
+- lib/telesign/call/response.rb
+- lib/telesign/lib/country.rb
+- lib/telesign/lib/exceptions.rb
+- lib/telesign/lib/language.rb
+- lib/telesign/lib/phone_type.rb
+- lib/telesign/phone_id/request.rb
+- lib/telesign/phone_id/response.rb
+- lib/telesign/phone_verification/request.rb
+- lib/telesign/phone_verification/response.rb
+- lib/telesign/sms/request.rb
+- lib/telesign/sms/response.rb
+- lib/telesign/status/request.rb
+- lib/telesign/status/response.rb
+- lib/telesign/api_request.rb
+- lib/telesign/api_response.rb
+- lib/telesign/phone.rb
+- README.markdown
+has_rdoc: true
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/telesign
+- lib/telesign/call
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A Telesign Library
+test_files: []