restaurant 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34693c2b7b5744a24cb8d8b5996a0e71f864c224
-  data.tar.gz: 05751994c3c8c46fa048b739ef440f0b61a1b6df
+  metadata.gz: 55d03c905414bb0fbac7cbc3752191feebee35da
+  data.tar.gz: 57d837db184f2493ce2a719c1ecfa9f4da2d05e2
 SHA512:
-  metadata.gz: ed5df57787d9ae463a3b9f0163470c613769efc904add512f243d06db0a4b2ff421236d7909976accd30a02ede8a90a3fba64389a1e2e79f13e90093fd7bd91f
-  data.tar.gz: f19f4861e947ea6b6b1cb94907ee48f22c8a7654c21d35def38d68137b97629bacaa377b7d1b0302918e49f5466c8c5d6c205289708838ef7674e2a56d4f3083
+  metadata.gz: 364da1e3ae41a17dd979c958f8a62019593ecf526acb170aaa18651a2abfcc3f72006128f3b1a3c2e9f2df24369c3058a0b9b8dc24d8f557fd6b0d97cbd8ec12
+  data.tar.gz: 4e8458965b3d116cc5ee364978af53a72e9928519ece7e57994c827972b92fb3c298282a4b464c071db286fac8fe6b8fe69ec0c1cd395eb4ea23bb766deac334

data/README.md

@@ -2,8 +2,10 @@
 Restaurant serves your data via auto-defined RESTful API on your rails application.
 
 ## Features
+* Auto-defined models
 * Auto-defined controllers
 * Auto-defined routes
+* Versioning
 * SQL-like URI query
 * OAuth authentication
 * Scope based authorization
@@ -12,37 +14,38 @@ Restaurant serves your data via auto-defined RESTful API on your rails applicati
  * restrict filtering
  * restrict sorting
 * RESTful APIs
- * GET /:resources
- * GET /:resources/:id
- * POST /:resources
- * PUT /:resources/:id
- * DELETE /:resources/:id
+ * GET /v1/:resources
+ * GET /v1/:resources/:id
+ * POST /v1/:resources
+ * PUT /v1/:resources/:id
+ * DELETE /v1/:resources/:id
 
-## Auto-defined controllers and routes
-Controllers and routes are auto-defined from your config/restaurant.yml.
+## Auto-defined application
+Models, controllers, and routes are auto-defined from your config/restaurant.yml.
 
 ```yaml
 # config/restaurant.yml
-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
+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
 ```
 
 ## SQL-like URI query
@@ -51,7 +54,7 @@ You can filter and sort resources by SQL-like URI query.
 ```ruby
 context "with where params" do
   it "returns recipes filtered by given query" do
-    get "/recipes", { where: { title: { eq: recipe.title } } }, env
+    get "/v1/recipes", { where: { title: { eq: recipe.title } } }, env
     response.should be_ok
     response.body.should be_json(
        "id"         => 1,

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-
 RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
+
+require File.expand_path("../spec/dummy/config/application", __FILE__)
+Dummy::Application.load_tasks

data/lib/restaurant/config.rb

@@ -1,13 +1,19 @@
 module Restaurant::Config
   class << self
-    def roles
-      @roles ||= YAML.load_file(path)
+    def versions
+      @versions ||= YAML.load_file(path)
     end
 
     def controllers
-      roles.inject([]) do |result, (role, controllers)|
-        result += controllers.keys
-      end.uniq
+      result = []
+      versions.each do |version, scopes|
+        scopes.each do |scope, controllers|
+          controllers.keys.each do |controller|
+            result << "#{version.camelize}::#{controller.camelize}Controller"
+          end
+        end
+      end
+      result.uniq
     end
 
     def path
@@ -15,6 +21,34 @@ module Restaurant::Config
         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)

data/lib/restaurant/controller_helper.rb

@@ -9,5 +9,6 @@ module Restaurant::ControllerHelper
     include Restaurant::Authorization
     include Restaurant::RoleProvider
     self.responder = Restaurant::ParamsQueryResponder
+    respond_to :json
   end
 end

data/lib/restaurant/controller_provider.rb

@@ -2,11 +2,7 @@ module Restaurant::ControllerProvider
   extend ActiveSupport::Concern
 
   included do
-    Restaurant::Config.controllers.each do |controller|
-      class_name = "#{controller.camelize.pluralize}Controller"
-      unless Object.const_defined?(class_name)
-        Object.const_set(class_name, Class.new(self))
-      end
-    end
+    Restaurant::Config.define_version_modules
+    Restaurant::Config.define_controller_classes(self)
   end
 end

data/lib/restaurant/restful_actions.rb

@@ -5,6 +5,8 @@ module Restaurant::RestfulActions
     rescue_from ActiveRecord::RecordNotFound do
       head 404
     end
+
+    hide_action :current_version
   end
 
   def index
@@ -16,17 +18,21 @@ module Restaurant::RestfulActions
   end
 
   def create
-    respond_with model.create(model_param), :only => current_role.allowed_attributes
+    respond_with model.create(resource_param), :only => current_role.allowed_attributes
   end
 
   def update
-    respond_with resource.update_attributes(model_param)
+    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
@@ -36,18 +42,26 @@ module Restaurant::RestfulActions
   end
 
   def model_name
-    @model_name ||= self.class.name.sub(/Controller$/, "").singularize
+    self.class.name.sub(/Controller$/, "").singularize
   end
 
-  def model_param
-    params[model_name.underscore]
+  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
-    Object.const_set(model_name, Class.new(ActiveRecord::Base))
+    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,4 +1,6 @@
 module Restaurant::RoleProvider
+  private
+
   def current_role
     @current_role ||= Role.new(self)
   end
@@ -23,7 +25,7 @@ module Restaurant::RoleProvider
     end
 
     def abilities
-      @abilities ||= Restaurant::Config.roles.map do |role, controllers|
+      @abilities ||= Restaurant::Config.versions[controller.current_version].map do |role, controllers|
         if doorkeeper_token.scopes.include?(role.to_sym)
           controllers[controller_name]
         end

data/lib/restaurant/router.rb

@@ -10,9 +10,13 @@ class Restaurant::Router
   end
 
   def route
-    Restaurant::Config.roles.each do |role, controllers|
-      controllers.each do |controller_name, definitions|
-        router.resources controller_name, :only => definitions["actions"]
+    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"]
+          end
+        end
       end
     end
   end

data/lib/restaurant/version.rb

@@ -1,3 +1,3 @@
 module Restaurant
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restaurant
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -213,4 +213,3 @@ signing_key:
 specification_version: 4
 summary: A rails plugin to auto-define RESTful API
 test_files: []
-has_rdoc: