smsglobal 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alex Cooper
+
+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.rdoc

@@ -0,0 +1,26 @@
+= smsglobal
+
+Ruby gem to send and receive SMS messages via SMSGlobal.
+
+To use:
+
+  require 'smsglobal'
+  sender = SmsGlobal::Sender.new :user => 'CHANGEME', :password => 'CHANGEME'
+
+  sender.send_text 'Test text message', '040xxxxxxx', '040yyyyyyy'
+
+Enjoy!
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Alex Cooper. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "smsglobal"
+    gem.summary = %Q{Ruby interface for SMSGlobal}
+    gem.description = %Q{Ruby gem to send and receive SMS messages via SMSGlobal.}
+    gem.email = "alex@kuperov.com"
+    gem.homepage = "http://github.com/kuperov/smsglobal"
+    gem.authors = ["Alex Cooper"]
+    gem.add_development_dependency "rspec", ">= 2.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "smsglobal #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/smsglobal.rb

@@ -0,0 +1,72 @@
+require 'net/http'
+require 'uri'
+
+module SmsGlobal
+  class Sender
+    include Net
+
+    def initialize(options = {})
+      @options = options
+      raise 'missing :user' unless @options[:user]
+      raise 'missing :password' unless @options[:password]
+      @base = @options[:base] || 'http://www.smsglobal.com/'
+    end
+
+    def send_text(text, to, sender = nil, send_at = nil)
+      from = sender || @options[:from] || raise_error('sender is required')
+      params = {
+        :action => 'sendsms',
+        :user => @options[:user],
+        :password => @options[:password],
+        :from => from,
+        :to => to,
+        :text => text
+      }
+      if send_at
+        params[:scheduledatetime] = send_at.strftime('%Y-%m-%d %h:%M:%S')
+      end
+      params[:maxsplit] = @options[:maxsplit] if @options[:maxsplit]
+
+      resp = get(params)
+
+      case resp
+      when Net::HTTPSuccess
+        if resp.body =~ /^OK: (\d+); ([^\n]+)\s+SMSGlobalMsgID:\s*(\d+)\s*$/
+          return {
+            :status  => :ok,
+            :code    => $1.to_i,
+            :message => $2,
+            :id      => $3.to_i
+          }
+        elsif resp.body =~ /^ERROR: (.+)$/
+          return {
+            :status  => :error,
+            :message => $1
+          }
+        else
+          raise "Unable to parse response: '#{resp.body}'"
+        end
+      else
+        return {
+          :status  => :failed,
+          :code    => resp.code,
+          :message => 'Unable to reach SMSGlobal'
+        }
+      end
+    end
+
+    private
+    
+    def get(params = nil)
+      url = URI.join(@base, 'http-api.php')
+      if params
+        url.query = params.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v)] }.join("&")
+      end
+      res = HTTP.start(url.host, url.port) do |http|
+        http.get(url.request_uri)
+      end
+    end
+  end
+
+end
+

data/spec/smsglobal_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'SmsGlobal' do
+  include SmsGlobal
+
+  describe 'Sender' do
+    before do
+      @sender = Sender.new :user => 'DUMMY', :password => 'DUMMY'
+    end
+
+    it "requires :user and :password" do
+      lambda { Sender.new }.should raise_error
+    end
+
+    it "sends SMS correctly" do
+      stub_sms_ok
+      resp = @sender.send_text('Lorem Ipsum', '12341324', '1234')
+      resp[:status].should == :ok
+      resp[:code].should == 0
+      resp[:message].should == 'Sent queued message ID: 941596d028699601'
+    end
+
+    it "gracefully fails" do
+      stub_sms_failed
+      resp = @sender.send_text('Lorem Ipsum', '12341324', '1234')
+      resp[:status].should == :error
+      resp[:message].should == 'Missing parameter: from'
+    end
+
+    it "hits the right URL" do
+      stub_request(:get, 'http://www.smsglobal.com/http-api.php?action=sendsms&from=5678&password=DUMMY&text=xyz&to=1234&user=DUMMY').to_return(:body => 'ERROR: Missing parameter: from')
+      @sender.send_text('xyz', '1234', '5678')
+    end
+
+    it "gracefully fails on connection error" do
+      stub_request(:get, /www.smsglobal.com.*/).to_return(:status => [500, "Internal Server Error"])
+      resp = @sender.send_text('xyz', '1234', '5678')
+      resp[:status].should == :failed
+      resp[:message].should == "Unable to reach SMSGlobal"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'smsglobal'
+require 'rspec'
+require 'webmock/rspec'
+
+include SmsGlobal
+
+RSpec.configure do |config|
+  config.include WebMock
+end
+
+def stub_sms(response_body)
+  stub_request(:get, /http:\/\/www.smsglobal.com\/http-api.php.*/).to_return(:body => response_body)
+end
+
+def stub_sms_ok
+  stub_sms("OK: 0; Sent queued message ID: 941596d028699601\nSMSGlobalMsgID:6764842339385521")
+end
+
+def stub_sms_failed
+  stub_sms("ERROR: Missing parameter: from")
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: smsglobal
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Cooper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-19 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+description: Ruby gem to send and receive SMS messages via SMSGlobal.
+email: alex@kuperov.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/smsglobal.rb
+- spec/smsglobal_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kuperov/smsglobal
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby interface for SMSGlobal
+test_files: 
+- spec/smsglobal_spec.rb
+- spec/spec_helper.rb