twizo 0.1.1

data/lib/twizo/modules/widget.rb

@@ -0,0 +1,59 @@
+require_relative 'params/widget_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 Widget
+
+    #
+    # Getter for params
+    #
+    attr_reader :params
+
+    #
+    # @param [String] recipient
+    #
+    def set(recipient)
+      @params = WidgetParams.new
+      @params.recipient = recipient
+
+      # set default allowed_types
+      @params.allowed_types ||= %w(sms call)
+    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
+
+    private
+
+    #
+    # @return [String]
+    #
+    def location
+      'widget/session'
+    end
+
+  end
+
+end

data/lib/twizo/result.rb

@@ -0,0 +1,66 @@
+=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
+
+  class Result
+
+    attr_reader :result
+
+    #
+    # Constructor
+    #
+    # @param [Array] result
+    #
+    def initialize(result)
+      set_fields(result)
+    end
+
+    #
+    # @param [Array] fields
+    #
+    def set_fields(fields)
+      fields.each do |name, value|
+        add_attribute_accessor(name, value)
+      end
+    end
+
+    #
+    # Getter and Setter fields are dynamically created
+    #
+    # @param [String] attr_name
+    # @param [Object] attr_value
+    #
+    def add_attribute_accessor(attr_name, attr_value)
+      self.class.send(:define_method, "#{attr_name}=".to_sym) do |value|
+        instance_variable_set('@' + attr_name.to_s, value)
+      end
+
+      self.class.send(:define_method, attr_name.to_sym) do
+        instance_variable_get('@' + attr_name.to_s)
+      end
+
+      self.send("#{attr_name}=".to_sym, attr_value)
+    end
+
+    #
+    # add an item to parent result
+    #
+    # @param [Object] item
+    #
+    def add_result(item)
+      @result ||= []
+      @result << item
+    end
+
+  end
+
+end

data/lib/twizo/status_codes.rb

@@ -0,0 +1,32 @@
+=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 StatusCodes
+
+    #
+    # Status codes for number lookup and sms
+    #
+    NO_STATUS = 0
+    DELIVERED = 1
+    REJECTED = 2
+    EXPIRED = 3
+    ENROUTE = 4
+    BUFFERED = 5
+    ACCEPTED = 6
+    UNDELIVERED = 7
+    DELETED = 8
+    UNKNOWN = 9
+
+  end
+
+end

data/lib/twizo/twizo_error.rb

@@ -0,0 +1,26 @@
+=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
+
+  class TwizoError < StandardError
+
+    attr_reader :body
+
+    def initialize(code, body = nil?)
+      super(code)
+
+      @body = body
+    end
+
+  end
+
+end

data/lib/twizo/version.rb

@@ -0,0 +1,3 @@
+module Twizo
+  VERSION = '0.1.1'
+end

data/test/test_all.rb

@@ -0,0 +1,19 @@
+=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
+
+# in the console type: ruby test_all.rb
+
+require_relative 'test_number_lookup'
+require_relative 'test_sms'
+require_relative 'test_balance'
+require_relative 'test_backup_codes'
+require_relative 'test_verification'
+require_relative 'test_widget'

data/test/test_backup_codes.rb

@@ -0,0 +1,120 @@
+require_relative 'test_init'
+
+=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
+
+class TestBackupCodes < TestInit
+
+  #
+  # Initialize Twizo
+  #
+  def setup
+    @twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+  end
+
+  #
+  # Test if an error is thrown when an invalid key is provided
+  #
+  def test_invalid_key
+    api_key = 'invalid_key'
+
+    assert_raise Twizo::TwizoError do
+      @twizo = Twizo::Twizo.new(api_key, API_HOST)
+      backup_codes = @twizo.create_backup_codes(NUMBER1)
+      backup_codes.send
+    end
+  end
+
+  #
+  # Test creation of backup codes
+  #
+  def test_create_backup_codes
+    test_identifier = rand(1000..9999).to_s
+
+    backup_codes = @twizo.create_backup_codes(nil)
+    backup_codes.params.identifier = test_identifier
+
+    backup_codes = backup_codes.send
+
+    assert_equal test_identifier, backup_codes.identifier
+    assert_equal 10, backup_codes.amountOfCodesLeft
+    assert_equal 10, backup_codes.codes.length
+  end
+
+  #
+  # Test verification of backup codes
+  #
+  def test_verify_backup_codes
+    test_identifier = rand(1000..9999).to_s
+
+    backup_codes = @twizo.create_backup_codes(nil)
+    backup_codes.params.identifier = test_identifier
+
+    backup_code = backup_codes.send
+    backup_code = backup_code.codes[0]
+
+    verification = backup_codes.verify(backup_code)
+
+    assert_equal test_identifier, verification.identifier
+  end
+
+  #
+  # Test retrievement of remaining backup codes
+  #
+  def test_get_backup_codes
+    test_identifier = rand(1000..9999).to_s
+
+    backup_codes = @twizo.create_backup_codes(nil)
+    backup_codes.params.identifier = test_identifier
+
+    backup_codes.send
+
+    check = @twizo.get_backup_code(test_identifier)
+
+    assert_equal test_identifier, check.identifier
+    assert_not_nil check.amountOfCodesLeft
+  end
+
+  #
+  # Test updating the backup codes
+  #
+  def test_update_backup_codes
+    test_identifier = rand(1000..9999).to_s
+
+    backup_codes = @twizo.create_backup_codes(nil)
+    backup_codes.params.identifier = test_identifier
+
+    backup_codes = backup_codes.update
+
+    assert_equal test_identifier, backup_codes.identifier
+    assert_equal 10, backup_codes.amountOfCodesLeft
+    assert_equal 10, backup_codes.codes.length
+  end
+
+  #
+  # Test deletion of backup codes
+  #
+  def test_delete_backup_codes
+    test_identifier = rand(1000..9999).to_s
+
+    backup_codes = @twizo.create_backup_codes(nil)
+    backup_codes.params.identifier = test_identifier
+
+    backup_codes = backup_codes.delete
+
+    assert_equal '204', backup_codes.code
+  end
+
+  def teardown
+    print "\n#{method_name}"
+  end
+
+end

data/test/test_balance.rb

@@ -0,0 +1,51 @@
+require_relative 'test_init'
+
+=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
+
+class TestBalance < TestInit
+
+  #
+  # Initialize Twizo
+  #
+  def setup
+    @twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+  end
+
+  #
+  # Test if an error is thrown when an invalid key is provided
+  #
+  def test_invalid_key
+    api_key = 'invalid_key'
+
+    assert_raise Twizo::TwizoError do
+      @twizo = Twizo::Twizo.new(api_key, API_HOST)
+      @twizo.get_balance
+    end
+  end
+
+  #
+  # Test get balance
+  #
+  def test_get_balance
+    balance = @twizo.get_balance
+
+    assert_not_nil balance.credit
+    assert_not_nil balance.currencyCode
+    assert_not_nil balance.freeVerifications
+    assert_not_nil balance.wallet
+  end
+
+  def teardown
+    print "\n#{method_name}"
+  end
+
+end

data/test/test_init.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require 'twizo'
+
+=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
+
+class TestInit < Test::Unit::TestCase
+
+  NUMBER1 = '601234567890'
+  NUMBER2 = '311234567890'
+
+  def self.load_config
+    filename = 'credentials.rb'
+
+    unless File.exist?("#{File.dirname(__FILE__)}/#{filename}")
+      print 'Enter api key: '
+      api_key = gets.chomp
+
+      print 'Enter api host: '
+      api_host = gets.chomp
+
+      file = File.new("#{File.dirname(__FILE__)}/#{filename}", 'w')
+      file.puts("API_KEY = '#{api_key}'")
+      file.puts("API_HOST = '#{api_host}'")
+      file.close
+    end
+
+    require_relative filename
+  end
+
+end
+
+TestInit.load_config

data/test/test_number_lookup.rb

@@ -0,0 +1,215 @@
+require_relative 'test_init'
+
+=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
+
+class TestNumberLookup < TestInit
+
+  #
+  # Initialize Twizo
+  #
+  def setup
+    @twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+  end
+
+  #
+  # Test if an error is thrown when an invalid key is provided
+  #
+  def test_invalid_key
+    api_key = 'invalid_key'
+
+    assert_raise Twizo::TwizoError do
+      @twizo = Twizo::Twizo.new(api_key, API_HOST)
+      number_lookup = @twizo.create_number_lookup(NUMBER1)
+      number_lookup.send
+    end
+  end
+
+  #
+  # Test creation of number lookup with multiple numbers
+  #
+  def test_create_number_lookup
+    number_lookup = @twizo.create_number_lookup(nil)
+
+    test_numbers = [NUMBER1, NUMBER2]
+    test_tag = 'test tag'
+    test_validity = 259200
+    test_result_type = 0
+    test_callback_url = nil
+
+    number_lookup.params.numbers = test_numbers
+    number_lookup.params.tag = test_tag
+    number_lookup.params.validity = test_validity
+    number_lookup.params.result_type = test_result_type
+    number_lookup.params.callback_url = test_callback_url
+
+    number_lookup = number_lookup.send
+
+    assert_equal test_numbers[0], number_lookup.result[0].number
+    assert_equal test_tag, number_lookup.result[0].tag
+    assert_equal 'no status', number_lookup.result[0].status
+
+    assert_equal test_numbers[1], number_lookup.result[1].number
+    assert_equal test_tag, number_lookup.result[1].tag
+    assert_equal 'no status', number_lookup.result[1].status
+  end
+
+  #
+  # Test creation of number lookup with a single number
+  #
+  def test_create_number_lookup_single
+    number_lookup = @twizo.create_number_lookup(nil)
+
+    test_number = NUMBER1
+    number_lookup.params.numbers = test_number
+
+    number_lookup = number_lookup.send
+
+    assert_equal test_number, number_lookup.result[0].number
+    assert_equal 'no status', number_lookup.result[0].status
+  end
+
+  #
+  # Test creation of number lookup and get status
+  #
+  def test_number_lookup_status
+    test_number = NUMBER1
+
+    number_lookup = @twizo.create_number_lookup(test_number)
+    number_lookup = number_lookup.send
+
+    test_message_id = number_lookup.result[0].messageId
+
+    status = @twizo.get_number_lookup_status(test_message_id)
+
+    assert_equal test_message_id, status.messageId
+    assert_equal test_number, status.number
+  end
+
+  #
+  # Test creation of number lookup and get results after completion of status
+  #
+  def test_number_lookup_results
+    test_number = NUMBER1
+
+    number_lookup = @twizo.create_number_lookup(test_number)
+    number_lookup.params.result_type = 2
+
+    number_lookup = number_lookup.send
+
+    x = false
+    until x
+      if @twizo.get_number_lookup_status(number_lookup.result[0].messageId).status == 'no status'
+        sleep 0.5
+        next
+      end
+      x = true
+    end
+
+    results = @twizo.get_number_lookup_results
+
+    assert_not_nil results.batchId
+
+    results.result.each do |item|
+      assert_not_nil item.number
+      assert_not_nil item.messageId
+    end
+  end
+
+  #
+  # Test number input normal
+  #
+  def test_different_numbers1
+    test_numbers = '1234567890'
+    number_lookup = @twizo.create_number_lookup(test_numbers)
+
+    number_lookup = number_lookup.send
+
+    assert_equal '1234567890', number_lookup.result[0].number
+  end
+
+  #
+  # Test number input with +
+  #
+  def test_different_numbers2
+    test_numbers = '+1234567890'
+    number_lookup = @twizo.create_number_lookup(test_numbers)
+
+    number_lookup = number_lookup.send
+
+    assert_equal '1234567890', number_lookup.result[0].number
+  end
+
+  #
+  # Test number input with 00
+  #
+  def test_different_numbers3
+    test_numbers = '00001234567890'
+    number_lookup = @twizo.create_number_lookup(test_numbers)
+
+    number_lookup = number_lookup.send
+
+    assert_equal '1234567890', number_lookup.result[0].number
+  end
+
+  #
+  # Test number input with ' '
+  #
+  def test_different_numbers4
+    test_numbers = '1 23 45 67 89 0'
+    number_lookup = @twizo.create_number_lookup(test_numbers)
+
+    number_lookup = number_lookup.send
+
+    assert_equal '1234567890', number_lookup.result[0].number
+  end
+
+  #
+  # Test number input with Characters
+  #
+  def test_different_numbers5
+    test_numbers = '1 23 A5 67 89 o'
+
+    assert_raise Twizo::TwizoError do
+      number_lookup = @twizo.create_number_lookup(test_numbers)
+      number_lookup.send
+    end
+  end
+
+  #
+  # Test number input with ()
+  #
+  def test_different_numbers6
+    test_numbers = '(1)234567890'
+    number_lookup = @twizo.create_number_lookup(test_numbers)
+
+    number_lookup = number_lookup.send
+
+    assert_equal '1234567890', number_lookup.result[0].number
+  end
+
+  #
+  # Test number input with + and ()
+  #
+  def test_different_numbers7
+    test_numbers = '+(1)234567890'
+    number_lookup = @twizo.create_number_lookup(test_numbers)
+
+    number_lookup = number_lookup.send
+
+    assert_equal '1234567890', number_lookup.result[0].number
+  end
+
+  def teardown
+    print "\n#{method_name}"
+  end
+
+end