healthety 0.0.4 → 0.0.5

data/README.md

@@ -4,24 +4,65 @@ The Ruby Worker sends JSON wrapped data via UDP packets to a given server at a d
 
 ## Installation
 
-    $ gem install healthety
+```
+$ gem install healthety
+```
 
 ## Usage
 
-    require "healthety"
+``` ruby
+require "healthety"
 
-    Healthety.workers do
-      server "127.0.0.1"
-      port 41234
+Healthety.workers do
+  server "127.0.0.1"
+  port 41234
 
-      worker :load_average do
-        interval 0.5
-        # Gets load average with a system call (Mac OS X)
-        value `w | head -n1 | cut -f4 -d":" | cut -f2 -d" "`.to_f
-      end
+  worker :load_average do
+    interval 0.5
+    # Gets load average with a system call (Mac OS X)
+    value `w | head -n1 | cut -f4 -d":" | cut -f2 -d" "`.to_f
+  end
 
-      worker :memory do
-        interval 2
-        value rand(10)
-      end
+  worker :random do
+    interval 2
+    value rand(10)
+  end
+end
+```
+
+### Defining helpers
+
+If you want to define some helper methods create a new module first. Note the `helpers` method at the end to include your module into the workers. In this case a new file called `connection_helper.rb` contains the MySQL connection handling.
+
+``` ruby
+require "mysql2"
+
+module Healthety
+  module ConnectionHelper
+    def mysql
+      @client ||= Mysql2::Client.new(:host => "localhost", :username => "root")
     end
+  end
+
+  helpers ConnectionHelper
+end
+```
+
+In your workers you can now use the helper method. Since the MySQL connection gets saved into a class instance variable the connection gets established only once.
+
+``` ruby
+$:.unshift File.dirname(__FILE__)
+
+require "healthety"
+require "connection_helper"
+
+Healthety.workers do
+  server "127.0.0.1"
+  port 41234
+
+  worker :user_count do
+    interval 5
+    value mysql.query("SELECT COUNT(*) AS count FROM users").first["count"]
+  end
+end
+```

data/lib/healthety/healthety.rb

@@ -22,6 +22,12 @@ module Healthety
     @workers << Worker.new(name, &block)
   end
 
+  # Makes the methods defined in the helper modules given in `extensions`
+  # available to the workers.
+  def helpers(*extensions)
+    Worker.class_eval { include(*extensions) } if extensions.any?
+  end
+
   def start
     puts message
     transmission = Transmission.new(@server, @port)

data/lib/healthety/version.rb

@@ -1,3 +1,3 @@
 module Healthety
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/unit/healthety_spec.rb

@@ -1,12 +1,16 @@
 require "spec_helper"
 
 module Healthety
+  module TestHelper
+    def test; end
+  end
+
   describe Healthety do
-    it "should start" do
-      $stdout = StringIO.new
-      Thread.any_instance.stubs(:join)
-      UDPSocket.any_instance.stubs(:send)
+    $stdout = StringIO.new
+    Thread.any_instance.stubs(:join)
+    UDPSocket.any_instance.stubs(:send)
 
+    it "should start" do
       expect do
         Healthety.workers do
           server "127.0.0.1"
@@ -19,5 +23,21 @@ module Healthety
         end
       end.to be_true
     end
+
+    it "should inclde helpers" do
+      Healthety.helpers TestHelper
+
+      expect do
+        Healthety.workers do
+          server "127.0.0.1"
+          port 41234
+
+          worker :test do
+            interval 0.5
+            value test
+          end
+        end
+      end.to be_true
+    end
   end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: healthety
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Martin Jagusch
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-26 00:00:00 +02:00
-default_executable: 
+date: 2011-04-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -26,11 +20,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
         version: 1.5.1
   type: :runtime
   version_requirements: *id001
@@ -42,11 +31,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
         version: 2.5.0
   type: :development
   version_requirements: *id002
@@ -58,11 +42,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 9
-        - 12
         version: 0.9.12
   type: :development
   version_requirements: *id003
@@ -89,7 +68,6 @@ files:
 - spec/unit/healthety_spec.rb
 - spec/unit/transmission_spec.rb
 - spec/unit/worker_spec.rb
-has_rdoc: true
 homepage: http://github.com/healthety/ruby_worker
 licenses: []
 
@@ -103,23 +81,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: The Ruby Worker sends JSON data via UDP packets to a given host.