carbonyte 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f88398d2111a4b6f2423dd798eb0d629fb7e9f78b54d49eea3b6fe28d60590ef
+  data.tar.gz: ddf8b9fe408fa7f2fa8b85bdc7157db5bfd07aa17fb165d68c76c7e7148b6d6e
+SHA512:
+  metadata.gz: 7875ec1d6d77312e7d7a0ad4f9f2db33aae0db243ca0d4d9edcb55ec4d90816d94027821d6e7abeb9a06757064da42a84fccb9becb8097cbea19fe0f9047733c
+  data.tar.gz: 5ff2e50321cb295d0726465488d2094152c30c63849c5af32bfb2a4b17dd70bb573a595d53d0d9a2306b42a54ff4c5ce8d371602728997515cc84df2e8ef55ab

data/README.md

@@ -0,0 +1,22 @@
+# Carbonyte
+Build Microservices-oriented Architectures with ease.
+
+## Installation
+Add this line to your microservice Gemfile:
+
+```ruby
+gem 'carbonyte'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+TBD
+
+## Contributing
+Before pushing:
+* Run `rubocop` to show code styles offences
+* Run `inch` to show documentation state

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+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    = 'Carbonyte'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/carbonyte/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte base class for all controllers
+  class ApplicationController < ActionController::API
+  end
+end

data/app/controllers/carbonyte/concerns/rescuable.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # The Rescuable concern rescues controllers from bubbling up the most common exceptions
+  # and provides a uniformed response body in case of such errors.
+  # @see https://jsonapi.org/format/#error-objects
+  module Rescuable
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from Pundit::NotAuthorizedError, with: :unauthorized
+      rescue_from Interactor::Failure, with: :interactor_failure
+      rescue_from ActiveRecord::RecordInvalid, with: :record_invalid
+    end
+
+    private
+
+    def serialized_errors(payload)
+      payload = [payload] unless payload.is_a?(Enumerable)
+      payload.to_json
+    end
+
+    def unauthorized(exc)
+      payload = {
+        code: exc.class.name,
+        source: { policy: exc.policy.class.name },
+        title: 'Not Authorized By Policy',
+        detail: exc.message
+      }
+      render json: serialized_errors(payload), status: :unauthorized
+    end
+
+    def interactor_failure(exc)
+      payload = {
+        code: exc.class.name,
+        source: { interactor: exc.context._called.last.class.name },
+        title: 'Interactor Failure',
+        detail: exc.context.error
+      }
+      render json: serialized_errors(payload), status: :unprocessable_entity
+    end
+
+    def record_invalid(exc)
+      payload = errors_for_record(exc.record, exc.class.name).flatten
+      render json: serialized_errors(payload), status: :unprocessable_entity
+    end
+
+    def errors_for_record(record, code)
+      record.messages.map do |field, errors|
+        errors.map do |error_message|
+          {
+            code: code,
+            source: { pointer: "attributes/#{field}" },
+            title: 'Invalid Field ',
+            detail: error_message
+          }
+        end
+      end
+    end
+  end
+end

data/app/interactors/carbonyte/application_interactor.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte base class for all interactors
+  class ApplicationInteractor
+    include Interactor
+  end
+end

data/app/interactors/carbonyte/finders/application_finder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte module for Finders.
+  # Finders are Interactors whose main task is to build a query
+  module Finders
+    # Carbonyte base class for all finders interactors.
+    # Finders are used to build queries based on parameters
+    class ApplicationFinder < ApplicationInteractor
+      # Default limit for pagination
+      DEFAULT_LIMIT = 25
+
+      # Starts building the query (:scope)
+      #
+      # @option context:params [Hash] the parameters used to build the query scope
+      # @option context:params:include [String] a comma-separated list of relations to include
+      # @option context:params:sort [String] a comma-separated list of columns to use to sort.
+      #   If the "-" prefix is provided then the sort will be descending, ascending otherwise
+      # @option context:params:limit [Integer] the number of items per page.
+      #   Defaults to +DEFAULT_LIMIT+
+      # @option context:params:page [Integer] the page to load. Defaults to 1
+      def call
+        include_relations if context.params[:include].present?
+        sort if context.params[:sort].present?
+        paginate
+      end
+
+      protected
+
+      # Returns true if the provided relation can be included
+      # @param _rel [Symbol] the relation to include
+      def can_include?(_rel)
+        false
+      end
+
+      private
+
+      def include_relations
+        context.params[:include].split(',').each do |relation|
+          next unless can_include?(relation)
+
+          context.scope = context.scope.includes(relation)
+        end
+      end
+
+      def sort_properties
+        context.params[:sort].split(',')
+      end
+
+      def sort_exp(prop)
+        return prop unless prop.start_with?('-')
+
+        { prop[1..] => :desc }
+      end
+
+      def sort
+        sort_properties.each do |prop|
+          context.scope = context.scope.order(sort_exp(prop))
+        end
+      end
+
+      def paginate
+        context.scope = context.scope.limit(context.params[:limit] || DEFAULT_LIMIT)
+        context.scope = context.scope.page(context.params[:page] || 1)
+      end
+    end
+  end
+end

data/app/models/carbonyte/application_record.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte base class for all models
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/serializers/carbonyte/application_serializer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte base class for all serializers
+  class ApplicationSerializer
+    include JSONAPI::Serializer
+
+    # Initializes the serializer.
+    # @param resource [Object] the resource(s) to serialize
+    # @param options [Hash] the serializer options.
+    # @see https://github.com/jsonapi-serializer/jsonapi-serializer/blob/master/README.md
+    def initialize(resource, options = {})
+      parse_options(resource, options)
+      super
+    end
+
+    private
+
+    # Adds additional options automatically based on the resource
+    def parse_options(resource, options)
+      resource_options = if resource.is_a?(Enumerable)
+                           options_for_list(resource)
+                         else
+                           options_for_object(resource)
+                         end
+      options.merge!(resource_options)
+    end
+
+    # For collections, the :meta option will be added to support pagination
+    def options_for_list(list)
+      options = {}
+      options[:meta] = { total: list.total_entries } if list.respond_to?(:total_entries)
+      options
+    end
+
+    def options_for_object(_resource)
+      {}
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Carbonyte::Engine.routes.draw do
+end

data/lib/carbonyte.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'carbonyte/engine'
+
+# Main Carbonyte module
+module Carbonyte
+end

data/lib/carbonyte/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte Engine
+  class Engine < ::Rails::Engine
+    isolate_namespace Carbonyte
+  end
+end

data/lib/carbonyte/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte version
+  VERSION = '0.1.0'
+end

data/lib/tasks/carbonyte_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :carbonyte do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: carbonyte
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iMacTia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: interactor-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Carbonyte is the core of great Microservices-oriented Architectures.
+email:
+- giuffrida.mattia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/carbonyte/application_controller.rb
+- app/controllers/carbonyte/concerns/rescuable.rb
+- app/interactors/carbonyte/application_interactor.rb
+- app/interactors/carbonyte/finders/application_finder.rb
+- app/models/carbonyte/application_record.rb
+- app/serializers/carbonyte/application_serializer.rb
+- config/routes.rb
+- lib/carbonyte.rb
+- lib/carbonyte/engine.rb
+- lib/carbonyte/version.rb
+- lib/tasks/carbonyte_tasks.rake
+homepage: https://github.com/iMacTia/carbonyte
+licenses:
+- Copyright
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Build Microservices-oriented Architectures with ease
+test_files: []