ruby-bulksms 0.4 → 0.4.1

data/{README → README.rdoc}

@@ -1,57 +1,73 @@
-== Introduction
-
-Net::SMS::BulkSMS is a Ruby library that allows you to easily integrate SMS services into your Ruby or RubyOnRails applications.
-
-It has support for all BulkSMS international sites, including the UK, USA, South Africa, Spain and Europe.
-
-To use the library, you will need an account from www.bulksms.com and some credits.
-
-== Examples
-
-Creating a new service and sending a message is simple.
-
-  s = Service.new('myusername', 'mypassword')
-  s.send_message('Hello, I hope you like my message!', '44799123456')
-  
-== Additional message options
-
-The Service class also has a <tt>send</tt> instance method that accepts a Message object. This allows you to construct your own Message objects and set additional parameters.
-
-  s = Service.new('myusername', 'mypassword')
-  m = Message.new('Hello, look at my funky message', '44799123456')
-  m.routing_group = 1
-  m.want_report = 1
-  s.send(m)
-
-Both <tt>send</tt> and <tt>send_message</tt> return a Response object.
-
-== Checking your account balance
-
-If you already have an existing Service object, you can easily check your account balance.
-
-  s = Service.new('myusername', 'mypassword')
-  s.account.credits
-
-Alternatively, you can create an Account object directly.
-
-  a = Account.new('myusername', 'mypassword')
-  a.credits
-
-For a further example, see the simple command line client provided.
-
-== Limitations
-
-This library currently only implements a small portion of the API, allowing you to send messages and check your account balance. Further parts of the BulkSMS API may be implemented in the future such as the ability to receive messages and status reports and manage the address book provided by BulkSMS.
-
-== A note about testing
-
-I tried to cover the library with unit tests where possible however I'm not very experienced with unit testing network services and all tests require a valid account to run. If anybody could share some advice here it would be much appreciated.
-
-==Authors:
-
-The Original work is made by Luke Redpath (email:contact@lukeredpath.co.uk)
-Modifications have been added by Basayel Said (email:eng.basayel.said@gmail.com)
-Modifications include:
-1.fixing a bug related to getting the host of bulksms service.
-2.adding gem spec file to the library.
-3.packaging the library as a gem.
+= Introduction
+
+Net::SMS::BulkSMS is a Ruby library that allows you to easily integrate SMS services into your Ruby or RubyOnRails applications.
+
+It has support for all BulkSMS international sites, including the UK, USA, South Africa, Spain and Europe.
+
+To use the library, you will need an account from www.bulksms.com and some credits.
+
+= Examples
+
+Creating a new service and sending a message is simple.
+
+  s = Service.new('myusername', 'mypassword')
+  s.send('Hello, I hope you like my message!', '44799123456')
+  
+= Additional message options
+
+The Service class also has a <tt>send</tt> instance method that accepts a Message object. This allows you to construct your own Message objects and set additional parameters.
+
+  s = Service.new('myusername', 'mypassword')
+  m = Message.new('Hello, look at my funky message', '44799123456')
+  m.routing_group = 1
+  m.want_report = 1
+  s.send_message(m)
+
+Both <tt>send</tt> and <tt>send_message</tt> return a Response object.
+
+=  Checking your account balance
+
+If you already have an existing Service object, you can easily check your account balance.
+
+  s = Service.new('myusername', 'mypassword')
+  s.account.credits
+
+Alternatively, you can create an Account object directly.
+
+  a = Account.new('myusername', 'mypassword')
+  a.credits
+  
+= Sending multiple messages with a single http connection
+  
+Also you can use a single http connection & send multiple messages using <tt>send_multiple</tt> method that accepts an array of Message object and return an array of Response object
+  s = Service.new('myusername', 'mypassword')
+  messages = []
+  responses = []
+  m1 = Message.new('Hello1, look at my funky message', '44799123456')
+  m2 = Message.new('Hello2, look at my funky message', '44799123666')
+  messages << m1
+  messages << m2
+  responses = s.send_multiple(messages)
+ 
+For a further example, see the simple command line client provided.
+
+= Limitations
+
+This library currently only implements a small portion of the API, allowing you to send messages and check your account balance. Further parts of the BulkSMS API may be implemented in the future such as the ability to receive messages and status reports and manage the address book provided by BulkSMS.
+
+= A note about testing
+
+I tried to cover the library with unit tests where possible however I'm not very experienced with unit testing network services and all tests require a valid account to run. If anybody could share some advice here it would be much appreciated.
+
+= Authors
+
+The Original work is made by Luke Redpath (email:contact@lukeredpath.co.uk)
+
+Modifications have been added by Basayel Said (email:eng.basayel.said@gmail.com)
+
+Modifications include:
+
+* fixing a bug related to getting the host of bulksms service.
+* Adding method named (send_multiple) in order to use a single http connection in sending multiple message objects.
+* adding gem spec file to the library.
+* packaging the library as a gem.

