resourcify 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce0387e71b16f415b6e60fdc2c6a8c87cf619ce7
-  data.tar.gz: 7edfd0fa2a98bb1586459c98255774f1004f957a
+  metadata.gz: 024f5520a2238ae49d504aa8cc020fa538bb1819
+  data.tar.gz: 16c2a53c2a5d639ee0bc48f2a3c4f1dd0ad3df1c
 SHA512:
-  metadata.gz: 8eeb99efad71fcae6e9ad3cb7197bcce6e1ffa77a4cffb4afff4a590ed1e0c9968e49ebf9d5364300fe55f648bce314c0fff570e93b1890203864639f5be2252
-  data.tar.gz: efd021a1a002a47dab329669025317f69c8566ed85c221cecbf789ccdf54f7927ae5310c10624556bda7584b5144308d9f922c386626d61a92a155302fa12956
+  metadata.gz: c8d915890438f9f14eb391c44c5440d84c7216764f79bce73bddc69e31e790358e7b5ae6030db19beb014f1e4ee81aa52c56376009ed5388182dc5f245752df0
+  data.tar.gz: b205151f540d8c63c841fed008b6c315b2cfc16dc39b541c0f2ca6499bdffe467845aa36d1efe00819503af1c94d97a8fcf23e04ab1767a17d2a92ecc285e98f

data/README.md

@@ -1,11 +1,9 @@
 # Resourcify [![Gem Version](https://badge.fury.io/rb/resourcify.png)](http://badge.fury.io/rb/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.
+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 "filter_by" 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)
+The resourcify gem currently depends on [Pundit](https://github.com/elabs/pundit)
 
 ## Installation
 
@@ -98,19 +96,19 @@ 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")
+Post.filter_by('title' => 'My First Post')
 
 # Users with first_name like 'Jo'
-User.resourcify_filter("first_name::like::Jo")
+User.filter_by('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")
+User.filter_by('first_name.like' => 'Jo', 'last_name.eq' => 'Doe')
+User.filter_by('age.gt' => 37)
+User.filter_by('age.gte' => 21, 'age.lte' => 35)
 
 # Users with age in [25, 26, 52, 62] 
-User.resourcify_filter("age::in::25,26,52,62")
+User.filter_by('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.

data/lib/resourcify.rb

@@ -1,7 +1,4 @@
 require "resourcify/resourcify"
 
 module Resourcify
-
-  class UndefinedError < StandardError
-  end
 end

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

@@ -6,17 +6,15 @@ module Controller::Actions
       authorize @record
 
       if @record.save
-        @response_data[:success] = true
-        @response_data[:data]    = @record
+        render json: @record
       else
-        @response_data[:error]   = {
-          type: 'validation',
-          errors: @record.errors.messages,
-          messages: @record.errors.full_messages
-        }
-      end
+        @error[:type]     = 'Validation'
+        @error[:message]  = 'Sorry, there were validation errors.'
+        @error[:errors]   = @record.errors.messages
+        @error[:messages] = @record.errors.full_messages
 
-      render json: @response_data
+        render json: @error
+      end
     end
   end
 end

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

@@ -4,17 +4,15 @@ module Controller::Actions
       authorize @record
 
       if @record.destroy
-        @response_data[:success] = true
-        @response_data[:data]    = @record
+        render json: @record
       else
-        @response_data[:error]   = {
-          type: 'other',
-          errors: @record.errors.messages,
-          messages: @record.errors.full_messages
-        }
-      end
+        @error[:type]     = 'Validation'
+        @error[:message]  = 'Sorry, there were validation errors.'
+        @error[:errors]   = @record.errors.messages
+        @error[:messages] = @record.errors.full_messages
 
-      render json: @response_data
+        render json: @error
+      end
     end
   end
 end

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

@@ -3,30 +3,20 @@ module Controller::Actions
     def index
       authorize _RC.new
 
-      # recs = policy_scope(_RC.all)
-      recs = policy_scope(_RC.includes(belongs_tos))
-      # recs = policy_scope(_RC.includes([]).all)
+      @records = policy_scope(_RC.includes(belongs_tos))
 
-      # 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])
+      # apply filter_by if present
+      if @records.respond_to? "filter_by"
+        @records = @records.filter_by(params.except(:controller, :action, :page, :size))
       end
 
-      recs_total = recs.count
+      response.headers['_meta_total'] = @records.count.to_s
 
       page = params[:page] || 1
-      size = params[:size] || 25
-      recs = recs.offset((page.to_i - 1) * size.to_i).limit(size)
+      size = params[:size] || 20
+      @records = @records.offset((page.to_i - 1) * size.to_i).limit(size)
 
-      if recs
-        @response_data[:success] = true
-        @response_data[:data]    = {
-          total: recs_total,
-          rows:  recs
-        }
-      end
-
-      render json: @response_data
+      render json: @records
     end
   end
 end

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

@@ -2,11 +2,8 @@ module Controller::Actions
   module Show
     def show
       authorize @record
-
-      @response_data[:success] = true
-      @response_data[:data]    = @record
-
-      render json: @response_data
+      
+      render json: @record
     end
   end
 end

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

@@ -4,17 +4,15 @@ module Controller::Actions
       authorize @record
 
       if @record.update(permitted_params)
-        @response_data[:success] = true
-        @response_data[:data]    = @record
+        render json: @record
       else
-        @response_data[:error]   = {
-          type: 'validation',
-          errors: @record.errors.messages,
-          messages: @record.errors.full_messages
-        }
-      end
+        @error[:type]     = 'Validation'
+        @error[:message]  = 'Sorry, there were validation errors.'
+        @error[:errors]   = @record.errors.messages
+        @error[:messages] = @record.errors.full_messages
 
-      render json: @response_data
+        render json: @error
+      end
     end
   end
 end

data/lib/resourcify/controller/base.rb

@@ -1,49 +1,30 @@
 module Controller
   module Base
-    require 'active_record/serializer_override'
-    ActiveRecord::Base.send(:include, ActiveRecord::SerializerOverride)
 
     include Pundit
 
     private
-      # Set JSON response data
-      def set_response_data
-        @response_data = { 
-          success: false,
-          data: { total: 0, rows: [] },
-          error: { type: '', errors: {}, messages: [] } 
+      # Set error response data
+      def set_error
+        @error = {
+          error: true,
+          type: 'Error',
+          message: 'Sorry, an error occurred.'
         }
-        # 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' ]
-      #   }
-        
-      #   render json: @response_data
-      # end
-   
       def record_not_found
-        @response_data[:success] = false
-        @response_data[:error]   = { 
-          type: 'record_not_found',
-          messages: [ 'Sorry, the record was not found.' ]
-        }
+        @error[:type]    = 'RecordNotFound'
+        @error[:message] = 'Sorry, the record was not found.'
         
-        render json: @response_data
+        render json: @error
       end
    
       def user_not_authorized
-        @response_data[:success] = false
-        @response_data[:error]   = { 
-          type: 'user_not_authorized',
-          messages: [ 'Sorry, you do not have the permission.' ]
-        }
+        @error[:type]    = 'UserNotAuthorized'
+        @error[:message] = 'Sorry, you do not have the permission.'
         
-        render json: @response_data
+        render json: @error
       end
 
       def _RC

data/lib/resourcify/model/filter_by.rb

@@ -0,0 +1,33 @@
+module Model
+  module FilterBy
+    def filter_by(filters = {})
+      records = self
+      column_names = self.column_names
+      simple_ops = { eq: '=', lt: '<', gt: '>', lte: '<=', gte: '>=' }
+      filters.select { |e| column_names.include?(e.split('.').first) }.each do |key, value|
+        field, operator = key.split('.')
+        operator = (operator)? operator.to_sym : :eq
+
+        if simple_ops[operator]
+          records = records.where("#{field} #{simple_ops[operator]} ?", value)
+        elsif operator == :ne
+          records = records.where.not("#{field} = ?", value)
+        elsif operator == :in
+          records = records.where("#{field} IN (?)", value.split(','))
+        elsif operator == :nin
+          records = records.where.not("#{field} IN (?)", value.split(','))
+        elsif operator == :like
+          if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+            records = records.where("#{field} ILIKE ?", "%#{value}%")
+          else
+            records = records.where("#{field} LIKE ?", "%#{value}%")
+          end
+        else
+          records = records.where("#{field} = ?", value)
+        end
+      end
+      
+      records
+    end
+  end
+end

data/lib/resourcify/resourcify.rb

@@ -1,6 +1,6 @@
-require "resourcify/model/resourcify_filter"
-require "resourcify/model/policy_class"
 require "resourcify/model/tpl"
+require "resourcify/model/filter_by"
+require "resourcify/model/policy_class"
 require "resourcify/controller/base"
 require "resourcify/controller/actions/index"
 require "resourcify/controller/actions/create"
@@ -21,15 +21,14 @@ module Resourcify
         def resourcified?() true end
         
         if self.ancestors.include?(ActiveRecord::Base)        # models
-          # Include filter and tag as filterable?
-          send :extend,  Model::ResourcifyFilter
-          def filterable?() true end
+          # Add tpl methods
+          send :extend,  Model::Tpl
 
           # Add policy_class method for pundit
           send :extend,  Model::PolicyClass
 
-          # Add tpl methods
-          send :extend,  Model::Tpl
+          # Include filter_by
+          send :extend,  Model::FilterBy
 
           # Include instance methods
           send :include, ModelInstanceMethods
@@ -40,14 +39,15 @@ module Resourcify
           # Respond to only json requests
           respond_to :json
           
-          # Set before_actions with methods located in base.rb
-          before_action :set_response_data
+          # Set error with set_error method located in base.rb
+          before_action :set_error
+
+          # Set record with set_record method located in base.rb
           before_action :set_record, only: [:show, :update, :destroy]
           
           # 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
 
           # 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.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resourcify
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Stephen Baidu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: active_model_serializers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +52,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Resoucify rails controllers and models
+description: Resourcify rails controllers and models
 email:
 - stephen@axoninfosystems.com
 executables: []
@@ -83,8 +69,8 @@ files:
 - lib/resourcify/controller/actions/show.rb
 - lib/resourcify/controller/actions/update.rb
 - lib/resourcify/controller/base.rb
+- lib/resourcify/model/filter_by.rb
 - lib/resourcify/model/policy_class.rb
-- lib/resourcify/model/resourcify_filter.rb
 - lib/resourcify/model/tpl.rb
 - lib/resourcify/resourcify.rb
 - lib/resourcify/version.rb
@@ -159,7 +145,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Resoucify rails controllers and models
+summary: Resourcify rails controllers and models
 test_files:
 - test/acts_as_resourcify_test.rb
 - test/dummy/app/assets/javascripts/application.js

data/lib/resourcify/model/resourcify_filter.rb

@@ -1,36 +0,0 @@
-module Model
-  module ResourcifyFilter
-    def resourcify_filter(filter_string)
-      records = self
-      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]) }
-
-      filter_string.each do |f|
-        next if f[:value].blank?
-
-        operand = f[:op].to_s.to_sym
-        
-        if simple_ops[operand]
-          f[:value] = f[:value].to_time if f[:type] == "date"
-          records = records.where("#{f[:name]} #{simple_ops[operand]} ?", f[:value])
-        elsif operand == :like
-          if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
-            records = records.where("#{f[:name]} ILIKE ?", "%#{f[:value]}%")
-          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 == :nin
-          records = records.where.not("#{f[:name]} IN (?)", f[:value].split(','))
-        end
-      end
-
-      records
-    end
-  end
-end