twizo 0.1.1

data/lib/twizo.rb

@@ -0,0 +1,190 @@
+require "twizo/version"
+require "twizo/client/net_http_client"
+require "twizo/entity"
+require "twizo/status_codes"
+
+require "twizo/modules/number_lookup"
+require "twizo/modules/sms"
+require "twizo/modules/balance"
+require "twizo/modules/backup_codes"
+require "twizo/modules/verification"
+require "twizo/modules/widget"
+
+=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 Twizo
+
+    #
+    # Constructor
+    #
+    # @param [String] api_key
+    # @param [String] api_host
+    #
+    def initialize(api_key, api_host)
+      @client = NetHttpClient.new(api_key, api_host)
+    end
+
+    # Number Lookup
+
+    #
+    # @param [String|Array] numbers
+    #
+    def create_number_lookup(numbers)
+      number_lookup = Entity.new(@client).extend(NumberLookup)
+      number_lookup.set(numbers)
+      number_lookup
+    end
+
+    #
+    # @param [String] message_id
+    #
+    # @return [Object]
+    #
+    def get_number_lookup_status(message_id)
+      number_lookup = Entity.new(@client).extend(NumberLookup)
+      number_lookup.populate(message_id)
+    end
+
+    #
+    # @return [Object]
+    #
+    def get_number_lookup_results
+      number_lookup = Entity.new(@client).extend(NumberLookup)
+      number_lookup.poll
+    end
+
+    # Sms
+
+    #
+    # @param [String] body
+    # @param [String|Array] recipients
+    # @param [String] sender
+    #
+    # @return [Object]
+    #
+    def create_sms(body, recipients, sender)
+      sms = Entity.new(@client).extend(Sms)
+      sms.set(body, recipients, sender)
+      sms
+    end
+
+    #
+    # @param [String] message_id
+    #
+    # @return [Object]
+    #
+    def get_sms_status(message_id)
+      sms = Entity.new(@client).extend(Sms)
+      sms.populate(message_id)
+    end
+
+    #
+    # @return [Object]
+    #
+    def get_sms_results
+      sms = Entity.new(@client).extend(Sms)
+      sms.poll
+    end
+
+    # Balance
+
+    def get_balance
+      balance = Entity.new(@client).extend(Balance)
+      balance.send
+    end
+
+    # Backup Codes
+
+    #
+    # @param [String] identifier
+    #
+    # @return [Object]
+    #
+    def create_backup_codes(identifier)
+      backup_codes = Entity.new(@client).extend(BackupCodes)
+      backup_codes.set(identifier)
+      backup_codes
+    end
+
+    #
+    # @param [String] identifier
+    #
+    # @return [Object]
+    #
+    def get_backup_code(identifier)
+      backup_codes = Entity.new(@client).extend(BackupCodes)
+      backup_codes.populate(identifier)
+    end
+
+    # Verification
+
+    #
+    # @param [String] recipient
+    #
+    # @return [Object]
+    #
+    def create_verification(recipient)
+      verification = Entity.new(@client).extend(Verification)
+      verification.set(recipient)
+      verification
+    end
+
+    #
+    # @param [String] message_id
+    # @param [String] token
+    #
+    # @return [Object]
+    #
+    def verify_token(message_id, token)
+      verification = Entity.new(@client).extend(Verification)
+      verification.verify(message_id, token)
+    end
+
+    #
+    # @param [String] message_id
+    #
+    # @return [Object]
+    #
+    def get_verification_status(message_id)
+      verification = Entity.new(@client).extend(Verification)
+      verification.populate(message_id)
+    end
+
+    # Verification widget
+
+    #
+    # @param [String] recipient
+    #
+    # @return [Object]
+    #
+    def create_widget(recipient)
+      widget = Entity.new(@client).extend(Widget)
+      widget.set(recipient)
+      widget
+    end
+
+    #
+    # @param [String] session_token
+    # @param [String|null] recipient
+    # @param [String|null] backup_code_identifier
+    #
+    # @return [Object]
+    #
+    def get_widget_status(session_token, recipient = nil, backup_code_identifier = nil)
+      widget = Entity.new(@client).extend(Widget)
+      widget.populate(session_token, recipient, backup_code_identifier)
+    end
+
+  end
+end

data/lib/twizo/client.rb

@@ -0,0 +1,45 @@
+=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 Client
+
+    API_VERSION = 'v1'
+    API_USERNAME = 'twizo'
+    LIB_NAME = 'Twizo-ruby-lib'
+    LIB_VERSION = '0.1.0'
+
+    #
+    # Constructor
+    #
+    # @param [String] api_key
+    # @param [String] api_host
+    #
+    def initialize(api_key, api_host)
+      @api_key, @api_host = api_key, api_host
+    end
+
+    #
+    # @return [String]
+    #
+    def user_agent
+      sprintf('%s/%s Ruby/%s/%s',
+              LIB_NAME,
+              LIB_VERSION,
+              RUBY_VERSION,
+              RUBY_PLATFORM
+      )
+    end
+
+  end
+
+end

data/lib/twizo/client/net_http_client.rb

@@ -0,0 +1,48 @@
+require_relative "../client"
+
+require 'net/http'
+require 'uri'
+
+module Twizo
+
+  class NetHttpClient < Client
+
+    #
+    # @param [String] method
+    # @param [String] location
+    #
+    # @return [Object]
+    #
+    def send_request(method, location, post_params)
+      uri = URI.parse("https://#{@api_host}/#{Client::API_VERSION}/#{location}")
+
+      case method
+        when 'GET'
+          request = Net::HTTP::Get.new(uri)
+        when 'POST'
+          request = Net::HTTP::Post.new(uri)
+        when 'PUT'
+          request = Net::HTTP::Put.new(uri)
+        when 'DELETE'
+          request = Net::HTTP::Delete.new(uri)
+        else
+          raise RuntimeError.new('No method provided')
+      end
+
+      request.add_field('user-agent', user_agent)
+      request.basic_auth(API_USERNAME, @api_key)
+      request.content_type = 'application/json; charset=utf8'
+      request['accept'] = 'application/json'
+
+      request.body = post_params unless post_params.nil?
+
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+
+      https.request(request)
+
+    end
+
+  end
+
+end

data/lib/twizo/entity.rb

@@ -0,0 +1,114 @@
+require "twizo/result"
+require "twizo/twizo_error"
+
+=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 Entity
+
+    #
+    # http method actions
+    #
+    ACTION_CREATE = 'POST'
+    ACTION_UPDATE = 'PUT'
+    ACTION_RETRIEVE = 'GET'
+    ACTION_REMOVE = 'DELETE'
+
+    #
+    # Constructor
+    #
+    # @param [Client] client
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    #
+    # @param [String] id
+    # @param [String|null] widget_recipient
+    # @param [String|null] widget_backup_code_id
+    #
+    # @return [Object]
+    #
+    def populate(id, widget_recipient = nil, widget_backup_code_id = nil)
+      raise 'Error: id not provided' unless id
+
+      params = id
+      params += "?recipient=#{widget_recipient}" if widget_recipient
+      params += "&backupCodeIdentifier=#{widget_backup_code_id}" if widget_backup_code_id
+
+      response = send_api_call(ACTION_RETRIEVE, "#{location}/#{params}")
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response)
+    end
+
+    private
+
+    #
+    # @param [String] method
+    # @param [String] location
+    # @param [Object|null] post_params
+    #
+    # @return [Object]
+    #
+    def send_api_call(method, location, post_params = nil)
+      response = @client.send_request(method, location, post_params)
+
+      case Integer(response.code)
+        when 200, 201
+          JSON.parse(response.body)
+        when 204
+          response
+        else
+          raise TwizoError.new(response.code, JSON.parse(response.body))
+      end
+    end
+
+    #
+    # @param [Object] response
+    # @param [String|null] field
+    #
+    # @return [Object]
+    #
+    def response_to_array(response, field = nil)
+
+      parent_items = response.reject { |key| key == '_embedded' }
+
+      results = Result.new(parent_items)
+
+      if field
+        child_items = response['_embedded'][field]
+
+        if child_items.kind_of?(Array)
+
+          child_items.each do |item|
+            results.add_result(Result.new(item))
+          end
+
+        else
+
+          results.add_result(Result.new(child_items))
+
+        end
+
+      end
+
+      results
+    end
+
+  end
+
+end
+

data/lib/twizo/modules/backup_codes.rb

@@ -0,0 +1,100 @@
+require_relative 'params/backup_codes_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 BackupCodes
+
+    #
+    # Getter for params
+    #
+    attr_reader :params
+
+    #
+    # @param [String] identifier
+    #
+    def set(identifier)
+      @params = BackupCodesParams.new
+      @params.identifier = identifier
+    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] backup_code
+    #
+    # @return [Object]
+    #
+    def verify(backup_code)
+      response = send_api_call(Entity::ACTION_RETRIEVE, "#{location}/#{@params.identifier}?token=#{backup_code}")
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response)
+    end
+
+    #
+    # Update de backup codes
+    #
+    # @return [Object]
+    #
+    def update
+      post_params = @params.to_json
+
+      response = send_api_call(Entity::ACTION_UPDATE, "#{location}/#{@params.identifier}", post_params)
+
+      raise response if response.kind_of?(TwizoError)
+
+      response_to_array(response)
+    end
+
+    #
+    # Delete de backup codes
+    #
+    # @return [Object]
+    #
+    def delete
+      response = send_api_call(Entity::ACTION_REMOVE, "#{location}/#{@params.identifier}")
+
+      raise response if response.kind_of?(TwizoError)
+
+      # return 204 No Content
+      response
+    end
+
+    private
+
+    #
+    # @return [String]
+    #
+    def location
+      'backupcode'
+    end
+
+  end
+
+end
+