apill 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b6e98aa489a5ae613535da00d756a01f5a43a21
+  data.tar.gz: 701aae7dade873f7fbb73dc58f43654dda96797e
+SHA512:
+  metadata.gz: 04627afe9df9d0af43799c794836461cb70587d3877039469d3cb179843d9ee72cd46ef7544921eeeb05d4ca89a03127b90779398637024ed082557bfdb277a2
+  data.tar.gz: fd1903a45d3ab8af84448a0f530b63f2d2b97bd2f3a0f3b60d53648a81fd3d0299d2f9bbd656c50e24c0319762a594cab4dc7129afca1dbc8a9491277be2accc

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeff Felchner
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Apill
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'apill'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apill
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/apill/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/apill.rb

@@ -0,0 +1,7 @@
+require 'apill/version'
+
+require 'apill/matchers/accept_header_matcher'
+require 'apill/matchers/invalid_api_request_matcher'
+require 'apill/matchers/version_matcher'
+
+require 'apill/responses/invalid_api_request_response'

data/lib/apill/accept_header.rb

@@ -0,0 +1,41 @@
+module  Apill
+class   AcceptHeader
+  attr_accessor :application,
+                :raw_accept_header
+
+  def initialize(application:, header:)
+    self.application       = application
+    self.raw_accept_header = header
+  end
+
+  def version
+    accept_header_data[2]
+  end
+
+  def content_type
+    accept_header_data[1]
+  end
+
+  def valid?
+    !accept_header_data.nil?
+  end
+
+  private
+
+  def accept_header_data
+    raw_accept_header.match(accept_header_format)
+  end
+
+  def accept_header_format
+    %r{\Aapplication/#{application_vendor}(?:\+(\w+))?(?:;version=(#{version_format}))?\z}
+  end
+
+  def application_vendor
+    "vnd\\.#{application}"
+  end
+
+  def version_format
+    "\\d+(?:\\.\\d+){0,2}(?:beta(?:\\d*))?"
+  end
+end
+end

data/lib/apill/errors/invalid_api_request_error.rb

@@ -0,0 +1,25 @@
+require 'human_error'
+
+module  Apill
+module  Errors
+class   InvalidApiRequestError < HumanError::Errors::RequestError
+  attr_accessor :accept_header
+
+  def http_status
+    400
+  end
+
+  def developer_message
+    'The accept header that you passed in the request cannot be parsed, please refer to the documentation to verify.'
+  end
+
+  def developer_details
+    { accept_header: accept_header }
+  end
+
+  def friendly_message
+    "Sorry! We couldn't understand what you were trying to ask us to do."
+  end
+end
+end
+end

data/lib/apill/matchers/accept_header_matcher.rb

@@ -0,0 +1,16 @@
+require 'apill/matchers/generic_matcher'
+
+module  Apill
+module  Matchers
+class   AcceptHeaderMatcher
+  include Apill::Matchers::GenericMatcher
+
+  def matches?(request)
+    super
+
+    request.subdomains.first == 'api' &&
+    accept_header.valid?
+  end
+end
+end
+end

data/lib/apill/matchers/generic_matcher.rb

@@ -0,0 +1,21 @@
+require 'apill/accept_header'
+
+module  Apill
+module  Matchers
+module  GenericMatcher
+  attr_accessor :application,
+                :accept_header
+
+  def initialize(**args)
+    args.each do |variable, value|
+      self.send("#{variable}=", value)
+    end
+  end
+
+  def matches?(request)
+    self.accept_header = Apill::AcceptHeader.new(application:  application,
+                                                 header:       request.headers['Accept'])
+  end
+end
+end
+end

data/lib/apill/matchers/invalid_api_request_matcher.rb

@@ -0,0 +1,11 @@
+require 'apill/matchers/accept_header_matcher'
+
+module  Apill
+module  Matchers
+class   InvalidApiRequestMatcher < AcceptHeaderMatcher
+  def matches?(request)
+    !super
+  end
+end
+end
+end

data/lib/apill/matchers/version_matcher.rb

@@ -0,0 +1,28 @@
+require 'apill/matchers/generic_matcher'
+require 'apill/errors/invalid_api_request_error'
+
+module  Apill
+module  Matchers
+class   VersionMatcher
+  include Apill::Matchers::GenericMatcher
+
+  attr_accessor :version_constraint,
+                :default_version
+
+  def matches?(request)
+    super
+
+    raise Apill::Errors::InvalidApiRequestError unless accept_header.valid?
+
+    request.subdomains.first == 'api' &&
+    requested_version        == version_constraint
+  end
+
+  private
+
+  def requested_version
+    accept_header.version || default_version
+  end
+end
+end
+end

data/lib/apill/responses/invalid_api_request_response.rb

@@ -0,0 +1,17 @@
+require 'apill/errors/invalid_api_request_error'
+
+module  Apill
+module  Responses
+class   InvalidApiRequestResponse
+  def self.call(env)
+    error = Apill::Errors::InvalidApiRequestError.new
+
+    [
+      error.http_status,  # HTTP Status Code
+      {},                 # Response Headers
+      error.to_json,      # Message
+    ]
+  end
+end
+end
+end

data/lib/apill/version.rb

@@ -0,0 +1,3 @@
+module Apill
+  VERSION = '1.1.0'
+end

data/spec/lib/apill/accept_header_spec.rb

@@ -0,0 +1,94 @@
+require 'rspectacular'
+require 'apill/accept_header'
+
+module    Apill
+describe  AcceptHeader do
+  it 'can validate an accept header with all the pieces of information' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion;version=1.0.0')
+
+    expect(header).to be_valid
+  end
+
+  it 'does not validate an accept header without passing an application' do
+    header = AcceptHeader.new(application:  '',
+                              header:       'application/vnd.matrix+zion;version=1.0.0')
+
+    expect(header).not_to be_valid
+  end
+
+  it 'does not validate an accept header without an application in the header' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.+zion;version=1.0.0')
+
+    expect(header).not_to be_valid
+
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/+zion;version=1.0.0')
+
+    expect(header).not_to be_valid
+
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/matrix+zion;version=1.0.0')
+
+    expect(header).not_to be_valid
+  end
+
+  it 'does not validate an accept header with an invalid version' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion;version=10..0')
+
+    expect(header).not_to be_valid
+
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion;version=neo')
+
+    expect(header).not_to be_valid
+
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion;version=')
+
+    expect(header).not_to be_valid
+
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion;10.0')
+
+    expect(header).not_to be_valid
+  end
+
+  it 'does validate an accept header even with a missing content type' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix;version=10.0')
+
+    expect(header).to be_valid
+  end
+
+  it 'does validate an accept header with only the minimal information' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix')
+
+    expect(header).to be_valid
+  end
+
+  it 'does validate an accept header with only a content type but no version' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion')
+
+    expect(header).to be_valid
+  end
+
+  it 'can extract version information from an accept header' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion;version=10.0.0beta1')
+
+    expect(header.version).to eql '10.0.0beta1'
+  end
+
+  it 'can extract the content type from an accept header' do
+    header = AcceptHeader.new(application:  'matrix',
+                              header:       'application/vnd.matrix+zion;version=10.0.0beta1')
+
+    expect(header.content_type).to eql 'zion'
+  end
+end
+end

data/spec/lib/apill/errors/invalid_api_request_error_spec.rb

@@ -0,0 +1,36 @@
+require 'rspectacular'
+require 'apill/errors/invalid_api_request_error'
+
+module    Apill
+module    Errors
+describe  InvalidApiRequestError do
+  let(:error) { InvalidApiRequestError.new }
+
+  it 'has a status of 400' do
+    expect(error.http_status).to eql 400
+  end
+
+  it 'has a code of 1007' do
+    expect(error.code).to eql 1007
+  end
+
+  it 'has a knowledgebase article ID of 1234567890' do
+    expect(error.knowledgebase_article_id).to eql '1234567890'
+  end
+
+  it 'can output the developer message' do
+    expect(error.developer_message).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 developer details' do
+    error = InvalidApiRequestError.new accept_header: 'foo'
+
+    expect(error.developer_details).to eql(accept_header: 'foo')
+  end
+
+  it 'can output the friendly message' do
+    expect(error.friendly_message).to eql "Sorry! We couldn't understand what you were trying to ask us to do."
+  end
+end
+end
+end

data/spec/lib/apill/matchers/accept_header_matcher_spec.rb

@@ -0,0 +1,45 @@
+require 'ostruct'
+require 'rspectacular'
+require 'apill/matchers/accept_header_matcher'
+
+module    Apill
+module    Matchers
+describe  AcceptHeaderMatcher do
+  it 'matches if the subdomain is API and the accept header is valid' do
+    request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion;version=1.0.0' },
+                             subdomains:  [ 'api' ])
+
+    matcher = AcceptHeaderMatcher.new(application: 'matrix')
+
+    expect(matcher.matches?(request)).to be_truthy
+  end
+
+  it 'does not match if the subdomain is not API but the accept header is valid' do
+    request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion' },
+                             subdomains:  [ 'not-api' ])
+
+    matcher = AcceptHeaderMatcher.new(application: 'matrix')
+
+    expect(matcher.matches?(request)).to be_falsey
+  end
+
+  it 'does not match if the subdomain is API but the accept header is invalid' do
+    request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.' },
+                             subdomains:  [ 'api' ])
+
+    matcher = AcceptHeaderMatcher.new(application: 'matrix')
+
+    expect(matcher.matches?(request)).to be_falsey
+  end
+
+  it 'does not match if neither the subdomain is API nor the accept header is valid' do
+    request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.' },
+                             subdomains:  [ 'not-api' ])
+
+    matcher = AcceptHeaderMatcher.new(application: 'matrix')
+
+    expect(matcher.matches?(request)).to be_falsey
+  end
+end
+end
+end

