rack-vendor_accept_header 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c91d3f2be51f0a1f1ddf59f1d8950c59bc51e4a
+  data.tar.gz: 044ec15f4ae9ce158dc685464f0bb5777d837962
+SHA512:
+  metadata.gz: 74d4417e73594ed204f9a9f7f1b6ef79a12c81477fa04c8e3c21874755ae2da7a7d2f20e59b91a8d6f5ece538db654d8e9a2a5afc0c9061f2758d2384cf0e5d4
+  data.tar.gz: 333578848e3e4bd9b4187126bc19f0964b72c2bde76c7ed37e7a058089db0bb9aa8a4c69127e24710e1a2178955368d3cff07beb54c0e5f89a268659e31d4744

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# ChangeLog
+
+The following are lists of the notable changes included with each release.
+This is intended to help keep people informed about notable changes between
+versions as well as provide a rough history.
+
+#### Next Release
+
+#### v1.0.0
+
+* wrote READEME.md
+* added vnd version parsing & exposure
+* added vnd context parsing & exposure
+* added vnd type parsing & exposure
+* added vnd sub_type parsing & exposure

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-vendor_accept_header.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew De Ponte
+
+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,110 @@
+# Rack::VendorAcceptHeader
+
+Welcome to the `rack-vendor_accept_header` gem. It provides
+[rack](http://rack.github.io) middleware that parses [vendor based mime
+types](https://tools.ietf.org/html/rfc4288#section-3.2) in the HTTP
+Accept header.
+
+```http
+GET /something HTTP/1.1
+Accept: application/vnd.acme.v3+json
+```
+
+The primary impetus for doing this is to be able to use vendor mime
+types in the HTTP Accept header for REST API versioning as well as for
+content negotiation. The [GitHub API's usage of Media
+Types](https://developer.github.com/v3/media/) is an excellent example
+of this.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-vendor_accept_header'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-vendor_accept_header
+
+## Usage
+
+Given that this is [rack](http://rack.github.io) middleware, it can be
+used with pure [rack](http://rack.github.io) applications, or with the
+vast number of web frameworks that are built on top of
+[rack](http://rack.github.io). This includes [Ruby on
+Rails](http://rubyonrails.org), [Sinatra](http://www.sinatrarb.com),
+[Grape](http://intridea.github.io/grape/), etc. Details on using
+[rack](http://rack.github.io) middleware within each of these framework
+can be found within their respective documentation. However, the
+following is a quick example of how you would register this
+[rack](http://rack.github.io) middleware in
+[Sinatra](http://www.sinatrarb.com).
+
+```ruby
+use Rack::VendorAcceptHeader
+```
+
+When you use this middleware it parses and exposes the `type`, `sub_type`,
+`context`, and `version` out of the vendor based mime type HTTP Accept
+header.
+
+```http
+GET /something HTTP/1.1
+Accept: application/vnd.acme.v3+json
+```
+
+Given the example above this middleware would expose these components in
+the [rack](http://rack.github.io) env as follows:
+
+```ruby
+request.env['vnd_type']     # => 'application'
+request.env['vnd_sub_type'] # => 'json'
+request.env['vnd_version']  # => '3'
+request.env['vnd_context']  # => 'acme'
+```
+
+## References
+
+If you are interested in any of the references around this use case and
+the details around it. Please see the following.
+
+- [GitHub API Media Types](https://developer.github.com/v3/media/)
+- [rfc2616 sec14 - Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
+- [rfc4288 sec3.2 - Media Type Specifications and Registration Procedures](https://tools.ietf.org/html/rfc4288#section-3.2)
+- [Using the Accept Header to version your API](http://labs.qandidate.com/blog/2014/10/16/using-the-accept-header-to-version-your-api/)
+- [Pivotal Labs - API Versioning](https://blog.pivotal.io/labs/labs/api-versioning)
+- [Nobody Understands REST or HTTP](http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http)
+- [MIMETYPES (AND APIS)](https://daveyshafik.com/archives/35507-mimetypes-and-apis.html)
+- [Versioning REST Web Services](http://barelyenough.org/blog/2008/05/versioning-rest-web-services/)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will create
+a git tag for the version, push git commits and tags, and push the
+`.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+[https://github.com/codebreakdown/rack-vendor_accept_header](https://github.com/codebreakdown/rack-vendor_accept_header).
+This project is intended to be a safe, welcoming space for
+collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/vendor_accept_header"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/vendor_accept_header.rb

@@ -0,0 +1,30 @@
+require "rack/vendor_accept_header/version"
+require "rack"
+
+module Rack
+  class VendorAcceptHeader
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+    end
+
+    def call(env)
+      parts = parse_accept_header(env)
+      env['vnd_version'] = parts[:version]
+      env['vnd_context'] = parts[:context]
+      env['vnd_type'] = parts[:type]
+      env['vnd_sub_type'] = parts[:sub_type]
+      @app.call(env)
+    end
+
+    private
+
+    def parse_accept_header(env)
+      if env['HTTP_ACCEPT'] =~ /application\/vnd\.(\w+)\.v(\d+(?:\.\d+)*)\+(\w+)/
+        return { type: 'application', context: $1, version: $2, sub_type: $3 }
+      else
+        return { type: nil, context: nil, version: nil, sub_type: nil }
+      end
+    end
+  end
+end

data/lib/rack/vendor_accept_header/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class VendorAcceptHeader
+    VERSION = "1.0.0"
+  end
+end

data/rack-vendor_accept_header.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/vendor_accept_header/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-vendor_accept_header"
+  spec.version       = Rack::VendorAcceptHeader::VERSION
+  spec.authors       = ["Andrew De Ponte"]
+  spec.email         = ["cyphactor@gmail.com"]
+
+  spec.summary       = %q{Rack middleware to parse vendor accept headers}
+  spec.description   = %q{Rack middleware to aid with parsing vendor accept headers}
+  spec.homepage      = "https://github.com/codebreakdown/rack-vendor_accept_header"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rack-vendor_accept_header
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew De Ponte
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Rack middleware to aid with parsing vendor accept headers
+email:
+- cyphactor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/vendor_accept_header.rb
+- lib/rack/vendor_accept_header/version.rb
+- rack-vendor_accept_header.gemspec
+homepage: https://github.com/codebreakdown/rack-vendor_accept_header
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware to parse vendor accept headers
+test_files: []