config/boot.rb lib/lokii/servers/gsm_proxy.rb lib/lokii/servers/gsm_server.rb lib/lokii/servers/memoy_server.rb templates/Rakefile templates/app/handlers/i_love_you_handler.rb templates/app/handlers/ping_handler.rb templates/app/models/inbox.rb templates/app/models/multipart_inbox.rb templates/app/models/outbox.rb templates/app/models/worker.rb templates/test/handlers/i_love_you_handler_test.rb templates/test/test_helper.rb @@ -1,6 +1,8 @@ +.DS_Store config/database.yml config/smsd.yml config/settings.yml -.DS_Store +db notes -pkg \ No newline at end of file +pkg +script/smsd \ No newline at end of file .gitignore @@ -1,5 +1,34 @@ GEM_NAME = 'lokii' +require File.join(File.expand_path(File.dirname(__FILE__)), 'config', 'boot.rb') + +require 'rake' +require 'rake/testtask' +require 'rake/rdoctask' + +desc 'Test the lokii gem' +Rake::TestTask.new(:test) do |t| + t.libs << 'config' + t.libs << 'lib' + t.libs << 'test' + t.pattern = File.join('test', '**', '*_test.rb') + t.verbose = true +end + +desc 'Generate documentation for lokii' +Rake::RDocTask.new(:rdoc) do |rdoc| + rdoc.rdoc_dir = 'rdoc' + rdoc.title = 'Transceivers' + rdoc.options << '--line-numbers' << '--inline-source' + rdoc.rdoc_files.include('README') + rdoc.rdoc_files.include(File.join('lib', '**', '*.rb')) +end + +Dir[File.join('tasks', '**', '*.rake')].each { |rake| load rake } + +# By default, we test. We love tests. +task :default => [:test] + begin require 'jeweler' Jeweler::Tasks.new do |s| @@ -9,7 +38,7 @@ begin s.homepage = "http://socialrange.org/" s.description = "Lokii is a Ruby SMS framework for ultimate awesomeness and with configurable servers and handlers." s.authors = ["Jeff Rafter"] - s.files = FileList["[A-Z]*.*", "{bin,lib,test,script,examples}/**/*"] + ["config/init.rb", "config/process.rb", "config/settings.example.yml", "config/database.example.yml", "config/messages.example.yml"] + s.files = FileList["[A-Z]*.*", "{app,bin,examples,lib,script,templates}/**/*"] + ["config/boot.rb", "config/init.rb", "config/process.rb", "config/settings.example.yml", "config/database.example.yml", "config/messages.example.yml"] s.executables = "lokii" end rescue LoadError @@ -20,19 +49,29 @@ def windows? false end -desc 'Uninstall the current gem' -task :uninstall do - list = `gem list #{GEM_NAME}` - installed = list =~ /#{GEM_NAME}/m - puts "Uninstalling #{GEM_NAME}" if installed - sh "#{'sudo ' unless windows?}gem uninstall #{GEM_NAME}" if installed +def remove(task) + Rake.application.instance_variable_get("@tasks").delete(task) end - -desc 'Install the package as a gem' -task :install => [:uninstall, :gemspec] do - sh "rm -rf pkg" - sh "mkdir pkg" - sh "gem build #{GEM_NAME}.gemspec" - sh "mv *.gem pkg" - sh "#{'sudo ' unless windows?}gem install pkg/*.gem --no-rdoc --no-ri" + +remove 'gem' +remove 'gem:build' +remove 'gem:install' + +namespace :jeweler do + desc 'Uninstall the current gem' + task :uninstall do + list = `gem list #{GEM_NAME}` + installed = list =~ /#{GEM_NAME}/m + puts "Uninstalling #{GEM_NAME}" if installed + sh "#{'sudo' unless windows?} gem uninstall #{GEM_NAME}" if installed + end + + desc 'Install the package as a gem' + task :install => [:uninstall, :gemspec] do + sh "rm -rf pkg" + sh "mkdir pkg" + sh "gem build #{GEM_NAME}.gemspec" + sh "mv *.gem pkg" + sh "#{'sudo' unless windows?} gem install pkg/*.gem --no-rdoc --no-ri" + end end \ No newline at end of file Rakefile @@ -1,5 +1,4 @@ #!/usr/bin/env ruby -require 'rubygems' require 'fileutils' LOCATION_ROOT = File.join(File.dirname(__FILE__), "..") @@ -15,6 +14,7 @@ def copy(f, t = nil) end def usage + puts "" puts "Usage:" puts "" puts " lokii create [name] - Creates a lokii directory at name or ./lokii" @@ -39,15 +39,18 @@ if ARGV.length >= 1 && !["start", "stop", "run", "restart"].include?(ARGV[0]) end # Generate it. FileUtils.mkdir(DEST) - ["log", "tmp", "config", "app", "script"].each do |folder| + ["log", "tmp", "config", "app", "script", "test"].each do |folder| FileUtils.mkdir(j(DEST, folder)) end - # PIDS + # Folders FileUtils.mkdir(j(DEST, 'tmp', 'pids')) FileUtils.mkdir(j(DEST, 'app', 'handlers')) FileUtils.mkdir(j(DEST, 'app', 'models')) FileUtils.mkdir(j(DEST, 'app', 'servers')) + FileUtils.mkdir(j(DEST, 'test', 'handlers')) + FileUtils.mkdir(j(DEST, 'test', 'models')) + FileUtils.mkdir(j(DEST, 'test', 'servers')) puts "Writing Settings" copy j("config", "settings.example.yml"), j("config", "settings.yml") @@ -56,12 +59,18 @@ if ARGV.length >= 1 && !["start", "stop", "run", "restart"].include?(ARGV[0]) copy j("config", "database.example.yml"), j("config", "database.yml") copy j("config", "messages.example.yml"), j("config", "messages.yml") + puts "Writing Boot" + copy j("config", "boot.rb") + puts "Writing Initializer" copy j("config", "init.rb") puts "Writing Process" copy j("config", "process.rb") + puts "Writing Rakefile" + copy j("templates", "Rakefile"), j("Rakefile") + puts "Copying start scripts" copy j("script", "console") copy j("script", "daemon") @@ -71,10 +80,15 @@ if ARGV.length >= 1 && !["start", "stop", "run", "restart"].include?(ARGV[0]) FileUtils.chmod 0755, j(DEST, "script", "lokii") puts "Copying example handlers" - copy j("lib", "lokii", "handlers", "ping_handler.rb"), j("app", "handlers", "ping_handler.rb") - copy j("lib", "lokii", "handlers", "i_love_you_handler.rb"), j("app", "handlers", "i_love_you_handler.rb") - + copy j("templates", "app", "handlers", "ping_handler.rb"), j("app", "handlers", "ping_handler.rb") + copy j("templates", "app", "handlers", "i_love_you_handler.rb"), j("app", "handlers", "i_love_you_handler.rb") + + puts "Building test environment" + copy j("templates", "test", "test_helper.rb"), j("test", "test_helper.rb") + copy j("templates", "test", "handlers", "i_love_you_handler_test.rb"), j("test", "handlers", "i_love_you_handler_test.rb") + puts "Done" + elsif ARGV.length >= 1 if !File.exist?(j("script", "daemon")) puts "This isn't a lokii directory." @@ -82,6 +96,7 @@ elsif ARGV.length >= 1 exit(1) end exec "ruby ./script/daemon #{ARGV.map {|a| a.include?(" ") ? "\"#{a}\"" : a }.join(" ")}" + else if !File.exist?(j("script", "lokii")) puts "This isn't a lokii directory." bin/lokii @@ -1,14 +1,20 @@ +require 'rubygems' require 'lokii' -Lokii::Config.setup +# Only option currently is :database +Lokii::Config.setup do |config| + config.options[:database] = false +end # Lokii won't do anything unless a server is activated. By default it comes with # two servers: database_server and file_server. These are simple servers that # implement the checking, processing and saying, either through a database # (which can be used in conjunction with gnokii/smsd and others) or through # a watched directory. -require File.join('lokii', 'servers', 'database_server') -Lokii::Processor.servers = Lokii::DatabaseServer.new +require 'lokii/servers/gsm_server' + +# Register the server with the processor +Lokii::Processor.servers = Lokii::GsmServer.new # Once you have selected a server you need to register the appropriate handlers # By example a PingHandler and ILoveYouHandler are registered. Handlers are config/init.rb @@ -1,6 +1,7 @@ development: interval: 1 verbose: false + ports: /dev/cu.usbmodem1a21 log: log/development.log err: log/development.err pid: tmp/pids/lokii.pid config/settings.example.yml @@ -1,9 +1,5 @@ -require 'rubygems' -require 'active_record' -require 'active_support' - require File.join('lokii', 'logger') require File.join('lokii', 'config') require File.join('lokii', 'server') require File.join('lokii', 'handler') -require File.join('lokii', 'processor') +require File.join('lokii', 'processor') \ No newline at end of file lib/lokii.rb @@ -1,9 +1,23 @@ +require 'yaml' + +class Hash + def symbolize_keys! + each do |k,v| + sym = k.respond_to?(:to_sym) ? k.to_sym : k + self[sym] = Hash === v ? v.symbolize_keys! : v + delete(k) unless k == sym + end + self + end +end + module Lokii class Config - cattr_accessor :configuration, :settings, :database, :messages - - def self.setup(options = {}) - load_config(options) + def self.setup(&block) + define_accessors :options, :configuration, :settings, :database, :messages + self.options = {} + block.call(self) + load_config load_defaults load_application setup_defaults @@ -35,23 +49,23 @@ module Lokii private - def self.load_config(options = {}) + def self.load_config self.configuration = {} - self.database = YAML.load_file(File.join(self.root, 'config', 'database.yml')) + self.database = YAML.load_file(File.join(self.root, 'config', 'database.yml')) rescue nil self.messages = YAML.load_file(File.join(self.root, 'config', 'messages.yml')) rescue nil self.settings = YAML.load_file(File.join(self.root, 'config', 'settings.yml')) - self.load_settings(options) + self.load_settings self.map_config end - def self.load_settings(options = {}) + def self.load_settings self.settings.symbolize_keys! - self.configuration.merge!(self.settings[self.environment].merge(options)) + self.configuration.merge!(self.settings[self.environment].merge(self.options)) self.configuration.symbolize_keys! end def self.map_config - self.database.symbolize_keys! + self.database.symbolize_keys! if self.database self.messages.symbolize_keys! if self.messages mod = Module.new do @@ -72,7 +86,6 @@ module Lokii end def self.load_defaults - require File.join('lokii', 'models', 'worker') end def self.load_application @@ -87,10 +100,18 @@ module Lokii end def self.setup_database + return unless self.options[:database] + require 'active_record' ActiveRecord::Base.establish_connection(Lokii::Config.database[Lokii::Config.environment]) rescue Exception => e Lokii::Logger.error "Could not initialize the database #{e.to_yaml}" end + def self.define_accessors(*args) + args.each {|attr| + class_eval("unless defined? @@#{attr}\n@@#{attr} = nil\nend\n\ndef self.#{attr}\n@@#{attr}\nend\n\ndef #{attr}\n@@#{attr}\nend\n", __FILE__, __LINE__) + class_eval("unless defined? @@#{attr}\n@@#{attr} = nil\nend\n\ndef self.#{attr}=(obj)\n@@#{attr} = obj\nend\n\ndef #{attr}=(obj)\n@@#{attr} = obj\nend\n", __FILE__, __LINE__) + } + end end end \ No newline at end of file lib/lokii/config.rb @@ -1,16 +1,14 @@ module Lokii class Handler - attr_accessor :message, :worker, :server + attr_accessor :message, :server def initialize @message = nil - @worker = nil @server = nil end - def handle(message, worker, server) + def handle(message, server) @message = message - @worker = worker @server = server process end @@ -24,8 +22,8 @@ module Lokii end def reply(text) - Lokii::Logger.debug "Sending reply to #{message.number}" - @server.say(text, message.number, message.id) + Lokii::Logger.debug "Sending reply to #{message[:number]}" + @server.say(text, message[:number], message) end def halt lib/lokii/handler.rb @@ -11,10 +11,17 @@ module Lokii # sent to the specified log file (and not the console). You can configure the # output log file in +config/settings.yml+. class Logger - cattr_accessor :logger - class << self - + @@logger = nil + + def logger + @@logger + end + + def logger=(value) + @@logger = value + end + def method_missing(name, *args, &blk) self.setup self.logger.send(name, *args, &blk) lib/lokii/logger.rb @@ -54,19 +54,18 @@ module Lokii private - def handle(message) - message = message - worker = Worker.active.find(:first, :conditions => {:number => message.number}) - return unless worker - Lokii::Logger.debug "" - Lokii::Logger.debug "Handling message\n#{message.to_yaml}" + def handle(message) + Lokii::Logger.debug "\nHandling message" + Lokii::Logger.debug ":sender: #{message[:number]}" + Lokii::Logger.debug ":sent: #{message[:created_at]}" + Lokii::Logger.debug ":received: #{message[:processed_at]}" + Lokii::Logger.debug ":text: #{message[:text]}" catch :halt do handlers.each {|handler| - handler.handle(message, worker, self) - break if message.processed > 0 + handler.handle(message, self) } end - complete(message) unless message.processed? + complete(message) unless message[:processed] end end lib/lokii/server.rb @@ -6,12 +6,12 @@ Gem::Specification.new do |s| s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Jeff Rafter"] - s.date = %q{2008-12-04} + s.date = %q{2009-02-04} s.default_executable = %q{lokii} s.description = %q{Lokii is a Ruby SMS framework for ultimate awesomeness and with configurable servers and handlers.} s.email = %q{jeff@socialrange.org} s.executables = ["lokii"] - s.files = ["README.textile", "VERSION.yml", "bin/lokii", "lib/lokii", "lib/lokii/config.rb", "lib/lokii/handler.rb", "lib/lokii/handlers", "lib/lokii/handlers/i_love_you_handler.rb", "lib/lokii/handlers/ping_handler.rb", "lib/lokii/logger.rb", "lib/lokii/mapper.rb", "lib/lokii/models", "lib/lokii/models/inbox.rb", "lib/lokii/models/multipart_inbox.rb", "lib/lokii/models/outbox.rb", "lib/lokii/models/worker.rb", "lib/lokii/processor.rb", "lib/lokii/server.rb", "lib/lokii/servers", "lib/lokii/servers/database_server.rb", "lib/lokii.rb", "test/test_helper.rb", "test/unit", "test/unit/i_love_you_handler_test.rb", "script/console", "script/daemon", "script/lokii", "script/smsd", "config/init.rb", "config/process.rb", "config/settings.example.yml", "config/database.example.yml", "config/messages.example.yml"] + s.files = ["README.textile", "VERSION.yml", "app/handlers", "app/handlers/i_love_you_handler.rb", "app/handlers/ping_handler.rb", "bin/lokii", "lib/lokii", "lib/lokii/config.rb", "lib/lokii/handler.rb", "lib/lokii/handlers", "lib/lokii/handlers/i_love_you_handler.rb", "lib/lokii/handlers/ping_handler.rb", "lib/lokii/logger.rb", "lib/lokii/models", "lib/lokii/models/inbox.rb", "lib/lokii/models/multipart_inbox.rb", "lib/lokii/models/outbox.rb", "lib/lokii/models/worker.rb", "lib/lokii/processor.rb", "lib/lokii/server.rb", "lib/lokii/servers", "lib/lokii/servers/database_server.rb", "lib/lokii/servers/gsm_proxy.rb", "lib/lokii/servers/gsm_server.rb", "lib/lokii/servers/memoy_server.rb", "lib/lokii.rb", "script/console", "script/daemon", "script/lokii", "script/smsd", "templates/Rakefile", "templates/test", "templates/test/handlers", "templates/test/handlers/i_love_you_handler_test.rb", "templates/test/test_helper.rb", "config/boot.rb", "config/init.rb", "config/process.rb", "config/settings.example.yml", "config/database.example.yml", "config/messages.example.yml"] s.homepage = %q{http://socialrange.org/} s.require_paths = ["lib"] s.rubygems_version = %q{1.3.1} lokii.gemspec @@ -1,16 +1,9 @@ #!/usr/bin/env ruby -require 'rubygems' require 'daemons' -LOKII_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) -LOKII_ENV = ENV['LOKII_ENV'] || 'development' LOKII_DAEMON = true -if File.exist?(File.join(LOKII_ROOT, 'config', 'init.rb')) - $:.unshift(File.join(LOKII_ROOT, 'config')) -end - -require 'init' +require File.join(File.dirname(__FILE__), '..', 'config', 'boot')) if ARGV.empty? "Usage: lokii [connect|disconnect|start|stop|restart]" script/daemon @@ -1,14 +1,5 @@ #!/usr/bin/env ruby -require 'rubygems' - -LOKII_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) -LOKII_ENV = ENV['LOKII_ENV'] || 'development' - -if File.exist?(File.join(LOKII_ROOT, 'config', 'init.rb')) - $:.unshift(File.join(LOKII_ROOT, 'config')) -end - -require 'init' +require File.join(File.dirname(__FILE__), '..', 'config', 'boot') # Check if it is already running if Lokii::Processor.running? script/lokii @@ -1,36 +1,14 @@ -require 'rubygems' - -require 'test/unit' -require 'context' -require 'matchy' -require 'stump' - -LOKII_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) unless defined? LOKII_ROOT LOKII_ENV = 'test' unless defined? LOKII_ENV -if File.exist?(File.join(LOKII_ROOT, 'lib', 'lokii.rb')) - $:.unshift(File.join(LOKII_ROOT, 'lib')) -end - -require 'lokii' - -# Load custom expectations -Dir[File.expand_path(File.join(LOKII_ROOT, 'test', 'expectations', '*.rb'))].uniq.each do |file| - require file -end - -alias :running :lambda +require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'config', 'boot.rb') +require 'test/unit' +require 'shoulda' class Test::Unit::TestCase - #self.use_transactional_fixtures = true - #self.use_instantiated_fixtures = false -end + # self.use_transactional_fixtures = true + # self.use_instantiated_fixtures = false -Dir[File.expand_path(File.join(LOKII_ROOT, 'test', '**', '*_test.rb'))].uniq.each do |file| - require file + def message(text, number=nil) + Inbox.new(:text => text, :number => number) + end end - - -def message(text, number=nil) - Inbox.new(:text => text, :number => number) -end \ No newline at end of file test/test_helper.rb lib/lokii/handlers/i_love_you_handler.rb lib/lokii/handlers/ping_handler.rb lib/lokii/mapper.rb lib/lokii/models/worker.rb test/unit/i_love_you_handler_test.rb e8c9735abbb9322826c476a8777c895d74963a9c Jeff Rafter jeff@baobabhealth.org http://github.com/jeffrafter/lokii/commit/ba8cb3821b66ac7995581057443bc92177a633b0 ba8cb3821b66ac7995581057443bc92177a633b0 2009-02-05T13:03:53-08:00 2009-02-05T13:03:53-08:00 Reorganization to remove some of the dependencies 18d8e1aa0c068adc8630ba924279c365e81d68e6 Jeff Rafter jeff@baobabhealth.org