thincloud-resque 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 New Leaders
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+# Thincloud::Resque
+
+## Description
+
+Rails Engine to provide Resque support for Thincloud applications.
+
+The Thincloud::Resque engine:
+
+* Manages all of the Resque (and Redis) dependencies for your application
+* Initializes the Redis connection and namespace for Resque
+* Configures the Resque Front End (resque-web) to use HTTP Basic authentication
+* Optionally configures `resque_mailer`
+* Provides a Capistrano recipe to link resque-web assets during deployment
+
+
+## Requirements
+
+This gem requires Rails 3.2+ and has been tested on the following versions:
+
+* 3.2
+
+This gem has been tested against the following Ruby versions:
+
+* 1.9.3
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem "thincloud-resque"
+```
+
+* Run `bundle`
+
+Or install it yourself as:
+
+```
+$ gem install thincloud-resque
+```
+
+## Usage
+
+### Configuration
+
+Thincloud::Resque configuration options are available to customize the engine behavior. Available options and their default values:
+
+```ruby
+# Redis connection details
+redis_url         = "unix:///tmp/redis.sock"
+redis_namespace   = "resque:APP_NAME:RAILS_ENV"
+redis_driver      = "ruby"  # make sure to include the gem for your driver
+
+# Authenticaiton details used for the Resque Front End
+web_username      = "thincloud-resque"
+web_password      = "thincloud-resque"
+
+# Environment(s) where Resque::Mailer should be enabled
+mailer_environments = [:production]
+```
+#### Environment Variables
+
+Several of the options will use environment variables when found.
+
+```
+redis_url    -> ENV["REDIS_URL"]
+web_username -> ENV["RESQUE_WEB_USERNAME"]
+web_password -> ENV["RESQUE_WEB_PASSWORD"]
+```
+
+#### Configuration Block
+
+The `Thincloud::Resque` module accepts a `configure` block that takes the same options listed above. This block can be put into an initializer or inside of a `config/environments` file.
+
+```ruby
+Thincloud::Resque.configure do |config|
+  config.redis_url       = "unix:///tmp/my_redis.sock"
+  config.redis_namespace = "my_redis_namespace"
+  config.redis_driver    = "hiredis"
+  # ...
+end
+```
+
+#### Rails Configuration
+
+You can also access the configuration via the Rails configuration object. In fact, the engine uses the Rails config as storage when the block syntax is used. The `Thincloud::Resque::Configuration` object is made available under `config.thincloud.resque`. You can access this configuration in `config/application.rb` or in your `config/environments` files.
+
+```ruby
+# ...
+config.thincloud.resque.redis_url       = "unix:///tmp/redis.sock"
+config.thincloud.resque.redis_namespace = "my_config_namespace"
+config.thincloud.resque.redis_driver    = "hiredis"
+#...
+```
+
+_Note: Configuration values take precendence over environment variables._
+
+#### Mailers
+
+Resque::Mailer is enabled for environments included in the `mailer_environments` array. By default it will be enabled for all mailers in those environments. If you need to selectively enable it for specific mailers you can disable all environments:
+
+```ruby
+config.mailer_environments = []
+```
+
+and, for those mailers that need to background email, add the following line:
+
+```ruby
+include Resque::Mailer
+```
+
+#### Routes
+
+Resque has a built-in Front End Sinatra (resque-web) server that provides access to monitor the Resque server's status. To allow access to the Front End through your app you need to mount the engine in `config/routes.rb`:
+
+```ruby
+mount Thincloud::Resque::Engine => "/resque"
+```
+=> `http://yourapp/resque`
+
+Call this inside a namespace to create a nested route if needed:
+
+```ruby
+namespace :admin do
+  mount Thincloud::Resque::Engine => "/resque"
+end
+```
+
+=> `http://yourapp/admin/resque`
+
+#### Capistrano
+
+To make resque-web assets available to the released application, add the following line to your `deploy.rb` or `Capfile`:
+
+```ruby
+require "thincloud/resque/capistrano"
+```
+
+This adds a recipe called `thincloud:resque:link_assets` that will run after `deploy:update_code`. The recipe links the web assets from the Resque gem directory into your application's public directory.
+
+#### Workers
+
+You'll need Resque workers in order to have any jobs processed. We use `foreman` in our deployments to manage these. Simply add the following line to your `Procfile`:
+
+```
+worker: bundle exec rake environment resque:work RAILS_ENV=$RAILS_ENV QUEUE=*
+```
+
+_This assumes you're running bundler and that you need the environment loaded for these workers. Modify to suit your needs._
+
+## Contributing
+
+1. [Fork it](https://github.com/newleaders/thincloud-resque/fork_select)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. [Create a Pull Request](https://github.com/newleaders/thincloud-resque/pull/new)
+
+
+## License
+
+* Freely distributable and licensed under the [MIT license](http://newleaders.mit-license.org/2012/license.html).
+* Copyright (c) 2012 New Leaders ([opensource@newleaders.com](opensource@newleaders.com))
+* [https://newleaders.com](https://newleaders.com)
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+begin
+  require "rdoc/task"
+rescue LoadError
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Thincloud::Resque"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+
+
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/tasks/thincloud-resque_tasks.rake

@@ -0,0 +1,2 @@
+# Make resque tasks available to the application
+require "resque/tasks"

data/lib/thincloud-resque.rb

@@ -0,0 +1,8 @@
+require "thincloud/resque/version"
+require "thincloud/resque/configuration"
+require "thincloud/resque/engine"
+
+module Thincloud
+  module Resque
+  end
+end

data/lib/thincloud/resque/capistrano.rb

@@ -0,0 +1,27 @@
+module Capistrano
+  # We only want to hook onto Capistrano when the Configuration module is
+  # present. Hat tip to the rvm-capistrano gem.
+  if const_defined? :Configuration
+    Configuration.instance(true).load do
+      namespace :thincloud do
+        namespace :resque do
+
+          desc "Link resque-web assets to release path"
+          task :link_assets, roles: :app do
+            resque_release_path = "#{release_path}/public/admin/resque"
+
+            assets_path = "#{shared_path}/bundle/ruby/1.9.1/gems/resque-*/lib/"
+            assets_path += "resque/server/public/*"
+
+            # setup resque assets
+            run "mkdir -p #{resque_release_path}; " +
+                "ln -nfs #{assets_path} #{resque_release_path}"
+          end
+
+        end
+      end
+
+      after "deploy:update_code", "thincloud:resque:link_assets"
+    end
+  end
+end

data/lib/thincloud/resque/configuration.rb

@@ -0,0 +1,36 @@
+module Thincloud
+  module Resque
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield configuration if block_given?
+      configuration
+    end
+
+    # Public: Configuration options for the Thincloud::Resque module
+    class Configuration
+      attr_accessor :redis_url
+      attr_accessor :redis_namespace
+      attr_accessor :redis_driver
+      attr_accessor :web_username
+      attr_accessor :web_password
+      attr_accessor :mailer_environments
+
+      def initialize
+        url       = ENV["REDIS_URL"] || "unix:///tmp/redis.sock"
+        username  = ENV["RESQUE_WEB_USERNAME"] || "thincloud-resque"
+        password  = ENV["RESQUE_WEB_PASSWORD"] || "thincloud-resque"
+
+        @redis_url       ||= url
+        @redis_namespace ||= "resque"
+        @redis_driver    ||= "ruby"
+        @web_username    ||= username
+        @web_password    ||= password
+        @mailer_environments ||= [:production]
+      end
+    end
+  end
+end

data/lib/thincloud/resque/engine.rb

@@ -0,0 +1,71 @@
+module Thincloud
+  module Resque
+    # Public: Thincloud Resque Engine
+    class Engine < ::Rails::Engine
+
+      # convenience method for engine options / configuration
+      def configuration
+        Thincloud::Resque.configuration
+      end
+
+      # initialize the configuration so it is available during rails init
+      ActiveSupport.on_load :before_configuration do
+        app_name  = Rails.application.class.name.deconstantize.underscore
+        rails_env = Rails.env || "development"
+
+        unless config.respond_to? :thincloud
+          config.thincloud = ActiveSupport::OrderedOptions.new
+        end
+
+        config.thincloud.resque ||= Thincloud::Resque.configure do |c|
+          c.redis_namespace = "resque:#{app_name}:#{rails_env}"
+        end
+      end
+
+      initializer "thincloud.resque.environment" do
+        require "redis"
+        require "resque"
+
+        ::Resque.redis = ::Redis.new({
+          url:    configuration.redis_url,
+          driver: configuration.redis_driver
+        })
+
+        ::Resque.redis.namespace = configuration.redis_namespace
+      end
+
+      initializer "thincloud.resque.server" do
+        require "resque/server"
+        require "resque-cleaner"
+
+        # use http basic auth for resque-web
+        ::Resque::Server.use ::Rack::Auth::Basic do |username, password|
+          username = configuration.web_username
+          password = configuration.web_password
+        end
+
+        ::Resque::Server.set :show_exceptions, true
+
+        # set the Resque::Server sinatra app as the endpoint for this engine
+        self.class.endpoint ::Resque::Server
+      end
+
+      initializer "thincloud.resque.mailer", after: "finisher_hook" do
+        if configuration.mailer_environments.include?(Rails.env.to_sym)
+          require "resque_mailer"
+
+          # Make sure that Resque::Mailer ends up at the correct place
+          # in the inheritance chain
+          ActiveSupport.on_load :action_mailer do
+            def self.inherited(subclass)
+              subclass.send :include, ::Resque::Mailer
+              super
+            end
+          end
+
+        end
+      end
+
+    end
+  end
+end

data/lib/thincloud/resque/resqueable.rb

@@ -0,0 +1,24 @@
+module Thincloud
+  module Resque
+
+    module Resqueable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def resqueable(options={})
+          instance_variable_set :"@queue",
+            (options[:queue] || self.new.class.collection.name).to_sym
+        end
+
+        def perform(id, method, *args)
+          find(id).send(method, *args)
+        end
+      end
+
+      def async(method, *args)
+        Resque.enqueue(self.class, id, method, *args)
+      end
+    end
+
+  end
+end

data/lib/thincloud/resque/version.rb

@@ -0,0 +1,5 @@
+module Thincloud
+  module Resque
+    VERSION = "0.1.0"
+  end
+end

data/test/ci/before_script.sh

@@ -0,0 +1,2 @@
+cd test/dummy
+RAILS_ENV=test bundle exec rake db:setup

data/test/ci/ci_runner.sh

@@ -0,0 +1,8 @@
+engine=$(ruby -e 'puts RUBY_ENGINE')
+
+case $engine in
+  "ruby" )
+    bundle exec rake test && bundle exec cane;;
+  * )
+    bundle exec rake test;;
+esac

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.