resources 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf722e722d2f471c57224f21a678dd0a054bf163
-  data.tar.gz: b029230fa7ccb38892f8d2f1d1577633ae027b48
+  metadata.gz: 581f13986a09c2e59a9f9d1ef6a55e042d0ead84
+  data.tar.gz: 8f133e57f806c9a5f55e0cf73200e1108d1a94d9
 SHA512:
-  metadata.gz: 8e177b3c014074f81c74f6b27597a7b539c1cb0373f2e16ae45cdef394644f19125c20f24c87b4f7327277160e6abfd92b1d1c3b8d7db600c86635ef62215979
-  data.tar.gz: 95e8cbacafed2eaa4f97e8d5e60651a9650c8dd6449cdaea6a666c73f1e9a9b3f4de305996f4f92eb788d505bc90a1b5d462df089cf53428bc81889cedc7d5aa
+  metadata.gz: 68339a0d0a01806b4e7f4ef7f3705c9b063a4201a758102fb961bb38faec6707bd7bfe07ef3b222d707efd57e6fb594b409240ec87458543b3c138de4159db28
+  data.tar.gz: 9a63a999d2728284df527a2edb6a66e0f9a132903c751f84b6dfe288debd48de46442c2043dbc9cb2177be6417ee3859754ef66a00267128ee3a41135c5fe481

data/README.md

@@ -269,6 +269,61 @@ If you want to override any of the REST actions, to add any extra logic that you
 
 **NOTE:** Remember that you can make use of the  **`resource_saved?`** method to know if the record has been saved
 
+#### **Using it with Grape **
+
+If you are using `resources` with the [Grape](https://github.com/intridea/grape) gem fallow the next steps:
+
+In your Gemfile add the `resources` **after** `grape`
+
+```
+gem "grape"
+gem 'grape-raketasks'
+gem "hashie-forbidden_attributes"
+gem "resources"
+```
+
+Now in your api class add the **`helpers ::Resources::GrapeHelpers`** and in the execute the  **`resource_for`** inside a before block.
+
+```
+require "resources"
+require "resources/grape_helpers" # only need to add this line if you didnt do the previous step
+module Twitter
+  class API < Grape::API
+    version 'v1', using: :header, vendor: 'twitter'
+    format :json
+    prefix :api
+
+    helpers ::Resources::GrapeHelpers
+
+    before do
+      resource_for :"Country"
+    end
+
+    resource :countries do
+      desc "Return a list of countries."
+      get do
+        resources
+      end
+
+      desc "Return a country."
+      get ':id' do
+        resource
+      end
+
+      desc "Update a country."
+      put ':id' do
+        save_resource
+      end
+
+    end
+
+  end
+end
+
+```
+**NOTE:** Currently there is a limitation, the option **`resource_method_name`** doesn't work inside grape
+
+
 #### **GLOBAL CONFIGURATION **
 
 You can change the default parameters of any configuration by change the options in the `config/initializers/resources.rb` that was generated by running `rails g resources:install`

data/lib/loader.rb

@@ -3,4 +3,8 @@ require "resources/rest_actions"
 require "resources/configuration"
 require "resources/controller"
 require "resources/routes"
-require "resources/manager"
+require "resources/manager"
+
+if defined?(Grape)
+  require "resources/grape_helpers"
+end

data/lib/resources.rb

@@ -1,5 +1,5 @@
 require "loader"
 module Resources
-  
+
 end
-ActionController::Base.send(:include, Resources::Controller)
+ActionController::Base.send(:include, Resources::Controller)

data/lib/resources/grape_helpers.rb

@@ -0,0 +1,46 @@
+module Resources
+  module GrapeHelpers
+
+    def resource_for name = nil, *args
+      options = Resources::Config.to_hash.deep_merge(args.extract_options!)
+      @resource_configuration = Resources::Configuration.new(options)
+      @resource_configuration.resource_class_name = name
+    end
+
+    def resource_configuration
+      @resource_configuration
+    end
+
+    def resources_search
+      @resources_search ||= resource_manager.resources_search
+    end
+
+    def resources
+      @resources ||= resource_manager.resources
+    end
+
+    def resource
+      @resource ||= resource_manager.resource
+    end
+
+    def resource_manager
+      @resource_manager ||= Resources::Manager.new(self, request)
+    end
+
+    def resource_saved?
+      @resource_saved
+    end
+
+    def save_resource &block
+      resource.assign_attributes(resource_manager.params_resource)
+      @resource_saved = resource.save
+      block_given? ? block.call(resource) : resource
+    end
+
+    def destroy_resource &block
+      @destroy_resource = resource.destroy
+      block_given? ? block.call(resource) : resource
+    end
+
+  end
+end

data/lib/resources/manager.rb

@@ -5,7 +5,7 @@ module Resources
     def initialize controller, request, *args
       @controller = controller
       @request = request
-      @settings = @controller.class.resource_configuration
+      @settings = grape? ? @controller.resource_configuration : @controller.class.resource_configuration
     end
 
     def resource_class
@@ -25,6 +25,10 @@ module Resources
         end
     end
 
+    def grape?
+      defined?(Grape) && !(controller.class < ActionController::Base)
+    end
+
     def pagination?
       settings.pagination.is_a?(Proc) ? settings.pagination.call(params, controller) : settings.pagination
     end
@@ -43,13 +47,17 @@ module Resources
     end
 
     def resource
-      @resource ||=
-        case controller.action_name
-        when "new", "create"
-          build_resource
-        else
-          resource_scope.where("#{resource_class.table_name}.id = ?",params[:id]).first rescue nil
-        end
+      if grape?
+        @resource ||= params[:id].blank? ? build_resource : (resource_scope.where("#{resource_class.table_name}.id = ?",params[:id]).first rescue nil )
+      else
+        @resource ||=
+          case controller.action_name
+          when "new", "create"
+            build_resource
+          else
+            resource_scope.where("#{resource_class.table_name}.id = ?",params[:id]).first rescue nil
+          end
+      end
     end
 
     def settings
@@ -57,7 +65,7 @@ module Resources
     end
 
     def params
-      controller.params
+      grape? ? request.params : controller.params
     end
 
     def params_search
@@ -90,16 +98,28 @@ module Resources
       end
     end
 
+    def forbidden_params_names
+      [settings.resource_method_name, settings.resources_method_name, :resource, :resources]
+    end
+
+    def forbidden_params_names? name
+      forbidden_params_names.map(&:to_s).include?(settings.send(name).to_s)
+    end
+
     def option_with_params name
+      result = {}
       if settings.send(name).is_a?(Proc)
-        settings.send(name).call(params)
+        result = settings.send(name).call(params)
       else
-        if Rails::VERSION::MAJOR >= 4
-          controller.send(name)
+        if Rails::VERSION::MAJOR >= 4 && !forbidden_params_names?(name)
+          value = controller.send(name) rescue nil
+          result = value ? value : params[settings.send(name)]
         else
-          params[settings.send(name)]
+          result = params[settings.send(name)]
         end
       end
+      result = result && result.is_a?(Hash) ? result :  {}
+      result
     end
 
     def controller

data/lib/resources/rest_actions.rb

@@ -31,6 +31,9 @@ module Resources
 
       end
 
+      def show
+      end
+
       def update
         save_resource
       end

data/lib/resources/version.rb

@@ -1,3 +1,3 @@
 module Resources
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resources
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Emilio Forrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-08 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies: []
 description: It's a gem that help's you to create CRUD controllers for your models
   in a very fast and flexible way.
@@ -34,6 +34,7 @@ files:
 - lib/resources/actions.rb
 - lib/resources/configuration.rb
 - lib/resources/controller.rb
+- lib/resources/grape_helpers.rb
 - lib/resources/manager.rb
 - lib/resources/rest_actions.rb
 - lib/resources/routes.rb