govuk_app_config 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f75a510e41a852ad4de24feb231868a11cbe2d72
-  data.tar.gz: 3c132b844a90fd02e1ab4420f96f862f372ceb39
+SHA256:
+  metadata.gz: cfbbf851de1ea4b966c7f5ba023721ca63de31f44de65a991c66f7753ff8cb8f
+  data.tar.gz: ac5b1d8780279f8307d4aba4e8350b4aecaf52939bb60fd2bb1e75e566e41aeb
 SHA512:
-  metadata.gz: 2d0c6306d1875583b42cb1e05463b473b53266fec17b333a11bd636024b81e982afb32c105671e2d39ab2c16998db16b32c95e8af8850bc2a0fb14bd6398cec3
-  data.tar.gz: 490dea815d8deec8623a23fed6984c3bdf98772bcc8fb36c346482e71518ffdd24d6aa6c71f48990740ba397e37cf61fa80816a7c05d7b964973c71db0da60f1
+  metadata.gz: 99d9c59c7815739ff8d4c95a3eaf8dd0404fd990d406569de4d8ee1a686c9b7be725e8f1a4208d72939686a9062657848857b1535f28dbbd9333264798435863
+  data.tar.gz: ba27e95fb497c8c30b1a6876f20c2e4ba4bb546aa5f1280270865b3cb01818aa554332df53e238ab5dadb3271948ddc0782f9e0d61a535146388292f162ad99a

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 1.3.0
+
+* Include a class to configure unicorn to the common GOV.UK configuration
+
+### How to upgrade
+
+* Find or create a config/unicorn.rb file in the app
+* At the top of the file insert:
+  ```rb
+  require "govuk_app_config"
+  GovukUnicorn.configure(self)
+  ```
+* If the app has the following, remove it:
+  ```rb
+  # Load the system-wide standard Unicorn file
+  def load_file_if_exists(config, file)
+    config.instance_eval(File.read(file)) if File.exist?(file)
+  end
+  load_file_if_exists(self, "/etc/govuk/unicorn.rb")
+  ```
+
 # 1.2.1
 
 * Use `INFO` log level for the default Rails logger

data/README.md

@@ -12,18 +12,34 @@ Adds the basics of a GOV.UK application:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'govuk_app_config'
+gem "govuk_app_config"
 ```
 
 And then execute:
 
     $ bundle
 
-## Usage
 
 ## Unicorn
 
-No configuration required.
+### Configuration
+
+Find or create a `config/unicorn.rb` in the app
+
+At the start of the file insert:
+
+```rb
+require "govuk_app_config"
+GovukUnicorn.configure(self)
+```
+
+### Usage
+
+To serve an app with unicorn run:
+
+```sh
+$ bundle exec unicorn -c config/unicorn.rb
+```
 
 ## Error reporting
 
@@ -34,7 +50,7 @@ If you include `govuk_app_config` in your `Gemfile`, Rails' autoloading mechanis
 If you use the gem outside of Rails you'll have to explicitly require it:
 
 ```rb
-require 'govuk_app_config'
+require "govuk_app_config"
 ```
 
 Your app will have to have the following environment variables set:
@@ -62,9 +78,9 @@ Extra parameters are:
 ```rb
 GovukError.notify(
   "Oops",
-  extra: { offending_content_id: '123' }, # Additional context for this event. Must be a hash. Children can be any native JSON type.
-  level: 'debug', # debug, info, warning, error, fatal
-  tags: { key: 'value' } # Tags to index with this event. Must be a mapping of strings.
+  extra: { offending_content_id: "123" }, # Additional context for this event. Must be a hash. Children can be any native JSON type.
+  level: "debug", # debug, info, warning, error, fatal
+  tags: { key: "value" } # Tags to index with this event. Must be a mapping of strings.
 )
 ```
 
@@ -87,12 +103,12 @@ Use `GovukStatsd` to send stats to graphite. It has the same interface as [the R
 Examples:
 
 ```ruby
-GovukStatsd.increment 'garets'
-GovukStatsd.timing 'glork', 320
-GovukStatsd.gauge 'bork', 100
+GovukStatsd.increment "garets"
+GovukStatsd.timing "glork", 320
+GovukStatsd.gauge "bork", 100
 
 # Use {#time} to time the execution of a block
-GovukStatsd.time('account.activate') { @account.activate! }
+GovukStatsd.time("account.activate") { @account.activate! }
 ```
 
 ## Rails logging

data/lib/govuk_app_config/govuk_unicorn.rb

@@ -0,0 +1,17 @@
+module GovukUnicorn
+  def self.configure(config)
+    config.worker_processes Integer(ENV.fetch("UNICORN_WORKER_PROCESSES", 2))
+
+    if ENV["GOVUK_APP_LOGROOT"]
+      config.stdout_path "#{ENV['GOVUK_APP_LOGROOT']}/app.out.log"
+      config.stderr_path "#{ENV['GOVUK_APP_LOGROOT']}/app.err.log"
+    end
+
+    config.before_exec do |server|
+      next unless ENV["GOVUK_APP_ROOT"]
+      ENV["BUNDLE_GEMFILE"] = "#{ENV['GOVUK_APP_ROOT']}/Gemfile"
+    end
+
+    config.check_client_connection true
+  end
+end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/lib/govuk_app_config.rb

@@ -2,5 +2,6 @@ require "govuk_app_config/version"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
 require "govuk_app_config/govuk_logging"
+require "govuk_app_config/govuk_unicorn"
 require "govuk_app_config/configure"
 require "govuk_app_config/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -160,6 +160,7 @@ files:
 - lib/govuk_app_config/govuk_error.rb
 - lib/govuk_app_config/govuk_logging.rb
 - lib/govuk_app_config/govuk_statsd.rb
+- lib/govuk_app_config/govuk_unicorn.rb
 - lib/govuk_app_config/railtie.rb
 - lib/govuk_app_config/version.rb
 homepage: https://github.com/alphagov/govuk_app_config
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications