drillbit 2.11.0 → 3.0.0

data/spec/drillbit/authorizers/parameters/filtering_spec.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled'
-require 'drillbit/authorizers/parameters/filtering'
-
-module    Drillbit
-module    Authorizers
-class     Parameters
-describe  Filtering do
-  let(:params) { { filter: { name: 'Bill', age: 26 } } }
-
-  it 'can authorize new filter parameters', verify: false do
-    filter_params = Filtering.new(action: 'index',
-                                  token:  '1234',
-                                  user:   '1234',
-                                  issuer: 'my_issuer',
-                                  params: params)
-
-    allow(params).to receive(:permit)
-
-    filter_params.send(:add_filterable_parameters, :name, :age)
-    filter_params.call
-
-    expect(params).to have_received(:permit).
-    with(:sort,
-         :token,
-         :token_b64,
-         :token_jwt,
-         :format,
-         :accept,
-         :include,
-         include(
-           filter: include(:name, :age),
-         ))
-  end
-
-  it 'can authorize parameters if they come in as arrays', verify: false do
-    params = {
-      filter: {
-        name: 'Bill',
-        ary:  %w{hello},
-      },
-    }
-    filter_params = Filtering.new(action: 'index',
-                                  token:  '1234',
-                                  user:   '1234',
-                                  issuer: 'my_issuer',
-                                  params: params)
-
-    allow(params).to receive(:permit)
-
-    filter_params.send(:add_filterable_parameters, :name, :ary)
-    filter_params.call
-
-    expect(params).to have_received(:permit).
-    with(:sort,
-         :token,
-         :token_b64,
-         :token_jwt,
-         :format,
-         :accept,
-         :include,
-         include(
-           filter: include(:name, ary: []),
-         ))
-  end
-
-  it 'has default authorized parameters', verify: false do
-    filter_params = Filtering.new(action: 'index',
-                                  token:  '1234',
-                                  user:   '1234',
-                                  issuer: 'my_issuer',
-                                  params: params)
-
-    allow(params).to receive(:permit)
-
-    filter_params.call
-
-    expect(params).to have_received(:permit).
-    with(:sort,
-         :token,
-         :token_b64,
-         :token_jwt,
-         :format,
-         :accept,
-         :include,
-         page:   %i{
-                   number
-                   size
-                   offset
-                   limit
-                   cursor
-                 },
-         filter: [
-                   :query,
-                   {},
-                 ])
-  end
-end
-end
-end
-end

data/spec/drillbit/authorizers/parameters/resource_spec.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled'
-require 'drillbit/authorizers/parameters/resource'
-
-module    Drillbit
-module    Authorizers
-class     Parameters
-describe  Resource do
-end
-end
-end
-end

data/spec/drillbit/authorizers/parameters_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled'
-require 'drillbit/authorizers/parameters'
-
-module    Drillbit
-module    Authorizers
-describe  Parameters do
-  it 'defaults to nothing' do
-    parameters = Parameters.new(action: 'index',
-                                token:  '123',
-                                user:   'my_user',
-                                issuer: 'my_issuer',
-                                params: { foo: 'bar' })
-
-    expect(parameters.call).to eql(foo: 'bar')
-  end
-end
-end
-end

data/spec/drillbit/authorizers/query_spec.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled'
-require 'drillbit/authorizers/query'
-
-module    Drillbit
-module    Authorizers
-describe  Query do
-  it 'does not authorize the resource by default' do
-    authorizer = Query.new(action:   'index',
-                           token:    '123',
-                           user:     'my_user',
-                           issuer:   'my_issuer',
-                           resource: 'my_resource',
-                           params:   'my_params')
-
-    expect(authorizer).not_to be_able_to_index
-    expect(authorizer).not_to be_able_to_show
-    expect(authorizer).not_to be_able_to_create
-    expect(authorizer).not_to be_able_to_update
-    expect(authorizer).not_to be_able_to_destroy
-  end
-end
-end
-end

data/spec/drillbit/authorizers/scope_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled'
-require 'ostruct'
-require 'drillbit/authorizers/scope'
-
-module    Drillbit
-module    Authorizers
-describe  Scope do
-  it 'defaults to nothing' do
-    scope = Scope.new(action:     'index',
-                      token:      '123',
-                      user:       Object.new,
-                      issuer:     'my_issuer',
-                      params:     {},
-                      scope_root: OpenStruct.new(none: []))
-
-    expect(scope.call).to be_empty
-  end
-end
-end
-end

