coach 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e57234c99f6622d05b93fed13fb589250cab7082
-  data.tar.gz: 950d40743209a397c5509438b2056a9aa06e16ce
+  metadata.gz: 2f7d2343c7e554691c7dc038d2673e23c46656fb
+  data.tar.gz: 2cd586a0f983cd8e357f230fc9cacfdf11dbf4ec
 SHA512:
-  metadata.gz: 926d433306e25f0aba99f433a491b135e17405da467b5baaf36466d96929aeb7fc42204321b88ca74855e1a01dbe7f158b16474cfe905ce6ba3a3a259f2a93f1
-  data.tar.gz: 1b79b97214372ffa5411cd6c94d165af8efee424a4cf3542b0e91755ea34bac765d1f9873ad4e1584dd2f02ca4f17cf8f9557e958cbe1b71838792b4f67ab49f
+  metadata.gz: 6879f15e2f13a29c063274ebc59ddac2006e7343848d2e188f83821f6a796d0e61549cabbcc125c5d66790221b7fa9e618ad97064b4c61f982366f6cc6592f61
+  data.tar.gz: 88c3755e9df7000de77a7c0a5f0dc4e92c0ff4ba4257b4dba56580a7fc61b9f8067e66751c511317e94b5e386b4fcf8b1428b9988d494fd04f083a1856f14ca3

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-# Unreleased changes
+# CHANGELOG
+
+# 0.5.0 / 2017-08-07
+
+* [https://github.com/gocardless/coach/pull/24](#24) Use
+  ActiveSupport.instrument for coach.handler.finish event. Potentially breaking
+  change as the coach.handler.finish subscribers may trigger twice, depending on
+  how users have subscribed to them.
 
 # 0.4.6
 

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 GoCardless
+
+MIT License
+
+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

@@ -292,3 +292,10 @@ 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.
+
+# License & Contributing
+
+* Coach is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+* Bug reports and pull requests are welcome on GitHub at https://github.com/gocardless/coach.
+
+GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/about/jobs).

data/coach.gemspec

@@ -7,8 +7,7 @@ require 'coach/version'
 Gem::Specification.new do |spec|
   spec.name          = 'coach'
   spec.version       = Coach::VERSION
-  spec.summary       = 'coach middleware'
-  spec.description   = 'Controller framework'
+  spec.summary       = 'Alternative controllers built with middleware'
   spec.authors       = %w[GoCardless]
   spec.homepage      = "https://github.com/gocardless/coach"
   spec.email         = %w[developers@gocardless.com]

data/lib/coach/handler.rb

@@ -15,6 +15,7 @@ module Coach
 
     # Run validation on the root of the middleware chain
     delegate :validate!, to: :@root_item
+    delegate :publish, :instrument, to: ActiveSupport::Notifications
 
     # The Rack interface to handler - builds a middleware chain based on
     # the current request, and invokes it.
@@ -23,20 +24,25 @@ module Coach
       sequence = build_sequence(@root_item, context)
       chain = build_request_chain(sequence, context)
 
-      start_event = start_event(context)
-      start = Time.now
+      event = build_event(context)
 
-      publish('coach.handler.start', start_event.dup)
-
-      begin
-        response = chain.instrument.call
-      ensure
-        status = response.try(:first) || STATUS_CODE_FOR_EXCEPTIONS
-        publish('coach.handler.finish', start, Time.now, nil,
-                start_event.merge(
-                  response: { status: status },
-                  metadata: context.fetch(:_metadata, {})
-                ))
+      publish('coach.handler.start', event.dup)
+      instrument('coach.handler.finish', event) do
+        begin
+          response = chain.instrument.call
+        ensure
+          # We want to populate the response and metadata fields after the middleware
+          # chain has completed so that the end of the instrumentation can see them. The
+          # simplest way to do this is pass the event by reference to ActiveSupport, then
+          # modify the hash to contain this detail before the instrumentation completes.
+          #
+          # This way, the last coach.handler.finish event will have all the details.
+          status = response.try(:first) || STATUS_CODE_FOR_EXCEPTIONS
+          event.merge!(
+            response: { status: status },
+            metadata: context.fetch(:_metadata, {})
+          )
+        end
       end
     end
 
@@ -65,19 +71,14 @@ module Coach
 
     private
 
-    # Trigger ActiveSupport::Notification
-    def publish(name, *args)
-      ActiveSupport::Notifications.publish(name, *args)
-    end
-
     # Remove middleware that have been included multiple times with the same
     # config, leaving only the first instance
     def dedup_sequence(sequence)
       sequence.uniq { |item| [item.class, item.middleware, item.config] }
     end
 
-    # Event to send for start of handler
-    def start_event(context)
+    # Event to send with notifications
+    def build_event(context)
       {
         middleware: @root_item.middleware.name,
         request: context[:request]

data/lib/coach/version.rb

@@ -1,3 +1,3 @@
 module Coach
-  VERSION = '0.4.6'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.49.1
-description: Controller framework
+description: 
 email:
 - developers@gocardless.com
 executables: []
@@ -107,6 +107,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - coach.gemspec
 - lib/coach.rb
@@ -149,10 +150,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: coach middleware
+summary: Alternative controllers built with middleware
 test_files:
 - spec/lib/coach/handler_spec.rb
 - spec/lib/coach/middleware_spec.rb