active_elastic_job 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c8395a6c3ac158c58cf57615c9df6bbe847ea76
-  data.tar.gz: 33b4188334606d4df92dd4fff85e2fc6a5558629
+  metadata.gz: f7f80373d7f57286083c91bfb62632d463df9b7a
+  data.tar.gz: 30ad4c79acf1d9a8393092bdf430f7416b606239
 SHA512:
-  metadata.gz: e53f0f7464e92f180bbd19af890a8069dbecafab7032865c4eb8f83052c7f01a3497c83383e023c996097875c4208fb70b1274e83e868fb80d50257eaeb53390
-  data.tar.gz: 44fab25e6c687772f19b01816ee56f94ccefc06e517a541b5aad1363f9a72f289d6a65713f5e663d89a7dda86844d070ca5ad8e4c3f0670b93102b5760958e17
+  metadata.gz: 72d3f884abb6f6b16d0c43fe2c537ba64d80acba7e65ff2a97faaea99d16b4e6b45666aeb33f232b95cf227b8d16af172385bc9dfcc5d978720fe97f3ea6742a
+  data.tar.gz: b5f4204e84cc39de88f67f321fbc758021b1fbcbb698cc7c991e1a1e0e14b0b9d6d177f92f92191840a01e9e72e29e4b5796886dfa4d2482e310889b89eafda1

data/lib/active_elastic_job/md5_message_digest_calculation.rb

@@ -1,4 +1,4 @@
-require 'digest'
+require 'openssl'
 module ActiveElasticJob
   # This module provides methods that calculate the MD5 digest for Amazon
   # SQS message bodies and message attributes.
@@ -29,35 +29,30 @@ module ActiveElasticJob
       'Number' => 1
     }
 
-    CHARSET_ENCODING = Encoding::UTF_8
+    NORMALIZED_ENCODING = Encoding::UTF_8
 
-    # Returns MD5 digest of +message_body+.
     def md5_of_message_body(message_body)
       OpenSSL::Digest::MD5.hexdigest(message_body)
     end
 
-    # Returns MD5 digest of +message_attributes+.
-    #
-    # The calculation follows the official algorithm which
-    # is specified by Amazon.
     def md5_of_message_attributes(message_attributes)
-      encoded = message_attributes.each.with_object({ }) do |(name, v), hash|
-        hash[name.to_s] = ""
-        data_type = v['data_type'] || v[:data_type]
+      encoded = { }
+      message_attributes.each do |name, attribute|
+        name = name.to_s
+        encoded[name] = String.new
+        encoded[name] << encode_length_and_bytes(name) <<
+        encode_length_and_bytes(attribute[:data_type]) <<
+        [TRANSPORT_TYPE_ENCODINGS[attribute[:data_type]]].pack('C'.freeze)
 
-        hash[name.to_s] << encode_length_and_bytes(name.to_s) <<
-          encode_length_and_bytes(data_type) <<
-          [ TRANSPORT_TYPE_ENCODINGS[data_type] ].pack('C')
-
-        if string_value = v['string_value'] || v[:string_value]
-          hash[name.to_s] << encode_length_and_string(string_value)
-        elsif binary_value = v['binary_value'] || v[:binary_value]
-          hash[name.to_s] << encode_length_and_bytes(binary_value)
+        if string_value = attribute[:string_value]
+          encoded[name] << encode_length_and_string(string_value)
+        elsif binary_value = attribute[:binary_value]
+          encoded[name] << encode_length_and_bytes(binary_value)
         end
       end
 
-      buffer = encoded.keys.sort.reduce("") do |b, name|
-        b << encoded[name]
+      buffer = encoded.keys.sort.reduce(String.new) do |string, name|
+        string << encoded[name]
       end
       OpenSSL::Digest::MD5.hexdigest(buffer)
     end
@@ -65,15 +60,13 @@ module ActiveElasticJob
     private
 
     def encode_length_and_string(string)
-      return '' if string.nil?
       string = String.new(string)
-      string.encode!(CHARSET_ENCODING)
+      string.encode!(NORMALIZED_ENCODING)
       encode_length_and_bytes(string)
     end
 
     def encode_length_and_bytes(bytes)
-      return '' if bytes.nil?
-      [ bytes.bytesize, bytes ].pack("L>a#{bytes.bytesize}")
+      [bytes.bytesize, bytes].pack('L>a*'.freeze)
     end
   end
 end

data/lib/active_elastic_job/message_verifier.rb

@@ -13,20 +13,22 @@ module ActiveElasticJob
       @secret = secret
     end
 
-    def verify!(message, digest)
+    def verify(message, digest)
       if message.nil? || message.blank? || digest.nil? || digest.blank?
-        raise InvalidDigest
+        return false
       end
 
-      unless ActiveSupport::SecurityUtils.secure_compare(digest, generate_digest(message))
-        raise InvalidDigest
-      end
-      true
+      return ActiveSupport::SecurityUtils.secure_compare(
+        digest, generate_digest(message))
+    end
+
+    def verify!(message, digest)
+      raise InvalidDigest unless verify(message, digest)
     end
 
     def generate_digest(message)
       require 'openssl' unless defined?(OpenSSL)
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get('SHA1').new, @secret, message)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA1.new, @secret, message)
     end
   end
 end

data/lib/active_elastic_job/rack/sqs_message_consumer.rb

@@ -5,8 +5,8 @@ module ActiveElasticJob
     # This middleware intercepts requests which are sent by the SQS daemon
     # running in {Amazon Elastic Beanstalk worker environments}[http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html].
     # It does this by looking at the +User-Agent+ header.
-    # Furthermore, it verifies the digest which is sent along with a legit SQS message,
-    # and passed as an HTTP header in the resulting request.
+    # Furthermore, it verifies the digest which is sent along with a legit SQS
+    # message, and passed as an HTTP header in the resulting request.
     # The digest is based on Rails' +secrets.secret_key_base+.
     # Therefore, the application running in the web environment, which generates
     # the digest, and the application running in the worker
@@ -36,11 +36,20 @@ module ActiveElasticJob
             job = JSON.load(request.body)
             ActiveJob::Base.execute(job)
           rescue ActiveElasticJob::MessageVerifier::InvalidDigest => e
-            return ['403', {CONTENT_TYPE_HEADER_NAME => 'text/plain' }, ["incorrect digest"]]
+            return [
+              '403',
+              {CONTENT_TYPE_HEADER_NAME => 'text/plain' },
+              ["incorrect digest"]]
           rescue StandardError => e
-            return ['500', {CONTENT_TYPE_HEADER_NAME => 'text/plain' }, [e.message]]
+            return [
+              '500',
+              {CONTENT_TYPE_HEADER_NAME => 'text/plain' },
+              [e.message]]
           end
-          return [OK_RESPONSE_CODE , {CONTENT_TYPE_HEADER_NAME => CONTENT_TYPE }, [ '' ]]
+          return [
+            OK_RESPONSE_CODE ,
+            {CONTENT_TYPE_HEADER_NAME => CONTENT_TYPE },
+            [ '' ]]
         end
         @app.call(env)
       end

data/lib/active_elastic_job/version.rb

@@ -2,7 +2,7 @@ module ActiveElasticJob
   module VERSION
     MAJOR = 1
     MINOR = 4
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/active_job/queue_adapters/active_elastic_job_adapter.rb

@@ -8,9 +8,11 @@ module ActiveJob
     # environments}[http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html].
     #
     # This adapter serializes job objects and sends them as a message to an
-    # Amazon SQS queue specified by the job's queue name, see <tt>ActiveJob::Base.queue_as</tt>
+    # Amazon SQS queue specified by the job's queue name,
+    # see <tt>ActiveJob::Base.queue_as</tt>
     #
-    # To use Active Elastic Job, set the queue_adapter config to +:active_elastic_job+.
+    # To use Active Elastic Job, set the queue_adapter config
+    # to +:active_elastic_job+.
     #
     #   Rails.application.config.active_job.queue_adapter = :active_elastic_job
     class ActiveElasticJobAdapter
@@ -34,9 +36,9 @@ which exceeds the allowed maximum of #{MAX_MESSAGE_SIZE} bytes imposed by Amazon
       end
 
       # Raised when job queue does not exist. The job queue is determined by
-      # <tt>ActiveJob::Base.queue_as</tt>. You can either: (1) create a new Amazon
-      # SQS queue and attach a worker environment to it, or (2) select a different
-      # queue for your jobs.
+      # <tt>ActiveJob::Base.queue_as</tt>. You can either: (1) create a new
+      # Amazon SQS queue and attach a worker environment to it, or (2) select a
+      # different queue for your jobs.
       #
       # Example:
       # * Open your AWS console and create an SQS queue named +high_priority+ in
@@ -49,12 +51,12 @@ which exceeds the allowed maximum of #{MAX_MESSAGE_SIZE} bytes imposed by Amazon
       #  end
       class NonExistentQueue < Error
         def initialize(queue_name)
-          msg = <<-MSG
-The job is bound to queue at #{queue_name}. Unfortunately a queue
-with this name does not exist in this region. Either create an Amazon SQS queue
-named #{queue_name} - you can do this in AWS console, make sure to select
-region '#{ENV['AWS_REGION']}' - or you select another queue for your jobs.
-          MSG
+          msg = "The job is bound to queue at #{queue_name}. " <<
+           "Unfortunately a queue with this name does not exist in this " <<
+           "region. Either create an Amazon SQS queue named #{queue_name} - " <<
+           "you can do this in AWS console, make sure to select region " <<
+           "'#{ENV['AWS_REGION']}' - or you select another queue for your jobs."
+
           super msg
         end
       end
@@ -62,11 +64,12 @@ region '#{ENV['AWS_REGION']}' - or you select another queue for your jobs.
       # Raised when calculated MD5 digest does not match the MD5 Digest
       # of the response from Amazon SQS.
       class MD5MismatchError < Error
-        def initialize( message_id)
-          msg = <<-MSG
-MD5 returned by Amazon SQS does not match the calculation on the original request.
-The message with Message ID #{message_id} sent to SQS might be corrupted.
-          MSG
+        def initialize(message_id)
+          msg = "MD5 returned by Amazon SQS does not match the calculation " <<
+            "on the original request. The message with Message ID " <<
+            "#{message_id} sent to SQS might be corrupted."
+
+          super msg
         end
       end
 
@@ -128,13 +131,14 @@ The message with Message ID #{message_id} sent to SQS might be corrupted.
         def calculate_delay(timestamp)
           delay = (timestamp - Time.current.to_f).to_i + 1
           if delay > MAX_DELAY_IN_MINUTES.minutes
-            msg =<<-MSG
-Jobs cannot be scheduled more than #{MAX_DELAY_IN_MINUTES} minutes into the future.
-See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html
-for further details!
-            MSG
-            raise RangeError
+            msg = "Jobs cannot be scheduled more than " <<
+            "#{MAX_DELAY_IN_MINUTES} minutes into the future. " <<
+            "See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html" <<
+            " for further details!"
+
+            raise RangeError, msg
           end
+          delay = 0 if delay < 0
           delay
         end
 
@@ -158,7 +162,7 @@ for further details!
           @verifier.generate_digest(messsage_body)
         end
 
-        def verify_md5_digests!(response, messsage_body, message_attributes = nil)
+        def verify_md5_digests!(response, messsage_body, message_attributes)
           if md5_of_message_body(messsage_body) != response.md5_of_message_body
             raise MD5MismatchError, response.message_id
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_elastic_job
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Tawan Sierek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk