grape-active_model_serializers 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fa78a0c1c6fad86746ab556a45be5bd48e19e08
-  data.tar.gz: 4a004397835d3ff02f1c6255d89572ccf6e923a1
+  metadata.gz: 708565b2aa28cddacf0cbd47a4f3f322480c832b
+  data.tar.gz: 82d88038489301fccf2e29da99a07af6c766f852
 SHA512:
-  metadata.gz: 0d504ac5c9ff1dcb9f28a542087391175f1c0f9479ef1c5e2ef534f19010897c7934b596bb4d3409142fe5c8720e0e0d5beca091efa45abe4dbf5783997a4914
-  data.tar.gz: 98b4c57071dff0c11d67e9af307805075f8be88603ae2517f9b603c1d4a33a2b964c74d7f2efa5cbfac8d0f90b5c4daafe2c641348382c4c57fc76313b0b10f9
+  metadata.gz: b17ce1b5d1bbd0462fedafa695f7bc0e5bdd97c776d9f948c43593f96aef3cf26f050604aca07e8a741a02c58830bca1454a45b8609a9a332dcb14f8fe75f010
+  data.tar.gz: 7497abba7aceba227dd9b3c87f1b975d253dda9715c1301533dd2f9d7e610ba8f1dd1e8476ecacdacd4cdfb9e165e72e5f3dc8e6dea76c210f6f47a0bc4e8110

data/README.md

@@ -4,6 +4,10 @@ Use [active_model_serializers](https://github.com/rails-api/active_model_seriali
 
 [![Build Status](https://api.travis-ci.org/jrhe/grape-active_model_serializers.png)](http://travis-ci.org/jrhe/grape-active_model_serializers) [![Dependency Status](https://gemnasium.com/jrhe/grape-active_model_serializers.png)](https://gemnasium.com/jrhe/grape-active_model_serializers) [![Code Climate](https://codeclimate.com/github/jrhe/grape-active_model_serializers.png)](https://codeclimate.com/github/jrhe/grape-active_model_serializers)
 
+## Breaking Changes
+#### v1.0.0
+* *BREAKING* Changes behaviour of root keys when serialising arrays. See [Array roots](https://github.com/jrhe/grape-active_model_serializers#array-roots)
+
 ## Installation
 
 Add the `grape` and `grape-active_model_serializers` gems to Gemfile.
@@ -23,7 +27,7 @@ And then execute:
 
 ```ruby
 # config.ru
-require 'grape/active_model_serializers'
+require 'grape-active_model_serializers'
 ```
 
 
@@ -56,7 +60,7 @@ end
 In this case, as User objects are being returned, grape-active_model_serializers will look for a serializer named UserSerializer.
 
 ### Array roots
-When serializing an array, the array root is set to the innermost namespace name if there is one, otherwise it is set to the route name (e.g. get 'name')
+When serializing an array, the array root is set to the innermost namespace name if there is one, otherwise it is set to the route name (e.g. get 'name').
 
 ```ruby
 namespace :users do
@@ -95,6 +99,37 @@ namespace 'foo', :serializer => :bar do
 end
 ```
 
+### current_user
+
+One of the nice features of ActiveModel::Serializers is that it
+provides access to the authorization context via the `current_user`.
+
+In Grape, you can get the same behavior by defining a `current_user`
+helper method:
+
+```ruby
+  helpers do
+    def current_user
+      @current_user ||= User.where( :access_token => params[:token]).first
+    end
+
+    def authenticate!
+      error!('401 Unauthenticated', 401) unless current_user
+    end
+  end
+```
+
+Then, in your serializer, you could show or hide some elements
+based on the current user's permissions:
+
+```ruby
+class PostSerializer < ActiveModel::Serializer
+...
+  def include_admin_comments?
+    current_user.roles.member? :admin
+  end
+end
+```
 
 ### Full Example
 
@@ -123,6 +158,12 @@ See "Writing Tests" in https://github.com/intridea/grape.
 
 Enjoy :)
 
+## Changelog
+
+#### v1.0.0
+* Released on rubygems.org
+* *BREAKING* Changes behaviour of root keys when serialising arrays. See [Array roots](https://github.com/jrhe/grape-active_model_serializers#array-roots)
+
 
 ## Contributing
 

data/lib/grape-active_model_serializers/endpoint_extension.rb

@@ -16,9 +16,18 @@ module Grape
       options[:route_options]
     end
 
+    def self.included(base)
+      mattr_accessor :_serialization_scope
+      self._serialization_scope = :current_user
+
+      base.class_eval do
+        def serialization_scope
+          send(_serialization_scope) if _serialization_scope && respond_to?(_serialization_scope, true)
+        end
+      end
+    end
+
     def default_serializer_options; end
-    def serialization_scope; end
-    def _serialization_scope; end
     def url_options; end
   end
 

data/lib/grape-active_model_serializers/formatter.rb

@@ -35,7 +35,7 @@ module Grape
           if innermost_scope[:namespace]
             innermost_scope[:namespace].space
           else
-            endpoint.options[:path][0].split('/')[-1]
+            endpoint.options[:path][0].to_s.split('/')[-1]
           end
         end
       end

data/lib/grape-active_model_serializers/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module ActiveModelSerializers
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: grape-active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Richard Henry Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2014-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
 - !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'
 - !ruby/object:Gem::Dependency
   name: rack-test
   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: 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: jazz_hands
   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: guard-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: Provides a Formatter for the Grape API DSL to emit objects serialized
@@ -116,8 +116,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .DS_Store
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -130,7 +129,6 @@ files:
 - lib/grape-active_model_serializers/endpoint_extension.rb
 - lib/grape-active_model_serializers/formatter.rb
 - lib/grape-active_model_serializers/version.rb
-- spec/.DS_Store
 - spec/grape-active_model_serializers/formatter_spec.rb
 - spec/grape-active_model_serializers_spec.rb
 - spec/old_grape_ams_spec.rb
@@ -149,17 +147,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.0.7
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Use active_model_serializer in grape