resourcify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7870d7f333dea432afeed996936a2cb731f3632
+  data.tar.gz: 147f8c9638fc801a08ba8bb01fbadfdbbbab4401
+SHA512:
+  metadata.gz: 3dd27cdb2437bb6124174683b42b9a9cbc23e1dc777e5231c29df09ed354dd234114fc012f2eeb2624a635495ff73c6dd6b454c99233d8ad7a5b4a68f1c2d372
+  data.tar.gz: e68314c16e70de51aee74180094bd41f36c4c7473329a90b920d7293d9ea50b6da234392e637012b9d16192b91b556bd880ce311651f5fcfc0126a7da7f1ede5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

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

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Resourcify'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/resourcify.rb

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

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

@@ -0,0 +1,22 @@
+module Controller::Actions
+  module Create
+    def create
+      @record = _RC.new(permitted_params)
+
+      authorize @record
+
+      if @record.save
+        @response_data[:success] = true
+        @response_data[:data]    = @record
+      else
+        @response_data[:error]   = {
+          type: 'validation',
+          errors: @record.errors.messages,
+          messages: @record.errors.full_messages
+        }
+      end
+
+      render json: @response_data
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Controller::Actions
+  module Destroy
+    def destroy
+      authorize @record
+
+      if @record.destroy
+        @response_data[:success] = true
+        @response_data[:data]    = @record
+      else
+        @response_data[:error]   = {
+          type: 'other',
+          errors: @record.errors.messages,
+          messages: @record.errors.full_messages
+        }
+      end
+
+      render json: @response_data
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Controller::Actions
+  module Index
+    def index
+      authorize _RC.new
+
+      recs = policy_scope(_RC.all)
+
+      # apply filter if query is present
+      recs = recs.filter(params[:query]) if params[:query].present?
+
+      recs_total = recs.count
+
+      page = params[:page] || 1
+      size = params[:size] || 25
+      recs = recs.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
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Controller::Actions
+  module Show
+    def show
+      authorize @record
+
+      @response_data[:success] = true
+      @response_data[:data]    = @record
+
+      render json: @response_data
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Controller::Actions
+  module Update
+    def update
+      authorize @record
+
+      if @record.update(permitted_params)
+        @response_data[:success] = true
+        @response_data[:data]    = @record
+      else
+        @response_data[:error]   = {
+          type: 'validation',
+          errors: @record.errors.messages,
+          messages: @record.errors.full_messages
+        }
+      end
+
+      render json: @response_data
+    end
+  end
+end

data/lib/resourcify/controller/base.rb

@@ -0,0 +1,72 @@
+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: [] } 
+        }
+        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.' ]
+        }
+        
+        render json: @response_data
+      end
+   
+      def user_not_authorized
+        @response_data[:success] = false
+        @response_data[:error]   = { 
+          type: 'user_not_authorized',
+          messages: [ 'Sorry, you do not have the permission.' ]
+        }
+        
+        render json: @response_data
+      end
+
+      def _RC
+        controller_name.classify.constantize
+      end
+
+      # Use callbacks to share common setup or constraints between actions.
+      def set_record
+        @record = _RC.find(params[:id])
+      end
+
+      # 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
+  end
+end

data/lib/resourcify/model/filter.rb

@@ -0,0 +1,34 @@
+module Model
+  module Filter
+    def filter(filters)
+      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]) }
+
+      filters.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 == :in
+          records = records.where("#{f[:name]} IN (?)", f[:value].split(','))
+        elsif operand == :notin
+          records = records.where.not("#{f[:name]} IN (?)", f[:value].split(','))
+        end
+      end
+
+      records
+    end
+  end
+end

data/lib/resourcify/model/policy_class.rb

@@ -0,0 +1,9 @@
+module Model
+  module PolicyClass
+    def policy_class
+      _p = "#{self.name}Policy" and _p.constantize and return _p
+    rescue
+      "ApiPolicy"
+    end
+  end
+end

data/lib/resourcify/resourcify.rb

@@ -0,0 +1,70 @@
+require "resourcify/model/filter"
+require "resourcify/model/policy_class"
+require "resourcify/controller/base"
+require "resourcify/controller/actions/index"
+require "resourcify/controller/actions/create"
+require "resourcify/controller/actions/show"
+require "resourcify/controller/actions/update"
+require "resourcify/controller/actions/destroy"
+
+module Resourcify
+  module Resourcify
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def resourcify(options = {})
+        # Class method to tag classes using this plugin
+        def resourcified?() true end
+        
+        if self.ancestors.include?(ActiveRecord::Base)        # models
+          # Include filter and tag as filterable?
+          send :extend,  Model::Filter
+          def filterable?() true end
+
+          # Add policy_class method for pundit
+          send :extend,  Model::PolicyClass
+
+          # Include instance methods
+          send :include, ModelInstanceMethods
+        elsif self.ancestors.include?(ActionController::Base) # controllers
+          # Turn off layout
+          layout false
+
+          # Respond to only json requests
+          respond_to :json
+          
+          # Set before_actions with methods located in base.rb
+          before_action :set_response_data
+          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
+
+          # Include RESTful actions
+          send :include, Controller::Actions::Index
+          send :include, Controller::Actions::Create
+          send :include, Controller::Actions::Show
+          send :include, Controller::Actions::Update
+          send :include, Controller::Actions::Destroy
+        end
+      end
+    end
+
+    module ModelInstanceMethods
+      def policy_class
+        self.class.policy_class
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Resourcify::Resourcify
+ActionController::Base.send :include, Resourcify::Resourcify

data/lib/resourcify/version.rb

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

data/lib/tasks/resourcify_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :resourcify do
+#   # Task goes here
+# end

data/test/acts_as_resourcify_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class ActsAsResourcifyTest < ActiveSupport::TestCase
+
+  def test_some_model_resourcified_should_be_true
+    assert_equal true, Foo.new.resourcified?
+  end
+
+  def test_pundit_api_policy_class_name_on_model_without_policy_class
+    assert_equal "ApiPolicy", Foo.new.policy_class
+  end
+
+  def test_pundit_custom_policy_class_name_on_model_with_policy_class
+    assert_equal "FooBarPolicy", FooBar.new.policy_class
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks