bluevia 1.0

data/lib/bluevia/schemas/sms_types.rb

@@ -0,0 +1,256 @@
+require 'xsd/qname'
+
+module Schemas; module Sms_types
+
+
+# {http://www.telefonica.com/schemas/UNICA/REST/sms/v1/}SMSTextType
+#   address - Schemas::Sms_types::UserIdType
+#   message - SOAP::SOAPString
+#   receiptRequest - Schemas::Sms_types::SimpleReferenceType
+#   originAddress - Schemas::Sms_types::UserIdType
+#   encode - SOAP::SOAPString
+#   sourceport - SOAP::SOAPInt
+#   destinationport - SOAP::SOAPInt
+#   esm_class - SOAP::SOAPInt
+#   data_coding - SOAP::SOAPInt
+class SMSTextType
+  attr_accessor :address
+  attr_accessor :message
+  attr_accessor :receiptRequest
+  attr_accessor :originAddress
+  attr_accessor :encode
+  attr_accessor :sourceport
+  attr_accessor :destinationport
+  attr_accessor :esm_class
+  attr_accessor :data_coding
+
+  def initialize(address = [], message = nil, receiptRequest = nil, originAddress = nil, encode = nil, sourceport = nil, destinationport = nil, esm_class = nil, data_coding = nil)
+    @address = address
+    @message = message
+    @receiptRequest = receiptRequest
+    @originAddress = originAddress
+    @encode = encode
+    @sourceport = sourceport
+    @destinationport = destinationport
+    @esm_class = esm_class
+    @data_coding = data_coding
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/sms/v1/}SMSDeliveryStatusType
+class SMSDeliveryStatusType < ::Array
+end
+
+
+# {http://www.telefonica.com/schemas/UNICA/REST/sms/v1/}ReceivedSMSType
+class ReceivedSMSType < ::Array
+end
+
+
+
+# {http://www.telefonica.com/schemas/UNICA/REST/sms/v1/}DeliveryInformationType
+#   address - Schemas::Sms_types::UserIdType
+#   deliveryStatus - (any)
+#   description - SOAP::SOAPString
+class DeliveryInformationType
+  attr_accessor :address
+  attr_accessor :deliveryStatus
+  attr_accessor :description
+
+  def initialize(address = nil, deliveryStatus = nil, description = nil)
+    @address = address
+    @deliveryStatus = deliveryStatus
+    @description = description
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/sms/v1/}SMSMessageType
+#   message - SOAP::SOAPString
+#   originAddress - Schemas::Sms_types::UserIdType
+#   destinationAddress - Schemas::Sms_types::UserIdType
+#   dateTime - SOAP::SOAPDateTime
+class SMSMessageType
+  attr_accessor :message
+  attr_accessor :originAddress
+  attr_accessor :destinationAddress
+  attr_accessor :dateTime
+
+  def initialize(message = nil, originAddress = nil, destinationAddress = nil, dateTime = nil)
+    @message = message
+    @originAddress = originAddress
+    @destinationAddress = destinationAddress
+    @dateTime = dateTime
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}AddressType
+#   street - SOAP::SOAPString
+#   streetNumber - SOAP::SOAPUnsignedInt
+#   locality - SOAP::SOAPString
+#   region - SOAP::SOAPString
+#   postalCode - SOAP::SOAPUnsignedInt
+#   country - SOAP::SOAPString
+#   ext - SOAP::SOAPString
+class AddressType
+  attr_accessor :street
+  attr_accessor :streetNumber
+  attr_accessor :locality
+  attr_accessor :region
+  attr_accessor :postalCode
+  attr_accessor :country
+  attr_accessor :ext
+
+  def initialize(street = nil, streetNumber = nil, locality = nil, region = nil, postalCode = nil, country = nil, ext = nil)
+    @street = street
+    @streetNumber = streetNumber
+    @locality = locality
+    @region = region
+    @postalCode = postalCode
+    @country = country
+    @ext = ext
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}UserIdType
+#   phoneNumber - (any)
+#   anyUri - SOAP::SOAPAnyURI
+#   ipAddress - Schemas::Sms_types::IpAddressType
+#   m_alias - (any)
+#   otherId - Schemas::Sms_types::OtherIdType
+class UserIdType
+  attr_accessor :phoneNumber
+  attr_accessor :anyUri
+  attr_accessor :ipAddress
+  attr_accessor :otherId
+
+  def m_alias
+    @v_alias
+  end
+
+  def m_alias=(value)
+    @v_alias = value
+  end
+
+  def initialize(phoneNumber = nil, anyUri = nil, ipAddress = nil, v_alias = nil, otherId = nil)
+    @phoneNumber = phoneNumber
+    @anyUri = anyUri
+    @ipAddress = ipAddress
+    @v_alias = v_alias
+    @otherId = otherId
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}IpAddressType
+#   ipv4 - (any)
+#   ipv6 - (any)
+class IpAddressType
+  attr_accessor :ipv4
+  attr_accessor :ipv6
+
+  def initialize(ipv4 = nil, ipv6 = nil)
+    @ipv4 = ipv4
+    @ipv6 = ipv6
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}OtherIdType
+#   type - SOAP::SOAPString
+#   value - SOAP::SOAPString
+class OtherIdType
+  attr_accessor :type
+  attr_accessor :value
+
+  def initialize(type = nil, value = nil)
+    @type = type
+    @value = value
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}ClientExceptionType
+#   exceptionCategory - SOAP::SOAPString
+#   exceptionId - SOAP::SOAPInt
+#   text - SOAP::SOAPString
+#   variables - SOAP::SOAPString
+class ClientExceptionType
+  attr_accessor :exceptionCategory
+  attr_accessor :exceptionId
+  attr_accessor :text
+  attr_accessor :variables
+
+  def initialize(exceptionCategory = nil, exceptionId = nil, text = nil, variables = [])
+    @exceptionCategory = exceptionCategory
+    @exceptionId = exceptionId
+    @text = text
+    @variables = variables
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}ServerExceptionType
+#   exceptionCategory - SOAP::SOAPString
+#   exceptionId - SOAP::SOAPInt
+#   text - SOAP::SOAPString
+#   variables - SOAP::SOAPString
+class ServerExceptionType
+  attr_accessor :exceptionCategory
+  attr_accessor :exceptionId
+  attr_accessor :text
+  attr_accessor :variables
+
+  def initialize(exceptionCategory = nil, exceptionId = nil, text = nil, variables = [])
+    @exceptionCategory = exceptionCategory
+    @exceptionId = exceptionId
+    @text = text
+    @variables = variables
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}SimpleReferenceType
+#   endpoint - SOAP::SOAPAnyURI
+#   correlator - SOAP::SOAPString
+class SimpleReferenceType
+  attr_accessor :endpoint
+  attr_accessor :correlator
+
+  def initialize(endpoint = nil, correlator = nil)
+    @endpoint = endpoint
+    @correlator = correlator
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}ExtensionType
+class ExtensionType
+  attr_reader :__xmlele_any
+
+  def set_any(elements)
+    @__xmlele_any = elements
+  end
+
+  def initialize
+    @__xmlele_any = nil
+  end
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/sms/v1/}DeliveryStatusType
+class DeliveryStatusType < ::String
+  DeliveredToNetwork = DeliveryStatusType.new("DeliveredToNetwork")
+  DeliveredToTerminal = DeliveryStatusType.new("DeliveredToTerminal")
+  DeliveryImpossible = DeliveryStatusType.new("DeliveryImpossible")
+  DeliveryNotificationNotSupported = DeliveryStatusType.new("DeliveryNotificationNotSupported")
+  DeliveryUncertain = DeliveryStatusType.new("DeliveryUncertain")
+  MessageWaiting = DeliveryStatusType.new("MessageWaiting")
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}FlagType
+class FlagType < ::String
+  No = FlagType.new("no")
+  Yes = FlagType.new("yes")
+end
+
+# {http://www.telefonica.com/schemas/UNICA/REST/common/v1}GenderType
+class GenderType < ::String
+  Female = GenderType.new("female")
+  Male = GenderType.new("male")
+end
+
+
+end; end

