rumeme 0.1.0

data/README.rdoc

@@ -0,0 +1,9 @@
+= RuMeMe
+Ruby SDK for Message Media SMS Gateway API.
+Since Message Media doesn't provide any ruby projects support, we decided to port it from available SDKs (mainly from PHP SDK; and some .NET usage). 
+For more information checkout {Message Media SMS APIs}[http://www.message-media.com/sms-gateway.html].
+
+= To Do
+* Refactoring to make api more rubyish.
+* Add unit tests
+* Extend documentation with Usage section.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake'
+require 'rake/gempackagetask'
+
+GEM_ROOT     = File.dirname(__FILE__).freeze
+VERSION_FILE = File.join(GEM_ROOT, 'lib', 'rumeme', 'version')
+
+require VERSION_FILE
+
+gemspec = Gem::Specification.new do |s|
+  s.name        = 'rumeme'
+  s.version     = Rumeme::VERSION
+  s.summary     = 'Ruby SDK for Message Media SMS Gateway API'
+
+  s.files        = FileList['[A-Z]*', 'lib/**/*.rb']
+  s.require_path = 'lib'
+
+  s.extra_rdoc_files = ['README.rdoc']
+  s.rdoc_options = ['--line-numbers', "--main", "README.rdoc"]
+
+  s.add_runtime_dependency('nokogiri', '1.4.1')
+
+  s.authors = ['antlypls']
+  s.email   = 'antlypls@gmail.com'
+  s.homepage = 'http://github.com/programmable/rumeme'
+
+  s.platform = Gem::Platform::RUBY
+end
+
+Rake::GemPackageTask.new gemspec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end

data/lib/rumeme/configuration.rb

@@ -0,0 +1,12 @@
+module Rumeme
+  class Configuration
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :use_message_id
+    attr_accessor :secure
+    #attr_accessor :proxy_settings
+    attr_accessor :allow_splitting
+    attr_accessor :allow_long_messages
+  end
+end
+

data/lib/rumeme/message_status.rb

@@ -0,0 +1,11 @@
+module Rumeme
+  # This class defines constants used to specify a message delivery status.
+  class MessageStatus
+    NONE =  0
+    PENDING = 1
+    DELIVERED = 2
+    FAILED = 3
+  end
+end
+
+

data/lib/rumeme/sms_interface.rb

@@ -0,0 +1,319 @@
+require "net/http"
+require "net/https"
+require 'rubygems'
+require 'nokogiri'
+
+module Rumeme
+
+  # This is the main class used to interface with the M4U SMS messaging server.
+  class SmsInterface
+    # allow_splitting, allow_long_messages, response_code, response_message, username, password, use_message_id, secure, http_connection, server_list, message_list,
+    # http_proxy, http_proxy_port, http_proxy_auth, https_proxy, https_proxy_port, https_proxy_auth, text_buffer,
+
+    # Constructor.
+    #
+    # The allowSplitting parameter determines whether messages over
+    # 160 characters will be split over multiple SMSes or truncated.
+    #
+    # The allowLongMessages parameter enables messages longer than 160
+    # characters to be sent as special concatenated messages. For this
+    # to take effect, the allowSplitting parameter must be set to false.
+
+    def initialize
+      @username = Rumeme.configuration.username
+      @password = Rumeme.configuration.password
+      @use_message_id = Rumeme.configuration.use_message_id
+      @secure = Rumeme.configuration.secure
+      
+      @allow_splitting, @allow_long_messages = Rumeme.configuration.allow_splitting, Rumeme.configuration.allow_long_messages
+
+      @response_code = -1
+      @response_message = nil
+      @use_message_id = false
+      @message_list = []
+      @http_connection = nil
+      @http_proxy = nil
+      @http_proxy_port = 80
+      @http_proxy_auth = nil
+      @https_proxy = nil
+      @https_proxy_port = 443;
+      @https_proxy_auth = nil
+      @text_buffer = nil
+      @server_list = ["smsmaster.m4u.com.au", "smsmaster1.m4u.com.au", "smsmaster2.m4u.com.au"]
+    end
+
+
+    # Set the HTTP proxy server, if one is being used.
+    # Also specify an optional proxy username and password.
+    # only for php version
+    def set_http_proxy proxy, port = 80, username = nil, password = nil
+      @http_proxy, @http_proxy_port = proxy, port
+      @http_proxy_username, @http_proxy_password = username, password
+      @http_proxy_auth = Base64.encode64("#{username}:#{password}").chop unless username.nil? || password.nil?
+      raise 'proxy is not supported'
+    end
+
+    # Set the HTTPS proxy server, if one is being used.
+    # Also specify an optional proxy username and password.
+    # only for php version
+    def set_https_proxy proxy, port = 443, username = nil, password = nil
+      @https_proxy, @https_proxy_port = proxy, port
+      @https_proxy_auth = Base64.encode64("#{username}:#{password}").chop unless username.nil? || password.nil?
+      raise 'proxy is not supported'
+    end
+
+    # Return the response code received from calls to
+    # changePassword, getCreditsRemaining, sendMessages, and
+    # checkReplies.
+    attr_reader :response_code
+
+    # Return the message that was returned with the response code.
+    attr_reader :response_message
+
+    # Add a message to be sent.
+    def  add_message phone, message_text, message_id = 0, delay = 0, validity_period = 169, delivery_report = false
+      p 'in  add_message '
+      phone = strip_invalid(phone);
+      return if phone.empty?
+
+      if message_text.length <= 160
+        @message_list << SmsMessage.new(phone, message_text, message_id, delay, validity_period, delivery_report)
+        return
+      end
+
+      if (@allow_long_messages) # Use concatenation.
+        @message_list << SmsMessage.new(phone, message_text[0..1071], message_id, delay, validity_period, delivery_report) # 1071??? WTF ??? see php code
+        return
+      end
+
+      if !@allow_splitting
+        @message_list << SmsMessage.new(phone, message_text[0..160], message_id, delay, validity_period, delivery_report)
+        return
+      end
+
+      ml = []
+      maxlen = 152;
+      while message_text.length > maxlen
+        if (pos = message_text[0..maxlen].rindex(" ")) == 0
+          pos = maxlen - 1
+        end
+
+        ml << message_text[0..pos+1]
+        message_text = message_text[pos + 1 .. -1]
+        maxlen = 147;
+      end
+      ml << message_text
+
+      ml.each_index {|i|
+        ni = i + 1
+        if (i == 0)
+          m = ml[i]
+        else
+          m = "(#{ni}/#{ml.size})#{ml[i]}"
+        end
+
+        if (ni != ml.size )
+          m << "...(#{ni}/#{ml.size})"
+        end
+
+        @message_list << SmsMessage.new(phone, m, message_id, delay + 30*i, validity_period, delivery_report)
+      }
+    end
+
+    # Clear all the messages from the list.
+    def clear_messages
+      @message_list.clear
+    end
+
+    # Open a connection to the specified server.
+    # proxy is not supported
+    def open_server_connection server, secure
+      p "in open_server_connection: #{server} #{secure}"
+      if secure
+        @http_connection =  Net::HTTP.new(server, 443)
+        @http_connection.use_ssl = true
+
+      else
+        @http_connection =  Net::HTTP.new(server, 80)
+      end
+
+      p @http_connection.inspect
+
+      @http_connection.nil? ? false : true
+    end
+
+    # 4 php api compatibility, returns response code from latest http flush
+    def read_response_code
+      @latest_response_code
+    end
+
+    # Change the password on the local machine and server.
+    # not implemented
+    def change_password
+      raise 'Not Implemented'
+    end
+
+    # Return the list of replies we have received.
+    def check_replies auto_confirm = true
+      connect
+      p 'in check_replies'
+      return nil if @http_connection.nil?
+      @text_buffer << "CHECKREPLY2.0\r\n.\r\n"
+
+      if (!flush_buffer || read_response_code != 150)
+        close
+        return nil
+      end
+
+      p @response_message
+
+      messages = @response_message.split("\r\n")[1..-2].map{|message_line| SmsReply.parse(message_line, @use_message_id)}
+
+      close
+
+      if auto_confirm && messages.size > 0
+        confirm_replies_received
+      end
+
+      return messages
+    end
+
+    # sends confirmation to server
+    def confirm_replies_received
+      connect
+      p 'in confirm_replies_received'
+      return nil if @http_connection.nil?
+      ok = true
+
+      @text_buffer << "CONFIRM_RECEIVED\r\n.\r\n";
+      if !flush_buffer
+        ok = false
+      end
+
+      close
+      p "result: #{ok}"
+      
+      return ok;
+    end
+
+    # Returns the credits remaining (for prepaid users only).
+    def get_credits_remaining
+      connect
+      return -2 if @http_connection.nil?
+      @text_buffer << "MESSAGES\r\n.\r\n"
+
+      if (!flush_buffer)
+        close
+        return -2
+      end
+
+      if response_message =~ /^(\d+)\s+OK\s+(\d+).+/
+        if $1.to_i != 100
+          p 'M4U code is not 100'
+          return -1
+        end
+        return $2.to_i
+      else
+        p "cant parse response: #{response_message}"
+        return -1
+      end
+    end
+
+    # Sends all the messages that have been added with the
+    # add_message command.
+    def send_messages
+      connect
+      return false if @http_connection.nil?
+      @text_buffer << "MESSAGES2.0\r\n"
+
+      @message_list.each {|sm|
+        s = "#{sm.message_id} #{sm.phone_number} #{sm.delay} #{sm.validity_period} "
+        s << (sm.delivery_report ? "1 " : "0 ")
+        s << "#{sm.message}\r\n";
+        @text_buffer << s
+      }
+
+      ok = true
+      @text_buffer << ".\r\n";
+      if (!flush_buffer || (read_response_code / 100) != 1)
+        ok = false;
+      end
+
+      close
+      return ok
+    end
+
+    private
+
+    # Strip invalid characters from the phone number.
+    def strip_invalid phone
+      "+#{phone.gsub(/[^0-9]/, '')}"
+    end
+
+    # Connect to the M4U server
+    def connect
+      p 'in connect'
+      return unless @http_connection.nil?
+
+      @server_list.all? {|server| !open_server_connection(server, @secure)} #unusefull code open_server_connection, do not connetct to server, just creates http object, so we can't check availability of the server
+
+      return if @http_connection.nil?
+
+      @text_buffer = "m4u\r\nUSER=#{@username}"
+      if @use_message_id
+        @text_buffer << "#"
+      end
+      @text_buffer << "\r\nPASSWORD=#{@password}\r\nVER=PHP1.0\r\n";
+    end
+
+    # only 4 php compatibility, just free object reference
+    def close
+      return if @http_connection.nil?
+      #@http_connection.finish
+      @http_connection = nil
+    end
+
+    # Flush the text buffer to the HTTP connection.
+    def flush_buffer
+      p 'in flush_buffer'
+      p "buffer: #{@text_buffer}"
+      headers = {
+              'Content-Length' => @text_buffer.length.to_s
+      }
+
+      path = '/'
+
+      begin
+        resp, data = @http_connection.post(path, @text_buffer, headers)
+        p resp.inspect
+        p data.inspect
+      rescue
+        p "error: #{$!}"
+        return false
+      end
+
+
+      if resp.code.to_i != 200
+        p 'http response code != 200'
+        return false
+      end
+
+      @latest_response_code = @response_code = resp.code.to_i
+
+      doc = Nokogiri::HTML(data)
+
+      return false if doc.xpath('//title').text != "M4U SMSMASTER"
+
+      @response_message = @latest_response = doc.xpath('//body').text.strip
+      if @response_message =~ /^(\d+)\s+/
+        @latest_response_code = @response_code = $1.to_i
+      end
+
+      p "latest response code: #{ @latest_response_code}"
+      p "response #{@response_message.inspect}"
+
+      @text_buffer = ''
+      return true
+    end
+  end
+end

data/lib/rumeme/sms_message.rb

@@ -0,0 +1,12 @@
+module Rumeme
+  # This class represents an SMS message.
+  class SmsMessage
+    attr_reader :phone_number, :message, :message_id, :delay, :validity_period, :delivery_report
+
+    # Constructor.
+    def initialize phone_number, message, message_id, delay, validity_period, delivery_report
+      @phone_number, @message, @message_id, @delay, @validity_period, @delivery_report = phone_number, message, message_id, delay, validity_period, delivery_report
+      @message = message.gsub("\n",'\n').gsub("\r",'\r').gsub("\\",'\\\\')
+    end
+  end
+end

data/lib/rumeme/sms_reply.rb

@@ -0,0 +1,74 @@
+module Rumeme
+  # This class represents an SMS reply.
+  class SmsReply
+    #attr_accessor :phone_number, :message, :message_id, :when, :status
+    attr_reader :phone_number, :message, :message_id, :when, :status
+
+    #Constructor.
+    def initialize phone_number, message, message_id, _when, status
+      @phone_number, @message, @message_id, @when, @status = phone_number, message, message_id, _when, status
+    end
+
+    # Unescape any escaped characters in the string.
+    def self.unescape line
+      line.nil? ? nil : line.gsub('\n', "\n").gsub('\r', "\r").gsub('\\\\', "\\")
+    end
+
+    #Parse a reply from a string.
+    # Format is: messageID phone when message
+    # Or if no message ID: phone when message
+    # Or if delivery receipt: messageID messageStatus when
+    # php suxx. reimplement using regex
+    def self.parse line, use_message_id
+      p "parsing line: #{line}. #{use_message_id}."
+      message_id = 0;
+      status = MessageStatus::NONE
+
+      prev_idx = 0;
+      if (idx = line.index(' ')) == nil
+        return nil
+      end
+
+      if (use_message_id)
+        if line[0..idx] =~ /\d+/
+          message_id = line[0..idx].to_i
+        else
+          return nil
+        end
+
+        prev_idx = idx + 1
+        if (idx = line.index(' ', idx + 1)) == nil
+          return nil
+        end
+      end
+
+      phone = line[prev_idx .. idx - 1]
+
+      if phone.length == 1
+        status = case phone  # why not use to_i ??
+          when "1"
+            MessageStatus::PENDING
+          when "2"
+            MessageStatus::DELIVERED
+          when "3"
+            MessageStatus::FAILED
+          else
+            nil
+        end
+        phone = ""
+      end
+
+      prev_idx = idx + 1;
+      idx = line.index(' ', idx + 1) || line.length
+
+      if line[prev_idx .. idx-1] =~ /\d+/
+        when_ = $&.to_i
+      else
+        return nil
+      end
+
+      message = (status != MessageStatus::NONE) || (line.length < idx + 2) ? "" : unescape(line[idx + 1 .. -1])
+      return SmsReply.new(phone, message, message_id, when_, status)
+    end
+  end
+end

data/lib/rumeme/validity_period.rb

@@ -0,0 +1,14 @@
+module Rumeme
+  # This class defines constants used to specify the validity period
+  # of messages injected into the SMS network.
+  class ValidityPeriod
+      MINIMUM = 0
+      ONE_HOUR = 11
+      SIX_HOURS= 71
+      ONE_DAY = 167
+      TWO_DAYS = 168
+      THREE_DAYS = 169
+      ONE_WEEK = 173
+      MAXIMUM = 255
+  end
+end

data/lib/rumeme/version.rb

@@ -0,0 +1,3 @@
+module Rumeme
+  VERSION = "0.1.0".freeze
+end

data/lib/rumeme.rb

@@ -0,0 +1,17 @@
+require "rumeme/configuration"
+require "rumeme/message_status"
+require "rumeme/validity_period"
+require "rumeme/sms_message"
+require "rumeme/sms_reply"
+require "rumeme/sms_interface"
+
+module Rumeme
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: rumeme
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- antlypls
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-09 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: antlypls@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/rumeme.rb
+- lib/rumeme/sms_interface.rb
+- lib/rumeme/version.rb
+- lib/rumeme/configuration.rb
+- lib/rumeme/sms_message.rb
+- lib/rumeme/message_status.rb
+- lib/rumeme/sms_reply.rb
+- lib/rumeme/validity_period.rb
+has_rdoc: true
+homepage: http://github.com/programmable/rumeme
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby SDK for Message Media SMS Gateway API
+test_files: []
+