upframework 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03201d4216dd3b35c2fc0868ab19a0c11f3b98f5e50a3e139934011732604073
+  data.tar.gz: 90775fb0f00abfae7d19b8b7ee132c456a7dac32ab7de9e26f89799bce1d7b08
+SHA512:
+  metadata.gz: be618352e1e443df2da7bedbe9b91d54db1acf0d98dbb42f7858568102480a0a847b706644368b840771bd3b6e116469d3d500b766b686ae42228ea5aa8b7e71
+  data.tar.gz: 2c8395e1c8ef62b1ca8e58b3c6247a2742068cea4f2c3051e189b2a3e1517528d3f9522bcf90be229cb90d64297e0a484d65db86777c3d3816d164fb59946c80

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 jude_cali
+
+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.md

@@ -0,0 +1,28 @@
+# Upframework
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'upframework'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install upframework
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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    = 'Upframework'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/upframework_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/upframework .css

data/app/assets/stylesheets/upframework/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/concerns/upframework/crud_extensions.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Upframework::CrudExtensions
+  extend ::ActiveSupport::Concern
+
+  included do
+    before_action :set_base_resource
+  end
+
+  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

data/app/controllers/concerns/upframework/error_handler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Upframework::ErrorHandler
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from StandardError do |e|
+      handle_exception(e)
+    end
+
+    protected
+
+    def handle_exception(error)
+      raise error if Rails.env.development?
+
+      ExceptionNotifier.notify_exception(error, env: request.env)
+
+      error_info = {
+        error: 'Internal Server Error',
+        exception: "#{error.class.name} : #{error.message}"
+      }
+
+      render json: error_info, status: :internal_server_error
+    end
+  end
+end

data/app/controllers/concerns/upframework/render_extensions.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Upframework
+  module RenderExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      # Args
+      # resource      => instance of model
+      # include       => include relations on response
+      # format        => format can be :full(returns all default) or :minimal(returns only ids an types)
+      # compound_opts => options, e.g: meta or links
+      # opts          => extra options from render
+      def render_serialized(resource, includes: [], format: :full, compound_opts: {}, **opts)
+        render json: serialize_resource(resource, includes, format, compound_opts), **opts
+      end
+
+      # Args
+      # resource      => instance of model
+      # channel       => channel on where to broadcast response. If not provided will use the resource
+      # include       => include relations on response
+      # format        => format can be :full(returns all default) or :minimal(returns only ids an types)
+      # compound_opts => options, e.g: meta or links
+      # opts          => extra options from render
+      def broadcast_serialized(channel, resource:, event:, includes: [], format: :full, compound_opts: {})
+        includes << :events
+        resource.add_event(event, creator: current_member)
+
+        channel_klass = "::#{channel.class.name}Channel".constantize
+        channel_klass.broadcast_to(channel, serialize_resource(resource, includes, format, compound_opts))
+      end
+
+      def render_errors(error_messages, status: :unprocessable_entity)
+        render json: { errors: error_messages }, status: status
+      end
+
+      protected
+
+      def serialize_resource(resource, includes, format, compound_opts)
+        resource_klass = resource.class.name
+        if resource_klass == 'ActiveRecord::Relation'
+          resource_klass = resource.klass.name
+        end
+        # TODO: support empty arrays
+        resource_klass = resource.first.class.name if resource.is_a? Array
+
+        serializer_klass = "#{resource_klass}Serializer".constantize
+
+        relations = serializer_klass.default_includes
+        relations.concat(Array(includes).map(&:to_sym)) if includes
+
+        serializer_klass.new(resource, include: relations, format: format, current_controller: self, **compound_opts).serializable_hash
+      end
+    end
+  end
+end

data/app/controllers/concerns/upframework/transform_param_keys.rb

@@ -0,0 +1,21 @@
+module Upframework::TransformParamKeys
+  extend ActiveSupport::Concern
+
+  included do
+    prepend_before_action :underscore_params!
+
+    def underscore_params!
+      request.parameters.deep_transform_keys!(&:underscore)
+
+      resource_name  = controller_name.singularize
+      resource_klass = resource_name.classify.safe_constantize
+      attributes     = resource_klass ? resource_klass.column_names.map(&:to_sym) : []
+
+      attributes.concat(extra_params) if respond_to?(:extra_params, true)
+
+      if resource_klass && params.key?(resource_name) && params[resource_name].class != Array
+        params[resource_name].merge! params.permit(*attributes)
+      end
+    end
+  end
+end

data/app/controllers/upframework/api_controller.rb

@@ -0,0 +1,33 @@
+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

data/app/helpers/upframework/application_helper.rb

@@ -0,0 +1,4 @@
+module Upframework
+  module ApplicationHelper
+  end
+end

data/app/jobs/upframework/application_job.rb

@@ -0,0 +1,4 @@
+module Upframework
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/upframework/application_mailer.rb

@@ -0,0 +1,6 @@
+module Upframework
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/upframework/application_record.rb

@@ -0,0 +1,5 @@
+module Upframework
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/services/concerns/service_action_controller.rb

@@ -0,0 +1,29 @@
+module Upframework
+  module ServiceActionController
+    extend ::ActiveSupport::Concern
+
+    included do
+      def service
+        service = service_class.run(**params.to_unsafe_h.symbolize_keys)
+
+        if service.success?
+          render_serialized service.result
+        else
+          render_errors service.errors
+        end
+      end
+
+      private
+
+      def service_class
+        base_resource_name = controller_name.classify.pluralize
+        service_name = params[:service_name]&.classify
+
+        service_class = "::#{base_resource_name}::#{service_name}Service".safe_constantize
+        raise ActionController::RoutingError.new('Not Found') if service_class.nil?
+
+        service_class
+      end
+    end
+  end
+end

data/app/views/layouts/upframework/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Upframework</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "upframework/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Upframework::Engine.routes.draw do
+  ::Upframework::Services::Routes.load
+end

data/lib/tasks/upframework_tasks.rake

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

data/lib/upframework/engine.rb

@@ -0,0 +1,5 @@
+module Upframework
+  class Engine < ::Rails::Engine
+    isolate_namespace Upframework
+  end
+end

data/lib/upframework/services/routes.rb

@@ -0,0 +1,19 @@
+module Upframework
+  module Services
+    module Routes
+      def self.load
+        Rails.application.routes.draw do
+          source_path = Rails.root.join('app', 'services')
+
+          namespace :api, defaults: { format: 'json' } 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
+              post "#{resource}/service/:service_name", to: "#{resource}#service"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/upframework/version.rb

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

data/lib/upframework.rb

@@ -0,0 +1,7 @@
+require "upframework/engine"
+
+module Upframework
+  # Your code goes here...
+end
+
+require "upframework/services/routes"

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: upframework
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jude_cali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+description: Rails framework extensions
+email:
+- jcalimbas@fullscale.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/upframework_manifest.js
+- app/assets/stylesheets/upframework/application.css
+- app/controllers/concerns/upframework/crud_extensions.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/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/views/layouts/upframework/application.html.erb
+- config/routes.rb
+- lib/tasks/upframework_tasks.rake
+- lib/upframework.rb
+- lib/upframework/engine.rb
+- lib/upframework/services/routes.rb
+- lib/upframework/version.rb
+homepage: https://gitlab.com/disruptors/upframework
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rails framework extensions
+test_files: []