data/lib/bluevia/sms.rb

@@ -0,0 +1,91 @@
+#
+# 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/messaging'
+require 'bluevia/schemas/sms_types'
+
+module Bluevia
+  #
+  # This class is in charge of access Bluevia SMS API
+  #
+
+  class Sms < BaseClient
+    include Messaging
+
+    include Schemas::Sms_types
+
+    # Basepath for SMS API
+    BASEPATH_API = "/SMS"
+
+    def initialize(params = nil)
+      super(params)
+      #super.extend(Schemas::Sms_types)
+    end
+
+    # 
+    # This method sends a SMS to a list of destination numbers.
+    # [*dest_number*] array, fixnum or string with the destination numbers
+    # [*origin*] originator number the SMS will be send in name of. Should be a
+    # valid access_token.
+    # [*text*] short message text
+    # returns the location where the delivery status can be checked
+    # 
+    def send_sms (dest_number, origin, text)
+      Utils.check_attribute dest_number, "Destination number cannot be null"
+      Utils.check_attribute text, "SMS text cannot be null"
+      Utils.check_attribute origin, "Origin number cannot be null"
+
+      # Set destination array
+      @dest_phones = Array.new
+      if (dest_number.instance_of?(Array))
+        dest_number.each { |i|
+          @dest_phones << UserIdType.new(i, nil, nil, nil, nil)
+        }
+      else
+        @dest_phones << UserIdType.new(dest_number, nil, nil, nil, nil)
+      end
+
+      @orig = UserIdType.new(nil, nil, nil, origin, nil)
+
+      # Create Message and convert to JSON
+      @msg = SMSTextType.new(@dest_phones, text, nil, @orig, nil, nil, nil, nil, nil)
+      message = Utils.object_to_json(@msg)
+
+      logger.debug "SMS Send this message:"
+      logger.debug message << "\n"
+
+      POST("#{get_basepath}/outbound/requests", message.to_s, nil, nil, "location")
+    end
+
+    #
+    # This method is used to retrieve MO messages that belongs to a specific registration ID
+    # [*registration_id*] MO Registration Identifier Mandatory
+    # returns a collection of messages
+    #
+    def get_received_sms(registration_id)
+      response = get_received_message(registration_id)
+      key = "receivedSMS"
+
+      # Fetch ["receivedSMS"]["receivedSMS"]
+      unless response.nil?
+        if response.respond_to?(:has_key?) && response.has_key?(key)
+          response = response[key]
+          if response.respond_to?(:has_key?) && response.has_key?(key)
+            return response[key]
+          else
+            return Hash.new
+          end
+        else
+          return Hash.new
+        end
+      else
+        return Hash.new
+      end
+      
+    end
+
+
+  end
+end

