Adds #present to Endpoints to make entity usage dead simple.

Author: Michael Bleigh

Gemfile

@@ -1,3 +1,12 @@
 source 'http://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

Gemfile.lock

@@ -2,62 +2,74 @@ PATH
   remote: .
   specs:
     grape (0.1.5)
-      hashie (~> 1.0)
+      hashie (~> 1.2)
       multi_json
       multi_xml
       rack
-      rack-jsonp
       rack-mount
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    guard (0.6.2)
+    coderay (1.0.0)
+    diff-lcs (1.1.3)
+    growl (1.0.3)
+    guard (0.8.8)
       thor (~> 0.14.6)
     guard-bundler (0.1.3)
       bundler (>= 1.0.0)
       guard (>= 0.2.2)
-    guard-rspec (0.4.2)
-      guard (>= 0.4.0)
-    hashie (1.1.0)
-    json_pure (1.5.2)
+    guard-rspec (0.5.1)
+      guard (>= 0.8.4)
+    hashie (1.2.0)
     maruku (0.6.0)
       syntax (>= 1.0.0)
+    method_source (0.6.5)
+      ruby_parser (>= 2.0.5)
     multi_json (1.0.3)
-    multi_xml (0.3.0)
-    rack (1.3.0)
-    rack-jsonp (1.2.0)
-      rack
+    multi_xml (0.4.1)
+    pry (0.9.6)
+      coderay (>= 0.9.8)
+      method_source (>= 0.6.5)
+      ruby_parser (>= 2.0.5)
+      slop (~> 2.1.0)
+    rack (1.3.5)
     rack-mount (0.8.3)
       rack (>= 1.0.0)
-    rack-test (0.6.0)
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rake (0.9.2.2)
+    rb-fsevent (0.4.3.1)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
+    rspec-mocks (2.7.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.7)
+    slop (2.1.0)
     syntax (1.0.0)
     thor (0.14.6)
-    yard (0.7.1)
+    yard (0.7.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
   grape!
+  growl
   guard
   guard-bundler
   guard-rspec
-  json_pure
   maruku
+  pry
   rack-test
   rake
-  rspec (~> 2.6.0)
+  rb-fsevent
+  rspec (~> 2.7.0)
   yard

grape.gemspec

@@ -15,21 +15,17 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'rack'
   s.add_runtime_dependency 'rack-mount'
-  s.add_runtime_dependency 'rack-jsonp'
+  # s.add_runtime_dependency 'rack-jsonp'
   s.add_runtime_dependency 'multi_json'
   s.add_runtime_dependency 'multi_xml'
-  s.add_runtime_dependency 'hashie', '~> 1.0'
+  s.add_runtime_dependency 'hashie', '~> 1.2'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'maruku'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
-  s.add_development_dependency 'json_pure'
+  s.add_development_dependency 'rspec', '~> 2.7.0'
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'guard'
-  s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'guard-bundler'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

lib/grape.rb

@@ -8,14 +8,14 @@ module Grape
   autoload :Client,          'grape/client'
   autoload :Route,           'grape/route'
   autoload :Entity,          'grape/entity'
-  
+
   module Middleware
     autoload :Base,      'grape/middleware/base'
     autoload :Prefixer,  'grape/middleware/prefixer'
     autoload :Versioner, 'grape/middleware/versioner'
     autoload :Formatter, 'grape/middleware/formatter'
     autoload :Error,     'grape/middleware/error'
-    
+
     module Auth
       autoload :OAuth2, 'grape/middleware/auth/oauth2'
       autoload :Basic,  'grape/middleware/auth/basic'

lib/grape/endpoint.rb

@@ -90,6 +90,33 @@ def body(value = nil)
       end
     end
 
+    # Allows you to make use of Grape Entities by setting
+    # the response body to the serializable hash of the
+    # entity provided in the `:with` option. This has the
+    # added benefit of automatically passing along environment
+    # and version information to the serialization, making it
+    # very easy to do conditional exposures. See Entity docs
+    # for more info.
+    #
+    # @example
+    #
+    #   get '/users/:id' do
+    #     present User.find(params[:id]),
+    #       :with => API::Entities::User,
+    #       :admin => current_user.admin?
+    #   end
+    def present(object, options = {})
+      entity_class = options.delete(:with)
+
+      if entity_class
+        embeds = {:env => env}
+        embeds[:version] = env['api.version'] if env['api.version']
+        body entity_class.represent(object, embeds.merge(options))
+      else
+        body object
+      end
+    end
+
     def call(env)
       @env = env
       @header = {}

spec/grape/endpoint_spec.rb

@@ -120,6 +120,35 @@ def memoized
     last_response.body.should == 'yo'
   end
 
+  describe '#present' do
+    it 'should just set the object as the body if no options are provided' do
+      subject.get '/example' do
+        present({:abc => 'def'})
+        body.should == {:abc => 'def'}
+      end
+      get '/example'
+    end
+
+    it 'should call through to the provided entity class if one is given' do
+      subject.get '/example' do
+        entity_mock = Object.new
+        entity_mock.should_receive(:represent)
+        present Object.new, :with => entity_mock
+      end
+      get '/example'
+    end
+
+    it 'should embed version and env when calling through to an entity' do
+      subject.version 'v2'
+      subject.get '/example' do
+        entity_mock = Object.new
+        entity_mock.should_receive(:represent).with(:version => 'v2', :env => env)
+        present Object.new, :with => entity_mock
+      end
+      get '/example'
+    end
+  end
+
   context 'filters' do
     describe 'before filters' do
       it 'should run the before filter if set' do

spec/spec_helper.rb

@@ -7,7 +7,6 @@
 require 'bundler'
 Bundler.setup :default, :test
 
-require 'rspec'
 require 'rack/test'
 
 require 'base64'