resourcify 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7870d7f333dea432afeed996936a2cb731f3632
-  data.tar.gz: 147f8c9638fc801a08ba8bb01fbadfdbbbab4401
+  metadata.gz: 35ae2a1538823e8d0c2c5b48bed067a61c7617e1
+  data.tar.gz: 41ef92c2d410713392e2c1654a1f0b345ae5609c
 SHA512:
-  metadata.gz: 3dd27cdb2437bb6124174683b42b9a9cbc23e1dc777e5231c29df09ed354dd234114fc012f2eeb2624a635495ff73c6dd6b454c99233d8ad7a5b4a68f1c2d372
-  data.tar.gz: e68314c16e70de51aee74180094bd41f36c4c7473329a90b920d7293d9ea50b6da234392e637012b9d16192b91b556bd880ce311651f5fcfc0126a7da7f1ede5
+  metadata.gz: 9f5d18268a7af685c16b8acdb6a527a12c3cb65aaf6781564cef44e807c5f516321c41591f1d7e0a5ba1a67745eb5ee363247b8739013fb899035adf0e473ee2
+  data.tar.gz: c882e3506a2f7920bdd1b7edd3bfeee72c0cf6358ed2293c893591a7f2bdf7651845e29775a538b9e716e4368bd1a8c77cfa06329add29636e4106fb3b1bc848

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 YOURNAME
+Copyright 2014 Stephen Baidu
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,120 @@
+# Resourcify
+
+Resourcify is a rails gem that helps to speed up development by giving you json api controllers that inherit all restful actions. It also makes your models easier to filter by adding a "resourcify_filter" method. This gem behaves as an "acts_as" gem by using ActiveSupport Concerns.
+
+#### Caveat
+The resourcify gem currently depends on 
+* [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers)
+* [Pundit](https://github.com/elabs/pundit)
+
+## Installation
+
+### Rails 4
+
+Include the gem in your Gemfile:
+
+```ruby
+gem 'resourcify'
+```
+
+## Usage
+
+Applies to different parts of Rails:
+
+* [Controllers](#controllers)
+* [Models](#models)
+
+### Controllers
+
+Usage with controllers is very easy. Just add "resourcify" to your controller and your controller will inherit all the RESTful actions with json response.
+
+```ruby
+class PostsController < ApplicationController
+  # Include the resourcify module
+  resourcify
+  
+end
+```
+
+You can check the [base.rb file](https://github.com/stephenbaidu/resourcify/blob/master/lib/resourcify/controller/base.rb) to see the private methods that have been made available.
+
+#### Strong Parameters
+
+By default, your controller has a permitted_params method for rails strong parameters like this. "_RC" is the resource class or model class.
+
+```ruby
+# Only allow a trusted parameter "white list" through.
+def permitted_params
+  if self.respond_to? "#{controller_name.singularize}_params", true
+    self.send("#{controller_name.singularize}_params")
+  else
+    param_key        = _RC.name.split('::').last.singularize.underscore.to_sym
+    excluded_fields  = ["id", "created_at", "updated_at"]
+    permitted_fields = (_RC.column_names - excluded_fields).map { |f| f.to_sym }
+    params.fetch(param_key, {}).permit([]).tap do |wl|
+      permitted_fields.each { |f| wl[f] = params[param_key][f] if params[param_key].key?(f) }
+    end
+  end
+end
+```
+You can override this by defining a custom method called "permitted_params" (or "post_params" for PostsController) in your controller.
+
+### Models
+
+Asuming you have the following models (Post, User) in your application.
+
+```ruby
+class Post < ActiveRecord::Base
+  attr_accessible :title
+  
+  belongs_to :user
+end
+
+class User < ActiveRecord::Base
+  attr_accessible :first_name, last_name, age
+end
+```
+
+Then you can add "resourcify" like this
+
+```ruby
+class Post < ActiveRecord::Base
+  # Include the resourcify module
+  resourcify
+  
+  attr_accessible :title
+  
+  belongs_to :user
+end
+
+class User < ActiveRecord::Base
+  # Include the resourcify module
+  resourcify
+  
+  attr_accessible :first_name, last_name, age
+end
+```
+
+This allows you to filter your models like this
+```ruby
+# Post with title equal to 'My First Post'
+Post.resourcify_filter("title::eq::My First Post")
+
+# Users with first_name like 'Jo'
+User.resourcify_filter("first_name::like::Jo")
+
+# The following parameters are allowed:
+# [eq(=), ne(!=), like(LIKE), lt(<), gt(>), lte(<=), gte(>=), in(IN [items]), nin(NOT IN [items])]
+User.resourcify_filter("first_name::like::Jo;;last_name::eq::Doe")
+User.resourcify_filter("age::gt::37")
+User.resourcify_filter("age::gte::21;;age::lte::35")
+
+# Users with age in [25, 26, 52, 62] 
+User.resourcify_filter("age::in::25,26,52,62")
+```
+
+Each model with  "resourcify" has a "policy_class" method which returns "ApiPolicy" that can be used by a generic api controller when using Pundit. This was added since the gem is currently tied with Pundit but will later be made optional.
+
+## License
+
+Resourcify is free software, and may be redistributed under the terms specified in the [MIT-LICENSE](MIT-LICENSE) file.

data/lib/resourcify/controller/actions/index.rb

@@ -5,8 +5,10 @@ module Controller::Actions
 
       recs = policy_scope(_RC.all)
 
-      # apply filter if query is present
-      recs = recs.filter(params[:query]) if params[:query].present?
+      # apply resourcify_filter if present and query param is also present
+      if recs.respond_to? "resourcify_filter" and params[:query].present?
+        recs = recs.resourcify_filter(params[:query])
+      end
 
       recs_total = recs.count
 

data/lib/resourcify/controller/base.rb

@@ -13,18 +13,18 @@ module Controller
           data: { total: 0, rows: [] },
           error: { type: '', errors: {}, messages: [] } 
         }
-        raise Resourcify::UndefinedError unless _RC.respond_to? 'resourcified?'
+        # raise Resourcify::UndefinedError unless _RC.respond_to? 'resourcified?'
       end
    
-      def resource_not_resourcified
-        @response_data[:success] = false
-        @response_data[:error]   = { 
-          type: 'resource_not_resourcified',
-          messages: [ 'Resourcify::UndefinedError. Resource route not defined' ]
-        }
+      # def resource_not_resourcified
+      #   @response_data[:success] = false
+      #   @response_data[:error]   = { 
+      #     type: 'resource_not_resourcified',
+      #     messages: [ 'Resourcify::UndefinedError. Resource route not defined' ]
+      #   }
         
-        render json: @response_data
-      end
+      #   render json: @response_data
+      # end
    
       def record_not_found
         @response_data[:success] = false

data/lib/resourcify/model/{filter.rb → resourcify_filter.rb}

@@ -1,13 +1,13 @@
 module Model
-  module Filter
-    def filter(filters)
+  module ResourcifyFilter
+    def resourcify_filter(filter_string)
       records = self
-      simple_ops = { eq: '=', lt: '<', gt: '>', lteq: '<=', gteq: '>=' }
-      filters = filters.split(';;').map { |q| q.split('::') }
-      filters = filters.map { |q| {name: q[0], op: q[1], value: q[2], type: q[3]} }
-      filters = filters.select { |f| self.column_names.include?(f[:name]) }
+      simple_ops = { eq: '=', lt: '<', gt: '>', lte: '<=', gte: '>=' }
+      filter_string = filter_string.split(';;').map { |q| q.split('::') }
+      filter_string = filter_string.map { |q| {name: q[0], op: q[1], value: q[2], type: q[3]} }
+      filter_string = filter_string.select { |f| self.column_names.include?(f[:name]) }
 
-      filters.each do |f|
+      filter_string.each do |f|
         next if f[:value].blank?
 
         operand = f[:op].to_s.to_sym
@@ -21,9 +21,11 @@ module Model
           else
             records = records.where("#{f[:name]} LIKE ?", "%#{f[:value]}%")
           end
+        elsif operand == :ne
+          records = records.where.not("#{f[:name]} = ?", f[:value])
         elsif operand == :in
           records = records.where("#{f[:name]} IN (?)", f[:value].split(','))
-        elsif operand == :notin
+        elsif operand == :nin
           records = records.where.not("#{f[:name]} IN (?)", f[:value].split(','))
         end
       end

data/lib/resourcify/resourcify.rb

@@ -1,4 +1,4 @@
-require "resourcify/model/filter"
+require "resourcify/model/resourcify_filter"
 require "resourcify/model/policy_class"
 require "resourcify/controller/base"
 require "resourcify/controller/actions/index"
@@ -21,7 +21,7 @@ module Resourcify
         
         if self.ancestors.include?(ActiveRecord::Base)        # models
           # Include filter and tag as filterable?
-          send :extend,  Model::Filter
+          send :extend,  Model::ResourcifyFilter
           def filterable?() true end
 
           # Add policy_class method for pundit
@@ -43,7 +43,7 @@ module Resourcify
           # Set rescue_froms with methods located in base.rb
           rescue_from ActiveRecord::RecordNotFound, with: :record_not_found
           rescue_from Pundit::NotAuthorizedError,   with: :user_not_authorized
-          rescue_from UndefinedError, with: :resource_not_resourcified
+          # rescue_from UndefinedError, with: :resource_not_resourcified
 
           # Include base.rb with before_action filters & rescue_from methods
           send :include, Controller::Base

data/lib/resourcify/version.rb

@@ -1,3 +1,3 @@
 module Resourcify
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resourcify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stephen Baidu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -46,7 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/resourcify.rb
 - lib/resourcify/controller/actions/create.rb
@@ -55,8 +55,8 @@ files:
 - lib/resourcify/controller/actions/show.rb
 - lib/resourcify/controller/actions/update.rb
 - lib/resourcify/controller/base.rb
-- lib/resourcify/model/filter.rb
 - lib/resourcify/model/policy_class.rb
+- lib/resourcify/model/resourcify_filter.rb
 - lib/resourcify/resourcify.rb
 - lib/resourcify/version.rb
 - lib/tasks/resourcify_tasks.rake

data/README.rdoc

@@ -1,3 +0,0 @@
-= Resourcify
-
-This project rocks and uses MIT-LICENSE.