twizo 0.1.1

data/lib/twizo/modules/balance.rb

@@ -0,0 +1,40 @@
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+module Twizo
+
+  module Balance
+
+    #
+    # Send message to the server and return response
+    #
+    # @return [Object]
+    #
+    def send
+      response = send_api_call(Entity::ACTION_RETRIEVE, location)
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response)
+    end
+
+    private
+
+    #
+    # @return [String]
+    #
+    def location
+      'wallet/getbalance'
+    end
+
+  end
+
+end

data/lib/twizo/modules/number_lookup.rb

@@ -0,0 +1,81 @@
+require_relative 'params/number_lookup_params'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+module Twizo
+
+  module NumberLookup
+
+    #
+    # Getter for params
+    #
+    attr_reader :params
+
+    #
+    # Bitmasks of which type of result type to send
+    #
+    RESULT_TYPE_CALLBACK = 1
+    RESULT_TYPE_POLL = 2
+
+    #
+    # @param [Array] numbers
+    #
+    def set(numbers)
+      @params = NumberLookupParams.new
+      @params.numbers = numbers
+    end
+
+    #
+    # Send message to the server and return response
+    #
+    # @return [Object]
+    #
+    def send
+      post_params = @params.to_json
+
+      response = send_api_call(Entity::ACTION_CREATE, location, post_params)
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response, 'items')
+    end
+
+    #
+    # @return [Object]
+    #
+    def poll
+      response = send_api_call(Entity::ACTION_RETRIEVE, 'numberlookup/poll')
+
+      raise response if response.kind_of?(TwizoError)
+
+      batch_id = response['batchId'] unless response['batchId'].nil?
+
+      unless batch_id.nil?
+        send_api_call(Entity::ACTION_REMOVE, 'numberlookup/poll/' + batch_id)
+      end
+
+      response_to_array(response, 'messages')
+    end
+
+    private
+
+    #
+    # @return [String]
+    #
+    def location
+      'numberlookup/submit'
+    end
+
+  end
+
+end
+

data/lib/twizo/modules/params/backup_codes_params.rb

@@ -0,0 +1,19 @@
+require_relative 'params'
+
+module Twizo
+
+  class BackupCodesParams < Params
+
+    attr_accessor :identifier
+
+    def to_json
+      json = {
+          :identifier => identifier
+      }
+
+      json.to_json
+    end
+
+  end
+
+end

data/lib/twizo/modules/params/number_lookup_params.rb

@@ -0,0 +1,23 @@
+require_relative 'params'
+
+module Twizo
+
+  class NumberLookupParams < Params
+
+    attr_accessor :numbers, :tag, :validity, :result_type, :callback_url
+
+    def to_json
+      json = {
+          :numbers         => format_to_array(numbers),
+          :tag                => tag,
+          :validity           => validity,
+          :resultType         => result_type,
+          :callbackUrl        => callback_url,
+      }
+
+      json.to_json
+    end
+
+  end
+
+end

data/lib/twizo/modules/params/params.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+module Twizo
+
+  class Params
+
+    #
+    # @param [String|Array] numbers
+    #
+    # @return [Array]
+    #
+    def format_to_array(attributes)
+      attributes.kind_of?(Array) ? attributes_array = attributes : attributes_array = [attributes]
+
+      attributes.nil? ? attributes : format_input(attributes_array)
+    end
+
+    #
+    # @param [Array] numbers
+    #
+    # @return [Array]
+    #
+    def format_input(attributes)
+      attributes.map do |attribute|
+        attribute.gsub!(/[()+o ]/, '()+ ' => '', 'o' => '0')
+        attribute.gsub!(/^0+/, '')
+        unless attribute.scan(/\D/).empty?
+          raise TwizoError.new(422, 'The number(s) may not contain any characters.')
+        end
+      end
+
+      attributes
+    end
+
+  end
+
+end

data/lib/twizo/modules/params/sms_params.rb

@@ -0,0 +1,34 @@
+require_relative 'params'
+
+module Twizo
+
+  class SmsParams < Params
+
+    attr_accessor :recipients, :body, :sender, :sender_ton, :sender_npi, :pid, :scheduled_delivery, :tag, :validity, :result_type, :callback_url, :dcs, :udh
+
+    def to_json(send_advanced = nil)
+      json = {
+          :recipients         => format_to_array(recipients),
+          :body               => body,
+          :sender             => sender,
+          :senderTon          => sender_ton,
+          :senderNpi          => sender_npi,
+          :pid                => pid,
+          :scheduledDelivery  => scheduled_delivery,
+          :tag                => tag,
+          :validity           => validity,
+          :resultType         => result_type,
+          :callbackUrl        => callback_url,
+      }
+
+      if send_advanced
+        json[:dcs] = dcs
+        json[:udh] = udh
+      end
+
+      json.to_json
+    end
+
+  end
+
+end

data/lib/twizo/modules/params/verification_params.rb

@@ -0,0 +1,30 @@
+require_relative 'params'
+
+module Twizo
+
+  class VerificationParams < Params
+
+    attr_accessor :recipient, :type, :token_length, :token_type, :body_template, :session_id, :sender, :sender_ton, :sender_npi, :tag, :validity, :dcs
+
+    def to_json
+      json = {
+          :recipient          => recipient,
+          :type               => type,
+          :tokenLength        => token_length,
+          :tokenType          => token_type,
+          :bodyTemplate       => body_template,
+          :sessionId          => session_id,
+          :sender             => sender,
+          :senderTon          => sender_ton,
+          :senderNpi          => sender_npi,
+          :tag                => tag,
+          :validity           => validity,
+          :dcs                => dcs
+      }
+
+      json.to_json
+    end
+
+  end
+
+end

data/lib/twizo/modules/params/widget_params.rb

@@ -0,0 +1,29 @@
+require_relative 'params'
+
+module Twizo
+
+  class WidgetParams < Params
+
+    attr_accessor :allowed_types, :recipient, :backup_code_identifier, :token_length, :token_type, :body_template, :sender, :sender_ton, :sender_npi, :tag, :dcs
+
+    def to_json
+      json = {
+          :allowedTypes          => allowed_types,
+          :recipient              => recipient,
+          :backupCodeIdentifier => backup_code_identifier,
+          :tokenLength            => token_length,
+          :tokenType              => token_type,
+          :bodyTemplate           => body_template,
+          :sender                 => sender,
+          :senderTon              => sender_ton,
+          :senderNpi              => sender_npi,
+          :tag                    => tag,
+          :dcs                    => dcs
+      }
+
+      json.to_json
+    end
+
+  end
+
+end

data/lib/twizo/modules/sms.rb

@@ -0,0 +1,130 @@
+require_relative 'params/sms_params'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+module Twizo
+
+  module Sms
+
+    #
+    # Getter for params
+    #
+    attr_reader :params
+
+    #
+    # Bitmasks of which type of result type to send
+    #
+    RESULT_TYPE_CALLBACK = 1
+    RESULT_TYPE_POLL = 2
+
+    #
+    # @param [String] body
+    # @param [Array] recipients
+    # @param [String] sender
+    #
+    def set(body, recipients, sender)
+      @params = SmsParams.new
+      @params.body = body
+      @params.recipients = recipients
+      @params.sender = sender
+    end
+
+    #
+    # Send message to the server and return response
+    #
+    # @return [Object]
+    #
+    def send_simple
+      post_params = @params.to_json
+
+      response = send_api_call(Entity::ACTION_CREATE, 'sms/submitsimple', post_params)
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response, 'items')
+    end
+
+    #
+    # Send message to the server and return response
+    #
+    # @return [Object]
+    #
+    def send
+      # set @dcs to 0 if dcs is not set
+      @params.dcs ||= 0
+
+      @params.body = bin_to_hex(@params.body).upcase if is_binary?
+
+      post_params = @params.to_json send_advanced: true
+
+      response = send_api_call(Entity::ACTION_CREATE, location, post_params)
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response, 'items')
+    end
+
+    #
+    # @return [Object]
+    #
+    def poll
+
+      response = send_api_call(Entity::ACTION_RETRIEVE, 'sms/poll')
+
+      raise response if response.kind_of?(TwizoError)
+
+      @batch_id = response['batchId'] unless response['batchId'].nil?
+
+      unless @batch_id == ''
+        send_api_call(Entity::ACTION_REMOVE, 'sms/poll/' + @batch_id)
+      end
+
+      response_to_array(response, 'messages')
+    end
+
+    private
+
+    #
+    # @return [String]
+    #
+    def location
+      'sms/submit'
+    end
+
+    #
+    # @return [Boolean]
+    #
+    def is_binary?
+      binary = false
+
+      if (@params.dcs & 200) === 0
+        binary = ((@params.dcs & 4) > 0)
+      elsif (@params.dcs & 4) > 0
+        binary = ((@params.dcs & 4) > 0)
+      end
+
+      binary
+    end
+
+    #
+    # @param [Binary] binary_string
+    #
+    # @return [Hex]
+    #
+    def bin_to_hex(binary_string)
+      binary_string.unpack('H*').first
+    end
+
+  end
+
+end
+

data/lib/twizo/modules/verification.rb

@@ -0,0 +1,73 @@
+require_relative 'params/verification_params'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+ 
+=end
+
+module Twizo
+
+  module Verification
+
+    #
+    # Getter for params
+    #
+    attr_reader :params
+
+    #
+    # @param [String] recipient
+    #
+    def set(recipient)
+      @params = VerificationParams.new
+      @params.recipient = recipient
+
+      # set default type
+      @params.type ||= 'sms'
+    end
+
+    #
+    # Send message to the server and return response
+    #
+    # @return [Object]
+    #
+    def send
+      post_params = @params.to_json
+
+      response = send_api_call(Entity::ACTION_CREATE, location, post_params)
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response)
+    end
+
+    #
+    # @param [String] token
+    #
+    # @return [Object]
+    #
+    def verify(message_id, token)
+      response = send_api_call(Entity::ACTION_RETRIEVE, "#{location}/#{message_id}?token=#{token}")
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response)
+    end
+
+    private
+
+    #
+    # @return [String]
+    #
+    def location
+      'verification/submit'
+    end
+
+  end
+
+end