parity-gupshup 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51f08a2eac81546f3fc1ef012873629d484ee230
+  data.tar.gz: 395305135e166bdba411d4c22b12353034d3ab07
+SHA512:
+  metadata.gz: 5fa6f769c19fb8144b9464c539bbdf0664ce873e4e421215acb8a270debd85ce052dc41097132850fd20d68cfb433db99e31935f6dcdc28f74245465128c3d6c
+  data.tar.gz: 1bf81ef8bfada13b059e3dec69b5203fe6a34c58864ad6f876624465425316405201c9486b8e1147987104940ce3bdfa1c966d4b5ea68afe2def04ea27e6df06

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/parity
+
+
+
+

data/README.rdoc

@@ -0,0 +1,67 @@
+= gupshup
+
+* http://github.com/parity/gupshup
+
+== 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.pdf
+
+== FEATURES
+
+* V 0.2.0 Return boolean status instead of raising exceptions. API_URL is now configurable.
+* 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
+* V 0.0.1 send_message is implemented.
+
+== USAGE
+
+  # "target_phone_number" should be a 12 digit Indian mobile number starting with "91" (either integer or string)
+
+  gup = Gupshup::Enterprise.new(:userid => 'your_gupshup_login', :password => 'your_password')
+
+  #optional parameters
+    mask - An alphanumeric string with maximum length of 8 characters. Each enterprise account has a default mask. Each account can have multiple masks, preapproved by Enterprise Support team. If no mask is specified, the default mask is chosen.
+
+    override_dnd - Specifies if the message to be sent to a number listed in DND(Do Not Disturb) list. By default value is false
+
+    gup = Gupshup::Enterprise.new(:userid => 'your_gupshup_login', :password => 'your_password', :mask => 'maskname', :override_dnd => true)
+
+
+  #send a normal text message
+  gup.send_text_message(:msg => 'sms message text', :send_to => '91xxxxxxxxxx')
+
+  #flash messages appear on mobile's screen immediately but may not be saved on some handsets
+  gup.send_flash_message(:msg => 'sms message text', :send_to => '91xxxxxxxxxx')
+
+  #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(:msg => vcard, :send_to => '91xxxxxxxxxx')
+
+  #send a non-english message with a hex-encoded UTF-8 string
+  gup.send_unicode_message(:msg => "\xE0\xA4\x97\xE0\xA4\xAA\xE0\xA4\xB6\xE0\xA4\xAA", :send_to => '91xxxxxxxxxx') # will send "gupshup" in Devnagari script
+
+  #Upload a CSV file for bulk messages
+  gup.bulk_file_upload(file_path)
+
+== REQUIREMENTS
+
+* httpclient
+
+== Installation
+  * Include the gem in your Gemfile:
+
+  gem 'parity-gupshup', '~> 1.0.0'
+
+  * Or
+
+  sudo gem install parity-gupshup
+ 
+ 

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 'Beena Shetty', 'binu.shetty@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/parity-gupshup.rb

@@ -0,0 +1,109 @@
+$:.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'
+
+class NilClass
+  def blank?
+    true
+  end unless nil.respond_to? :blank?
+end
+
+class String
+  def blank?
+    self !~ /\S/
+  end unless "".respond_to? :blank?
+end
+
+module Gupshup
+  VERSION = '0.2.1'
+  class Enterprise
+    def initialize(opts)
+      @api_url = opts[:api_url] || 'http://enterprise.smsgupshup.com/GatewayAPI/rest'
+      @api_params = {}
+      @api_params[:userid] = opts[:userid]
+      @api_params[:password] = opts[:password]
+      @api_params[:mask] = opts[:mask] if opts[:mask]
+      @api_params[:override_dnd] = opts[:override_dnd] || false
+      @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] = opts[:token]
+        @api_params.delete(:password)
+      end
+      raise "Invalid credentials" if opts[:userid].blank? || (opts[:password].blank? && opts[:token].blank?)
+    end
+    
+    def call_api(opts = {})
+      res = Net::HTTP.post_form(
+        URI.parse(@api_url),
+        @api_params.merge(opts)
+      )
+      resp = res.body
+      puts "GupShup Response: #{resp}"
+
+      case res
+      when Net::HTTPSuccess
+        if resp.nil? || resp.include?("success") == false
+          puts "API call '#{opts[:method]}' failed: #{resp}"
+          return false, resp
+        end
+        return true, nil
+      else
+        return false, "HTTP Error : #{res}"
+      end
+    end
+
+    def send_message(opts)
+      msg = opts[:msg]
+      number = opts[:send_to]
+      msg_type = opts[:msg_type] || 'TEXT'
+      
+      return false, 'Phone Number is too short' if number.to_s.length < 12
+      return false, 'Phone Number is too long' if number.to_s.length > 12
+      #return false, 'Phone Number should start with "91"' if number.to_s.start_with? "91"
+      return false, 'Phone Number should be numerical value' unless number.to_i.to_s == number.to_s
+      return false, 'Message cannot be empty' if msg.to_s.length == 0
+      return false, '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(opts)
+      send_message(opts.merge({ :msg_type => 'TEXT'}))
+    end
+
+    def send_vcard(opts)
+      send_message(opts.merge({ :msg_type => 'VCARD'}))
+    end
+
+    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 = {})
+      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
+    end
+    
+    def group_post(opts)
+      return false,"Invalid group name" if opts[:group_name].blank?
+      return false,"Invalid message" if opts[:msg].blank?
+      return false,"Invalid message type" if opts[:msg_type].blank?
+      call_api opts.merge({:method => 'post_group'})
+    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,37 @@
+$:.unshift File.dirname(__FILE__)
+require 'test_helper'
+class TestGupshup < Test::Unit::TestCase
+
+  def setup
+  	@gup = Gupshup::Enterprise.new(:userid => '19009888', :password => 'test')
+  end
+  
+  def test_truth
+    assert_equal([true, nil], @gup.send_text_message(msg: "Testing", send_to: "919453456689"))
+  end
+
+  def test_failure
+    assert_not_equal([true, nil], @gup.send_text_message(msg: "Testing", send_to: "4567777888"))
+  end
+
+  def test_creditional
+  	assert_raise( RuntimeError ){Gupshup::Enterprise.new(userid: "")}
+  end
+
+  def test_short_phone_number
+  	assert_equal([false, "Phone Number is too short"], @gup.send_text_message(msg: "Testing", send_to: "9194567890"))
+  end
+
+  def test_long_phone_number
+  	assert_equal([false, "Phone Number is too long"], @gup.send_text_message(msg: "Testing", send_to: "91945678901123"))
+  end
+  
+  def test_string
+  	assert_equal([false, "Phone Number should be numerical value"], @gup.send_text_message(msg: "Testing", send_to: "hellotest123"))
+  end
+
+  def test_empty_msg
+  	assert_equal([false, "Message cannot be empty"], @gup.send_text_message(msg: "", send_to: "919453456689"))
+  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,76 @@
+--- !ruby/object:Gem::Specification
+name: parity-gupshup
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Beena Shetty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5.2
+description: Ruby wrapper for SMSGupShup API
+email:
+- binu.shetty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files:
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/parity-gupshup.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_gupshup.rb
+- test/test_helper.rb
+homepage: http://github.com/parity/gupshup
+licenses: []
+metadata: {}
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: parity-gupshup
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for SMSGupShup API
+test_files:
+- test/test_gupshup.rb
+- test/test_helper.rb
+has_rdoc: