active_elastic_job 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d19d4e4ef144ceabffd14c20daae3b285df14616
+  data.tar.gz: 70be0d9706ef4ae1f7a91d14380522e5263a2c31
+SHA512:
+  metadata.gz: 829d4cd3713427e6b85ed76a0a9e212b63ad5ab1232c901d30f2ad5360db90af1e242ef0fe8f37c0d01475911ad3d88e8d5dfdb22c41e17fcc3d9f04c32f5486
+  data.tar.gz: 7cea59eaaa8091a0cfa95c103ef373874f31225223e60d87e5ce9c41b5135a9ab4db6099a66f5f6d0c384174372a838c947624e71e1a3b099b74cc905983b17d

data/active-elastic-job.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'active_elastic_job/version'
+
+Gem::Specification.new do |spec|
+  spec.platform      = Gem::Platform::RUBY
+  spec.name          = 'active_elastic_job'
+  spec.version       = ActiveElasticJob::VERSION
+  spec.authors       = ['Tawan Sierek']
+  spec.email         = ['tawan@sierek.com']
+  spec.description   = 'Active Elastic Job is a simple to use Active Job backend for Rails applications deployed on the Amazon Elastic Beanstalk platform.'
+  spec.summary       = spec.description
+  spec.license       = 'MIT'
+  spec.homepage      = 'https://github.com/tawan/active-elastic-job'
+
+  spec.files         = Dir.glob('lib/**/*') + [ 'active-elastic-job.gemspec' ]
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'rails', '~> 4.2'
+  spec.add_development_dependency 'rdoc'
+  spec.add_dependency 'aws-sdk', '~> 2'
+end

data/lib/active_elastic_job.rb

@@ -0,0 +1,9 @@
+require 'aws-sdk-core'
+require 'active_elastic_job/version'
+require 'active_job/queue_adapters/active_elastic_job_adapter'
+require 'active_elastic_job/rack/sqs_message_consumer'
+require 'active_elastic_job/message_verifier'
+
+module ActiveElasticJob; end;
+
+require "active_elastic_job/railtie" if defined? Rails

data/lib/active_elastic_job/message_verifier.rb

@@ -0,0 +1,32 @@
+require 'active_support/security_utils'
+
+module ActiveElasticJob
+  class MessageVerifier #:nodoc:
+
+    # Raised when digest generated by
+    # <tt>ActiveJob::QueueAdapters::ActiveElasticJobAdapter</tt> could not
+    # be verified.
+    class InvalidDigest < StandardError
+    end
+
+    def initialize(secret)
+      @secret = secret
+    end
+
+    def verify(message, digest)
+      if message.nil? || message.blank? || digest.nil? || digest.blank?
+        raise InvalidDigest
+      end
+
+      unless ActiveSupport::SecurityUtils.secure_compare(digest, generate_digest(message))
+        raise InvalidDigest
+      end
+      true
+    end
+
+    def generate_digest(message)
+      require 'openssl' unless defined?(OpenSSL)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get('SHA1').new, @secret, message)
+    end
+  end
+end

data/lib/active_elastic_job/rack/sqs_message_consumer.rb

@@ -0,0 +1,47 @@
+require "action_dispatch"
+
+module ActiveElasticJob
+  module Rack
+    # 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.
+    # 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
+    # environment, which verifies the digest, have to use the *same*
+    # +secrets.secret_key_base+ setting.
+    class SqsMessageConsumer
+      def initialize(app) #:nodoc:
+        @app = app
+      end
+
+      def call(env) #:nodoc:
+        request = ActionDispatch::Request.new env
+        if request.headers['User-Agent'] =~ /aws-sqsd/
+          begin
+            verify(request)
+            job = JSON.load(request.body)
+            ActiveJob::Base.execute(job)
+          rescue ActiveElasticJob::MessageVerifier::InvalidDigest => e
+            return ['403', {'Content-Type' => env['text/plain'] }, ["incorrect digest"]]
+          rescue StandardError => e
+            return ['500', {'Content-Type' => env['text/plain'] }, [e.message]]
+          end
+          return ['200', {'Content-Type' => 'application/json' }, [ '' ]]
+        end
+        @app.call(env)
+      end
+
+      private
+
+      def verify(request)
+        secret_key_base = Rails.application.secrets[:secret_key_base]
+        verifier = ActiveElasticJob::MessageVerifier.new(secret_key_base)
+        digest = request.headers['HTTP_X_AWS_SQSD_ATTR_MESSAGE_DIGEST']
+        verifier.verify(request.body.string, digest)
+      end
+    end
+  end
+end

