sendsms 0.0.2 → 0.0.6

data/lib/sendsms.rb

@@ -1,36 +1,69 @@
+#############################################################################
+#                                                                           #
+#    Copyright (C) 2012  Revath S Kumar                                     #
+#                                                                           #
+#    This program is free software: you can redistribute it and/or modify   #
+#    it under the terms of the GNU General Public License as published by   #
+#    the Free Software Foundation, either version 3 of the License, or      #
+#    (at your option) any later version.                                    #
+#                                                                           #
+#    This program is distributed in the hope that it will be useful,        #
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of         #
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
+#    GNU General Public License for more details.                           #
+#                                                                           #
+#    You should have received a copy of the GNU General Public License      #
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>   #
+#                                                                           #
+#############################################################################
+
 require "net/http"
 require "net/https"
 require "uri"
 require "hpricot"
 
+#
+# The class which handles sending sms with way2sms
+#
+# @author Revath S Kumar
+#
 class SendSms
   attr_accessor :username, :password
 
+  # The way2sms root url
   URL = 'http://site6.way2sms.com'
  
-  def initialize(username = "", password = "",autologin = true)
+  #
+  # Initiate Sendsms class with way2sms username and password
+  #
+  # @param [String] username way2sms username
+  # @param [String] password way2sms password
+  # @param [true,false] auto_logout
+  #   Set to logout after sending SMS. we don't need to call the logout explicitly
+  #   Recommended to turn it off when you are sending SMS repeatedly
+  #
+  #
+  def initialize(username , password ,auto_logout = true)
     @username = username
     @password = password
     @uri = URI.parse URL
     @cookie = @action = nil
     @referer = URL
+    @auto_logout = auto_logout
     @http = Net::HTTP.new(@uri.host,@uri.port)
   end
 
-  def set_header(cookie=nil,referer=nil)
-    {"Cookie" => cookie , "Referer" => referer ,"Content-Type" => "application/x-www-form-urlencoded",
-      "User-Agent" => "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.3) Gecko/20091020 Ubuntu/9.10 (karmic) Firefox/3.5.3 GTB7.0" }
-  end
-
-  def validate(msisdn = nil)
-    result = /^(\+|00)?(91)?(9|8|7)[0-9]{9}$/.match(msisdn)
-    return {:success => false,:message => "Invalid Msisdn"} if result.nil?
-    msisdn_formated = result[0][-10..-1]
-    return {:success => true,:message => "Valid Msisdn",:msisdn => msisdn_formated}
-  end
 
+  # Login to way2sms.com
+  #
+  # @visibility public
+  # @return [json]
+  #   A json response with status and message
+  #     { :success => true, :message => "Login Successful" }
+  #     { :success => false, :message => "Login Failed" }
+  #
   def login
-    data = 'username='+@username+'&password='+@password
+    data = "username=#{@username}&password=#{@password}"
     headers = set_header @cookie, @referer
     response = @http.post("/Login1.action",data,headers.delete_if {|i,j| j.nil? })
     case response.code
@@ -47,34 +80,81 @@ class SendSms
     end
   end
 
-  def getAction
-    headers = set_header @cookie, @referer
-    response = @http.get("/jsp/InstantSMS.jsp",headers.delete_if {|i,j| j.nil? })
-    hdoc = Hpricot(response.body)
-    return (hdoc/"#Action").attr('value')  
-  end
-
-  def send_sms msisdn,message
-    headers = set_header @cookie, @referer
-    data = "MobNo=#{msisdn}&textArea=#{message}&HiddenAction=instantsms&login=&pass=&Action=#{@action}"
-    return @http.post("/quicksms.action?custid=\"+custid+\"&sponserid=\"+sponserid+\"",data,headers.delete_if {|i,j| j.nil? })
-  end
-
-  def send msisdn,message
+  #
+  # To send Individual and Group SMS
+  # This method support Group SMS from version 0.0.5
+  #
+  # @param [Mixed] msisdns
+  #   The msisdn/msisdns to send the SMS
+  #     Individual
+  #       A single msisdn as String Eg: "9995436867"
+  #     Group
+  #       An array of msisdns
+  #         Eg: ["9995436867","9037107542","9037864203"]
+  #       An hash of msisdns
+  #         Eg: {0 => "9995436867",1 => "9037107542",2 => "9037864203"}
+  #       A semicolon(;) seperated string of msisdns
+  #         Eg: "9995436867;9037107542;9037864203"
+  # @param [String] message The message to send
+  #
+  # @visibility public
+  # @return [json]
+  #   A json response with status and message
+  #     Individual
+  #       {:success => true,:message => "Send successfull"}
+  #       {:success => false,:message => "Send failed"}
+  #     Group
+  #       {
+  #         "9995436867" => {:success => true,:message => "Send successfully"},
+  #         "9037864203" => {:success => true,:message => "Send successfully"},
+  #         "9037107542" => {:success => true,:message => "Send successfully"}
+  #       }
+  #
+  def send msisdns,message
     if @cookie.nil?
       login_res = login
       return {:success => false,:message => "Login failed"} if !login_res[:success]
     end
