react 0.0.1 → 0.0.2

data/README.md

@@ -1,20 +1,25 @@
 # React
 
-React is a simple application that allows for remote execution of commands.
-It uses Redis as a queue - it is blocking specified list and waits for new 
-entries - when an entry appears, then it is executing recognized command.
+React is a simple application that allows for remote execution of commands, 
+and it uses Redis as a queue.
 
 ## Inspiration
 
-It's inspired by Simon Willson's example of "Queue-activated shell scripts"
-in his redis-tutorial:
+It's inspired by Simon Willison's example of "Queue-activated shell scripts"
+in his [redis tutorial](http://simonwillison.net/static/2010/redis-tutorial/):
 
     while [ 1 ] do
       redis-cli blpop restart-httpd 0
       apache2ctl graceful
     done
 
-## Examples
+## Installation
+
+You can simply install React using rubygems:
+
+    sudo gem install react
+
+## Usage
 
 Firs you have to prepare file with available commands. It can look like this: 
 
@@ -26,39 +31,37 @@ Firs you have to prepare file with available commands. It can look like this:
     reboot: |
       reboot
    
-And now you can start consumer. 
+And now you can start a consumer. 
 
     react my_commands.yml
 
-## Commands
+## Pushing commands
 
-While your consumer is working, you can push any of specified command to it's 
+While your consumer is working, you can push any of specified command to  
 queue (default queue name is `queue`), eg:
 
     redis-cli lpush queue restart_httpd
     redis-cli lpush queue reboot
 
+After that consumer will pick up enqueued command names from and execute 
+related commands. 
+
 ## Configuration
   
 There are few more runtime options, which can be useful for you. 
 
-* you can specify queue wihch will be consumed:
+* you can specify queue which will be consumed:
 
-    react my_commands.yml --queue "my:queue:name"
+      react my_commands.yml --queue "my:queue:name"
 
 * you can specify the database to which consumer should connect:
 
-    react my_commands.yml --host "yourhost.com" --port 6379 --db 2
+      react my_commands.yml --host "yourhost.com" --port 6379 --db 2 --password pass
 
 * and finally, you can demonize the consumer:
 
-    react my_commands.yml --daemonize
-
-## Links
-
-* [My website](http://nu7hatch.com/)
-* [Simon Wilson's Redis tutorial](http://simonwillison.net/static/2010/redis-tutorial/)
-
+      react my_commands.yml --daemon
+      
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "react"
-    gem.version = "0.0.1"
+    gem.version = "0.0.2"
     gem.default_executable = 'react'
     gem.executables = ['react']
     gem.summary = %Q{Redis based remote command executor.}

data/bin/react

@@ -28,6 +28,7 @@ opts = OptionParser.new do |opts|
   opts.on('-h', '--host [HOST]', 'Select redis host') {|val| val and options[:redis][:host] = val }
   opts.on('-p', '--port [PORT]', Integer, 'Select redis port') {|val| val and options[:redis][:port] = val }
   opts.on('-D', '--db [DATABASE]', 'Select redis database number') {|val| val and options[:redis][:db] = val }
+  opts.on('-P', '--password [PASSWORD]', 'Select redis database password') {|val| val and options[:redis][:password] = val }  
   opts.on('-d', '--daemon', 'Run in background') { options[:daemon] = true }
 end.parse(ARGV)
 

data/examples/commands.yml

@@ -0,0 +1,8 @@
+restart_httpd: |
+  apache2ctl graceful
+  
+restart_mysql: |
+  /etc/init.d/mysql restart
+
+reboot: |
+  reboot

data/lib/react.rb

@@ -1,21 +1,20 @@
 require 'redis'
 require 'thread'
 
-# React is a simple application that allows for remote execution of commands.
-# It uses Redis as a queue - it is blocking specified list and waits for new 
-# entries - when an entry appears, then it is executing recognized command.
+# React is a simple application that allows for remote execution of commands, 
+# and it uses Redis as a queue.
 #
 # == Inspiration
 #
-# It's inspired by Simon Willson's example of "Queue-activated shell scripts"
-# in his redis-tutorial:
+# It's inspired by Simon Willison's example of "Queue-activated shell scripts"
+# in his redis tutorial:
 #
 #   while [ 1 ] do
 #     redis-cli blpop restart-httpd 0
 #     apache2ctl graceful
 #   done
 #
-# == Examples
+# == Usage
 # 
 # Firs you have to prepare file with available commands. It can look like this: 
 #
@@ -31,26 +30,32 @@ require 'thread'
 #
 #   react my_commands.yml
 #
-# == Commands
+# == Pushing commands
 #
-# While your consumer is working, you can push any command to it's queue
-# (default queue name is `queue`), eg:
+# While your consumer is working, you can push any of specified command to  
+# queue (default queue name is `queue`), eg:
 #
 #   redis-cli lpush queue restart_httpd
 #   redis-cli lpush queue reboot
 #
+# After that consumer will pick up enqueued command names from and execute 
+# related commands. 
+#
 # == Configuration
-#   
+#  
 # There are few more runtime options, which can be useful for you. 
-#   
-#   # it will be consuming commands from specified queue
-#   react my_commands.yml --queue "my:queue:name"
 #
-#   # you can specify the database to which React should connect
-#   react my_commands.yml --host "yourhost.com" --port 6379 --db 2
+# * you can specify queue which will be consumed:
+#
+#     react my_commands.yml --queue "my:queue:name"
+#
+# * you can specify the database to which consumer should connect:
+#
+#     react my_commands.yml --host "yourhost.com" --port 6379 --db 2 --password pass
+#
+# * and finally, you can demonize the consumer:
 #
-#   # and finally, you can demonize your application
-#   react  my_commands.yml --daemonize
+#     react my_commands.yml --daemon
 module React
 
   # It starts the consumer loop. 

data/react.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{react}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kriss 'nu7hatch' Kowalik"]
-  s.date = %q{2010-08-16}
+  s.date = %q{2010-08-17}
   s.default_executable = %q{react}
-  s.description = %q{A simple application that allows remote execution of commands.}
+  s.description = %q{A simple application that allows for remote execution of commands.}
   s.email = %q{kriss.kowalik@gmail.com}
   s.executables = ["react"]
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "README.md",
      "Rakefile",
      "bin/react",
+     "examples/commands.yml",
      "lib/react.rb",
      "react.gemspec",
      "test/react_test.rb",
@@ -34,7 +35,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Redis based remote commands executor.}
+  s.summary = %q{Redis based remote command executor.}
   s.test_files = [
     "test/teststrap.rb",
      "test/react_test.rb"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kriss 'nu7hatch' Kowalik
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-16 00:00:00 +02:00
+date: 2010-08-17 00:00:00 +02:00
 default_executable: react
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
-description: A simple application that allows remote execution of commands.
+description: A simple application that allows for remote execution of commands.
 email: kriss.kowalik@gmail.com
 executables: 
 - react
@@ -59,6 +59,7 @@ files:
 - README.md
 - Rakefile
 - bin/react
+- examples/commands.yml
 - lib/react.rb
 - react.gemspec
 - test/react_test.rb
@@ -92,7 +93,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Redis based remote commands executor.
+summary: Redis based remote command executor.
 test_files: 
 - test/teststrap.rb
 - test/react_test.rb