data/spec/drillbit/errors/invalid_api_request_spec.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled/spec_helpers/rspeckled'
-require 'drillbit/errors/invalid_api_request'
-
-module    Drillbit
-module    Errors
-describe  InvalidApiRequest do
-  let(:error) { InvalidApiRequest.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_api_request'
-  end
-
-  it 'can output the detail' do
-    expect(error.detail).to eql 'The accept header that you passed in the ' \
-                                'request cannot be parsed, please refer to ' \
-                                'the documentation to verify.'
-  end
-
-  it 'can output the source' do
-    error = InvalidApiRequest.new accept_header: 'foo'
-
-    expect(error.source).to eql(accept_header: 'foo')
-  end
-end
-end
-end

data/spec/drillbit/errors/invalid_request_body_spec.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled/spec_helpers/rspeckled'
-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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled/spec_helpers/rspeckled'
-require 'drillbit/errors/invalid_subdomain'
-
-module    Drillbit
-module    Errors
-describe  InvalidSubdomain do
-  let(:error) { InvalidSubdomain.new }
-
-  it 'has a status of 404' do
-    expect(error.http_status).to eql 404
-  end
-
-  it 'has a code' do
-    expect(error.code).to eql 'errors.invalid_subdomain'
-  end
-
-  it 'can output the detail' do
-    expect(error.detail).to eql \
-      'The subdomain you attempted to access is not valid.  Please try again.'
-  end
-
-  it 'can output the source' do
-    error = InvalidSubdomain.new http_host: 'foo'
-
-    expect(error.source).to eql(http_host: 'foo')
-  end
-end
-end
-end

data/spec/drillbit/errors/invalid_token_spec.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled/spec_helpers/rspeckled'
-require 'drillbit/errors/invalid_token'
-
-module    Drillbit
-module    Errors
-describe  InvalidToken do
-  let(:error) { InvalidToken.new }
-
-  it 'has a status of 401' do
-    expect(error.http_status).to eql 401
-  end
-
-  it 'has a code' do
-    expect(error.code).to eql 'errors.invalid_token'
-  end
-
-  it 'can output the detail' do
-    expect(error.detail).to eql \
-      'Either the token you passed is invalid or is not allowed to perform this action.'
-  end
-end
-end
-end

data/spec/drillbit/invalid_subdomain_spec.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled/spec_helpers/rspeckled'
-require 'drillbit/responses/invalid_subdomain'
-
-module    Drillbit
-module    Responses
-describe  InvalidSubdomain, singletons: Erratum::Configuration do
-  it 'returns the proper response' do
-    Erratum.configuration.url_mappings = {
-      'external_documentation_urls'  => {
-        'errors.responses.invalid_subdomain' => 'http://example.com/foo',
-      },
-      'developer_documentation_urls' => {
-        'errors.responses.invalid_subdomain' => 'http://example.com/foo',
-      },
-    }
-
-    request                   = { 'HTTP_HOST' => 'api.example.com' }
-    status, headers, response = InvalidSubdomain.call(request)
-
-    expect(status).to                 eql 404
-    expect(headers).to                eql({})
-    expect(JSON.load(response[0])).to include(
-      'errors' => [
-                    include(
-                      'id'     => match(/[a-f0-9\-]+/),
-                      'links'  => {
-                        'about'         => nil,
-                        'documentation' => nil,
-                      },
-                      'status' => 404,
-                      'code'   => 'errors.invalid_subdomain',
-                      'title'  => 'Invalid Subdomain',
-                      'detail' => 'The subdomain you attempted to access is not valid.' \
-                                  '  Please try again.',
-                      'source' => {
-                        'http_host' => 'api.example.com',
-                      },
-                    ),
-                  ],
-    )
-  end
-end
-end
-end

data/spec/drillbit/invalid_token_spec.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled/spec_helpers/rspeckled'
-require 'drillbit/responses/invalid_token'
-
-# rubocop:disable Metrics/LineLength
-module    Drillbit
-module    Responses
-describe  InvalidToken, singletons: Erratum::Configuration do
-  it 'returns the proper response' do
-    Erratum.configuration.url_mappings = {
-      'external_documentation_urls'  => {
-        'errors.responses.invalid_token' => 'http://example.com/foo',
-      },
-      'developer_documentation_urls' => {
-        'errors.responses.invalid_token' => 'http://example.com/foo',
-      },
-    }
-
-    request                   = { 'HTTP_HOST' => 'api.example.com' }
-    status, headers, response = InvalidToken.call(request, application_name: 'my_app')
-
-    expect(status).to                 eql 401
-    expect(headers).to                eql('WWW-Authenticate' => 'Token realm="my_app"')
-    expect(JSON.load(response[0])).to include(
-      'errors' => [
-                    include(
-                      'id'     => match(/[a-f0-9\-]+/),
-                      'links'  => {
-                        'about'         => nil,
-                        'documentation' => nil,
-                      },
-                      'status' => 401,
-                      'code'   => 'errors.invalid_token',
-                      'title'  => 'Invalid or Unauthorized Token',
-                      'detail' => 'Either the token you passed is invalid or is not allowed to ' \
-                                  'perform this action.',
-                      'source' => {},
-                    ),
-                  ],
-    )
-  end
-end
-end
-end

data/spec/drillbit/matchers/accept_header_spec.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-require 'rspeckled/spec_helpers/rspeckled'
-require 'drillbit/requests/base'
-require 'drillbit/matchers/accept_header'
-
-# rubocop:disable Metrics/LineLength
-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',
-      'HTTP_X_APPLICATION_NAME' => 'westeros',
-    }
-    request = Requests::Base.resolve(env)
-
-    matcher = AcceptHeader.new
-
-    expect(matcher.matches?(request)).to be_a TrueClass
-  end
-
-  it 'matches if the subdomain is API and the accept header is passed in as ' \
-     'a parameter' do
-
-    env = {
-      'QUERY_STRING'            => 'accept=application/vnd.westeros+redkeep;version=1.0.0',
-      'HTTP_X_APPLICATION_NAME' => 'westeros',
-    }
-    request = Requests::Base.resolve(env)
-
-    matcher = AcceptHeader.new
-
-    expect(matcher.matches?(request)).to be_a TrueClass
-  end
-
-  it 'matches if the subdomain is API and the accept header is passed in as a ' \
-     'secondary parameter' do
-
-    env = {
-      'QUERY_STRING'            => 'first=my_param&accept=application/vnd.westeros+redkeep;' \
-                                   'version=1.0.0',
-      'HTTP_X_APPLICATION_NAME' => 'westeros',
-    }
-    request = Requests::Base.resolve(env)
-
-    matcher = AcceptHeader.new
-
-    expect(matcher.matches?(request)).to be_a TrueClass
-  end
-
-  it 'matches the header accept header if the subdomain is API and the accept header ' \
-     'is passed both as a valid header and as a parameter' do
-
-    env = {
-      'HTTP_ACCEPT'             => 'application/vnd.westeros+redkeep;version=1.0.0',
-      'QUERY_STRING'            => 'accept=application/vnd.westeros+redkeep;version=2.0.0',
-      'HTTP_X_APPLICATION_NAME' => 'westeros',
-    }
-    request = Requests::Base.resolve(env)
-
-    matcher = AcceptHeader.new
-    matcher.matches?(request)
-
-    expect(matcher.accept_header.version).to eql '1.0.0'
-  end
-
-  it 'matches the accept header parameter if the subdomain is API and the accept ' \
-     'header is passed both as an invalid header as well as as a parameter' do
-
-    env = {
-      'HTTP_ACCEPT'             => 'application/vndwesteros+redkeep;version=1.0.0',
-      'QUERY_STRING'            => 'accept=application/vnd.westeros+redkeep;version=2.0.0',
-      'HTTP_X_APPLICATION_NAME' => 'westeros',
-    }
-    request = Requests::Base.resolve(env)
-
-    matcher = AcceptHeader.new
-    matcher.matches?(request)
-
-    expect(matcher.accept_header.version).to eql '2.0.0'
-  end
-
-  it 'matches the accept header parameter if the subdomain is API and the accept ' \
-     'header is passed both as an invalid header as well as as a parameter' do
-
-    env = {
-      'HTTP_ACCEPT'             => 'application/vndwesteros+redkeep;version=1.0.0',
-      'QUERY_STRING'            => '',
-      'HTTP_X_APPLICATION_NAME' => 'westeros',
-    }
-    request = Requests::Base.resolve(env)
-
-    matcher = AcceptHeader.new
-    matcher.matches?(request)
-
-    expect(matcher.accept_header.raw_accept_header).to eql \
-      'application/vndwesteros+redkeep;version=1.0.0'
-  end
-
-  it 'does not match if the subdomain is API but the accept header is invalid' do
-    env = {
-      'HTTP_ACCEPT'             => 'application/vndwesteros+redkeep;version=1.0.0',
-      'QUERY_STRING'            => '',
-      'HTTP_X_APPLICATION_NAME' => 'westeros',
-    }
-    request = Requests::Base.resolve(env)
-
-    matcher = AcceptHeader.new
-
-    expect(matcher.matches?(request)).to be_a FalseClass
-  end
-end
-end
-end