restfulness 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fec45922d74ec00c62042cfa323627cb5e23d925
-  data.tar.gz: 87679a0dd96e313a113f24e85e35c4130285cb01
+  metadata.gz: cfa898034332002c6aca448027bc52cf29abfbd7
+  data.tar.gz: 17961f1c4475131c07321a775575b7c32f66360a
 SHA512:
-  metadata.gz: a818c4417a58a9a84fe108b5a0c0a57e02f6342ccd47810e571e6d2f6d49ec0c736a111a1ac9b82ec1a67eeecc644908af1fbb869cf0f67f4a31335112e44fb6
-  data.tar.gz: 568d63dc34ffa86bd6e8f59c5d278ac54426ad7b95648c79252fd1475c93c80cd17611245f8d2e7d926dda22bdc5fc9bad929249cc4cef5aa2e62a9842a35057
+  metadata.gz: 493a6d814a922764739e3698bea3a8bf16573bb207f940b0f240f7e70a27c50a9607cc2a3e5d7ad2053ddad95593109fd8370e591e07669cbbd0f6ec23d6185c
+  data.tar.gz: a62d90e70f22d2db78e0df083ecaf77c8fa769b6c2372874ad0b88b544cd963a95d8d5ac35d6d064f2aac6d6c56afcba6a7ce1969f20f27b493394c4723ae109

data/README.md

@@ -255,6 +255,30 @@ class ProjectResource < Restfulness::Resource
 end
 ```
 
+#### I18n in Resources
+
+Restfulness uses the [http_accept_language](https://github.com/iain/http_accept_language) gem to automatically handle the `Accept-Language` header coming in from a client. After trying to make a match between the available locales, it will automatically set the `I18n.locale`. You can access the http_accept_language parser via the `request.http_accept_language` method.
+
+For most APIs this should work great, especially for mobile applications where this header is automatically set by the phone. There may however be situations where you need a bit more control. If a user has a preferred language setting for example.
+
+Resources contain two protected methods that can be overwritten if you need more precise control. This is what they look like in the Restfulness code:
+
+```ruby
+protected
+
+def locale
+  request.http_accept_language.compatible_language_from(I18n.available_locales)
+end
+
+def set_locale
+  I18n.locale = locale
+end
+``` 
+
+The `Resource#set_locale` method is called before any of the other callbacks are handled. This is important as it allows the locale to be set before returning any translatable error messages.
+
+Most users will probably just want to override the `Resource#locale` method and provide the appropriate locale for the request. If you are using a User object or similar, double check your authentication process as the default `authorized?` method will be called *after* the locale is prepared.
+
 
 ### Requests
 
@@ -565,7 +589,11 @@ Restfulness is still a work in progress but at Cabify we are using it in product
 
 ## History
 
-### 0.2.3 - pending
+### 0.2.4 - February 7, 2014
+
+ * Added I18n support with the help of the http_accept_language gem. (@samlown)
+
+### 0.2.3 - February 6, 2014
 
  * Fixing issue where query parameters are set as Hash instead of HashWithIndifferentAccess.
  * Rewinding the body, incase rails got there first.

data/lib/restfulness/request.rb

@@ -73,6 +73,11 @@ module Restfulness
       @sanitized_params ||= @params ? Sanitizer.sanitize_hash(@params) : nil
     end
 
+    # Provide a wrapper for the http_accept_language parser
+    def http_accept_language
+      @http_accept_language = HttpAcceptLanguage::Parser.new(headers[:accept_language])
+    end
+
     [:get, :post, :put, :patch, :delete, :head, :options].each do |m|
       define_method("#{m}?") do
         action == m

data/lib/restfulness/resource.rb

@@ -51,6 +51,9 @@ module Restfulness
     end
 
     def check_callbacks
+      # Locale Handling
+      set_locale
+
       # Access control
       method_not_allowed! unless method_allowed?
       unauthorized!       unless authorized?
@@ -70,6 +73,14 @@ module Restfulness
 
     protected
 
+    def locale
+      request.http_accept_language.compatible_language_from(I18n.available_locales)
+    end
+
+    def set_locale
+      I18n.locale = locale
+    end
+
     def logger
       Restfulness.logger
     end

data/lib/restfulness/version.rb

@@ -1,3 +1,3 @@
 module Restfulness
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/restfulness.rb

@@ -9,6 +9,8 @@ require 'rack/commonlogger'
 require 'rack/showexceptions'
 require 'rack/builder'
 
+require 'http_accept_language/parser'
+
 require "restfulness/resources/events"
 
 require "restfulness/application"

data/restfulness.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack", "~> 1.4"
   spec.add_dependency "multi_json", "~> 1.8"
   spec.add_dependency "activesupport", ">= 3.1"
+  spec.add_dependency "http_accept_language", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ require 'restfulness' # and any other gems you need
 
 RSpec.configure do |config|
   config.color_enabled = true
+
+  # Avoid deprication messages with this:
+  I18n.config.enforce_available_locales = false
 end
 
 # Disable any logger output

data/spec/unit/request_spec.rb

@@ -169,6 +169,17 @@ describe Restfulness::Request do
     end
   end
 
+  describe "#http_accept_language" do
+    it "should provide an instance of Parser" do
+      obj.http_accept_language.should be_a(HttpAcceptLanguage::Parser)
+    end
+    it "should use the accept_language header" do
+      header = "en-us,en-gb;q=0.8,en"
+      obj.headers[:accept_language] = header
+      obj.http_accept_language.header.should eql(header)
+    end
+  end
+
   describe "method helpers" do
     it "should respond to method questions" do
       [:get?, :post?, :put?, :delete?, :head?, :options?].each do |q|

data/spec/unit/resource_spec.rb

@@ -121,7 +121,7 @@ describe Restfulness::Resource do
 
     let :obj do
       request.action = :get
-      obj = resource.new(request, response)
+      resource.new(request, response)
     end
 
     it "should all be good by default" do
@@ -130,6 +130,11 @@ describe Restfulness::Resource do
       }.to_not raise_error
     end
 
+    it "should try to set the locale" do
+      obj.should_receive(:set_locale)
+      obj.check_callbacks
+    end
+
     it "should raise error on invalid method" do
       obj.stub(:method_allowed?).and_return(false)
       expect {
@@ -227,4 +232,38 @@ describe Restfulness::Resource do
     end
   end
 
+  describe "Locale handling" do
+
+    let :resource do
+      Class.new(GetPostResource) do
+        def head; nil; end
+        def put; nil; end
+        def delete; nil; end
+      end
+    end
+
+    let :obj do
+      request.headers[:accept_language] = "nl, es, en"
+      request.action = :get
+      resource.new(request, response)
+    end
+
+    describe "#locale" do
+      it "should return acceptable locale" do
+        I18n.available_locales = ['es']
+        obj.send(:locale).should eql(:es)
+      end
+    end
+
+    describe "#set_locale" do
+      it "should set the global locale value" do
+        I18n.available_locales = ['en', 'es']
+        I18n.locale.should_not eql(:es)
+        obj.send(:set_locale)
+        I18n.locale.should eql(:es)
+      end
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: http_accept_language
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement