cruisecontrolrb_to_hipchat 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3a4f5d9a20f3fbddddcb6384b120cfe03a92f66
-  data.tar.gz: a72a8694de06e3f4b81a273d8346e00af53e19a4
+  metadata.gz: bb399bb7cbe2989220930dba9167277cbc0dee6c
+  data.tar.gz: 016d62ff0fd3922cb76be40e4cba1f10426257bf
 SHA512:
-  metadata.gz: 922963784bf5fd209f9bdef8e97c1deae19067d0873f28df1418229262494a83f8f498375964a0868ec285b3be1e5fd6e47252f0e614d0d3bdbdbc7fc9880aff
-  data.tar.gz: 6ef87dfc667c106a55ff2346bb320ae0a8716d81952cf1470c4d26375d73eb8ee9dff31cea812a1694f30bb357eaaaa6f7b613801971f9509a02ab95db68edd5
+  metadata.gz: b7c80351256e5e0cfc878830740aba4f7358d3f9b0f468a20c2995d762770fd240526d91143212cd573eb5f1e760b8a5ae239b61a8d7ac96d3f9bafa23008c21
+  data.tar.gz: 8b492e809013e82f1e882f4679443e3b1b64c9b797fb9e9d9ce57c8292145a6de0af1b29c5a891be8ec3830028bb8953a86b3d788e0ac44d236418d36d8f2fc4

data/README.md

@@ -2,34 +2,76 @@ This is a little Sinatra app notifies Hipchat of any changes in the build status
 
 Heroku-ready! Just follow these steps:
 
-1. Grab a copy of the source
+## Installation
 
-        git clone git@github.com:andrewpbrett/cruisecontrolrb_to_hipchat.git
+Install as a gem
 
-2. Create a Heroku app
+    gem install cruisecontrolrb_to_hipchat
 
-        heroku create myapp
+or add to your Gemfile
 
-3. Required configuration
-				
-				heroku config:add HIPCHAT_AUTH_TOKEN=your_auth_token
-				heroku config:add HIPCHAT_ROOM_ID=your_room_id
-				heroku config:add CC_URL=your_cruise_control_url
+```
+# Gemfile
+gem "cruisecontrolrb_to_hipchat"
+```
 
-4. Optional configuration:
+and run `bundle install`
 
-				Basic auth for your CruiseControlrb install (recommended):
-				
-				heroku config:add CC_USERNAME=your_username
-				heroku config:add CC_PASSWORD=your_password
-				
-				heroku config:add POLLING_INTERVAL							 # polling interval in minutes. defaults to 1 minute.
-				heroku config:add HIPCHAT_FROM=cruise-control    # who the messages are "from" in hipchat. defaults to 'cruise-control'		
+or from source
 
-5. Deploy to Heroku
+```
+git clone git@github.com:zumobi/cruisecontrolrb_to_hipchat.git
+cd cruisecontrolrb_to_hipchat
+bundle install
+rake build
+```
 
-        git push heroku master
+## Configuration
 
-6. Set up something to ping your app regularly in order to [prevent it from idling](http://stackoverflow.com/questions/5480337/easy-way-to-prevent-heroku-idling). The New Relic add-on seems to do the trick, but so does a cron job, pingdom, etc., etc., etc. ...
+Make sure to define the following environment variable as they are required in either
+you `.profile` or `/etc/profile.d/cruisecontrolrc_to_hipchat.sh` (for all users)
 
-7. Have a beer while you wait for your first notification in Hipchat.
+```
+HIPCHAT_AUTH_TOKEN=your_auth_token
+HIPCHAT_ROOM_ID=your_room_id
+CC_URL=your_cruise_control_url
+```
+
+The following are optionals
+
+Basic auth for your CruiseControlrb install (recommended):
+
+```				
+CC_USERNAME=your_username
+CC_PASSWORD=your_password
+```			
+
+```
+POLLING_INTERVAL							 # polling interval in minutes. defaults to 1 minute.
+HIPCHAT_FROM=cruise-control    # who the messages are "from" in hipchat. defaults to 'cruise-control'		
+```
+
+## Running
+
+As this gem uses dante, options are best describes [here](http://github.com/nesquena/dante) but here are some very simple
+setup
+
+### Run in foreground and STDOUT output (to test most likely)
+
+```
+cruisecontrolrb_to_hipchat
+```
+
+### Run in foreground with logs 
+
+```
+cruisecontrolrb_to_hipchat -l /var/log/myapp.log
+```
+
+### Run as a daemon with a pid file and logs
+
+```
+cruisecontrolrb_to_hipchat -d -P /var/run/myapp.pid -l /var/log/myapp.log
+```
+
+<img width="100px" src="http://1.bp.blogspot.com/-VYkLIx6dPTE/TapmnuECsJI/AAAAAAAAALY/L3c1FY4v--w/s1600/looney_tunes_thats_all_folks.jpg"  />

data/cruisecontrolrb_to_hipchat.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = CruisecontrolrbToHipchat::VERSION
   spec.authors       = ["epinault"]
   spec.email         = ["emmanuel.pinault@zumobi.com"]
-  spec.summary       = %q{A simple daemon to report last build status from cruisecontrol}
-  spec.description   = %q{Inspired from https://github.com/andrewpbrett/cruisecontrolrb_to_hipchat but with support of more recent api and multiple projects}
+  spec.summary       = %q{A simple daemon to report last build status of projects and activities from cruisecontrol}
+  spec.description   = %q{A simple daemon to report last build status of projects and activities from cruisecontrol. Inspired from https://github.com/andrewpbrett/cruisecontrolrb_to_hipchat but with support of more recent api and multiple projects}
   spec.homepage      = "http://github.com/zumobi/cruisecontrolrb_to_hipchat"
   spec.license       = "MIT"
 

data/lib/cruisecontrolrb_to_hipchat/version.rb

@@ -1,3 +1,3 @@
 module CruisecontrolrbToHipchat
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cruisecontrolrb_to_hipchat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - epinault
@@ -108,7 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Inspired from https://github.com/andrewpbrett/cruisecontrolrb_to_hipchat
+description: A simple daemon to report last build status of projects and activities
+  from cruisecontrol. Inspired from https://github.com/andrewpbrett/cruisecontrolrb_to_hipchat
   but with support of more recent api and multiple projects
 email:
 - emmanuel.pinault@zumobi.com
@@ -153,5 +154,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A simple daemon to report last build status from cruisecontrol
+summary: A simple daemon to report last build status of projects and activities from
+  cruisecontrol
 test_files: []