barbeque 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66a4d253528f2a554ce38065c2eca4eb57f2281d6d6cbbe9adf285d00211b0b5
-  data.tar.gz: 3df5c3011aa375dce9274fffa75a8be6a77231632bba9fa02196a2c098447aa2
+  metadata.gz: '098d46ae421c14386c5231061b4c098931bbe762b3e3fcec5149beef806ce46b'
+  data.tar.gz: df03e121930f8d03ce5cc34e1e6f29b35130cb9b2f0c2b5c2c33a3de1a81fe7c
 SHA512:
-  metadata.gz: e54454ba9b12c2dbb3bad474c8511e0b5234fb3296fd80679bcf0802470d46de47a118f7774fc5deb8d79c029d6d52c91b4bf8f2de1f9e25597e95e5dc6a60b1
-  data.tar.gz: f4e929ced516b5e0cec7e8d7e2db717f5b0b49d4ca3dc40bb37c211a57dc96dfbbe62d053afa1dbaa120fcb56a9bf5da288a65c74610f5d36ea6693d09278ecc
+  metadata.gz: 2d53cdd09556249fc858311bdaab4efb43f0d2f4189a29cec76d83e8b8bbd471b3fe14ff2d1eb57674036829eeff094fe928065fbab765d737280380e157ece6
+  data.tar.gz: de83d760cabef91439014926294fc181404cf29adfbafe7463901da0a5ddc8d75ae6ab973cbb72601019123acaf4b45b20832adc11a7445dfc24545f94f7159d

data/README.md

@@ -38,6 +38,11 @@ And deploy it as you like.
 
 You also need to prepare MySQL, Amazon SQS and Amazon S3.
 
+#### For sandbox environment
+Barbeque's enqueue API tries to be independent of MySQL by design.
+Although that design policy, verifying the enqueued job is useful in some environment (such as sandboxed environment).
+Passing `BARBEQUE_VERIFY_ENQUEUED_JOBS=1` to the Web API server enables the feature that verifies the enqueued job by accessing MySQL.
+
 ### Worker
 
 ```bash

data/app/controllers/barbeque/api/job_executions_controller.rb

@@ -6,6 +6,11 @@ class Barbeque::Api::JobExecutionsController < Barbeque::Api::ApplicationControl
     string :job, required: true, description: 'Class of Job to be enqueued'
     string :queue, required: true, description: 'Queue name to enqueue a job'
     any :message, required: true, description: 'Free-format JSON'
+    integer :delay_seconds, description: 'Set message timer of SQS'
+  end
+
+  rescue_from Barbeque::MessageEnqueuingService::BadRequest do |exc|
+    render status: 400, json: { error: exc.message }
   end
 
   private
@@ -32,6 +37,7 @@ class Barbeque::Api::JobExecutionsController < Barbeque::Api::ApplicationControl
       job:         params[:job],
       queue:       params[:queue],
       message:     params[:message],
+      delay_seconds: params[:delay_seconds],
     ).run
   end
 

data/app/controllers/barbeque/sns_subscriptions_controller.rb

@@ -44,6 +44,6 @@ class Barbeque::SnsSubscriptionsController < Barbeque::ApplicationController
   private
 
   def fetch_sns_topic_arns
-    Barbeque::SNSSubscriptionService.sns_client.list_topics.topics.map(&:topic_arn)
+    Barbeque::SNSSubscriptionService.sns_client.list_topics.flat_map(&:topics).map(&:topic_arn)
   end
 end

data/app/models/barbeque/api/job_execution_resource.rb

@@ -1,11 +1,9 @@
 class Barbeque::Api::JobExecutionResource < Barbeque::Api::ApplicationResource
   property :message_id
-
   property :status
-
   property :id
-
   property :html_url, selectable: true
+  property :message, selectable: true
 
   delegate :message_id, :status, :id, to: :model
 
@@ -21,4 +19,11 @@ class Barbeque::Api::JobExecutionResource < Barbeque::Api::ApplicationResource
       nil
     end
   end
+
+  def message
+    log = @model.execution_log
+    if log
+      log['message']
+    end
+  end
 end

data/app/services/barbeque/message_enqueuing_service.rb

@@ -2,6 +2,10 @@ require 'aws-sdk-sqs'
 
 class Barbeque::MessageEnqueuingService
   DEFAULT_QUEUE = ENV['BARBEQUE_DEFAULT_QUEUE'] || 'default'
+  VERIFY_ENQUEUED_JOBS = ENV['BARBEQUE_VERIFY_ENQUEUED_JOBS'] || '0'
+
+  class BadRequest < StandardError
+  end
 
   def self.sqs_client
     @sqs_client ||= Aws::SQS::Client.new
@@ -11,21 +15,31 @@ class Barbeque::MessageEnqueuingService
   # @param [String] job
   # @param [Object] message
   # @param [String] queue
-  def initialize(application:, job:, message:, queue: nil)
+  # @param [Integer, nil] delay_seconds
+  def initialize(application:, job:, message:, queue: nil, delay_seconds: nil)
     @application = application
     @job         = job
     @queue       = queue || DEFAULT_QUEUE
     @message     = message
+    @delay_seconds = delay_seconds
   end
 
   # @return [String] message_id
   def run
     queue_url = Barbeque::JobQueue.queue_url_from_name(@queue)
+    if VERIFY_ENQUEUED_JOBS == '1'
+      unless Barbeque::JobDefinition.joins(:app).merge(Barbeque::App.where(name: @application)).where(job: @job).exists?
+        raise BadRequest.new("JobDefinition '#{@job}' isn't defined in '#{@application}' application")
+      end
+    end
     response = Barbeque::MessageEnqueuingService.sqs_client.send_message(
       queue_url:    queue_url,
       message_body: build_message.to_json,
+      delay_seconds: @delay_seconds,
     )
     response.message_id
+  rescue Aws::SQS::Errors::InvalidParameterValue => e
+    raise BadRequest.new(e.message)
   end
 
   private

data/lib/barbeque/version.rb

@@ -1,3 +1,3 @@
 module Barbeque
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barbeque
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adminlte2-rails