restaurant 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9240b0b57d5349170de3603b00cb905f7b9be258
-  data.tar.gz: 8a2bf81d2789e6a28f01deb75d6d831cf7794049
+  metadata.gz: 49cc226f4daf8e7f58cd29786cbc7791ede0710a
+  data.tar.gz: e674d4933f37fab45fe0ed45f8d63910a04b8077
 SHA512:
-  metadata.gz: 761bddbc10f7fc2e3e1160bd91d80046a2882efa92c355e40b88578b41514e8a38cb3618069687a91bf23878312529c37d02e4e025f5930bcd2947b559cbcf39
-  data.tar.gz: 636bee79b982d0145cd3fe5ec4407be309bfc9fe3d7d5858f3e3e26e9bfab65901099dbb0dd2c3e6fa9b11201bde78b9cd1066a10812cf9e2c85086bc9ecf053
+  metadata.gz: 2df6791bafce8d9db067d18e6e8d71dfab0c4133ca5e4cb512e3137b0caa4c54d17a835a197656797f06bd863f2aa7a157304784c77c673cea60595b5c7bca84
+  data.tar.gz: c5e1e05f9dc39dde654c58aed854d4cff560fd0be8582d47d0f2735178e7cda6e958b447de550050a69645394aed9953f2fc6bdccfdfc1d3770112aa694dae18

data/README.md

@@ -1,87 +1,58 @@
 # Restaurant
 Restaurant serves your data via auto-defined RESTful API on your rails application.  
-All you have to do is to write config/restaurant.yml and create DB tables.
+All you have to do is to edit config/routes.rb.
 
-## Features
-* Auto-defined models
-* Auto-defined controllers
-* Auto-defined routes
-* Versioning
-* SQL-like URI query
-* OAuth authentication
-* Scope based authorization
- * restrict actions
- * restrict attributes
- * restrict filtering
- * restrict sorting
-* RESTful APIs
- * GET /v1/:resources
- * GET /v1/:resources/:id
- * POST /v1/:resources
- * PUT /v1/:resources/:id
- * DELETE /v1/:resources/:id
-
-## Auto-defined application
-Models, controllers, and routes are auto-defined from your config/restaurant.yml.
-
-```yaml
-# config/restaurant.yml
-v1:               # Namespaced by v1
-  public:         # User with "public" scope token
-    recipes:      #
-      actions:    #
-        - show    # can access to /recipes/:id
-      attributes: #
-        - title   # can read recipe.title
-  admin:          # User with "admin" scope token
-    recipes:      #
-      actions:    #
-        - index   # can access to /recipes
-        - show    # can access to /recipes/:id
-      where:      #
-        - id      # can filter recipes by id
-        - title   # can filter recipes by title
-      order:      #
-        - id      # can sort recipes by id
-        - title   # can sort recipes by title
-      attributes: #
-        - id      # can read recipe.id
-        - title   # can read recipe.title
+## Get started
 ```
+$ rails new example
+$ cd example
 
-## SQL-like URI query
-You can filter and sort resources by SQL-like URI query.
+$ vi Gemfile
+source "https://rubygems.org"
+gem "rails", "~> 3.2.13"
+gem "restaurant"
+gem "sqlite3"
 
-```ruby
-context "with where params" do
-  it "returns recipes filtered by given query" do
-    get "/v1/recipes", { where: { title: { eq: recipe.title } } }, env
-    response.should be_ok
-    response.body.should be_json(
-       "id"         => 1,
-       "user_id"    => 1
-       "body"       => "body 1",
-       "title"      => "title 1",
-       "updated_at" => "2000-01-01T00:00:00Z",
-       "created_at" => "2000-01-01T00:00:00Z",
-    )
+$ vi config/routes.rb
+Example::Application.routes.draw do
+  namespace :v1 do
+    Restaurant::Router.route(self)
   end
 end
-```
 
-## Install
-```ruby
-# Gemfile
-gem "restaurant"
-```
+$ brew install mongodb
+$ mongod --fork
 
