endpoint-flux 1.1.1

data/spec/lib/endpoint/middlewares_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Endpoint do
+  let(:klass) { class_double('Sample') }
+
+  before do
+    EndpointFlux.config EndpointFlux::Config.new
+
+    klass.include EndpointFlux::Endpoint
+  end
+
+  context 'with exceptions' do
+    it 'fails with wrong string' do
+      klass.flow [:validator]
+
+      expect do
+        klass.validator 'some_not_existing_class'
+      end.to raise_error('You must provide block or existing klass')
+    end
+
+    it 'fails whit wrong class passed' do
+      stub_const 'EndpointFlux::Middlewares::Validator::SampleMiddleware', Class.new
+
+      klass.flow [:validator]
+
+      expect { klass.validator 'sample_middleware' }.to raise_error(
+        'The [EndpointFlux::Middlewares::Validator::SampleMiddleware] '\
+        'class should define perform class method'
+      )
+    end
+
+    context 'when wrong param passed' do
+      it do
+        klass.flow [:validator]
+
+        expect { klass.validator 1334 }.to raise_error(
+          'You must provide block or existing klass'
+        )
+      end
+
+      it do
+        stub_const 'SampleMiddleware', Class.new
+
+        klass.flow [:validator]
+
+        expect { klass.validator SampleMiddleware }.to raise_error(
+          'You must provide block or existing klass'
+        )
+      end
+    end
+  end
+
+  describe 'middlewares' do
+    before do
+      stub_const 'SomeNamespace::MiddlewareName::SampleMiddleware', Class.new
+      SomeNamespace::MiddlewareName::SampleMiddleware.class_eval do
+        def self.perform(*args)
+          args
+        end
+      end
+
+      EndpointFlux.config.middlewares_namespaces << 'some_namespace'
+    end
+
+    before do
+      klass.flow [:middleware_name]
+    end
+
+    let(:middleware) { klass.middleware_name.first }
+
+    it 'sets middleware with options' do
+      klass.middleware_name 'sample_middleware', some: :option
+
+      expect(middleware.klass).to be(SomeNamespace::MiddlewareName::SampleMiddleware)
+      expect(middleware.options).to eq(some: :option)
+    end
+
+    it 'sets middleware' do
+      klass.middleware_name 'sample_middleware'
+
+      expect(middleware.klass).to be(SomeNamespace::MiddlewareName::SampleMiddleware)
+    end
+
+    it 'does not add twice' do
+      klass.middleware_name 'sample_middleware'
+      klass.middleware_name 'sample_middleware'
+
+      middleware = klass.middleware_name.first
+
+      expect(middleware.klass).to be(SomeNamespace::MiddlewareName::SampleMiddleware)
+    end
+
+    context 'block' do
+      let(:block) { proc {} }
+
+      it 'sets middleware' do
+        klass.middleware_name(&block)
+
+        expect(middleware.handler).to be == block
+      end
+
+      it 'does not adds twice' do
+        klass.middleware_name(&block)
+        klass.middleware_name(&block)
+
+        expect(middleware.handler).to be == block
+      end
+    end
+  end
+end

data/spec/lib/endpoint/perform_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Endpoint do
+  let(:klass) { stub_const 'Sample', Class.new }
+  let(:middleware_request) { EndpointFlux::Request.new(headers: {}, params: params) }
+  let(:middleware_response) { EndpointFlux::Response.new }
+
+  before do
+    EndpointFlux.config EndpointFlux::Config.new
+
+    klass.include EndpointFlux::Endpoint
+  end
+
+  describe '#perform' do
+    before do
+      stub_const 'EndpointFlux::Middlewares::Validator::SampleValidator', Class.new
+      EndpointFlux::Middlewares::Validator::SampleValidator.class_eval do
+        def self.perform(request, response, _)
+          request.params = {}
+          [request, response, {}]
+        end
+      end
+    end
+
+    let(:params) { { some: :val } }
+
+    it 'checks if middleware exists' do
+      klass.flow [:validator]
+
+      expect { klass.perform(middleware_request) }
+        .to raise_error('No middleware registred for [:validator]')
+    end
+
+    context 'middleware passed as string' do
+      it 'runs middleware passed as string' do
+        klass.flow [:validator]
+        klass.validator 'sample_validator'
+
+        request, response = klass.perform(middleware_request)
+
+        expect(request.params).to eq({})
+        expect(response.body).to eq({})
+      end
+    end
+
+    context 'default middleware' do
+      before do
+        klass.flow [:validator]
+
+        EndpointFlux.config.default_middlewares :validator, 'sample_validator'
+      end
+
+      it 'uses default if not defined' do
+        request, response = klass.perform(middleware_request)
+
+        expect(request.params).to eq({})
+        expect(response.body).to eq({})
+      end
+    end
+  end
+end

