sgsms 0.1.0

data/README.rdoc

@@ -0,0 +1,44 @@
+= Sgsms
+
+== Description
+
+sgsms - A tool to send sms via SMSGlobal's HTTP API.
+
+== Installation
+
+    gem install sgsms
+
+== Usage
+
+    require 'sgsms'
+    texter = Sgsms::Texter.new
+    texter.send_sms("Hello", 1234567, {:user => 'smsglobalusername', :password=>'smsglobalpassword'})
+
+Alternatively you can supply the options hash to the constructor of the texter object:
+    texter = Sgsms::Texter.new({:user => 'smsglobalusername', :password=>'smsglobalpassword'})
+    texter.send_sms("Hello", 1234567)
+
+Finally, you can change who it appears to be from by supplying a :from in the options hash.
+    Sgsms::Texter.new({:user => 'smsglobalusername', :password=>'smsglobalpassword', :from => 'youknowwho'})
+
+== License
+
+Copyright (c) <2011> <Leonard Garvey>
+
+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 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,65 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require File.join(File.dirname(__FILE__), %w(lib sgsms version))
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'sgsms'
+  s.version          = Sgsms::Version.to_s
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "This gem does ... "
+  s.author           = 'First Last'
+  s.email            = 'user@example.com'
+  s.homepage         = 'http://my-site.net'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables    = ['sgsms']
+
+  # s.add_dependency('gem_name', '~> 0.0.1')
+
+  s.add_development_dependency('rake', '~> 0.8.0')
+  s.add_development_dependency('bundler', '~> 1.0.0')
+  s.add_development_dependency('jnunemaker-matchy', '~> 0.4.0')
+  s.add_development_dependency('shoulda', '~> 2.11.0')
+  s.add_development_dependency('mocha', '~> 0.9.0')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+
+  exclude_paths  = %w(/Library/Ruby /usr/lib/ruby)
+  exclude_paths += Array(Gem.path)
+
+  options = ['--text-report'] + exclude_paths.map {|p| "-x '#{p}'" }
+
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs       = ['test']
+    t.test_files = FileList["test/**/*_test.rb"]
+    t.verbose    = true
+    t.rcov_opts  = options
+  end
+
+  task :default => :coverage
+
+rescue LoadError
+  warn "\n**** Install rcov (gem install rcov) to get coverage stats ****\n"
+  task :default => :test
+end
+
+desc 'Generate the gemspec for this Gem'
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/sgsms/version.rb

@@ -0,0 +1,13 @@
+module Sgsms
+  module Version
+
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+
+  end
+end

data/lib/sgsms.rb

@@ -0,0 +1,53 @@
+$:.unshift File.dirname(__FILE__)
+
+# require 'sgsms/...'
+require 'net/http'
+
+module Sgsms
+  class Texter
+    
+
+    def initialize(opts={})
+      @options = opts
+      @options[:from] = "sgsms" unless @options[:from]
+    end
+   
+    attr_accessor :options 
+    
+    def send_sms(message, to, opts={})
+      sms_params = {
+        :user => opts[:user] || @options[:user], 
+        :password => opts[:password] || @options[:password],
+        :from => opts[:from] || @options[:from],
+        :action => 'sendsms',
+        :text => message,
+        :to => to
+      }
+      
+      raise :user_missing unless sms_params[:user]
+      raise :password_missing unless sms_params[:password]
+      raise :from_missing unless sms_params[:from]
+
+      url = URI.join("http://smsglobal.com.au", 'http-api.php')
+      url.query = sms_params.map {|k,v| "#{k.to_s}=#{v.to_s}"}.join('&')
+      response = Net::HTTP.get_response(url)
+
+      #puts response
+      #return {:status => :ok, :id => 1 }
+      case response
+      when Net::HTTPSuccess
+        if response.body.match(/^OK: 0; .+ ID: ([\dabcdef]+).*^SMSGlobalMsgID:(\d+)/m)
+          return {:status => :ok, :id => $1.to_s, :msgid => $2.to_i}
+        elsif response.body.match(/^ERROR: (.*): (.*)$/)
+          return {:status => :fail, :error => $1, :detail => $2}
+        else
+          raise "Cannot parse body: #{response.body}"
+        end
+      else
+        raise "Net error: #{response.inspect}"
+      end
+              
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+require File.dirname(__FILE__) + '/../lib/sgsms'
+
+FakeWeb.allow_net_connect = false
+
+def stub_send(response)
+  FakeWeb.register_uri(:any, /.*smsglobal.*/, :body => response)
+end
+
+def stub_send_ok
+  stub_send("OK: 0; Sent queued message ID: 34a637908349a796\nSMSGlobalMsgID:6191845908398754")
+end
+
+def stub_send_failure(error="Missing parameter",param="from")
+  stub_send("ERROR: #{error}: #{param}")
+end

data/test/unit/sgsms_test.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w(.. test_helper)))
+
+class SgsmsTest < Test::Unit::TestCase
+  include Sgsms
+  context "An instance of the Sgsms class" do
+
+    should "should load" do
+      smser = Texter.new
+      assert_equal smser.class, Texter
+    end
+    
+    should "initialise parameters" do
+      opts = {:user => 'test',
+        :password => 'password',
+        :from => 'sgsms-test'}
+      smser = Texter.new(opts)
+      assert smser.respond_to?(:options)
+      assert_equal smser.options, opts
+    end
+    should "default to values" do
+      opts = {:user => 'test',
+        :password => 'password'} 
+      smser = Texter.new(opts)
+      assert smser.respond_to?(:options)
+      assert_equal smser.options[:from], "sgsms"
+    end
+  end
+  
+  context "Sending an sms" do
+    setup do
+      @opts = {:user => 'test',
+        :password => 'password'} 
+      @smser = Texter.new(@opts)
+    end
+    should "send an sms using instance" do
+      stub_send_ok
+      response = @smser.send_sms("Hello", 1234)  
+      assert_equal response, {:status=>:ok, 
+        :id=>"34a637908349a796",
+        :msgid=>6191845908398754}
+    end
+
+    should "not send an sms" do
+      stub_send_failure
+      response = @smser.send_sms("Hello", 1234)  
+      assert_equal response, {:status => :fail, :error => "Missing parameter", :detail => "from"}
+      stub_send_failure "Missing parameter", "to"
+      response = @smser.send_sms("Hello", 1234)  
+      assert_equal response, {:status => :fail, :error => "Missing parameter", :detail => "to"}
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: sgsms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Leonard Garvey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156805280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156805280
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2156804780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156804780
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2156804300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156804300
+description: 
+email: lengarvey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- Rakefile
+- lib/sgsms/version.rb
+- lib/sgsms.rb
+- test/test_helper.rb
+- test/unit/sgsms_test.rb
+homepage: https://github.com/lengarvey/sgsms
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+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.7.2
+signing_key: 
+specification_version: 3
+summary: This gem sends sms via SMSGlobal's http api
+test_files: []