grape-roar 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5827a1b2d9d4d8b3add2a301aa5fae68074c5d22
-  data.tar.gz: a60fedc73b8d76bdbb608e5331448a910476a7b2
+  metadata.gz: 0d20b4c91d2e6c8ddf666534169e08e979d1f0b4
+  data.tar.gz: 80f25794c1901dc9dcbeb5d137dfef37ab634121
 SHA512:
-  metadata.gz: 343baa16ae114e19e69f365f4109a4e1f8a269a03e3cb1623302377d567cea1e020f24cd0d9726c8ee951d535f0872012378c84e37cd9f6e505bd094b081144f
-  data.tar.gz: aa5f1ed03620b635defe792007768d8f7afd8b5b11ff2969b99306db70767091937ffc943b73aa03a8105d96f85c55847e4251cda658a10c79bcaaab1c40cf5a
+  metadata.gz: 268ee883eafd778ae6fdaf2a68392426f152532d8354e75e5620c33b869f115a4a4fe5382ad222b70720e95eedf05e612fdebdb12d23542af8942685a393acbf
+  data.tar.gz: f9c92f7d2a629d6d23937ac1b7017530d467e74bf53be5ab2651b6d3c7991d59fb5c31be6204f95d04b3df4057a65e4f7cd8f3b54d427cb90c9b0375c3af6c88

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 doc
 pkg
+.bundle

data/.rubocop.yml

@@ -3,27 +3,4 @@ AllCops:
     - vendor/**/*
     - bin/**/*
 
-LineLength:
-  Enabled: false
-
-MethodLength:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-Documentation:
-  # don't require classes to be documented
-  Enabled: false
-
-CollectionMethods:
-  # don't prefer map to collect, recuce to inject
-  Enabled: false
-
-Encoding:
-  # no need to always specify encoding
-  Enabled: false
-
-FileName:
-  # allow grape-roar.rb
-  Enabled: false
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-18 10:52:56 -0500 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 304
+
+# Offense count: 13
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,5 @@
+sudo: false
+
 language: ruby
 
 cache: bundler
@@ -8,4 +10,4 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode
-  - rbx-2
+  - rbx-2.2.10

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-0.1.0 (18/07/2014)
+0.2.0 (12/18/2014)
 ------------------
 
+* [#10](https://github.com/dblock/grape-roar/pull/10): Support for Roar decorator - [@sdbondi](https://github.com/sdbondi).
+
+0.1.0 (7/17/2014)
+-----------------
+
 * Initial public release, with support for Grape `present` - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -3,14 +3,14 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "rake"
+  gem 'rake'
 end
 
 group :test do
-  gem "rspec", "~> 3.0"
-  gem "rack-test"
+  gem 'rspec', '~> 3.0'
+  gem 'rack-test'
 end
 
 group :development, :test do
-  gem 'rubocop', '0.24.1'
+  gem 'rubocop', '0.28.0'
 end

data/README.md

@@ -5,6 +5,11 @@ Use [Roar](https://github.com/apotonick/roar) with [Grape](https://github.com/in
 
 [![Build Status](https://secure.travis-ci.org/dblock/grape-roar.png)](http://travis-ci.org/dblock/grape-roar)
 
+Demo
+----
+
+The [grape-with-roar](https://github.com/dblock/grape-with-roar) project deployed [here on heroku](http://grape-with-roar.herokuapp.com).
+
 Installation
 ------------
 
@@ -30,7 +35,7 @@ end
 
 ### Use Grape's Present
 
-You can use Grape's `present` keyword after including Grape::Roar::Presenter into a representer module.
+You can use Grape's `present` keyword after including Grape::Roar::Representer into a representer module.
 
 ```ruby
 module ProductRepresenter
@@ -49,9 +54,27 @@ get 'product/:id' do
 end
 ```
 
-### Accessing the Request Inside a Presenter
+Presenting collections works the same way. The following example returns an embedded set of products in the HAL Hypermedia format.
+
+```ruby
+module ProductsRepresenter
+  include Roar::Representer::JSON::HAL
+  include Roar::Representer::Feature::Hypermedia
+  include Grape::Roar::Representer
+
+  collection :entries, extend: ProductPresenter, as: :products, embedded: true
+end
+```
+
+```ruby
+get 'products' do
+  present Product.all, with: ProductsRepresenter
+end
+```
+
+### Accessing the Request Inside a Representer
 
-The formatter invokes `to_json` on presented objects and provides access to the requesting environment via the `env` option. The following example renders a full request URL in a presenter.
+The formatter invokes `to_json` on presented objects and provides access to the requesting environment via the `env` option. The following example renders a full request URL in a representer.
 
 ```ruby
 module ProductRepresenter
@@ -66,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
 ------------
 
@@ -74,6 +124,6 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 Copyright and License
 ---------------------
 
-MIT License, see [LICENSE](http://github.com/dblock/grape-roar/raw/master/LICENSE) for details.
+MIT License, see [LICENSE](LICENSE) for details.
 
-(c) 2012-2014 [Daniel Doubrovkine](http://github.com/dblock), [Art.sy](http://artsy.github.com)
+(c) 2012-2014 [Daniel Doubrovkine](https://github.com/dblock) & Contributors, [Artsy](https://artsy.net)

data/lib/grape/roar.rb

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

data/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

data/lib/grape/roar/formatter.rb

@@ -3,8 +3,7 @@ module Grape
     module Roar
       class << self
         def call(object, env)
-          return object.to_json(env: env) if object.respond_to?(:to_json)
-          MultiJson.dump(object)
+          object.respond_to?(:to_json) ? object.to_json(env: env) : MultiJson.dump(object)
         end
       end
     end

data/lib/grape/roar/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Roar
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/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

data/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

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-roar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -48,6 +48,7 @@ files:
 - .gitignore
 - .rspec
 - .rubocop.yml
+- .rubocop_todo.yml
 - .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -58,9 +59,11 @@ files:
 - grape-roar.gemspec
 - lib/grape-roar.rb
 - lib/grape/roar.rb
+- lib/grape/roar/decorator.rb
 - lib/grape/roar/formatter.rb
 - lib/grape/roar/representer.rb
 - lib/grape/roar/version.rb
+- spec/decorator_spec.rb
 - spec/nested_representer_spec.rb
 - spec/present_with_spec.rb
 - spec/representer_spec.rb
@@ -71,6 +74,8 @@ files:
 - spec/support/order_representer.rb
 - spec/support/product.rb
 - spec/support/product_representer.rb
+- spec/support/user.rb
+- spec/support/user_representer.rb
 homepage: http://github.com/dblock/grape-roar
 licenses: []
 metadata: {}
@@ -90,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Enable Resource-Oriented Architectures in Grape API DSL