upframework 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05f3cb12631eb6061d0d6765ac7fd2807ba477044ba3325dc3c8b94f56988fd0
-  data.tar.gz: 9d1372ba1123335dba56508767e4c96e1a858008bfb1b579c3040bdb7c5d79fe
+  metadata.gz: 01aa46c287d2a52c8fb32619543e90f984269b7186ad4f358665a84428618b4e
+  data.tar.gz: 9c310448029653953ee6fb7cda77ff9da622fd2e6e711db9eed4d4038bed1504
 SHA512:
-  metadata.gz: 8c7161d7ab8b9458f410f87a200f4aa48cfc0200db586a0950e2eb2e9de88e7d380be8d085b0ff9899a80b1b0b3fd44b5ee8470239373e5d96ec0b903325300d
-  data.tar.gz: 33d53469918bc45501702d0c12fdc556c85fd770f7218387180b67f65afb235457e16fd2e18108d6f1c45cbf79553ac37b12985f416c50efee4f0e7441030c41
+  metadata.gz: e0abf86d1dda28bda9e7224307af334f2a26c5e7da4065ca749b4fa6fccead7518a173e7e9cc4b7c17d6e08be0cc3589e866d49238f6b767cbc4118e80cc0783
+  data.tar.gz: 919879cab48a3800d1bacf8040a69d4961366cef98699362a28a407f4a34d1a89ff9160efcea3063f284711fafc28aa6a0ce5d64a6c86674e150e74ce12af250

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

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

data/app/controllers/upframework/api_controller.rb

@@ -3,9 +3,9 @@ module Upframework
     include ::DeviseTokenAuth::Concerns::SetUserByToken
     include ::Upframework::ErrorHandler
     include ::Upframework::TransformParamKeys
-    include ::Upframework::CrudExtensions
+    include ::Upframework::CrudEndpoint
+    include ::Upframework::ServiceEndpoint
     include ::Upframework::RenderExtensions
-    include ::Upframework::ServiceActionController
 
     before_action :authenticate!
 

data/app/controllers/upframework/searches_controller.rb

@@ -0,0 +1,30 @@
+module Upframework
+  class SearchesController < Upframework::ApiController
+    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)
+
+      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,23 @@
+class Upframework::BaseSearch < Upframework::BaseService
+  DEFAULT_PAGE     = 1
+  DEFAULT_PER_PAGE = 12
+
+  def result
+    @model_scope
+  end
+
+  def query(field)
+    @model_scope = yield if present_value?(field)
+  end
+
+  def paginate_scope
+    @model_scope = @model_scope.
+      page(@page || DEFAULT_PAGE).
+      per(@per_page || DEFAULT_PER_PAGE).
+      order(created_at: :desc)
+  end
+
+  def present_value?(field)
+    instance_variable_get("@#{field}").present?
+  end
+end

data/app/services/concerns/upframework/{service_action_controller.rb → 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 done 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,2 @@
 Upframework::Engine.routes.draw do
-  ::Upframework::Services::Routes.load
 end

data/lib/upframework/searches/routes.rb

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

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.1'
+  VERSION = '0.2.0'
 end

data/lib/upframework.rb

@@ -5,3 +5,4 @@ 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.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - jude_cali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,21 +42,25 @@ 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/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/upframework/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
 - 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