grape-roar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5827a1b2d9d4d8b3add2a301aa5fae68074c5d22
+  data.tar.gz: a60fedc73b8d76bdbb608e5331448a910476a7b2
+SHA512:
+  metadata.gz: 343baa16ae114e19e69f365f4109a4e1f8a269a03e3cb1623302377d567cea1e020f24cd0d9726c8ee951d535f0872012378c84e37cd9f6e505bd094b081144f
+  data.tar.gz: aa5f1ed03620b635defe792007768d8f7afd8b5b11ff2969b99306db70767091937ffc943b73aa03a8105d96f85c55847e4251cda658a10c79bcaaab1c40cf5a

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+doc
+pkg

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  Exclude:
+    - 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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - ruby-head
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 (18/07/2014)
+------------------
+
+* Initial public release, with support for Grape `present` - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+Contributing to Grape-Roar
+==========================
+
+Grape-Roar is work of [many of contributors](https://github.com/dblock/grape-roar/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/dblock/grape-roar/pulls), [propose features and discuss issues](https://github.com/dblock/grape-roar/issues). When in doubt, ask a question in the [Grape Google Group](http://groups.google.com/group/ruby-grape).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/grape-roar) and check out your copy.
+
+```
+git clone https://github.com/contributor/grape-roar.git
+cd grape-roar
+git remote add upstream https://github.com/dblock/grape-roar.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/grape-roar](spec/grape-roar).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/grape-roar and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/grape-roar/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2012 Daniel Doubrovkine, Art.sy Inc.
+
+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,79 @@
+Grape::Roar
+------------
+
+Use [Roar](https://github.com/apotonick/roar) with [Grape](https://github.com/intridea/grape).
+
+[![Build Status](https://secure.travis-ci.org/dblock/grape-roar.png)](http://travis-ci.org/dblock/grape-roar)
+
+Installation
+------------
+
+Add the `grape`, `roar` and `grape-roar` gems to Gemfile.
+
+```ruby
+gem 'grape'
+gem 'roar'
+gem 'grape-roar'
+```
+
+Usage
+-----
+
+### Tell your API to use Grape::Formatter::Roar
+
+```ruby
+class API < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Roar
+end
+```
+
+### Use Grape's Present
+
+You can use Grape's `present` keyword after including Grape::Roar::Presenter into a representer module.
+
+```ruby
+module ProductRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+  include Grape::Roar::Representer
+
+  property :title
+  property :id
+end
+```
+
+```ruby
+get 'product/:id' do
+  present Product.find(params[:id]), with: ProductRepresenter
+end
+```
+
+### Accessing the Request Inside 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 presenter.
+
+```ruby
+module ProductRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+  include Grape::Roar::Representer
+
+  link :self do |opts|
+    request = Grape::Request.new(opts[:env])
+    "#{request.url}"
+  end
+end
+```
+
+Contributing
+------------
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+Copyright and License
+---------------------
+
+MIT License, see [LICENSE](http://github.com/dblock/grape-roar/raw/master/LICENSE) for details.
+
+(c) 2012-2014 [Daniel Doubrovkine](http://github.com/dblock), [Art.sy](http://artsy.github.com)

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup :default, :test, :development
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/grape-roar.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grape/roar/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Daniel Doubrovkine']
+  gem.email         = ['dblock@dblock.org']
+  gem.description   = 'Use Roar with Grape'
+  gem.summary       = 'Enable Resource-Oriented Architectures in Grape API DSL'
+  gem.homepage      = 'http://github.com/dblock/grape-roar'
+
+  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 -- {spec}/*`.split("\n")
+  gem.name          = 'grape-roar'
+  gem.require_paths = ['lib']
+  gem.version       = Grape::Roar::VERSION
+
+  gem.add_dependency 'grape'
+  gem.add_dependency 'roar'
+end

data/lib/grape-roar.rb

@@ -0,0 +1,3 @@
+require 'roar'
+require 'grape'
+require 'grape/roar'

data/lib/grape/roar.rb

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

data/lib/grape/roar/formatter.rb

@@ -0,0 +1,12 @@
+module Grape
+  module Formatter
+    module Roar
+      class << self
+        def call(object, env)
+          return object.to_json(env: env) if object.respond_to?(:to_json)
+          MultiJson.dump(object)
+        end
+      end
+    end
+  end
+end

data/lib/grape/roar/representer.rb

@@ -0,0 +1,16 @@
+module Grape
+  module Roar
+    module Representer
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def represent(object, _options = {})
+          object.extend self
+          object
+        end
+      end
+    end
+  end
+end

data/lib/grape/roar/version.rb

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

data/spec/nested_representer_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Grape::Roar 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 'nested representer' do
+    before do
+      subject.get('/order/:id') do
+        order = Order.new(id: params[:id], client_id: 42)
+        order.articles << Article.new(title: 'One', id: 1)
+        order.articles << Article.new(title: 'Two', id: 2)
+        order
+      end
+    end
+
+    it 'returns a hypermedia representation' do
+      get '/order/666'
+      expect(last_response.body).to eq '{"id":"666","client_id":42,"articles":[{"title":"One","id":1,"links":[{"rel":"self","href":"/article/1"}]},{"title":"Two","id":2,"links":[{"rel":"self","href":"/article/2"}]}],"links":[{"rel":"self","href":"/order/666"},{"rel":"items","href":"/order/666/items"}]}'
+    end
+  end
+end

data/spec/present_with_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Grape::Roar 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 'using present' do
+    before do
+      subject.get('/product/:id') do
+        present Product.new(title: 'Lonestar', id: params[:id]), with: ProductRepresenter
+      end
+    end
+
+    it 'returns a hypermedia representation' do
+      get '/product/666'
+      expect(last_response.body).to eq '{"title":"Lonestar","id":"666","links":[{"rel":"self","href":"http://example.org/product/666"}]}'
+    end
+  end
+end

data/spec/representer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Grape::Roar 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 'representer' do
+    before do
+      subject.get('/article/:id') do
+        Article.new(title: 'Lonestar', id: params[:id])
+      end
+    end
+
+    it 'returns a hypermedia representation' do
+      get '/article/666'
+      expect(last_response.body).to eq '{"title":"Lonestar","id":"666","links":[{"rel":"self","href":"/article/666"}]}'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bundler'
+Bundler.setup :default, :test
+
+require 'grape'
+
+require 'roar'
+require 'roar/representer/json'
+require 'roar/representer/feature/hypermedia'
+
+require 'grape/roar'
+require 'rack/test'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/article.rb

@@ -0,0 +1,14 @@
+require 'support/article_representer'
+
+class Article
+  include Roar::Representer::JSON
+  include ArticleRepresenter
+
+  attr_accessor :title, :id
+
+  def initialize(attrs = {})
+    attrs.each_pair do |k, v|
+      send("#{k}=", v)
+    end
+  end
+end

data/spec/support/article_representer.rb

@@ -0,0 +1,11 @@
+module ArticleRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :title
+  property :id
+
+  link :self do
+    "/article/#{id}"
+  end
+end

data/spec/support/order.rb

@@ -0,0 +1,14 @@
+require 'support/order_representer'
+
+class Order
+  include Roar::Representer::JSON
+  include OrderRepresenter
+
+  attr_accessor :id, :client_id, :articles
+
+  def initialize(attrs = {})
+    { articles: [] }.merge(attrs).each_pair do |k, v|
+      send("#{k}=", v)
+    end
+  end
+end

data/spec/support/order_representer.rb

@@ -0,0 +1,19 @@
+require 'support/article'
+
+module OrderRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :id
+  property :client_id
+
+  collection :articles, class: Article
+
+  link :self do
+    "/order/#{id}"
+  end
+
+  link :items do
+    "/order/#{id}/items"
+  end
+end

data/spec/support/product.rb

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

data/spec/support/product_representer.rb

@@ -0,0 +1,15 @@
+require 'roar/representer/json/hal'
+
+module ProductRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+  include Grape::Roar::Representer
+
+  property :title
+  property :id
+
+  link :self do |opts|
+    request = Grape::Request.new(opts[:env])
+    "#{request.url}"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: grape-roar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Roar with Grape
+email:
+- dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grape-roar.gemspec
+- lib/grape-roar.rb
+- lib/grape/roar.rb
+- lib/grape/roar/formatter.rb
+- lib/grape/roar/representer.rb
+- lib/grape/roar/version.rb
+- spec/nested_representer_spec.rb
+- spec/present_with_spec.rb
+- spec/representer_spec.rb
+- spec/spec_helper.rb
+- spec/support/article.rb
+- spec/support/article_representer.rb
+- spec/support/order.rb
+- spec/support/order_representer.rb
+- spec/support/product.rb
+- spec/support/product_representer.rb
+homepage: http://github.com/dblock/grape-roar
+licenses: []
+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.14
+signing_key: 
+specification_version: 4
+summary: Enable Resource-Oriented Architectures in Grape API DSL
+test_files: []