apill 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 324554154383f6408cffde10e537effa59d4b928
-  data.tar.gz: c5b4dbfa7b10c87ae1861526fcda7eb6a1a55016
+  metadata.gz: 83d6429288497499ef52987e7f8f9a5c8d8c7f6c
+  data.tar.gz: a07b1f22022080022b72665a07b212c58aba56d4
 SHA512:
-  metadata.gz: 8e5ba589f30445e86f402e2aefb0c9ea22b5dda8943a85bcf612a98fd48128c52749ab069cb267d267159143211d24bbf826c86d26905e895eab1a5d5210a07d
-  data.tar.gz: 8adaaa7dbf3dc3dba76f6be72503fc9b14973e82d5a726ad4591f9dbedbb76725f9c069c28ac71dba9b13fb37a03fe348fd4761cb034c3131797e5df42dc72ca
+  metadata.gz: 80896fdee5a9fd08bf3ba02449d54d481415ccb6fa82424312fa3aaa329bcaf1492ac14d93f4f7bca224cbe7cc78f2da21210f5e07b9992887dfcce8d6f3bb3d
+  data.tar.gz: 875abc5d8d8999fe9e649f2fde48305c2f822ecdc820ba2aad2c7f8d79aa906eb69b9a135bfb3129d8ff55458be3f294ba20d53dad75727111786c5de8641acf

data/lib/apill/accept_header.rb

@@ -17,7 +17,15 @@ class   AcceptHeader
   end
 
   def valid?
-    !accept_header_data.nil?
+    !invalid?
+  end
+
+  def invalid?
+    accept_header_data.nil?
+  end
+
+  def to_s
+    raw_accept_header
   end
 
   private

data/lib/apill/configuration.rb

@@ -14,6 +14,10 @@ module  Apill
     end
   end
 
+  def allowed_subdomains
+    @allowed_subdomains || ['api']
+  end
+
   def self.configure
     yield configuration
   end

data/lib/apill/matchers/generic_matcher.rb

@@ -1,4 +1,5 @@
 require 'apill/accept_header'
+require 'apill/requests/base'
 
 module  Apill
 module  Matchers
@@ -13,31 +14,9 @@ module  GenericMatcher
   end
 
   def matches?(request)
-    self.application   = request['API_APPLICATION_NAME']
-    self.accept_header = get_accept_header(raw_header_from_headers: request['HTTP_ACCEPT'],
-                                           raw_header_from_params:  request['QUERY_STRING'])
-  end
-
-  private
-
-  def get_accept_header(raw_header_from_headers:, raw_header_from_params:)
-    header_from_header = accept_header_from_string(raw_header_from_headers)
-
-    return header_from_header if header_from_header.valid? ||
-                                 raw_header_from_params.to_s.empty?
-
-    accept_header_from_params(raw_header_from_params)
-  end
-
-  def accept_header_from_string(raw_header_from_headers='')
-    Apill::AcceptHeader.new(application:  application,
-                            header:       raw_header_from_headers)
-  end
-
-  def accept_header_from_params(raw_header_from_params='')
-    header_from_params = raw_header_from_params[%r{(?:\A|&)accept=(.+?)(?=\z|&)}, 1]
-
-    accept_header_from_string(header_from_params)
+    request            = Requests::Base.resolve(request)
+    self.application   = request.application_name
+    self.accept_header = request.accept_header
   end
 end
 end

data/lib/apill/matchers/subdomain_matcher.rb

@@ -1,7 +1,7 @@
 module  Apill
 module  Matchers
 class   SubdomainMatcher
-  def initialize(allowed_subdomains: ['api'])
+  def initialize(allowed_subdomains: Apill.configuration.allowed_subdomains)
     self.allowed_subdomains = Array(allowed_subdomains)
   end
 

data/lib/apill/matchers/version_matcher.rb

@@ -4,7 +4,7 @@ require 'apill/matchers/generic_matcher'
 module  Apill
 module  Matchers
 class   VersionMatcher
-  include Apill::Matchers::GenericMatcher
+  include GenericMatcher
 
   attr_accessor :version_constraint,
                 :default_version

data/lib/apill/middleware/api_request.rb

@@ -13,11 +13,9 @@ class   ApiRequest
   end
 
   def call(env)
-    env['API_APPLICATION_NAME'] = Apill.configuration.application_name
-
-    if Matchers::SubdomainMatcher.new(allowed_subdomains: Apill.configuration.allowed_subdomains).
-                                  matches?(env)
+    env['HTTP_X_APPLICATION_NAME'] = Apill.configuration.application_name
 
+    if Matchers::SubdomainMatcher.new.matches?(env)
       if Matchers::AcceptHeaderMatcher.new.matches?(env)
         @app.call(env)
       else

data/lib/apill/requests/base.rb

@@ -0,0 +1,37 @@
+module  Apill
+module  Requests
+class   Base
+  def self.resolve(original_request)
+    if original_request.respond_to? :headers
+      rails_request_class.new(original_request)
+    else
+      rack_request_class.new(original_request)
+    end
+  end
+
+  def accept_header
+    if accept_header_from_header.valid? ||
+       accept_header_from_params.invalid?
+
+      accept_header_from_header
+    else
+      accept_header_from_params
+    end
+  end
+
+  private
+
+  def self.rails_request_class
+    require 'apill/requests/rails_request'
+
+    Object.const_get('Apill::Requests::RailsRequest')
+  end
+
+  def self.rack_request_class
+    require 'apill/requests/rack_request'
+
+    Object.const_get('Apill::Requests::RackRequest')
+  end
+end
+end
+end

data/lib/apill/requests/rack_request.rb

@@ -0,0 +1,37 @@
+require 'apill/configuration'
+require 'apill/requests/base'
+require 'apill/accept_header'
+
+module  Apill
+module  Requests
+class   RackRequest < Base
+  ACCEPT_PARAM_PATTERN = %r{(?:\A|&)accept=(.+?)(?=\z|&)}
+
+  attr_accessor :request
+
+  def initialize(request)
+    self.request = request
+  end
+
+  def accept_header_from_header
+    AcceptHeader.new(application: application_name,
+                     header:      request['HTTP_ACCEPT'] || '')
+  end
+
+  def accept_header_from_params
+    AcceptHeader.new(application: application_name,
+                     header:      raw_accept_header_from_params || '')
+  end
+
+  def application_name
+    request['HTTP_X_APPLICATION_NAME'] || Apill.configuration.application_name
+  end
+
+  private
+
+  def raw_accept_header_from_params
+    request['QUERY_STRING'][ACCEPT_PARAM_PATTERN, 1]
+  end
+end
+end
+end

data/lib/apill/requests/rails_request.rb

@@ -0,0 +1,29 @@
+require 'apill/configuration'
+require 'apill/requests/base'
+require 'apill/accept_header'
+
+module  Apill
+module  Requests
+class   RailsRequest < Base
+  attr_accessor :request
+
+  def initialize(request)
+    self.request = request
+  end
+
+  def accept_header_from_header
+    AcceptHeader.new(application: application_name,
+                     header:      request.headers['Accept'] || '')
+  end
+
+  def accept_header_from_params
+    AcceptHeader.new(application: application_name,
+                     header:      request.params['accept'] || '')
+  end
+
+  def application_name
+    request.headers['X-Application-Name'] || Apill.configuration.application_name
+  end
+end
+end
+end

data/lib/apill/version.rb

@@ -1,3 +1,3 @@
 module Apill
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/spec/apill/matchers/accept_header_matcher_spec.rb

