grape-active_model_serializers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58bcfddca3256fcdbb1af668f25f340bc2000ab8
+  data.tar.gz: 75b2aa6e107a1402d825bc4c4afddce3bde93570
+SHA512:
+  metadata.gz: 84615c11bc2426db13caa2e541bec83eebfc8939c5d3c479d351bd3916d67d58ff6507b31ae9f23796d2998cf5ef8485253e2bde677304c8478d5f1de487f4fd
+  data.tar.gz: fd6273206d0fb5fd80ccf9a26580aa211d2a70dd1a172461136c346fc7ff3a49d1adb116a1709cd2537bc8825874d3eb72d9a3b525525a0a93ab363d88c95e17

data/.gitignore

@@ -0,0 +1,18 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+Gemfile.lock
+.DS_Store

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'jazz_hands', git: 'https://github.com/jrhe/jazz_hands.git', branch: 'without_rails' 
+end

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonathan Evans
+
+MIT License
+
+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,141 @@
+# Grape::ActiveModelSerializers
+
+Use [active_model_serializers](https://github.com/rails-api/active_model_serializers) with [Grape](https://github.com/intridea/grape)!
+
+[![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)
+
+## Installation
+
+Add the `grape` and `grape-active_model_serializers` gems to Gemfile.
+
+```ruby
+gem 'grape'
+gem 'grape-active_model_serializers'
+```
+
+And then execute:
+
+    bundle
+
+## Usage
+
+### Require grape-active_model_serializers
+
+```ruby
+# config.ru
+require 'grape/active_model_serializers'
+```
+
+
+### Tell your API to use Grape::Formatter::ActiveModelSerializers
+
+```ruby
+class API < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::ActiveModelSerializers
+end
+```
+
+
+### Writing serializers
+
+See [active_model_serializers](https://github.com/rails-api/active_model_serializers)
+
+
+### Serializers are inferred by active_record model names
+
+`grape-active_model_serializers` will search for serializers for the objects returned by your grape API.
+
+```ruby
+namespace :users do
+  get ":id" do
+    @user = User.find(params[:id])
+  end
+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')
+
+```ruby
+namespace :users do
+  get ":id" do
+    @user = User.find(params[:id])
+  end
+end
+# root = users
+```
+
+```ruby
+get "people" do
+  @user = User.all
+end
+# root = people
+```
+
+### Manually specifying serializer options
+
+```ruby
+# Serializer options can be specified on routes or namespaces.
+namespace 'foo', :serializer => :bar do
+  get "/" do
+    # will use "bar" serializer
+  end
+
+  # Options specified on a route or namespace override those of the containing namespace.
+  get "/home", :serializer => :home do
+    # will use "home" serializer
+  end
+
+  # All standard options for `ActiveModel::Serializers` are supported.
+  get "/fancy_homes", :root => 'world', :each_serializer => :fancy_homes
+  ...
+  end
+end
+```
+
+
+### Full Example
+
+```ruby
+class User < ActiveRecord::Base
+  attr_accessor :first_name, :last_name, :password, :email
+end
+
+class UserSerializer < ActiveModel::Serializer
+  attributes :first_name, :last_name
+end
+
+class API < Grape::API
+  get("/home") do
+    User.new({first_name: 'JR', last_name: 'HE', email: 'contact@jrhe.co.uk'})
+  end
+end
+
+API.new.get "/home" # => '{:user=>{:first_name=>"JR", :last_name=>"HE"}}'
+```
+
+
+## RSpec
+
+See "Writing Tests" in https://github.com/intridea/grape.
+
+Enjoy :)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Thanks to
+The developers and maintainers of:
+[active_model_serializers](https://github.com/rails-api/active_model_serializers)
+[Grape](https://github.com/intridea/grape)!
+
+Structured and based upon [grape-rabl](https://github.com/LTe/grape-rabl).

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['-fd -c']
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/grape-active_model_serializers.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grape-active_model_serializers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jonathan Richard Henry Evans"]
+  gem.email         = ["contact@jrhe.co.uk"]
+  gem.summary       = %q{Use active_model_serializer in grape}
+  gem.description   = %q{Provides a Formatter for the Grape API DSL for emitting objects serialized with active_model_serializer serializers.}
+  gem.homepage      = "https://github.com/jrhe/grape-active_model_serializers"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "grape-active_model_serializers"
+  gem.require_paths = ["lib"]
+  gem.version       = Grape::ActiveModelSerializers::VERSION
+  gem.licenses      = ['MIT']
+
+  gem.add_dependency "grape", "~> 0.3"
+  gem.add_dependency "active_model_serializers", ">= 0.8.1"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "jazz_hands"
+  gem.add_development_dependency 'guard-rspec'
+end

data/lib/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - rbx-19mode
+
+env:
+   - JRUBY_OPTS="--1.9"

data/lib/grape-active_model_serializers.rb

@@ -0,0 +1,5 @@
+require 'active_model_serializers'
+require 'grape'
+require 'grape-active_model_serializers/endpoint_extension'
+require 'grape-active_model_serializers/formatter'
+require 'grape-active_model_serializers/version'

data/lib/grape-active_model_serializers/endpoint_extension.rb

@@ -0,0 +1,26 @@
+#
+# Make the Grape::Endpoint quack like a ActionController
+#
+# This allows us to rely on the ActiveModel::Serializer#build_json method
+# to lookup the approriate serializer.
+#
+module Grape
+  module EndpointExtension
+    attr_accessor :controller_name
+
+    def namespace_options
+      settings[:namespace] ? settings[:namespace].options : {}
+    end
+
+    def route_options
+      options[:route_options]
+    end
+
+    def default_serializer_options; end
+    def serialization_scope; end
+    def _serialization_scope; end
+    def url_options; end
+  end
+
+  Endpoint.send(:include, EndpointExtension)
+end

data/lib/grape-active_model_serializers/formatter.rb

@@ -0,0 +1,44 @@
+module Grape
+  module Formatter
+    module ActiveModelSerializers
+      class << self
+        def call(resource, env)
+          serializer = fetch_serializer(resource, env)
+
+          if serializer
+            serializer.to_json
+          else
+            Grape::Formatter::Json.call resource, env
+          end
+        end
+
+        def fetch_serializer(resource, env)
+          endpoint = env['api.endpoint']
+          options = build_options_from_endpoint(endpoint)
+
+          if resource.respond_to?(:to_ary) && !resource.empty?
+            # ensure we have an root to fallback on
+            endpoint.controller_name = default_root(endpoint)
+          end
+          ::ActiveModel::Serializer.build_json(endpoint, resource, options)
+        end
+
+        def build_options_from_endpoint(endpoint)
+          endpoint.namespace_options.merge(endpoint.route_options)
+        end
+
+        # array root is the innermost namespace name ('space') if there is one,
+        # otherwise the route name (e.g. get 'name')
+        def default_root(endpoint)
+          innermost_scope = endpoint.settings.peek
+
+          if innermost_scope[:namespace]
+            innermost_scope[:namespace].space
+          else
+            endpoint.options[:path][0].split('/')[-1]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape-active_model_serializers/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module ActiveModelSerializers
+    VERSION = '1.0.0'
+  end
+end

data/spec/grape-active_model_serializers/formatter_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'grape-active_model_serializers/formatter'
+
+describe Grape::Formatter::ActiveModelSerializers do
+
+end

data/spec/grape-active_model_serializers_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe 'grape-active_model_serializers' do
+
+end

data/spec/old_grape_ams_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'support/models/user'
+require 'support/models/blog_post'
+require 'support/serializers/user_serializer'
+require 'support/serializers/blog_post_serializer'
+require "grape-active_model_serializers"
+
+describe Grape::ActiveModelSerializers do
+  let(:app) { Class.new(Grape::API) }
+
+  before do
+    app.format :json
+    app.formatter :json, Grape::Formatter::ActiveModelSerializers
+  end
+
+
+  it "should respond with proper content-type" do
+    app.get("/home/users", :serializer => UserSerializer) do
+      User.new
+    end
+    get("/home/users")
+    last_response.headers["Content-Type"].should == "application/json"
+  end
+
+  context 'serializer is set to nil' do
+    before do
+      app.get("/home", serializer: nil) do
+        {user: {first_name: "JR", last_name: "HE"}}
+      end
+    end
+    it 'uses the built in grape serializer' do 
+      get("/home")
+      last_response.body.should == "{\"user\":{\"first_name\":\"JR\",\"last_name\":\"HE\"}}"
+    end
+  end
+
+  context "serializer isn't set" do
+    before do
+      app.get("/home") do
+        User.new({first_name: 'JR', last_name: 'HE', email: 'contact@jrhe.co.uk'})
+      end
+    end
+
+    it 'infers the serializer' do
+      get "/home"
+      last_response.body.should == "{\"user\":{\"first_name\":\"JR\",\"last_name\":\"HE\"}}"
+    end
+  end
+
+  it "serializes arrays of objects" do
+    app.get("/users") do
+      user = User.new({first_name: 'JR', last_name: 'HE', email: 'contact@jrhe.co.uk'})
+      [user, user]
+    end
+
+    get "/users"
+    last_response.body.should == "{\"users\":[{\"first_name\":\"JR\",\"last_name\":\"HE\"},{\"first_name\":\"JR\",\"last_name\":\"HE\"}]}"
+  end
+
+  context "models with compound names" do
+    it "generates the proper 'root' node for individual objects" do
+      app.get("/home") do
+        BlogPost.new({title: 'Grape AM::S Rocks!', body: 'Really, it does.'})
+      end
+
+      get "/home"
+      last_response.body.should == "{\"blog_post\":{\"title\":\"Grape AM::S Rocks!\",\"body\":\"Really, it does.\"}}"
+    end
+
+    it "generates the proper 'root' node for serialized arrays" do
+      app.get("/blog_posts") do
+        blog_post = BlogPost.new({title: 'Grape AM::S Rocks!', body: 'Really, it does.'})
+        [blog_post, blog_post]
+      end
+
+      get "/blog_posts"
+      last_response.body.should == "{\"blog_posts\":[{\"title\":\"Grape AM::S Rocks!\",\"body\":\"Really, it does.\"},{\"title\":\"Grape AM::S Rocks!\",\"body\":\"Really, it does.\"}]}"
+    end
+  end
+
+  it "uses namespace options when provided" do
+    app.namespace :admin, :serializer => UserSerializer do
+      get('/jeff') do
+        User.new(first_name: 'Jeff')
+      end
+    end
+
+    get "/admin/jeff"
+    last_response.body.should == "{\"user\":{\"first_name\":\"Jeff\",\"last_name\":null}}"
+  end
+
+  context 'route is in a namespace' do
+    it 'uses the name of the closest namespace for the root' do
+      app.namespace :admin do
+        get('/jeff') do
+          user = User.new(first_name: 'Jeff')
+          [user, user]
+        end
+      end
+
+      get "/admin/jeff"
+      last_response.body.should == "{\"admin\":[{\"first_name\":\"Jeff\",\"last_name\":null},{\"first_name\":\"Jeff\",\"last_name\":null}]}"
+    end
+  end
+
+  context 'route is not in a namespace' do
+    it 'uses the of the route for the root' do
+      app.get('/people') do
+        user = User.new(first_name: 'Jeff')
+        [user, user]
+      end
+
+      get "/people"
+      last_response.body.should == "{\"people\":[{\"first_name\":\"Jeff\",\"last_name\":null},{\"first_name\":\"Jeff\",\"last_name\":null}]}"
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bundler'
+Bundler.setup :default, :test
+
+require "active_model_serializers"
+require 'active_support/core_ext/hash/conversions'
+require "active_support/json"
+require 'rspec'
+require 'rack/test'
+
+require 'jazz_hands'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/models/blog_post.rb

@@ -0,0 +1,10 @@
+class BlogPost
+  include ActiveModel::SerializerSupport
+  attr_accessor :title, :body
+
+  def initialize(params={})
+    params.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+end

data/spec/support/models/user.rb

@@ -0,0 +1,10 @@
+class User
+  include ActiveModel::SerializerSupport
+  attr_accessor :first_name, :last_name, :password, :email
+
+  def initialize(params={})
+    params.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+end

data/spec/support/serializers/blog_post_serializer.rb

@@ -0,0 +1,3 @@
+class BlogPostSerializer < ActiveModel::Serializer
+  attributes :title, :body
+end

data/spec/support/serializers/user_serializer.rb

@@ -0,0 +1,3 @@
+class UserSerializer < ActiveModel::Serializer
+  attributes :first_name, :last_name
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: grape-active_model_serializers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Richard Henry Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-09 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 for emitting objects serialized
+  with active_model_serializer serializers.
+email:
+- contact@jrhe.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-active_model_serializers.gemspec
+- lib/.rspec
+- lib/.travis.yml
+- lib/grape-active_model_serializers.rb
+- 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
+- spec/spec_helper.rb
+- spec/support/models/blog_post.rb
+- spec/support/models/user.rb
+- spec/support/serializers/blog_post_serializer.rb
+- spec/support/serializers/user_serializer.rb
+homepage: https://github.com/jrhe/grape-active_model_serializers
+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.0.7
+signing_key: 
+specification_version: 4
+summary: Use active_model_serializer in grape
+test_files:
+- spec/grape-active_model_serializers/formatter_spec.rb
+- spec/grape-active_model_serializers_spec.rb
+- spec/old_grape_ams_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/blog_post.rb
+- spec/support/models/user.rb
+- spec/support/serializers/blog_post_serializer.rb
+- spec/support/serializers/user_serializer.rb
+has_rdoc: