blacksheep 0.2.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b520c717b2b72704b7f6854ce506fca8e47773a3b2fe48d54344d2622a9ac8b
-  data.tar.gz: b3dfe30943535dbc03e6a9e81c088e2267528c775aa484524d12710e50b2cf64
+  metadata.gz: bff82a7d7c387c7f72cd750bab7db223ec98ca693dfe07b5de48733b40a07df8
+  data.tar.gz: 866abc7ed1b93db2edca0d6a619a7b5c566ab4bac844d4560ea1b6a0d81036c8
 SHA512:
-  metadata.gz: 3d3ee10c9acc1381e10e95101c42d7bbd17b6972c94b526aabc28b1b142bec56634da37b2ff0bd71f752ec158846ba888439af2d87bd3120c4fdda7e0a75c010
-  data.tar.gz: '0401960e858de894e369599234431f8c91014e5ea0419924d00bb20396c48dd50d3faa04f2fa0d266f79e3d10795e9ad93ffa1ae45aa72b232d786a0a44db8e4'
+  metadata.gz: bc737ddd30b3d74b227635f4bde894345b92184310d391d88f073d715d59295998cd0cb25c0a556fb4f5a83ae4c109db6d9d721caa79dc1e4023fa78166fa0ac
+  data.tar.gz: 0c2f456acf1c54cb6236abc36c925abff77363078f4ae07a2d92db745147688fd3e40c5e65df280d3d914f312e77c779ceca2747035e713d716d716d95ee15a7

data/Gemfile.lock

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

data/lib/blacksheep.rb

@@ -1,5 +1,6 @@
 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"

data/lib/blacksheep/action_error.rb

@@ -0,0 +1,16 @@
+module Blacksheep
+  #
+  # @class Blacksheep::ActionError
+  class ActionError < StandardError
+    attr_reader :identifier, :title, :status
+
+    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/json_transformer.rb

@@ -10,11 +10,9 @@ module Blacksheep
 
         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)
@@ -22,11 +20,9 @@ module Blacksheep
 
         transformed_params = self.transform_params(params)
 
-        json = super(transformed_params, current_user: current_user, **options, &block)
-
-        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
 
 
@@ -50,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
@@ -69,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/version.rb

@@ -1,3 +1,3 @@
 module Blacksheep
-  VERSION = "0.2.3"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacksheep
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Martin Schweizer
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-07-10 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: []