grape-rabl 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-rabl.gemspec
+gemspec
+
+gem "grape", :git => "git://github.com/intridea/grape.git", :branch => "frontier"
+
+group :test do
+  gem "rspec", "~> 2.8.0"
+  gem "rack-test"
+  gem "rake"
+  gem "ruby-debug19"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Piotr Niełacny
+
+MIT License
+
+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,95 @@
+# Grape::Rabl
+
+Use rabl templates in grape!
+
+[![Build Status](http://travis-ci.org/LTe/grape-rabl.png)](http://github.com/LTe/grape-rabl)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-rabl'
+gem 'grape', :git => "git://github.com/intridea/grape.git", :branch => "frontier"
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Require grape-rabl
+```ruby
+# config.ru
+require 'grape-rabl'
+```
+
+### Setup view root directory
+```ruby
+# config.ru
+require 'grape-rabl'
+
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+end
+```
+
+### Create grape application
+
+To *get post put delete options* add **:rabl** options with template name.
+
+```ruby
+get "/path", :rabl => "template_name.rabl" do
+  # stuff
+  @var = "hello"
+end
+
+post "/path", :rabl => "template_name_diff.rabl" do
+  # stuff
+  @user = User.find_user("email@example.com")
+end
+```
+
+**You can use instance variables in templates!**
+
+### Example
+
+```ruby
+# config.ru
+require 'grape-rabl'
+
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+end
+
+class UserAPI < Grape::API
+  # use rabl with 'hello.rabl' template
+  get '/user', :rabl => 'hello.rabl' do
+    @user = User.first
+  end
+
+  # do not use rabl, normal usage
+  get '/user2' do
+    { :some => :hash }
+  end
+end
+```
+
+```ruby
+# hello.rabl
+object @user => :user
+
+attributes :name
+```
+
+Enjoy :)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['-fd -c']
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/grape-rabl.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grape-rabl/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Piotr Niełacny"]
+  gem.email         = ["piotr.nielacny@gmail.com"]
+  gem.description   = %q{Use rabl in grape}
+  gem.summary       = %q{Use rabl in grape}
+  gem.homepage      = ""
+
+  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 -- {test,spec,features}/*`.split("\n")
+  gem.name          = "grape-rabl"
+  gem.require_paths = ["lib"]
+  gem.version       = Grape::Rabl::VERSION
+
+  gem.add_dependency "rabl"
+  gem.add_dependency "tilt"
+  gem.add_dependency "i18n"
+end

data/lib/grape-rabl/formatter.rb

@@ -0,0 +1,42 @@
+require 'tilt'
+Rabl.register!
+
+module Grape
+  module Middleware
+    class Formatter
+      alias :old_after :after
+
+      def after
+        status, headers, bodies = *@app_response
+        current_endpoint = env['api.endpoint']
+
+        rabl(current_endpoint) do |template|
+          engine = ::Tilt.new(File.join(env['api.tilt.root'], template))
+          rendered = engine.render(current_endpoint, {})
+          Rack::Response.new(rendered, status, headers).to_a
+        end
+      end
+
+      def rabl(endpoint)
+        if template = rablable?(endpoint)
+          yield template
+        else
+          old_after
+        end
+      end
+
+      def rablable?(endpoint)
+        if template = endpoint.options[:route_options][:rabl]
+          set_view_root unless env['api.tilt.root']
+          template
+        else
+          false
+        end
+      end
+  
+      def set_view_root
+        raise "Use Rack::Config to set 'api.tilt.root' in config.ru"
+      end
+    end
+  end
+end

data/lib/grape-rabl/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Rabl
+    VERSION = "0.0.1"
+  end
+end

data/lib/grape-rabl.rb

@@ -0,0 +1,4 @@
+require "rabl"
+require "grape"
+require "grape-rabl/version"
+require "grape-rabl/formatter"

data/spec/grape_rabl_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Grape::Rabl do
+  subject { Class.new(Grape::API) }
+  before { subject.default_format :json }
+  def app; subject end
+
+  it 'should work without rabl template' do
+    subject.get("/home") {"Hello World"}
+    get "/home"
+    last_response.body.should == "Hello World"
+  end
+
+  it "should raise error about root directory" do
+    subject.get("/home", :rabl => true){}
+    lambda{ get "/home" }.should raise_error("Use Rack::Config to set 'api.tilt.root' in config.ru")
+  end
+
+  context "titl root is setup"  do
+    before do
+      subject.before { env["api.tilt.root"] = "#{File.dirname(__FILE__)}/views" }
+    end
+
+    it "should not raise error about root directory" do
+      subject.get("/home", :rabl => true){}
+      lambda{ get "/home" }.should_not raise_error("Use Rack::Config to set 'api.tilt.root' in config.ru")
+    end
+
+    it "should render rabl template" do
+      subject.get("/home", :rabl => "user.rabl") do
+        @user = OpenStruct.new(:name => "LTe", :email => "email@example.com")
+        @project = OpenStruct.new(:name => "First")
+      end
+
+      get "/home"
+      last_response.body.should == '{"user":{"name":"LTe","email":"email@example.com","project":{"name":"First"}}}'
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/views/user.rabl

@@ -0,0 +1,6 @@
+object @user => :user
+attributes :name, :email
+
+child @project => :project do
+  attributes :name
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: grape-rabl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Niełacny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabl
+  requirement: &17866020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17866020
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &17863200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17863200
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &17874680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17874680
+description: Use rabl in grape
+email:
+- piotr.nielacny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grape-rabl.gemspec
+- lib/grape-rabl.rb
+- lib/grape-rabl/formatter.rb
+- lib/grape-rabl/version.rb
+- spec/grape_rabl_spec.rb
+- spec/spec_helper.rb
+- spec/views/user.rabl
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Use rabl in grape
+test_files: []
+has_rdoc: