lita 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b293324db64514ccb9e45a84342fbf522363478
-  data.tar.gz: 50625efaedf4a1b1aeb8c7f0cde496ceee80fd88
+  metadata.gz: 4b61601772ee2c0a0822f137d838dd8f2b2aed2b
+  data.tar.gz: a035716200ec7451d45e4b9cc6bf633200718a30
 SHA512:
-  metadata.gz: 44946d4c859be7be8bbcaf0aca603c26ff7532cff12451eb20f13931eaad7b67812f5604c810e0a4e38c0986dbf2be298260dff2239a9a89b87a28db7e2914b9
-  data.tar.gz: 44bace7dfae78672b8dcee24cdf3ed952e2dffa5982a442f79503255871bfbff37f8bf3235d8eb4640a624c9710dbf8633d7abeacd701651829cf974111ef3fa
+  metadata.gz: 0088d680d6ded0dbeabfc979401010675d6e5d2b296dfdd66e06cadcfcf760d2db22ba480f9830a7d8eb05d3b81f1773bbe7ec8c6d20e4bb0820699eff90c195
+  data.tar.gz: 7225377452adbde322b4a9a1a62d2abb30721dee7b719b62e9d41c62ede19116b0979942374bfb195ea8eb2ebdec8efcbbe6ab1ba360927c17b42f065526775f

data/README.md

@@ -42,7 +42,7 @@ Yes.
 
 ## Installation
 
-First, install the gem with `gem install lita`. This gives you access to the `lita` commmand. Run `lita help` to list available tasks.
+First, install the gem with `gem install lita`. This gives you access to the `lita` command. Run `lita help` to list available tasks.
 
 Generate a new Lita instance by running `lita new NAME`. This will create a new directory called NAME (defaults to "lita") with a Gemfile and Lita configuration file.
 
@@ -295,7 +295,7 @@ module Lita
 
         data = MultiJson.load(http_response.body)
         rep = data["representative"]["name"]
-        redis.set(zip, data["representative"]["name"])
+        redis.set(zip, rep)
         rep
       end
     end
@@ -386,6 +386,10 @@ If you use `lita: true` instead of `lita_handler: true` in the metadata for your
 * Lita's logger is stubbed to prevent log messages from cluttering up your test output.
 * Lita's configuration is cleared out before each example, so that the first call to `Lita.config` will start from the default configuration.
 
+## Running as a daemon
+
+Lita has built-in support for daemonization on Unix systems. When run as a daemon, Lita will redirect standard output and standard error to a log file, and write the process ID to a PID file. To start Lita as a daemon, run `lita -d`. There are additional command line flags for specifying the path of the log and PID files, which override the defaults. If an existing Lita process is running when `lita -d` is invoked, Lita will abort and leave the original process running, unless the `-k` flag is specified, in which case it will kill the existing process. Run `lita help` for information about all the possible command line flags.
+
 ## Deploying to Heroku
 
 There are a few things worth mentioning when deploying an instance of Lita to Heroku:

data/lib/lita/cli.rb

@@ -1,5 +1,7 @@
 require "thor"
 
+require "lita/daemon"
+
 module Lita
   # The command line interface for Lita.
   class CLI < Thor
@@ -14,12 +16,47 @@ module Lita
     class_option :config,
       aliases: "-c",
       banner: "PATH",
-      default: "lita_config.rb",
+      default: File.expand_path("lita_config.rb", Dir.pwd),
       desc: "Path to the configuration file to use"
 
+    class_option :daemonize,
+      aliases: "-d",
+      default: false,
+      desc: "Run Lita as a daemon",
+      type: :boolean
+
+    class_option :log_file,
+      aliases: "-l",
+      banner: "PATH",
+      default: Process.euid == 0 ?
+        "/var/log/lita.log" : File.expand_path("lita.log", ENV["HOME"]),
+      desc: "Path where the log file should be written when daemonized"
+
+    class_option :pid_file,
+      aliases: "-p",
+      banner: "PATH",
+      default: Process.euid == 0 ?
+        "/var/run/lita.pid" : File.expand_path("lita.pid", ENV["HOME"]),
+      desc: "Path where the PID file should be written when daemonized"
+
+    class_option :kill,
+      aliases: "-k",
+      default: false,
+      desc: "Kill existing Lita processes when starting the daemon",
+      type: :boolean
+
     desc "start", "Starts Lita"
     def start
       Bundler.require
+
+      if options[:daemonize]
+        Daemon.new(
+          options[:pid_file],
+          options[:log_file],
+          options[:kill]
+        ).daemonize
+      end
+
       Lita.run(options[:config])
     end
 

data/lib/lita/daemon.rb

@@ -0,0 +1,62 @@
+require "fileutils"
+
+module Lita
+  # Converts Lita to a daemon process.
+  class Daemon
+    # @param pid_path [String] The path to the PID file.
+    # @param log_path [String] The path to the log file.
+    # @param kill_existing [Boolean] Whether or not to kill existing processes.
+    def initialize(pid_path, log_path, kill_existing)
+      @pid_path = pid_path
+      @log_path = log_path
+      @kill_existing = kill_existing
+    end
+
+    # Converts Lita to a daemon process.
+    # @return [void]
+    def daemonize
+      handle_existing_process
+      Process.daemon(true)
+      File.open(@pid_path, "w") { |f| f.write(Process.pid) }
+      set_up_logs
+      at_exit { FileUtils.rm(@pid_path) if File.exist?(@pid_path) }
+    end
+
+    private
+
+    # Abort if Lita is already running.
+    def ensure_not_running
+      if File.exist?(@pid_path)
+        abort <<-FATAL.chomp
+PID file exists at #{@pid_path}. Lita may already be running. \
+Kill the existing process or remove the PID file and then start Lita.
+FATAL
+      end
+    end
+
+    # Call the appropriate method depending on kill mode.
+    def handle_existing_process
+      if @kill_existing
+        kill_existing_process
+      else
+        ensure_not_running
+      end
+    end
+
+    # Try to kill an existing process.
+    def kill_existing_process
+      pid = File.read(@pid_path).strip.to_i
+      Process.kill("TERM", pid)
+    rescue Errno::ESRCH, RangeError, Errno::EPERM
+      abort "Failed to kill existing Lita process #{pid}."
+    end
+
+    # Redirect the standard streams to a log file.
+    def set_up_logs
+      log_file = File.new(@log_path, "a")
+      $stdout.reopen(log_file)
+      $stderr.reopen(log_file)
+      $stderr.sync = $stdout.sync = true
+    end
+  end
+end

data/lib/lita/version.rb

@@ -1,4 +1,4 @@
 module Lita
   # The current version of Lita.
-  VERSION = "2.1.2"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,6 +199,7 @@ files:
 - lib/lita/authorization.rb
 - lib/lita/cli.rb
 - lib/lita/config.rb
+- lib/lita/daemon.rb
 - lib/lita/handler.rb
 - lib/lita/handlers/authorization.rb
 - lib/lita/handlers/help.rb