reddavis-clickatell 0.0.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 reddavis
+
+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 @@
+= Clickatell
+
+This is a wrapper for http://www.clickatell.com 
+
+== Install
+
+  gem sources -a -http://gemcutter.org
+  sudo gem install reddavis-clickatell
+  
+== How To Use
+
+Sending Texts
+
+  require 'rubygems'
+  require 'clickatell'
+  
+  a = Clickatell::Text.new('username', 'password', 'api_id')
+  a.send(number, 'this is the message')
+  
+== TODO
+
+* Receive texts
+
+== Copyright
+
+Copyright (c) 2009 Red Davis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "reddavis-clickatell"
+    gem.summary = %Q{Wrapper for clickatell.com}
+    gem.description = %Q{Wrapper for clickatell.com}
+    gem.email = "reddavis@gmail.com"
+    gem.homepage = "http://github.com/reddavis/clickatell"
+    gem.authors = ["reddavis"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency('typhoeus')
+    # 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: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "clickatell #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/clickatell/exceptions.rb

@@ -0,0 +1,42 @@
+module Clickatell
+  
+  class AuthenticationFailed < Exception
+  end
+  
+  class UnknownUsernameOrPassword < Exception
+  end
+  
+  class AccountFrozen < Exception
+  end
+  
+  class IPLockdownViolation < Exception
+  end
+  
+  class InvalidNumber < Exception
+  end
+  
+  class EmptyMessage < Exception
+  end
+  
+  class InvalidAPIID < Exception
+  end
+  
+  class MessageTooLong < Exception
+  end
+  
+  class NumberBlocked < Exception
+  end
+  
+  class NumberDelisted < Exception
+  end
+  
+  class NoCreditLeft < Exception
+  end
+  
+  class MaxAllowedCredit < Exception
+  end
+  
+  class UnknownError < Exception
+  end
+  
+end

data/lib/clickatell/text.rb

@@ -0,0 +1,56 @@
+require 'uri'
+
+module Clickatell
+  
+  class Text
+    def initialize(username, password, api_id)
+      @username, @password, @api_id = username, password, api_id
+    end
+  
+    def send(to, message)
+      url = send_url(to, message)
+      response = Typhoeus::Request.get(url)
+      respond(response)
+    end
+  
+    private
+  
+    def send_url(to, message)
+      "https://api.clickatell.com/http/sendmsg?user=#{@username}&password=#{@password}&api_id=#{@api_id}&to=#{to}&text=#{URI.escape(message)}"
+    end
+    
+    def respond(response)
+      case response.code
+      when 200
+        true
+      when 001
+        raise AuthenticationFailed.new(response.body)
+      when 002
+        raise UnknownUsernameOrPassword.new(response.body)
+      when 004
+        raise AccountFrozen.new(response.body)
+      when 007
+        raise IPLockdownViolation.new(response.body)
+      when 106
+        raise InvalidNumber.new(response.body)
+      when 107
+        raise EmptyMessage.new(response.body)
+      when 108
+        raise InvalidAPIID.new(response.body)
+      when 113
+        raise MessageTooLong.new(response.body)
+      when 121
+        raise NumberBlocked.new(response.body)
+      when 128
+        raise NumberDelisted.new(response.body)
+      when 301
+        raise NoCreditLeft.new(response.body)
+      when 302
+        raise MaxAllowedCredit.new(response.body)
+      else
+        raise UnknownError.new("#{response.code} - #{response.body}")
+      end
+    end
+  end
+  
+end

data/lib/clickatell.rb

@@ -0,0 +1,4 @@
+require 'typhoeus'
+
+require 'clickatell/text'
+require 'clickatell/exceptions'

data/reddavis-clickatell.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{reddavis-clickatell}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["reddavis"]
+  s.date = %q{2009-11-23}
+  s.description = %q{Wrapper for clickatell.com}
+  s.email = %q{reddavis@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/clickatell.rb",
+     "lib/clickatell/exceptions.rb",
+     "lib/clickatell/text.rb",
+     "reddavis-clickatell.gemspec",
+     "spec/clickatell_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/reddavis/clickatell}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Wrapper for clickatell.com}
+  s.test_files = [
+    "spec/clickatell_spec.rb",
+     "spec/spec_helper.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
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<typhoeus>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<typhoeus>, [">= 0"])
+  end
+end
+

data/spec/clickatell_spec.rb

@@ -0,0 +1,218 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Clickatell" do
+  
+  describe "Sending Texts" do
+    before do
+      response = Typhoeus::Response.new(:code => 200)
+      Typhoeus::Request.stub!(:get).and_return(response)
+      @a = start_clickatell
+    end
+  
+    it "should send text" do
+      Typhoeus::Request.should_receive(:get)
+      @a.send(444, 'sometext')
+    end
+    
+    it "should return true" do
+      @a.send(444, 'yer').should be_true
+    end
+  end
+  
+  describe "Error Handling" do
+    
+    describe "Authentication Fail" do
+      before do
+        response = build_response(001)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an AuthenticationFailed exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::AuthenticationFailed)
+      end
+    end
+    
+    describe "Unknown Username or Password" do
+      before do
+        response = build_response(002)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an UnknownUsernameOrPassword exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::UnknownUsernameOrPassword)
+      end
+    end
+    
+    describe "Account Frozen" do
+      before do
+        response = build_response(004)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an AccountFrozen exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::AccountFrozen)
+      end
+    end
+    
+    describe "IP Lockdown Violation" do
+      before do
+        response = build_response(007)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an IPLockdownViolation exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::IPLockdownViolation)
+      end
+    end
+    
+    describe "Invalid Number" do
+      before do
+        response = build_response(106)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an InvalidNumber exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::InvalidNumber)
+      end
+    end
+    
+    describe "Empty Message" do
+      before do
+        response = build_response(107)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an EmptyMessage exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::EmptyMessage)
+      end
+    end
+    
+    describe "Invalid Or Missing API ID" do
+      before do
+        response = build_response(108)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an InvalidAPIID exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::InvalidAPIID)
+      end
+    end
+    
+    describe "Message Too Long" do
+      before do
+        response = build_response(113)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an MessageTooLong exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::MessageTooLong)
+      end
+    end
+    
+    describe "Number Blocked" do
+      before do
+        response = build_response(121)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an NumberBlocked exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::NumberBlocked)
+      end
+    end
+    
+    describe "Number Delisted" do
+      before do
+        response = build_response(128)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an NumberDelisted exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::NumberDelisted)
+      end
+    end
+    
+    describe "No Credit Left" do
+      before do
+        response = build_response(301)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an NoCreditLeft exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::NoCreditLeft)
+      end
+    end
+    
+    describe "Max Allowed Credit" do
+      before do
+        response = build_response(302)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an MaxAllowedCredit exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::MaxAllowedCredit)
+      end
+    end
+    
+    describe "Unknown Error" do
+      before do
+        response = build_response(999)
+        Typhoeus::Request.stub!(:get).and_return(response)
+        @a = start_clickatell
+      end
+      
+      it "should raise an UnknownError exception" do
+        lambda do
+          @a.send(444, 'test')
+        end.should raise_error(Clickatell::UnknownError)
+      end
+    end
+    
+  end
+  
+  private
+  
+  def start_clickatell
+    Clickatell::Text.new('username', 'password', 'api_id')
+  end
+  
+  def build_response(code)
+    Typhoeus::Response.new(:code => code)
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'clickatell'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: reddavis-clickatell
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- reddavis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Wrapper for clickatell.com
+email: reddavis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/clickatell.rb
+- lib/clickatell/exceptions.rb
+- lib/clickatell/text.rb
+- reddavis-clickatell.gemspec
+- spec/clickatell_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/reddavis/clickatell
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Wrapper for clickatell.com
+test_files: 
+- spec/clickatell_spec.rb
+- spec/spec_helper.rb