restaurant 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc774878cfd70d875198554dc08a0c02699de0c
-  data.tar.gz: a9f90a959400a81935d5441a21ddc3770264368a
+  metadata.gz: b3f1d76c4e2e076ae74aab8564275da04ef24a55
+  data.tar.gz: d86e4d33694c9faba170aeec9deb699cb78be05c
 SHA512:
-  metadata.gz: 5b11d73e5068aad446ab0ed0b23191236c0729ea848bdf344ff35c9153d1bb463e6e426a7abc9184d94e9e5cd22600fca8adec9300c7a1de91becf809aa0a765
-  data.tar.gz: ce710ac1bff61b2d2cb876aaa8ee37d69b0c2de32ee7ba41737d3cc276d6ea8101df18bb14a4ce7e3bbe600bbcf8010e66041a2eeb1d3f0b8f61e58855317603
+  metadata.gz: 996b518bb2182fed86fd59e97ec8ae4f01a1d5c8570cc03c2132ee005c27d5a615226ae7ca8d99bb96046bc96151a4c0d4bcd75753b82efac759fa8daaf93fc0
+  data.tar.gz: ac833d067a1e7be9a37c95a1e2632c631394c29b9a2ebbc68214b63713bff71c60c02be4c9e65f883a6da247d2d254911b2377faeaf780a4211f267ea3ab7824

data/README.md

@@ -1,7 +1,10 @@
 # Restaurant
-Restaurant serves your data via auto-defined RESTful API on your rails application.
+Restaurant serves your data via auto-defined RESTful API on your rails application.  
+No longer models, controllers, views, routes, and schemas are needed.
 
 ## Usage
+Here is an example that creates a new rails app with Restaurant to provide RESTful API.
+
 ```
 $ brew install mongodb
 $ mongod --fork
@@ -15,33 +18,110 @@ $ bundle install
 $ rails g mongoid:config
 $ rails c
 
-[1] pry(main)> app.accept = "application/json"
+irb(main):001:0> app.accept = "application/json"
 => "application/json"
-[2] pry(main)> app.post "/recipes", recipe: { title: "created" }
+irb(main):002:0> app.post "/recipes", recipe: { title: "created" }
 => 201
-[3] pry(main)> JSON.parse(app.response.body)
+irb(main):003:0 JSON.parse(app.response.body)
 => {"title"=>"created", "_id"=>"51963fe9f02da4c1f8000001"}
-[4] pry(main)> app.get "/recipes/51963fe9f02da4c1f8000001"
+irb(main):004:0> app.get "/recipes/51963fe9f02da4c1f8000001"
 => 200
-[5] pry(main)> JSON.parse(app.response.body)
+irb(main):005:0> JSON.parse(app.response.body)
 => {"title"=>"created", "_id"=>"51963fe9f02da4c1f8000001"}
-[6] pry(main)> app.put "/recipes/51963fe9f02da4c1f8000001", recipe: { title: "updated" }
+irb(main):006:0> app.put "/recipes/51963fe9f02da4c1f8000001", recipe: { title: "updated" }
 => 204
-[7] pry(main)> app.get "/recipes/51963fe9f02da4c1f8000001"
+irb(main):007:0> app.get "/recipes/51963fe9f02da4c1f8000001"
 => 200
-[8] pry(main)> JSON.parse(app.response.body)
+irb(main):008:0> JSON.parse(app.response.body)
 => {"title"=>"updated", "_id"=>"51963fe9f02da4c1f8000001"}
-[9] pry(main)> app.get "/recipes"
+irb(main):009:0> app.get "/recipes"
 => 200
-[10] pry(main)> JSON.parse(app.response.body)
+irb(main):010:0> JSON.parse(app.response.body)
 => [{"title"=>"updated", "_id"=>"51963fe9f02da4c1f8000001"}]
-[11] pry(main)> app.delete "/recipes/51963fe9f02da4c1f8000001"
+irb(main):011:0> app.delete "/recipes/51963fe9f02da4c1f8000001"
 => 204
-[12] pry(main)> app.get "/recipes"
+irb(main):012:0> app.get "/recipes"
 => 200
-[13] pry(main)> JSON.parse(app.response.body)
+irb(main):013:0> JSON.parse(app.response.body)
 => []
 ```
 
