raad_totem 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6cc5ec492a3a7e4ff5ee49cf38c01826f0efb27
-  data.tar.gz: df041b77a669ce3a6abf6443f9a186ef215a775d
+  metadata.gz: b772d074bcc80584f4bb8f0bcb48b32521f04f84
+  data.tar.gz: 08a63c2fe519d1ec7d6002bc0e68be0027161862
 SHA512:
-  metadata.gz: 8aaf81a66fbe9eb507da57698f2d36f49507f49f3af90dfd3cda219d39222b2426f226a13660d242ae8c11242d122eef060822b87eb48da5e66882fb34cb4eed
-  data.tar.gz: 76cb583b22e8bbbc7981edf97b5566c3ebaf480e5d237c67eafc08dabb2f825f81b55cff52b96ab4a640eae8cf79b549ba7f6bc0d073cec2f43ac1e695c47ef3
+  metadata.gz: 9ca7a0a6f3d8dcbf1fce64706d9efed240d5b34565bdd4fca5a8caadb394453222a971e9d2a4f7e377b8a29161b42abe69842f348e9f4b2469918c5f6e40c188
+  data.tar.gz: 260c1543892a3d7d31d990352307d6faf2697afb5669a98076b31f3ee76dce3814c042aef5c02f940b056fa6e83fba39b4508f5b83116b3dcb6c21109bf2c35e

data/LICENSE.md

@@ -1,5 +1,5 @@
 Raad - Totem
-Authored by Chad Remesch (chad@remesch.com) as a derivate of the original Raad Ruby gem.
+Authored by Chad Remesch as a derivate of the original Raad Ruby gem.
 
   Copyright 2014 Chad Remesch
 

data/README.md

@@ -7,26 +7,76 @@ This is a fork of the [Raad](https://github.com/colinsurprenant/raad) gem that i
 ## Changes from the original Raad v0.5.0:
 
 - Removal of log4j since Totem already has a built in logger.
-- Integration with Totem's environment setting.
+- Integration with Totem.
 - Change namespaces so as not to conflict with Raad if both gems are installed.
+- Removal of various command line options and use Totem defaults instead.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your Totem project's Gemfile:
 
-    gem 'raad-totem'
+    gem 'raad_totem', :require => 'raad_totem/shell_cmds/service'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install raad-totem
+Create a new service file `service/hello_world_service.rb` in the project root directory:
 
-## Usage
+    #!/usr/bin/env ruby
+
+    require_relative '../config/environment.rb'
+
+    require 'raad_totem'
+
+    class HelloWorldService
+      def self.options_parser(parser, options)
+        parser.separator('')
+        parser.separator('App Options:')
+
+        parser.on('-c', '--custom', 'Some custom option') {|val| options[:custom] = val }
+
+        return parser
+      end
+
+      def start
+        Totem.logger.info('Service start.')
+
+        while !RaadTotem.stopped?
+          Totem.logger.info('Hello World.')
+          sleep 5
+        end
+      end
+
+      def stop
+        Totem.logger.info('Service stop.')
+      end
+    end
+    
+Make sure you set executable permissions on your service file:
+
+    chmod +x service/hello_world_service.rb
+
+You can run your service in the foreground (press ctrl+c to kill it and wait a few seconds):
+
+    ./service/hello_world_service.rb start
+
+You can also run your service in the background:
+
+    ./service/hello_world_service.rb -d start
+
+To stop the background service:
+
+    ./service/hello_world_service.rb stop
+
+By default, your service will log to a custom log in the `log` directory.
+It will also create a PID file in the `tmp/pid` directory.
+
+To view all available options (including custom ones you define):
 
-Coming soon.
+    ./service/hello_world_service.rb --help
 
 ## Contributing
 

data/lib/raad_totem/runner.rb

@@ -170,8 +170,6 @@ module RaadTotem
         opts.separator "Service Options:"
 
         opts.on('-d', '--daemonize', "run daemonized in the background (default: no)") { |v| @parsed_options[:daemonize] = v }
-        opts.on('-P', '--pid FILE', "pid file when daemonized (default: tmp/pids directory)") { |file| @parsed_options[:pid_file] = file }
-        opts.on('-r', '--redirect FILE', "redirect stdout when daemonized (default: log directory)") { |v| @parsed_options[:redirect] = v }
         opts.on('-e', '--environment ENVIRONMENT', "Totem environment") { |v| Totem.env = v }
         opts.on('-i', '--instance INSTANCE', "Totem instance") { |v| Totem.instance = v }
         opts.on(nil,  '--timeout SECONDS', "seconds to wait before force stopping the service (default: 60)") { |v| @parsed_options[:stop_timeout] = v }

data/lib/raad_totem/version.rb

@@ -1,3 +1,3 @@
 module RaadTotem
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end unless defined?(RaadTotem::VERSION)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raad_totem
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Colin Surprenant