exetel 0.0.1

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 jkongie
+
+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,17 @@
+= exetel
+
+Description goes here.
+
+== 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 jkongie. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "exetel"
+    gem.summary = "Ruby API wrapper for the Exetel SMS Service"
+    gem.description = "This gem wraps the SMS service provided by Exetel. You are required to have an Exetel account to use this service - http://www.exetel.com.au"
+    gem.email = "jkongie@gmail.com"
+    gem.homepage = "http://github.com/jkongie/exetel"
+    gem.authors = ["James Kong"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 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
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "exetel #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/exetel.gemspec

@@ -0,0 +1,61 @@
+# 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{exetel}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Kong"]
+  s.date = %q{2010-05-10}
+  s.description = %q{This gem wraps the SMS service provided by Exetel. You are required to have an Exetel account to use this service - http://www.exetel.com.au}
+  s.email = %q{jkongie@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "exetel.gemspec",
+     "lib/exetel.rb",
+     "lib/exetel/api.rb",
+     "lib/exetel/api/command.rb",
+     "lib/exetel/api/command_executor.rb",
+     "lib/exetel/api/error.rb",
+     "lib/exetel/api/message_status.rb",
+     "lib/exetel/response.rb",
+     "lib/exetel/response/type_keys.rb",
+     "test/helper.rb",
+     "test/test_exetel.rb"
+  ]
+  s.homepage = %q{http://github.com/jkongie/exetel}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby API wrapper for the Exetel SMS Service}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_exetel.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<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/exetel.rb

@@ -0,0 +1,8 @@
+module Exetel end
+
+%w(
+exetel/api
+exetel/response
+).each do |lib|
+  require File.join(File.dirname(__FILE__), lib)
+end

data/lib/exetel/api.rb

@@ -0,0 +1,49 @@
+module Exetel
+  # This module provides the core implementation of the Exetel SMS HTTP Service
+  class API
+    attr_accessor :auth_options
+    
+    def initialize(auth_options={})
+      @auth_options = auth_options
+    end
+    
+    # Sends a message +message_text+ to +recipient+. 
+    #
+    # Additional options:
+    #    :sender - the from number/name(default="")
+    #    :msg_type - The encoding type of message(default=text)
+    #    :ref_number - An optional reference number for local tracking
+    # Returns a new message ID if successful.
+    def send_message(recipient, message_text, opts={})
+      valid_options = { :sender => "", :messagetype => "Text" }
+      valid_options.merge!(:sender => opts[:sender]) if opts[:sender]
+      valid_options.merge!(:messagetype => opts[:msg_type]) if opts[:msg_type]
+      valid_options.merge!(:referencenumber => opts[:ref_number]) if opts[:ref_number]
+      recipient = recipient.join(",")if recipient.is_a?(Array)
+      response = execute_command('sms',
+                                 { :mobilenumber => recipient, :message => message_text}.merge(valid_options)
+                                )
+      response = parse_response(:sms, response)
+      response.is_a?(Array) ? response.map { |r| r[:status] } : response[:status]
+    end
+    
+    # Requests for the amount of credit remaining
+    #
+    # Returns a response hash
+    def credit_check
+      response = execute_command('sms_credit')
+      response = parse_response(:credit_check, response)
+    end
+    
+    protected
+      def execute_command(command_name, parameters={}) #:nodoc:
+        executor = CommandExecutor.new(auth_options, true)
+        result = executor.execute(command_name, parameters)
+      end
+    
+      def parse_response(response_type, raw_response) #:nodoc:
+        Exetel::Response.parse(response_type, raw_response)
+      end
+  end
+end
+

data/lib/exetel/api/command.rb

@@ -0,0 +1,35 @@
+require 'cgi'
+module Exetel  
+  class API
+    # Represents a Exetel HTTP gateway command in the form 
+    # of a complete URL (the raw, low-level request).
+    class Command
+      API_SERVICE_HOST = 'smsgw.exetel.com.au'
+      
+      def initialize(command_name, opts = {})
+        @command_name = command_name
+        @options = opts
+      end
+      
+      # Returns a URL for the given parameters (a hash).
+      def with_params(param_hash)
+        param_string = '?' + param_hash.map { |key, value| "#{::CGI.escape(key.to_s)}=#{::CGI.escape(value.to_s)}" }.sort.join('&')
+        return URI.parse(File.join(api_service_uri, command_uri + param_string))
+      end
+      
+      protected
+      
+        # Return the api service uri
+        # - TODO - Allow overriding of the default service host
+        def api_service_uri
+          api_service_host = API_SERVICE_HOST
+          return "https://#{api_service_host}/sendsms/"
+        end
+        
+        # Return the command part of the uri
+        def command_uri
+          return "/api_#{@command_name}.php"
+        end
+    end
+  end
+end

data/lib/exetel/api/command_executor.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'net/https'
+
+module Exetel
+  class API
+    
+    class CommandExecutor
+      
+      def initialize(authentication_hash, debug=false)
+        @authentication_hash = authentication_hash
+        @debug = debug
+      end
+      
+      # Builds a command object and sends it using HTTP GET. 
+      # Will output URLs as they are requested to stdout when 
+      # debugging is enabled.
+      def execute(command_name, parameters)
+        request_uri = command(command_name, parameters)
+        puts "[debug] Sending request to #{request_uri}" if @debug
+        get_response(request_uri).first
+      end
+      
+      protected
+        def command(command_name, parameters)
+          Command.new(command_name).with_params(parameters.merge(@authentication_hash))
+        end
+        
+        def get_response(uri)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.scheme == 'https')
+          http.start do |http|
+            resp, body = http.get([uri.path, uri.query].join('?'))
+          end
+        end
+    end
+  end
+end

data/lib/exetel/api/error.rb

@@ -0,0 +1,15 @@
+module Exetel
+  class API
+    
+    # Exetel API Error exception
+    class Error < StandardError
+      attr_reader :status, :message
+      
+      def initialize(response)
+        @status = Exetel::API::MessageStatus[response[:status]]
+        @message = response[:exetel_notes]
+        puts "Error: #{@status} => #{@message}"
+      end
+    end
+  end
+end

data/lib/exetel/api/message_status.rb

@@ -0,0 +1,15 @@
+module Exetel  
+  class API
+    class MessageStatus
+      STATUS_MAP = {
+        0 => "SMS Request Rejected",
+        1 => "Sent",
+        2 => "Failed"
+      }
+    
+      def self.[](code)
+        STATUS_MAP[code.to_i]
+      end
+    end
+  end
+end

data/lib/exetel/response.rb

@@ -0,0 +1,20 @@
+module Exetel
+  
+  # Used to parse HTTP responses returned from Exetel API calls.
+  class Response
+
+    class << self
+      
+      # Returns the HTTP response body data as a hash.
+      # - TODO - CLean this up
+      def parse(response_type, http_response)
+        response_keys = Exetel::Response::TypeKeys[response_type]
+        body = http_response.body.gsub("\n", '')
+        response = Hash[*response_keys.zip(body.split("|")).flatten]
+        raise Exetel::API::Error.new(response) if response[:status] == "0"
+        response
+      end
+    end
+    
+  end
+end

data/lib/exetel/response/type_keys.rb

@@ -0,0 +1,13 @@
+module Exetel  
+  class Response
+    class TypeKeys
+      TYPE_MAP = { 
+        :sms => [:status, :number, :reference_number, :exetel_id, :exetel_notes],
+        :credit_check => [:status, :credit_limit, :exetel_notes]
+        }
+      def self.[](type)
+        TYPE_MAP[type]
+      end  
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'exetel'
+
+class Test::Unit::TestCase
+end

data/test/test_exetel.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestExetel < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: exetel
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Kong
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-10 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This gem wraps the SMS service provided by Exetel. You are required to have an Exetel account to use this service - http://www.exetel.com.au
+email: jkongie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- exetel.gemspec
+- lib/exetel.rb
+- lib/exetel/api.rb
+- lib/exetel/api/command.rb
+- lib/exetel/api/command_executor.rb
+- lib/exetel/api/error.rb
+- lib/exetel/api/message_status.rb
+- lib/exetel/response.rb
+- lib/exetel/response/type_keys.rb
+- test/helper.rb
+- test/test_exetel.rb
+has_rdoc: true
+homepage: http://github.com/jkongie/exetel
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby API wrapper for the Exetel SMS Service
+test_files: 
+- test/helper.rb
+- test/test_exetel.rb