data/lib/bluevia/utils.rb

@@ -0,0 +1,110 @@
+#
+# 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 'net/http'
+require 'multipartable'
+require 'bluevia/errors/client_error'
+
+module Bluevia
+  #
+  # Helper to enable internal features
+  #
+
+  module Utils
+
+    class Multipart < Net::HTTP::Post
+      include Multipartable
+
+      def set_content_type(type, params = {})
+
+      end
+
+      def content_length=(len)
+
+      end
+    end
+
+    def Utils.get_file_mime_type(file)
+      unless file.nil?
+        Magic.guess_file_mime_type(file)
+      else
+        nil
+      end
+    end
+
+    #
+    # Helper to parse an objet to an equivalent JSON format
+    # used to serialize body data
+    #
+    def Utils.object_to_json(object)
+      name = object.class.to_s
+      name = name[name.rindex(":")+1..name.size].sub(/Type$/,"").sub(/^SMS/, "sms")
+      name = name[0..0].to_s.downcase << name[1..name.size]
+      result = Hash.new
+      result[name] = _object_to_json(object)
+      return result.to_json
+
+      #return _object_to_json(object).to_json
+    end
+
+    #
+    # Check if an attribute is not null
+    # Raise an exception in case of param.nil?
+    #
+    def Utils.check_attribute(attribute, message)
+      if attribute.nil?
+        raise ClientError, message
+      elsif attribute.instance_of?(String)
+        if attribute.empty?
+          raise ClientError, message
+        end
+      else
+        if attribute.respond_to?(:size)
+          if attribute.size == 0
+            raise ClientError, message
+          end
+        end
+      end
+    end
+
+
+    private
+
+    def Utils._object_to_json(object)
+      result = Hash.new
+      #result_aux = []
+      object.instance_variables.each do |column|
+        aux = object.instance_variable_get(column)
+        unless aux.nil?
+          if aux.instance_of?(String) or aux.kind_of?(String)
+            # It's required to erase any '_' character because
+            # soap4r has included it (not idea about the reason)
+            result[get_column_value(column)] = aux.to_s
+          else
+            if aux.instance_of?(Array)
+              result_aux = Array.new
+              aux.each do |elem|
+                result_aux << _object_to_json(elem)
+              end
+            else
+              result_aux = _object_to_json(aux)
+            end
+            result[get_column_value(column)] = result_aux
+            #result_aux =[]
+          end
+        end
+      end
+      return result
+    end
+
+    def Utils.get_column_value(column)
+      column = column.to_s.sub(/@/,'')
+      unless column.index('_').nil?
+        column = column.split('_')[1]
+      end
+      column
+    end
+  end
+end