barbeque_client 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d6d90f5591143367ca2599bbdd7be7aba7b778e
-  data.tar.gz: bba82d410d8a01c60d6fe38ec5958e61cb72d497
+SHA256:
+  metadata.gz: d48cc489c84d703adcc61ce78a13d4bc965ca7cffe29ae75596f8e25147671f6
+  data.tar.gz: 6e3d9e47c80f061eb14fde4c135a490da9e859b593a0016293f69aa97d0c6e91
 SHA512:
-  metadata.gz: 16195a2a5f380e24448f63045372fdf2cfd1d21749fee2231f83f54b53eec74002bbabff50118169cbf970ad6cd7bfe74597d0cb015b4133136607a3a17cdba1
-  data.tar.gz: 1ce68df8f09245e83d5f6c40ff2afa115d903d4581586a95943cf9bacf8556ffdec9f7ec50b592b1d557e33509dca5ebfafc517f90df450fefe836f41c94a88f
+  metadata.gz: 46d4e41a1148c6baa7348b2aa5c897d4ca3d91c0c8b45ce2efd5850f5946907feb705db8aed9a33c2d6ab5a4222af3eb9ab015eac45cd21cb07f95dfcbff7a32
+  data.tar.gz: 1508a6d730ed77f8c4825a97b6f3619e824d410b911ad693033e83849a8d96aec90c6e9e0adbc9c381821c0e1c31e5a57a478f6ef9ebbf67383a93bebb9d853d

data/.travis.yml

@@ -8,7 +8,6 @@ rvm:
   - 2.4.0
   - 2.3.1
   - 2.2.5
-  - 2.1.10
 script:
   - bundle exec rake
 matrix:

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## v0.10.0 (2018-08-24)
+- Add documentation for ActiveJob adapter
+- Drop support for Ruby 2.1
+- Support delay_seconds parameter
+  - Also supports ActiveJob's enqueue_at method
+  - Requires Barbeque >= v2.5.0
+
+## v0.9.1 (2017-06-19)
+- Fix NoMethodError in distributed tracing
+
+## v0.9.0 (2017-05-30)
+- Support distributed tracing
+  - See https://github.com/cookpad/barbeque_client#distributed-tracing for details.
+
+## v0.8.2 (2017-03-17)
+- Add `fields` option to Client#execution
+
+## v0.8.1 (2017-03-14)
+- Add naive status management in barbeque:runner
+
+## v0.8.0 (2016-09-01)
+- Initial release

data/README.md

@@ -28,6 +28,7 @@ execution = BarbequeClient.enqueue(
   job:     'NotifyAuthor',       # @param [String] job     - Job name to enqueue.
   message: { user_id: 7553989 }, # @param [Object] message - An object which is serializable as JSON.
   queue:   'default',            # @param optional [String] queue - A queue name to enqueue a job.
+  delay_seconds: 0,              # @param optional [Integer] delay_seconds - Message timer of SQS.
 )
 execution.message_id #=> "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
 execution.status     #=> "pending"
@@ -40,6 +41,21 @@ message_id = "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
 BarbequeClient.status(message_id: message_id) #=> "success"
 ```
 
+### With Rails
+
+Barbeque client has adapter for ActiveJob.
+
+```rb
+# config/environments/some_environment.rb
+Rails.application.config.active_job.queue_adapter = :barbeque
+```
+
+And everything will be ok. Don't forget to setup `config.application` and `config.endpoint` in somewhere.
+One more thing, `config.default_queue` option is meaningless with Rails.
+`default_queue` is the fallback option for enqueueing without specified queue name.
+However, ActiveJob always set default queue as 'default' internally,
+there is no place to work on. So please use [`queue_as`](http://api.rubyonrails.org/classes/ActiveJob/QueueName/ClassMethods.html#method-i-queue_as) when you want to use different queue name.
+
 ### Distributed tracing
 Configure `tracing` option. Pick one of supported tracers.
 See more detail in https://github.com/cookpad/garage_client#tracing.

data/barbeque_client.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'garage_client'
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rails', '~> 4.2'
+  spec.add_development_dependency 'rails', '~> 5.1'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-rails'

data/lib/active_job/queue_adapters/barbeque_adapter.rb

@@ -6,6 +6,10 @@ module ActiveJob
         BarbequeAdapter.enqueue(job)
       end
 
+      def enqueue_at(job, timestamp)
+        BarbequeAdapter.enqueue_at(job, timestamp)
+      end
+
       class << self
         # Interface for ActiveJob 4.2
         def enqueue(job)
@@ -18,9 +22,14 @@ module ActiveJob
         end
 
         def enqueue_at(job, timestamp)
-          raise NotImplementedError.new(
-            'Currently setting timestamp is not supported'
+          delay_seconds = (timestamp - Time.now.to_f).round
+          execution = BarbequeClient.enqueue(
+            job:     job.class.to_s,
+            message: ActiveJob::Arguments.serialize(job.arguments),
+            queue:   job.queue_name,
+            delay_seconds: delay_seconds,
           )
+          job.job_id = execution.message_id
         end
       end
     end

data/lib/barbeque_client.rb

@@ -23,12 +23,14 @@ module BarbequeClient
     # @param  [String] job     - Job name to enqueue.
     # @param  [Object] message - An object which is serializable as JSON.
     # @param  optional [String] queue - A queue name to enqueue a job.
+    # @param  optional [Integer] delay_seconds - Message timer of SQS.
     # @return [Hashie::Mash] resonse - { message_id: String, status: String }
-    def enqueue(job:, message:, queue: nil)
+    def enqueue(job:, message:, queue: nil, delay_seconds: nil)
       response = client.create_execution(
         job:     job,
         message: message,
         queue:   queue,
+        delay_seconds: delay_seconds,
       )
       response.body
     end

data/lib/barbeque_client/client.rb

@@ -13,13 +13,15 @@ module BarbequeClient
     # @param [String] job     - Job name to enqueue.
     # @param [Object] message - An object which is serializable as JSON.
     # @param optional [String] queue - A queue name to enqueue a job.
+    # @param optional [Integer] delay_seconds - Message timer of SQS.
     # @return [Faraday::Response]
-    def create_execution(job:, message:, queue: nil)
+    def create_execution(job:, message:, queue: nil, delay_seconds: nil)
       params = {
         application: @application,
         job:         job,
         message:     message,
         queue:       queue || @default_queue,
+        delay_seconds: delay_seconds,
       }
       result = garage_client.post('/v2/job_executions', params)
       result.response

data/lib/barbeque_client/version.rb

@@ -1,3 +1,3 @@
 module BarbequeClient
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barbeque_client
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: garage_client
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Barbeque client for Ruby