rannel 0.4.0

data/README.txt

@@ -0,0 +1,27 @@
+Currently we can consider Rannel to be on an alpha stage. We have the ability to send requests (via HTTP/GET) to a kannel (http://www.kannel.org) instance in order to send sms messages to a subscriber.
+
+Which are the steps (not necessarily versions) of Rannel (i.e. what will it do for us)?
+
+I can see for the moment 4 main steps in here:
+
+	1. Rannel ---http/get(post)---> Kannel
+
+	In this first step we will be able to send requests to a Kannel instance in order to be able to send sms messages to a subscriber. It might seem that we have that already (more or less) but I think that there is still a lot work to do here (logs, etc).
+
+	2. Rannel <---http/get(post)--- Kannel
+
+	In this second step we should be able to receive messages from Kannel. I did not include the protocol in the graph as I think that we should be able to do this without thinking first on the protocol. Let me explain:
+	
+	In Kannel there are various ways to send content or call an application, these include http requests (GET and POST), external program calls, or even fetching the content from a flat file. We should be able to respond to any one of these.
+
+	3. Rannel ---administer---> Kannel
+
+	In this 3rd step, we should be able to administer the Kannel instances, being able to change configuration parameters and restarting the whole thing. We should also not be that tied to Kannel any more (in the sense of that we don't need to start Kannel in order to get Rannel working, Kannel (bearerbox and smsbox) will be	started from within Rannel when Rannel starts). I.e. we are moving into being a	SMS gateway.
+
+	4. Rannel --- SMPP ---> SMSC
+
+	From this moment on we should be able to talk directly to the SMSC (or GSM modem) in order to receive and send messages to the subscribers.
+
+I am also considering the option of integrating Rannel with other features of Kannel (OTA & WAP), we should consider these too.
+
+Then I was thinking of plugging Rannel into Mbuni too (http://www.mbuni.org). Mbuni is a MMS gateway that sits on top of Kannel. We should take a look at it at some stage to see how we could use this to send not only SMS but also MMS to the subscribers...

data/lib/rannel.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# Rannel is a set of classes that will interact with the open source
+# SMS Gateway Kannel (http://www.kannel.org) to send SMS messages from 
+# a Ruby (or Rails) application.
+# 
+# It has been inspired by the ActiveXXX project family for the ease of
+# usage.
+# 
+# This file just puts all the needed files found in the Rannel project
+# together so that there is no need to "require" each and every file when
+# using rannel.
+# 
+# === Note
+# 
+# Per se Rannel will need a working Kannel instance running in order to 
+# be able to send the messages through Kannel (that is the bearerbox and
+# smsbox processes) for the moment. Later we might implement either the
+# handles to start the bearer- and sms-box from within Rannel or we will
+# implement the same funcionallity as offered by Kannel.
+#
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+$:.unshift(File.dirname(__FILE__))
+
+require "logger"
+
+require "rannel/base"
+require "rannel/exceptions"
+require "rannel/connections"
+require "rannel/sms"
+require "rannel/adapters/abstract_adapter"
+require "rannel/adapters/get_requests"
+require "rannel/adapters/post_requests"
+
+@@logger = Logger.new(STDOUT)
+@@logger.level = Logger::WARN

data/lib/rannel/adapters/abstract_adapter.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# Here you will find common methods to be used by all the adapter 
+# implementations.
+#
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+module Rannel
+  class AbstractAdapter
+    require 'net/http'
+    require 'cgi'
+    
+    def initialize(config)
+      @ip = config[:ip]
+      @port = config[:port]
+      @user = config[:user]
+      @password = config[:password]
+      @@logger.info("Adapter #{self.class} initialized")
+      @@logger.debug("With IP:#{@ip} | PORT:#{@port}" +
+        " | USER:#{@user} | PWD: #{@password}")
+    end
+  end
+end

data/lib/rannel/adapters/get_requests.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# The GetRequestAdapter will make HTTP/GET requests to a Kannel smsbox
+# instance in order to send the messages to Kannel.
+#
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+module Rannel
+  class Base
+    def self.get_request_adapter(config)
+      return GetRequestAdapter.new(config)
+    end
+  end
+
+  class GetRequestAdapter < AbstractAdapter
+    
+    def deliver(sms)
+      result = ""
+      Net::HTTP.start(@ip, @port) do |http|
+        url = "/cgi-bin/sendsms?username=#{@user}" + 
+          "&password=#{@password}#{sms.to_kannel}"
+        @@logger.debug("Sending following rewuest: #{url}")
+        response = http.get(url)
+        result = response.body
+        @@logger.debug("Response from Kannel #{result}")
+      end  
+      result
+    end    
+  end
+end

data/lib/rannel/adapters/post_requests.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# The PostRequestAdapter will make HTTP/POST requests to a Kannel smsbox
+# instance in order to send the messages to Kannel.
+#
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+require "rubygems"
+require "builder"
+
+module Rannel
+  class Base
+    def self.post_request_adapter(config)
+      return PostRequestAdapter.new(config)
+    end
+  end
+
+  class PostRequestAdapter < AbstractAdapter
+    
+    # TODO implement the post funcionallity for this adapter
+    def deliver(sms)
+      http = Net::HTTP.new(@ip, @port)
+      response =  http.post("/cgi-bin/sendsms",
+        to_xml(sms).gsub("_", "-"), {'Content-Type'=>'text/xml', 
+          'user'=> @user.to_s, 'password' => @password.to_s,
+          'X-Kannel-From' => sms.from.to_s})
+      @@logger.debug("Response from Kannel #{response.body}")
+      response.body
+    end
+    
+    # Will Create the XML that we will need to post to Kannel
+    def to_xml(sms)
+      xml = ''
+      doc = Builder::XmlMarkup.new(:target => xml, :indent => 2)
+      doc.instruct!
+      
+      doc.message {|message|
+        message.submit {|submit|
+          if sms.to_many.nil? || sms.to_many.length < 1
+            submit.da{|da| da.number(sms.to)}
+          else
+            sms.to_many.each do |to|
+              submit.da{|da| da.number(to)}
+            end
+            unless sms.to.nil?
+              submit.da{|da| da.number(sms.to)}
+            end
+          end
+          submit.oa{|oa| oa.number(sms.from)}
+          submit.ud(sms.text)
+          sms.udh.nil? ? '' : submit.udh(sms.udh)
+          submit.dcs{|dcs|
+            sms.mclass.nil? ? '' : dcs.mclass(sms.mclass)
+            sms.coding.nil? ? '' : dcs.coding(sms.coding)
+            sms.mwi.nil? ? '' : dcs.mwi(sms.mwi)
+            sms.compress.nil? ? '' : dcs.compress(sms.compress)
+            sms.alt_dcs.nil? ? '' : dcs.alt_dcs(sms.alt_dcs)
+            }
+          sms.pid.nil? ? '' : submit.pid(sms.pid)
+          sms.rpi.nil? ? '' : submit.rpi(sms.rpi)
+          sms.validity.nil? ? '' : submit.vp{|vp| vp.delay(sms.validity)}
+          sms.deferred.nil? ? '' : submit.timing{|timing| timing.delay(sms.deferred)}
+          
+          if !(sms.dlr_mask.nil? && sms.dlr_url.nil?)
+            submit.statusrequest{|status|
+              sms.dlr_mask.nil? ? '' : status.dlr_mask(sms.dlr_mask)
+              sms.dlr_url.nil? ? '' : status.dlr_url(sms.dlr_url)
+            }
+          end
+          submit.from {|from|
+            from.username(@user.to_s)
+            from.password(@password.to_s)
+          }
+          submit.to(sms.account)
+        }
+      }
+      @@logger.debug("XML for Post: #{xml}")
+      xml
+    end    
+  end
+end

data/lib/rannel/base.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# Rannel is a set of classes that will interact with the open source
+# SMS Gateway Kannel (http://www.kannel.org) to send SMS messages from 
+# a Ruby (or Rails) application.
+# 
+# It has been inspired by the ActiveXXX project family for the ease of
+# usage.
+# 
+# === Note
+# 
+# Per se Rannel will need a working Kannel instance running in order to 
+# be able to send the messages through Kannel (that is the bearerbox and
+# smsbox processes) for the moment. Later we might implement either the
+# handles to start the bearer- and sms-box from within Rannel or we will
+# implement the same funcionallity as offered by Kannel.
+#
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+module Rannel
+  class Base
+
+    class << self
+      
+      # Will deliver the SMS using the provided Adapter.
+      def deliver(sms)
+        raise "No SMS provided to deliver" unless sms
+        begin
+          @@logger.debug("Delivering SMS to Kannel")
+          self.connection.deliver(sms)
+        rescue NoMethodError
+          @@logger.warn("Adapter has not been initialized!")
+          raise ConnectionNotEstablished
+        end
+      end
+      
+      def create_sms
+        sms = Rannel::Sms.new
+        sms
+      end
+    end
+  end
+end

data/lib/rannel/connections.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# Here you'll find methods on the Base class that work closely with the
+# connections to the Kannel Gateway.
+# 
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+module Rannel
+  
+  class Base
+    @connection = nil
+    
+    class << self
+      
+      # Return the current connection object 
+      # (or an exception if not available)
+      def connection
+        if @connection.nil?
+          raise ConnectionNotEstablished
+        end
+        @connection
+      end
+      
+      # Are we connected? Do we have a connection adapter configured?
+      def connected? 
+        !@connection.nil?
+      end
+      
+      # Adds the connection to the Base class
+      # 
+      # TODO: Think about the possibility to add more than one connection.
+      # 
+      def connection=(spec)
+        raise ConnectionNotEstablished unless spec
+        @connection = spec
+      end
+      
+      # Method to explicitly drop the current connection
+      def drop_connection
+        @connection = nil
+      end
+      
+      # To establish a valid connection to a kannel smsbox you will
+      # initialize as following:
+      # 
+      # Rannel::Base.establish_connection(
+      #   :adapter => "get",
+      #   :ip => "localhost",
+      #   :port => "123342",
+      #   :user => "someusr",
+      #   :password => "foobar")
+      # 
+      # This will open (or prepare the connection to the smsbox so that
+      # you are ready to send sms messages)
+      def establish_connection(config)
+        unless config.key?(:adapter)
+          raise AdapterNotSpecified, "#{config} adapter is not configured"
+        end
+        
+        adapter_method = "#{config[:adapter]}_request_adapter"
+        unless respond_to?(adapter_method)
+          raise AdapterNotFound,
+            "Configuration specifies nonexistent #{config[:adapter]} adapter"
+        end
+        @connection = self.send(adapter_method, config)
+      end
+    end
+  end
+end

data/lib/rannel/exceptions.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# In this file you will find all the Exceptions that will be thrown
+# inside of a Rannel runtime.
+#
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+module Rannel
+
+  # Standard Rannel error
+  class RannelError < StandardError
+  end
+  
+  # When the connection object has not been added.
+  class ConnectionNotEstablished < RannelError
+  end  
+  
+  # When no adapter was specified while configuring
+  class AdapterNotSpecified < RannelError
+  end
+  
+  # When a wrong adapter was specified
+  class AdapterNotFound < RannelError
+  end
+end

data/lib/rannel/sms.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# In this file you will find the SMS class, that defines a sms message to
+# be consumed by a Kannel Gateway.
+#
+# == Author
+#  Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+module Rannel
+
+  # Defines a Kannel Internal SMS message (that is with all the parameters
+  # accepted by Kannel).
+  class Sms
+    require 'cgi'
+    
+    @@methods = %w{ from to text charset udh smsc mclass mwi compress coding validity deferred dlr_mask dlr_url pid alt_dcs rpi account bininfo priority }
+    
+    def initialize
+      @accessors = Hash.new
+    end
+    
+    # When we call a setter (=) or a getter method, or even a xxx_to_kannel
+    # method it will be handled by this method in order to allow us to
+    # use the kannel specific methods.
+    def method_missing(method_id, *args)
+      if method_id.to_s=~ /=$/
+        includes(method_id.to_s.chop)
+        arg = *args
+        if arg.instance_of?(String) || (arg.to_s=~ /(\%\d{2})*/) > 0
+          arg = CGI.escape(arg)
+        end
+        @accessors["#{method_id}"] = arg
+      elsif method_id.to_s=~/_to_kannel/
+        includes($`)
+        return "&#{$`}=#{@accessors["#{$`}="]}".gsub("_", "-")
+      else
+        includes(method_id.to_s)
+        return @accessors["#{method_id}="]
+      end
+    end
+    
+    # Outputs the whole Sms object with the current values as a kannel string
+    # to be used when we do a get request.
+    # 
+    # TODO: Think if it makes sense here... or should it go to the get adapter?
+    def to_kannel
+      kannel = ""
+      @accessors.each do |key, value|
+        kannel << self.method_missing("#{key.chop}_to_kannel", nil)
+      end
+      kannel
+    end
+    
+    # adds a subscriber to the list of multiple recipients
+    # note that it will only be taken into consideration in the POST adapter
+    def add_to(to)
+      if @to_many.nil?
+        @to_many = Array.new
+      end
+        @to_many.push(to)
+    end
+    
+    # Returns the list of subscribers that will receive the SMS
+    def to_many
+      @to_many
+    end
+    
+    private
+    
+    # We want to be sure that the method we are calling is a valid method.
+    def includes(method)
+      if(!@@methods.include?(method.to_s))
+        raise "NoMethodError"
+      end
+    end
+  end
+end

data/rakefile.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# == Synopsis
+# With this rake file you will be able to run the tests found in the test
+# directory and perform other tasks that we will be defining over the time.
+# 
+# == Tasks
+#  - default: Will just call the test task
+#  - dest: Will run the unit tests
+#  - clobber_rdoc: Remove the rdocumentation
+#  - rdoc: Run the RDoc documentation
+#  - rerdoc: Rerun the RDoc documentation
+# 
+# == Author
+#  Created by Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+require "rubygems"
+require 'rake'
+require 'rake/testtask'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+# Switch off if you don't wan't all that profiling information printed out.
+#require "profile"
+
+PKG_VERSION   = "0.4.0"
+PKG_NAME      = "rannel"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+#  == Gem Specification
+dist_dirs = [ "lib", "test"]
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.files = [ "rakefile.rb", "README.txt" ]
+  dist_dirs.each do |dir|
+    s.files = s.files + Dir.glob( "#{dir}/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  end
+  s.summary = "Rannel framework to send SMS messages through Kannel"
+  s.has_rdoc = true
+  s.require_path = 'lib'
+  s.author = "Enrique Comba Riepenhausen"
+  s.email = "ecomba@rubyforge.org"
+  s.homepage = "http://rannel.rubyforge.org/"
+  s.rubyforge_project = "rannel"
+end
+
+# Tasks
+task :default => :test
+
+desc "Runs the unit tests"
+Rake::TestTask.new(:test) do |test|
+    test.libs << "test"
+    test.test_files = FileList['test/test*.rb']
+    test.verbose = true
+end
+
+desc "Generated the projects api documentation"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.rdoc_dir = "docs/rdoc"
+end
+
+desc "Generates the zip, tar and gem packages of the project"
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end

data/test/adapters.yaml

@@ -0,0 +1,27 @@
+get:
+    :adapter: "get"
+    :ip: "localhost"
+    :port: 13920
+    :user: "tester"
+    :password: "foobar"
+    
+post:
+    :adapter: "post"
+    :ip: "localhost"
+    :port: 13920
+    :user: "tester"
+    :password: "foobar"
+    
+wrong_user_post:
+    :adapter: "post"
+    :ip: "localhost"
+    :port: 13920
+    :user: "austin"
+    :password: "foobar"
+
+wrong_password_post:
+    :adapter: "post"
+    :ip: "localhost"
+    :port: 13920
+    :user: "tester"
+    :password: "ahole"

data/test/test_adapters.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+# 
+# == Synopsis
+#  Will test the different adapters that communicate with Kannel
+#
+#  == Author
+#  Created by Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "rubygems"
+require "test/unit"
+require 'mocha'
+
+require 'rannel'
+require "logger"
+require "yaml"
+
+class TestAdapters < Test::Unit::TestCase
+  
+  def setup
+    @OK = "0: Accepted for delivery"
+    @adapters = YAML.load_file("#{File.dirname(__FILE__)}/adapters.yaml")
+  end
+  
+  def test_connected
+    assert(!Rannel::Base.connected?, "Connection should not be established.")
+  end
+  
+  def test_connection_not_established
+    assert_raise(Rannel::ConnectionNotEstablished) { Rannel::Base.connection }
+  end
+  
+  def test_no_connection_to_deliver_sms
+    sms = Rannel::Base.create_sms
+    Rannel::Base.drop_connection
+    assert_raise(Rannel::ConnectionNotEstablished) { Rannel::Base.deliver(sms) }
+  end
+  
+  def test_no_deliver
+    assert_raise(RuntimeError) { Rannel::Base.deliver(nil) }
+  end
+  
+  def test_get_adapter
+    get_request = Rannel::Base.establish_connection(@adapters["get"])
+    
+    assert_equal(get_request, Rannel::Base.connection)
+  end
+  
+  def test_send_through_get_adapter
+    Rannel::Base.establish_connection(@adapters["get"])
+  
+    sms = Rannel::Base.create_sms
+    sms.from = "123124" 
+    sms.to = 2356556652
+    sms.text = "Hello"
+    
+    body = @OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+     
+    assert_equal(@OK, Rannel::Base.deliver(sms))
+  end
+  
+  def test_send_through_post_adapter
+    Rannel::Base.establish_connection(@adapters["post"])
+        
+    sms = Rannel::Base.create_sms
+    sms.from = "12345678"
+    sms.add_to("23489988923")
+    sms.add_to("29930038883")
+    sms.text = "Greetings"
+    
+    body = @OK
+    response = stub(:body => @OK)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    assert_equal(@OK, Rannel::Base.deliver(sms))
+  end
+  
+  def test_send_nokia_ringtone
+    Rannel::Base.establish_connection(@adapters["get"])
+      
+    sms = Rannel::Base.create_sms
+    sms.from = 2345342222
+    sms.to = 123123232
+    sms.udh = "%06%05%04%15%81%15%81"
+    
+    sms.text = "%02%4A%3A%5D%35%85%B5%85%35%A5%84%04%00%77%1E%96%58%26" + 
+      "%C3%4C%26%C3%4C%26%C3%4C%26%C3%6C%26%C3%6C%26%C3%6C%26%C3%6C%26" +
+      "%C3%4C%26%C3%4C%26%C3%4C%26%C3%4C%26%C3%6C%26%C3%6C%26%C3%6C%26" +
+      "%C3%6C%26%C3%4C%34%C3%8C%51%36%17%29%06%17%61%56%17%61%56%13%42" +
+      "%4D%30%E3%14%4D%85%CA%41%85%D8%55%85%D8%55%84%D0%00%00%00"
+      
+    body = @OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+        
+    assert_equal(@OK, Rannel::Base.deliver(sms))  
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# 
+# == Synopsis
+#  Will test the methods located in the base.rb (i.e. the Base class).
+#
+#  == Author
+#  Created by Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "test/unit"
+
+require 'rannel'
+
+class TestBase < Test::Unit::TestCase
+  
+  def test_create_sms
+    sms = Rannel::Base.create_sms
+    
+    assert_instance_of(Rannel::Sms, sms)
+  end
+  
+  # TAIWO -- This is the place where to code the test... Thanks!
+  def test_regexp 
+    binary = "%06%05%04%15%81%15%81"
+    
+    assert_equal(binary,  /(\%\d{2})*/.match(binary).to_s)
+  end
+end

data/test/test_get_requests.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+# 
+# == Synopsis
+#  Will test the GetRequestAdapter that "talks" with Kannel using the
+#  HTTP GET method.
+#
+#  == Author
+#  Created by Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "rubygems"
+require "test/unit"
+require 'mocha'
+
+require "rannel"
+require "yaml"
+
+class TestGetRequestAdapter < Test::Unit::TestCase
+  @@OK = "0: Accepted for delivery"
+  def setup
+    @adapters = YAML.load_file("#{File.dirname(__FILE__)}/adapters.yaml")
+    @kannel = Rannel::GetRequestAdapter.new(@adapters["get"])
+    @sms = Rannel::Sms.new
+    @sms.from = 1234556
+    @sms.to = 345345435
+    @sms.text = "Kannel!"
+  end
+  
+  def test_get_request_adapter
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+  
+  def test_get_with_mclass
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    @sms.mclass = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 3
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 4
+    body = "MClass field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    assert_equal("MClass field misformed, rejected", @kannel.deliver(@sms))
+  end
+  
+  def test_get_with_mwi
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    @sms.mwi = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 3
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 4
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 5
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 6
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 7
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 8
+    body = "MWI field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    assert_equal("MWI field misformed, rejected", @kannel.deliver(@sms))
+  end
+  
+  def test_get_with_coding
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    @sms.coding = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.coding = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.coding = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.coding = 3
+    body = "Coding field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    assert_equal("Coding field misformed, rejected", @kannel.deliver(@sms))
+  end
+  
+  def test_get_with_validity
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    @sms.validity = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.validity = 7812378213782782
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+  
+  def test_get_with_deffered
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    @sms.deferred = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+  
+  def test_get_with_alt_dcs
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    @sms.alt_dcs = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.alt_dcs = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.alt_dcs = 2
+    
+    body = "Alt-DCS field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    assert_equal("Alt-DCS field misformed, rejected", @kannel.deliver(@sms))
+  end
+  
+  def test_get_with_priority
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    @sms.priority = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.priority = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.priority = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.priority = 3
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.priority = 4
+    
+    body = "Priority field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    
+    assert_equal("Priority field misformed, rejected", @kannel.deliver(@sms))
+  end
+end

data/test/test_post_request.rb

@@ -0,0 +1,206 @@
+#!/usr/bin/env ruby
+#
+#  Created by Enrique Comba Riepenhausen on 2007-05-23.
+#  Copyright (c) 2007. All rights reserved.
+
+require "rubygems"
+require "test/unit"
+require 'mocha'
+
+require "rannel"
+require "yaml"
+
+class TestPostRequestAdapter < Test::Unit::TestCase
+  @@OK = "0: Accepted for delivery"
+  
+  def setup
+    @adapters = YAML.load_file("#{File.dirname(__FILE__)}/adapters.yaml")
+
+    @kannel = Rannel::PostRequestAdapter.new(@adapters["post"])
+    @sms = Rannel::Sms.new
+    @sms.from = 1234556
+    @sms.to = 345345435
+    @sms.text = "POSTME"
+  end
+  
+  def test_xml
+    #puts @kannel.to_xml(@sms)
+  end
+  
+  def test_deliver
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+  
+  def test_wrong_user_deliver
+    body = "Authorization failed for sendsms"
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    kannel = Rannel::PostRequestAdapter.new(@adapters["wrong_user_post"])  
+    
+    assert_equal("Authorization failed for sendsms", kannel.deliver(@sms))
+  end
+  
+  def test_wrong_password_deliver
+    body = "Authorization failed for sendsms"
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    kannel = Rannel::PostRequestAdapter.new(@adapters["wrong_password_post"])
+  
+    assert_equal("Authorization failed for sendsms", kannel.deliver(@sms))
+  end
+  
+  def test_many
+    @sms.add_to(3333333333)
+    @sms.add_to(4444444444)
+    
+    response = stub(:body => @@OK)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+  
+  # Testing the fields...
+  def test_post_with_mclass
+    response = stub(:body => @@OK)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    @sms.mclass = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 3
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mclass = 4
+    
+    body = "MClass field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    assert_equal(body, @kannel.deliver(@sms))
+  end
+  
+  def test_post_with_mwi
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    @sms.mwi = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 3
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 4
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 5
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 6
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 7
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.mwi = 8
+    
+    body = "MWI field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    assert_equal("MWI field misformed, rejected", @kannel.deliver(@sms))
+  end
+  
+  def test_post_with_coding
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    @sms.coding = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.coding = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.coding = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.coding = 3
+    
+    body = "Coding field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    assert_equal("Coding field misformed, rejected", @kannel.deliver(@sms))
+  end
+  
+  def test_post_with_validity
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    @sms.validity = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.validity = 7812378213782782
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+  
+  def test_post_with_deffered
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    @sms.deferred = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+  
+  def test_post_with_alt_dcs
+    response = stub(:body => @@OK)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    @sms.alt_dcs = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.alt_dcs = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.alt_dcs = 2
+    
+    body = "Alt-DCS field misformed, rejected"
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    assert_equal("Alt-DCS field misformed, rejected", @kannel.deliver(@sms))
+  end
+  
+  def test_post_with_priority
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:post => response)
+    Net::HTTP.stubs(:new).returns(http)
+    
+    @sms.priority = 0
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.priority = 1
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.priority = 2
+    assert_equal(@@OK, @kannel.deliver(@sms))
+    @sms.priority = 3
+    assert_equal(@@OK, @kannel.deliver(@sms))
+  end
+end

data/test/test_rannel_included.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# 
+# == Synopsis
+#  Will test the inclusion of the Rannel Module into a class and use it from
+# there.A
+#
+#  == Author
+#  Created by Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+require "rubygems"
+require "test/unit"
+require "mocha"
+
+require "rannel"
+require "yaml"
+
+class TestRannelIncluded < Test::Unit::TestCase
+  include Rannel
+  
+  @@OK = "0: Accepted for delivery"
+  
+  def test_case_name
+    @adapters = YAML.load_file("#{File.dirname(__FILE__)}/adapters.yaml")
+    Base.establish_connection(@adapters["get"])
+      
+    sms = Base.create_sms
+    sms.from = "1234233"
+    sms.to = "2122121"
+    sms.text = "Cool"
+    
+    body = @@OK
+    response = stub(:body => body)
+    http = stub(:get => response)
+    Net::HTTP.stubs(:start).yields(http)
+    assert_equal(@@OK, Base.deliver(sms))
+  end
+end

data/test/test_sms.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# 
+# == Synopsis
+#  Will test the Sms class to make sure it's methods work as expected.
+#
+#  == Author
+#  Created by Enrique Comba Riepenhausen
+# 
+# == Copyright
+#  Copyright (c) 2007. All rights reserved.
+#  Licensed under the LGPL
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "test/unit"
+
+require "rannel"
+
+class TestSms < Test::Unit::TestCase
+  def setup
+    @sms = Rannel::Base.create_sms
+  end
+  
+  def test_basic_methods
+    @sms.from = "me"
+    @sms.to = "you"
+    @sms.text = "How are you?"
+    
+    assert_equal("me", @sms.from)
+    assert_equal("you", @sms.to)
+    assert_equal("How+are+you%3F", @sms.text)
+  end
+  
+  def test_dynamic_methods
+    @sms.mclass= "expected"
+    assert_equal("expected", @sms.mclass)
+    assert_equal("&mclass=expected", @sms.mclass_to_kannel)
+  end
+  
+  def test_wrong_method
+    @sms.mclass = 2323
+    @sms.smsc = "smscee"
+    
+    assert_raise(RuntimeError) { @sms.nanana=12 }
+    assert_raise(RuntimeError) { @sms.nanana }
+    assert_raise(RuntimeError) { @sms.nanana_to_kannel }
+    assert_raise(RuntimeError) { @sms.nanana_nununu }
+  end
+  
+  def test_to_many
+    sms = Rannel::Sms.new
+    sms.add_to("12344444")
+    
+    assert_equal(1, sms.to_many.length)
+    
+    sms.add_to("12122122")
+    
+    assert_equal(2, sms.to_many.length)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: rannel
+version: !ruby/object:Gem::Version 
+  version: 0.4.0
+date: 2007-05-28 00:00:00 +02:00
+summary: Rannel framework to send SMS messages through Kannel
+require_paths: 
+- lib
+email: ecomba@rubyforge.org
+homepage: http://rannel.rubyforge.org/
+rubyforge_project: rannel
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Enrique Comba Riepenhausen
+files: 
+- rakefile.rb
+- README.txt
+- lib/rannel
+- lib/rannel.rb
+- lib/rannel/adapters
+- lib/rannel/base.rb
+- lib/rannel/connections.rb
+- lib/rannel/exceptions.rb
+- lib/rannel/sms.rb
+- lib/rannel/adapters/abstract_adapter.rb
+- lib/rannel/adapters/get_requests.rb
+- lib/rannel/adapters/post_requests.rb
+- test/adapters.yaml
+- test/test_adapters.rb
+- test/test_base.rb
+- test/test_get_requests.rb
+- test/test_post_request.rb
+- test/test_rannel_included.rb
+- test/test_sms.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+