data/lib/net/sms/bulksms.rb

@@ -1,91 +1,91 @@
-# Author::		Luke Redpath (mailto:contact@lukeredpath.co.uk)
-# License::		MIT
-
-require File.dirname(__FILE__) + '/bulksms/account'
-require File.dirname(__FILE__) + '/bulksms/message'
-require File.dirname(__FILE__) + '/bulksms/response'
-
-module Net
-	module SMS
-
-		# The main BulkSMS module contains some constants
-		# for the different countries that are supported
-		# and a helper method to return the correct URL
-		# for the chosen country
-		#
-		# The countries/areas supported are:
-		#  * UK
-		#  * USA
-		#  * Spain
-		#  * South Africa
-		#  * International/Europe
-		
-		module BulkSMS
-
-			UK = 'uk'
-			USA = 'usa'
-			SPAIN = 'spain'
-			SAFRICA = 'safrica'
-			INTER = 'international'
-					
-			class Service
-				# The port the message service rus on
-				MESSAGE_SERVICE_PORT = 80 #5567
-
-				# Path to the message service gateway
-				MESSAGE_SERVICE_PATH = '/eapi/submission/send_sms/2/2.0'
-
-				# returns an Account object for the credentials supplied to the service
-				attr_reader :account
-
-				def initialize(username, password, country = 'uk')
-					@account = Account.new(username, password, country)
-          @country=country
-				end
-
-				# Sends the given Message object to the gateway for delivery
-				def send_message(msg)
-					payload = [@account.to_http_query, msg.to_http_query].join('&')
-					Net::HTTP.start(host(@country), MESSAGE_SERVICE_PORT) do |http|
-						resp = http.post(MESSAGE_SERVICE_PATH, payload)
-						Response.parse(resp.body)
-					end
-				end
-        #Openning single connection & sending an array of message objects
-        def send_multiple(messages)
-          responses=[]
-          Net::HTTP.start(host(@country), MESSAGE_SERVICE_PORT) do |http|
-            messages.each do |msg|
-              payload = [@account.to_http_query, msg.to_http_query].join('&')
-              resp = http.post(MESSAGE_SERVICE_PATH, payload)
-              responses << Response.parse(resp.body)
-            end
-          end
-          responses
-        end
-				# Creates a new Message object from the message text and recipient
-				# given and sends to the gateway using send_message()
-				def send(message, recipient)
-					msg = Message.new(message, recipient)
-					self.send_message(msg)
-				end
-      end
-      
-			# Returns the gateway URL for the chosen country
-			def host(country)
-				case country
-					when 'uk'
-						'www.bulksms.co.uk'
-					when 'usa'
-						'usa.bulksms.com'
-					when 'international'
-						'bulksms.vsms.net'
-					when 'safrica'
-						'bulksms.2way.co.za'
-					when 'spain'
-						'bulksms.com.es'
-				end
-			end
-		end
-	end
-end
+# Author::		Luke Redpath (mailto:contact@lukeredpath.co.uk)
+# License::		MIT
+
+require File.dirname(__FILE__) + '/bulksms/account'
+require File.dirname(__FILE__) + '/bulksms/message'
+require File.dirname(__FILE__) + '/bulksms/response'
+
+module Net
+	module SMS
+
+		# The main BulkSMS module contains some constants
+		# for the different countries that are supported
+		# and a helper method to return the correct URL
+		# for the chosen country
+		#
+		# The countries/areas supported are:
+		#  * UK
+		#  * USA
+		#  * Spain
+		#  * South Africa
+		#  * International/Europe
+		
+		module BulkSMS
+
+			UK = 'uk'
+			USA = 'usa'
+			SPAIN = 'spain'
+			SAFRICA = 'safrica'
+			INTER = 'international'
+					
+			class Service
+				# The port the message service rus on
+				MESSAGE_SERVICE_PORT = 80 #5567
+
+				# Path to the message service gateway
+				MESSAGE_SERVICE_PATH = '/eapi/submission/send_sms/2/2.0'
+
+				# returns an Account object for the credentials supplied to the service
+				attr_reader :account
+
+				def initialize(username, password, country = INTER)
+					@account = Account.new(username, password, country)
+          @country=country
+				end
+
+				# Sends the given Message object to the gateway for delivery
+				def send_message(msg)
+					payload = [@account.to_http_query, msg.to_http_query].join('&')
+					Net::HTTP.start(host(@country), MESSAGE_SERVICE_PORT) do |http|
+						resp = http.post(MESSAGE_SERVICE_PATH, payload)
+						Response.parse(resp.body)
+					end
+				end
+        #Openning single connection & sending an array of message objects
+        def send_multiple(messages)
+          responses=[]
+          Net::HTTP.start(host(@country), MESSAGE_SERVICE_PORT) do |http|
+            messages.each do |msg|
+              payload = [@account.to_http_query, msg.to_http_query].join('&')
+              resp = http.post(MESSAGE_SERVICE_PATH, payload)
+              responses << Response.parse(resp.body)
+            end
+          end
+          responses
+        end
+				# Creates a new Message object from the message text and recipient
+				# given and sends to the gateway using send_message()
+				def send(message, recipient)
+					msg = Message.new(message, recipient)
+					self.send_message(msg)
+				end
+      end
+      
+			# Returns the gateway URL for the chosen country
+			def host(country)
+				case country
+					when 'uk'
+						'www.bulksms.co.uk'
+					when 'usa'
+						'usa.bulksms.com'
+					when 'international'
+						'bulksms.vsms.net'
+					when 'safrica'
+						'bulksms.2way.co.za'
+					when 'spain'
+						'bulksms.com.es'
+				end
+			end
+		end
+	end
+end