data/spec/lib/apill/matchers/invalid_api_request_matcher_spec.rb

@@ -0,0 +1,18 @@
+require 'ostruct'
+require 'rspectacular'
+require 'apill/matchers/invalid_api_request_matcher'
+
+module    Apill
+module    Matchers
+describe  InvalidApiRequestMatcher do
+  it 'is the inverse of whether the accept header matches' do
+    request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion;version=1.0.0' },
+                             subdomains:  [ 'api' ])
+
+    matcher = InvalidApiRequestMatcher.new(application: 'matrix')
+
+    expect(matcher.matches?(request)).to be_falsey
+  end
+end
+end
+end

data/spec/lib/apill/matchers/version_matcher_spec.rb

@@ -0,0 +1,85 @@
+require 'ostruct'
+require 'rspectacular'
+require 'apill/matchers/version_matcher'
+
+module    Apill
+module    Matchers
+describe  VersionMatcher do
+  it 'raises an error when the accept header is not valid' do
+    request = OpenStruct.new(headers:     { 'Accept' => 'matrix' },
+                             subdomains:  [ 'api' ])
+
+    matcher = VersionMatcher.new
+
+    expect { matcher.matches?(request) }.to raise_error Apill::Errors::InvalidApiRequestError
+  end
+
+  context 'when the version is passed in the accept header' do
+    it 'does not match if the subdomain is not API but the request version is equal to the version constraint' do
+      request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion;version=10.0' },
+                               subdomains:  [ 'not-api' ])
+
+      matcher = VersionMatcher.new(application:        'matrix',
+                                   version_constraint: '10.0')
+
+      expect(matcher.matches?(request)).to be_falsey
+    end
+
+    it 'does not match if the subdomain is API but the requested version does not equal the version constraint' do
+      request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion;version=10.0' },
+                               subdomains:  [ 'api' ])
+
+      matcher = VersionMatcher.new(application:        'matrix',
+                                   version_constraint: '10.1')
+
+      expect(matcher.matches?(request)).to be_falsey
+    end
+
+    it 'does match if the subdomain is API and the requested version equals the version constraint' do
+      request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion;version=10.0' },
+                               subdomains:  [ 'api' ])
+
+      matcher = VersionMatcher.new(application:        'matrix',
+                                   version_constraint: '10.0')
+
+      expect(matcher.matches?(request)).to be_truthy
+    end
+  end
+
+  context 'when the version is not passed in the accept header' do
+    it 'does not match if the subdomain is not API but the request version is equal to the version constraint' do
+      request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion' },
+                               subdomains:  [ 'not-api' ])
+
+      matcher = VersionMatcher.new(application:        'matrix',
+                                   version_constraint: '10.0',
+                                   default_version:    '10.0')
+
+      expect(matcher.matches?(request)).to be_falsey
+    end
+
+    it 'does not match if the subdomain is API but the requested version does not equal the version constraint' do
+      request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion' },
+                               subdomains:  [ 'api' ])
+
+      matcher = VersionMatcher.new(application:        'matrix',
+                                   version_constraint: '10.1',
+                                   default_version:    '10.0')
+
+      expect(matcher.matches?(request)).to be_falsey
+    end
+
+    it 'does match if the subdomain is API and the requested version equals the version constraint' do
+      request = OpenStruct.new(headers:     { 'Accept' => 'application/vnd.matrix+zion' },
+                               subdomains:  [ 'api' ])
+
+      matcher = VersionMatcher.new(application:        'matrix',
+                                   version_constraint: '10.0',
+                                   default_version:    '10.0')
+
+      expect(matcher.matches?(request)).to be_truthy
+    end
+  end
+end
+end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: apill
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- jfelchner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: human_error
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0beta
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0beta
+- !ruby/object:Gem::Dependency
+  name: rspectacular
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+description: ''
+email: accounts+git@thekompanee.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/apill.rb
+- lib/apill/accept_header.rb
+- lib/apill/errors/invalid_api_request_error.rb
+- lib/apill/matchers/accept_header_matcher.rb
+- lib/apill/matchers/generic_matcher.rb
+- lib/apill/matchers/invalid_api_request_matcher.rb
+- lib/apill/matchers/version_matcher.rb
+- lib/apill/responses/invalid_api_request_response.rb
+- lib/apill/version.rb
+- spec/lib/apill/accept_header_spec.rb
+- spec/lib/apill/errors/invalid_api_request_error_spec.rb
+- spec/lib/apill/matchers/accept_header_matcher_spec.rb
+- spec/lib/apill/matchers/invalid_api_request_matcher_spec.rb
+- spec/lib/apill/matchers/version_matcher_spec.rb
+homepage: https://github.com/jfelchner/apill
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset = UTF-8"
+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: apill
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Common API functionality
+test_files:
+- spec/lib/apill/accept_header_spec.rb
+- spec/lib/apill/errors/invalid_api_request_error_spec.rb
+- spec/lib/apill/matchers/accept_header_matcher_spec.rb
+- spec/lib/apill/matchers/invalid_api_request_matcher_spec.rb
+- spec/lib/apill/matchers/version_matcher_spec.rb
+has_rdoc: