cinchize 0.0.2 → 0.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Victor Bergöö
+Copyright (c) 2010 Victor Bergöö
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -2,17 +2,25 @@
 
 An early version of program which purpose is to daemonize Cinch ircbots from "simple" json config-files.
 
+== Installation
+
+  gem install cinchize
+
 == Usage
 
 Basic
 
-  cinchize start -- server
+  cinchize network
+
+The config file can either be in the current working directory or in /etc, should be called cinchize.json, i.e. /etc/cinchize.json, use -s to look for the file in /etc
+  
+  cinchize -s network
   
-Specify a config file, if no file is specified the cinchize is looking for it in /etc/cinchize.json
+To daemonzize, use -d
 
-  cinchize start -- -f config.json server
+  cinchize -d network
 
-Server is the name you call the a server config in the servers part of the config file, i.e. "freenode", "my_cute_bot", "quakenet" or similar. 
+Network is the name you call the a server config in the servers part of the config file, i.e. "freenode", "my_cute_bot", "quakenet" or similar. 
 
 == Config-file
 
@@ -34,7 +42,9 @@ All config options can be skipped and the bot will use the defaults, but it coul
           {
             "module" : "plugin-module",
             "class" : "Cinch::Plugins::User::SomePlugin",
-            "options" : { }
+            "options" : { 
+                "foo" : "bar"
+            }
           }
         ]
       }

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/cinchize.gemspec

@@ -0,0 +1,56 @@
+# 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{cinchize}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Victor Bergöö"]
+  s.date = %q{2010-10-31}
+  s.default_executable = %q{cinchize}
+  s.description = %q{Create dynamic Cinch IRC-bots and daemonize them, without the need of writing any code}
+  s.email = %q{victor.bergoo@gmail.com}
+  s.executables = ["cinchize"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/cinchize",
+     "cinchize.gemspec",
+     "lib/cinchize.rb"
+  ]
+  s.homepage = %q{http://github.com/netfeed/cinchize}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Create dynamic Cinch IRC-bots and daemonize them}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cinch>, [">= 0"])
+      s.add_runtime_dependency(%q<daemons>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<cinch>, [">= 0"])
+      s.add_dependency(%q<daemons>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cinch>, [">= 0"])
+    s.add_dependency(%q<daemons>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/lib/cinchize.rb

@@ -8,22 +8,53 @@ $LOAD_PATH.unshift(dir) unless $LOAD_PATH.include? dir
 require 'cinch'
 require 'daemons'
 require 'json'
+require 'optparse'
 
 module Cinchize
+  Options = {
+    :ontop => true,
+    :system => false,
+    :local_config => File.join(Dir.pwd, 'cinchize.json'),
+    :system_config => '/etc/cinchize.json',
+  }
+  
   def self.run
-    daemon_options, ntw, plugins, plugin_options = config 
-    Daemons.run_proc(daemon_options[:app_name], daemon_options) do
+    options = Options.dup
+    
+    ARGV.options do |o|
+      o.set_summary_indent '  '
+      o.banner = "Usage: #{File.basename $0} [Options] network"
+      
+      o.on("-d", "--daemonize", "Daemonize") { 
+        options[:ontop] = false
+      }
+      
+      o.on("-s", "--system-config", "Use system config") { 
+        options[:system] = true
+      }
+      
+      o.parse!
+    end
+
+    d_options, network, plugins, plugin_options = config(options, ARGV.first)
+    daemon = Daemons::ApplicationGroup.new(d_options[:app_name], {
+      :ontop => d_options[:ontop],
+      :dir => d_options[:dir],
+      :dir_mode => d_options[:dir_mode]
+    })
+    app = daemon.new_application :mode => :none, :log_output => d_options[:log_output]
+    app.start
+    
+    loop do
       bot = Cinch::Bot.new do  
         configure do |c|
-          ntw.keys.each do |key|
-            c.send("#{key}=".to_sym, ntw[key])
-          end
-          
+          network.keys.each { |key| c.send("#{key}=".to_sym, network[key]) }
+
           c.plugins.plugins = plugins
           c.plugins.options = plugin_options
         end
       end
-      
+
       bot.start
     end
   rescue ArgumentError => e
@@ -31,24 +62,14 @@ module Cinchize
     exit 1
   end
   
-  def self.config
+  def self.config options, network
     cmd_options = []
     
-    idx = ARGV.index "--"
-    unless idx.nil?
-      cmd_options = ARGV.dup.slice(idx+1..-1)
-    end
+    config_file = options[:system] ? options[:system_config]: options[:local_config]
     
-    config_file = "/etc/cinchize.json"
-    unless cmd_options.index("-f").nil?
-      config_file = cmd_options[cmd_options.index("-f") + 1]
-    end
-    
-    raise ArgumentError.new "the config file doesn't exist" unless File.exists? config_file
-    raise ArgumentError.new "needs a network" if cmd_options[-1].nil?
+    raise ArgumentError.new "the config file #{config_file} doesn't exist" unless File.exists? config_file
+    raise ArgumentError.new "needs a network" if network.nil? or network.empty?
 
-    network = cmd_options[-1]
-    
     cfg = JSON.parse File.open(config_file, "r").read()
     
     raise ArgumentError.new "there's no server config in the config file" unless cfg.has_key? "servers"
@@ -70,7 +91,7 @@ module Cinchize
         plugin["class"].split("::").inject(Object) { |m,n| clazz = m.const_get(n) }
         plugins << clazz 
       
-        plugin_options[plugin["class"]] = plugin["options"] || {}
+        plugin_options[clazz] = plugin["options"] || {}
       rescue LoadError => e
         puts "error while loading the module: #{e}"
       rescue NameError => e
@@ -80,16 +101,52 @@ module Cinchize
 
     raise ArgumentError.new "no plugins loaded" if plugins.size == 0
 
-    dir_mode = cfg["options"]["dir_mode"].nil? ? "normal" : cfg["options"]["dir_mode"]
-
     cfg["options"] ||= {}
+    dir_mode = cfg["options"]["dir_mode"].nil? ? "normal" : cfg["options"]["dir_mode"]
+    
     daemon_options = {
       :dir_mode => dir_mode.to_sym,
       :dir => cfg["options"]["dir"] || Dir.getwd,
       :log_output => cfg["options"]["log_output"] || false,
-      :app_name => "cinchize_#{network}"
+      :app_name => "cinchize_#{network}",
+      :ontop => options[:ontop],
     }
 
     [daemon_options, ntw, plugins, plugin_options]
   end
 end
+
+# We need to open up Daemons::Application#start_none so we can log the output
+# The original code can be found at: 
+# => http://github.com/ghazel/daemons/blob/master/lib/daemons/application.rb#L60
+module Daemons
+  class Application
+    def start_none
+      unless options[:ontop]
+        Daemonize.daemonize(output_logfile, @group.app_name)
+      else
+        Daemonize.simulate
+      end
+
+      @pid.pid = Process.pid
+
+      at_exit {
+        begin; @pid.cleanup; rescue ::Exception; end
+        if options[:backtrace] and not options[:ontop] and not $daemons_sigterm
+          begin; exception_log(); rescue ::Exception; end
+        end
+      }
+      trap(SIGNAL) {
+        begin; @pid.cleanup; rescue ::Exception; end
+        $daemons_sigterm = true
+
+        if options[:hard_exit]
+          exit!
+        else
+          exit
+        end
+      }
+    end
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - "Victor Berg\xC3\xB6\xC3\xB6"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-24 00:00:00 +02:00
+date: 2010-10-31 00:00:00 +02:00
 default_executable: cinchize
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,6 +72,7 @@ files:
 - Rakefile
 - VERSION
 - bin/cinchize
+- cinchize.gemspec
 - lib/cinchize.rb
 has_rdoc: true
 homepage: http://github.com/netfeed/cinchize