data/lib/net/sms/bulksms/account.rb

@@ -1,46 +1,46 @@
-require 'net/http'
-require 'uri'
-
-module Net
-	module SMS
-		module BulkSMS
-
-			# Wraps up the functionality for a user account on the system
-			class Account
-
-				# The port the account service runs on
-				SERVICE_PORT = 7512
-
-				# Path to the account service gateway
-				SERVICE_PATH = '/eapi/1.0/get_credits.mc'
-				
-				def initialize(username, password, country = 'uk')
-					@username, @password = username, password
-					@country = country
-				end
-
-				# Returns the number of credits left on a users account as a
-				# float to 2 decimal places. Will raise an AccountError
-				# if the credentials are wrong
-				def credits
-					Net::HTTP.start(host(@country), SERVICE_PORT) do |http|
-						response = http.post SERVICE_PATH, self.to_http_query
-						if response.body.include?('|')
-							rsp = Response.parse(response.body)
-							raise AccountError, rsp.description, caller
-						end
-						response.body.to_f
-					end
-				end
-
-				# Returns the account credentials in the form of a http
-				# query string for use by other gateway services
-				def to_http_query
-					URI.encode("username=#{@username}&password=#{@password}")
-				end
-			end
-
-			class AccountError < Exception; 	end
-		end
-	end
-end
+require 'net/http'
+require 'uri'
+
+module Net
+	module SMS
+		module BulkSMS
+
+			# Wraps up the functionality for a user account on the system
+			class Account
+
+				# The port the account service runs on
+				SERVICE_PORT = 7512
+
+				# Path to the account service gateway
+				SERVICE_PATH = '/eapi/1.0/get_credits.mc'
+				
+				def initialize(username, password, country = 'uk')
+					@username, @password = username, password
+					@country = country
+				end
+
+				# Returns the number of credits left on a users account as a
+				# float to 2 decimal places. Will raise an AccountError
+				# if the credentials are wrong
+				def credits
+					Net::HTTP.start(host(@country), SERVICE_PORT) do |http|
+						response = http.post SERVICE_PATH, self.to_http_query
+						if response.body.include?('|')
+							rsp = Response.parse(response.body)
+							raise AccountError, rsp.description, caller
+						end
+						response.body.to_f
+					end
+				end
+
+				# Returns the account credentials in the form of a http
+				# query string for use by other gateway services
+				def to_http_query
+					URI.encode("username=#{@username}&password=#{@password}")
+				end
+			end
+
+			class AccountError < Exception; 	end
+		end
+	end
+end

data/lib/net/sms/bulksms/message.rb

@@ -1,54 +1,54 @@
-module Net
-	module SMS
-		module BulkSMS
-
-			# Encapsulates a message to be sent by the gateway
-			class Message
-				FLASH_SMS = 0
-				NORMAL_SMS = 2
-
-				# The various attributes for a message as defined
-				# by the BulkSMS HTTP API. For full details on the
-				# different attributes see:
-				#  http://www.bulksms.co.uk/docs/eapi/submission/send_sms/
-				attr_accessor :message, :recipient, :msg_class,
-											:want_report, :routing_group, :source_id,
-											:test_always_succeed, :test_always_fail,
-											:concat_text_sms, :concat_max_parts
-				
-				def initialize(message, recipient)
-					@message = message
-					@recipient = recipient
-					@msg_class = NORMAL_SMS
-					@want_report = 0
-					@routing_group = 2
-					@source_id = ''
-					@test_always_succeed = 0
-					@test_always_fail = 0
-					@concat_text_sms = 0
-					@concat_max_parts = 2
-				end
-
-				# Returns a message as a http query string for use
-				# by other gateway services
-				def to_http_query
-					params = {
-						'message' => @message,
-						'msisdn' => @recipient,
-						'msg_class' => @msg_class,
-						'want_report' => @want_report,
-						'routing_group' => @routing_group,
-						'source_id' => @source_id,
-						'test_always_succeed' => @test_always_succeed,
-						'test_always_fail' => @test_always_fail,
-						'allow_concat_text_sms' => @concat_text_sms,
-						'concat_text_sms_max_parts' => @concat_max_parts
-					}
-					query_string = params.collect { |x, y| "#{x}=#{y}" }.join('&')
-					URI.encode(query_string)
-				end
-			end
-			
-		end
-	end
-end
+module Net
+	module SMS
+		module BulkSMS
+
+			# Encapsulates a message to be sent by the gateway
+			class Message
+				FLASH_SMS = 0
+				NORMAL_SMS = 2
+
+				# The various attributes for a message as defined
+				# by the BulkSMS HTTP API. For full details on the
+				# different attributes see:
+				#  http://www.bulksms.co.uk/docs/eapi/submission/send_sms/
+				attr_accessor :message, :recipient, :msg_class,
+											:want_report, :routing_group, :source_id,
+											:test_always_succeed, :test_always_fail,
+											:concat_text_sms, :concat_max_parts
+				
+				def initialize(message, recipient)
+					@message = message
+					@recipient = recipient
+					@msg_class = NORMAL_SMS
+					@want_report = 0
+					@routing_group = 2
+					@source_id = ''
+					@test_always_succeed = 0
+					@test_always_fail = 0
+					@concat_text_sms = 0
+					@concat_max_parts = 2
+				end
+
+				# Returns a message as a http query string for use
+				# by other gateway services
+				def to_http_query
+					params = {
+						'message' => @message,
+						'msisdn' => @recipient,
+						'msg_class' => @msg_class,
+						'want_report' => @want_report,
+						'routing_group' => @routing_group,
+						'source_id' => @source_id,
+						'test_always_succeed' => @test_always_succeed,
+						'test_always_fail' => @test_always_fail,
+						'allow_concat_text_sms' => @concat_text_sms,
+						'concat_text_sms_max_parts' => @concat_max_parts
+					}
+					query_string = params.collect { |x, y| "#{x}=#{y}" }.join('&')
+					URI.encode(query_string)
+				end
+			end
+			
+		end
+	end
+end

data/lib/net/sms/bulksms/response.rb

