restpack_serializer 0.4.13 → 0.4.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c65793e190074e46598d0c1840e05fce55fd0c55
-  data.tar.gz: 0d6d15e20c00d2123d3a3ac584f51edd908e9ec5
+  metadata.gz: 8a00410f5da13a4809d6e34a2691b65e7c17489c
+  data.tar.gz: f98e7fff30aefe3a917653a6d6407e22077bee8f
 SHA512:
-  metadata.gz: f1b48f4b0c4cbc764d9de0a495e0ead2125ad07d96ebbd4bb69a18a72298890e167b7bceab57555a5f623d06caab26dc86b292ca5056de745df86bbd1a01a624
-  data.tar.gz: e28f52414ae19524964d353a55fbc24380bfe5afff65d19739363828eb21aa6641e428aa60ae0bef55ac045087ee1cd7c0feeb28a8e9b5a04eca25fe56b21cdf
+  metadata.gz: b1b0bf8aac3022e67127598e102f0890e5d5476419914e03240faa156128ee4acdc3f12604c6cfdee98545e9bd0347447acbe52978a3b23f2f7373f87008b54a
+  data.tar.gz: eee7830a50cc6c9e1808d68c67568d9c1493ae8aa4634a1c6261bf0628f2036ad2d4e8b3f6293ca3db0d8f92ff55a8a3e2d1035184167500f0060755cabf8de8

data/Gemfile

@@ -3,5 +3,3 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-
-gem 'protected_attributes'

data/README.md

@@ -46,6 +46,27 @@ end
 }
 ```
 
+`as_json` accepts an optional `context` hash parameter which can be used be your Serializers to customize their output:
+
+```ruby
+class AlbumSerializer
+  include RestPack::Serializer
+  attributes :id, :title, :year, :artist_id, :extras
+  can_include :artists, :songs
+  can_filter_by :year
+
+  def extras
+    if @context[:admin?]
+      { markup_percent: 95 }
+    end
+  end
+end
+```
+
+```ruby
+AlbumSerializer.as_json(album, { admin?: true })
+```
+
 ## Exposing an API
 
 The `AlbumSerializer` provides `page` and `resource` methods which provide paged collection and singular resource GET endpoints.
@@ -67,12 +88,24 @@ These endpoint will live at URLs such as `/albums` and `/albums/142857`:
 * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json
 * http://restpack-serializer-sample.herokuapp.com/api/v1/albums/4.json
 
-Both `page` and `resource` methods take an optional scope argument allowing us to enforce arbitrary constraints:
+The `AlbumSerializer` also provides a `single` method which will return a serialized resource similar to `as_json` above.
+
+`page`, `resource` and `single` methods take an optional scope argument allowing us to enforce arbitrary constraints:
 
 ```ruby
 AlbumSerializer.page(params, Albums.where("year < 1950"))
 ```
 
+In addition to `scope`, all three methods also accept an optional `context` hash:
+
+```ruby
+AlbumSerializer.page(params, Albums.where("year < 1950"), { admin?: true })
+```
+
+Other features:
+ * [Dynamically Include/Exclude Attributes](https://github.com/RestPack/restpack_serializer/blob/master/spec/serializable/serializer_spec.rb#L42)
+ * [Custom Attributes Hash](https://github.com/RestPack/restpack_serializer/blob/master/spec/serializable/serializer_spec.rb#L46)
+
 ## Paging
 
 Collections are paged by default. `page` and `page_size` parameters are available:

data/lib/restpack_serializer.rb

@@ -1,5 +1,6 @@
 require 'will_paginate'
 require 'will_paginate/active_record'
+require 'protected_attributes'
 
 require 'restpack_serializer/version'
 require 'restpack_serializer/configuration'

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.4.13'
+    VERSION = '0.4.14'
   end
 end

data/restpack_serializer.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'activerecord', '~> 4.0'
-  gem.add_dependency 'activesupport', '~> 4.0'
-  gem.add_dependency 'protected_attributes', '~> 1.0.3'
-  gem.add_dependency 'will_paginate', '~> 3.0'
-  gem.add_dependency 'restpack_gem', '~> 0.0.9'
+  gem.add_dependency 'activerecord', '~> 4.0.3'
+  gem.add_dependency 'activesupport', '~> 4.0.3'
+  # gem.add_dependency 'protected_attributes', '~> 1.0.5'
+  gem.add_dependency 'will_paginate', '~> 3.0.5'
 
+  gem.add_development_dependency 'restpack_gem', '~> 0.0.9'
   gem.add_development_dependency 'rake', '~> 10.0.3'
   gem.add_development_dependency 'rspec', '~> 2.12'
   gem.add_development_dependency 'guard-rspec', '~> 2.5.4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.13
+  version: 0.4.14
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,56 +16,42 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: protected_attributes
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 4.0.3
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.5
 - !ruby/object:Gem::Dependency
   name: restpack_gem
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +59,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.9
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: