hirefireapp 0.0.1 → 0.0.2

data/README.md

@@ -1,5 +1,6 @@
-# HireFireApp.com - The Heroku Worker Monitor
+# HireFire - The Heroku Worker Manager
 
-See the official website for more information!
+HireFire is a hosted service that scales your Heroku web and worker dynos when necessary.
+This allows you to save a lot of money by allowing HireFire to shut down idle workers, and add scalability to both your web as well as your worker dynos.
 
-[http://hirefireapp.com/](http://hirefireapp.com/)
+Visit the [official website](http://hirefireapp.com/) for more information!

data/bin/hirefireapp

@@ -11,7 +11,7 @@ def usage
   puts "Or locally:"
   puts
   puts "  gem install thin"
-  puts "  thin start -p 3000"
+  puts "  [bundle exec] thin start -p 3000"
   puts "  hirefireapp http://127.0.0.1:3000/"
   puts
   puts "SSL Enabled URLs:"

data/hirefireapp.gemspec

@@ -4,17 +4,17 @@ Gem::Specification.new do |gem|
 
   # General configuration / information
   gem.name        = 'hirefireapp'
-  gem.version     = '0.0.1'
+  gem.version     = '0.0.2'
   gem.platform    = Gem::Platform::RUBY
   gem.authors     = 'Michael van Rooijen'
   gem.email       = 'meskyanichi@gmail.com'
   gem.homepage    = 'http://hirefireapp.com/'
-  gem.summary     = %|HireFireApp.com - The Heroku Worker Monitor - Save money and scale at the same time!|
-  gem.description = %|HireFireApp.com - The Heroku Worker Monitor - Save money and scale at the same time! We monitor your applications by the minute!|
+  gem.summary     = %|HireFireApp.com - The Heroku Worker Manager - Save money and scale at the same time!|
+  gem.description = %|HireFireApp.com - The Heroku Worker Manager - Save money and scale at the same time! We monitor your applications by the minute!|
 
   # Files and folder that need to be compiled in to the Ruby Gem
   gem.files         = %x[git ls-files].split("\n")
   gem.executables   = ['hirefireapp']
   gem.require_path  = 'lib'
 
-end
+end

data/lib/hirefireapp/middleware.rb

@@ -6,19 +6,20 @@ module HireFireApp
     ##
     # Initialize the Rack Middleware by setting the app instance
     # as well as allowing HireFire to request information via the token uri.
+    #
     def initialize(app)
       @app   = app
       @token = ENV['HIREFIREAPP_TOKEN']
     end
 
     ##
-    # If we are currently in the Heroku environment, and the path to the HireFire info uri
-    # has been requested (and the token belongs to the app) then we'll calculate the amount of
-    # jobs that are currently pending (either Delayed Job with Active Record / Mongoid or Resque with Redis).
+    # Simple router. If a request come in at the "test" url (the url to test if HireFire is properly installed)
+    # then we return information about the current environment (orm, odm, kvs, worker library, etc). Returns "Not Found"
+    # and specified "what wasn't found" in case the environment isn't complete (e.g. the worker library could not be found).
+    #
+    # HireFireApp.com will always ping to the "info?" url. This will return JSON format containing the current job queue
+    # for the given worker library, as well as the queue_wait_time
     #
-    # Once the job_count has been determined, we build a simple JSON string object and
-    # create a rack-based json response with 200 status. This will be returned to the HireFire service
-    # in order to determine what actions to take in terms of scaling up or down.
     def call(env)
       @env = env
 
@@ -32,22 +33,35 @@ module HireFireApp
     end
 
     ##
-    # Response body
+    # Response body - This is the data that gets returned to the requester
+    # depending on which URL was requested.
+    #
     def each(&block)
       if test?
         block.call "[HireFireApp: #{ok}] Worker: #{worker} - Mapper: #{mapper}"
       elsif info?
-        block.call %|{"job_count":#{job_count || 'null'}}|
+        block.call %|{"job_count":#{job_count || 'null'}, "queue_wait_time":#{queue_wait_time}}|
       end
     end
 
     private
 
+    ##
+    # Returns the time it took to allow the request
+    # (delayed by the queue) in miliseconds
+    #
+    # @request [Integer] the queue wait time in miliseconds
+    #
+    def queue_wait_time
+      @env["HTTP_X_HEROKU_QUEUE_WAIT_TIME"].to_i
+    end
+
     ##
     # Counts the amount of jobs that are currently queued
     # and show be processed as soon as possible (aka the ones that are pending)
     #
     # @returns [Fixnum, nil] job_count returns nil if something went wrong
+    #
     def job_count
       begin
         if defined?(Delayed::Worker)
@@ -69,6 +83,7 @@ module HireFireApp
     # exist, and we'll have to use the old :conditions hash notation.
     #
     # @returns [Fixnum] delayed_job_count the amount of jobs currently pending
+    #
     def count_delayed_job
       if defined?(ActiveRecord) and Delayed::Worker.backend.to_s =~ /ActiveRecord/
         if defined?(ActiveRecord::Relation)
@@ -95,6 +110,7 @@ module HireFireApp
     #
     # @returns [Fixnum] resque_job_count
     #  the number of jobs pending + the amount of workers currently working
+    #
     def count_resque
       Resque.info[:pending].to_i + Resque.info[:working].to_i
     end
@@ -103,6 +119,7 @@ module HireFireApp
     # Returns the name of the mapper, or "Not Found" if not found
     #
     # @returns [String]
+    #
     def mapper
       if defined?(Redis) and defined?(Resque)
         "Redis"
@@ -123,6 +140,7 @@ module HireFireApp
     # Returns the name of the worker type, or "Not Found" if not found
     #
     # @returns [String]
+    #
     def worker
       if defined?(Delayed::Job)
         "Delayed Job"
@@ -137,6 +155,7 @@ module HireFireApp
     # Returns "OK" if both the mapper and worker were found
     #
     # @returns [String]
+    #
     def ok
       if mapper =~ /Not Found/ or worker =~ /Not Found/
         "Incomplete"
@@ -149,6 +168,7 @@ module HireFireApp
     # Returns true if the REQUEST_PATH matches the test url
     #
     # @returns [String]
+    #
     def test?
       @env['REQUEST_PATH'] == "/hirefireapp/test"
     end
@@ -157,6 +177,7 @@ module HireFireApp
     # Returns true if the REQUEST_PATH matches the info url
     #
     # @returns [String]
+    #
     def info?
       @env['REQUEST_PATH'] == "/hirefireapp/#{@token}/info"
     end

metadata

@@ -2,7 +2,7 @@
 name: hirefireapp
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -10,11 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-23 00:00:00 +02:00
+date: 2011-07-25 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: HireFireApp.com - The Heroku Worker Monitor - Save money and scale at the same time! We monitor your applications by the minute!
+description: HireFireApp.com - The Heroku Worker Manager - Save money and scale at the same time! We monitor your applications by the minute!
 email: meskyanichi@gmail.com
 executables: 
 - hirefireapp
@@ -57,6 +57,6 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: HireFireApp.com - The Heroku Worker Monitor - Save money and scale at the same time!
+summary: HireFireApp.com - The Heroku Worker Manager - Save money and scale at the same time!
 test_files: []