-```
 $ bundle install
-$ bundle exec rails g doorkeeper:install
-$ bundle exec rails g doorkeeper:migration
-$ bundle exec rake db:migrate
-$ ... create your db and tables ...
-$ ... write your config/restaurant.yml
+$ rails g mongoid:config
+$ rails c
+
+[1] pry(main)> app.accept = "application/json"
+=> "application/json"
+[2] pry(main)> app.post "/v1/recipes.json", recipe: { title: "created" }
+=> 201
+[3] pry(main)> JSON.parse(app.response.body)
+=> {"title"=>"created", "_id"=>"51963fe9f02da4c1f8000001"}
+[4] pry(main)> app.get "/v1/recipes/51963fe9f02da4c1f8000001.json"
+=> 200
+[5] pry(main)> JSON.parse(app.response.body)
+=> {"title"=>"created", "_id"=>"51963fe9f02da4c1f8000001"}
+[6] pry(main)> app.put "/v1/recipes/51963fe9f02da4c1f8000001.json", recipe: { title: "updated" }
+=> 204
+[7] pry(main)> app.get "/v1/recipes/51963fe9f02da4c1f8000001.json"
+=> 200
+[8] pry(main)> JSON.parse(app.response.body)
+=> {"title"=>"updated", "_id"=>"51963fe9f02da4c1f8000001"}
+[9] pry(main)> app.get "/v1/recipes.json"
+=> 200
+[10] pry(main)> JSON.parse(app.response.body)
+=> [{"title"=>"updated", "_id"=>"51963fe9f02da4c1f8000001"}]
+[11] pry(main)> app.delete "/v1/recipes/51963fe9f02da4c1f8000001.json"
+=> 204
+[12] pry(main)> app.get "/v1/recipes.json"
+=> 200
+[13] pry(main)> JSON.parse(app.response.body)
+=> []
 ```
 
 ## More

data/lib/restaurant.rb

@@ -1,14 +1,3 @@
-require "restaurant/authentication"
-require "restaurant/authorization"
-require "restaurant/config"
-require "restaurant/controller_helper"
-require "restaurant/controller_provider"
-require "restaurant/params_query_responder"
-require "restaurant/params_query_translator"
-require "restaurant/restful_actions"
-require "restaurant/role_provider"
+require "mongoid"
+require "restaurant/actions"
 require "restaurant/router"
-require "restaurant/railtie"
-
-module Restaurant
-end

data/lib/restaurant/actions.rb

@@ -0,0 +1,52 @@
+module Restaurant
+  module Actions
+    def index
+      respond_with collection.find
+    end
+
+    def show
+      respond_with collection.find(:_id => resource_id).first
+    end
+
+    def create
+      collection.insert(resource_param.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)
+    end
+
+    def destroy
+      respond_with collection.find(:_id => resource_id).remove_all
+    end
+
+    private
+
+    def collection
+      Mongoid.default_session.with(:safe => true)[resources_name]
+    end
+
+    def resource_name
+      resources_name.singularize
+    end
+
+    def resources_name
+      params[:resource]
+    end
+
+    def resource_param
+      params[resource_name]
+    end
+
+    def resource_id
+      @resource_id ||= begin
+        if params[:id]
+          Moped::BSON::ObjectId.from_string(params[:id])
+        else
+          Moped::BSON::ObjectId.new
+        end
+      end
+    end
+  end
+end

data/lib/restaurant/router.rb

@@ -1,23 +1,89 @@
-class Restaurant::Router
-  def self.route(*args)
-    new(*args).route
-  end
+# Define routes and a controller.
+#
+# Examples
+#
+#   # config/routes.rb
+#   Restaurant::Router.route(self)
+#
+#     1. Define ResourcesController if not defined
+#     2. Define these routes
+#       GET    /:resources     -> reosurces#index
+#       GET    /:resources/:id -> resources#show
+#       POST   /:resources     -> resources#create
+#       PUT    /:resources/:id -> resources#update
+#       DELETE /:resources/:id -> resources#destroy
+#
+#
+#   # config/routes.rb
+#   namespace :v1 do
+#     Restaurant::Router.route(self)
+#   end
+#
+#     1. Define V1::ResourcesController if not defined
+#     2. Define these routes
+#       GET    /v1/:resources     -> v1/reosurces#index
+#       GET    /v1/:resources/:id -> v1/resources#show
+#       POST   /v1/:resources     -> v1/resources#create
+#       PUT    /v1/:resources/:id -> v1/resources#update
+#       DELETE /v1/:resources/:id -> v1/resources#destroy
+#
+module Restaurant
+  class Router
+    def self.route(*args)
+      new(*args).route
+    end
 
