upframework 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03201d4216dd3b35c2fc0868ab19a0c11f3b98f5e50a3e139934011732604073
-  data.tar.gz: 90775fb0f00abfae7d19b8b7ee132c456a7dac32ab7de9e26f89799bce1d7b08
+  metadata.gz: 1acaf495ed6f2835c25eae1905515573ee647802879f43212ad934f6f3a4a3fb
+  data.tar.gz: 670163801f3ead631d142ef5840970833f48c069ba055ed19369a8a9e08fecc7
 SHA512:
-  metadata.gz: be618352e1e443df2da7bedbe9b91d54db1acf0d98dbb42f7858568102480a0a847b706644368b840771bd3b6e116469d3d500b766b686ae42228ea5aa8b7e71
-  data.tar.gz: 2c8395e1c8ef62b1ca8e58b3c6247a2742068cea4f2c3051e189b2a3e1517528d3f9522bcf90be229cb90d64297e0a484d65db86777c3d3816d164fb59946c80
+  metadata.gz: e6c44c39aae828c7b62cf450d47fe2d61200cc2e2e48af25c80abd6d3f631c060518b7fc15a64d912a2e3c386487a3f1b32edc6cef5bd808e22e443d5f7c863c
+  data.tar.gz: fa64458e28228ee45cac5d922ab848962dc313f8fb6481ffeecc1bd2d549512a73a96c6946922c65ffd57ddab6b43ab86db90120fe79440376fd3d0995f32d3e

data/README.md

@@ -1,8 +1,42 @@
 # Upframework
-Short description and motivation.
+Add features on top of Rails, Especially for APIs. This was created to make structural code reusable to other projects (not solving the same problem all over again). And to make the main application less bloated and only contain domain specific code as much as possible.
 
-## Usage
-How to use my plugin.
+#### The following features are available.
+- Creates (create, read, update, destroy) action methods for resources.
+- Has render helpers for API or socket responses. ex. Converting models to its designated serializer.
+- Converts snake case request params (from js standard) to underscore params (ruby standard)
+- Searches layer under app/searches. Usually used for form searches.
+- Services layer under app/services. For single responsibility domain-specific logic code.
+- Exception notifier and API error response handler.
+
+##  Basic Usage
+####Controllers
+```ruby
+#app/controllers
+class ProjectsController < Upframework::ResourcesController
+end
+```
+
+####Searches
+```ruby
+#app/searches
+class ProjectSearch < Upframework::BaseSearch
+end
+```
+
+####Services
+```ruby
+#app/services
+class  Project::SubmitService < Upframework::BaseService
+end
+```
+
+####Routes
+app/services
+```ruby
+#config/routes
+mount Upframework::Engine => /path
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/controllers/concerns/upframework/{crud_extensions.rb → crud_endpoint.rb}

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
-
-module Upframework::CrudExtensions
+module Upframework::CrudEndpoint
   extend ::ActiveSupport::Concern
 
   included do

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

@@ -0,0 +1,26 @@
+module Upframework
+  class SearchesController < ApplicationController
+    skip_authorize_resource
+
+    def index
+      args = { current_ability: current_ability, current_user: current_user }
+      args.merge!(permitted_params)
+
+      resource_scope = search_class.run(args).result
+      render_serialized resource_scope
+    end
+
+    private
+
+    def search_class
+      "#{params[:resource].classify}Search".constantize
+    end
+
+    def permitted_params
+      excluded_keys  = %w[resource format controller action search]
+      permitted_keys = params.keys - excluded_keys
+
+      params.slice(*permitted_keys).permit(permitted_keys)
+    end
+  end
+end

data/app/searches/upframework/base_search.rb

@@ -0,0 +1,30 @@
+class Upframework::BaseSearch < Upframework::BaseService
+  DEFAULT_PAGE     = 1
+  DEFAULT_PER_PAGE = 12
+
+  def result
+    @model_scope
+  end
+
+  def query(field)
+    @model_scope = yield if field.present?
+  end
+
+  def paginate_scope
+    return if @model_scope.nil?
+
+    @model_scope = @model_scope.
+      page(@page || DEFAULT_PAGE).
+      per(@per_page || DEFAULT_PER_PAGE).
+      order(created_at: :desc)
+  end
+
+  module ExecuteWrapper
+    def execute
+      super
+      paginate_scope
+    end
+  end
+
+  include ExecuteWrapper
+end

data/app/services/concerns/{service_action_controller.rb → upframework/service_endpoint.rb}

@@ -1,5 +1,5 @@
 module Upframework
-  module ServiceActionController
+  module ServiceEndpoint
     extend ::ActiveSupport::Concern
 
     included do

data/app/services/upframework/base_service.rb

@@ -0,0 +1,52 @@
+module Upframework
+  class BaseService
+    attr_reader :errors
+
+    class << self
+      def run(attributes = {})
+        attributes = Hash[attributes.to_h.map { |k, v| [k.to_sym, v] }]
+        new(**attributes).tap(&:execute)
+      end
+    end
+
+    def initialize(**attributes)
+      @errors = []
+
+      self.class.send(:attr_reader, *attributes.keys)
+
+      #TODO: Remove. This should be handled on the child class.
+      attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      post_initialize(**attributes)
+    end
+
+    def post_initialize(**attributes)
+    end
+
+    def execute
+    end
+
+    def result
+    end
+
+    def success?
+      @errors.blank?
+    end
+
+    def error?
+      @errors.present?
+    end
+
+    def error_messages
+      @errors.join('. ')
+    end
+
+    protected
+
+    def add_error(error)
+      @errors << error
+    end
+  end
+end

data/config/routes.rb

@@ -1,3 +1,3 @@
 Upframework::Engine.routes.draw do
-  ::Upframework::Services::Routes.load
+  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/services/routes.rb

@@ -1,17 +1,26 @@
 module Upframework
   module Services
     module Routes
-      def self.load
+      def self.load(namespace: nil, **options)
+        scope_name = namespace
+
         Rails.application.routes.draw do
           source_path = Rails.root.join('app', 'services')
 
-          namespace :api, defaults: { format: 'json' } do
+          service_routes = proc do
             Dir.glob("#{source_path}/*/").map{ |e| File.basename e }.each do |resource|
-              #TODO: check resource exists in controller
-              # config to exclude some services in the routes
+              # Create a post route for services
+              # ex.
+              # POST users/service/my_custom_service
               post "#{resource}/service/:service_name", to: "#{resource}#service"
             end
           end
+
+          if scope_name
+            namespace scope_name, defaults: { format: :json }, &service_routes
+          else
+            service_routes.call
+          end
         end
       end
     end

data/lib/upframework/version.rb

@@ -1,3 +1,3 @@
 module Upframework
-  VERSION = '0.1.0'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upframework
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - jude_cali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-05-26 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
@@ -42,16 +70,20 @@ files:
 - Rakefile
 - app/assets/config/upframework_manifest.js
 - app/assets/stylesheets/upframework/application.css
-- app/controllers/concerns/upframework/crud_extensions.rb
+- app/controllers/concerns/upframework/crud_endpoint.rb
 - 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
 - app/mailers/upframework/application_mailer.rb
 - app/models/upframework/application_record.rb
-- app/services/concerns/service_action_controller.rb
+- app/searches/upframework/base_search.rb
+- app/services/concerns/upframework/service_endpoint.rb
+- app/services/upframework/base_service.rb
 - app/views/layouts/upframework/application.html.erb
 - config/routes.rb
 - lib/tasks/upframework_tasks.rake

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::CrudExtensions
-    include ::Upframework::RenderExtensions
-    include ::Upframework::ServiceActionController
-
-    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