timberline-rails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2654b1a797bfa7d8573546111e8feb64eab21465
-  data.tar.gz: 6b1149c50d8e950e5fd7c430f7af50a674e07e2e
+  metadata.gz: b996ea83143cd888bf6275b1c261d736f375dad9
+  data.tar.gz: 9067b5d3572fa7793ffa65e055e55e919b0da236
 SHA512:
-  metadata.gz: 78c515559d34b015c0a5d4c6e37dd8729b5f50b2e7207d66bd35f2fd7e9b08c2f996667da38d01c677a642c52a89ca66d919beaa471166743d60b86e02303cf4
-  data.tar.gz: 412bf508b44c3b0a614a7b988c67dd10af5707faa6890dd108838db4c933234d80e15e6904a620056af4bfb03bf9cbc66e33d01df4c4cc6f5a3bc88884f1b1a6
+  metadata.gz: 06c3924792b9e3d270f20e5a17bc6664bbfc803efa5a81a8ee379f0dec6f43684d3700fc8ec5c3ecfc0a4d447c8ea145d11131692177f03d8199d413de0a1a9b
+  data.tar.gz: 897bc71be003ffd398dcdb037ea9c60d2261ee6ef63ee2e1dbd7e566ac3c9cfb05f10a55c0b7622028a39513965a370b863ae38f17e42c86f3d314d777b9c259

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.4.0
+  - Upgrade to Timberline v0.8.5
+  - Add ActiveJob adapter and Timberline::Rails::ActiveJobWorker
+0.3.0
+  - Upgrade to Timberline v0.8.0
 0.2.0
   - Add Timberline::Rails::ActiveRecord and Timberline::Rails::ActiveRecordWorker support
   - Upgrade to Timberline v0.7.0 with Worker support

data/Gemfile.lock

@@ -1,26 +1,40 @@
 PATH
   remote: .
   specs:
-    timberline-rails (0.2.0)
-      timberline (~> 0.7.0)
+    timberline-rails (0.4.0)
+      timberline (~> 0.8.5)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    activejob (4.2.4)
+      activesupport (= 4.2.4)
+      globalid (>= 0.3.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     coderay (1.1.0)
-    daemons (1.1.9)
+    daemons (1.2.3)
     diff-lcs (1.2.5)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
     method_source (0.8.2)
+    minitest (5.8.2)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
     rake (10.3.2)
-    redis (3.0.7)
+    redis (3.2.2)
     redis-expiring-set (0.1.2)
       redis
-    redis-namespace (1.4.1)
-      redis (~> 3.0.4)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)
       rspec-expectations (~> 3.0.0)
@@ -34,21 +48,28 @@ GEM
       rspec-support (~> 3.0.0)
     rspec-support (3.0.0)
     slop (3.5.0)
-    timberline (0.7.0)
+    thread_safe (0.3.5)
+    timberline (0.8.5)
       daemons
       redis
       redis-expiring-set
       redis-namespace
       trollop
-    trollop (2.0)
+    trollop (2.1.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
     yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activejob
   pry
   rake
   rspec (~> 3.0.0)
   timberline-rails!
   yard
+
+BUNDLED WITH
+   1.10.6

data/README.markdown

@@ -19,10 +19,26 @@ configuration in code using `Timberline.configure`. Timberline-Rails adds in
 automatic detection for a config file at `config/timberline.yml` in your Rails
 app, complete with environment support (just like database.yml).
 
-### Timberline::Rails::ActiveRecord and Timberline::Rails::ActiveRecordWorker
+### ActiveJob Integration
+
+Timberline-Rails now includes an adapter and worker so you can use Timberline as
+ActiveJob's queueing backend.
+
+To use, set Timberline as the queue adapter in `config/application.rb` or in one
+of your environment's configs:
+
+    config.active_job.queue_adapter = :timberline
+
+Then, run a worker for each queue that you use.
+
+    # run this script with rails/runner or use some other means to load your Rails environment
+
+    Timberline::Rails::ActiveJobWorker.new.watch("default")
+
+### ActiveRecord Integration
 
 In order to make running jobs in the background as easy as possible,
-Timberline-Rails comes with two new items to help:
+Timberline-Rails comes with two items to help:
 
 #### Timberline::Rails::ActiveRecord
 
@@ -52,7 +68,7 @@ To continue our example from above:
 
     # run this script with rails/runner or use some other means to load your Rails environment
     
-    Timberline::Rails::ActiveRecordWorker.new("user_jobs").watch
+    Timberline::Rails::ActiveRecordWorker.new.watch("user_jobs")
 
 ...and items will be pulled off of the `user_jobs` queue and processed (in this case,
 we'll look up the appropriate User record and call `#send_some_email` on it directly).=

data/lib/active_job/queue_adapters/timberline_adapter.rb

@@ -0,0 +1,18 @@
+module ActiveJob
+  module QueueAdapters
+    # To use Timberline set the queue_adapter config to +:timberline+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :timberline
+    class TimberlineAdapter
+      class << self
+        def enqueue(job)
+          Timberline.push job.queue_name, job.serialize
+        end
+
+        def enqueue_at(job, timestamp)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/timberline/rails/active_job_worker.rb

@@ -0,0 +1,13 @@
+class Timberline
+  class Rails
+    class ActiveJobWorker < ::Timberline::Worker
+      def process_item(item)
+        ActiveJob::Base.execute item.contents
+      rescue StandardError => e
+        item.error_reason = e.message
+        item.error_backtrace = e.backtrace
+        error_item(item)
+      end
+    end
+  end
+end

data/lib/timberline/rails/version.rb

@@ -1,6 +1,6 @@
 class Timberline
   class Rails
     # The canonical version of Timberline-Rails
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/timberline-rails.rb

@@ -1,8 +1,10 @@
 require 'timberline'
 require 'timberline/rails/version'
 require 'timberline/rails/exceptions'
+require 'timberline/rails/active_job_worker'
 require 'timberline/rails/active_record'
 require 'timberline/rails/active_record_worker'
+require 'active_job/queue_adapters/timberline_adapter'
 
 class Timberline
   # Re-open the Timberline::Config class from Timberline

data/spec/lib/timberline/rails/active_job_worker_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Timberline::Rails::ActiveJobWorker do
+  subject do
+    Timberline::Rails::ActiveJobWorker.new.tap do |worker|
+      worker.instance_variable_set :@queue, queue
+    end
+  end
+  let(:queue) { Timberline.queue("fake_queue") }
+  let(:item) do
+    queue.push({ job_class: "SpecSupport::FakeRails::FakeJob",
+                 arguments: [1, 2, 3] })
+    queue.pop
+  end
+
+  describe "#process_item" do
+    it "uses ActiveJob to execute the item contents" do
+      expect(ActiveJob::Base).to receive(:execute).with(item.contents)
+      subject.process_item(item)
+    end
+
+    context "If the method raises an exception of its own" do
+      before do
+        allow_any_instance_of(SpecSupport::FakeRails::FakeJob).to receive(:perform) { raise "This doesn't work" }
+      end
+
+      it "errors the item" do
+        expect(subject).to receive(:error_item).with(item)
+        subject.process_item(item)
+      end
+
+      it "provides an error_reason" do
+        expect { subject.process_item(item) }.to raise_error(Timberline::ItemErrored)
+        expect(item.error_reason).to include("This doesn't work")
+      end
+
+      it "provides an error_backtrace" do
+        expect { subject.process_item(item) }.to raise_error(Timberline::ItemErrored)
+        expect(item.error_backtrace).to be_a Array
+      end
+    end
+  end
+end

data/spec/lib/timberline/rails/active_record_worker_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
 describe Timberline::Rails::ActiveRecordWorker do
-  subject { Timberline::Rails::ActiveRecordWorker.new("fake_queue") }
+  subject do
+    Timberline::Rails::ActiveRecordWorker.new.tap do |worker|
+      worker.instance_variable_set :@queue, queue
+    end
+  end
   let(:queue) { Timberline.queue("fake_queue") }
   let(:item) do 
     queue.push({ model_name: "SpecSupport::FakeRails::FakeModel",

data/spec/support/fake_rails.rb

@@ -1,3 +1,8 @@
+require 'active_job'
+
+ActiveJob::Base.logger = nil
+ActiveJob::Base.queue_adapter = :timberline
+
 module SpecSupport
   module FakeRails
     def self.create_fake_env
@@ -14,6 +19,13 @@ module SpecSupport
       Object.send(:remove_const, :Rails)
     end
 
+    class FakeJob < ActiveJob::Base
+      queue_as :fake_queue
+
+      def perform(*args)
+      end
+    end
+
     class FakeModel
       include Timberline::Rails::ActiveRecord
 

data/timberline-rails.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "timberline", "~> 0.8.0"
+  s.add_runtime_dependency "timberline", "~> 0.8.5"
 
+  s.add_development_dependency "activejob"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", '~> 3.0.0'
   s.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timberline-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tommy Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: timberline
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,13 +112,16 @@ files:
 - Gemfile.lock
 - README.markdown
 - Rakefile
+- lib/active_job/queue_adapters/timberline_adapter.rb
 - lib/timberline-rails.rb
+- lib/timberline/rails/active_job_worker.rb
 - lib/timberline/rails/active_record.rb
 - lib/timberline/rails/active_record_worker.rb
 - lib/timberline/rails/exceptions.rb
 - lib/timberline/rails/version.rb
 - spec/fake_rails/config/timberline.yml
 - spec/lib/timberline/config_spec.rb
+- spec/lib/timberline/rails/active_job_worker_spec.rb
 - spec/lib/timberline/rails/active_record_spec.rb
 - spec/lib/timberline/rails/active_record_worker_spec.rb
 - spec/spec_helper.rb
@@ -130,9 +147,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: timberline-rails
-rubygems_version: 2.2.2
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Rails logic and niceties for the Timberline queueing system.
-test_files: []
+test_files:
+- spec/fake_rails/config/timberline.yml
+- spec/lib/timberline/config_spec.rb
+- spec/lib/timberline/rails/active_job_worker_spec.rb
+- spec/lib/timberline/rails/active_record_spec.rb
+- spec/lib/timberline/rails/active_record_worker_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_rails.rb
+- spec/support/timberline_reset.rb
 has_rdoc: