sms_xchange 0.1.0

data/Manifest

@@ -0,0 +1,10 @@
+config.yml
+init.rb
+lib/sms_xchange.rb
+Manifest
+Rakefile
+README.rdoc
+sms_xchange.gemspec
+test/mocks/sms_xchange_mock.rb
+test/test_helper.rb
+test/unit/sms_xchange_test.rb

data/README.rdoc

@@ -0,0 +1,52 @@
+= SmsXchange
+
+Send SMS messages via the SMS Xchange service.
+
+
+== SMS Xchange Gateway
+
+See http://www.smsxchange.com/
+
+  
+== Features
+
+* So easy to use, even a baby (with an SMS Xchange account) could SMS his
+  baby pals.
+* Tested under Ruby 1.8.7 and Ruby 1.9
+
+== Example
+
+  require 'sms_xchange'
+  client = SmsExchange.new(:username => 'username', :password => 'password')
+  client.send("6599998888", "Hi, this is a test message")
+
+
+== References
+
+* http://www.smsxchange.com/main/sms_delivery.asp
+
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Global IT Creations Pte Ltd http://www.globalitcreations.com
+
+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,77 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'echoe'
+require 'yaml'
+
+APP_NAME = "sms_xchange"
+APP_URL = "http://github.com/scottbarr/sms_xchange"
+APP_DESCRIPTION = "Ruby client for the smsxchange.com service."
+AUTHOR_NAME = "Scott Barr"
+AUTHOR_EMAIL = "scottb@globalitcreations.com"
+
+#
+# Create a version for this build from the config.yml and the BUILD_NUMBER
+# environment variable.
+#
+def get_version
+  # read the config file
+  config = open("config.yml") {|f| YAML.load(f)}
+  
+  # build the version number
+  version_major = config["version"]["major"]
+  version_minor = config["version"]["minor"]  
+  version_build = ENV["BUILD_NUMBER"] || "0"
+  "#{version_major}.#{version_minor}.#{version_build}"
+end
+
+Rake::TestTask.new("test:units") { |t|
+  t.pattern = 'test/unit/*_test.rb'
+  t.verbose = true
+  t.warning = false
+}
+
+Rake::TestTask.new("test:integration") { |t|
+  t.pattern = 'test/integration/*_test.rb'
+  t.verbose = true
+  t.warning = false
+}
+
+# setup the gem
+Echoe.new(APP_NAME, get_version) do |p|
+  p.description    = APP_DESCRIPTION
+  p.url            = APP_URL
+  p.author         = AUTHOR_NAME
+  p.email          = AUTHOR_EMAIL
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+task :publish => [:test, :clean, :manifest, :repackage, :upload]
+
+task :upload do
+  version = get_version
+  
+  retval = system "rsync -av pkg/#{APP_NAME}-#{version}.gem git.globalitcreations.com:/var/www/gems.globalitcreations.com/gems/"
+  Exception.new("rsync of gem failed") unless retval
+  
+  retval = system "ssh git.globalitcreations.com 'cd /var/www/gems.globalitcreations.com/ ; gem generate_index'"
+  Exception.new("regenerating gem index failed") unless retval
+end
+
+# define a remove task method so the "test" task isn't breaking my stuff
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+# helper method to remove a task
+def remove_task(task_name)
+  Rake.application.remove_task(task_name)
+end
+
+# remove the original test task
+remove_task :test
+
+task :test => ["test:units", "test:integration"]

data/config.yml

@@ -0,0 +1,4 @@
+--- 
+version: 
+  major: 0
+  minor: 1

data/init.rb

@@ -0,0 +1,2 @@
+require 'sms_xchange'
+

data/lib/sms_xchange.rb

@@ -0,0 +1,70 @@
+require 'net/http'
+require 'net/https'
+require 'cgi'
+
+class SmsXchange
+  
+  OK = "01"
+  
+  ERRORS = {
+    "02" => "No Such User",
+    "03" => "Password is wrong",
+    "04" => "Domain Name of server is wrong",
+    "05" => "Message not sent. Undocumented error.",
+    "06" => "Phone Number is empty.",
+    "07" => "SMS parameter missing. No message to send.",
+    "09" => "Insufficient SMS Credits."
+  }
+  
+  SERVER = "https://www.smsxchange.com"
+  URL = "/scripts/sendsms.asp"
+  PARAMS = "userid=%s&password=%s&phone=%s&sms=%s"
+  
+  attr_reader :username, :password, :server
+  
+  def initialize(opts)
+    @server = opts[:server] || SERVER
+    @username = opts[:username]
+    @password = opts[:password]
+  end
+  
+  #
+  # Get the data to send to the service
+  #
+  def get_data(phone, message, test = false)
+    sprintf(PARAMS, @username, @password, CGI.escape(phone), CGI.escape(message))
+  end
+  
+  #
+  #
+  # Get the url for the service
+  def get_url
+    URI.parse("#{@server}#{URL}")
+  end
+  
+  def get_error_message(code)
+    sprintf "Gateway application response code %s - %s", code, ERRORS[code] || "Unknown error code"
+  end
+  
+  #
+  # Send an sms message
+  #
+  def send(phone, message)
+    url = get_url
+    url.query = get_data(phone, message, test)
+    
+    https = Net::HTTP.new(url.host, url.port)
+    https.use_ssl = (url.scheme == 'https')
+    
+    res = https.get(url.request_uri)
+    
+    if res.code.to_i != 200
+      raise Exception.new("Server responded with HTTP " + res.code)
+    end
+    
+    if res.body != OK
+      raise Exception.new(get_error_message(res.body))
+    end
+  end
+  
+end

data/sms_xchange.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sms_xchange}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Barr"]
+  s.date = %q{2009-12-07}
+  s.description = %q{Ruby client for the smsxchange.com service.}
+  s.email = %q{scottb@globalitcreations.com}
+  s.extra_rdoc_files = ["lib/sms_xchange.rb", "README.rdoc"]
+  s.files = ["config.yml", "init.rb", "lib/sms_xchange.rb", "Manifest", "Rakefile", "README.rdoc", "sms_xchange.gemspec", "test/mocks/sms_xchange_mock.rb", "test/test_helper.rb", "test/unit/sms_xchange_test.rb"]
+  s.homepage = %q{http://github.com/scottbarr/sms_xchange}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sms_xchange", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{sms_xchange}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby client for the smsxchange.com service.}
+  s.test_files = ["test/test_helper.rb", "test/unit/sms_xchange_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/mocks/sms_xchange_mock.rb

@@ -0,0 +1,16 @@
+#
+# A mock of the SmsXchange class
+#
+
+# require the real class
+require 'lib/sms_xchange'
+
+# reopen and override the class
+class SmsXchange
+  
+  def send(phone, message)
+    # raise an Exception = "Message not sent. Undocumented error."
+    raise Exception.new(get_error_message("05"))
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'lib/sms_xchange'

data/test/unit/sms_xchange_test.rb

@@ -0,0 +1,47 @@
+require 'test/test_helper'
+
+# unit test will be working against the mock
+require 'test/mocks/sms_xchange_mock'
+
+class SmsXchangeTest < Test::Unit::TestCase
+
+  def setup
+    @client = SmsXchange.new(:username => "scott", :password => "pass1")
+    @phone = "6597528429"
+    @message = "Test message"
+  end
+  
+  def test_default_server
+    assert_equal SmsXchange::SERVER, @client.server
+  end
+  
+  def test_get_url
+    url = @client.get_url()
+    
+    assert_equal "https", url.scheme
+    assert_equal "www.smsxchange.com", url.host
+    assert_equal "/scripts/sendsms.asp", url.path
+  end
+  
+  def test_get_data
+    expected = "userid=scott&password=pass1&phone=6597528429&sms=Test+message"
+    assert_equal expected, @client.get_data(@phone, @message)
+  end
+  
+  def test_authentication_details
+    assert_equal "scott", @client.username
+    assert_equal "pass1", @client.password
+  end
+  
+  def test_send
+    assert_raise Exception do
+      @client.send("6597529999", "This is a test message")
+    end
+  end
+  
+  def test_get_error_message
+    expected = "Gateway application response code 02 - No Such User"
+    assert_equal expected, @client.get_error_message("02")
+  end
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: sms_xchange
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Barr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Ruby client for the smsxchange.com service.
+email: scottb@globalitcreations.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/sms_xchange.rb
+- README.rdoc
+files: 
+- config.yml
+- init.rb
+- lib/sms_xchange.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- sms_xchange.gemspec
+- test/mocks/sms_xchange_mock.rb
+- test/test_helper.rb
+- test/unit/sms_xchange_test.rb
+has_rdoc: true
+homepage: http://github.com/scottbarr/sms_xchange
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sms_xchange
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: sms_xchange
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby client for the smsxchange.com service.
+test_files: 
+- test/test_helper.rb
+- test/unit/sms_xchange_test.rb