grape-roar 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d20b4c91d2e6c8ddf666534169e08e979d1f0b4
-  data.tar.gz: 80f25794c1901dc9dcbeb5d137dfef37ab634121
+  metadata.gz: f093829bf015a0d7e28dfde89dd892ef75f476ad
+  data.tar.gz: 510c6d4ca8038ca89c9ffceb08ab4e4f331fdbea
 SHA512:
-  metadata.gz: 268ee883eafd778ae6fdaf2a68392426f152532d8354e75e5620c33b869f115a4a4fe5382ad222b70720e95eedf05e612fdebdb12d23542af8942685a393acbf
-  data.tar.gz: f9c92f7d2a629d6d23937ac1b7017530d467e74bf53be5ab2651b6d3c7991d59fb5c31be6204f95d04b3df4057a65e4f7cd8f3b54d427cb90c9b0375c3af6c88
+  metadata.gz: 96fc420d047ff343877c733b2cba4c5a3e5dbec12dd10a4aaa8848145cf60313209cab853e60210783d6c58fc67cfd94d702f6d0e11a349b6d115e75ef2bc557
+  data.tar.gz: aa92afe084b80dc6b09677b073a233c04d69ee65b7a0f17b699ffb92da87be20c8a103334fad6a2132ebfd0184deed23d60a4df01b1029eb00769bee6bf0ff3a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.3.0 (12/31/2014)
+------------------
+
+* Added support for Roar 1.0 - [@dblock](https://github.com/dblock).
+
 0.2.0 (12/18/2014)
 ------------------
 

data/Gemfile

@@ -7,10 +7,11 @@ group :development do
 end
 
 group :test do
-  gem 'rspec', '~> 3.0'
+  gem 'rspec', '~> 3.1'
   gem 'rack-test'
 end
 
 group :development, :test do
   gem 'rubocop', '0.28.0'
+  gem 'nokogiri', '1.6.3.1'
 end

data/README.md

@@ -1,9 +1,12 @@
 Grape::Roar
 ------------
 
-Use [Roar](https://github.com/apotonick/roar) with [Grape](https://github.com/intridea/grape).
+[![Gem Version](http://img.shields.io/gem/v/grape-roar.svg)](http://badge.fury.io/rb/grape-roar)
+[![Build Status](http://img.shields.io/travis/dblock/grape-roar.svg)](https://travis-ci.org/dblock/grape-roar)
+[![Dependency Status](https://gemnasium.com/dblock/grape-roar.svg)](https://gemnasium.com/dblock/grape-roar)
+[![Code Climate](https://codeclimate.com/github/dblock/grape-roar.svg)](https://codeclimate.com/github/dblock/grape-roar)
 
-[![Build Status](https://secure.travis-ci.org/dblock/grape-roar.png)](http://travis-ci.org/dblock/grape-roar)
+Use [Roar](https://github.com/apotonick/roar) with [Grape](https://github.com/intridea/grape).
 
 Demo
 ----
@@ -21,6 +24,8 @@ gem 'roar'
 gem 'grape-roar'
 ```
 
+If you're upgrading from an older version of this gem, please see [UPGRADING](UPGRADING.md).
+
 Usage
 -----
 
@@ -35,12 +40,12 @@ end
 
 ### Use Grape's Present
 
-You can use Grape's `present` keyword after including Grape::Roar::Representer into a representer module.
+Include Grape::Roar::Representer into a representer module *after* any Roar mixins, then use Grape's `present` keyword.
 
 ```ruby
 module ProductRepresenter
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
   include Grape::Roar::Representer
 
   property :title
@@ -58,8 +63,8 @@ Presenting collections works the same way. The following example returns an embe
 
 ```ruby
 module ProductsRepresenter
-  include Roar::Representer::JSON::HAL
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON::HAL
+  include Roar::Hypermedia
   include Grape::Roar::Representer
 
   collection :entries, extend: ProductPresenter, as: :products, embedded: true
@@ -78,8 +83,8 @@ The formatter invokes `to_json` on presented objects and provides access to the
 
 ```ruby
 module ProductRepresenter
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
   include Grape::Roar::Representer
 
   link :self do |opts|
@@ -95,8 +100,8 @@ 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
+  include Roar::JSON
+  include Roar::Hypermedia
 
   link :self do |opts|
     "#{request(opts).url}/#{represented.id}"

data/UPGRADING.md

@@ -0,0 +1,11 @@
+Upgrading Grape-Roar
+====================
+
+### Upgrading to >= 0.3.0
+
+This version requires Roar 1.0 or newer.
+
+* Make presenter changes according to the [roar changelog](https://github.com/apotonick/roar/blob/master/CHANGES.markdown), specifically replace `Roar::Representer::Feature::Hypermedia` with `Roar::Hypermedia` and `Roar::Representer::JSON` with `Roar::JSON` and adjust any `require` paths.
+* Ensure that `Grape::Roar::Representer` is included *after* any `Roar::JSON` or `Roar::Hypermedia` mixins. You would otherwise get a `TypeError: class or module required` from within `Roar::Representable`.
+
+

data/grape-roar.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |gem|
   gem.version       = Grape::Roar::VERSION
 
   gem.add_dependency 'grape'
-  gem.add_dependency 'roar'
+  gem.add_dependency 'roar', '>= 1.0'
 end

data/lib/grape/roar/version.rb

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

data/spec/spec_helper.rb

@@ -7,8 +7,8 @@ Bundler.setup :default, :test
 require 'grape'
 
 require 'roar'
-require 'roar/representer/json'
-require 'roar/representer/feature/hypermedia'
+require 'roar/json'
+require 'roar/hypermedia'
 
 require 'grape/roar'
 require 'rack/test'

data/spec/support/article.rb

@@ -1,7 +1,7 @@
 require 'support/article_representer'
 
 class Article
-  include Roar::Representer::JSON
+  include Roar::JSON
   include ArticleRepresenter
 
   attr_accessor :title, :id

data/spec/support/article_representer.rb

@@ -1,6 +1,6 @@
 module ArticleRepresenter
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
 
   property :title
   property :id

data/spec/support/order.rb

@@ -1,7 +1,7 @@
 require 'support/order_representer'
 
 class Order
-  include Roar::Representer::JSON
+  include Roar::JSON
   include OrderRepresenter
 
   attr_accessor :id, :client_id, :articles

data/spec/support/order_representer.rb

@@ -1,8 +1,8 @@
 require 'support/article'
 
 module OrderRepresenter
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
 
   property :id
   property :client_id

data/spec/support/product_representer.rb

@@ -1,8 +1,8 @@
-require 'roar/representer/json/hal'
+require 'roar/json/hal'
 
 module ProductRepresenter
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
   include Grape::Roar::Representer
 
   property :title

data/spec/support/user_representer.rb

@@ -1,6 +1,6 @@
 class UserRepresenter < Grape::Roar::Decorator
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
 
   property :name
   property :id

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: grape-roar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: roar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: Use Roar with Grape
 email:
 - dblock@dblock.org
@@ -45,17 +45,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .rubocop_todo.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADING.md
 - grape-roar.gemspec
 - lib/grape-roar.rb
 - lib/grape/roar.rb
@@ -85,17 +86,17 @@ 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.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Enable Resource-Oriented Architectures in Grape API DSL