drillbit 1.1.0 → 2.0.0

data/spec/drillbit/errors/invalid_request_body_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'drillbit/errors/invalid_request_body'
+
+module    Drillbit
+module    Errors
+describe  InvalidRequestBody do
+  let(:error) { InvalidRequestBody.new }
+
+  it 'has a status of 400' do
+    expect(error.http_status).to eql 400
+  end
+
+  it 'has a code' do
+    expect(error.code).to eql 'errors.invalid_request_body'
+  end
+
+  it 'can output the detail' do
+    expect(error.detail).to eql \
+      'The information you attempted to send in the request cannot be parsed as ' \
+      'a valid JSON document.'
+  end
+end
+end
+end

data/spec/drillbit/errors/invalid_subdomain_spec.rb

@@ -2,9 +2,9 @@
 require 'spec_helper'
 require 'drillbit/errors/invalid_subdomain'
 
-module          Drillbit
-module          Errors
-RSpec.describe  InvalidSubdomain do
+module    Drillbit
+module    Errors
+describe  InvalidSubdomain do
   let(:error) { InvalidSubdomain.new }
 
   it 'has a status of 404' do

data/spec/drillbit/errors/invalid_token_spec.rb

@@ -2,9 +2,9 @@
 require 'spec_helper'
 require 'drillbit/errors/invalid_token'
 
-module          Drillbit
-module          Errors
-RSpec.describe  InvalidToken do
+module    Drillbit
+module    Errors
+describe  InvalidToken do
   let(:error) { InvalidToken.new }
 
   it 'has a status of 401' do

data/spec/drillbit/invalid_subdomain_spec.rb

@@ -2,9 +2,9 @@
 require 'spec_helper'
 require 'drillbit/responses/invalid_subdomain'
 
-module          Drillbit
-module          Responses
-RSpec.describe  InvalidSubdomain, singletons: Erratum::Configuration do
+module    Drillbit
+module    Responses
+describe  InvalidSubdomain, singletons: Erratum::Configuration do
   it 'returns the proper response' do
     Erratum.configuration.url_mappings = {
       'external_documentation_urls'  => {

data/spec/drillbit/invalid_token_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 require 'drillbit/responses/invalid_token'
 
 # rubocop:disable Metrics/LineLength
-module          Drillbit
-module          Responses
-RSpec.describe  InvalidToken, singletons: Erratum::Configuration do
+module    Drillbit
+module    Responses
+describe  InvalidToken, singletons: Erratum::Configuration do
   it 'returns the proper response' do
     Erratum.configuration.url_mappings = {
       'external_documentation_urls'  => {

data/spec/drillbit/matchers/accept_header_spec.rb

@@ -4,9 +4,9 @@ require 'drillbit/requests/base'
 require 'drillbit/matchers/accept_header'
 
 # rubocop:disable Metrics/LineLength
-module          Drillbit
-module          Matchers
-RSpec.describe  AcceptHeader do
+module    Drillbit
+module    Matchers
+describe  AcceptHeader do
   it 'matches if the subdomain is API and the accept header is valid' do
     env = {
       'HTTP_ACCEPT'             => 'application/vnd.westeros+redkeep;version=1.0.0',

data/spec/drillbit/matchers/subdomain_spec.rb

@@ -4,9 +4,9 @@ require 'drillbit/requests/base'
 require 'drillbit/matchers/subdomain'
 require 'drillbit/configuration'
 
-module          Drillbit
-module          Matchers
-RSpec.describe  Subdomain do
+module    Drillbit
+module    Matchers
+describe  Subdomain do
   before(:each) do
     Drillbit.configuration.allowed_subdomains     = %w{api}
     Drillbit.configuration.allowed_api_subdomains = %w{api}

data/spec/drillbit/matchers/version_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 require 'drillbit/requests/base'
 require 'drillbit/matchers/version'
 
-module          Drillbit
-module          Matchers
-RSpec.describe  Version do
+module    Drillbit
+module    Matchers
+describe  Version do
   context 'when the version is passed in the accept header' do
     it 'does not match if the subdomain is API but the requested version does not ' \
        'equal the version constraint' do

data/spec/drillbit/middleware/{api_request_spec.rb → api_request_validator_spec.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 require 'spec_helper'
-require 'drillbit/middleware/api_request'
+require 'drillbit/middleware/api_request_validator'
 
 # rubocop:disable Metrics/LineLength
-module          Drillbit
-module          Middleware
-RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
+module    Drillbit
+module    Middleware
+describe  ApiRequestValidator, singletons: Erratum::Configuration do
   let(:app) { ->(_env) { [200, {}, 'response'] } }
 
   before(:each) do
@@ -26,7 +26,7 @@ RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
   end
 
   it 'allows requests for allowed subdomains without accept headers' do
-    api_request_middleware = ApiRequest.new(app)
+    api_request_middleware = ApiRequestValidator.new(app)
 
     request = {
       'HTTP_HOST'    => 'westeros.example.com',
@@ -42,7 +42,7 @@ RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
   end
 
   it 'does not allow requests if they are not for an allowed subdomain' do
-    api_request_middleware = ApiRequest.new(app)
+    api_request_middleware = ApiRequestValidator.new(app)
 
     request = {
       'HTTP_HOST'    => 'notvalid.example.com',
@@ -78,7 +78,7 @@ RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
   it 'does not allow requests if they are for an allowed subdomain but does ' \
      'not have a valid accept header' do
 
-    api_request_middleware = ApiRequest.new(app)
+    api_request_middleware = ApiRequestValidator.new(app)
 
     request = {
       'HTTP_HOST'    => 'api.example.com',
@@ -112,7 +112,7 @@ RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
   end
 
   it 'does allow requests if both the subdomain and the accept header are valid' do
-    api_request_middleware = ApiRequest.new(app)
+    api_request_middleware = ApiRequestValidator.new(app)
 
     request = {
       'HTTP_HOST'    => 'api.example.com',
@@ -129,7 +129,7 @@ RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
 
   it 'does allow requests if the subdomain, the accept header and the token are valid' do
     Drillbit.configuration.token_private_key = test_private_key
-    api_request_middleware = ApiRequest.new(app)
+    api_request_middleware = ApiRequestValidator.new(app)
 
     request = {
       'HTTP_HOST'          => 'api.example.com',
@@ -145,43 +145,8 @@ RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
     expect(response).to eql 'response'
   end
 
-  it 'returns the proper response if the token is invalid' do
-    Drillbit.configuration.token_private_key = test_private_key
-    api_request_middleware = ApiRequest.new(app)
-
-    request = {
-      'HTTP_HOST'          => 'api.example.com',
-      'HTTP_ACCEPT'        => 'application/vnd.westeros+redkeep;version=1.0.0',
-      'HTTP_AUTHORIZATION' => "Token #{invalid_jwe_token}",
-      'QUERY_STRING'       => 'accept=application/vnd.westeros+redkeep;version=1.0.0',
-    }
-
-    _status, _headers, response = api_request_middleware.call(request)
-
-    expect(response.first).to include 'errors.invalid_token'
-  end
-
-  it 'converts JSON API compliant dasherized query params to underscored' do
-    app                    = ->(env) { [200, env, 'response'] }
-    api_request_middleware = ApiRequest.new(app)
-
-    request = {
-      'HTTP_HOST'    => 'api.example.com',
-      'HTTP_ACCEPT'  => 'application/vnd.westeros+redkeep;version=1.0.0',
-      'QUERY_STRING' => 'hello-there=bob-jones&'     \
-                        'nice-to-meet=you-bob&'      \
-                        'hows-the-weather=today-bob',
-    }
-
-    _status, headers, _response = api_request_middleware.call(request)
-
-    expect(headers['QUERY_STRING']).to eql 'hello_there=bob-jones&' \
-                                           'nice_to_meet=you-bob&'  \
-                                           'hows_the_weather=today-bob'
-  end
-
   it 'properly converts the content type for Rails when it is the only one' do
-    api_request_middleware = ApiRequest.new(app)
+    api_request_middleware = ApiRequestValidator.new(app)
 
     request = {
       'CONTENT_TYPE' => 'application/vnd.api+json',
@@ -199,7 +164,7 @@ RSpec.describe  ApiRequest, singletons: Erratum::Configuration do
   end
 
   it 'properly converts the content type for Rails when it is not the only one' do
-    api_request_middleware = ApiRequest.new(app)
+    api_request_middleware = ApiRequestValidator.new(app)
 
     request = {
       'CONTENT_TYPE' => 'application/vnd.api+json;other',

data/spec/drillbit/middleware/parameter_parser_spec.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'drillbit/middleware/parameter_parser'
+
+module    Drillbit
+module    Middleware
+describe  ParameterParser do
+  let(:app) { ->(_env) { [200, {}, 'response'] } }
+
+  it 'converts JSON API compliant dasherized query params to underscored' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'QUERY_STRING' => 'hello-there=bob-jones&'     \
+                        'nice-to-meet=you-bob&'      \
+                        'hows-the-weather=today-bob',
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(headers['QUERY_STRING']).to eql 'hello_there=bob-jones&' \
+                                           'nice_to_meet=you-bob&'  \
+                                           'hows_the_weather=today-bob'
+  end
+
+  it 'does not touch query params with no dashes' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'QUERY_STRING' => 'hello_there=bob-jones',
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(headers['QUERY_STRING']).to eql 'hello_there=bob-jones'
+  end
+
+  it 'can handle weirdly formatted query string parameters' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'QUERY_STRING' => 'hello-there=bob-jones&' \
+                        'nice-to-meet=you-bob&=',
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(headers['QUERY_STRING']).to eql 'hello_there=bob-jones&' \
+                                           'nice_to_meet=you-bob&='
+  end
+
+  it 'can handle query string parameters with no values' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'QUERY_STRING' => 'hello-there&nice-to-meet=you-bob&=',
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(headers['QUERY_STRING']).to eql 'hello_there&nice_to_meet=you-bob&='
+  end
+
+  it 'can handle query string parameters with parameter name' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'QUERY_STRING' => 'hello-there=bob-jones&=you-bob&nice-to-meet=you-bob&=',
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(headers['QUERY_STRING']).to eql 'hello_there=bob-jones&' \
+                                           '=you-bob&' \
+                                           'nice_to_meet=you-bob&='
+  end
+
+  it 'converts JSON API compliant dasherized request params to underscored' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'CONTENT_LENGTH' => '1',
+      'CONTENT_TYPE'   => 'application/json',
+      'RACK_INPUT'     => <<-HEREDOC
+        {
+          "single":      "word",
+          "double-word": "double double",
+          "triple":      {
+                           "trippple-tripple": "mcdipple",
+                           "quad":             {
+                             "another-level":    "whoa inception"
+                           }
+                         }
+        }
+      HEREDOC
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(JSON.load(headers['RACK_INPUT'])).to eql(
+      'single'      => 'word',
+      'double_word' => 'double double',
+      'triple'      => {
+        'trippple_tripple' => 'mcdipple',
+        'quad'             => {
+          'another_level' => 'whoa inception',
+        },
+      },
+    )
+  end
+
+  it 'does not convert to JSON if the content type is not JSON' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'CONTENT_LENGTH' => '1',
+      'CONTENT_TYPE'   => 'not_j_s_o_n',
+      'RACK_INPUT'     => 'This is not JSON',
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(headers['RACK_INPUT']).to eql 'This is not JSON'
+  end
+
+  it 'does not convert to JSON if there is no content' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'CONTENT_LENGTH' => '0',
+      'CONTENT_TYPE'   => 'application/json',
+      'RACK_INPUT'     => 'empty',
+    }
+
+    _status, headers, _response = middleware.call(request)
+
+    expect(headers['RACK_INPUT']).to eql 'empty'
+  end
+
+  it 'can handle incorrectly formatted JSON' do
+    app        = ->(env) { [200, env, 'response'] }
+    middleware = ParameterParser.new(app)
+
+    request = {
+      'CONTENT_LENGTH' => '1',
+      'CONTENT_TYPE'   => 'application/json',
+      'RACK_INPUT'     => 'something blah',
+    }
+
+    status, headers, response = middleware.call(request)
+
+    expect(status).to                 eql 400
+    expect(headers).to                eql({})
+    expect(JSON.load(response[0])).to include(
+      'errors' => [
+                    {
+                      'id'     => match(/[a-z0-9\-]+/),
+                      'links'  => {
+                        'about'         => nil,
+                        'documentation' => nil,
+                      },
+                      'status' => 400,
+                      'code'   => 'errors.invalid_request_body',
+                      'title'  => 'Invalid Request Body',
+                      'detail' => 'The information you attempted to send in the ' \
+                                  'request cannot be parsed as a valid JSON document.',
+                      'source' => {
+                        'request_body' => 'something blah',
+                      },
+                    },
+                  ],
+    )
+  end
+end
+end
+end

data/spec/drillbit/middleware/token_processor_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'drillbit/middleware/token_processor'
+
+module    Drillbit
+module    Middleware
+describe  TokenProcessor do
+  let(:app) { ->(_env) { [200, {}, 'response'] } }
+
+  it 'returns the proper response if the token is invalid' do
+    Drillbit.configuration.token_private_key = test_private_key
+    middleware = TokenProcessor.new(app)
+
+    request = {
+      'HTTP_HOST'          => 'api.example.com',
+      'HTTP_ACCEPT'        => 'application/vnd.westeros+redkeep;version=1.0.0',
+      'HTTP_AUTHORIZATION' => "Token #{invalid_jwe_token}",
+      'QUERY_STRING'       => 'accept=application/vnd.westeros+redkeep;version=1.0.0',
+    }
+
+    _status, _headers, response = middleware.call(request)
+
+    expect(response.first).to include 'errors.invalid_token'
+  end
+end
+end
+end

data/spec/drillbit/requests/base_spec.rb

@@ -3,9 +3,9 @@ require 'ostruct'
 require 'spec_helper'
 require 'drillbit/requests/base'
 
-module          Drillbit
-module          Requests
-RSpec.describe  Base do
+module    Drillbit
+module    Requests
+describe  Base do
   it 'can resolve itself by returning itself' do
     raw_request      = Base.new(token_private_key: '', request: {})
     resolved_request = Base.resolve(raw_request)