grape-resources 0.0.1.alpha → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 837961eaaf5f621932eec50334d3cf76b3036b2b
-  data.tar.gz: 618ca3bb4d8ef74cf314018e0a4de72a3c476426
+  metadata.gz: 96c8f832053917cc1f99c0e0562f270a8455a721
+  data.tar.gz: 05614c9a6bd1f46715cde8a546186fdb73c4678f
 SHA512:
-  metadata.gz: f14e1a80d8a32848d668b6010a192a8acb103c9812c09d02361ff6cc603f761578a5a8a1b67bc8f935df2739ba8213e6cf6aaa19bbe83c8c8d77864d1b6a556c
-  data.tar.gz: 2ca3c1960f2d0e6b72260c41c46f3b583d410b07806c519cbcc0bc2832ce5651be670ed3c2cb41b4a5b53a32556aab2cacc0e9bbf06ff79493b321bab98cae8d
+  metadata.gz: d395e028761dd5010248b5d2868f8d3b095cbb4df260d6b5573a12ae2ceb8eb2ad8e8e8c741b23c2fd792af468ce926454486a3715fc1c9f85a5d11093caa263
+  data.tar.gz: 8ee61be4d6e088254bdeb906eeb311a201cf99d12f95b74d1473c216eef5cb5c0ef712d1f2b8f171bf83a176f9f4b05d3b03f2bf49d87455b8eca5aab0799d72

data/README.md

@@ -64,6 +64,55 @@ Available options for routes are:
     :put    -> [PUT]    /player/:id
     :delete -> [DELETE  /player/:id
 
+resources_for method can receive a block to allow nested resources, and custom endpoints for a particular class
+
+for example:
+
+```ruby
+
+  class MyApi::API < Grape::API
+    resources_for Player, [:list, :get] do
+      get :tshirt_size do
+          ...
+      end
+    end
+  end
+```
+  
+And it will generate:
+
+      GET     /players
+      GET     /player/:id
+      GET     /players/tshirt_size
+
+
+TODO: v0.0.3
+
+- Detect when resources_for is being called inside another resource, in that case, generated routes should 
+  consider the parent resource id.
+
+  for example:
+
+  ```ruby
+
+    class MyApi::API < Grape::API
+      resources :teams do
+        resources_for(Player, [:list, :get])
+      end
+    end
+
+  ```
+
+  And it should generate: 
+
+        GET     /team/:id/players
+        GET     /team/:id/player/:id
+        POST    /team/:id/player
+        PUT     /team/:id/player/:id
+        DELETE  /team/:id/player/:id
+
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/grape-resources/fork )

data/lib/grape/resources.rb

@@ -6,35 +6,43 @@ module Grape
     include Grape::Resources
     class << self
       def resources_for( clazz, methods=[:list, :get, :post, :put, :delete])
-        singular_name = clazz.name.underscore
-        plural_name   = clazz.name.pluralize.underscore
-
         raise Error("To use grape_resources on a given class it should inherit from ActiveRecord::Base.( at least for now buddy ;) )") unless clazz < ActiveRecord::Base
+        
+        plural_name = clazz.name.pluralize.underscore        
+        resources plural_name.to_sym do
+          Grape::Resources.list_endpoint_for( clazz, self ) if methods.include?(:list)
+          yield if block_given?
+        end
 
-        Grape::Resources.list_endpoint_for( clazz, self ) if methods.include?(:list)
-        Grape::Resources.get_endpoint_for( clazz, self ) if methods.include?(:get)
-        Grape::Resources.create_endpoint_for( clazz, self ) if methods.include?(:post)        
-        Grape::Resources.update_endpoint_for( clazz, self ) if methods.include?(:put)               
-        Grape::Resources.delete_endpoint_for(clazz, self) if methods.include?(:delete)
+        Grape::Resources.load_singular_endpoints(clazz, self, methods)   
       end
     end
   end
 
   module Resources
     class << self
+
+      def load_singular_endpoints( clazz, api_instance, methods)
+        singular_name = singular_name_for clazz
+
+        api_instance.resource singular_name.to_sym do
+          Grape::Resources.get_endpoint_for( clazz, api_instance ) if methods.include?(:get)
+          Grape::Resources.create_endpoint_for( clazz, api_instance ) if methods.include?(:post)        
+          Grape::Resources.update_endpoint_for( clazz, api_instance ) if methods.include?(:put)               
+          Grape::Resources.delete_endpoint_for( clazz, api_instance) if methods.include?(:delete)
+        end
+      end
       
       def list_endpoint_for(clazz, api_instance)
-        plural_name   = clazz.name.pluralize.underscore
-
-        api_instance.route('GET', ["/#{plural_name}"], {} ) do                   
+        api_instance.get do
           result = Grape::Resources.list(clazz, params)
           result
         end
       end
 
-      def get_endpoint_for(clazz, api_instance)      
+      def get_endpoint_for(clazz, api_instance)   
         singular_name = singular_name_for clazz  
-        api_instance.route('GET', ["/#{singular_name }/:id"], {}) do
+        api_instance.get ":id" do
           result = Grape::Resources.find(clazz, params)
           error!( "#{singular_name} not found", 404) if result.nil?
           result
@@ -44,7 +52,7 @@ module Grape
       def delete_endpoint_for(clazz, api_instance) 
         singular_name = singular_name_for clazz
         
-        api_instance.route('DELETE', ["/#{singular_name}/:id"], {}) do
+        api_instance.delete ":id" do
           result = Grape::Resources.find(clazz, params)
           error!( "#{singular_name} not found", 404) if result.nil?
           result.destroy
@@ -53,7 +61,7 @@ module Grape
 
       def create_endpoint_for(clazz, api_instance)
         singular_name = singular_name_for clazz
-        api_instance.route('POST', ["/#{singular_name}"], {}) do
+        api_instance.post do
           result = clazz.new
           
           Grape::Resources.apply_attributes(result, params)
@@ -66,7 +74,7 @@ module Grape
       def update_endpoint_for(clazz, api_instance)
         singular_name = singular_name_for clazz
 
-        api_instance.route('PUT', ["/#{singular_name}/:id"], {}) do
+        api_instance.put ":id" do
           result = clazz.find_by_id(params[:id])        
           error!( {error: "#{singular_name} with id '#{params[:id]}' was not found"}, 404) unless result.present?
           
@@ -96,6 +104,7 @@ module Grape
       def singular_name_for( clazz ) 
         clazz.name.underscore
       end
+
     end
   end
 end

data/lib/grape/resources/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Resources
-    VERSION = "0.0.1.alpha"
+    VERSION = "0.0.2"
   end
 end

data/spec/lib/grape/resources_spec.rb

@@ -215,4 +215,54 @@ describe Grape::Resources do
     end
     
   end
+
+  describe "block processing" do
+    it "should accept a block and process it after the resources part" do
+      
+      subject.class_eval do
+        resources_for(Car, [:list] ) do
+          get :engine do
+            ["Cars usually have one engine"]
+          end
+        end
+      end
+
+      get "/cars/engine"
+      expect(last_response.status).to eq 200
+    end
+
+    it "blocks inside can be nested as Grape provides" do
+      
+      subject.class_eval do
+        resources_for(Car, [:list] ) do
+          namespace :engine do
+            before do
+              @something = "cool"
+            end
+
+            get do 
+            end
+
+            post do
+              { something: @something }.to_json
+            end
+          end
+        end
+      end
+
+      post "/cars/engine"
+      expect(JSON.parse(last_response.body)["something"]).to eq "cool"
+    end
+
+    it "should allow nested resources_for" do
+      subject.class_eval do
+        resources_for(Car, [:list] ) do
+          resources_for(User)
+        end
+      end
+
+      get "/cars/users"
+      expect(last_response.status).to eq 200
+    end
+  end
 end

data/spec/support/examples/api_example.rb

@@ -3,5 +3,4 @@ require "grape/resources"
 
 class APIExample < Grape::API
   format :json
-  resources_for( User )
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-resources
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.2
 platform: ruby
 authors:
 - Antonio Pagano, Israel De La Hoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -234,9 +234,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.1
@@ -253,3 +253,4 @@ test_files:
 - spec/support/models/car.rb
 - spec/support/models/user.rb
 - spec/support/schema.rb
+has_rdoc: