upframework 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01aa46c287d2a52c8fb32619543e90f984269b7186ad4f358665a84428618b4e
-  data.tar.gz: 9c310448029653953ee6fb7cda77ff9da622fd2e6e711db9eed4d4038bed1504
+  metadata.gz: b5dc4e38225f1091ec9ededb3e0403156c9806a95e0b23c22c03169a030fda1b
+  data.tar.gz: 68be508da24fb695aea2029b0ac78cf0dfb5408ee3d8c3997fb67caf921a7698
 SHA512:
-  metadata.gz: e0abf86d1dda28bda9e7224307af334f2a26c5e7da4065ca749b4fa6fccead7518a173e7e9cc4b7c17d6e08be0cc3589e866d49238f6b767cbc4118e80cc0783
-  data.tar.gz: 919879cab48a3800d1bacf8040a69d4961366cef98699362a28a407f4a34d1a89ff9160efcea3063f284711fafc28aa6a0ce5d64a6c86674e150e74ce12af250
+  metadata.gz: dc9e6fc1fa2df5b5f710a755bf5814e787d06f16c5792fcefaa8339940bdd73dc50eb72e25ca73ee7a2710085ce2472c65f15be4b89dcef13fdce09b61db6aae
+  data.tar.gz: 43d03176e6695273b2216b214d5730f59de656b19dba481fd44e1eb2da78216397db2e9dfeeb032bcb07a729d0ffdd788420080cb0f8720d9de25132344a93c6

data/app/controllers/upframework/api_extensions.rb

@@ -0,0 +1,30 @@
+module Upframework
+  module ApiExtensions
+    extend ::ActiveSupport::Concern
+
+    included do
+      include ::DeviseTokenAuth::Concerns::SetUserByToken
+      include ::Upframework::ErrorHandler
+      include ::Upframework::TransformParamKeys
+      include ::Upframework::ServiceEndpoint
+      include ::Upframework::RenderExtensions
+
+      # need to skip this on non-resource controller
+      # > skip_authorize_resource
+      authorize_resource unless: :devise_controller?
+
+      rescue_from CanCan::AccessDenied do |exception|
+        respond_to do |format|
+          format.json { render json: { success: false, error: exception.message }, status: :forbidden }
+          format.html { redirect_to main_app.root_url, alert: exception.message }
+        end
+      end
+
+      protected
+
+      def extra_params
+        [] # Override in specific controllers for custom params
+      end
+    end
+  end
+end

data/app/controllers/upframework/resources_controller.rb

@@ -0,0 +1,95 @@
+module Upframework
+  class ResourcesController < ApplicationController
+    before_action :set_base_resource
+
+    def show
+      base_resource
+
+      yield if block_given?
+      render_serialized base_resource
+    end
+
+    def update
+      if base_resource.update(base_resource_params)
+        yield if block_given?
+        render_serialized base_resource
+      else
+        render_errors base_resource.errors.full_messages
+      end
+    end
+
+    def index
+      base_resource
+
+      yield if block_given?
+      render_serialized base_resource, includes: params[:includes]
+    end
+
+    def create
+      if base_resource.save
+
+        yield if block_given?
+        render_serialized base_resource
+      else
+        render_errors base_resource.errors.full_messages
+      end
+    end
+
+    def destroy
+      base_resource.destroy
+      head :no_content
+    end
+
+    private
+
+    def base_resource
+      if params[:id]
+        instance_variable_get("@#{base_resource_name}")
+      else
+        instance_variable_get("@#{base_resource_name.pluralize}")
+      end
+    end
+
+    def set_base_resource
+      data =
+        if params[:id]
+          base_resource_class.find(params[:id])
+        elsif action_name == 'index'
+          base_resource_class.accessible_by(current_ability).where(base_resource_params || {})
+        elsif action_name == 'create'
+          base_resource_class.new(base_resource_params)
+        end
+
+      resource_name = %w[index create].include?(action_name) \
+        ? base_resource_name.pluralize \
+        : base_resource_name
+
+      instance_variable_set("@#{resource_name}", data) if data
+    end
+
+    def base_resource_params
+      base_name = base_resource_name
+
+      base_name = base_name.pluralize unless params.key?(base_name)
+
+      params.fetch(base_name).permit(*permitted_columns)
+    end
+
+    def permitted_columns
+      columns = base_resource_class.accessible_fields_by(accessors)
+      columns.concat(extra_params)
+    end
+
+    def accessors
+      current_user
+    end
+
+    def base_resource_name
+      controller_name.singularize
+    end
+
+    def base_resource_class
+      base_resource_name.classify.safe_constantize
+    end
+  end
+end

data/app/controllers/upframework/searches_controller.rb

@@ -1,11 +1,7 @@
 module Upframework
-  class SearchesController < Upframework::ApiController
+  class SearchesController < ApplicationController
     skip_authorize_resource
 
-    authorize_resource class: :search
-
-    skip_before_action :set_base_resource
-
     def index
       args = { current_ability: current_ability, current_user: current_user }
       args.merge!(permitted_params)

data/app/services/upframework/base_service.rb

@@ -14,7 +14,7 @@ module Upframework
 
       self.class.send(:attr_reader, *attributes.keys)
 
-      #TODO: Remove. this should be done on the child class.
+      #TODO: Remove. This should be handled on the child class.
       attributes.each do |key, value|
         instance_variable_set("@#{key}", value)
       end

data/config/routes.rb

@@ -1,2 +1,3 @@
 Upframework::Engine.routes.draw do
+  get "search", to: "searches#index"
 end

data/lib/upframework/engine.rb

@@ -1,5 +1,9 @@
 module Upframework
   class Engine < ::Rails::Engine
     isolate_namespace Upframework
+
+    config.to_prepare do
+      ApplicationController.include ::Upframework::ApiExtensions
+    end
   end
 end

data/lib/upframework/version.rb

@@ -1,3 +1,3 @@
 module Upframework
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/upframework.rb

@@ -5,4 +5,3 @@ module Upframework
 end
 
 require "upframework/services/routes"
-require "upframework/searches/routes"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upframework
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - jude_cali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,6 +30,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: Rails framework extensions
 email:
 - jcalimbas@fullscale.io
@@ -46,7 +74,8 @@ files:
 - app/controllers/concerns/upframework/error_handler.rb
 - app/controllers/concerns/upframework/render_extensions.rb
 - app/controllers/concerns/upframework/transform_param_keys.rb
-- app/controllers/upframework/api_controller.rb
+- app/controllers/upframework/api_extensions.rb
+- app/controllers/upframework/resources_controller.rb
 - app/controllers/upframework/searches_controller.rb
 - app/helpers/upframework/application_helper.rb
 - app/jobs/upframework/application_job.rb
@@ -60,7 +89,6 @@ files:
 - lib/tasks/upframework_tasks.rake
 - lib/upframework.rb
 - lib/upframework/engine.rb
-- lib/upframework/searches/routes.rb
 - lib/upframework/services/routes.rb
 - lib/upframework/version.rb
 homepage: https://gitlab.com/disruptors/upframework

data/app/controllers/upframework/api_controller.rb

@@ -1,33 +0,0 @@
-module Upframework
-  class ApiController < ::ApplicationController
-    include ::DeviseTokenAuth::Concerns::SetUserByToken
-    include ::Upframework::ErrorHandler
-    include ::Upframework::TransformParamKeys
-    include ::Upframework::CrudEndpoint
-    include ::Upframework::ServiceEndpoint
-    include ::Upframework::RenderExtensions
-
-    before_action :authenticate!
-
-    # need to skip this on non-resource controller
-    # > skip_authorize_resource
-    authorize_resource
-
-    rescue_from CanCan::AccessDenied do |exception|
-      respond_to do |format|
-        format.json { render json: { success: false, error: exception.message }, status: :forbidden }
-        format.html { redirect_to main_app.root_url, alert: exception.message }
-      end
-    end
-
-    def authenticate!
-      super || authenticate_user!
-    end
-
-    protected
-
-    def extra_params
-      [] # Override in specific controllers for custom params
-    end
-  end
-end

data/lib/upframework/searches/routes.rb

@@ -1,14 +0,0 @@
-module Upframework
-  module Searches
-    module Routes
-      def self.load(namespace: nil, **options)
-        Rails.application.routes.draw do
-          # Create a route for searches
-          # ex.
-          # GET searches
-          get [namespace, "search"].compact.join("/"), to: "searches#index"
-        end
-      end
-    end
-  end
-end