thredded_resque 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.mkdn

@@ -0,0 +1,34 @@
+# Thredded + Redis + Resque
+
+Out of the gate thredded does require anything other than a recent version of
+ruby, and postgres and it works fine as is. There is a need over time to speed
+things up with something like a background job processing queue, or a nosql
+store like redis to help speed things up.
+
+This gem helps do that. Using [resque] and [resque_mailer] it automatically
+updates all mailers to push into resque instead of sending immediately. For now
+that's all it does, but in time it will do more.
+
+[resque]: https://github.com/defunkt/resque
+[resque_mailer]: https://github.com/zapnap/resque_mailer
+
+## Installation
+
+* Dependencies:
+  1. Redis must be installed. If you're on a mac: `brew install redis` and follow the directions.
+  2. Use [foreman] ([railscast episode]) locally, and have a Procfile set up (there is a default Procfile in the thredded repo). This isn't a hard and fast requirement but it will certainly make things easier.
+* Add this gem into your thredded app **Gemfile** - `gem 'thredded_resque'`
+* Install with - `bundle install`
+* Run the generator - `rails g thredded_resque:install`. This will append a worker to your Procfile.
+* Start your local server and worker with foreman (`foreman start`) or start both of them
+  individually: 
+
+```
+bundle exec rails server
+bundle exec rake environment resque:work QUEUE='*'
+```
+
+[foreman]: https://github.com/ddollar/foreman
+[railscast episode]: http://railscasts.com/episodes/281-foreman
+
+## Using with heroku

data/Rakefile

@@ -0,0 +1,27 @@
+#!/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    = 'ThreddedResque'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/config/initializers/can_access_resque.rb

@@ -0,0 +1,6 @@
+class CanAccessResque
+  def self.matches?(request)
+    current_user = request.env['warden'].user
+    current_user.superadmin?
+  end
+end

data/config/initializers/resque_mailer.rb

@@ -0,0 +1 @@
+Resque::Mailer.excluded_environments = [:test, :cucumber]

data/config/routes.rb

@@ -0,0 +1,5 @@
+Thredded::Application.routes.prepend do
+  constraints CanAccessResque do
+    mount Resque::Server, at: '/resque'
+  end
+end

data/lib/generators/thredded_resque/install/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+module ThreddedResque
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def add_worker_to_procfile
+        append_file 'Procfile', "worker: bundle exec rake environment resque:work QUEUE='*'"
+      end
+    end
+  end
+end

data/lib/tasks/resque.rake

@@ -0,0 +1,12 @@
+require 'resque/tasks'
+
+task 'resque:setup' => :environment do
+  ENV['QUEUE'] ||= '*'
+  Resque.before_fork = Proc.new { ActiveRecord::Base.establish_connection }
+end
+
+namespace :resque do
+  desc 'let resque workers always load the rails environment'
+  task setup: :environment do
+  end
+end

data/lib/tasks/thredded_resque_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :thredded_resque do
+#   # Task goes here
+# end

data/lib/thredded_resque/engine.rb

@@ -0,0 +1,14 @@
+require 'resque/server'
+require 'thredded_resque'
+require 'rails'
+
+module ThreddedResque
+  class Engine < Rails::Engine
+    initializer 'thredded_resque.extend_mailers' do |app|
+      app.config.to_prepare do
+        PostMailer.send(:include, Resque::Mailer)
+        TopicMailer.send(:include, Resque::Mailer)
+      end
+    end
+  end
+end

data/lib/thredded_resque/version.rb

@@ -0,0 +1,3 @@
+module ThreddedResque
+  VERSION = "0.0.1"
+end

data/lib/thredded_resque.rb

@@ -0,0 +1,6 @@
+require 'resque_mailer'
+require 'rails/engine'
+require 'thredded_resque/engine'
+
+module ThreddedResque
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: thredded_resque
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joel Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque_mailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: thredded_resque adds resque, and resque-mailer support to thredded
+email:
+- joel@thredded.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/initializers/can_access_resque.rb
+- config/initializers/resque_mailer.rb
+- config/routes.rb
+- lib/generators/thredded_resque/install/install_generator.rb
+- lib/tasks/resque.rake
+- lib/tasks/thredded_resque_tasks.rake
+- lib/thredded_resque/engine.rb
+- lib/thredded_resque/version.rb
+- lib/thredded_resque.rb
+- MIT-LICENSE
+- Rakefile
+- README.mkdn
+homepage: https://www.thredded.com/meta
+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.25
+signing_key: 
+specification_version: 3
+summary: thredded_resque adds resque, and resque-mailer support to thredded
+test_files: []