govuk_sidekiq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fbf655d18d2914d3720c3b011abb49c5cf43895
+  data.tar.gz: ed5ccf95e8be8d80df17266e71a4a9a4deff459b
+SHA512:
+  metadata.gz: a51fe08e06acb4bb896bebe3d23f75f98440afc11c8a518bffeb411a792371687df95866bf97302d7183a8ac54216c9a8026f867310f4a6cfe1803f113bb63fa
+  data.tar.gz: 0278ff5f0f7058f99d44d8b498e74aaa12fe1ea49b0425d70f387fc9f00c1b25bc5665e54ce58a61ededa6c4c26a58841580a514e9c35c07691382cff2506e89

data/LICENCE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# GOVUK Sidekiq
+
+Provides a unified set of configurations and behaviours when using Sidekiq
+in GOV.UK applications.
+
+## Technical documentation
+
+When added to a Rails application, this gem uses a railtie to inject an
+initializer configuring Sidekiq.
+
+It includes our current optimal sidekiq configuration
+including Airbrake/Errbit, statsd, JSON logging,
+and passthrough of the `govuk_request_id`.
+
+No other configuration is required other than the presence of the following
+environment variables:
+
+- **GOVUK_APP_NAME**, used for Redis and statsd namespacing.
+- **REDIS_HOST**
+- **REDIS_PORT**
+
+This gem also assumes that the app has separately configured and required Airbrake/Errbit.
+
+## Licence
+
+[MIT License](LICENCE)
+
+## Versioning policy
+
+See https://github.com/alphagov/styleguides/blob/master/rubygems.md#versioning

data/lib/govuk_sidekiq/api_headers.rb

@@ -0,0 +1,33 @@
+require "gds_api/govuk_headers"
+
+module GovukSidekiq
+  module APIHeaders
+    # Client-side middleware runs before the pushing of the job to Redis and
+    # allows you to modify/stop the job before it gets pushed.
+    #
+    # https://github.com/mperham/sidekiq/wiki/Middleware#client-side-middleware
+    class ClientMiddleware
+      def call(worker_class, job, queue, redis_pool)
+        job["args"] << { request_id: GdsApi::GovukHeaders.headers[:govuk_request_id] }
+        yield
+      end
+    end
+
+    # Server-side middleware runs 'around' job processing.
+    #
+    # https://github.com/mperham/sidekiq/wiki/Middleware#server-side-middleware
+    class ServerMiddleware
+      def call(worker, message, queue)
+        last_arg = message["args"].last
+
+        if last_arg.is_a?(Hash) && last_arg.keys == ["request_id"]
+          message["args"].pop
+          request_id = last_arg["request_id"]
+          GdsApi::GovukHeaders.set_header(:govuk_request_id, request_id)
+        end
+
+        yield
+      end
+    end
+  end
+end

data/lib/govuk_sidekiq/railtie.rb

@@ -0,0 +1,11 @@
+module GovukSidekiq
+  class Railtie < Rails::Railtie
+    initializer "govuk_sidekiq.initialize_sidekiq" do |app|
+      SidekiqInitializer.setup_sidekiq(
+        ENV["GOVUK_APP_NAME"] || app.root.basename.to_s,
+        ENV["REDIS_HOST"] || "127.0.0.1",
+        ENV["REDIS_PORT"] || 6379
+      )
+    end
+  end
+end

data/lib/govuk_sidekiq/sidekiq_initializer.rb

@@ -0,0 +1,36 @@
+require "sidekiq"
+require "sidekiq/logging/json"
+require "airbrake"
+require "govuk_sidekiq/api_headers"
+
+module GovukSidekiq
+  module SidekiqInitializer
+    def self.setup_sidekiq(govuk_app_name, redis_host, redis_port)
+      redis_config = {
+        host: redis_host,
+        port: redis_port,
+        namespace: govuk_app_name,
+      }
+
+      Sidekiq.configure_server do |config|
+        config.redis = redis_config
+        config.error_handlers << Proc.new { |ex, context_hash| Airbrake.notify(ex, context_hash) }
+
+        config.server_middleware do |chain|
+          chain.add Sidekiq::Statsd::ServerMiddleware, env: "govuk.app.#{govuk_app_name}", prefix: "workers"
+          chain.add GovukSidekiq::APIHeaders::ServerMiddleware
+        end
+      end
+
+      Sidekiq.configure_client do |config|
+        config.redis = redis_config
+
+        config.client_middleware do |chain|
+          chain.add GovukSidekiq::APIHeaders::ClientMiddleware
+        end
+      end
+
+      Sidekiq.logger.formatter = Sidekiq::Logging::Json::Logger.new
+    end
+  end
+end

data/lib/govuk_sidekiq/version.rb

@@ -0,0 +1,3 @@
+module GovukSidekiq
+  VERSION = "0.0.1"
+end

data/lib/govuk_sidekiq.rb

@@ -0,0 +1 @@
+require "govuk_sidekiq/railtie" if defined?(Rails)

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: govuk_sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elliot Crosby-McCullough
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-statsd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-logging-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: gds-api-adapters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 19.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 19.1.0
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: gem_publisher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+description: 
+email:
+- elliot.cm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE.txt
+- README.md
+- lib/govuk_sidekiq.rb
+- lib/govuk_sidekiq/api_headers.rb
+- lib/govuk_sidekiq/railtie.rb
+- lib/govuk_sidekiq/sidekiq_initializer.rb
+- lib/govuk_sidekiq/version.rb
+homepage: http://github.com/alphagov/govuk_sidekiq
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides standard setup and behaviour for Sidekiq in GOV.UK applications.
+test_files: []