smslane 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smslane.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Robinson
+
+MIT License
+
+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/README.md

@@ -0,0 +1,67 @@
+# Smslane
+
+A simple wrapper gem for the smslane.com HTTP API for sending Bulk SMS in India.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smslane'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smslane
+
+## Usage
+
+Create an instance of `Smslane::Client` and pass your smslane.com `username` and `password` as arguments like below:
+
+    client = Smslane::Client.new('username','password')
+    
+Now using this client you can check your credit balance, send SMS and check delivery reports.
+
+### Checking Credit Balance
+
+To check your balance credits simple call the `check_balance` method on the client:
+
+    client.check_balance
+    # => {:result => 'Success', :response => '2000'}
+    # or
+    # => {:result => 'Failure', :response => 'Invalid Login'}
+    # or
+    # => {:result => 'Failure', :response => 'Unauthorized Access'}
+    # etc
+
+### Sending SMS
+
+SMS is sent using the client through the `send_sms` method. This method requires three arguments: 
+  * An array of recipient numbers
+  * The message to be sent
+  * A boolean indicating whether or not to send the SMS as a flash message
+ 
+Numbers must be of the format `919841254836`.Prefixing with `91` is crucial. But there are mechanisms in the gem that will take care of some malformed numbers.
+Recipient numbers are split into groups of 90 numbers and are sent seprately to comply with smslane.com's limits. Malformed numbers will cause the entire group in which they are to fail. So it is crucial that numbers are of the specified format.
+
+The response of this call is an array of hashes. Each hash contains the recipient number and the `message_id` returned by smslane.com. This `message_id` is used to check delivery reports.
+
+    client.send_sms ['919234567888','919999999999'], 'Testing :)', false
+    #=> [{:number => '919234567888', :message_id => '677a468d46f342e66e69ddbe5a963d7d'},
+         {:number => '919999999999', :message_id => '4c52312229df5fbc82cd07ea29ca4d91'}]
+
+If a number is not present in this response list it indicates that the number is invalid. 
+
+### Delivery Report
+
+To Do.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+ 
+# Rake::TestTask.new do |t|
+#   t.test_files = FileList['spec/lib/smslane/*_spec.rb']
+#   t.verbose = true
+# end
+ 
+# task :default => :test

data/lib/smslane.rb

@@ -0,0 +1,6 @@
+require "httparty"
+require "smslane/version"
+require 'smslane/client'
+
+module Smslane
+end

data/lib/smslane/client.rb

@@ -0,0 +1,72 @@
+
+
+module Smslane
+
+  class Client
+    include HTTParty
+    #include WebMock::API
+
+    base_uri  'http://smslane.com'
+
+    #Webmock stubs for testing
+    
+    # stub_request(:get, "http://smslane.com/vendorsms/CheckBalance.aspx?password=karimbenzema&user=steverob").to_return(:body => "Success#20000", :status => 200, :headers => { 'Content-Length' => 13 })
+    # stub_request(:get, /http:\/\/smslane\.com\/vendorsms\/pushsms\.aspx?/).to_return(:body => lambda { |request| 
+    #   nums = CGI::parse(request.uri.query)['msisdn'][0].split(',')
+    #   response = ''
+    #   nums.each do |num|
+    #     if !(/^(\+91|91)[789][0-9]{9}$/.match(num).nil?)
+    #       response += 'The Message Id : ' + num + '-' + SecureRandom.hex + '<br />'
+    #     else
+    #       response = 'Failed#Invalid Mobile Numbers'
+    #       break
+    #     end
+    #   end
+    #   response 
+    # })
+    
+
+    def initialize(username,password)
+      @auth = {user: username, password: password}
+    end
+
+    def check_balance
+      options = {:query => @auth}
+      response =  self.class.get '/vendorsms/CheckBalance.aspx?',options
+      responses = response.split('#')
+      {:result=>responses[0],:response=>responses[1]}
+    end
+
+    def send options
+      self.class.get '/vendorsms/pushsms.aspx?',options  
+    end
+
+    def send_sms recipients, message, flash
+      flash = flash ? 1 : 0
+      responses = []
+      recipients = recipients.each_slice(90).to_a
+      recipients.each do |recipient_list|
+        recipient_list.each_with_index do |number,i|
+          recipient_list[i] = '91'+number[-10..-1]
+          if /^(\+91|91)[789][0-9]{9}$/.match(recipient_list[i]).nil?
+            recipient_list.delete_at(i)
+          end
+        end
+        options = {:query => @auth.merge({:msisdn=>recipient_list.join(','), :sid=>'WebSMS', :fl => flash, :msg => message})}
+        responses << send(options).parsed_response
+      end
+      
+      responses.delete('Failed#Invalid Mobile Numbers')
+      responses = responses.join().split('<br />')
+      result = []
+      responses.each do |response|
+        res = response[-45..-1].split('-')
+        result << {:number => res[0], :message_id=>res[1]}
+      end
+      result
+    end
+
+  end
+
+
+end

data/lib/smslane/version.rb

@@ -0,0 +1,3 @@
+module Smslane
+  VERSION = "0.0.3"
+end

data/smslane.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smslane/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smslane"
+  spec.version       = Smslane::VERSION
+  spec.authors       = ["Steve Robinson"]
+  spec.email         = ["steve.rob@me.com"]
+  spec.description   = %q{Wrapper gem for the Smslane.com HTTP API}
+  spec.summary       = %q{A simple to use gem that enables developers to integrate Smslane.com's HTTP API with their applications and access the Bulk SMS service. Balance Check, Multiple recipient and delivery report features are all supported.}
+  spec.homepage      = "https://github.com/steverob/smslane"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/temp.rb

@@ -0,0 +1,70 @@
+require "httparty"
+require 'webmock'
+require 'cgi'
+require 'securerandom'
+
+#
+
+class Client
+    include HTTParty
+    include WebMock::API
+    debug_output $stderr
+    base_uri  'http://smslane.com'
+
+    stub_request(:get, "http://smslane.com/vendorsms/CheckBalance.aspx?password=karimbenzema&user=steverob").to_return(:body => "Success#20000", :status => 200, :headers => { 'Content-Length' => 13 })
+    stub_request(:get, /http:\/\/smslane\.com\/vendorsms\/pushsms\.aspx?/).to_return(:body => lambda { |request| 
+      nums = CGI::parse(request.uri.query)['msisdn'][0].split(',')
+      response = ''
+      nums.each do |num|
+        if !(/^(\+91|91)[789][0-9]{9}$/.match(num).nil?)
+          response += 'The Message Id : ' + num + '-' + SecureRandom.hex + '<br />'
+        else
+          response = 'Failed#Invalid Mobile Numbers'
+          break
+        end
+      end
+      response 
+    })
+    
+
+    def initialize(username,password)
+      @auth = {user: username, password: password}
+    end
+
+    def check_balance
+      options = {:query => @auth}
+      response =  self.class.get '/vendorsms/CheckBalance.aspx?',options
+      responses = response.split('#')
+      {:result=>responses[0],:response=>responses[1]}
+    end
+
+    def send options
+      self.class.get '/vendorsms/pushsms.aspx?',options  
+    end
+
+    def send_sms recipients, message, flash
+      flash = flash ? 1 : 0
+      responses = []
+      recipients = recipients.each_slice(5).to_a
+      recipients.each do |recipient_list|
+        recipient_list.each_with_index do |number,i|
+          recipient_list[i] = '91'+number[-10..-1]
+          if /^(\+91|91)[789][0-9]{9}$/.match(recipient_list[i]).nil?
+            recipient_list.delete_at(i)
+          end
+        end
+        options = {:query => @auth.merge({:msisdn=>recipient_list.join(','), :sid=>'WebSMS', :fl => flash, :msg => message})}
+        responses << send(options).parsed_response
+      end
+      
+      responses.delete('Failed#Invalid Mobile Numbers')
+      responses = responses.join().split('<br />')
+      result = []
+      responses.each do |response|
+        res = response[-45..-1].split('-')
+        result << {:number => res[0], :message_id=>res[1]}
+      end
+      result
+    end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: smslane
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Steve Robinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &12007440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12007440
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &12006920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12006920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12006400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12006400
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &12005660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *12005660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12004920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12004920
+description: Wrapper gem for the Smslane.com HTTP API
+email:
+- steve.rob@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smslane.rb
+- lib/smslane/client.rb
+- lib/smslane/version.rb
+- smslane.gemspec
+- temp.rb
+homepage: https://github.com/steverob/smslane
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A simple to use gem that enables developers to integrate Smslane.com's HTTP
+  API with their applications and access the Bulk SMS service. Balance Check, Multiple
+  recipient and delivery report features are all supported.
+test_files: []