data/spec/lib/endpoint/rescue_from_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Endpoint do
+  let(:klass) { stub_const 'Sample', Class.new }
+  let(:middleware_request) { EndpointFlux::Request.new(headers: {}, params: {}) }
+  let(:middleware_response) { EndpointFlux::Response.new }
+
+  before do
+    EndpointFlux.config EndpointFlux::Config.new
+
+    klass.include EndpointFlux::Endpoint
+  end
+
+  describe '#rescue_from' do
+    let(:sample_exception) { stub_const 'SampleException', Class.new(Exception) }
+    let!(:sample_validator) do
+      stub_const 'EndpointFlux::Middlewares::Validator::Sample', Class.new
+      EndpointFlux::Middlewares::Validator::Sample.class_eval do
+        def self.perform(*)
+          raise SampleException, 'bla bla'
+        end
+      end
+      EndpointFlux::Middlewares::Validator::Sample
+    end
+    let!(:sample_decorator) do
+      stub_const 'EndpointFlux::Middlewares::Decorator::Sample', Class.new
+      EndpointFlux::Middlewares::Decorator::Sample.class_eval do
+        def self.perform(request, response, options)
+          response.body[:decorator] = true
+          [request, response, options]
+        end
+      end
+      EndpointFlux::Middlewares::Decorator::Sample
+    end
+
+    it 'fails if exception not found' do
+      expect do
+        EndpointFlux.config.rescue_from 'NonExsistingClasss' do |_, attrs|
+          # code
+        end
+      end.to raise_error('The [NonExsistingClasss] should be a string representing a class')
+    end
+
+    context 'default middleware' do
+      before do
+        klass.flow %i[validator decorator]
+        klass.validator 'sample'
+        klass.decorator 'sample'
+
+        EndpointFlux.config.rescue_from sample_exception do |_, attrs|
+          [attrs[0], attrs[1], { status: false }]
+        end
+      end
+
+      it 'uses default if not defined' do
+        _, response = klass.perform(middleware_request)
+        expect(response.body[:status]).to be_falsey
+      end
+    end
+  end
+end

data/spec/lib/exceptions/forbidden_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Exceptions::Forbidden do
+  describe '#to_hash' do
+    it 'returns correct hash' do
+      expect(subject.to_hash).to eq(
+        status: 403,
+        message: 'Forbidden'
+      )
+    end
+  end
+end

data/spec/lib/exceptions/not_found_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Exceptions::NotFound do
+  describe '#to_hash' do
+    it 'returns correct hash' do
+      expect(subject.to_hash).to eq(
+        status: 404,
+        message: 'not found'
+      )
+    end
+  end
+end

data/spec/lib/exceptions/service_unavailable_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Exceptions::ServiceUnavailable do
+  describe '#to_hash' do
+    it 'returns correct hash' do
+      expect(subject.to_hash).to eq(
+        status: 503,
+        message: 'service unavailable'
+      )
+    end
+  end
+end

data/spec/lib/exceptions/unauthorized_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Exceptions::Unauthorized do
+  describe '#to_hash' do
+    it 'returns correct hash' do
+      expect(subject.to_hash).to eq(
+        status: 401,
+        message: 'Unauthorized'
+      )
+    end
+  end
+end

data/spec/lib/exceptions/validation_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Exceptions::Validation do
+  describe '#to_hash' do
+    let(:messages) { {name: 'not valid'} }
+    it 'returns correct hash' do
+      expect(EndpointFlux::Exceptions::Validation.new(messages).to_hash).to eq(
+        status: 422,
+        message: 'validation errors',
+        errors: messages
+      )
+    end
+  end
+end

data/spec/lib/middlewares/authenticator/skip_spec.rb

@@ -0,0 +1,5 @@
+require_relative '../../middlewares/shared_examples'
+
+RSpec.describe EndpointFlux::Middlewares::Authenticator::Skip do
+  include_examples 'perform does not change the params'
+end

data/spec/lib/middlewares/authorizator/skip_spec.rb

@@ -0,0 +1,5 @@
+require_relative '../../middlewares/shared_examples'
+
+RSpec.describe EndpointFlux::Middlewares::Authorizator::Skip do
+  include_examples 'perform does not change the params'
+end

data/spec/lib/middlewares/decorator/add_status_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe EndpointFlux::Middlewares::Decorator::AddStatus do
+  describe '#perform' do
+    let(:params) { { some: 'value' } }
+    let(:body) { { status: 200 } }
+    let(:request) { EndpointFlux::Request.new(headers: {}, params: params) }
+    let(:response) { EndpointFlux::Response.new(headers: {}, body: body) }
+
+    it 'returns response with status in body' do
+      middleware_request, middleware_response = subject.perform(request, response, {})
+
+      expect(middleware_request.headers).to eq({})
+      expect(middleware_request.params).to eq(params)
+      expect(middleware_response.headers).to eq({})
+      expect(middleware_response.body).to eq(body)
+    end
+  end
+end

data/spec/lib/middlewares/decorator/skip_spec.rb

@@ -0,0 +1,5 @@
+require_relative '../../middlewares/shared_examples'
+
+RSpec.describe EndpointFlux::Middlewares::Decorator::Skip do
+  include_examples 'perform does not change the params'
+end

data/spec/lib/middlewares/policy/skip_spec.rb

@@ -0,0 +1,5 @@
+require_relative '../../middlewares/shared_examples'
+
+RSpec.describe EndpointFlux::Middlewares::Policy::Skip do
+  include_examples 'perform does not change the params'
+end

data/spec/lib/middlewares/shared_examples.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.shared_context 'perform does not change the params', shared_context: :metadata do
+  describe '#perform' do
+    let(:params) { { some: 'value' } }
+    let(:headers) { { 'Authorization' => 'valid' } }
+    let(:request) { EndpointFlux::Request.new(headers: headers, params: params) }
+    let(:response) { EndpointFlux::Response.new(headers: {}, body: {}) }
+    
+    it 'returns not changed params' do
+      middleware_request, middleware_response = subject.perform(request, response, {})
+      
+      expect(middleware_request.params).to eq(params)
+      expect(middleware_request.headers).to eq(headers)
+      expect(middleware_response.headers).to eq({})
+      expect(middleware_response.body).to eq({})
+    end
+  end
+end

data/spec/lib/middlewares/validator/empty_spec.rb

@@ -0,0 +1,15 @@
+RSpec.describe EndpointFlux::Middlewares::Validator::Empty do
+  describe '#perform' do
+    let(:params) { { some: 'value' } }
+    let(:request) { EndpointFlux::Request.new(headers: {}, params: params) }
+    let(:response) { EndpointFlux::Response.new }
+
+    it 'returns empty params' do
+      middleware_request, middleware_response = subject.perform(request, response, {})
+
+      expect(middleware_request.params).to eq({})
+      expect(middleware_response.headers).to eq({})
+      expect(middleware_response.body).to eq({})
+    end
+  end
+end

data/spec/lib/response_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Response do
+  subject { EndpointFlux::Response.new(params) }
+  let(:empty_subject) { EndpointFlux::Response.new() }
+  
+  describe '#success?' do
+    context 'when valid params given' do
+      Array(200..209).each do |status|
+        let(:params) { { headers: {}, body: {status: status}  } }
+        it "returns true for status #{status}" do
+          expect(subject.success?).to be_truthy
+        end
+      end
+    end
+
+    context 'when wrong params given' do
+      let(:status) { 400 }
+      let(:params) { { headers: {}, body: {status: status}  } }
+      it 'returns false for not a success status' do
+        expect(subject.success?).to be_falsey
+      end
+      
+      describe 'when Response initialized without params' do
+        it 'returns false for not a success status' do
+          expect(empty_subject.success?).to be_falsey
+        end
+      end
+    end
+  end
+
+  describe '#invalid?' do
+    let(:params) { { headers: {}, body: {status: status}  } }
+    context 'when valid params given' do
+      let(:status) { 422 }
+      
+      it 'returns true for status 422' do
+        expect(subject.invalid?).to be_truthy
+      end
+    end
+  
+    context 'when wrong params given' do
+      let(:status) { 400 }
+      
+      it 'returns false for not an invalid status' do
+        expect(subject.invalid?).to be_falsey
+      end
+    
+      describe 'when Response initialized without params' do
+        it 'returns false for not an invalid status' do
+          expect(empty_subject.invalid?).to be_falsey
+        end
+      end
+    end
+  end
+
+  describe '#forbidden?' do
+    let(:params) { { headers: {}, body: {status: status}  } }
+    context 'when valid params given' do
+      let(:status) { 403 }
+    
+      it 'returns true for status 403' do
+        expect(subject.forbidden?).to be_truthy
+      end
+    end
+  
+    context 'when wrong params given' do
+      let(:status) { 400 }
+    
+      it 'returns false for not a forbidden status' do
+        expect(subject.forbidden?).to be_falsey
+      end
+    
+      describe 'when Response initialized without params' do
+        it 'returns false for not a forbidden status' do
+          expect(empty_subject.forbidden?).to be_falsey
+        end
+      end
+    end
+  end
+
+  describe '#unauthorized?' do
+    let(:params) { { headers: {}, body: {status: status}  } }
+    context 'when valid params given' do
+      let(:status) { 401 }
+    
+      it 'returns true for status 401' do
+        expect(subject.unauthorized?).to be_truthy
+      end
+    end
+  
+    context 'when wrong params given' do
+      let(:status) { 400 }
+    
+      it 'returns false for not a unauthorized status' do
+        expect(subject.unauthorized?).to be_falsey
+      end
+    
+      describe 'when Response initialized without params' do
+        it 'returns false for not a unauthorized status' do
+          expect(empty_subject.unauthorized?).to be_falsey
+        end
+      end
+    end
+  end
+
+  describe '#unauthorized?' do
+    let(:params) { { headers: {}, body: {status: status}  } }
+    context 'when valid params given' do
+      let(:status) { 404 }
+    
+      it 'returns true for status 404' do
+        expect(subject.not_found?).to be_truthy
+      end
+    end
+  
+    context 'when wrong params given' do
+      let(:status) { 400 }
+    
+      it 'returns false for not a not_found status' do
+        expect(subject.not_found?).to be_falsey
+      end
+    
+      describe 'when Response initialized without params' do
+        it 'returns false for not a not_found status' do
+          expect(empty_subject.not_found?).to be_falsey
+        end
+      end
+    end
+  end
+end