sponges 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6cece34aa41d2f8dad71f3d2135e7abe8aea29c
-  data.tar.gz: 9c07a08501a29f2c51c4b46d02ac3216aebfd11e
+  metadata.gz: 08f5c47703d30df8dc08b6e3982cdc2093890f34
+  data.tar.gz: 6d9af0ec47db5670cfb51287d92343698e8b06fc
 SHA512:
-  metadata.gz: 163974d2f7704a4c564e6ec237de28daf0ce83ee5e2d25d3f984a3debb2162dc0442dcc66349bcabbc0f7cc227fd951d65d088f2f0d1bf128d5f8fbbff427c7c
-  data.tar.gz: a60e3ae1fcffd326f4863db94b4d9005762eea6816736b03ce7250a28bba5fae9c77e174a4965ff27218c520ba943c6d781d5cf7b38719d9c990f49eac1d6750
+  metadata.gz: 3b10980701ade47d210a5b9df3e7c6ca3281d9594f19702f5811211d839f80100eaca8a6705e27b237dcac32f9ceecdb31ca15573f0623fed897b5efcdde1ebc
+  data.tar.gz: 6a66267ddf49b8e9ee0486d8058874c5df696b01933ce18c0551210e49c9371079d6fcebafe300b832a7e67e07b275470f58d4092415130422816dbcb7740149

data/README.md

@@ -13,6 +13,7 @@ to work is your job. :)
 Basically, sponges is a ruby supervisor that forks processes and controls their
 execution and termination. For example the following will start a supervision
 daemon and 8 processes of  "a_worker".
+
 ```bash
 ruby a_worker.rb start -d -s 8
 ```
@@ -69,10 +70,11 @@ class Worker
 end
 
 Sponges.configure do |config|
-  config.logger        = MyCustomLogger.new   # optionnal
-  config.redis         = Redis.new            # optionnal
-  config.size          = 3
-  config.daemonize     = true
+  config.logger            = MyCustomLogger.new   # optionnal
+  config.redis             = Redis.new            # optionnal
+  config.size              = 3                    # optionnal, default to cpu's size
+  config.daemonize         = true                 # optionnal, default to false
+  config.port              = 5032                 # optionnal, default to 5032
   config.after_fork do
     puts "Execute code when a child process is created"
   end
@@ -146,6 +148,58 @@ Show a list of workers and their children.
 ruby example.rb list
 ```
 
+## Http supervision
+
+sponges provides an http interface to supervise pool's activity, and to expose
+pids. Http supervision can be enable in configuration:
+
+
+``` ruby
+Sponges.configure do |config|
+  config.port            = 3333
+end
+```
+
+By default, sponges listens on port 5032, and responds in json. Here is an
+example of response:
+
+``` javascript
+{
+  "supervisor":{
+    "pid":11537,
+    "pctcpu":0.0,
+    "pctmem":0.22,
+    "created_at":"2013-03-05 15:21:04 +0100"
+  },
+  "children":[
+    {
+      "pid":11540,
+      "pctcpu":0.0,
+      "pctmem":0.21,
+      "created_at":"2013-03-05 15:21:04 +0100"
+    },
+    {
+      "pid":11543,
+      "pctcpu":0.0,
+      "pctmem":0.21,
+      "created_at":"2013-03-05 15:21:04 +0100"
+    },
+    {
+      "pid":11546,
+      "pctcpu":0.0,
+      "pctmem":0.21,
+      "created_at":"2013-03-05 15:21:04 +0100"
+    },
+    {
+      "pid":11549,
+      "pctcpu":0.0,
+      "pctmem":0.21,
+      "created_at":"2013-03-05 15:21:04 +0100"
+    }
+  ]
+}
+```
+
 ## Stores
 
 sponges can store pids in memory or in redis. Memory is the default store. The
@@ -155,7 +209,7 @@ To select the redis store, you need to add `nest` to your application's
 Gemfile, and do the following.
 
 ``` ruby
-gem "sponges"
+gem "nest"
 ```
 
 ``` ruby
@@ -166,16 +220,6 @@ end
 
 ## Roadmap
 
-### Version 0.6
-
- * Deprecation notice about Redis store removal
-
-
-### Version 0.7
-
- * Inclusion of Http supervision
-
-
 ### Version 1.0
 
  * Removal of Redis store

data/lib/sponges.rb

@@ -4,8 +4,13 @@ require 'socket'
 require 'logger'
 require 'machine'
 require 'forwardable'
+require 'socket'
+require 'json'
+require_relative 'sponges/version'
 require_relative 'sponges/configuration'
 require_relative 'sponges/handler'
