rest_engine 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,55 @@
+rest_engine
+===========
+
+rest_engine is a Rails 3 engine that provide your Rails application a restful API
+
+Installation
+------------
+
+In your `Gemfile`, add the following dependencies:
+
+    gem 'rest_engine'
+
+Run:
+
+    $ bundle install
+
+That's it. It will provide a restful API for your models.
+
+Usage
+-----
+
+Start the server:
+
+    $ rails server
+
+Let's say you have a model `Customer`, you should now be able to access your customers:
+
+* To get a list of customers: `GET http://localhost:3000/api/customers`
+* To get a single customer: `GET http://localhost:3000/api/customers/1`
+* To create a new customer: `POST http://localhost:3000/api/customers`
+* To update a customer: `PUT http://localhost:3000/api/customers/1`
+* To delete a customer: `DELETE http://localhost:3000/api/customers/1`
+
+It also support namespaced model. For example if your model is `Product::Toy`, then the url would be: `http://localhost:3000/api/product/toys`
+
+Or, to see the available routes:
+
+    $ rake routes
+
+Contributing to rest_engine
+---------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 Yehezkiel Syamsuhadi. See LICENSE.txt for
+further details.

data/app/controllers/rest_engine/main_controller.rb

@@ -16,12 +16,12 @@ module RestEngine
 
       items = @model.all(options)
 
-      respond(:success => true, :data => items)
+      respond(:success => true, @resources => items)
     end
 
     def show
       item = @model.find(params[:id])
-      respond(:success => true, :data => item)
+      respond(:success => true, @resources => [item])
     end
 
     def destroy
@@ -36,7 +36,7 @@ module RestEngine
     def create
       item = @model.new(request.POST)
       if item.save
-        respond(:success => true, :message => "Created new #{@model_name} #{item.id}", :data => item)
+        respond(:success => true, :message => "Created new #{@model_name} #{item.id}", @resources => [item])
       else
         respond(:success => false, :message => "Failed to create #{@model_name}")
       end
@@ -45,7 +45,7 @@ module RestEngine
     def update
       item = @model.find(params[:id])
       if item.update_attributes(request.POST)
-        respond(:success => true, :message => "Updated #{@model_name} #{item.id}", :data => item)
+        respond(:success => true, :message => "Updated #{@model_name} #{item.id}", @resources => [item])
       else
         respond(:success => false, :message => "Failed to update #{@model_name}")
       end
@@ -61,13 +61,9 @@ module RestEngine
     end
 
     def get_model
-      @model_name = to_model_name(params[:resources])
+      @resources = params[:resources]
+      @model_name = @resources.classify
       @model = @model_name.constantize
     end
-
-    def to_model_name(resources_name)
-      parts = resources_name.split('~')
-      parts.map { |x| x == parts.last ? x.classify : x.camelize }.join('::')
-    end
   end
 end

data/config/routes.rb

@@ -1,11 +1,11 @@
 Rails.application.routes.draw do
   scope 'api', :as => 'rest_engine' do
     controller 'rest_engine/main' do
-      get    '/:resources',     :to => :list,    :as => 'list'
-      post   '/:resources',     :to => :create,  :as => 'create'
-      get    '/:resources/:id', :to => :show,    :as => 'show'
-      put    '/:resources/:id', :to => :update,  :as => 'update'
-      delete '/:resources/:id', :to => :destroy, :as => 'destroy'
+      get    '/*resources/:id(.:format)', :to => :show,    :as => 'show',    :constraints => { :id => /\d+/ }
+      put    '/*resources/:id(.:format)', :to => :update,  :as => 'update',  :constraints => { :id => /\d+/ }
+      delete '/*resources/:id(.:format)', :to => :destroy, :as => 'destroy', :constraints => { :id => /\d+/ }
+      get    '/:resources(.:format)',     :to => :list,    :as => 'list',    :constraints => { :resources => /.+?/ }
+      post   '/:resources(.:format)',     :to => :create,  :as => 'create',  :constraints => { :resources => /.+?/ }
     end
   end
 end

metadata

@@ -1,153 +1,147 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rest_engine
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Yehezkiel Syamsuhadi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-25 00:00:00 +10:00
+date: 2011-07-21 00:00:00.000000000 +10:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2159038320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 3.0.9
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159038320
+- !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2159037780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159037780
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2159037180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159037180
+- !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &2159036660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.3.1
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159036660
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &2159003540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.15
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159003540
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &2159003060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159003060
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &2159002580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159002580
+- !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &2159002100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *id008
+  version_requirements: *2159002100
 description: 
 email: yehezkielbs@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
+- README.md
+files:
 - app/controllers/rest_engine/application_controller.rb
 - app/controllers/rest_engine/main_controller.rb
 - config/routes.rb
 - lib/rest_engine.rb
 - lib/rest_engine/engine.rb
 - LICENSE.txt
-- README.rdoc
+- README.md
 has_rdoc: true
 homepage: http://github.com/yehezkielbs/rest_engine
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -2714594228656389374
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1271305889267693870
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: A Rails 3 Engine to provide a restful API
+summary: A Rails 3 engine that provide your Rails application a restful API
 test_files: []
-

data/README.rdoc

@@ -1,19 +0,0 @@
-= rest_engine
-
-Description goes here.
-
-== Contributing to rest_engine
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Yehezkiel Syamsuhadi. See LICENSE.txt for
-further details.
-