pika_que 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b062334f6fd120c3cbdd8f9dbab1d0a50119c6e1
-  data.tar.gz: f9b3e62818fe79276aec1cb54435de8c51767eb1
+  metadata.gz: 39faa9df72e909b96bdc74876b9a68b87d26634c
+  data.tar.gz: edb0a973f47f8b872e1815cd162f42cffd6a9f8a
 SHA512:
-  metadata.gz: 8aaab568dd9e153e2942534ad74341e5b6da4e87ed389dfb2c2bfa85cb1c5629d94382d8dcec02b4b888bb61a728b4fa4c8ecc1a293144ae4274ba686db7f896
-  data.tar.gz: af5f17435c0992adbe6bb142cd3db5f20f29aef8a8bd54a7646084a9e1a1b9c8c4451c462d6003cfa7034ba26a0c1fe32978562e3f8873974e426b6fdef3411d
+  metadata.gz: 9f3f5b73288368228458ad5aef2002640447a037fa336866aecd6ff8f5637064b1acca53a6df86ab721601052c8010c0195c908642b5de6c62ab79772561baf4
+  data.tar.gz: 16438758d34dc710056d6c04139d8d68f602ee262495a43b3b20cf0479154c1f1d73ec3cd775e16fdf010fd46d49a9d54381a438924d00a2702b251cf81b3976

data/README.md

@@ -1,8 +1,9 @@
 # PikaQue
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pika_que`. To experiment with that code, run `bin/console` for an interactive prompt.
+A RabbitMQ background processing framework for Ruby with built-in support for Rails integration.
 
-TODO: Delete this and the text above, and describe your gem
+PikaQue is inspired by Sneakers, Hutch, and Sidekiq. It is intended to implement more support for Rails a la Sidekiq.
+It supports retry (both constant and exponential backoffs) and delayed/scheduled execution.
 
 ## Installation
 
@@ -12,17 +13,69 @@ Add this line to your application's Gemfile:
 gem 'pika_que'
 ```
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install pika_que
 
 ## Usage
 
-TODO: Write usage instructions here
+To create a worker:
+
+```ruby
+class PokeWorker
+  include PikaQue::Worker
+  from_queue "rocket"
+
+  def perform(msg)
+    # do something with msg["greeting"]
+    # or below for active job
+    ActiveJob::Base.execute msg
+    ack!
+  end
+end
+```
+
+To enqueue a job:
+
+```ruby
+PokeWorker.enqueue({ greeting: "I Challenge You!" })
+```
+
+To run server:
+
+    $ bundle exec pika_que
+    
+### Rails and ActiveJob
+
+Create workers in:
+
+    app/workers
+    
+Create a initializer file `pika_que.rb` in:
+
+    config/initializers
+    
+```ruby
+# pika_que.rb
+
+require 'active_job/queue_adapters/pika_que_adapter'
+
+# override default queue_name for ActiveJob::Base and ActionMailer::DeliveryJob here if necessary
+
+# setup workers here or with config/pika_que.yml
+PikaQue.config.add_processor(workers: [PokeWorker])
+PikaQue.config[:codec] = PikaQue::Codecs::RAILS
+```
+
+Set the backend for active job in `config/application.rb`:
+
+    config.active_job.queue_adapter = :pika_que
+
+Then run the server.
+
+## Specs
+
+Coming soon. See examples for reference.
 
 ## Development
 
@@ -32,7 +85,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pika_que. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dwkoogt/pika_que. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/active_job/queue_adapters/pika_que_adapter.rb

@@ -14,7 +14,7 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :pika_que
     #
-    class PikaQueAdapter
+    class PikaQueRails4
       @monitor = Monitor.new
 
       class << self
@@ -37,6 +37,30 @@ module ActiveJob
       end
     end
 
-    autoload :PikaQueAdapter
+    class PikaQueRails5
+      def initialize
+        @monitor = Monitor.new
+      end
+
+      def enqueue(job) #:nodoc:
+        @monitor.synchronize do
+          JobWrapper.enqueue job.serialize, to_queue: job.queue_name
+        end
+      end
+
+      def enqueue_at(job, timestamp) #:nodoc:
+        @monitor.synchronize do
+          JobWrapper.enqueue_at job.serialize, timestamp, routing_key: job.queue_name
+        end
+      end
+
+      class JobWrapper #:nodoc:
+        extend PikaQue::Worker::ClassMethods
+        config codec: PikaQue::Codecs::RAILS
+      end
+    end
+
+    PikaQueAdapter = (::Rails::VERSION::MAJOR < 5) ? PikaQueRails4 : PikaQueRails5
+
   end
 end

data/lib/pika_que.rb

@@ -42,3 +42,5 @@ module PikaQue
   end
 
 end
+
+require 'pika_que/rails' if defined?(::Rails::Engine)

data/lib/pika_que/rails.rb

@@ -22,7 +22,8 @@ module PikaQue
       if File.exist? config_file
         PIKA_QUE_CONFIG = YAML.load_file(config_file)
       else
-        PIKA_QUE_CONFIG = { "processors" => [{ "workers" => [{ "queue" => ActiveJob::Base.queue_name }, { "queue" => ActionMailer::DeliveryJob.queue_name}] }] }
+        mailer_queue = (::Rails::VERSION::MAJOR < 5) ? ActionMailer::DeliveryJob.queue_name : ActionMailer::Base.deliver_later_queue_name
+        PIKA_QUE_CONFIG = { "processors" => [{ "workers" => [{ "queue" => ActiveJob::Base.queue_name }, { "queue" => mailer_queue.to_s }] }] }
       end
 
       workers_dir = Rails.root.join('app').join('workers')

data/lib/pika_que/version.rb

@@ -1,3 +1,3 @@
 module PikaQue
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pika_que
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dong Wook Koo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby background processor for RabbitMQ.