carbonyte 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88398d2111a4b6f2423dd798eb0d629fb7e9f78b54d49eea3b6fe28d60590ef
-  data.tar.gz: ddf8b9fe408fa7f2fa8b85bdc7157db5bfd07aa17fb165d68c76c7e7148b6d6e
+  metadata.gz: e0182bc2a05957e2aa33ff9d29b1bef6e80e0bf46e043cab50ea83088a8b9979
+  data.tar.gz: 9975a93ce713a8a3dad2a0493905a75f257f9f2d36403ece1e145e0ed03896c3
 SHA512:
-  metadata.gz: 7875ec1d6d77312e7d7a0ad4f9f2db33aae0db243ca0d4d9edcb55ec4d90816d94027821d6e7abeb9a06757064da42a84fccb9becb8097cbea19fe0f9047733c
-  data.tar.gz: 5ff2e50321cb295d0726465488d2094152c30c63849c5af32bfb2a4b17dd70bb573a595d53d0d9a2306b42a54ff4c5ce8d371602728997515cc84df2e8ef55ab
+  metadata.gz: 4546a5fb7554b04c2cc1f38657d315c157611ee4cd16af526443c3d24d8216976392950016ce144ab7dc5eefb9949ea0070c4031c5dadea3a8dcd1fcfa10c61b
+  data.tar.gz: f9808c42d3dcea7d9d293ce3481dfd79b5215218587cedba4b62e114843cbc268bc793cc2b0a2f28e2d5a96e40e90ed2c8908601a277911c6e4d27cd433b08c6

data/README.md

@@ -13,9 +13,6 @@ And then execute:
 $ bundle
 ```
 
-## Usage
-TBD
-
 ## Contributing
 Before pushing:
 * Run `rubocop` to show code styles offences

data/Rakefile

@@ -19,3 +19,9 @@ end
 load 'rails/tasks/statistics.rake'
 
 require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/carbonyte/application_controller.rb

@@ -3,5 +3,22 @@
 module Carbonyte
   # Carbonyte base class for all controllers
   class ApplicationController < ActionController::API
+    include Concerns::Correlatable
+    include Concerns::Loggable
+    include Concerns::Rescuable
+    include Concerns::Policiable
+    include Concerns::Serializable
+
+    # GET /health
+    def health
+      payload = {
+        correlation_id: correlation_id,
+        db_status: ActiveRecord::Base.connected? ? 'OK' : 'Not Connected',
+        environment: Rails.env,
+        pid: ::Process.pid
+      }
+
+      render json: payload, status: :ok
+    end
   end
 end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'request_store'
+
+module Carbonyte
+  # Module enclosing all concerns
+  module Concerns
+    # The Correlatable concern automatically manages the correlation ID
+    module Correlatable
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :find_or_create_correlation_id
+        after_action :send_correlation_id
+      end
+
+      # Retrieves the request correlation ID
+      def correlation_id
+        RequestStore.store[:correlation_id]
+      end
+
+      protected
+
+      # Finds the correlation ID in the request.
+      # Can be overridden to fit the application
+      def find_correlation_id
+        request.headers['X-Correlation-Id'] || request.headers['X-Request-Id']
+      end
+
+      # Generates a correlation ID (defaults to Rails auto-generated one).
+      # Can be overridden to fit the application
+      def create_correlation_id
+        request.request_id || SecureRandom.uuid
+      end
+
+      private
+
+      def find_or_create_correlation_id
+        correlation_id = find_correlation_id || create_correlation_id
+        RequestStore.store[:correlation_id] = correlation_id
+      end
+
+      def send_correlation_id
+        response.set_header('X-Correlation-Id', correlation_id)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  module Concerns
+    # The Loggable concern integrates with lograge to log efficiently
+    module Loggable
+      extend ActiveSupport::Concern
+
+      # Used for logging IP.
+      # @see Carbonyte::Engine
+      def remote_ip
+        request.headers['HTTP_X_FORWARDED_FOR'] || request.headers['HTTP_X_REAL_IP'] || request.remote_ip
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  module Concerns
+    # The Policiable concern integrates with Pundit to manage policies
+    module Policiable
+      extend ActiveSupport::Concern
+
+      included do
+        include Pundit
+        rescue_from Pundit::NotAuthorizedError, with: :policy_not_authorized
+      end
+
+      private
+
+      def policy_not_authorized(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: :forbidden
+      end
+    end
+  end
+end

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

@@ -1,61 +1,107 @@
 # 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
+  module Concerns
+    # 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
 
-    private
+      included do
+        # The first one MUST be StandardError as otherwise will catch all others
+        rescue_from StandardError, with: :internal_error
 
-    def serialized_errors(payload)
-      payload = [payload] unless payload.is_a?(Enumerable)
-      payload.to_json
-    end
+        rescue_from ActiveRecord::RecordNotFound, with: :record_not_found
+        rescue_from Interactor::Failure, with: :interactor_failure
+        rescue_from ActiveRecord::RecordInvalid,
+                    ActiveRecord::RecordNotSaved,
+                    with: :record_invalid
+      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
+      # Upon rescuing an exception, stores that exception in RequestStore for later logging
+      # @param exception [StandardError] the rescued exception
+      def rescue_with_handler(exception)
+        RequestStore.store[:rescued_exception] = exception
+        super
+      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
+      # This is a special case
+      def route_not_found
+        payload = {
+          code: 'RoutingError',
+          source: request.path,
+          title: 'Route not found',
+          detail: "No route matches #{request.path}"
+        }
+        render json: serialized_errors(payload), status: :not_found
+      end
 
-    def record_invalid(exc)
-      payload = errors_for_record(exc.record, exc.class.name).flatten
-      render json: serialized_errors(payload), status: :unprocessable_entity
-    end
+      private
+
+      def serialized_errors(payload)
+        payload = [payload] unless payload.is_a?(Array)
+        { errors: payload }.to_json
+      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
-          }
+      def unauthenticated(exc)
+        payload = {
+          code: exc.class.name,
+          title: 'User Not Authenticated',
+          detail: exc.message
+        }
+        render json: serialized_errors(payload), status: :unauthorized
+      end
+
+      def record_not_found(exc)
+        payload = {
+          code: exc.class.name,
+          source: {
+            model: exc.model,
+            id: exc.id
+          },
+          title: 'Resource Not Found',
+          detail: exc.message
+        }
+        render json: serialized_errors(payload), status: :not_found
+      end
+
+      def interactor_failure(exc)
+        payload = {
+          code: exc.class.name,
+          source: { interactor: exc.context.current_interactor.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.errors.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
+
+      def internal_error(exc)
+        payload = {
+          code: exc.class.name,
+          title: 'Internal Server Error',
+          detail: exc.message
+        }
+        render json: serialized_errors(payload), status: :internal_server_error
+      end
     end
   end
 end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  module Concerns
+    # The Serializable concern helps with JSON:API serialization
+    module Serializable
+      extend ActiveSupport::Concern
+
+      # Helper method to render json responses
+      # @param object [Any] the object (or list) to be serialized
+      # @param serializer_class [JSONAPI::Serializer] serializer class to use. Inferred if not provided.
+      # @param status [Symbol, Number] the status code to return, defaults to 200 (OK)
+      # @example Serializes `user` using UserSerializer and returns status 200 (OK)
+      #   user = User.find(123)
+      #   serialize(user)
+      # @example Serializes `created_record` using the specified UserSerializer and returning status 201 (CREATED)
+      #   serialize(created_record, serializer: UserSerializer, status: :created)
+      def serialize(object, serializer_class: nil, status: :ok)
+        serializer_class ||= serializer_for(object)
+        render json: serializer_class.new(object, serializer_options).serializable_hash.to_json, status: status
+      end
+
+      # Default options for serializers
+      def serializer_options
+        {
+          include: include_option,
+          params: {
+            current_user: current_user
+          }
+        }
+      end
+
+      # Default include options for serializers
+      def include_option
+        return [] unless params[:include]
+
+        params[:include].split(',').map(&:to_sym)
+      end
+
+      private
+
+      def serializer_for(object)
+        object = object.first if object.is_a?(Array)
+        "#{object.class.name}Serializer".constantize
+      end
+    end
+  end
+end

data/app/interactors/carbonyte/application_interactor.rb

@@ -4,5 +4,19 @@ module Carbonyte
   # Carbonyte base class for all interactors
   class ApplicationInteractor
     include Interactor
+
+    # Interactor hooks are not inherited by subclasses, so we need a hack.
+    # @see https://github.com/collectiveidea/interactor/issues/114
+    def self.inherited(klass)
+      klass.class_eval do
+        before do
+          context.current_interactor = self
+        end
+
+        after do
+          context.current_interactor = nil
+        end
+      end
+    end
   end
 end

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

@@ -25,8 +25,6 @@ module Carbonyte
         paginate
       end
 
-      protected
-
       # Returns true if the provided relation can be included
       # @param _rel [Symbol] the relation to include
       def can_include?(_rel)
@@ -37,9 +35,9 @@ module Carbonyte
 
       def include_relations
         context.params[:include].split(',').each do |relation|
-          next unless can_include?(relation)
+          next unless can_include?(relation.to_sym)
 
-          context.scope = context.scope.includes(relation)
+          context.scope = context.scope.includes(relation.to_sym)
         end
       end
 
@@ -48,9 +46,9 @@ module Carbonyte
       end
 
       def sort_exp(prop)
-        return prop unless prop.start_with?('-')
+        return prop.to_sym unless prop.start_with?('-')
 
-        { prop[1..] => :desc }
+        { prop[1..].to_sym => :desc }
       end
 
       def sort

data/app/policies/carbonyte/application_policy.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Carbonyte
+  # Carbonyte base class for all policies
+  class ApplicationPolicy
+    attr_reader :user, :record
+
+    # Initializes a new policy with the current user and the record
+    def initialize(user, record)
+      @user = user
+      @record = record
+    end
+
+    # Can the user get a list of records?
+    def index?
+      true
+    end
+
+    # Can the user get this specific record?
+    def show?
+      true
+    end
+
+    # Can the user create a new record?
+    def create?
+      true
+    end
+
+    # Can the user update this record?
+    def update?
+      true
+    end
+
+    # Can the user destroy this record?
+    def destroy?
+      true
+    end
+
+    # Carbonyte base class for all policy scopes
+    class Scope
+      attr_reader :user, :scope
+
+      # Initializes a new scope from the user and a base scope
+      def initialize(user, scope)
+        @user = user
+        @scope = scope
+      end
+
+      # Resolves the scope effectively triggering the query
+      def resolve
+        scope.all
+      end
+    end
+  end
+end