data/lib/active_elastic_job/railtie.rb

@@ -0,0 +1,7 @@
+module ActiveElasticJob
+  class Railtie < Rails::Railtie
+    initializer "active_elastic_job.insert_middleware" do |app|
+      app.config.middleware.use "ActiveElasticJob::Rack::SqsMessageConsumer"
+    end
+  end
+end

data/lib/active_elastic_job/version.rb

@@ -0,0 +1,3 @@
+module ActiveElasticJob
+  VERSION = '1.0.0'
+end

data/lib/active_job/queue_adapters/active_elastic_job_adapter.rb

@@ -0,0 +1,66 @@
+module ActiveJob
+  module QueueAdapters
+    # == Active Elastic Job adapter for Active Job
+    #
+    # Active Elastic Job provides (1) an adapter (this class) for Rails'
+    # Active Job framework and (2) a Rack middleware to process job 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].
+    #
+    # 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>
+    #
+    # 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
+      class << self
+        def enqueue(job) #:nodoc:
+          enqueue_at(job, Time.now)
+        end
+
+        def enqueue_at(job, timestamp) #:nodoc:
+          queue_url = aws_sqs_client.create_queue(queue_name: job.queue_name.to_s).queue_url
+          message_body = JSON.dump(job.serialize)
+          delay = (timestamp - Time.current.to_f).to_i + 1
+          if delay > 15.minutes
+            msg =<<-MSG
+             Jobs cannot be scheduled more than 15 minutes into the future.
+             See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html
+             for further details!
+            MSG
+            raise RangeError, 'The maximum allowed delay is 15 minutes' if delay > 15.minutes
+          end
+
+          aws_sqs_client.send_message(
+            queue_url: queue_url,
+            message_body: message_body,
+            delay_seconds: delay,
+            message_attributes: {
+              "message_digest" => {
+                string_value: message_digest(message_body),
+                data_type: "String"
+              }
+            }
+          )
+        end
+
+        private
+
+        def aws_sqs_client
+          Aws::SQS::Client.new(
+            access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+            secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
+            region: ENV['AWS_REGION']
+          )
+        end
+
+        def message_digest(messsage_body)
+          secret_key_base = Rails.application.secrets[:secret_key_base]
+          verifier = ActiveElasticJob::MessageVerifier.new(secret_key_base)
+          verifier.generate_digest(messsage_body)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: active_elastic_job
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tawan Sierek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Active Elastic Job is a simple to use Active Job backend for Rails applications
+  deployed on the Amazon Elastic Beanstalk platform.
+email:
+- tawan@sierek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- active-elastic-job.gemspec
+- lib/active_elastic_job.rb
+- lib/active_elastic_job/message_verifier.rb
+- lib/active_elastic_job/rack/sqs_message_consumer.rb
+- lib/active_elastic_job/railtie.rb
+- lib/active_elastic_job/version.rb
+- lib/active_job/queue_adapters/active_elastic_job_adapter.rb
+homepage: https://github.com/tawan/active-elastic-job
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Active Elastic Job is a simple to use Active Job backend for Rails applications
+  deployed on the Amazon Elastic Beanstalk platform.
+test_files: []