@@ -6,8 +6,8 @@ module    Matchers
 describe  AcceptHeaderMatcher do
   it 'matches if the subdomain is API and the accept header is valid' do
     request = {
-      'HTTP_ACCEPT'          => 'application/vnd.matrix+zion;version=1.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_ACCEPT'             => 'application/vnd.matrix+zion;version=1.0.0',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = AcceptHeaderMatcher.new
@@ -19,8 +19,8 @@ describe  AcceptHeaderMatcher do
      'a parameter' do
 
     request = {
-      'QUERY_STRING'         => 'accept=application/vnd.matrix+zion;version=1.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'QUERY_STRING'            => 'accept=application/vnd.matrix+zion;version=1.0.0',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = AcceptHeaderMatcher.new
@@ -32,8 +32,8 @@ describe  AcceptHeaderMatcher do
      'secondary parameter' do
 
     request = {
-      'QUERY_STRING'         => 'first=my_param&accept=application/vnd.matrix+zion;version=1.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'QUERY_STRING'            => 'first=my_param&accept=application/vnd.matrix+zion;version=1.0.0',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = AcceptHeaderMatcher.new
@@ -45,9 +45,9 @@ describe  AcceptHeaderMatcher do
      'is passed both as a valid header and as a parameter' do
 
     request = {
-      'HTTP_ACCEPT'          => 'application/vnd.matrix+zion;version=1.0.0',
-      'QUERY_STRING'         => 'accept=application/vnd.matrix+zion;version=2.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_ACCEPT'             => 'application/vnd.matrix+zion;version=1.0.0',
+      'QUERY_STRING'            => 'accept=application/vnd.matrix+zion;version=2.0.0',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = AcceptHeaderMatcher.new
@@ -60,9 +60,9 @@ describe  AcceptHeaderMatcher do
      'header is passed both as an invalid header as well as as a parameter' do
 
     request = {
-      'HTTP_ACCEPT'          => 'application/vndmatrix+zion;version=1.0.0',
-      'QUERY_STRING'         => 'accept=application/vnd.matrix+zion;version=2.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_ACCEPT'             => 'application/vndmatrix+zion;version=1.0.0',
+      'QUERY_STRING'            => 'accept=application/vnd.matrix+zion;version=2.0.0',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = AcceptHeaderMatcher.new
@@ -75,9 +75,9 @@ describe  AcceptHeaderMatcher do
      'header is passed both as an invalid header as well as as a parameter' do
 
     request = {
-      'HTTP_ACCEPT'          => 'application/vndmatrix+zion;version=1.0.0',
-      'QUERY_STRING'         => '',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_ACCEPT'             => 'application/vndmatrix+zion;version=1.0.0',
+      'QUERY_STRING'            => '',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = AcceptHeaderMatcher.new
@@ -89,9 +89,9 @@ describe  AcceptHeaderMatcher do
 
   it 'does not match if the subdomain is API but the accept header is invalid' do
     request = {
-      'HTTP_ACCEPT'          => 'application/vndmatrix+zion;version=1.0.0',
-      'QUERY_STRING'         => '',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_ACCEPT'             => 'application/vndmatrix+zion;version=1.0.0',
+      'QUERY_STRING'            => '',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = AcceptHeaderMatcher.new

data/spec/apill/matchers/invalid_api_request_matcher_spec.rb

@@ -7,9 +7,9 @@ module    Matchers
 describe  InvalidApiRequestMatcher do
   it 'is the inverse of whether the accept header matches' do
     request = {
-      'HTTP_HOST'            => 'api.example.com',
-      'HTTP_ACCEPT'          => 'application/vnd.matrix+zion;version=1.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_HOST'               => 'api.example.com',
+      'HTTP_ACCEPT'             => 'application/vnd.matrix+zion;version=1.0.0',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
     }
 
     matcher = InvalidApiRequestMatcher.new

data/spec/apill/matchers/subdomain_matcher_spec.rb

@@ -4,6 +4,10 @@ require 'apill/matchers/subdomain_matcher'
 module    Apill
 module    Matchers
 describe  SubdomainMatcher do
+  before(:each) do
+    Apill.configuration.allowed_subdomains = %w{api}
+  end
+
   it 'matches if the subdomain is API' do
     matcher = SubdomainMatcher.new
     request = { 'HTTP_HOST' => 'api.example.com' }

data/spec/apill/matchers/version_matcher_spec.rb

@@ -9,8 +9,8 @@ describe  VersionMatcher do
        'equal the version constraint' do
 
       request = {
-        'API_APPLICATION_NAME' => 'matrix',
-        'HTTP_ACCEPT'          => 'application/vnd.matrix+zion;version=10.0',
+        'HTTP_X_APPLICATION_NAME' => 'matrix',
+        'HTTP_ACCEPT'             => 'application/vnd.matrix+zion;version=10.0',
       }
 
       matcher = VersionMatcher.new(version_constraint: '10.1')
@@ -22,8 +22,8 @@ describe  VersionMatcher do
        'version constraint' do
 
       request = {
-        'API_APPLICATION_NAME' => 'matrix',
-        'HTTP_ACCEPT'          => 'application/vnd.matrix+zion;version=10.0',
+        'HTTP_X_APPLICATION_NAME' => 'matrix',
+        'HTTP_ACCEPT'             => 'application/vnd.matrix+zion;version=10.0',
       }
 
       matcher = VersionMatcher.new(version_constraint: '10.0')
@@ -37,8 +37,8 @@ describe  VersionMatcher do
        'equal the version constraint' do
 
       request = {
-        'API_APPLICATION_NAME' => 'matrix',
-        'HTTP_ACCEPT'          => 'application/vnd.matrix+zion',
+        'HTTP_X_APPLICATION_NAME' => 'matrix',
+        'HTTP_ACCEPT'             => 'application/vnd.matrix+zion',
       }
 
       matcher = VersionMatcher.new(version_constraint: '10.1',
@@ -51,8 +51,8 @@ describe  VersionMatcher do
        'version constraint' do
 
       request = {
-        'API_APPLICATION_NAME' => 'matrix',
-        'HTTP_ACCEPT'          => 'application/vnd.matrix+zion',
+        'HTTP_X_APPLICATION_NAME' => 'matrix',
+        'HTTP_ACCEPT'             => 'application/vnd.matrix+zion',
       }
 
       matcher = VersionMatcher.new(version_constraint: '10.0',
@@ -66,8 +66,8 @@ describe  VersionMatcher do
     Apill.configuration.default_api_version = '100.0'
 
     request = {
-      'API_APPLICATION_NAME' => 'matrix',
-      'HTTP_ACCEPT'          => 'application/vnd.matrix+zion',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
+      'HTTP_ACCEPT'             => 'application/vnd.matrix+zion',
     }
 
     matcher = VersionMatcher.new(version_constraint: '100.0')

data/spec/apill/middleware/api_request_spec.rb

@@ -1,30 +1,31 @@
 require 'rspectacular'
 require 'apill/middleware/api_request'
 
-HumanError.configure do |config|
-  config.api_error_documentation_url = 'http://error.com'
-  config.knowledgebase_url           = 'http://knowledge.com'
-  config.api_version                 = '1'
-end
-
-Apill.configure do |config|
-  config.allowed_subdomains = %w{api}
-  config.application_name   = 'matrix'
-end
-
 module    Apill
 module    Middleware
 describe  ApiRequest do
   let(:app) { lambda { |env| [200, {}, 'response'] } }
 
+  before(:each) do
+    HumanError.configure do |config|
+      config.api_error_documentation_url = 'http://error.com'
+      config.knowledgebase_url           = 'http://knowledge.com'
+      config.api_version                 = '1'
+    end
+
+    Apill.configure do |config|
+      config.allowed_subdomains = %w{api}
+      config.application_name   = 'matrix'
+    end
+  end
+
   it 'does not allow requests if they are not for an allowed subdomain' do
     api_request_middleware = ApiRequest.new(app)
 
     request = {
-      'HTTP_HOST'            => 'notvalid.example.com',
-      'HTTP_ACCEPT'          => '',
-      'QUERY_STRING'         => 'first=my_param&accept=application/vnd.silent+zion;version=1.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_HOST'               => 'notvalid.example.com',
+      'HTTP_ACCEPT'             => '',
+      'QUERY_STRING'            => 'first=my_param&accept=application/vnd.silent+zion;version=1.0.0',
     }
 
     status, headers, response = api_request_middleware.call(request)
@@ -60,10 +61,9 @@ describe  ApiRequest do
     api_request_middleware = ApiRequest.new(app)
 
     request = {
-      'HTTP_HOST'            => 'api.example.com',
-      'HTTP_ACCEPT'          => '',
-      'QUERY_STRING'         => 'first=my_param&accept=application/vnd.silent+zion;version=1.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_HOST'               => 'api.example.com',
+      'HTTP_ACCEPT'             => '',
+      'QUERY_STRING'            => 'first=my_param&accept=application/vnd.silent+zion;version=1.0.0',
     }
 
     status, headers, response = api_request_middleware.call(request)
@@ -97,10 +97,9 @@ describe  ApiRequest do
     api_request_middleware = ApiRequest.new(app)
 
     request = {
-      'HTTP_HOST'            => 'api.example.com',
-      'HTTP_ACCEPT'          => 'application/vnd.matrix+zion;version=1.0.0',
-      'QUERY_STRING'         => 'first=my_param&accept=application/vnd.matrix+zion;version=1.0.0',
-      'API_APPLICATION_NAME' => 'matrix',
+      'HTTP_HOST'               => 'api.example.com',
+      'HTTP_ACCEPT'             => 'application/vnd.matrix+zion;version=1.0.0',
+      'QUERY_STRING'            => 'first=my_param&accept=application/vnd.matrix+zion;version=1.0.0',
     }
 
     status, headers, response = api_request_middleware.call(request)

data/spec/apill/requests/rack_request_spec.rb

@@ -0,0 +1,57 @@
+require 'rspectacular'
+require 'apill/requests/rack_request'
+
+module    Apill
+module    Requests
+describe  RackRequest do
+  it 'finds the accept header from the headers if it is valid' do
+    raw_request = {
+      'HTTP_ACCEPT'             => 'application/vnd.matrix+zion;version=10.0',
+      'QUERY_STRING'            => '',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
+    }
+    request     = RackRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'application/vnd.matrix+zion;version=10.0'
+  end
+
+  it 'finds the accept header from the headers if it is invalid but there is no ' \
+     'accept header in the params' do
+
+    raw_request = {
+      'HTTP_ACCEPT'             => 'invalid/vnd.matrix+zion;version=10.0',
+      'QUERY_STRING'            => '',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
+    }
+    request     = RackRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'invalid/vnd.matrix+zion;version=10.0'
+  end
+
+  it 'finds the accept header from the params if it is valid' do
+    raw_request = {
+      'HTTP_ACCEPT'             => '',
+      'QUERY_STRING'            => 'accept=application/vnd.matrix+zion;version=10.0',
+      'HTTP_X_APPLICATION_NAME' => 'matrix',
+    }
+    request     = RackRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'application/vnd.matrix+zion;version=10.0'
+  end
+
+  it 'defaults to the application name in the configuration if none is found in ' \
+     'the header' do
+
+    Apill.configuration.application_name = 'zion'
+
+    raw_request = {
+      'HTTP_ACCEPT'             => '',
+      'QUERY_STRING'            => 'accept=application/vnd.zion+zion;version=10.0',
+    }
+    request     = RackRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'application/vnd.zion+zion;version=10.0'
+  end
+end
+end
+end

data/spec/apill/requests/rails_request_spec.rb

@@ -0,0 +1,59 @@
+require 'ostruct'
+require 'rspectacular'
+require 'apill/requests/rails_request'
+
+module    Apill
+module    Requests
+describe  RailsRequest do
+  it 'finds the accept header from the headers if it is valid' do
+    raw_request = OpenStruct.new(
+                    headers: {
+                      'X-Application-Name' => 'matrix',
+                      'Accept'             => 'application/vnd.matrix+zion;version=10.0',
+                    },
+                    params:  {})
+    request     = RailsRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'application/vnd.matrix+zion;version=10.0'
+  end
+
+  it 'finds the accept header from the headers if it is invalid but there is no ' \
+     'accept header in the params' do
+
+    raw_request = OpenStruct.new(
+                    headers: {
+                      'X-Application-Name' => 'matrix',
+                      'Accept'             => 'invalid/vnd.matrix+zion;version=10.0',
+                    },
+                    params:  {})
+    request     = RailsRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'invalid/vnd.matrix+zion;version=10.0'
+  end
+
+  it 'finds the accept header from the params if it is valid' do
+    raw_request = OpenStruct.new(
+                    headers: {
+                      'X-Application-Name' => 'matrix',
+                    },
+                    params:  { 'accept' => 'application/vnd.matrix+zion;version=10.0' })
+    request     = RailsRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'application/vnd.matrix+zion;version=10.0'
+  end
+
+  it 'defaults to the application name in the configuration if none is found in ' \
+     'the header' do
+
+    Apill.configuration.application_name = 'zion'
+
+    raw_request = OpenStruct.new(
+                    headers: {},
+                    params:  { 'accept' => 'application/vnd.zion+zion;version=10.0' })
+    request     = RailsRequest.new(raw_request)
+
+    expect(request.accept_header.to_s).to eql 'application/vnd.zion+zion;version=10.0'
+  end
+end
+end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apill
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - jfelchner
@@ -86,6 +86,9 @@ files:
 - lib/apill/matchers/subdomain_matcher.rb
 - lib/apill/matchers/version_matcher.rb
 - lib/apill/middleware/api_request.rb
+- lib/apill/requests/base.rb
+- lib/apill/requests/rack_request.rb
+- lib/apill/requests/rails_request.rb
 - lib/apill/responses/invalid_api_request_response.rb
 - lib/apill/responses/invalid_subdomain_response.rb
 - lib/apill/version.rb
@@ -98,6 +101,8 @@ files:
 - spec/apill/matchers/subdomain_matcher_spec.rb
 - spec/apill/matchers/version_matcher_spec.rb
 - spec/apill/middleware/api_request_spec.rb
+- spec/apill/requests/rack_request_spec.rb
+- spec/apill/requests/rails_request_spec.rb
 homepage: https://github.com/jfelchner/apill
 licenses:
 - MIT
@@ -132,4 +137,6 @@ test_files:
 - spec/apill/matchers/subdomain_matcher_spec.rb
 - spec/apill/matchers/version_matcher_spec.rb
 - spec/apill/middleware/api_request_spec.rb
+- spec/apill/requests/rack_request_spec.rb
+- spec/apill/requests/rails_request_spec.rb
 has_rdoc: