coach 0.5.2 → 1.0.0

data/spec/lib/coach/middleware_spec.rb

@@ -1,7 +1,7 @@
 require "coach/middleware"
 
 describe Coach::Middleware do
-  let(:middleware_class) { Class.new(Coach::Middleware) }
+  let(:middleware_class) { Class.new(described_class) }
   let(:context_) { {} }
   let(:middleware_obj) { middleware_class.new(context_, nil) }
 
@@ -17,8 +17,10 @@ describe Coach::Middleware do
       before { middleware_class.provides(:foo, :bar) }
 
       it "returns true" do
+        # rubocop:disable RSpec/PredicateMatcher
         expect(middleware_class.provides?(:foo)).to be_truthy
         expect(middleware_class.provides?(:bar)).to be_truthy
+        # rubocop:enable RSpec/PredicateMatcher
       end
     end
 
@@ -26,7 +28,9 @@ describe Coach::Middleware do
       before { middleware_class.provides(:foo) }
 
       it "returns false" do
+        # rubocop:disable RSpec/PredicateMatcher
         expect(middleware_class.provides?(:baz)).to be_falsy
+        # rubocop:enable RSpec/PredicateMatcher
       end
     end
   end

data/spec/lib/coach/middleware_validator_spec.rb

@@ -4,12 +4,12 @@ require "coach/middleware_validator"
 describe Coach::MiddlewareValidator do
   subject(:validator) { described_class.new(head_middleware, already_provided) }
 
-  let(:head_middleware) { build_middleware('Head') }
+  let(:head_middleware) { build_middleware("Head") }
   let(:already_provided) { [] }
 
-  let(:middleware_a) { build_middleware('A') }
-  let(:middleware_b) { build_middleware('B') }
-  let(:middleware_c) { build_middleware('C') }
+  let(:middleware_a) { build_middleware("A") }
+  let(:middleware_b) { build_middleware("B") }
+  let(:middleware_c) { build_middleware("C") }
 
   # head <── a
   #       └─ b <- c

data/spec/lib/coach/notifications_spec.rb

@@ -1,36 +1,37 @@
-require 'spec_helper'
-require 'coach/notifications'
+require "spec_helper"
+require "coach/notifications"
 
 describe Coach::Notifications do
   subject(:notifications) { described_class.instance }
-  before { described_class.unsubscribe! }
 
-  # Remove need to fully mock a request object
   before do
+    described_class.unsubscribe!
+
+    # Remove need to fully mock a request object
     allow(Coach::RequestSerializer).
-      to receive(:new).and_return(double(serialize: {}))
+      to receive(:new).
+      and_return(instance_double("Coach::RequestSerializer", serialize: {}))
+
+    ActiveSupport::Notifications.subscribe(/\.coach$/) do |name, *_, event|
+      events << [name, event]
+    end
   end
 
   # Capture all Coach events
   let(:events) { [] }
   let(:middleware_event) do
-    event = events.find { |(name, _)| name == 'coach.request' }
+    event = events.find { |(name, _)| name == "request.coach" }
     event && event[1]
   end
-  before do
-    ActiveSupport::Notifications.subscribe(/coach/) do |name, *_, event|
-      events << [name, event]
-    end
-  end
 
   # Mock a handler to simulate an endpoint call
   let(:handler) do
-    middleware_a = build_middleware('A')
-    middleware_b = build_middleware('B')
+    middleware_a = build_middleware("A")
+    middleware_b = build_middleware("B")
 
     middleware_a.uses(middleware_b)
 
-    terminal_middleware = build_middleware('Terminal')
+    terminal_middleware = build_middleware("Terminal")
     terminal_middleware.uses(middleware_a)
 
     Coach::Handler.new(terminal_middleware)
@@ -43,17 +44,17 @@ describe Coach::Notifications do
       expect(notifications.active?).to be(true)
     end
 
-    it "will now send coach.request" do
+    it "will now send request.coach" do
       handler.call({})
-      expect(middleware_event).not_to be_nil
+      expect(middleware_event).to_not be_nil
     end
 
-    describe "coach.request event" do
+    describe "request.coach event" do
       before { handler.call({}) }
 
       it "contains all middleware that have been run" do
         middleware_names = middleware_event[:chain].map { |item| item[:name] }
-        expect(middleware_names).to include('Terminal', 'A', 'B')
+        expect(middleware_names).to include("Terminal", "A", "B")
       end
 
       it "includes all logged metadata" do
@@ -64,17 +65,17 @@ describe Coach::Notifications do
   end
 
   describe "#unsubscribe!" do
-    it "should disable any prior subscriptions" do
+    it "disables any prior subscriptions" do
       notifications.subscribe!
 
       handler.call({})
-      expect(events.count { |(name, _)| name == 'coach.request' }).
+      expect(events.count { |(name, _)| name == "request.coach" }).
         to eq(1)
 
       notifications.unsubscribe!
 
       handler.call({})
-      expect(events.count { |(name, _)| name == 'coach.request' }).
+      expect(events.count { |(name, _)| name == "request.coach" }).
         to eq(1)
     end
   end

data/spec/lib/coach/request_benchmark_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
-require 'coach/request_benchmark'
+require "spec_helper"
+require "coach/request_benchmark"
 
 describe Coach::RequestBenchmark do
-  subject(:event) { described_class.new('ENDPOINT') }
+  subject(:event) { described_class.new("ENDPOINT") }
 
   let(:base_time) { Time.now }
 
@@ -14,8 +14,8 @@ describe Coach::RequestBenchmark do
   let(:finish)    { base_time + 5 }
 
   before do
-    event.notify('B', b_start, b_finish)
-    event.notify('A', a_start, a_finish)
+    event.notify("B", b_start, b_finish)
+    event.notify("A", a_start, a_finish)
     event.complete(start, finish)
   end
 
@@ -35,11 +35,11 @@ describe Coach::RequestBenchmark do
     end
 
     it "computes duration of middleware with no children" do
-      expect(stats[:chain]).to include(name: 'B', duration: 1000)
+      expect(stats[:chain]).to include(name: "B", duration: 1000)
     end
 
     it "adjusts duration of middleware for their children" do
-      expect(stats[:chain]).to include(name: 'A', duration: 2000)
+      expect(stats[:chain]).to include(name: "A", duration: 2000)
     end
 
     it "correctly orders chain" do

data/spec/lib/coach/request_serializer_spec.rb

@@ -1,12 +1,12 @@
-require 'spec_helper'
-require 'active_support/core_ext/object/try'
-require 'coach/request_serializer'
+require "spec_helper"
+require "active_support/core_ext/object/try"
+require "coach/request_serializer"
 
 describe Coach::RequestSerializer do
   describe ".apply_header_rule" do
     before { described_class.clear_header_rules! }
 
-    let(:header) { 'http_abc' }
+    let(:header) { "http_abc" }
     let(:rule) { nil }
 
     context "with header that has a rule that" do
@@ -14,8 +14,8 @@ describe Coach::RequestSerializer do
 
       context "does not specify block" do
         it "replaces blacklisted header with default text" do
-          sanitized = Coach::RequestSerializer.apply_header_rule(header, 'value')
-          expect(sanitized).not_to eq('value')
+          sanitized = described_class.apply_header_rule(header, "value")
+          expect(sanitized).to_not eq("value")
         end
       end
 
@@ -23,20 +23,22 @@ describe Coach::RequestSerializer do
         let(:rule) { ->(value) { "#{value}#{value}" } }
 
         it "uses block to compute new filtered value" do
-          sanitized = Coach::RequestSerializer.apply_header_rule(header, 'value')
-          expect(sanitized).to eq('valuevalue')
+          sanitized = described_class.apply_header_rule(header, "value")
+          expect(sanitized).to eq("valuevalue")
         end
       end
     end
 
     context "with header that has no blacklist rule" do
       it "does not modify value" do
-        sanitized = Coach::RequestSerializer.apply_header_rule(header, 'value')
-        expect(sanitized).to eq('value')
+        sanitized = described_class.apply_header_rule(header, "value")
+        expect(sanitized).to eq("value")
       end
     end
 
     context "as an instance" do
+      subject(:request_serializer) { described_class.new(mock_request) }
+
       let(:mock_request) do
         instance_double("ActionDispatch::Request", format:              nil,
                                                    remote_ip:           nil,
@@ -45,25 +47,23 @@ describe Coach::RequestSerializer do
                                                    filtered_parameters: nil,
                                                    filtered_env:        {
                                                      "foo" => "bar",
-                                                     "HTTP_foo" => "bar"
+                                                     "HTTP_foo" => "bar",
                                                    })
       end
 
-      subject(:request_serializer) { described_class.new(mock_request) }
-
       describe "#serialize" do
         subject(:serialized) { request_serializer.serialize }
 
         it "rescues any exceptions request#fullpath may raise" do
           allow(mock_request).to receive(:fullpath).and_raise
 
-          expect(serialized[:path]).to eq('unknown')
+          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)
 
-          expect(serialized[:headers]).not_to include("foo")
+          expect(serialized[:headers]).to_not include("foo")
           expect(serialized[:headers]).to include("http_foo")
         end
       end

data/spec/lib/coach/router_spec.rb

@@ -1,15 +1,12 @@
-require 'spec_helper'
+require "spec_helper"
 
-require 'coach/router'
-require 'coach/handler'
+require "coach/router"
+require "coach/handler"
 
 describe Coach::Router do
   subject(:router) { described_class.new(mapper) }
-  let(:mapper) { double(:mapper) }
 
-  before do
-    allow(Coach::Handler).to receive(:new) { |route| route }
-  end
+  let(:mapper) { instance_double("ActionDispatch::Routing::Mapper") }
 
   let(:resource_routes) do
     routes_module = Module.new
@@ -19,6 +16,10 @@ describe Coach::Router do
     routes_module
   end
 
+  before do
+    allow(Coach::Handler).to receive(:new) { |route| route }
+  end
+
   shared_examples "mount action" do |action, params|
     let(:actions) { [action] }
 
@@ -35,31 +36,33 @@ describe Coach::Router do
   end
 
   describe "#draw" do
-    subject(:draw) { router.draw(resource_routes, base: '/resource', actions: actions) }
+    subject(:draw) { router.draw(resource_routes, base: "/resource", actions: actions) }
 
     context "with default action" do
-      it_behaves_like "mount action", :index, url: '/resource', method: :get
-      it_behaves_like "mount action", :show, url: '/resource/:id', method: :get
-      it_behaves_like "mount action", :create, url: '/resource', method: :post
-      it_behaves_like "mount action", :update, url: '/resource/:id', method: :put
-      it_behaves_like "mount action", :destroy, url: '/resource/:id', method: :delete
+      it_behaves_like "mount action", :index, url: "/resource", method: :get
+      it_behaves_like "mount action", :show, url: "/resource/:id", method: :get
+      it_behaves_like "mount action", :create, url: "/resource", method: :post
+      it_behaves_like "mount action", :update, url: "/resource/:id", method: :put
+      it_behaves_like "mount action", :destroy, url: "/resource/:id", method: :delete
     end
 
     context "with custom action" do
       let(:actions) { [refund: { method: :post, url: custom_url }] }
 
       context "with no slash" do
-        let(:custom_url) { ':id/refund' }
+        let(:custom_url) { ":id/refund" }
+
         it "mounts correct url" do
-          expect(mapper).to receive(:match).with('/resource/:id/refund', anything)
+          expect(mapper).to receive(:match).with("/resource/:id/refund", anything)
           draw
         end
       end
 
       context "with multiple /'s" do
-        let(:custom_url) { '//:id/refund' }
+        let(:custom_url) { "//:id/refund" }
+
         it "mounts correct url" do
-          expect(mapper).to receive(:match).with('/resource/:id/refund', anything)
+          expect(mapper).to receive(:match).with("/resource/:id/refund", anything)
           draw
         end
       end
@@ -67,6 +70,7 @@ describe Coach::Router do
 
     context "with unknown default action" do
       let(:actions) { [:unknown] }
+
       it "raises RouterUnknownDefaultAction" do
         expect { draw }.to raise_error(Coach::Errors::RouterUnknownDefaultAction)
       end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
-require 'rspec/its'
-require 'pry'
-require 'coach'
-require 'coach/rspec'
+require "rspec/its"
+require "pry"
+require "coach"
+require "coach/rspec"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -39,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.3.0
 description: 
 email:
 - developers@gocardless.com
@@ -101,10 +101,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -142,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Alternative controllers built with middleware