rack-locale-root-redirect 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcaab6184e9b62181e1640b5fecbaf3ccdc0a622
-  data.tar.gz: a3453a28b666819ce6ac59a410a96e94964f230c
+  metadata.gz: 1d2d5a0277e85cb40191e22c43805c04c61686b6
+  data.tar.gz: ff459afe51d1e6f138e6b8b993b1278afdd2b6d6
 SHA512:
-  metadata.gz: 0818ace5d08d70bdd3d2222943f95ebc609521b9270ccba2365743446416fbccfb39c7d178a6efc559d252cbbbc590a74b3b719eb5461207b7c6be6abf0cbc57
-  data.tar.gz: d1ecfbd5cdea8b9b8eb628fba9027e9a568a0d1240937a86e7692a742cff7a8bfbf3a0b2a9ef49c6390983f634749326edc092c499cdec759563a7378706c210
+  metadata.gz: 5917d7929baaa7ba25c09cd9d23a06f4b09bb03cdb355f5c0283f9745cde0614484693c7547f2b6ef487e2a7e18933d2de53273654feab94b94befbb6bd02737
+  data.tar.gz: c94307202a975a43d1dc18573700573cbdad25e1c36640ca1a6d7e7bf51e4538ef1f9bb133584d501f94432df48dd8aff29deb53ab549ed9cedce8a44a8680a3

data/.travis.yml

@@ -1,7 +1,18 @@
 language: ruby
 
 rvm:
-  - 2.0.0
+  - 2.1
+  - 2.0
   - 1.9.3
 
+sudo: false
+
 script: "echo 'DO IT' && bundle exec rake spec"
+
+notifications:
+  hipchat:
+    rooms:
+      secure: "RFgHPxn6Oq4BSmmb9sI0Qd3lhDerpbuIUh6A08k0jB1WHTSUVMH62up/B33PGbvtdsCZ1vZwrFo/ePE7kZrRJSGHNoV55em7GsVBOqXRcJnl8YTj65IXM51S7d22v9YmhjG2mkyJo+IZ+yWTJ6DZI1DLqNmYWhszTvcJqWJOEd4="
+    template:
+      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Build</a>/<a href="%{compare_url}">Changes</a>)'
+    format: 'html'

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2013, Mirego
+Copyright (c) 2013-2015, Mirego
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,7 +1,6 @@
 # Rack::LocaleRootRedirect
 
 [![Build Status](https://travis-ci.org/mirego/rack-locale-root-redirect.png?branch=master)](https://travis-ci.org/mirego/rack-locale-root-redirect)
-[![Coverage Status](https://coveralls.io/repos/mirego/rack-locale-root-redirect/badge.png)](https://coveralls.io/r/mirego/rack-locale-root-redirect)
 [![Ruby Gem](https://badge.fury.io/rb/rack-locale-root-redirect.png)](https://rubygems.org/gems/microscope)
 
 `Rack::LocaleRootRedirect` redirects requests to `"/"` based on the `Accept-Language` HTTP header.
@@ -22,48 +21,50 @@ $ bundle
 
 ## Usage
 
-With Sinatra:
+Add the `rack-locale-root-redirect` gem in your `Gemfile`.
 
 ```ruby
-# Gemfile
-gem 'sinatra'
 gem 'rack-locale-root-redirect'
+```
+
+### With Ruby on Rails
+
+Add these lines in your `config/application.rb` file, along other configuration instructions.
 
-# config.ru
-require 'bundler'
-Bundler.require
+```ruby
+config.use Rack::Accept
+config.use Rack::LocaleRootRedirect, fr: '/fr', en: '/en'
+```
 
-class MyApp < Sinatra::Base
-  use Rack::Accept
-  use Rack::LocaleRootRedirect, fr: "/fr", en: "/en"
+### With Sinatra
 
-  get('/fr') { 'Français!' }
-  get('/en') { 'English!' }
-end
+Add these lines in your `config.ru` file, or wherever your Sinatra application is located.
 
-run MyApp
+```ruby
+use Rack::Accept
+use Rack::LocaleRootRedirect, fr: '/fr', en: '/en'
 ```
 
-Then, test it:
+### The result
 
 ```shell
 $ rackup &
 
 $ curl -sI "http://0.0.0.0:9292" -H "Accept-Language: fr;q=1, en;q=0.8" | grep "302\|Location"
-HTTP/1.1 302 Moved Permanently
+HTTP/1.1 302 Found
 Location: /fr
 
 $ curl -sI "http://0.0.0.0:9292" -H "Accept-Language: fr;q=0.4, en;q=0.8" | grep "302\|Location"
-HTTP/1.1 302 Moved Permanently
+HTTP/1.1 302 Found
 Location: /en
 ```
 
 ## License
 
-`Rack::LocaleRootRedirect` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/rack-locale-root-redirect/blob/master/LICENSE.md) file.
+`Rack::LocaleRootRedirect` is © 2013-2015 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/rack-locale-root-redirect/blob/master/LICENSE.md) file.
 
 ## About Mirego
 
-Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly build mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development") in beautiful Quebec City.
+[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
 
-We also love [open-source software](http://open.mirego.com/) and we try to extract as much code as possible from our projects to give back to the community.
+We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.

data/lib/rack/locale_root_redirect/middleware.rb

@@ -1,24 +1,29 @@
-require 'rack/accept'
-
 module Rack
   class LocaleRootRedirect
+    STATUS = 302
+    REGEX = %r[\A/(?<query_string>\?.*|\Z)]
+    RACK_ACCEPT_MISSING = 'Rack::LocaleRootRedirect must be used after Rack::Accept. Please make your application use Rack::Accept before Rack::LocaleRootRedirect.'
+
+    # @private
     def initialize(app, locales = {})
       @locales = locales
       @available_locales = locales.keys.map(&:to_s)
       @default_locale = @available_locales.first
+
       @app = app
     end
 
+    # @private
     def call(env)
       status, headers, response = @app.call(env)
 
       if root_request?(env)
-        language_matcher = env['rack-accept.request'].language.tap { |m| m.first_level_match = true }
-        redirect_lang = language_matcher.best_of(@available_locales) || @default_locale
+        locale = best_locale(env)
 
-        status = 302
+        status = STATUS
         query_string = env['QUERY_STRING'] == '' ? '' : "?#{env['QUERY_STRING']}"
-        headers['Location'] = @locales[redirect_lang.to_sym] + query_string
+        headers['Vary'] = 'Accept-Language'
+        headers['Location'] = @locales[locale.to_sym] + query_string
       end
 
       [status, headers, response]
@@ -26,8 +31,22 @@ module Rack
 
   protected
 
+    # Return whether we must act on this request
     def root_request?(env)
-      %r[\A/(?<query_string>\?.*|\Z)].match(env['PATH_INFO'])
+      REGEX.match(env['PATH_INFO'])
+    end
+
+    # Return the best locale to redirect to based on the request enviroment
+    def best_locale(env)
+      if accept = env['rack-accept.request']
+        matcher = accept.language.tap do |matcher|
+          matcher.first_level_match = true
+        end
+
+        matcher.best_of(@available_locales) || @default_locale
+      else
+        raise StandardError.new(RACK_ACCEPT_MISSING)
+      end
     end
   end
 end

data/lib/rack/locale_root_redirect/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class LocaleRootRedirect
-    VERSION = '0.3'
+    VERSION = '0.3.1'
   end
 end

data/rack-locale-root-redirect.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'rack-accept', '>= 0.4.5'
 
-  gem.add_development_dependency 'rspec', '~> 2.14'
-  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'rspec', '~> 3.1'
   gem.add_development_dependency 'rake'
 end

data/spec/rack/locale_root_redirect_spec.rb

@@ -2,26 +2,41 @@ require 'spec_helper'
 
 describe Rack::LocaleRootRedirect do
   let(:app) { proc{[200,{},['Hello, world.']]} }
-  let(:stack) { Rack::LocaleRootRedirect.new(Rack::Accept.new(app), locales) }
   let(:request) { Rack::MockRequest.new(stack) }
 
-  describe 'response' do
-    let(:locales) { { fr: '/fr', en: '/en' } }
-    let(:response) { request.get('/?foo=bar', 'HTTP_ACCEPT_LANGUAGE' => accept_language.join(',')) }
+  context 'with stack using Rack::Accept' do
+    let(:stack) { Rack::LocaleRootRedirect.new(Rack::Accept.new(app), locales) }
 
-    context 'with first matching language' do
-      let(:accept_language) { %w{en es;q=0.9} }
-      it { expect(response.headers['Location']).to eq '/en?foo=bar' }
-    end
+    describe 'response' do
+      let(:locales) { { fr: '/fr', en: '/en' } }
+      let(:response) { request.get('/?foo=bar', 'HTTP_ACCEPT_LANGUAGE' => accept_language.join(',')) }
+
+      context 'with first matching language' do
+        let(:accept_language) { %w{en es;q=0.9} }
+        it { expect(response.headers['Location']).to eq '/en?foo=bar' }
+        it { expect(response.headers['Vary']).to eq 'Accept-Language'}
+      end
+
+      context 'with second matching language' do
+        let(:accept_language) { %w{es en;q=0.8} }
+        it { expect(response.headers['Location']).to eq '/en?foo=bar' }
+        it { expect(response.headers['Vary']).to eq 'Accept-Language'}
+      end
 
-    context 'with second matching language' do
-      let(:accept_language) { %w{es en;q=0.8} }
-      it { expect(response.headers['Location']).to eq '/en?foo=bar' }
+      context 'with default matching language' do
+        let(:accept_language) { %w{es jp;q=0.8} }
+        it { expect(response.headers['Location']).to eq '/fr?foo=bar' }
+        it { expect(response.headers['Vary']).to eq 'Accept-Language'}
+      end
     end
+  end
+
+  context 'with stack without Rack::Accept' do
+    let(:locales) { { fr: '/fr', en: '/en' } }
+    let(:stack) { Rack::LocaleRootRedirect.new(app, locales) }
 
-    context 'with default matching language' do
-      let(:accept_language) { %w{es jp;q=0.8} }
-      it { expect(response.headers['Location']).to eq '/fr?foo=bar' }
+    specify do
+      expect { request.get('/') }.to raise_error(StandardError, Rack::LocaleRootRedirect::RACK_ACCEPT_MISSING)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,20 @@
 $:.unshift File.expand_path('../lib', __FILE__)
 
-require 'coveralls'
-Coveralls.wear!
-
+# We test using RSpec
 require 'rspec'
+
+# We need Rack::MockRequest
+require 'rack/mock'
+
+# Rack::LocaleRootRedirect requires Rack::Accept
+require 'rack/accept'
+
+# We need Rack::LocaleRootRedirect
 require 'rack-locale-root-redirect'
 
 RSpec.configure do |config|
+  # Disable `should` syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 end

metadata

@@ -1,69 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rack-locale-root-redirect
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-accept
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
-- !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'
+        version: '3.1'
 - !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'
 description: Rack::LocaleRootRedirect uses Rack:Accept to map '/' to a path based
@@ -74,9 +60,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -97,17 +83,17 @@ 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.1.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rack::LocaleRootRedirect uses Rack:Accept to map '/' to a path based on the