+## Customize
+While Restaurant automagically defines what RESTful API needs, you can do them on your own.
+
+### routes
+```ruby
+# config/routes.rb
+#   1. V1::ResourcesController < ApplicationController are defined if not defined
+#   2. The following routes are defined
+#     GET    /v1/:resources     -> V1::ReosurcesController#index
+#     GET    /v1/:resources/:id -> V1::ResourcesController#show
+#     POST   /v1/:resources     -> V1::ResourcesController#create
+#     PUT    /v1/:resources/:id -> V1::ResourcesController#update
+#     DELETE /v1/:resources/:id -> V1::ResourcesController#destroy
+namespace :v1 do
+  Restaurant::Router.route(self)
+end
+
+# Or customize what you want (e.g. only provides Read API)
+namespace :v2 do
+  scope ":resource" do
+    controller :resources do
+      get "" => :index
+      get ":id" => :show
+    end
+  end
+end
+```
+
+### controller
+```ruby
+# Restaurant::Actions provides index, show, create, update, and destroy actions by default.
+# Of course you can override them as you like.
+module V1
+  class ResourcesController < ApplicationController
+    include Restaurant::Actions
+    respond_to :xml # you can respond to xml requests
+
+    def index
+      respond_with { foo: "bar" }
+    end
+  end
+end
+```
+
+### authentication & authorization
+Restaurant does not provide any auth layer, but it's easy to add it to your application.  
+Here is a short example to authenticate users with [doorkeeper](https://github.com/applicake/doorkeeper).
+
+```
+$ echo 'gem "doorkeeper"' >> Gemfile
+$ bundle install
+
+$ rails g doorkeeper:install
+$ rails g doorkeeper:migration
+$ bundle exec rake db:migrate
+
+$ vi app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  doorkeeper_for :all
+end
+
+$ rails c
+
+irb(main):001:0> app.accept = "application/json"
+=> "application/json"
+irb(main):002:0> app.get "/v2/recipes"
+=> 401
+irb(main):003:0> application = Doorkeeper::Application.create(name: "example", redirect_uri: "http://example.com")
+=> #<Doorkeeper::Application ...>
+irb(main):004:0> create = application.access_tokens.create
+=> #<Doorkeeper::AccessToken ...>
+irb(main):005:0> app.get "/v2/recipes", access_token: token.token
+=> 200
+irb(main):006:0> JSON.parse(app.response.body)
+=> [...]
+```
+
 ## More
 See [the example application](https://github.com/r7kamura/restaurant/tree/master/spec/dummy).

data/lib/restaurant/actions.rb

@@ -1,20 +1,24 @@
 module Restaurant
   module Actions
+    def self.included(base)
+      base.before_filter :require_valid_id, :require_resource, :only => [:show, :update, :destroy]
+    end
+
     def index
-      respond_with collection.find
+      respond_with collection.find(filter_params).sort(sort_params).skip(skip_params).limit(limit_params)
     end
 
     def show
-      respond_with collection.find(:_id => resource_id).first
+      respond_with @resource
     end
 
     def create
-      collection.insert(resource_param.merge(:_id => resource_id))
+      collection.insert(resource_params.merge(:_id => resource_id))
       respond_with collection.find(:_id => resource_id).first, :location => { :action => :show, :id => resource_id }
     end
 
     def update
-      respond_with collection.find(:_id => resource_id).update(:$set => resource_param)
+      respond_with collection.find(:_id => resource_id).update(:$set => resource_params)
     end
 
     def destroy
@@ -23,8 +27,16 @@ module Restaurant
 
     private
 
+    def require_valid_id
+      head 404 unless Moped::BSON::ObjectId.legal?(params[:id])
+    end
+
+    def require_resource
+      @resource = collection.find(:_id => resource_id).first || head(404)
+    end
+
     def collection
-      Mongoid.default_session.with(:safe => true)[resources_name]
+      Mongoid.default_session[resources_name]
     end
 
     def resource_name
@@ -35,8 +47,8 @@ module Restaurant
       params[:resource]
     end
 
-    def resource_param
-      params[resource_name]
+    def resource_params
+      params[resource_name] || {}
     end
 
     def resource_id
@@ -48,5 +60,37 @@ module Restaurant
         end
       end
     end
+
+    def filter_params
+      params[:filter] || {}
+    end
+
+    def sort_params
+      if params[:sort]
+        Hash[
+          params[:sort].map do |key, value|
+            [key, value.to_i]
+          end
+        ]
+      else
+        {}
+      end
+    end
+
+    def skip_params
+      (page - 1) * per_page
+    end
+
+    def limit_params
+      per_page
+    end
+
+    def page
+      [params[:page].to_i, 1].max
+    end
+
+    def per_page
+      10
+    end
   end
 end

data/lib/restaurant/version.rb

@@ -1,3 +1,3 @@
 module Restaurant
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restaurant
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: doorkeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement