client_version 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f710b5c97a5ae74c49e10f631ad7b8e795b431f
+  data.tar.gz: 0e0b8055ef4cf009a941af19ed7a014bb7805d3d
+SHA512:
+  metadata.gz: 420948abd388d037f483928cec8ae4e302628bc8fe10b8645e899357c0cf8c51e9b217c2cd623216484112398a3b580b0bc8b58768213efe00dd9adcab640640
+  data.tar.gz: 8aac58ea868a7152d4f77881324d0b425447697989d9d76eb9f3cf97fd07f94a617216d1299880c19859fe8d1dae8e0854ed58eec4651aac946d16765b3fa7d0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Johannes Gorset
+
+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,40 @@
+# Client Version
+[![Gem Version](https://img.shields.io/gem/v/client-version.svg?style=flat)](https://rubygems.org/gems/client-version)
+[![Build Status](https://img.shields.io/travis/hyperoslo/client-version.svg?style=flat)](https://travis-ci.org/hyperoslo/client-version)
+[![Code Climate](https://img.shields.io/codeclimate/github/hyperoslo/client-version.svg?style=flat)](https://codeclimate.com/github/hyperoslo/client-version)
+[![Coverage Status](https://img.shields.io/coveralls/hyperoslo/client-version.svg?style=flat)](https://coveralls.io/r/hyperoslo/client-version)
+[![Join the chat at https://gitter.im/hyperoslo/client-version](https://badges.gitter.im/hyperoslo/client-version.svg)](https://gitter.im/hyperoslo/client-version?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+If you're building an API, it can be really helpful to be able to force your
+clients to upgrade to the latest version. This is Rack middleware that simply
+adds a `Client-Version` header to every response with the value of the
+`CLIENT_VERSION` environment variable. Your clients can use it to determine
+whether they should force the user to upgrade to the latest version.
+
+## Installation
+
+You know the drill:
+
+```ruby
+# Gemfile
+gem 'client_version'
+```
+
+```bash
+$ bundle install
+```
+
+## Configuration
+
+If you're using Rails, you're all set; we've hooked into your middleware stack
+for you. Otherwise just add `ClientVersion` to your middleware stack.
+
+## Hyper loves you
+
+[Hyper] made this. We're a bunch of folks who love building things. You should
+[tweet us] if you can't get it to work. In fact, you should tweet us anyway.
+If you're using Facebook Messenger, we probably want to [hire you].
+
+[Hyper]: https://github.com/hyperoslo
+[tweet us]: http://twitter.com/hyperoslo
+[hire you]: http://www.hyper.no/jobs/engineers

data/lib/client_version.rb

@@ -0,0 +1,17 @@
+require 'client_version/version'
+require 'client_version/railtie' if defined?(Rails)
+
+# Rack middleware that adds adds a `Client-Version` header to every response
+# with the value of the `CLIENT_VERSION` environment variable.
+class ClientVersion
+  def initialize(app, client_version = ENV['CLIENT_VERSION'])
+    @app = app
+    @client_version = client_version
+  end
+
+  def call(env)
+    @app.call(env).tap do |_, headers, _|
+      headers['Client-Version'.freeze] = @client_version if @client_version
+    end
+  end
+end

data/lib/client_version/railtie.rb

@@ -0,0 +1,8 @@
+class ClientVersion
+  # Railtie to use the ClientVersion middleware.
+  class Railtie < Rails::Railtie
+    initializer 'client_version.use_middleware' do |app|
+      app.middleware.insert 0, ClientVersion
+    end
+  end
+end

data/lib/client_version/version.rb

@@ -0,0 +1,3 @@
+class ClientVersion
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: client_version
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johannes Gorset
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: pry
+  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: Rack middleware for forcing clients to upgrade
+email:
+- johannes@hyper.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/client_version.rb
+- lib/client_version/railtie.rb
+- lib/client_version/version.rb
+homepage: https://github.com/hyperoslo/client-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.5.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware for forcing clients to upgrade
+test_files: []