-  attr_reader :router
+    attr_reader :router
 
-  def initialize(router)
-    @router = router
-  end
+    def initialize(router)
+      @router = router
+    end
 
-  def route
-    Restaurant::Config.versions.each do |version, scopes|
-      router.namespace(version) do
-        scopes.each do |scope, controllers|
-          controllers.each do |controller, values|
-            router.resources controller, :only => values["actions"]
+    def route
+      define_route
+      define_controller
+    end
+
+    private
+
+    def define_route
+      router.instance_eval do
+        scope ":resource" do
+          controller :resources do
+            get "" => :index
+            get ":id" => :show
+            post "" => :create
+            put ":id" => :update
+            delete ":id" => :destroy
           end
         end
       end
     end
+
+    def define_controller
+      namespace.const_get(:ResourcesController)
+    rescue NameError
+      namespace.const_set(:ResourcesController, controller_class)
+    end
+
+    def scope
+      router.instance_variable_get(:@scope)
+    end
+
+    def controller_class
+      Class.new(::ApplicationController) do
+        include Restaurant::Actions
+        respond_to :json
+      end
+    end
+
+    def namespace
+      scope[:module].to_s.camelize.constantize
+    rescue NameError => exception
+      if exception.to_s =~ /uninitialized constant (?:(.+)(?:::))?(.+)/
+        $1.to_s.constantize.const_set($2, Module.new)
+        retry
+      end
+    end
   end
 end

data/lib/restaurant/version.rb

@@ -1,3 +1,3 @@
 module Restaurant
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: restaurant
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.13
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.13
-- !ruby/object:Gem::Dependency
-  name: rack-accept-default
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -39,33 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: doorkeeper
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.7
-  type: :runtime
+        version: 3.2.13
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.7
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  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'
+        version: 3.2.13
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +94,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: factory_girl_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +108,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: response_code_matchers
-  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'
 description: Restraunt serves your data via auto-defined RESTful API on your rails
   application.
 email:
@@ -172,16 +116,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/restaurant/authentication.rb
-- lib/restaurant/authorization.rb
-- lib/restaurant/config.rb
-- lib/restaurant/controller_helper.rb
-- lib/restaurant/controller_provider.rb
-- lib/restaurant/params_query_responder.rb
-- lib/restaurant/params_query_translator.rb
-- lib/restaurant/railtie.rb
-- lib/restaurant/restful_actions.rb
-- lib/restaurant/role_provider.rb
+- lib/restaurant/actions.rb
 - lib/restaurant/router.rb
 - lib/restaurant/version.rb
 - lib/restaurant.rb

data/lib/restaurant/authentication.rb

@@ -1,7 +0,0 @@
-module Restaurant::Authentication
-  extend ActiveSupport::Concern
-
-  included do
-    doorkeeper_for :all
-  end
-end

data/lib/restaurant/authorization.rb

@@ -1,13 +0,0 @@
-module Restaurant::Authorization
-  extend ActiveSupport::Concern
-
-  included do
-    before_filter :require_authorization
-  end
-
-  private
-
-  def require_authorization
-    head 403 unless current_role.has_authorization?
-  end
-end

data/lib/restaurant/config.rb

@@ -1,43 +0,0 @@
-module Restaurant::Config
-  class << self
-    def versions
-      @versions ||= YAML.load_file(path)
-    end
-
-    def path
-      Rails.root.join("config/restaurant.yml").tap do |path|
-        raise NoRolesError, "#{path} is not found" unless path.exist?
-      end
-    end
-
-    def define_version_modules
-      version_module_names.each do |version_module_name|
-        unless Object.const_defined?(version_module_name)
-          Object.const_set(version_module_name, Module.new)
-        end
-      end
-    end
-
-    def define_controller_classes(base)
-      versions.each do |version, scopes|
-        scopes.each do |scope, controllers|
-          controllers.keys.each do |controller|
-            version_module = version.camelize.constantize
-            controller_class_name = "#{controller.camelize}Controller"
-            unless version_module.const_defined?(controller_class_name)
-              version_module.const_set(controller_class_name, Class.new(base))
-            end
-          end
-        end
-      end
-    end
-
-    def version_module_names
-      versions.keys.map do |version_name|
-        version_name.camelize
-      end
-    end
-  end
-
-  NoRolesError = Class.new(StandardError)
-end

data/lib/restaurant/controller_helper.rb

@@ -1,14 +0,0 @@
-module Restaurant::ControllerHelper
-  extend ActiveSupport::Concern
-
-  included do
-    use Rack::AcceptDefault
-    include Restaurant::ControllerProvider
-    include Restaurant::RestfulActions
-    include Restaurant::Authentication
-    include Restaurant::Authorization
-    include Restaurant::RoleProvider
-    self.responder = Restaurant::ParamsQueryResponder
-    respond_to :json
-  end
-end

data/lib/restaurant/controller_provider.rb

@@ -1,8 +0,0 @@
-module Restaurant::ControllerProvider
-  extend ActiveSupport::Concern
-
-  included do
-    Restaurant::Config.define_version_modules
-    Restaurant::Config.define_controller_classes(self)
-  end
-end

data/lib/restaurant/params_query_responder.rb

@@ -1,8 +0,0 @@
-class Restaurant::ParamsQueryResponder < ActionController::Responder
-  def initialize(controller, resources, options = {})
-    if resources.last.is_a? ActiveRecord::Relation
-      resources[-1] = Restaurant::ParamsQueryTranslator.translate(controller.params, resources.last)
-    end
-    super(controller, resources, options)
-  end
-end

data/lib/restaurant/params_query_translator.rb

@@ -1,170 +0,0 @@
-class Restaurant::ParamsQueryTranslator
-  def self.translate(*args)
-    new(*args).translate
-  end
-
-  attr_reader :params, :resources
-
-  def initialize(params, resources)
-    @params = params
-    @resources = resources
-  end
-
-  def translate
-    filters.inject(resources) do |result, filter|
-      filter.call(result)
-    end
-  end
-
-  def filters
-    where_filters + order_filters
-  end
-
-  private
-
-  def where_filters
-    where.map do |column, value|
-      WhereFilter.new(column, value)
-    end
-  end
-
-  def order_filters
-    order.map do |column|
-      OrderFilter.new(column)
-    end
-  end
-
-  def where
-    params[:where] || {}
-  end
-
-  def order
-    case params[:order]
-    when String
-      [params[:order]]
-    else
-      []
-    end
-  end
-
-  class WhereFilter
-    attr_reader :column, :value
-
-    def initialize(column, value)
-      @column = column
-      @value = value
-    end
-
-    def call(resources)
-      sections.inject(resources) do |relation, section|
-        relation.where("#{column} #{section.operator}", *section.operand)
-      end
-    end
-
-    private
-
-    def sections
-      value.map do |operator, operand|
-        Section.new(operator, operand)
-      end
-    end
-
-    class Section
-      attr_reader :raw_operator, :raw_operand
-
-      def initialize(raw_operator, raw_operand)
-        @raw_operator = raw_operator
-        @raw_operand = raw_operand
-      end
-
-      def operator
-        if raw_operand.nil?
-          case raw_operator
-          when "eq"
-            "IS NULL"
-          when "ne"
-            "IS NOT NULL"
-          end
-        else
-          case raw_operator
-          when "eq"
-            "= ?"
-          when "ne"
-            "!= ?"
-          when "lt"
-            "< ?"
-          when "lte"
-            "<= ?"
-          when "gt"
-            "> ?"
-          when "gte"
-            ">= ?"
-          when "in"
-            "IN (?)"
-          end
-        end
-      end
-
-      def operand
-        case raw_operand
-        when nil
-          []
-        else
-          [raw_operand]
-        end
-      end
-    end
-  end
-
-  class OrderFilter
-    attr_reader :columns
-
-    def initialize(columns)
-      @columns = columns
-    end
-
-    def call(resources)
-      sections.inject(resources) do |result, section|
-        result.order(section.sort)
-      end
-    end
-
-    def sections
-      Array.wrap(columns).map do |column|
-        Section.new(column)
-      end
-    end
-
-    private
-
-    class Section
-      attr_reader :raw_column
-
-      def initialize(raw_column)
-        @raw_column = raw_column
-      end
-
-      def sort
-        "#{column} #{order}"
-      end
-
-      private
-
-      def column
-        raw_column.to_s.gsub(/^-/, "")
-      end
-
-      def order
-        if desc?
-          "DESC"
-        else
-          "ASC"
-        end
-      end
-
-      def desc?
-        /^-/ === raw_column.to_s
-      end
-    end
-  end
-end

data/lib/restaurant/railtie.rb

@@ -1,6 +0,0 @@
-class Restaurant::Railtie < Rails::Railtie
-  config.after_initialize do
-    Rails.application.routes.append { Restaurant::Router.route(self) }
-    ApplicationController.send :include, Restaurant::ControllerHelper
-  end
-end

data/lib/restaurant/restful_actions.rb

@@ -1,67 +0,0 @@
-module Restaurant::RestfulActions
-  extend ActiveSupport::Concern
-
-  included do
-    rescue_from ActiveRecord::RecordNotFound do
-      head 404
-    end
-
-    hide_action :current_version
-  end
-
-  def index
-    respond_with model.scoped, :only => current_role.allowed_attributes
-  end
-
-  def show
-    respond_with resource, :only => current_role.allowed_attributes
-  end
-
-  def create
-    respond_with model.create(resource_param), :only => current_role.allowed_attributes
-  end
-
-  def update
-    respond_with resource.update_attributes(resource_param)
-  end
-
-  def destroy
-    respond_with resource.delete
-  end
-
-  def current_version
-    @current_version ||= self.class.name.split("::").first.underscore
-  end
-
-  private
-
-  def model
-    model_name.constantize
-  rescue NameError
-    define_model
-  end
-
-  def model_name
-    self.class.name.sub(/Controller$/, "").singularize
-  end
-
-  def resource_param
-    params[resource_class_name.underscore]
-  end
-
-  def resource
-    model.find(params[:id])
-  end
-
-  def resource_class_name
-    model_name.split("::").last
-  end
-
-  def define_model
-    current_version_module.const_set(resource_class_name, Class.new(ActiveRecord::Base))
-  end
-
-  def current_version_module
-    current_version.camelize.constantize
-  end
-end

data/lib/restaurant/role_provider.rb

@@ -1,93 +0,0 @@
-module Restaurant::RoleProvider
-  private
-
-  def current_role
-    @current_role ||= Role.new(self)
-  end
-
-  class Role
-    delegate(
-      :action_name,
-      :controller_name,
-      :doorkeeper_token,
-      :params,
-      :to => :controller
-    )
-
-    attr_reader :controller
-
-    def initialize(controller)
-      @controller = controller
-    end
-
-    def has_authorization?
-      has_action_authorization? && has_query_authorization?
-    end
-
-    def abilities
-      @abilities ||= Restaurant::Config.versions[controller.current_version].map do |role, controllers|
-        if doorkeeper_token.scopes.include?(role.to_sym)
-          controllers[controller_name]
-        end
-      end.compact
-    end
-
-    def allowed_attributes
-      abilities.map {|ability| ability["attributes"] }.compact.inject(:|)
-    end
-
-    private
-
-    def has_action_authorization?
-      abilities.any? do |ability|
-        ability["actions"].include?(action_name)
-      end
-    end
-
-    def has_query_authorization?
-      if has_not_allowed_where? || has_not_allowed_order?
-        false
-      else
-        true
-      end
-    end
-
-    def has_where_query?
-      params[:where]
-    end
-
-    def has_order_query?
-      params[:order]
-    end
-
-    def order_abilities
-      abilities.inject([]) do |columns, ability|
-        columns + (ability["order"] || [])
-      end
-    end
-
-    def where_abilities
-      abilities.inject([]) do |columns, ability|
-        columns + (ability["where"] || [])
-      end
-    end
-
-    def has_not_allowed_where?
-      has_where_query? && (where_queries - where_abilities).any?
-    end
-
-    def has_not_allowed_order?
-      has_order_query? && (order_queries - order_abilities).any?
-    end
-
-    def where_queries
-      params[:where].keys
-    end
-
-    def order_queries
-      Array.wrap(params[:order]).map do |column|
-        column.sub(/^-/, "")
-      end
-    end
-  end
-end