simple_job 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bb025d9059b69eb50b47c4bbc028c14099de884
-  data.tar.gz: 707f5a66bbfdd89f98cc5e86969d9e7bec7d8847
+  metadata.gz: 7c017adc129ac7a434ceabc18789ffa3961e7a13
+  data.tar.gz: 4a7f812e0810ca90604bb300a10b43f31c019116
 SHA512:
-  metadata.gz: 2f3403565780e85f72e519a494f84eef280e831be7f3b4ab4dc22c053918377eb6d1bb6628f3f456cf2a9d0d900f874f6c42e8b4d8e7b5aeecf2465587ba07b0
-  data.tar.gz: b16e5270289067d2095778da0cc3a3fcfcb8ea97fadcff8281cf9e52847523beec3ef971f8f31df1cac4833032bc83a4507355c957b900972b83615003b79584
+  metadata.gz: 0a6c69686ed7cebc1ba2531a2df856d6f9f154181b1eeb3ff82b82e5f528df3e44b7fd3a6b07d24398b8958a35f4dbb6091fe5a5a0046a23dada6d060ee19a3a
+  data.tar.gz: 9f75a0b951dfd8b9d72c490ae40aeff1a2871e723a9e98ce81702203afe563f6592c76dd7318d41a2123b2a7219c396827f652d47860e0c879255459b47d0c82

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Simple Job
 
+== Version 0.12.0
+* Added accept_nested_definition option to SQSJobQueue
+* Updating specs and eliminating their dependency on AWS
+
 == Version 0.11.0
 * Using explicit aws-sdk-v1 to allow apps dependent on this library to use both v1 and v2 of aws sdk
 

data/lib/simple_job/sqs_job_queue.rb

@@ -42,20 +42,38 @@ class SQSJobQueue < JobQueue
   # then fork and execute the proper job in a separate process. This can be
   # used when you have long-running jobs that will exceed the visibility timeout,
   # and it is not critical that they be retried when they fail.
+  #
+  # You may pass an :accept_nested_definition option with a string value to allow this
+  # queue to accept messages where the body is nested within a hash entry. This
+  # facilitates easy processing of SNS and AutoScaling messages. For example, if you
+  # pass this option:
+  #
+  #   accept_nested_definition: 'NotificationMetadata'
+  #
+  # Then you can put a job body into the NotificationMetadata of an AutoScaling
+  # notification:
+  #
+  #   { "AutoScalingGroupName": "some_name", "Service": "AWS Auto Scaling" ...
+  #     "NotificationMetadata": "{\"type\":\"my_job\",\"version\":\"1\"}" }
+  #
+  # Then the queue will attempt to process incoming messages normally, but if it
+  # encounters a message missing a type and version, it will check the value
+  # passed into accept_nested_definition before failing.
   def self.define_queue(type, options = {})
     type = type.to_s
 
     options = {
-      :visibility_timeout => config[:default_visibility_timeout],
-      :asynchronous_execute => false,
-      :default => false,
+      visibility_timeout: config[:default_visibility_timeout],
+      asynchronous_execute: false,
+      default: false
     }.merge(options)
+    make_default = options.delete(:default)
 
-    queue = self.new(type, options[:visibility_timeout], options[:asynchronous_execute])
+    queue = self.new(type, options)
     self.queues ||= {}
     self.queues[type] = queue
 
-    @default_queue = queue if options[:default]
+    @default_queue = queue if make_default
     
     queue
   end
@@ -153,9 +171,10 @@ class SQSJobQueue < JobQueue
       current_job_type = 'unknown'
       begin
         sqs_queue.receive_messages(options) do |message|
+          message_body = get_message_body(message)
           last_message = message
           last_message_at = Time.now
-          raw_message = JSON.parse(message.body)
+          raw_message = JSON.parse(message_body)
           current_job_type = raw_message['type']
           definition_class = JobDefinition.job_definition_class_for(raw_message['type'], raw_message['version'])
 
@@ -165,7 +184,7 @@ class SQSJobQueue < JobQueue
             raise('max attempt count reached') 
           end
 
-          definition = definition_class.new.from_json(message.body)
+          definition = definition_class.new.from_json(message_body)
           last_definition = definition
 
           # NOTE: only executes if asynchronous_execute is false (message will be re-enqueued after
@@ -230,9 +249,9 @@ class SQSJobQueue < JobQueue
     attr_accessor :queues
   end
 
-  attr_accessor :queue_name, :sqs_queue, :visibility_timeout, :asynchronous_execute, :cloud_watch
+  attr_accessor :queue_name, :sqs_queue, :visibility_timeout, :asynchronous_execute, :cloud_watch, :accept_nested_definition
 
-  def initialize(type, visibility_timeout, asynchronous_execute)
+  def initialize(type, visibility_timeout:, asynchronous_execute:, accept_nested_definition: nil)
     sqs = ::AWS::SQS.new
     self.queue_name = "#{self.class.config[:queue_prefix]}-#{type}-#{self.class.config[:environment]}"
     self.sqs_queue = sqs.queues.create(queue_name)
@@ -242,6 +261,7 @@ class SQSJobQueue < JobQueue
       :aws_access_key_id => AWS.config.access_key_id,
       :aws_secret_access_key => AWS.config.secret_access_key
     )
+    self.accept_nested_definition = accept_nested_definition
   end
 
   def logger
@@ -350,6 +370,17 @@ class SQSJobQueue < JobQueue
     end
   end
 
+  def get_message_body(message)
+    result = message.body
+    message_hash = JSON.parse(result)
+
+    if (!message_hash.has_key?('type') || !message_hash.has_key?('version')) && accept_nested_definition
+      result = message_hash[accept_nested_definition]
+    end
+
+    result
+  end
+
 end
 end
 

data/lib/simple_job/version.rb

@@ -1,3 +1,3 @@
 module SimpleJob
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_job
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - David Dawson