@@ -1,28 +1,28 @@
-module Net
-	module SMS
-		module BulkSMS
-
-			# A response sent by the BulkSMS gateway
-			class Response
-				attr_reader :code, :description, :batch_id
-				
-				def initialize(code, description, batch_id)
-					@code = code
-					@description = description
-					@batch_id = batch_id
-				end
-
-				def self.parse(response_text)
-					tokens = response_text.split('|')
-					self.new tokens[0].to_i, tokens[1], tokens[2].to_i
-				end
-
-				# Was the original request successful?
-				def successful?
-					(@code == 0) ? true : false
-				end
-			end
-			
-		end
-	end
-end
+module Net
+	module SMS
+		module BulkSMS
+
+			# A response sent by the BulkSMS gateway
+			class Response
+				attr_reader :code, :description, :batch_id
+				
+				def initialize(code, description, batch_id)
+					@code = code
+					@description = description
+					@batch_id = batch_id
+				end
+
+				def self.parse(response_text)
+					tokens = response_text.split('|')
+					self.new tokens[0].to_i, tokens[1], tokens[2].to_i
+				end
+
+				# Was the original request successful?
+				def successful?
+					(@code == 0) ? true : false
+				end
+			end
+			
+		end
+	end
+end

data/lib/ruby-bulksms.rb

@@ -1,4 +1,4 @@
-$:.unshift File.expand_path(File.dirname(__FILE__))
-
-require 'net/sms/bulksms.rb'
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'net/sms/bulksms.rb'
 include Net::SMS::BulkSMS

data/ruby-bulksms.gemspec

@@ -1,20 +1,20 @@
-Gem::Specification.new do |s|
-  s.name     = "ruby-bulksms"
-  s.version  = "0.4"
-  s.date     = "2010-03-31"
-  s.summary  = "Sending SMS using bulksms services"
-  s.email    = "eng.basayel.said@gmail.com"
-  s.homepage = "http://github.com/basayel/ruby-bulksms"
-  s.description = "Integrating SMS services into RubyOnRails applications using BulkSMS gateway"
-  s.has_rdoc = true
-  s.authors  = ["Basayel Said"]
-  s.files    = [ 
-                "ruby-bulksms.gemspec", 
-                "README",
-                "lib/ruby-bulksms.rb",
-                "lib/net/sms/bulksms/account.rb",
-                "lib/net/sms/bulksms/message.rb",
-                "lib/net/sms/bulksms/response.rb",
-                "lib/net/sms/bulksms.rb"
-  ]
+Gem::Specification.new do |s|
+  s.name     = "ruby-bulksms"
+  s.version  = "0.4.1"
+  s.date     = "2015-06-15"
+  s.summary  = "Sending SMS using bulksms services"
+  s.email    = "eng.basayel.said@gmail.com"
+  s.homepage = "http://github.com/basayel/ruby-bulksms"
+  s.description = "Integrating SMS services into RubyOnRails applications using BulkSMS gateway"
+  s.has_rdoc = true
+  s.authors  = ["Basayel Said"]
+  s.files    = [ 
+                "ruby-bulksms.gemspec", 
+                "README.rdoc",
+                "lib/ruby-bulksms.rb",
+                "lib/net/sms/bulksms/account.rb",
+                "lib/net/sms/bulksms/message.rb",
+                "lib/net/sms/bulksms/response.rb",
+                "lib/net/sms/bulksms.rb"
+  ]
 end

metadata

@@ -1,67 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-bulksms
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  version: "0.4"
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Basayel Said
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-03-31 00:00:00 +02:00
-default_executable: 
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies: []
-
-description: Integrating SMS services into RubyOnRails applications using BulkSMS gateway
+description: Integrating SMS services into RubyOnRails applications using BulkSMS
+  gateway
 email: eng.basayel.said@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - ruby-bulksms.gemspec
-- README
+- README.rdoc
 - lib/ruby-bulksms.rb
 - lib/net/sms/bulksms/account.rb
 - lib/net/sms/bulksms/message.rb
 - lib/net/sms/bulksms/response.rb
 - lib/net/sms/bulksms.rb
-has_rdoc: true
 homepage: http://github.com/basayel/ruby-bulksms
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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.3.6
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Sending SMS using bulksms services
 test_files: []
-
+has_rdoc: true