hirefire-resource 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.swp
+*.swo
+*.gem

data/README.md

@@ -0,0 +1,80 @@
+# [HireFire](http://hirefireapp.com/) - The Heroku Dyno Manager
+
+*Note: This gem currently only applies to users that are using the new HireFire beta program.
+Once out of beta, this will become the default gem for new users.*
+
+HireFire is a hosted service that manages / autoscales your [Heroku](http://heroku.com/) dynos.
+
+It supports the following stacks:
+
+* Celadon Cedar
+* Badious Bamboo
+* Argent Aspen
+
+It supports practically any worker library. We provide out-of-the-box support for:
+
+* Delayed Job
+* Resque
+* Qu
+* QueueClassic
+
+*Note that you can write your own worker queue logic for almost any other worker library as well.
+HireFire can scale multiple individual worker libraries at the same time, as well as multiple individual queues for any worker library.*
+
+It supports practically any Rack-based application or framework, such as:
+
+* Ruby on Rails
+* Sinatra
+* Padrino
+* Bare Rack Apps
+
+We provide convenient macros for the above mentioned worker libraries to calculate the queue size for each of them.
+If you wish to conribute more macros for other existing worker libraries feel free to send us a pull request.
+
+Here is an example with Ruby on Rails 3. First, add the gem to your `Gemfile`:
+
+```ruby
+gem "hirefire-resource"
+```
+
+Then, all you have to do is create an initializer in `config/initializers/hirefire.rb` and add the following:
+
+```ruby
+HireFire::Resource.configure do |config|
+  config.dyno(:resque_worker) do
+    HireFire::Macro::Resque.queue
+  end
+
+  config.dyno(:dj_worker) do
+    HireFire::Macro::Delayed::Job.queue
+  end
+end
+```
+
+This will allow HireFire to read out the queues for both Resque and Delayed Job. By default these macros will count all the queues combined if you are using multiple
+different queues for each worker library. You can also pass in specific queues to count, like so:
+
+```ruby
+HireFire::Resource.configure do |config|
+  config.dyno(:resque_worker) do
+    HireFire::Macro::Resque.queue(:mail, :backup)
+  end
+
+  config.dyno(:dj_worker) do
+    HireFire::Macro::Delayed::Job.queue(:encode, :compress)
+  end
+end
+```
+
+This will tell HireFire to count the total amount of jobs from the `mail` and `backup` queue for the `resque_worker` dyno, and the `encode` and `compress` queues for the `dj_worker` dyno.
+The `resque_worker` refers to the `resque_worker` in your `Procfile`, and the `dj_worker` refers to the `dj_worker` in the `Procfile`. In this case the `Procfile` would look something like this:
+
+```
+resque_worker: QUEUE=mail,backup bundle exec rake resque:work
+dj_worker: QUEUES=encode,compress bundle exec rake jobs:work
+```
+
+Now that HireFire will scale both of the these dyno types based on their individual queue sizes. To customize how they scale, log in to the HireFire web interface.
+
+Visit the [official website](http://hirefireapp.com/) for more information!
+

data/bin/hirefire

@@ -0,0 +1,4 @@
+#! /usr/bin/env ruby
+
+require File.expand_path("../../lib/hirefire/cli", __FILE__)
+

data/bin/hirefireapp

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+puts "Please use the `hirefire` utility instead of the `hirefireapp` utility."
+exit 1
+

data/hirefire-resource.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name        = "hirefire-resource"
+  gem.version     = "0.0.1"
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = "Michael van Rooijen"
+  gem.email       = "michael@hirefireapp.com"
+  gem.homepage    = "http://hirefireapp.com/"
+  gem.summary     = "HireFire - The Heroku Dyno Manager"
+  gem.description = "HireFire - The Heroku Dyno Manager"
+
+  gem.files         = %x[git ls-files].split("\n")
+  gem.executables   = ["hirefire", "hirefireapp"]
+  gem.require_path  = "lib"
+end
+

data/lib/hirefire-resource.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+HIREFIRE_PATH = File.expand_path("../hirefire", __FILE__)
+
+%w[middleware resource].each do |file|
+  require "#{HIREFIRE_PATH}/#{file}"
+end
+
+%w[delayed_job resque qu qc].each do |file|
+  require "#{HIREFIRE_PATH}/macro/#{file}"
+end
+
+require "#{HIREFIRE_PATH}/railtie" if defined?(Rails::Railtie)
+

data/lib/hirefire/cli.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require "open-uri"
+require "openssl"
+
+OpenSSL::SSL.send(:remove_const, :VERIFY_PEER)
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+def usage
+  puts(<<-EOS)
+
+Usage:
+
+  hirefire http://mydomain.com/
+
+Or locally:
+
+  gem install thin
+  [bundle exec] thin start -p 3000
+  hirefire http://127.0.0.1:3000/
+
+SSL Enabled URLs:
+
+  hirefire https://mydomain.com/
+
+EOS
+end
+
+if (url = ARGV[0]).nil?
+  usage
+else
+  begin
+    response = open(File.join(url, "hirefire", "test")).read
+  rescue
+    puts
+    puts "Error: Could not connect to: #{url}"
+    usage
+    exit 1
+  end
+
+  if response =~ /HireFire/
+    puts response
+  else
+    puts "Error: Could not find HireFire at #{url}."
+    exit 1
+  end
+end
+

data/lib/hirefire/macro/delayed_job.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module HireFire
+  module Macro
+    module Delayed
+      module Job
+        extend self
+
+        # Determines whether `ActiveRecord (3)` or `Mongoid` is being used.
+        # Once determined, it will build the appropriate query criteria in order
+        # to count the amount of jobs in a given queue and return the result.
+        #
+        # Example:
+        #
+        #  HireFire::Macro::Delayed::Job.queue # all queues
+        #  HireFire::Macro::Delayed::Job.queue("email") # only email queue
+        #  HireFire::Macro::Delayed::Job.queue("audio", "video") # audio and video queues
+        #
+        # @param [Array] queues provide one or more queue names, or none for "all".
+        # @return [Integer] the number of jobs in the queue(s).
+        def queue(*queues)
+          queues.flatten!
+
+          if defined?(ActiveRecord)
+            c = ::Delayed::Job
+            c = c.where(:failed_at => nil)
+            c = c.where("run_at <= ?", Time.now.utc)
+            c = c.where(:queue => queues) unless queues.empty?
+            c.count
+          elsif defined?(Mongoid)
+            c = ::Delayed::Job
+            c = c.where(:failed_at => nil)
+            c = c.where(:run_at.lte => Time.now.utc)
+            c = c.where(:queue.in => queues) unless queues.empty?
+            c.count
+          else
+            raise "HireFire could not detect ActiveRecord or Mongoid for HireFire::Macro::Delayed::Job."
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/hirefire/macro/qc.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module HireFire
+  module Macro
+    module QC
+      extend self
+
+      # Queries the PostgreSQL database through QueueClassic in order to
+      # count the amount of jobs in the specified queue.
+      #
+      # Example:
+      #
+      #  HireFire::Macro::QC.queue # counts the `default` queue.
+      #  HireFire::Macro::QC.queue("email") # counts the `email` queue.
+      #
+      # @param [String, Symbol, nil] queue the queue name to count. (default: `default`)
+      # @return [Integer] the number of jobs in the queue(s).
+      def queue(queue = "default")
+        ::QC::Queries.count(queue.to_s)
+      end
+    end
+  end
+end
+

data/lib/hirefire/macro/qu.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module HireFire
+  module Macro
+    module Qu
+      extend self
+
+      # Counts the amount of jobs in the (provided) Qu queue(s).
+      #
+      # Example:
+      #
+      #  HireFire::Macro::Qu.queue # all queues
+      #  HireFire::Macro::Qu.queue("email") # only email queue
+      #  HireFire::Macro::Qu.queue("audio", "video") # audio and video queues
+      #
+      # @param [Array] queues provide one or more queue names, or none for "all".
+      # @return [Integer] the number of jobs in the queue(s).
+      def queue(*queues)
+        queues = ::Qu.backend.queues if queues.empty?
+        queues.flatten.inject(0) { |memo, queue| memo += ::Qu.backend.length(queue); memo }
+      end
+    end
+  end
+end
+

data/lib/hirefire/macro/resque.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module HireFire
+  module Macro
+    module Resque
+      extend self
+
+      # Counts the amount of jobs in the (provided) Resque queue(s).
+      #
+      # Example:
+      #
+      #  HireFire::Macro::Resque.queue # all queues
+      #  HireFire::Macro::Resque.queue("email") # only email queue
+      #  HireFire::Macro::Resque.queue("audio", "video") # audio and video queues
+      #
+      # @param [Array] queues provide one or more queue names, or none for "all".
+      # @return [Integer] the number of jobs in the queue(s).
+      def queue(*queues)
+        return ::Resque.info[:pending].to_i if queues.empty?
+        queues = queues.flatten.map(&:to_s)
+        queues.inject(0) { |memo, queue| memo += ::Resque.size(queue); memo }
+      end
+    end
+  end
+end
+

data/lib/hirefire/middleware.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module HireFire
+  class Middleware
+
+    # Initialize the HireFire::Middleware and store the `app` in `@app`
+    # and `ENV["HIREFIRE_TOKEN"]` in `@token` for convenience.
+    #
+    # @param [ActionDispatch::Routing::RouteSet] app.
+    def initialize(app)
+      @app   = app
+      @token = ENV["HIREFIRE_TOKEN"]
+    end
+
+    # Will respond to the request here if either the `test` or the `info` url was requested.
+    # Otherwise, fall through to the rest of the middleware below HireFire::Middleware.
+    #
+    # @param [Hash] env containing request information.
+    def call(env)
+      @env = env
+
+      if test?
+        [ 200, {"Content-Type" => "text/html"}, self ]
+      elsif info?
+        [ 200, {"Content-Type" => "application/json"}, self ]
+      else
+        @app.call(env)
+      end
+    end
+
+    # Returns text/html when the `test` url is requested.
+    # This is purely to see whether the URL works through the HireFire command-line utility.
+    #
+    # Returns a JSON String when the `info` url is requested.
+    # This url will be requested every minute by HireFire in order to fetch dyno data.
+    #
+    # @return [text/html, application/json] based on whether the `test` or `info` url was requested.
+    def each(&block)
+      if test?
+        block.call "HireFire Middleware Found!"
+      elsif info?
+        block.call(dynos)
+      end
+    end
+
+    private
+
+    # Generates a JSON string based on the dyno data.
+    #
+    # @return [String] in JSON format.
+    def dynos
+      dyno_data = HireFire::Resource.dynos.inject(String.new) do |json, dyno|
+        json << %|,{"name":"#{dyno[:name]}","quantity":#{dyno[:quantity].call || "null"}}|; json
+      end
+
+      "[#{dyno_data.sub(",","")}]"
+    end
+
+    # Returns true if the PATH_INFO matches the test url.
+    #
+    # @return [Boolean] true if the requested url matches the test url.
+    def test?
+      @env["PATH_INFO"] == "/hirefire/test"
+    end
+
+    # Returns true if the PATH_INFO matches the info url.
+    #
+    # @return [Boolean] true if the requested url matches the info url.
+    def info?
+      @env["PATH_INFO"] == "/hirefire/#{@token || "development"}/info"
+    end
+  end
+end

data/lib/hirefire/railtie.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module HireFire
+  class Railtie < ::Rails::Railtie
+    initializer "hirefire.add_middleware" do |app|
+      app.config.middleware.use "HireFire::Middleware"
+    end
+  end
+end

data/lib/hirefire/resource.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module HireFire
+  module Resource
+    extend self
+    attr_accessor :dynos
+
+    # Sets the `@dynos` instance variable to an empty Array to hold all the dyno configuration.
+    #
+    # Example:
+    #
+    #  HireFire::Resource.configure do |config|
+    #    config.dyno(:worker) do
+    #      # Macro or Custom logic for the :worker dyno here..
+    #    end
+    #  end
+    #
+    # @yields [HireFire::Resource] to allow for block-style configuration.
+    def configure
+      @dynos ||= []
+      yield self
+    end
+
+    # Will be used through block-style configuration with the `configure` method.
+    #
+    # @param [Symbol, String] name the name of the dyno as defined in the Procfile.
+    # @param [Proc] block an Integer containing the quantity calculation logic.
+    def dyno(name, &block)
+      @dynos << { :name => name, :quantity => block }
+    end
+  end
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: hirefire-resource
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000 Z
+dependencies: []
+description: HireFire - The Heroku Dyno Manager
+email: michael@hirefireapp.com
+executables:
+- hirefire
+- hirefireapp
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- bin/hirefire
+- bin/hirefireapp
+- hirefire-resource.gemspec
+- lib/hirefire-resource.rb
+- lib/hirefire/cli.rb
+- lib/hirefire/macro/delayed_job.rb
+- lib/hirefire/macro/qc.rb
+- lib/hirefire/macro/qu.rb
+- lib/hirefire/macro/resque.rb
+- lib/hirefire/middleware.rb
+- lib/hirefire/railtie.rb
+- lib/hirefire/resource.rb
+homepage: http://hirefireapp.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: HireFire - The Heroku Dyno Manager
+test_files: []
+has_rdoc: