bluevia 1.0

data/lib/bluevia/bluevia_logger.rb

@@ -0,0 +1,30 @@
+require 'logger'
+
+#
+# BlueVia is a global iniciative of Telefonica delivered by Movistar and O2.
+# Please, check out www.bluevia.com and if you need more information
+# contact us at mailto:support@bluevia.com
+#
+
+
+module BlueviaLogger
+  def logger=(value)
+    $logger = value
+  end
+
+  def logger
+    $logger||=create_logger
+  end
+
+  def log_level=(level)
+    logger.level = level
+  end
+
+  def create_logger(output=nil)
+    output.nil? and output = STDOUT
+    logger = Logger.new(output)
+    logger.level = Logger::ERROR
+    logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+    logger
+  end
+end

data/lib/bluevia/directory.rb

@@ -0,0 +1,81 @@
+#
+# BlueVia is a global iniciative of Telefonica delivered by Movistar and O2.
+# Please, check out www.bluevia.com and if you need more information
+# contact us at mailto:support@bluevia.com
+
+require 'json'
+require 'net/http'
+require 'bluevia/base_client'
+
+module Bluevia
+  #
+  # This class is in charge of access Bluevia Directory API
+  #
+
+  class Directory < BaseClient
+
+    # Valid methods included in the API
+    @@valid_methods = %W[Profile AccessInfo TerminalInfo]
+    USER_PROFILE        = @@valid_methods[0]
+    USER_ACCESS_INFO    = @@valid_methods[1]
+    USER_TERMINAL_INFO  = @@valid_methods[2]
+
+    # Base Path for Directory API
+    BASEPATH_API = "/Directory"
+
+    def initialize(params = nil)
+      super(params)
+    end
+
+    #
+    # This method is in charge of retrieving user information
+    # [*user*] User identifier, a valid access token
+    # [*type*] information to be retrieved. Can be one or more @@valid_methods.
+    # Raises RuntimeError if any error occurred while invoking the request
+    #
+
+    def get_user_info(user, type = nil)
+      Utils.check_attribute user, "User cannot be null"
+      unless type.nil?
+        if (type.instance_of?(Array))
+          if type.length == 1
+            if @@valid_methods.to_a.include?(type[0])
+              _type = "/" + type[0]
+            else
+              raise SyntaxError, "Type not allowed. #{@@valid_methods} only."
+            end
+          else
+            _type = ""
+            data_sets = type.join(',')
+          end
+
+        elsif (type.instance_of?(String))
+          if @@valid_methods.to_a.include?(type)
+            _type = "/User" + type
+          else
+            raise SyntaxError, "Type not allowed. #{@@valid_methods} only."
+          end
+        else
+          raise SyntaxError, "Invalid type"
+        end
+      else
+        _type = ""
+      end
+
+      # Include the alias prefix in URL
+      identifier = CGI::escape("alias:#{user}")
+
+      params = Hash.new
+
+      unless data_sets.nil?
+        params[:dataSets] = data_sets
+      end
+
+      # returns the response body
+      GET("#{get_basepath}/#{identifier}/UserInfo#{_type}", params, nil)
+    end
+
+      
+  end
+end
+

data/lib/bluevia/errors.rb

@@ -0,0 +1,13 @@
+#
+# BlueVia is a global iniciative of Telefonica delivered by Movistar and O2.
+# Please, check out www.bluevia.com and if you need more information
+# contact us at mailto:support@bluevia.com
+#
+
+require 'bluevia/errors/server_error'
+require 'bluevia/errors/client_error'
+require 'bluevia/errors/not_found_error'
+
+module Bluevia::Errors
+
+end

data/lib/bluevia/errors/client_error.rb

@@ -0,0 +1,6 @@
+
+module Bluevia
+  class ClientError < StandardError
+
+  end
+end

data/lib/bluevia/errors/not_found_error.rb

@@ -0,0 +1,5 @@
+
+module Bluevia
+  class NotFoundError < StandardError
+  end
+end

data/lib/bluevia/errors/server_error.rb

@@ -0,0 +1,6 @@
+
+module Bluevia
+  class ServerError < StandardError
+
+  end
+end

data/lib/bluevia/ext/hash.rb

@@ -0,0 +1,64 @@
+require 'nokogiri'
+
+#
+# BlueVia is a global iniciative of Telefonica delivered by Movistar and O2.
+# Please, check out www.bluevia.com and if you need more information
+# contact us at mailto:support@bluevia.com
+# 
+# Extension of Hash to create a Hash table using as input an XML
+# that should be decoded using Nokogiri library
+#
+class Hash
+  class << self
+    def from_xml(xml_io)
+      begin
+        result = Nokogiri::XML(xml_io)
+        return { result.root.name.to_sym => xml_node_to_hash(result.root)}
+      rescue Exception => e
+        raise e
+      end
+    end
+
+    def xml_node_to_hash(node)
+      # If we are at the root of the document, start the hash
+      if node.element?
+        result_hash = {}
+        if node.attributes != {}
+          result_hash[:attributes] = {}
+          node.attributes.keys.each do |key|
+            result_hash[:attributes][node.attributes[key].name.to_sym] = prepare(node.attributes[key].value)
+          end
+        end
+        if node.children.size > 0
+          node.children.each do |child|
+            result = xml_node_to_hash(child)
+
+            if child.name == "text"
+              unless child.next_sibling || child.previous_sibling
+                return prepare(result)
+              end
+            elsif result_hash[child.name.to_sym]
+              if result_hash[child.name.to_sym].is_a?(Object::Array)
+                result_hash[child.name.to_sym] << prepare(result)
+              else
+                result_hash[child.name.to_sym] = [result_hash[child.name.to_sym]] << prepare(result)
+              end
+            else
+              result_hash[child.name.to_sym] = prepare(result)
+            end
+          end
+
+          return result_hash
+        else
+          return result_hash
+        end
+      else
+        return prepare(node.content.to_s)
+      end
+    end
+
+    def prepare(data)
+      (data.class == String && data.to_i.to_s == data) ? data.to_i : data
+    end
+  end
+end

data/lib/bluevia/messaging.rb

@@ -0,0 +1,96 @@
+#
+# BlueVia is a global iniciative of Telefonica delivered by Movistar and O2.
+# Please, check out www.bluevia.com and if you need more information
+# contact us at mailto:support@bluevia.com
+
+module Bluevia
+  #
+  # This module is a mixin used by SMS client to get some basic messaging features
+  #
+
+  module Messaging
+
+
+    #
+    # This method is used to retrieve MO messages that belongs to a specific registration ID
+    # [*registration_id*] MO Registration Identifier Mandatory
+    # [*message_id*] message unique identifier
+    # [*attachments*] bool flag to get message attachments (if true)
+    # returns a collection of messages
+    #
+    def get_received_message(registration_id, message_id = nil, attachments = false)
+      Utils.check_attribute(registration_id, "Provisioning registration id must be provided")
+      unless message_id.nil?
+        message_id = "/#{message_id}"
+        unless attachments == false
+          attachments = "/attachments"
+        else
+          attachments = ""
+        end
+      else
+        message_id = ""
+        attachments = ""
+      end
+      GET("#{get_basepath}/inbound/#{registration_id}/messages#{message_id}#{attachments}")
+    end
+
+    #
+    # This method allows to retrieved a specific attachment belonging to a message
+    # [*registration_id*] MO Registration Identifier
+    # [*message_id*] message unique identifier
+    # [*attachment_id*] attachment identifier (corresponding to the specific message
+    #
+
+    def get_attachment(registration_id, message_id, attachment_id)
+      Utils.check_attribute(registration_id, "Registration id must be provided")
+      Utils.check_attribute(message_id, "Message id must be provided")
+      Utils.check_attribute(attachment_id, "Attachment id must be provided")
+      GET("#{get_basepath}/inbound/#{registration_id}/messages/#{message_id}/attachments/#{attachment_id}")
+    end
+
+    #
+    # This method returns the delivery status of a SMS sent by the user
+    # [*id*] message unique identifier
+    #
+
+    def get_delivery_status (id)
+      Utils.check_attribute id, "#{self.class.to_s.upcase} identifier cannot be null"
+      if is_url?(id)
+        id = id.split("/").last(2).first
+      end
+      response = GET("#{get_basepath}/outbound/requests/#{id}/deliverystatus", nil, nil)
+
+      # Clean duplicated key
+      if response.instance_of?(Hash)
+        if response.has_key?("smsDeliveryStatus")
+          return response["smsDeliveryStatus"]
+        elsif response.has_ley?("messageDeliveryStatus")
+          return response["messageDeliveryStatus"]
+        else
+          return response
+        end
+      end
+    end
+
+    #
+    # This method stop the message notification (MO)
+    # [*subscription_id*] The subscription identifier to be deleted
+    #
+
+    private
+
+    #
+    # Validates if a URL is defined properly
+    #
+    def is_url?(identifier)
+      if identifier.match(/^https?:\/\//i).nil?
+      # if identifier.match(/^https?:\/\/([a-z0-9-]+\.)+[a-z0-9]+(:[0-9]{2,5})?/i)
+      #if identifier.match(/^https?:\/\/([a-z]+\.)*[a-z]+$/i).nil?
+      #if identifier.match(/^https?:\/\/([a-z]+\.)*[a-z]+$/i).nil?
+        return false
+      else
+        return true
+      end
+    end
+  end
+end

data/lib/bluevia/oauth.rb

@@ -0,0 +1,117 @@
+#
+# BlueVia is a global iniciative of Telefonica delivered by Movistar and O2.
+# Please, check out www.bluevia.com and if you need more information
+# contact us at mailto:support@bluevia.com
+
+require 'oauth'
+require 'oauth/signature/hmac/sha1'
+require 'oauth/client/helper'
+
+module Bluevia
+  #
+  # This class can be used to launch oAuth authentication mechanism when
+  # a user is using the application for the first time
+  #
+  # User authentication is launched using oAuth protocol, so user is not required to use credentials in third party applications. If you want to learn more about oAuth please check this URL.
+  # When user wants to launch the oAuth process, once the Bluevia client has been created only the two lines below are required to retrieve a valid token for user:
+  #
+  #  @service = @bc.get_service(:oAuth)
+  #  token, secret, url = @service.get_request_token({:callback =>"http://foo.bar"})
+  #
+  # The retrieved parameter token and secret should be use during the oAuth process, and url is the endpoint where Bluevia shall authenticate the user. In case of a Rails application, the lines below could be used:
+  #
+  #  token, token_secret, url = @service.get_request_token("http://juan.pollinimini.net/bluevia/get_access")
+  #  cookies[:token] = "#{token}|#{token_secret}"
+  #  redirect_to(url)
+  #
+  # Once user is authenticated and she authorized the application in BlueVia portal, she should be redirected to the URL used as parameter before. Now it's time to fetch the valid token and token secret that shall identify the new user during any call to BlueVia API. Lines below show an example using Rails:
+  #
+  #  def get_access
+  #     oauth_verifier = params[:oauth_verifier]
+  #     get_token_from_cookie
+  #     @bc = BlueviaClient.new(
+  #       { :consumer_key   => CONSUMER_KEY,
+  #         :consumer_secret=> CONSUMER_SECRET
+  #       })
+  #     @service = @bc.get_service(:oAuth)
+  #     @token, @token_secret = @service.get_access_token(@request_token, @request_secret, oauth_verifier)
+  #  end
+  #
+  #  private
+  #   def get_token_from_cookie
+  #     cookie_token = cookies[:token]
+  #     unless cookie_token.nil?
+  #       cookie_token = cookie_token.split("|")
+  #       if cookie_token.size != 2
+  #         raise SyntaxError, "The cookie is not valid"
+  #       end
+  #       @request_token = cookie_token[0]
+  #       @request_secret = cookie_token[1]
+  #     end
+  #   end
+
+  class Oauth < BaseClient
+
+    AUTHORIZE_URI          = "http://connect.bluevia.com/authorise/"
+
+    def initialize(params = nil)
+      super(params)
+    end
+
+    def get_request_token(_params)
+      
+      consumer=OAuth::Consumer.new \
+        @consumer_key,
+        @consumer_secret,
+        {
+          :site               => @@base_uri,
+          :signature_method   => "HMAC-SHA1",
+          :request_token_path => "#{BASEPATH}/Oauth/getRequestToken",
+          :access_token_path  => "#{BASEPATH}/Oauth/getAccessToken",
+          #:proxy              => "http://localhost:8888",
+          :http_method        => :post
+        }
+
+      params = Hash.new
+      specific_params = Hash.new
+      if _params.instance_of?(String)
+        params[:oauth_callback] = _params
+        uri = AUTHORIZE_URI
+      elsif _params.instance_of?(Hash)
+        if _params.has_key?(:callback)
+          params[:oauth_callback] = _params[:callback]
+        else
+          Raise SyntaxError, "Callback parameter must be provided"
+        end
+        if _params.has_key?(:uri)
+          uri = _params[:uri]
+        else
+          uri = AUTHORIZE_URI
+        end
+      end
+      request_token = consumer.get_request_token(params, {:v => "1"}, specific_params)
+      return request_token.token, request_token.secret, "#{uri}?oauth_token=#{request_token.token}"
+
+    end
+
+    def get_access_token(token, token_secret, oauth_verifier)
+      begin
+        consumer = OAuth::Consumer.new \
+          @consumer_key, @consumer_secret,
+          {
+            :site               => BASEURI,
+            :signature_method   => "HMAC-SHA1",
+            :request_token_path => "#{BASEPATH}/Oauth/getRequestToken",
+            :access_token_path  => "#{BASEPATH}/Oauth/getAccessToken",
+            :http_method        => :post
+          }
+        request_token = OAuth::RequestToken.new(consumer, token, token_secret)
+        access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
+
+        return access_token.params[:oauth_token], access_token.params[:oauth_token_secret]
+      rescue => ex
+        return nil, nil # error
+      end
+    end
+  end
+end

data/lib/bluevia/response.rb

@@ -0,0 +1,48 @@
+#
+# BlueVia is a global iniciative of Telefonica delivered by Movistar and O2.
+# Please, check out www.bluevia.com and if you need more information
+# contact us at mailto:support@bluevia.com
+
+module Bluevia
+  #
+  # Inner class that wraps the response
+  #
+
+  class Response
+    # HTTP response code
+    attr_accessor :code
+    # HTTP response body
+    attr_accessor :body
+    # HTTP headers (required when creating resources)
+    attr_accessor :headers
+
+    attr_accessor :message
+
+    def initialize
+      @body = ""
+    end
+
+    def to_s
+      value = String.new
+      self.instance_variables.each{ |var|
+        value << "#{var} : #{get_value(self.instance_variable_get(var))} \n"
+      }
+      value
+    end
+
+    def get_value(var)
+      if var.instance_of?(String)
+        var
+      elsif var.instance_of?(Hash)
+        var.to_a.join(" - ")
+      else
+        var
+      end
+    end
+
+    def [](value)
+      return self.instance_variable_get("@#{value}")
+    end
+
+  end
+end