gupshup 0.1.3

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-08-17
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/gupshup.rb
+script/console
+script/destroy
+script/generate
+test/test_gupshup.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,6 @@
+For more information on SMS GupShup product, see http://enterprise.smsgupshup.com
+For more information on gupshup gem, see http://github.com/nileshtrivedi
+
+
+
+

data/README.rdoc

@@ -0,0 +1,75 @@
+= gupshup
+
+* http://github.com/nileshtrivedi/smsgupshup
+
+== DESCRIPTION:
+
+gupshup is a Ruby wrapper for the HTTP APIs provided by SMS GupShup which
+is a Group SMS Platform for the enterprises with advanced features such as
+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
+
+== FEATURES:
+
+* 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
+* V 0.0.1 send_message is implemented.
+
+== USAGE:
+
+  # "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')
+
+  #send a normal text message
+  gup.send_text_message('sms message text',target_phone_number)
+
+  #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)
+
+  #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)
+
+  #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
+
+  #Upload a CSV file for bulk messages
+  gup.bulk_file_upload(file_path)
+
+== REQUIREMENTS:
+
+* httpclient
+
+== INSTALL:
+
+ sudo gem install gupshup
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Nilesh Trivedi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/gupshup'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'gupshup' do
+  self.developer 'Nilesh Trivedi', 'nilesh.tr@gmail.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/gupshup.rb

@@ -0,0 +1,83 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'httpclient'
+
+module Gupshup
+  VERSION = '0.1.2'
+  class Enterprise
+    def initialize(login,password)
+      @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'
+    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) }
+      res = Net::HTTP.post_form(
+        URI.parse(@api_url),
+        msg_params.merge(@api_params).merge(opts)
+      )
+      resp = res.body
+      puts "GupShup Response: #{resp}"
+
+      case res
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        if resp.nil? || resp.include?("success") == false
+          raise "SMS Sending failed: #{resp}"
+        end
+        return true
+      else
+        raise 'GupShup returned HTTP Error'
+      end
+    end
+
+    def send_flash_message(msg,number,opts = {})
+      send_message(msg,number,:FLASH,opts)
+    end
+
+    def send_text_message(msg,number,opts = {})
+      send_message(msg,number,:TEXT,opts)
+    end
+
+    def send_vcard(card,number,opts = {})
+      send_message(card,number,:VCARD,opts)
+    end
+
+    def send_unicode_message(msg,number,opts = {})
+      send_message(msg,number,:UNICODE_TEXT,opts)
+    end
+
+    def bulk_file_upload(file_path,file_type = 'csv',mime_type = 'text/csv', opts = {})
+      msg_params = {}
+      msg_params[:method] = 'xlsUpload'
+      msg_params[:filetype] = file_type.to_s
+      file = File.new(file_path,"r")
+      def file.mime_type; "text/csv"; end
+      msg_params[:xlsFile] = file
+      resp = HTTPClient.post(@api_url,msg_params.merge(@api_params).merge(opts))
+      file.close
+      puts resp.body.content
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/gupshup.rb'}"
+puts "Loading gupshup gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_gupshup.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGupshup < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/gupshup'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: gupshup
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Nilesh Trivedi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-05 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.5.2
+    version: 
+description: Ruby wrapper for SMSGupShup API
+email: 
+- nilesh.tr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/gupshup.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_gupshup.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/nileshtrivedi/gupshup
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gupshup
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for SMSGupShup API
+test_files: 
+- test/test_gupshup.rb
+- test/test_helper.rb