rack-json-api-version 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eec834773db4d47d5fd5d95ef7f9eb689ccec32e
+  data.tar.gz: 302b7ee16d55659b44a3ed6474208081cadee56d
+SHA512:
+  metadata.gz: 8d015b1e2dd95ea5ead7a5fc21b0e056c16a28e0b996e6ee69f3570e4221299ed3cb607ed3bd4d027f15f811bdf59d8da98f751a1202d9f779c0c5e1e881569f
+  data.tar.gz: d9c9233cac38d7d7bb4430d790dfa8bdc1cfbe63eeaf4da5ba099c62ce89625a211ae3cd86a38e2a19550d98d168197cc045d99fb94ead88fb9d93977362ba0e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Mantilla
+
+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,49 @@
+# Rack::Json::Api::Version
+
+Extract JSON API version number from request headers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-json-api-version'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-json-api-version
+
+## Usage
+
+In `Rails` add this to your `application.rb' file
+
+    config.middleware.use Rack::Json::Api::Version, vendor: 'company_name'
+
+Where `vendor` is your company name, without any dots
+
+Request header `Accept` should be something like this: `application/vnd.my_company.v1.1+json`
+
+In your controller you will have the version available by using
+
+    env['api.version'] # will return 1.1
+
+    # OR
+
+    request.env['api.version']
+
+This gem will modify the `Accept` headers to `application/json` and keep the original value under the `ORIGINAL_HTTP_ACCEPT` key.
+
+If the `Accept` headers contain `application/json`, `env['api.version']` will return `nil`. In this case `ORIGINAL_HTTP_ACCEPT` won't be set.
+
+In general, if the `Accept` header does not conform to this structure `application/vnd.my_company.vn+json` nothing will be done to the headers.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rack-json-api-version/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/rack/json/api/version/version.rb

@@ -0,0 +1,9 @@
+module Rack
+  module Json
+    module Api
+      class Version
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

data/lib/rack/json/api/version.rb

@@ -0,0 +1,34 @@
+require "rack/json/api/version/version"
+
+module Rack
+  module Json
+    module Api
+      class InvalidVersion < StandardError; end
+
+      class Version
+        def initialize(app, opts={})
+          @app = app
+          @vendor = opts[:vendor] || raise('Vendor name required')
+        end
+
+        def call(env)
+          update(env)
+          @app.call env
+        end
+
+        def extract_version(env)
+          env['HTTP_ACCEPT'].to_s[/^application\/vnd\.#{@vendor}\.v(.+)\+json/, 1]
+        end
+
+        def update(env)
+          version = extract_version(env)
+          env['api.version'] = version
+          unless version.nil?
+            env['ORIGINAL_HTTP_ACCEPT'] = env['HTTP_ACCEPT']
+            env['HTTP_ACCEPT'] = 'application/json'
+          end
+        end
+      end
+    end
+  end
+end

data/rack-json-api-version.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/json/api/version/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-json-api-version"
+  spec.version       = Rack::Json::Api::Version::VERSION
+  spec.authors       = ["Daniel Mantilla"]
+  spec.email         = ["dan@appcabinet.com"]
+  spec.summary       = %q{Middleware to extract the API version from request headers}
+  spec.description   = %q{The API version should reside on the Accept headers. Check documentation for deatils}
+  spec.homepage      = "http://github.com/dmantilla/rack-json-api-version"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/version/version_spec.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rack/json/api/version'
+
+describe Rack::Json::Api::Version do
+  let(:app)   { Object.new }
+  let(:klass) { Rack::Json::Api::Version }
+
+  describe '.initialize' do
+    it 'creates a new instance' do
+      expect { klass.new(app, vendor: 'abc' ) }.not_to raise_error
+    end
+
+    context 'failures' do
+      it 'complains when the vendor is missing' do
+        expect { klass.new(app) }.to raise_error
+      end
+    end
+  end
+
+  describe '#extract_version' do
+    let(:version) { klass.new(app, vendor: 'abc') }
+
+    context 'valid versions' do
+      it 'is version 1' do
+        env = { 'HTTP_ACCEPT' => 'application/vnd.abc.v1+json'}
+        expect(version.extract_version(env)).to eq('1')
+      end
+
+      it 'is version 1.1' do
+        env = { 'HTTP_ACCEPT' => 'application/vnd.abc.v1.1+json'}
+        expect(version.extract_version(env)).to eq('1.1')
+      end
+    end
+
+    context 'version not found' do
+      it 'returns nil' do
+        env = { 'HTTP_ACCEPT' => 'application/json'}
+        expect(version.extract_version(env)).to eq(nil)
+      end
+
+      it 'returns nil' do
+        env = { 'HTTP_ACCEPT' => 'something'}
+        expect(version.extract_version(env)).to eq(nil)
+      end
+    end
+  end
+
+  describe '#update' do
+    let(:version) { klass.new(app, vendor: 'abc') }
+
+    it 'does nothing' do
+      env = {}
+      version.update(env)
+      expect(env).to eq({'api.version' => nil})
+    end
+
+    it 'sets the header and saves the original' do
+      env = {'HTTP_ACCEPT' => 'application/vnd.abc.v1+json'}
+      version.update(env)
+      expect(env).to eq({
+        'api.version'           => '1',
+        'HTTP_ACCEPT'           => 'application/json',
+        'ORIGINAL_HTTP_ACCEPT'  => 'application/vnd.abc.v1+json'
+      })
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rack-json-api-version
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Mantilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The API version should reside on the Accept headers. Check documentation
+  for deatils
+email:
+- dan@appcabinet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/json/api/version.rb
+- lib/rack/json/api/version/version.rb
+- rack-json-api-version.gemspec
+- spec/version/version_spec.rb
+homepage: http://github.com/dmantilla/rack-json-api-version
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Middleware to extract the API version from request headers
+test_files:
+- spec/version/version_spec.rb