blacksheep 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f9f95a300f2d7c84826615cb86a66fabe8ecdd680edabf6b9e960973d8f5f83
-  data.tar.gz: 3cdfd65ec9647bed1ff5df0261b000227f395d379a9c310e8def4de9b0439c83
+  metadata.gz: 84572df9e128c7565cfb17bfb7135451b33bc3b3d12ef97a2c3a3f319843f4d2
+  data.tar.gz: 79884c76bd997723295b04efaf0d5e32b086dd6a281f648bcbe6d01412710690
 SHA512:
-  metadata.gz: ac515283bff176a47ffa4b6159e169c7a3776bc1e2d0f587182e479420b805b0633e2f909a9720bbff15bcc68776ce9f180e51e6a014e2e2ef2ae261b6114d94
-  data.tar.gz: 1c7008322b347109e570b87f8a83b6512a7380c4021e779655fb80f8bd426efc9aad3a1a606c73dd09e7735f2a85dd927e5f8f472ce5650323ec7d90283c82cf
+  metadata.gz: 8819a2a83c63b4c3c6d6c9aaf3ccfcab848ebe70dc49b81033dea1df578626905577dcb18ef80a5c7af0e7b34685c3de90d88a4f3a532a1ea35caa0b7468d590
+  data.tar.gz: b31d65fedd9a8f0870b4be19baeb7ebe8f9941071a030f8d9ba97fab16d0be46a9613960c0600ef582702aeba4b0bbc1e587cd09fd5b6ffe69d90ccb0adfec45

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blacksheep (0.2.2)
+    blacksheep (0.4.0)
       dry-matcher
 
 GEM

data/lib/blacksheep.rb

@@ -1,9 +1,12 @@
 require "blacksheep/version"
 require "blacksheep/action_result"
+require "blacksheep/action_error"
 require "blacksheep/action_decorator"
+require "blacksheep/decorators/error_handler"
 require "blacksheep/decorators/default_error_handler"
 require "blacksheep/decorators/json_transformer"
 require "blacksheep/decorators/result_matcher"
+require "blacksheep/decorators/localizer"
 require "blacksheep/action"
 require "blacksheep/version"
 

data/lib/blacksheep/action.rb

@@ -28,11 +28,16 @@ module Blacksheep
         @@decorators ||= []
       end
 
+      #
+      # Adds a decorator to the list of decorated to be applied on Balcksheep::Actions
+      # @param decorator [type] [description]
+      #
+      # @return [type] [description]
       def add_decorator(decorator)
-        decorators << decorator
+        decorators << decorator unless decorators.include?(decorator)
       end
 
-      def new(*)
+      def new(*arguments, &block)
         instance = super
 
         decorators.each do |decorator|

data/lib/blacksheep/action_decorator.rb

@@ -1,9 +1,29 @@
 require 'delegate'
 
 module Blacksheep
+  # @class Blacksheep::ActionDecorator
   class ActionDecorator < SimpleDelegator
+
+    # Access to the decorators class - since original class is overwritten to return the model class.
+    #
+    # @return [Class] The class of the deocrator.
+    # @see [#class]
+    alias_method :__class__, :class
+
     def class
       __getobj__.class
     end
+
+    #
+    # Just for curiosity - get the decorators chain
+    #
+    # @return [type] [description]
+    def decorators_chain
+      decorated = __getobj__
+      chain = decorated.kind_of?(Blacksheep::ActionDecorator) ? decorated.decorators_chain : [ decorated.class ]
+
+      chain.unshift(self.__class__)
+    end
+
   end
 end

data/lib/blacksheep/action_error.rb

@@ -0,0 +1,16 @@
+module Blacksheep
+  #
+  # @class Blacksheep::ActionError
+  class ActionError < StandardError
+    attr_reader :identifier, :title
+
+    def initialize(message, title: 'Error', identifier: 'undefined', status: :internal_server_error)
+      @identifier = identifier
+      @title = title
+      @status = status
+
+      super(message)
+    end
+
+  end
+end

data/lib/blacksheep/action_result.rb

@@ -3,11 +3,42 @@ module Blacksheep
 
     attr_reader :data, :status
 
+    @render_http_status = true
+
     def initialize(data, status)
       @data = data
       @status = status
     end
 
+    class << self
+      attr_accessor :render_http_status
+
+      def success(message)
+        json = {
+          _meta: {
+            message: message
+          }
+        }
+
+        new(json, :ok)
+      end
+
+      def error(title: 'Error', message:, status: :internal_server_error, pointer: 'unspecified')
+        json = {
+          errors: [
+            pointer: {
+              source: pointer
+            },
+            title: title,
+            detail: message,
+          ]
+        }
+        status = :internal_server_error
+
+        new(json, status)
+      end
+    end
+
     def set_data(value)
       @data = value
 
@@ -24,19 +55,32 @@ module Blacksheep
       @status == :ok
     end
 
-    def render_json(json_wrap: 'data')
-      {
-        json:   wrap(@data, json_wrap: json_wrap),
-        status: status
-      }
+    def render_http_status
+      self.class.render_http_status
     end
 
-    private
+    def render_json(json_wrap: 'data', render_http_status: self.render_http_status, to: nil)
+      if to.nil?
+        return {
+          json: wrap_json(json_wrap)
+        }
+      end
 
-    def wrap(json, json_wrap:)
-      wrap = success? ? json_wrap : nil
+      if to.respond_to?(:render)
+        if render_http_status
+          to.render json: wrap_json(json_wrap), status: status
+        else
+          to.render json: wrap_json(json_wrap)
+        end
+      else
+        raise ArgumentError, "render target #{to.class} does not respond to #render"
+      end
+    end
+
+    private
 
-      wrap.present? ? { wrap => json } : json
+    def wrap_json(json_wrap)
+      json_wrap.present? && success? ? { json_wrap => @data } : @data
     end
 
   end

data/lib/blacksheep/decorators/default_error_handler.rb

@@ -7,64 +7,57 @@ module Blacksheep
       def handle(exception)
         json = status = nil
 
-        # case exception
-        #   when Exceptions::ValidationException
-        #     errors = []
-        #     exception.model.errors.each do |attribute, message|
-        #       errors << {
-        #         title:  "'#{attribute}' validation error",
-        #         detail: message,
-        #       }
-        #     end
-        #     json = {
-        #       errors: errors
-        #     }
-        #     status = :unprocessable_entity # 422
-        #   when Pundit::NotAuthorizedError
-        #     json = {
-        #       errors: [
-        #         pointer: {
-        #           source: not_authorized_pointer(exception)
-        #         },
-        #         title: "#{exception.class}",
-        #         detail: "#{exception.message}",
-        #       ]
-        #     }
-        #     status = :unauthorized # 401
-        #   when Exceptions::AuthenticationInvalid
-        #     json = {
-        #       errors: [
-        #         pointer: {
-        #           source: 'Secured Module'
-        #         },
-        #         title: "#{exception.class}",
-        #         detail: "#{exception.message}",
-        #       ]
-        #     }
-        #     status = :unauthorized # 401
-        #   else
-        #     json = {
-        #       errors: [
-        #         pointer: {
-        #           source: 'Internal'
-        #         },
-        #         title: "#{exception.class}",
-        #         detail: "#{exception.message}",
-        #       ]
-        #     }
-        #     status = :internal_server_error # 500
-        # end
+        case exception
+          when Blacksheep::ActionError
+            json = {
+              errors: [
+                pointer: {
+                  source:  exception.backtrace.first,
+                  identifier: exception.identifier,
+                },
+                title: exception.title,
+                detail: exception.message,
+              ]
+            }
 
-        json = {
-          errors: [
-            pointer: {
-              source: 'Internal'
-            },
-            title: "#{exception.class}",
-            detail: "#{exception.message}",
-          ]
-        }
-        status = :internal_server_error # 500
+            status = exception.status
+
+            #   when Pundit::NotAuthorizedError
+            #     json = {
+            #       errors: [
+            #         pointer: {
+            #           source: not_authorized_pointer(exception)
+            #         },
+            #         title: "#{exception.class}",
+            #         detail: "#{exception.message}",
+            #       ]
+            #     }
+            #     status = :unauthorized # 401
+            #   when Exceptions::AuthenticationInvalid
+            #     json = {
+            #       errors: [
+            #         pointer: {
+            #           source: 'Secured Module'
+            #         },
+            #         title: "#{exception.class}",
+            #         detail: "#{exception.message}",
+            #       ]
+            #     }
+            #     status = :unauthorized # 401
+
+          else
+            json = {
+              errors: [
+                pointer: {
+                  source: 'Internal'
+                },
+                title: "#{exception.class}",
+                detail: "#{exception.message}",
+              ]
+            }
+        end
+
+        status ||= :internal_server_error
 
         ActionResult.new(json, status)
       end

data/lib/blacksheep/decorators/error_handler.rb

@@ -1,7 +1,7 @@
 module Blacksheep
   module Decorators
-    # @class Blacksheep::Decorators::ErrorHandler
-    class ErrorHandler
+    # @module Blacksheep::Decorators::ErrorHandler
+    module ErrorHandler
 
       def call(*)
         super

data/lib/blacksheep/decorators/json_transformer.rb

@@ -5,27 +5,24 @@ module Blacksheep
 
       attr_reader :case, :params
 
-      def call(params, **options)
+      def call(params, current_user: nil, **options)
         detect_case(params)
 
-        transformed_params = self.transformed_params(params)
+        transformed_params = self.transform_params(params)
 
-        json = super(transformed_params, **options)
+        result = super(transformed_params, **options)
 
-        transformed_json = transform_result(json)
-
-        ActionResult.new(transformed_json, :ok)
+        as_transformed_action_result(result)
       end
 
       def perform(params, current_user: nil, **options, &block)
         detect_case(params)
 
-        transformed_params = self.transformed_params(params)
+        transformed_params = self.transform_params(params)
 
-        json = block.call(transformed_params)
-        transformed_json = transform_result(json)
+        result = super(transformed_params, current_user: current_user, **options, &block)
 
-        ActionResult.new(transformed_json, :ok)
+        as_transformed_action_result(result)
       end
 
 
@@ -34,7 +31,7 @@ module Blacksheep
       #
       # @return [Array, Hash] The params converted into snake_case
       # @see #snakecase_keys
-      def transformed_params(params)
+      def transform_params(params)
         case @case
           when 'snake', 'as_is'
             params
@@ -49,16 +46,15 @@ module Blacksheep
       # Transform the obj with key in snake_case to the source case.
       # NOTE: leading underscored are preserved (e.g. _my_laptop => _myLaptop)
       #
-      # @param obj [Array, Hash] A result structure
+      # @param obj [Array, Hash, ActionResult] A result structure
       # @return [Array, Hash] The rsult structure with keys converted to source caseing
       # @see #camelize_keys
-      def transform_result(obj)
+      def as_transformed_action_result(obj)
         is_action_result, data = if obj.kind_of?(Blacksheep::ActionResult)
           [ true, obj.data ]
         else
           [ false, obj ]
         end
-
         converted_data = case @case
           when 'snake', 'as_is'
             data
@@ -68,7 +64,7 @@ module Blacksheep
             raise Blacksheep::Error, "unknown_case #{@case}"
         end
 
-        is_action_result ? obj.set_data(converted_data) : converted_data
+        is_action_result ? obj.set_data(converted_data) : ActionResult.new(converted_data, :ok)
       end
 
       #

data/lib/blacksheep/decorators/localizer.rb

@@ -1,10 +1,10 @@
 module Blacksheep
   module Decorators
 
-    # @class Blacksheep::Decorators::Localozer
+    # @class Blacksheep::Decorators::Localizer
     class Localizer < ActionDecorator
 
-      def call(params, **)
+      def call(params, current_user: nil, **options)
         if (locale = params[:_locale])
           I18n.with_locale(locale) do
             super
@@ -14,7 +14,8 @@ module Blacksheep
         end
       end
 
-      def perform(params, **)
+      def perform(params, current_user: nil, **options)
+
         if (locale = params[:_locale])
           I18n.with_locale(locale) do
             super

data/lib/blacksheep/version.rb

@@ -1,3 +1,3 @@
 module Blacksheep
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacksheep
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin Schweizer
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-matcher
@@ -87,6 +87,7 @@ files:
 - lib/blacksheep.rb
 - lib/blacksheep/action.rb
 - lib/blacksheep/action_decorator.rb
+- lib/blacksheep/action_error.rb
 - lib/blacksheep/action_result.rb
 - lib/blacksheep/decorators/default_error_handler.rb
 - lib/blacksheep/decorators/error_handler.rb
@@ -100,7 +101,7 @@ licenses:
 metadata:
   homepage_uri: http://verticonaut.me
   source_code_uri: https://github.com/verticonaut/blacksheep
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Support for API acrtions
 test_files: []