Merge pull request #11 from fixate/feature/decorator_support_squashed

Added support for Roar decorators

Author: dblock

CHANGELOG.md

@@ -1,3 +1,8 @@
+Next
+------------------
+
+* [#10](https://github.com/dblock/grape-roar/pull/10): Support for Roar decorator - [@sdbondi](https://github.com/sdbondi).
+
 0.1.0 (18/07/2014)
 ------------------
 

README.md

@@ -89,6 +89,33 @@ module ProductRepresenter
 end
 ```
 
+### Decorators
+
+If you prefer to use a decorator class instead of modules.
+
+```ruby
+class ProductRepresenter < Grape::Roar::Decorator
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  link :self do |opts|
+    "#{request(opts).url}/#{represented.id}"
+  end
+
+  private
+
+  def request(opts)
+    Grape::Request.new(opts[:env])
+  end
+end
+```
+
+```ruby
+get 'products' do
+  present Product.all, with: ProductsRepresenter
+end
+```
+
 Contributing
 ------------
 

lib/grape/roar.rb

@@ -1,3 +1,4 @@
 require 'grape/roar/version'
 require 'grape/roar/formatter'
 require 'grape/roar/representer'
+require 'grape/roar/decorator'

lib/grape/roar/decorator.rb

@@ -0,0 +1,11 @@
+require 'roar/decorator'
+
+module Grape
+  module Roar
+    class Decorator < ::Roar::Decorator
+      def self.represent(object, _options = {})
+        new(object)
+      end
+    end
+  end
+end

spec/decorator_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Grape::Roar::Decorator do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  before do
+    subject.format :json
+    subject.formatter :json, Grape::Formatter::Roar
+  end
+
+  def app
+    subject
+  end
+
+  context 'decorator' do
+    before do
+      subject.get('/user/:id') do
+        present User.new(name: 'Lonestar', id: params[:id]), with: UserRepresenter
+      end
+    end
+
+    it 'returns a hypermedia representation' do
+      get '/user/666'
+      expect(last_response.body).to eq '{"name":"Lonestar","id":"666","links":[{"rel":"self","href":"/user/666"}]}'
+    end
+  end
+end

spec/support/user.rb

@@ -0,0 +1,9 @@
+class User
+  attr_accessor :id, :name
+
+  def initialize(attrs = {})
+    attrs.each_pair do |k, v|
+      send("#{k}=", v)
+    end
+  end
+end

spec/support/user_representer.rb

@@ -0,0 +1,11 @@
+class UserRepresenter < Grape::Roar::Decorator
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :name
+  property :id
+
+  link :self do
+    "/user/#{represented.id}"
+  end
+end