gupshup 0.1.4 → 0.1.5

data/README.rdoc

@@ -1,6 +1,6 @@
 = gupshup
 
-* http://github.com/nileshtrivedi/smsgupshup
+* http://github.com/nileshtrivedi/gupshup
 
 == DESCRIPTION:
 
@@ -10,10 +10,12 @@ masks, keywords, text/flash/vcard/bulk messages, advertising and keyword
 campaigns and so on.
 
 Documentation of HTTP APIs is available here:
-http://enterprise.smsgupshup.com/doc/GatewayAPIDoc.doc
+http://enterprise.smsgupshup.com/doc/GatewayAPIDoc.pdf
 
 == FEATURES:
 
+* V 0.1.5 Added group_post method and a generic call_api method. All methods
+    now expect a hash of API params instead if individual arguments
 * V 0.1.2 Bulk file upload implemented. Only CSV format supported for now.
 * V 0.1.0 send_vcard and send_unicode_message implemented. Error checking.
 * V 0.0.5 send_text_message and send_flash_message are implemented
@@ -23,20 +25,20 @@ http://enterprise.smsgupshup.com/doc/GatewayAPIDoc.doc
 
   # "target_phone_number" should be a 12 digit Indian mobile number starting with "919" (either integer or string)
 
-  gup = Gupshup::Enterprise.new('your_gupshup_login','password')
+  gup = Gupshup::Enterprise.new(:userid => 'your_gupshup_login', :password => 'your_password')
 
   #send a normal text message
-  gup.send_text_message('sms message text',target_phone_number)
+  gup.send_text_message(:msg => 'sms message text', :send_to => '919xxxxxxxxx')
 
   #flash messages appear on mobile's screen immediately but may not be saved on some handsets
-  gup.send_flash_message('sms message text',target_phone_number)
+  gup.send_flash_message(:msg => 'sms message text', :send_to => '919xxxxxxxxx')
 
   #send a contact in VCARD format
   vcard = "BEGIN:VCARD\r\nVERSION:1.2\r\nN:ICICI\r\nTEL:18002098888\r\nEND:VCARD"
-  gup.send_vcard(vcard,target_phone_number)
+  gup.send_vcard(:msg => vcard, :send_to => '919xxxxxxxxx')
 
   #send a non-english message with a hex-encoded UTF-8 string
-  gup.send_unicode_message("\xE0\xA4\x97\xE0\xA4\xAA\xE0\xA4\xB6\xE0\xA4\xAA",target_phone_number) # will send "gupshup" in Devnagari script
+  gup.send_unicode_message(:msg => "\xE0\xA4\x97\xE0\xA4\xAA\xE0\xA4\xB6\xE0\xA4\xAA", :send_to => '919xxxxxxxxx') # will send "gupshup" in Devnagari script
 
   #Upload a CSV file for bulk messages
   gup.bulk_file_upload(file_path)
@@ -53,7 +55,7 @@ http://enterprise.smsgupshup.com/doc/GatewayAPIDoc.doc
 
 (The MIT License)
 
-Copyright (c) 2009 Nilesh Trivedi
+Copyright (c) 2010 Nilesh Trivedi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/gupshup.rb

@@ -6,42 +6,40 @@ require 'uri'
 require 'cgi'
 require 'httpclient'
 
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class String
+  def blank?
+    self.empty?
+  end
+end
+
 module Gupshup
-  VERSION = '0.1.2'
+  VERSION = '0.1.5'
   class Enterprise
-    def initialize(login,password, token = nil)
+    def initialize(opts)
       @api_url = 'http://enterprise.smsgupshup.com/GatewayAPI/rest'
       @api_params = {}
-      @api_params[:userid] = login
-      @api_params[:password] = password
-      @api_params[:v] = '1.1'
-      @api_params[:auth_scheme] = 'PLAIN'
-      if token
+      @api_params[:userid] = opts[:userid]
+      @api_params[:password] = opts[:password]
+      @api_params[:v] = opts[:v] || '1.1'
+      @api_params[:auth_scheme] = opts[:auth_scheme] || 'PLAIN'
+      unless opts[:token].blank?
         @api_params[:auth_scheme] = 'TOKEN'
-        @api_params[:token] = token
+        @api_params[:token] = opts[:token]
         @api_params.delete(:password)
       end
+      raise "Invalid credentials" if opts[:userid].blank? || (opts[:password].blank? && opts[:token].blank?)
     end
-
-    def send_message(msg,number,msg_type = 'TEXT',opts = {})
-      raise 'Phone Number is too short' if number.to_s.length < 12
-      raise 'Phone Number is too long' if number.to_s.length > 12
-      #raise 'Phone Number should start with "91"' if number.to_s.start_with? "91"
-      raise 'Phone Number should be numerical value' unless number.to_i.to_s == number.to_s
-      raise 'Message should be less than 725 characters long' if msg.to_s.length > 724
-      msg_params = {}
-      msg_params[:method] = 'sendMessage'
-      msg_params[:msg_type] = msg_type.to_s
-      msg_params[:msg] = msg.to_s
-      msg_params[:send_to] = number.to_s
-      #url = URI.parse(@api_url)
-      #req = Net::HTTP::Post.new(url.path)
-      #puts "--- #{msg_params.merge(@api_params).inspect}"
-      #req.set_form_data(msg_params.merge(@api_params))
-      #res = Net::HTTP.new(url.host, url.port).start {|http|http.request(req) }
+    
+    def call_api(opts = {})
       res = Net::HTTP.post_form(
         URI.parse(@api_url),
-        msg_params.merge(@api_params).merge(opts)
+        @api_params.merge(opts)
       )
       resp = res.body
       puts "GupShup Response: #{resp}"
@@ -49,7 +47,7 @@ module Gupshup
       case res
       when Net::HTTPSuccess, Net::HTTPRedirection
         if resp.nil? || resp.include?("success") == false
-          raise "SMS Sending failed: #{resp}"
+          raise "API call '#{opts[:method]}' failed: #{resp}"
         end
         return true
       else
@@ -57,20 +55,33 @@ module Gupshup
       end
     end
 
-    def send_flash_message(msg,number,opts = {})
-      send_message(msg,number,:FLASH,opts)
+    def send_message(opts)
+      msg = opts[:msg]
+      number = opts[:send_to]
+      msg_type = opts[:msg_type] || 'TEXT'
+      
+      raise 'Phone Number is too short' if number.to_s.length < 12
+      raise 'Phone Number is too long' if number.to_s.length > 12
+      #raise 'Phone Number should start with "91"' if number.to_s.start_with? "91"
+      raise 'Phone Number should be numerical value' unless number.to_i.to_s == number.to_s
+      raise 'Message should be less than 725 characters long' if msg.to_s.length > 724
+      call_api opts.merge({ :method => 'sendMessage' })
+    end
+
+    def send_flash_message(opts)
+      send_message(opts.merge({ :msg_type => 'FLASH'}))
     end
 
-    def send_text_message(msg,number,opts = {})
-      send_message(msg,number,:TEXT,opts)
+    def send_text_message(opts)
+      send_message(opts.merge({ :msg_type => 'TEXT'}))
     end
 
-    def send_vcard(card,number,opts = {})
-      send_message(card,number,:VCARD,opts)
+    def send_vcard(opts)
+      send_message(opts.merge({ :msg_type => 'VCARD'}))
     end
 
-    def send_unicode_message(msg,number,opts = {})
-      send_message(msg,number,:UNICODE_TEXT,opts)
+    def send_unicode_message(opts)
+      send_message(opts.merge({ :msg_type => 'UNICODE_TEXT'}))
     end
 
     def bulk_file_upload(file_path,file_type = 'csv',mime_type = 'text/csv', opts = {})
@@ -84,5 +95,12 @@ module Gupshup
       file.close
       puts resp.body.content
     end
+    
+    def group_post(opts)
+      raise "Invalid group name" if opts[:group_name].blank?
+      raise "Invalid message" if opts[:msg].blank?
+      raise "Invalid message type" if opts[:msg_type].blank?
+      call_api opts.merge({:method => 'post_group'})
+    end
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: gupshup
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Nilesh Trivedi
@@ -9,19 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 +05:30
+date: 2010-03-25 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httpclient
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 5
+        - 2
         version: 2.1.5.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: Ruby wrapper for SMSGupShup API
 email: 
 - nilesh@webaroo.com
@@ -59,18 +69,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: gupshup
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for SMSGupShup API