sunspot-queue 0.10.0 → 0.10.1

data/History.md

@@ -1,5 +1,12 @@
 # Sunspot Queue Changelog
 
+## 0.11.1
+* Allow without_proxy to work with SessionProxy subclasses
+* Added missing requires in sidekiq jobs
+
+## 0.11.0
+* Delayed Job support
+
 ## 0.10.0
 * Sidekiq support
 * SessionProxy now takes a backend as a second required option

data/README.md

@@ -54,6 +54,30 @@ Start Sidekiq
 $ sidekiq -q sunspot
 ```
 
+## Usage with Rails and Delayed::Job 
+
+In your Gemfile
+
+```ruby
+gem "sunspot-queue"
+gem "delayed_job"
+gem "delayed_job_active_record"     # or choose another backend
+```
+
+In config/initializers/sunspot.rb
+
+```ruby
+require "sunspot/queue/delayed_job"
+backend = Sunspot::Queue::DelayedJob::Backend.new
+Sunspot.session = Sunspot::Queue::SessionProxy.new(Sunspot.session, backend)
+```
+
+Start Delayed::Job
+
+```console
+$ rake jobs:work 
+```
+
 ## Configuring Sunspot Queue
 
 In config/initializers/sunspot.rb

data/lib/sunspot/queue/delayed_job.rb

@@ -0,0 +1,9 @@
+require "sunspot/queue"
+
+module Sunspot::Queue
+  module DelayedJob
+    require "sunspot/queue/delayed_job/backend"
+    require "sunspot/queue/delayed_job/index_job"
+    require "sunspot/queue/delayed_job/removal_job"
+  end
+end

data/lib/sunspot/queue/delayed_job/backend.rb

@@ -0,0 +1,35 @@
+require "delayed_job"
+require "sunspot/queue/delayed_job/index_job"
+require "sunspot/queue/delayed_job/removal_job"
+
+module Sunspot::Queue::DelayedJob
+  class Backend
+    attr_reader :configuration
+
+    def initialize(configuration = Sunspot::Queue.configuration)
+      @configuration = configuration
+    end
+
+    def enqueue(job)
+      Delayed::Job.enqueue(job)
+    end
+
+    def index(klass, id)
+      enqueue(index_job.new(klass, id))
+    end
+
+    def remove(klass, id)
+      enqueue(removal_job.new(klass, id))
+    end
+
+    private
+
+    def index_job
+      configuration.index_job || ::Sunspot::Queue::DelayedJob::IndexJob
+    end
+
+    def removal_job
+      configuration.removal_job || ::Sunspot::Queue::DelayedJob::RemovalJob
+    end
+  end
+end

data/lib/sunspot/queue/delayed_job/index_job.rb

@@ -0,0 +1,13 @@
+require "sunspot/queue/helpers"
+
+module Sunspot::Queue::DelayedJob
+  class IndexJob < Struct.new(:klass, :id)
+    include ::Sunspot::Queue::Helpers
+
+    def perform
+      without_proxy do
+        constantize(klass).find(id).solr_index
+      end
+    end
+  end
+end

data/lib/sunspot/queue/delayed_job/removal_job.rb

@@ -0,0 +1,13 @@
+require "sunspot/queue/helpers"
+
+module Sunspot::Queue::DelayedJob
+  class RemovalJob < Struct.new(:klass, :id)
+    include ::Sunspot::Queue::Helpers
+
+    def perform
+      without_proxy do
+        ::Sunspot.remove_by_id(klass, id)
+      end
+    end
+  end
+end

data/lib/sunspot/queue/helpers.rb

@@ -7,7 +7,7 @@ module Sunspot::Queue
 
       # Pop off the queueing proxy for the block if it's in place so we don't
       # requeue the same job multiple times.
-      if Sunspot.session.instance_of?(SessionProxy)
+      if Sunspot.session.is_a?(SessionProxy)
         proxy = Sunspot.session
         Sunspot.session = proxy.session
       end

data/lib/sunspot/queue/sidekiq/index_job.rb

@@ -1,4 +1,5 @@
 require "sidekiq/worker"
+require "sunspot/queue/helpers"
 
 module Sunspot::Queue::Sidekiq
   class IndexJob

data/lib/sunspot/queue/sidekiq/removal_job.rb

@@ -1,4 +1,5 @@
 require "sidekiq/worker"
+require "sunspot/queue/helpers"
 
 module Sunspot::Queue::Sidekiq
   class RemovalJob

data/lib/sunspot/queue/version.rb

@@ -1,5 +1,5 @@
 module Sunspot
   module Queue
-    VERSION = "0.10.0"
+    VERSION = "0.10.1"
   end
 end

data/spec/delayed_job/backend_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe Sunspot::Queue::DelayedJob::Backend do
+
+  # Mock DelayedJobJob 
+  class CustomDelayedJobJob < Struct.new(:klass, :id)
+    def perform
+    end
+  end
+
+  subject(:backend) { described_class.new(configuration) }
+
+  let(:configuration) { ::Sunspot::Queue::Configuration.new }
+
+  describe "#index" do
+    it "uses the index job set in the global configuration" do
+      configuration.index_job = CustomDelayedJobJob
+
+      Delayed::Job.should_receive(:enqueue) do |args|
+        args.first.is_a? CustomDelayedJobJob
+      end
+
+      backend.index(Person, 3)
+    end
+
+    it "uses the default index job if one is not configured" do
+      Delayed::Job.should_receive(:enqueue) do |args|
+        args.first.is_a? Sunspot::Queue::DelayedJob::IndexJob
+      end
+      
+      backend.index(Person, 12)
+    end
+  end
+
+  describe "#remove" do
+    it "uses the removal job set in the global configuration" do
+      configuration.removal_job = CustomDelayedJobJob
+
+      Delayed::Job.should_receive(:enqueue) do |args|
+        args.first.is_a? CustomDelayedJobJob
+      end
+
+      backend.remove(Person, 3)
+    end
+
+    it "uses the default index job if one is not configured" do
+      Delayed::Job.should_receive(:enqueue) do |args|
+        args.first.is_a? Sunspot::Queue::DelayedJob::RemovalJob
+      end
+
+      backend.remove(Person, 12)
+    end
+  end
+end

data/spec/delayed_job/index_job_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Sunspot::Queue::DelayedJob::IndexJob do
+  context "ActiveRecord" do
+
+    it "indexes an ActiveRecord model" do
+      person = Person.create(:name => "The Grandson") 
+      job = Sunspot::Queue::DelayedJob::IndexJob.new(Person, person.id)
+
+      # This will queue a job but we'll just ignore it to isolate the job
+      expect do
+        job.perform
+        commit
+      end.to change { Person.search.hits.size }.by(1)
+
+      results = Person.search { fulltext "grandson" }.results
+      results.first.should == person
+    end
+
+    it "raises an error if the record could not be found" do
+      job = Sunspot::Queue::DelayedJob::IndexJob.new(Person, 404)
+
+      expect do
+        job.perform
+      end.to raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it "maintains the existing proxy if there was an error" do
+      job = Sunspot::Queue::DelayedJob::IndexJob.new(Person, 404)
+
+      expect do
+        job.perform rescue nil
+      end.to_not change { Sunspot.session }
+    end
+
+    it "does not commit changes to the index" do
+      person = Person.create(:name => "The Grandson")
+      job = Sunspot::Queue::DelayedJob::IndexJob.new(Person, person.id)
+
+      expect do
+        job.perform
+      end.to_not change { Person.search.hits.size }
+
+      expect do
+        commit
+      end.to change { Person.search.hits.size }
+    end
+  end
+end

data/spec/delayed_job/removal_job_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+require "sunspot/queue/delayed_job"
+require "sunspot/queue/helpers"
+
+describe Sunspot::Queue::DelayedJob::RemovalJob do
+  it "removes a job from the search index" do
+    person =
+      without_proxy do
+        Person.create(:name => "The Albino")
+      end
+    commit
+
+    Person.search.hits.size.should == 1
+
+    job = Sunspot::Queue::DelayedJob::RemovalJob.new(Person, person.id) 
+    expect do
+      job.perform
+      commit
+    end.to change { Person.search.hits.size }.by(-1)
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ require "resque_spec"
 # Neither is required when loading sunspot/queue
 require "sunspot/queue/resque"
 require "sunspot/queue/sidekiq"
+require "sunspot/queue/delayed_job"
 
 # Sidekiq
 require "sidekiq"
@@ -82,6 +83,14 @@ RSpec.configure do |config|
     Sunspot.session = Sunspot::Queue::SessionProxy.new(session, backend)
   end
 
+  config.before(:each, :backend => :delayed_job) do
+    Delayed::Worker.delay_jobs = false 
+
+    require "sunspot/queue/delayed_job"
+    backend = Sunspot::Queue::DelayedJob::Backend.new
+    Sunspot.session = Sunspot::Queue::SessionProxy.new(session, backend)
+  end
+
   config.before(:each, :backend => :inline) do
     backend = Sunspot::Queue::Inline::Backend.new
     Sunspot.session = Sunspot::Queue::SessionProxy.new(session, backend)
@@ -100,8 +109,8 @@ RSpec.configure do |config|
 
     at_exit { Process.kill("TERM", solr_pid) }
 
-    # Wait for up to 5 seconds for Solr to boot
-    10.times do
+    # Wait up to 30 seconds for Solr to boot
+    60.times do
       begin
         TCPSocket.new("localhost", 8983)
         break

data/spec/support/delayed_job.rb

@@ -0,0 +1,2 @@
+# Fake Delayed::Job persistence backend
+class Delayed::Job ; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunspot-queue
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sunspot_rails
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +227,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sunspot/queue/configuration.rb
+- lib/sunspot/queue/delayed_job/backend.rb
+- lib/sunspot/queue/delayed_job/index_job.rb
+- lib/sunspot/queue/delayed_job/removal_job.rb
+- lib/sunspot/queue/delayed_job.rb
 - lib/sunspot/queue/helpers.rb
 - lib/sunspot/queue/inline/backend.rb
 - lib/sunspot/queue/inline.rb
@@ -227,6 +247,9 @@ files:
 - lib/sunspot/queue.rb
 - lib/sunspot-queue.rb
 - spec/configuration_spec.rb
+- spec/delayed_job/backend_spec.rb
+- spec/delayed_job/index_job_spec.rb
+- spec/delayed_job/removal_job_spec.rb
 - spec/inline/backend_spec.rb
 - spec/integration/indexing_spec.rb
 - spec/integration/sidekiq_spec.rb
@@ -239,6 +262,7 @@ files:
 - spec/sidekiq/index_job_spec.rb
 - spec/sidekiq/removal_job.rb
 - spec/spec_helper.rb
+- spec/support/delayed_job.rb
 - spec/support/sidekiq.rb
 - LICENSE
 - README.md
@@ -257,7 +281,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2557787847468836943
+      hash: -2562861309914958961
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -266,10 +290,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2557787847468836943
+      hash: -2562861309914958961
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Background search indexing using existing worker systems.