coach 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f314e7cc1779f326294cede2142167c325fd5182cc403b17dcdf2ffa4a0ab2f0
-  data.tar.gz: c29c7bc00999c22d65ed1da8268761ff1633f936e58e856dd9f2b3dad189ce80
+  metadata.gz: 9d5d8146dab264d6d7e2f1177101b9f7f5c62f44840964fb9672b7de7d01fe20
+  data.tar.gz: '058153f00f46e7eac0d26eb7039af4624e9636954fd59999f9bcf419fe559abf'
 SHA512:
-  metadata.gz: da2a45e51025660adc160604297d3614fea894b79b203be1ee8b337832281d59d4a4f8e3e4aa222209754251763cecced1e225a039921e9f8a979a2b741410e6
-  data.tar.gz: fc581d18446b2fbab925e49a4cb984d06d7112f1e90bde8dffb07ae124d0a061a9f6c107afd4addc1c8058ec5be503316d5a7437042b9d9c3ffbf602c6522af4
+  metadata.gz: 04204eb3b4029928a706b5d9894984462698ee337ccdb3d96e224da1bfc8debf4970b1eb5ba0b8b8cd14960171b8e926d5369f12eea66fcd42ded4bad5de1738
+  data.tar.gz: a3db075dddeff6e111cdac3bdef7236e8d461fb86c9aa7b696dd15ffd2b8cb5db2b755c07f2465e51eeee5963461a5ae72985aa924e4d9a1340a18987f428391

data/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 No unreleased changes.
 
+# 2.1.0 / 2019-11-14
+
+* [#79](https://github.com/gocardless/coach/pull/79) RequestSerializer will now
+  return the 'http_content_type' and 'http_content_length' filtered headers.
+
+* [#75](https://github.com/gocardless/coach/pull/75) Documentation update.
+
 # 2.0.0 / 2019-06-13
 
 ## Breaking changes

data/README.md

@@ -309,10 +309,21 @@ solution to Rails `process_action.action_controller` event emitted on controller
 The benchmarking data includes information on how long each middleware took to process,
 along with the total duration of the chain.
 
+For coach to emit `request.coach` events, it first needs to be subscribed to handler/middleware events:
+
+```ruby
+Coach::Notifications.subscribe!
+
+# Now you can subscribe to and use request.coach events, e.g.
+ActiveSupport::Notifications.subscribe("request.coach") do |_, event|
+  Rails.logger.info(event)
+end
+```
+
 You can add additional metadata to the notifications published by Coach by calling the
 `log_metadata` method from inside your Coach middlewares.
 
-```
+```ruby
 class Tracking < Coach::Middleware
   requires :user
 

data/coach.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionpack", ">= 4.2"
   spec.add_dependency "activesupport", ">= 4.2"
 
-  spec.add_development_dependency "gc_ruboconfig", "= 2.4.0"
+  spec.add_development_dependency "gc_ruboconfig", "= 2.6.1"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "rspec-its", "~> 1.2"

data/lib/coach/notifications.rb

@@ -10,7 +10,7 @@ module Coach
   # Notifications is used to coordinate the listening and aggregation of these middleware
   # notifications, while RequestEvent processes the published data.
   #
-  # Once a request has completed, Notifications will emit a 'requst.coach' with
+  # Once a request has completed, Notifications will emit a 'request.coach' event with
   # aggregated request data.
   class Notifications
     # Begin processing/emitting 'request.coach's

data/lib/coach/request_serializer.rb

@@ -2,6 +2,11 @@
 
 module Coach
   class RequestSerializer
+    # Rack specs dictate that CONTENT_TYPE and CONTENT_LENGTH
+    # are not prefixed with HTTP_.
+    # See https://rubydoc.info/github/rack/rack/master/file/SPEC
+    RACK_UNPREFIXED_HEADERS = %w[CONTENT_TYPE CONTENT_LENGTH].freeze
+
     def self.header_rules
       @header_rules ||= {}
     end
@@ -57,9 +62,13 @@ module Coach
 
     def filtered_headers
       header_value_pairs = @request.filtered_env.map do |key, value|
-        next unless key =~ /^HTTP_/
+        key = if RACK_UNPREFIXED_HEADERS.include?(key)
+                "http_#{key.downcase}"
+              elsif key =~ /^HTTP_/
+                key.downcase
+              end
 
-        [key.downcase, self.class.apply_header_rule(key.downcase, value)]
+        [key, self.class.apply_header_rule(key, value)] if key
       end.compact
 
       Hash[header_value_pairs]

data/lib/coach/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coach
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/lib/coach/request_serializer_spec.rb

@@ -47,10 +47,14 @@ describe Coach::RequestSerializer do
                                                    uuid: nil,
                                                    method: nil,
                                                    filtered_parameters: nil,
-                                                   filtered_env: {
-                                                     "foo" => "bar",
-                                                     "HTTP_foo" => "bar",
-                                                   })
+                                                   filtered_env: filtered_env)
+      end
+
+      let(:filtered_env) do
+        {
+          "foo" => "bar",
+          "HTTP_foo" => "bar",
+        }
       end
 
       describe "#serialize" do
@@ -62,11 +66,31 @@ describe Coach::RequestSerializer do
           expect(serialized[:path]).to eq("unknown")
         end
 
-        it "filters headers allowing only those prefixed with 'HTTP_'" do
-          allow(mock_request).to receive(:fullpath).and_return(nil)
+        context "filters headers" do
+          before do
+            allow(mock_request).to receive(:fullpath).and_return(nil)
+          end
+
+          it "allowing those prefixed with 'HTTP_'" do
+            expect(serialized[:headers]).to_not include("foo")
+            expect(serialized[:headers]).to include("http_foo")
+          end
+
+          context "Content-Type and Content-Length" do
+            let(:filtered_env) do
+              {
+                "foo" => "foo",
+                "CONTENT_TYPE" => "application/json",
+                "CONTENT_LENGTH" => 42,
+              }
+            end
 
-          expect(serialized[:headers]).to_not include("foo")
-          expect(serialized[:headers]).to include("http_foo")
+            it "prefixing with 'http_'" do
+              expect(serialized[:headers]).to_not include("foo")
+              expect(serialized[:headers]).to include("http_content_type")
+              expect(serialized[:headers]).to include("http_content_length")
+            end
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Alternative controllers built with middleware