cinchize 0.2.0 → 0.3.0

data/README.rdoc

@@ -1,6 +1,8 @@
 = cinchize
 
-An early version of program which purpose is to daemonize Cinch ircbots from "simple" json config-files.
+Cinchize scope is to easily get a daemonized irc-bot up and running using plugins where there shouldn't be any need to actually write code.
+
+It should be noted that the program is currently considered to be in beta and may change both in how it's accessed and how the config logs is formed.
 
 == Installation
 
@@ -12,7 +14,7 @@ Basic
 
   cinchize --start 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
+The config file can either be in the current working directory or in /etc and should be called cinchize.yml. Use the flag -s to tell cinchize to look for the config file at /etc/cinchize.yml.
   
   cinchize -s --start network
   
@@ -20,38 +22,38 @@ To daemonzize, use -d
 
   cinchize -d --start network
 
-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.
+Network is the name you call the a server config in the servers part of the config file, i.e. "freenode", "super_duper_amazing_network", "quakenet" or similar.
 
 --start, --restart, --stop and --status assumes that the config file is located in the current working directory unless -s is used.
 
 == Config-file
 
-All config options can be skipped and the bot will use the defaults, but it could always be nice to connect to a server that isn't localhost, right? Plugins can be skipped too, but then the bot wouldn't do anything other then just idle.
-
-  {
-    "options" : {
-      "dir" : "/path/to/pid/dir",
-      "dir_mode" : "normal",
-      "log_output" : true
-    },
-    "servers" : {
-      "freenode" : {
-        "server" : "irc.freenode.net",
-        "port" : 6667,
-        "nick" : "Cinchbot",
-        "channels" : ["#cinchbots"],
-        "plugins" : [
-          {
-            "module" : "plugin-module",
-            "class" : "Cinch::Plugins::User::SomePlugin",
-            "options" : { 
-                "foo" : "bar"
-            }
-          }
-        ]
-      }
-    }
-  }
+All config options to each server object is optional, except for the channels and plugins. All valid config options for a Cinch bot should work.
+
+  options:
+    log_output: true
+    dir_mode: normal
+    dir: "/path/to/pid/dir"
+  servers:
+    freenode:
+      server: irc.freenode.net
+      port: 6667
+      nick: CinchizeBot
+      channels:
+        - "#cinchbots"
+      plugins:
+        - 
+          module: "cinch/plugins/some_plugin"
+          class: "Cinch::Plugins::SomePlugin"
+          options:
+            option: value
+        -
+          module: "cinch/plugins/another_plugin"
+          class: "Cinch::Plugins::AnotherPlugin"
+
+=== JSON deprecation
+
+The JSON format has been deprecated and will be removed in a future release, YaML is the preferred format hence forth.
 
 === Options explained
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/cinchize.gemspec

@@ -1,36 +1,34 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{cinchize}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Bergöö"]
-  s.date = %q{2010-12-05}
+  s.date = %q{2011-02-26}
   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"
+    "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/cinchize",
-     "cinchize.gemspec",
-     "examples/cinchize.init",
-     "lib/cinchize.rb"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/cinchize",
+    "cinchize.gemspec",
+    "examples/cinchize.init",
+    "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}

data/lib/cinchize.rb

@@ -7,15 +7,15 @@ $LOAD_PATH.unshift(dir) unless $LOAD_PATH.include? dir
 
 require 'cinch'
 require 'daemons'
-require 'json'
+require 'yaml'
 require 'optparse'
 
 module Cinchize
   Options = {
     :ontop => true,
     :system => false,
-    :local_config => File.join(Dir.pwd, 'cinchize.json'),
-    :system_config => '/etc/cinchize.json',
+    :local_config => File.join(Dir.pwd, 'cinchize.yml'),
+    :system_config => '/etc/cinchize.yml',
     :action => nil,
   }
   
@@ -65,11 +65,20 @@ module Cinchize
 
   def self.config options, network
     config_file = options[:system] ? options[:system_config]: options[:local_config]
+    unless File.exists? config_file
+      config_file.gsub! /yml$/, "json"
+    end
     
-    raise ArgumentError.new "the config file #{config_file} doesn't exist" unless File.exists? config_file
+    raise ArgumentError.new "there's no config file located at: #{config_file.gsub(/json$/, 'yml')}" unless File.exists? config_file
     raise ArgumentError.new "needs a network" if network.nil? or network.empty?
 
-    cfg = JSON.parse File.open(config_file, "r").read()
+    if File.extname(config_file) == ".yml"
+      cfg = YAML.load_file config_file
+    else 
+      require 'json'
+      puts "WARNING: the json config format has be deprecated in favour of YaML"
+      cfg = JSON.parse open(config_file, 'r').read()
+    end
     
     raise ArgumentError.new "there's no server config in the config file" unless cfg.has_key? "servers"
     raise ArgumentError.new "the config file doesn't contain a config for #{network}" unless cfg["servers"].has_key? network
@@ -133,7 +142,7 @@ module Cinchize
     end
     
     def clean_app_name
-      app_name.split('_').last
+      app_name.split('_', 2).last
     end
 
     def restart
@@ -199,6 +208,8 @@ module Cinchize
       pidfile = Daemons::PidFile.new dir, app_name
       return false if pidfile.pid.nil?
       return Process.kill(0, pidfile.pid) != 0
+    rescue Errno::ESRCH => e
+      return false
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Victor Berg\xC3\xB6\xC3\xB6"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-05 00:00:00 +01:00
+date: 2011-02-26 00:00:00 +01:00
 default_executable: cinchize
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,6 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -80,8 +79,8 @@ homepage: http://github.com/netfeed/cinchize
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1 +0,0 @@
-pkg