lib/mobile/config.rb lib/mobile/globe/callback.rb lib/mobile/globe/response.rb lib/mobile/globe/rest.rb lib/mobile/globe/soap.rb lib/mobile/support.rb lib/mobile/version.rb lib/test.rb @@ -1,4 +1,5 @@ .project .loadpath *.gem +*.swp .gitignore @@ -1,11 +1,28 @@ -= Mobile API Ruby Gem += Globe-Mobile API in Ruby -== Required gems +* Website: http://github.com/gregmoreno/globe-mobile/tree/master + +== Developers +* {Greg Moreno}[http://gregmoreno.ca] <hello at gregmoreno dot ca> +* {Neil Decapia} +* {Mikong Galero} + +== Description + +globe-mobile provides a Ruby-based interface to Globe Telecoms Mobile API platform. +To learn more of the Globe's API, visit http://www.globelabs.com.ph + + +== External gem dependencies For using the API: - soap4r - xml-simple +* SOAP4R (tested with soap4r-1.5.8) +* XMLSimple (tested with xml-simple-1.0.12) -For testing and debugging: +For running tests rspec - ruby-debug \ No newline at end of file + + +== Usage examples + +TODO: README.rdoc @@ -1,2 +1,17 @@ -require File.dirname(__FILE__) + '/base' -require File.dirname(__FILE__) + '/mobile/globe' \ No newline at end of file +require 'rubygems' + +module Mobile; end + +require 'xmlsimple' +require 'hpricot' +require 'net/https' +require 'uri' + +def require_local(suffix) + require(File.expand_path(File.join(File.dirname(__FILE__), suffix))) +end + +require_local('mobile/support') +require_local('mobile/version') +require_local('mobile/globe') + lib/mobile.rb @@ -1,183 +1,10 @@ -require 'rubygems' -require 'soap/rpc/driver' -require 'xmlsimple' - -module Mobile - - # Required values when using this service - # :username => String - # :pin => String - class GlobeProxy < Base - include Validation - - # This is the version of the API that we will use - API_VERSION = '1.03' - - def initialize(params = {}) - params = { - :transport => 'soap', - :namespace => 'http://ESCPlatform/xsd', - :url => 'http://iplaypen.globelabs.com.ph:1881/axis2/services/Platform/' - }.merge(params) - - super(params) - validate_presence_of :username, :pin, :transport, :in => self.params - end - - def server - @server ||= send("initialize_proxy_#{self.params[:transport]}", self.params) - end - - def send_sms(sms) - validate_presence_of :to, :message, :in => sms - @response = server.send_sms( - self.params[:username], - self.params[:pin], - sms[:to], - sms[:message], - sms[:display] || '1', - sms[:user_data_header] || '', - sms[:message_waiting_indicator] || '', - sms[:coding] || '0' - ) - end - - def send_mms(mms) - validate_presence_of :to, :subject, :in => mms - @response = server.send_mms( - self.params[:username], - self.params[:pin], - mms[:to], - mms[:subject], - mms[:body] || '' - ) - end - - class << self - def parse_callback_xml(xml) - GlobeCallback.parse_xml(xml) - end - end - - ####### - private - ####### - - def initialize_proxy_soap(params) - ProxySoap.new(params) - end - - class ProxySoap - def initialize(params) - @server = SOAP::RPC::Driver.new(params[:url], params[:namespace]) - @server.add_method('sendSMS', 'uName', 'uPin', 'MSISDN', 'messageString', - 'Display', 'udh', 'mwi', 'coding') - - @server.add_method('sendMMS', 'uName', 'uPin', 'MSISDN', 'Subject', 'SMIL') - end - - def send_sms(uname, upin, msisdn, message, display, udh, mwi, coding) - result = @server.sendSMS(uname, upin, msisdn, message, display, udh, mwi, coding) - GlobeProxyResponse.new(result.to_i) - end - - def send_mms(u_name, u_pin, msisdn, subject, smil) - result = @server.sendMMS(u_name, u_pin, msisdn, subject, smil) - - # XXX API bug? If smil is not well-formed, sendMMS returns an empty - # SOAP::Mapping::Object. For now, force the result to "402 MMS sending failed" - result = 402 if result.is_a? SOAP::Mapping::Object - GlobeProxyResponse.new(result.to_i) - end - end - - class GlobeCallback - @@field_map = { - 'id' => :id, # unique message identifier - 'source' => :sender, # sender MSISDN/cellular number - 'target' => :recipient, # receiver MSISDN/cellular number - 'msg' => :message, # message - 'file' => :files, # MMS attachments - 'subject' => :subject, # MMS subject - 'messageType' => :type, # "SMS" or "MMS" - 'type' => :status # delivery status report code - } - - class << self - def parse_xml(xml) - message = XmlSimple.xml_in(xml) - message['param'].inject({}) do |h, param| - k, v = param['name'].first, param['value'].first - # Should still capture unknown parameters - h[(f = @@field_map[k]) ? f : k.to_sym] = v - h - end - end - end - end - end - - class GlobeProxyResponse - attr_reader :response_code - - @@error_map = { - :sms_accepted? => 201, - :sms_failed? => 401, - :mms_accepted? => 202, - :mms_failed? => 402, - :not_allowed? => 301, - :cap_exceeded? => 302, - :invalid_size? => 303, - :connection_exceeded? => 304, - :invalid_login? => 305, - :invalid_target? => 501, - :invalid_display? => 502, - :invalid_mwi? => 503, - :invalid_coding? => 504, - } - - @@status_messages = { - 201 => "SMS Accepted for delivery", - 202 => "MMS Accepted for delivery", - 301 => "User is not allowed to access this service", - 302 => "User exceeded daily cap", - 303 => "Invalid message_length", - 304 => "Maximum number of simultaneous connections reached", - 305 => "Invalid login credentials", - 401 => "SMS sending failed", - 402 => "MMS sending failed", - 501 => "Invalid target MSISDN", - 502 => "Invalid display type", - 503 => "Invalid MWI", - 504 => "Invalid coding", - 505 => "Empty value given in required argument", - 506 => "Badly formed XML in SOAP request", - 507 => "Argument too large", - 509 => "Malformed SMIL" - } - - def initialize(code) - @response_code = code - end - - def valid? - [201, 202].include?(@response_code) - end - - def message(code = @response_code) - if msg = @@status_messages[code] - msg - else - raise ArgumentError, "undefined response code" - end - end - - def method_missing(method_id) - if code = @@error_map[method_id.to_sym] - @response_code == code - else - raise NoMethodError, "undefined GlobeProxyResponse matcher" - end - end - end +module Mobile::Globe + class Response; end + module SOAP; end + module REST; end + module Callback; end end +require 'mobile/globe/response' +require 'mobile/globe/soap' +require 'mobile/globe/rest' +require 'mobile/globe/callback' lib/mobile/globe.rb lib/base.rb 0a4179b01e46592ab40c9b7b7d57f02a8cb62cfc Greg Moreno greg@gokou.local http://github.com/gregmoreno/globe-mobile/commit/45462a76a78ae0a015610345413510e8d571c75f 45462a76a78ae0a015610345413510e8d571c75f 2009-04-03T04:16:49-07:00 2009-04-03T04:16:49-07:00 Major refactor and support for REST. d6e55e520e41d4e6493ea0d72c8de41813d9e3a4 Greg Moreno greg@gokou.local