+require_relative 'sponges/response'
+require_relative 'sponges/listener'
 require_relative 'sponges/supervisor'
 require_relative 'sponges/runner'
 require_relative 'sponges/commander'

data/lib/sponges/configuration.rb

@@ -5,7 +5,8 @@ module Sponges
   class Configuration
     class << self
       ACCESSOR = [:worker_name, :worker, :logger, :redis, :size,
-        :daemonize, :after_fork, :timeout, :gracefully, :store
+        :daemonize, :after_fork, :timeout, :gracefully, :store,
+        :port
       ]
       attr_accessor *ACCESSOR
 
@@ -32,6 +33,10 @@ module Sponges
         @store || :memory
       end
 
+      def port
+        @port || 5032
+      end
+
       def redis
         @redis ||= Redis.new.tap { warn_redis }
       end
@@ -44,6 +49,7 @@ module Sponges
       def warn_redis
         Sponges.logger.warn "Redis's store will be removed in version 1.0!"
       end
+
     end
   end
 

data/lib/sponges/handler.rb

@@ -2,6 +2,7 @@
 module Sponges
   class Handler
     extend Forwardable
+
     attr_reader :supervisor, :queue, :notifier
 
     def initialize(supervisor)

data/lib/sponges/listener.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Sponges
+  class Listener
+    attr_reader :supervisor
+    CRLF = "\r\n"
+
+    def initialize(supervisor)
+      @supervisor = supervisor
+    end
+
+    def call
+      Socket.tcp_server_loop("0.0.0.0", port) {|c| handle_connection c }
+    end
+
+    private
+
+    def port
+      Sponges::Configuration.port
+    end
+
+    def handle_connection(connection)
+      response = Response.new(supervisor).to_json
+      connection.write headers(response)
+      connection.write response
+      connection.close
+    rescue Errno::EPIPE
+      # Resist to ping
+    end
+
+    def headers(response)
+      [
+        "HTTP/1.1 200 OK",
+        "Date: #{Time.now.utc}",
+        "Status: OK",
+        "Server: Sponges #{Sponges::VERSION} #{supervisor.name} edition",
+        "Content-Type: application/json; charset=utf-8",
+        "Content-Length: #{response.length}",
+        CRLF
+      ].join(CRLF)
+    end
+
+  end
+end

data/lib/sponges/response.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Sponges
+  class Response
+    attr_reader :supervisor
+
+    def initialize(supervisor)
+      @supervisor = supervisor
+    end
+
+    def to_json
+      as_json.to_json
+    end
+
+    def as_json(opts={})
+      {
+        supervisor: process_information(supervisor.pid),
+        children: children_information
+      }
+    end
+
+    private
+
+    def process_information(pid)
+      info = Machine::ProcessStatus.new(pid)
+      {
+        pid:         pid,
+        pctcpu:      info.pctcpu,
+        pctmem:      info.pctmem,
+        created_at:  info.created_at
+
+      }
+    end
+
+    def children_information
+      supervisor.children_pids.map do |pid|
+        process_information(pid)
+      end
+    end
+
+  end
+end
+

data/lib/sponges/supervisor.rb

@@ -1,7 +1,10 @@
 # encoding: utf-8
 module Sponges
   class Supervisor
-    attr_reader :store, :name, :options, :handler
+    extend Forwardable
+    attr_reader :store, :name, :options, :handler, :listener
+    def_delegator :@store, :supervisor_pid, :pid
+    def_delegator :@store, :children_pids
 
     def initialize(name, options, store, block)
       @name, @options, @store, @block = name, options, store, block
@@ -10,6 +13,7 @@ module Sponges
       store.register Process.pid
       @children_seen = 0
       @handler = Handler.new self
+      @listener = Listener.new(self)
     end
 
     def start
@@ -18,8 +22,8 @@ module Sponges
       options[:size].times do
         handler.push :TTIN
       end
-      Sponges.logger.info "Supervisor started, waiting for messages."
-      sleep
+      Sponges.logger.info "Supervisor started, waiting for messages, listening on port #{Sponges::Configuration.port}"
+      listener.call
     rescue SystemExit => exception
       raise exception
     rescue Exception => exception

data/lib/sponges/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Sponges
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sponges
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - chatgris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
@@ -28,16 +28,16 @@ dependencies:
   name: machine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +69,8 @@ files:
 - lib/sponges/commander.rb
 - lib/sponges/configuration.rb
 - lib/sponges/handler.rb
+- lib/sponges/listener.rb
+- lib/sponges/response.rb
 - lib/sponges/runner.rb
 - lib/sponges/store.rb
 - lib/sponges/store/memory.rb