-
-    response = send_sms msisdn,message
-    case response.code
-      when  /2\d{2}/
-        return {:success => true,:message => "Send successfully"}
-      else
-        return {:success => false,:message => "Sending failed"}
+    if msisdns.kind_of?(String) && !msisdns.include?(";")
+      response = send_sms msisdns,message
+      logout if @auto_logout
+      return response
+    else
+      if msisdns.kind_of?(String) && msisdns.include?(";")
+        msisdns = msisdns.split(';')
+      end
+      response = {}
+      msisdns.each do | key, msisdn |
+        msisdn = key if msisdn.nil?
+        response[msisdn] = send_sms msisdn,message
+      end
+      logout if @auto_logout
+      return response
     end
   end
 
+  #
+  # To send Group SMS
+  #
+  # @deprecated Use {#send} instead of this method
+  # 
+  #
+  # @param [String] msisdns
+  #   A semicolon seperated string of msisdns
+  #   Eg: "9995436867;9037107542;9037864203"
+  # @param [String] message The message to send
+  #
+  # @visibility public
+  #
+  # @return [json]
+  #   A json response with status and message
+  #     {
+  #       "9995436867" => {:success => true,:message => "Send successfully"},
+  #       "9037864203" => {:success => true,:message => "Send successfully"},
+  #       "9037107542" => {:success => true,:message => "Send successfully"}
+  #     }
+  #
+  #
   def send_to_many msisdns, message
     if @cookie.nil?
       login_res = login
@@ -89,6 +169,17 @@ class SendSms
     return response
   end
 
+  #
+  # To logout the way2sms session
+  #
+  # @visibility public
+  #
+  # @return  [json]
+  #   A json with status and message
+  #     { :success => true,:message => "Logout successfully" }
+  #
+  #
+  #
   def logout
     response = @http.get("/jsp/logout.jsp");
     @cookie = nil
@@ -99,4 +190,85 @@ class SendSms
         return {:success => false,:message => "Logout failed"}
     end
   end
+
+  private
+
+  #
+  # Method to fetch the unique identifier in the send sms form
+  # @visibility private
+  # @return [String]
+  #   The unique identifier
+  #
+  def getAction
+    headers = set_header @cookie, @referer
+    response = @http.get("/jsp/InstantSMS.jsp",headers.delete_if {|i,j| j.nil? })
+    hdoc = Hpricot(response.body)
+    return (hdoc/"#Action").attr('value')
+  end
+
+  #
+  # To set the Headers for each request
+  #
+  # @param [Sting] cookie
+  #   The cookie which need to set
+  # @param [String] referer
+  #   The referer which need to set
+  #
+  # @visibility private
+  # @return [Json] A json header
+  #
+  def set_header(cookie=nil,referer=nil)
+    {"Cookie" => cookie , "Referer" => referer ,"Content-Type" => "application/x-www-form-urlencoded",
+      "User-Agent" => "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.3) Gecko/20091020 Ubuntu/9.10 (karmic) Firefox/3.5.3 GTB7.0" }
+  end
+
+  #
+  # To validate and format the msisdn passed by the user
+  # Format the msisdn into 10 digit.
+  # Accepted Formats
+  #
+  #   00919995436867
+  #   +919995436867
+  #   919995436867
+  #   9995436867
+  #
+  # @param [String] msisdn
+  #   The msisdn which need to validated
+  #
+  # @visibility private
+  # @return [Json]
+  #   A Json with status and message
+  #
+  def validate(msisdn = nil)
+    result = /^(\+|00)?(91)?(9|8|7)[0-9]{9}$/.match(msisdn)
+    return {:success => false,:message => "Invalid Msisdn"} if result.nil?
+    msisdn_formated = result[0][-10..-1]
+    return {:success => true,:message => "Valid Msisdn",:msisdn => msisdn_formated}
+  end
+
+  #
+  # The method which post the msisdn, message and unique identifier to way2sms
+  #
+  # @param [String] msisdn
+  #   A string of msisdn
+  # @param [String] message
+  #   A string of message
+  #
+  # @visibility private
+  #
+  # @return [HttpPost]
+  #   The Http post object
+  #
+  #
+  def send_sms msisdn,message
+    headers = set_header @cookie, @referer
+    data = "MobNo=#{msisdn}&textArea=#{message}&HiddenAction=instantsms&login=&pass=&Action=abfghst5654g"
+    response = @http.post("/quicksms.action?custid=\"+custid+\"&sponserid=\"+sponserid+\"",data,headers.delete_if {|i,j| j.nil? })
+    case response.code
+      when  /2\d{2}/
+        {:success => true,:message => "Send successfully"}
+      else
+        {:success => false,:message => "Sending failed"}
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendsms
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000 +05:30
-default_executable: 
+date: 2012-03-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &17388780 !ruby/object:Gem::Requirement
+  requirement: &83129430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17388780
+  version_requirements: *83129430
 description: The library Helps you to send SMS via way2sms in India
 email:
 - rsk@revathskumar.com
@@ -31,7 +30,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sendsms.rb
-has_rdoc: true
 homepage: http://blog.revathskumar.com
 licenses: []
 post_install_message: 
@@ -52,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Send SMS via way2sms