coach 0.0.0

data/spec/lib/coach/notifications_spec.rb

@@ -0,0 +1,73 @@
+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
+    allow(Coach::RequestSerializer).
+      to receive(:new).and_return(double(serialize: {}))
+  end
+
+  # Capture all Coach events
+  let(:events) { [] }
+  let(:middleware_event) do
+    event = events.find { |(name, _)| name == 'coach.request' }
+    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.uses(middleware_b)
+
+    terminal_middleware = build_middleware('Terminal')
+    terminal_middleware.uses(middleware_a)
+
+    Coach::Handler.new(terminal_middleware)
+  end
+
+  describe "#subscribe!" do
+    before { notifications.subscribe! }
+
+    it "becomes active" do
+      expect(notifications.active?).to be(true)
+    end
+
+    it "will now send coach.request" do
+      handler.call({})
+      expect(middleware_event).not_to be_nil
+    end
+
+    it "broadcasts event containing all middleware that have been run" do
+      handler.call({})
+      middleware_names = middleware_event[:chain].map { |item| item[:name] }
+      expect(middleware_names).to include(*%w(Terminal A B))
+    end
+  end
+
+  describe "#unsubscribe!" do
+    it "should disable any prior subscriptions" do
+      notifications.subscribe!
+
+      handler.call({})
+      expect(events.count { |(name, _)| name == 'coach.request' }).
+        to eq(1)
+
+      notifications.unsubscribe!
+
+      handler.call({})
+      expect(events.count { |(name, _)| name == 'coach.request' }).
+        to eq(1)
+    end
+  end
+end

data/spec/lib/coach/request_benchmark_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'coach/request_benchmark'
+
+describe Coach::RequestBenchmark do
+  subject(:event) { described_class.new('ENDPOINT') }
+
+  let(:base_time) { Time.now }
+
+  let(:start)     { base_time + 0 }
+  let(:a_start)   { base_time + 1 }
+  let(:b_start)   { base_time + 2 }
+  let(:b_finish)  { base_time + 3 }
+  let(:a_finish)  { base_time + 4 }
+  let(:finish)    { base_time + 5 }
+
+  before do
+    event.notify('B', b_start, b_finish)
+    event.notify('A', a_start, a_finish)
+    event.complete(start, finish)
+  end
+
+  describe "#stats" do
+    subject(:stats) { event.stats }
+
+    it "computes overall duration" do
+      expect(stats[:duration]).to eq(5000)
+    end
+
+    it "computes duration of middleware with no children" do
+      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)
+    end
+
+    it "correctly orders chain" do
+      chain_names = stats[:chain].map { |item| item[:name] }
+      expect(chain_names).to eq %w(A B)
+    end
+  end
+end

data/spec/lib/coach/request_serializer_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'coach/request_serializer'
+
+describe Coach::RequestSerializer do
+  describe '.apply_header_rule' do
+    before { described_class.clear_header_rules! }
+
+    let(:header) { 'http_abc' }
+    let(:rule) { nil }
+
+    context "with header that has a rule that" do
+      before { described_class.sanitize_header(header, &rule) }
+
+      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')
+        end
+      end
+
+      context "specifies custom block" 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')
+        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')
+      end
+    end
+  end
+end

data/spec/lib/coach/router_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+require 'coach/router'
+require 'coach/handler'
+
+describe Coach::Router do
+  subject(:router) { described_class.new(app) }
+  let(:app) { double(:rails_app, routes: double(draw: nil)) }
+
+  before do
+    allow(Coach::Handler).to receive(:new) { |route| route }
+  end
+
+  let(:resource_routes) do
+    Module.new do
+      class Index; end
+      class Show; end
+      class Create; end
+      class Update; end
+      class Destroy; end
+      class Refund; end  # custom
+    end
+  end
+
+  shared_examples "mount action" do |action, params|
+    let(:actions) { [action] }
+
+    it "correctly mounts url for :#{action}" do
+      expect(router).to receive(:match).with(params[:url], anything)
+      draw
+    end
+
+    it "correctly mounts on method for :#{action}" do
+      expect(router).to receive(:match).
+        with(anything, hash_including(via: params[:method]))
+      draw
+    end
+  end
+
+  describe "#draw" do
+    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
+    end
+
+    context "with custom action" do
+      let(:actions) { [refund: { method: :post, url: custom_url }] }
+
+      context "with no slash" do
+        let(:custom_url) { ':id/refund' }
+        it "mounts correct url" do
+          expect(router).to receive(:match).with('/resource/:id/refund', anything)
+          draw
+        end
+      end
+
+      context "with multiple /'s" do
+        let(:custom_url) { '//:id/refund' }
+        it "mounts correct url" do
+          expect(router).to receive(:match).with('/resource/:id/refund', anything)
+          draw
+        end
+      end
+    end
+
+    context "with unknown default action" do
+      let(:actions) { [:unknown] }
+      it "raises RouterUnknownDefaultAction" do
+        expect { draw }.to raise_error(Coach::Errors::RouterUnknownDefaultAction)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec/its'
+require 'pry'
+require_relative '../lib/coach'
+require_relative '../lib/spec/coach_helper'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: coach
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- GoCardless
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Controller framework
+email:
+- developers@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- coach.gemspec
+- lib/coach.rb
+- lib/coach/errors.rb
+- lib/coach/handler.rb
+- lib/coach/middleware.rb
+- lib/coach/middleware_item.rb
+- lib/coach/middleware_validator.rb
+- lib/coach/notifications.rb
+- lib/coach/request_benchmark.rb
+- lib/coach/request_serializer.rb
+- lib/coach/router.rb
+- lib/coach/version.rb
+- lib/spec/coach_helper.rb
+- spec/lib/coach/handler_spec.rb
+- spec/lib/coach/middleware_spec.rb
+- spec/lib/coach/middleware_validator_spec.rb
+- spec/lib/coach/notifications_spec.rb
+- spec/lib/coach/request_benchmark_spec.rb
+- spec/lib/coach/request_serializer_spec.rb
+- spec/lib/coach/router_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/coach
+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.0.14
+signing_key: 
+specification_version: 4
+summary: coach middleware
+test_files:
+- spec/lib/coach/handler_spec.rb
+- spec/lib/coach/middleware_spec.rb
+- spec/lib/coach/middleware_validator_spec.rb
+- spec/lib/coach/notifications_spec.rb
+- spec/lib/coach/request_benchmark_spec.rb
+- spec/lib/coach/request_serializer_spec.rb
+- spec/lib/coach/router_spec.rb
+- spec/spec_helper.rb