gongren-rails 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+doc
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 François Beausoleil
+
+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.rdoc

@@ -0,0 +1,66 @@
+= gongren-rails
+
+gongren-rails is for use specifically within Rails.  It includes extensions to ActiveRecord, ActionController
+and ActionMailer to make queuing jobs for later easier.
+
+== Basic Usage
+
+  # config/environment.rb
+  Rails::Initializer.run do |config|
+    # Will pull in all needed dependencies
+    config.gem "gongren-rails", :lib => "gongren/server"
+
+    config.after_initialize do
+      # Reads config/amqp.yml, or uses default configuration
+      Gongren::RailsServer.start
+
+      # OR, manual configuration
+      Gongren::Rails::Server.start(:host     => "rabbit.myhost.com",
+                                   :port     => 1234,
+                                   :user     => "not-guest",
+                                   :password => "not-empty")
+    end
+  end
+
+  # ActiveRecord model, callback
+  class BlogComment < ActiveRecord::Base
+    def evaluate_for_spaminess
+      # Potentially hanging network call to Defensio or other.
+    end
+
+    # NOT IMPLEMENTED YET
+    # queued_after_create :evaluate_for_spaminess, :key => "comment.spam"
+    # queued_after_update :evaluate_for_spaminess, :key => "comment.spam"
+    # queued_after_save   :evaluate_for_spaminess, :key => "comment.spam"
+
+    # Manually enqueue a method call
+    after_create do |comment|
+      comment.queue(:key => "comment.spam").evaluate_for_spaminess
+    end
+  end
+
+  # ActionMailer helper
+  class UsersController < ActionController::Base
+    def create
+      user = User.create!(params[:user])
+      url = user_confirmation_url(:id => user.id, :token => user.confirmation_token)
+      UserMailer.queue(:key => "user.welcome").deliver_confirmation_email(:user => user, :url => url)
+    end
+  end
+
+The +key+ parameters above allows routing different jobs to different Gongren::Worker instances.  See
+the README documentation of the Gongren gem itself for details on usage and purpose.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 François Beausoleil. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,109 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gongren-rails"
+    gem.summary = %Q{Gongren::Server specifically for use within Rails.}
+    gem.description = %Q{Gongren::Rails::Server is what you're after.}
+    gem.email = "francois@teksol.info"
+    gem.homepage = "http://github.com/francois/gongren-rails"
+    gem.authors = ["François Beausoleil"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+    gem.add_dependency "gongren", ">= 0.1.2"
+    gem.add_dependency "qusion", ">= 1.0.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+namespace :version do
+  task :rewrite do
+    require "erb"
+
+    version = File.read("VERSION").chomp
+    template = ERB.new <<-EOT.gsub(/^\s{6}/, "")
+      # Nothing interesting here: see {Gongren::Rails::Server} or {Gongren::Rails::Worker}.
+      module Gongren
+        module Rails
+          VERSION = "<%= version %>"
+        end
+      end
+    EOT
+    path = File.join(Dir.pwd, "lib/gongren/rails.rb")
+    contents = template.result(binding)
+    File.open(path, "w") {|out| out.write contents}
+    sha = `git log -n 1 --pretty=format:%H`.chomp
+    raise "Could not determine last commit" if sha.empty?
+    sh "git commit --amend --reuse-message #{sha} -- #{path}"
+  end
+end
+
+%w(version:bump:patch version:bump:minor version:bump:major).each do |name|
+  Rake::Task[name].enhance do
+    Rake::Task["version:rewrite"].invoke
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/gongren-rails.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gongren-rails}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fran\303\247ois Beausoleil"]
+  s.date = %q{2010-01-20}
+  s.description = %q{Gongren::Rails::Server is what you're after.}
+  s.email = %q{francois@teksol.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "gongren-rails.gemspec",
+     "lib/gongren/call_proxy.rb",
+     "lib/gongren/rails.rb",
+     "lib/gongren/rails/extensions/action_mailer.rb",
+     "lib/gongren/rails/extensions/active_record.rb",
+     "lib/gongren/rails/server.rb",
+     "lib/gongren/rails/worker.rb",
+     "test/helper.rb",
+     "test/test_gongren-rails.rb"
+  ]
+  s.homepage = %q{http://github.com/francois/gongren-rails}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Gongren::Server specifically for use within Rails.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_gongren-rails.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<gongren>, [">= 0.1.2"])
+      s.add_runtime_dependency(%q<qusion>, [">= 1.0.0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<gongren>, [">= 0.1.2"])
+      s.add_dependency(%q<qusion>, [">= 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<gongren>, [">= 0.1.2"])
+    s.add_dependency(%q<qusion>, [">= 1.0.0"])
+  end
+end
+

data/lib/gongren/call_proxy.rb

@@ -0,0 +1,25 @@
+module Gongren
+  class CallProxy
+    def initialize(options={}, &block)
+      @options = options
+      @block   = block
+    end
+
+    def method_missing(selector, *args, &block)
+      raise ArgumentError, "Cannot generate a CallProxy when a block is involved" if block.present?
+      return super unless selector.to_s =~ /^deliver_/
+      data = {:selector => selector, :args => args}
+      @block.call(data) if @block
+
+      args = map_active_record_instances_to_simpler_representation(args)
+
+      Gongren::RailsServer.submit(options[:key], data)
+    end
+
+    def map_active_record_instances_to_simpler_representation(args)
+      args.map do |arg|
+        arg.kind_of?(ActiveRecord) ? {:active_record => [arg.class.name, arg.id]} : arg
+      end
+    end
+  end
+end

data/lib/gongren/rails.rb

@@ -0,0 +1,6 @@
+# Nothing interesting here: see {Gongren::Rails::Server} or {Gongren::Rails::Worker}.
+module Gongren
+  module Rails
+    VERSION = "0.1.1"
+  end
+end

data/lib/gongren/rails/extensions/action_mailer.rb

@@ -0,0 +1,13 @@
+module Gongren
+  module Rails
+    module Extensions
+      module ActionMailer
+        def self.queue(options)
+          CallProxy.new(options) do |data|
+            data[:receiver] = {:class => self.name}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gongren/rails/extensions/active_record.rb

@@ -0,0 +1,28 @@
+module Gongren
+  module Rails
+    module Extensions
+      module ActiveRecord
+        # TODO: Map from *args to a block / #call-able something
+        def self.queued_after_save(*args, &block)
+          raise "not implemented"
+        end
+
+        # TODO: Map from *args to a block / #call-able something
+        def self.queued_after_update(*args, &block)
+          raise "not implemented"
+        end
+
+        # TODO: Map from *args to a block / #call-able something
+        def self.queued_after_create(*args, &block)
+          raise "not implemented"
+        end
+
+        def queue(options)
+          CallProxy.new(options) do |data|
+            data[:receiver] = {:active_record => [self.class.name, self.id]}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gongren/rails/server.rb

@@ -0,0 +1,66 @@
+require "logger"
+require "qusion"
+
+require "gongren/rails/extensions/active_record" if defined?(ActiveRecord::Base)
+require "gongren/rails/extensions/action_mailer" if defined?(ActionMailer::Base)
+
+module Gongren
+  module Rails
+    class Server
+      def initialize(options={})
+        @options = options.symbolize_keys
+        @logger  = options[:logger] || Rails.logger
+      end
+
+      # Submits a unit of work to the pool of workers.
+      def self.submit(name, unit)
+        data = Marshal.dump(unit)
+
+        # NOTE: mandatory => true means return an error if the message can't be routed immediately.
+        # This would indicate a configuration error, as workers should build their queue and
+        # bind them to the exchange on startup.
+        topic.publish(data, :persistent => true, :mandatory => true, :routing_key => "unit.#{name}")
+      end
+
+      # A quick way to instantiate a server with some options.
+      def self.start(options={})
+        new(options).start
+      end
+
+      # Starts the reactor / event loop.
+      def start
+        logger.info { "Gongren::Server #{Process.pid} starting" }
+        Qusion.start(@options)
+        self.class.control_topic # Instantiates the control topic, for later use
+      end
+
+      private
+
+      attr_reader :options, :logger
+
+      def self.exchange_name
+        "gongren.work"
+      end
+
+      def self.exchange_options
+        {:durable => true}
+      end
+
+      def self.topic
+        Qusion.channel.topic(exchange_name, exchange_options)
+      end
+
+      def self.control_exchange_name
+        "gongren.worker.control"
+      end
+
+      def self.control_exchange_options
+        {}
+      end
+
+      def self.control_topic
+        Qusion.channel.topic(control_exchange_name, control_exchange_options)
+      end
+    end
+  end
+end

data/lib/gongren/rails/worker.rb

@@ -0,0 +1,70 @@
+module Gongren
+  module Rails
+    class Worker < Gongren::Worker
+      def start
+        raise ArgumentError, "#start must be called with a block" unless block_given?
+
+        logger.info { "Gongren::RailsWorker #{worker_id} ready to work" }
+
+        AMQP.start do
+          MQ.queue(control_queue_name, control_queue_options).bind(control_exchange_name, control_exchange_options) do |header, data|
+            message = Marshal.load(data)
+            logger.info { message.inspect }
+
+            if message[:selector].to_s.strip.empty? then
+              logger.error { "Received control request without :selector key: ignoring" }
+            else
+              begin
+                send(message[:selector], message)
+              rescue Exception => e
+                log_failure(header, message, e)
+              end
+            end
+          end
+
+          MQ.queue(queue_name, queue_options).bind(exchange_name, exchange_options).subscribe(:ack => true) do |header, data|
+            message = Marshal.load(data)
+            class << message; include Unit; end # Dynamically add our #ack method
+            message.gongren_header = header
+
+            logger.info { message.inspect }
+            receiver = case keys = message[:receiver].keys
+                       when [:active_record]
+                         active_record_model(message[:receiver][:active_record])
+                       when [:class]
+                         message[:receiver][:class].constantize
+                       else
+                         raise UnknownReceiverKeys, "Unable to map from #{keys} to a receiver instance: aborting"
+                       end
+            message.args.collect! do |arg|
+              if arg.kind_of?(Hash) && arg[:active_record] then
+                active_record_model(arg[:active_record])
+              else
+                arg
+              end
+            end
+            logger.debug { "Mapped message is:\n#{message.inspect}" }
+
+            begin
+              receiver.send(message[:selector], *message[:args])
+
+              # Automatically ack messages, but do it only once
+              logger.debug { "Block ack'd? #{message.acked?}" }
+              unless message.acked?
+                logger.debug { "Ack'ing for the block" }
+                message.ack
+              end
+            rescue Exception => e
+              log_failure(header, message, e)
+            end
+          end
+        end
+      end
+
+      # Given a two element Array of ["ClassName", ID], returns an ActiveRecord instance.
+      def active_record_model(ar)
+        ar.first.constantize.find(ar.last)
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gongren-rails'
+
+class Test::Unit::TestCase
+end

data/test/test_gongren-rails.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGongrenRails < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: gongren-rails
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- "Fran\xC3\xA7ois Beausoleil"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gongren
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: qusion
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: Gongren::Rails::Server is what you're after.
+email: francois@teksol.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- gongren-rails.gemspec
+- lib/gongren/call_proxy.rb
+- lib/gongren/rails.rb
+- lib/gongren/rails/extensions/action_mailer.rb
+- lib/gongren/rails/extensions/active_record.rb
+- lib/gongren/rails/server.rb
+- lib/gongren/rails/worker.rb
+- test/helper.rb
+- test/test_gongren-rails.rb
+has_rdoc: true
+homepage: http://github.com/francois/gongren-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Gongren::Server specifically for use within Rails.
+test_files: 
+- test/helper.rb
+- test/test_gongren-rails.rb