ree_lib 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b78b5d2573b0674dc4f2eae170e408ac3f2fe18bb735be4fdd5ba8bbb7950e6
-  data.tar.gz: 253c3e28a517d3d14dd3110cd774f5ae4086c1ba5e0d19110de9f7d8c6f05bd8
+  metadata.gz: d39c69499684b2f63a3dfc5636265aceab2d0935cd4f6dfed10195cff8131989
+  data.tar.gz: 464e780303d9b8f1d1f8b786e507c87e708d5ba242520390fbf4f2643061d73d
 SHA512:
-  metadata.gz: c083f3c6b152024b97e90af5294db3aa0703fa7b0c50747de9596cbe7b4da7c87d8e190e68c25acc4a039ad00a7be549b2d0ad61bb05efd7d94cd6528d3dfecd
-  data.tar.gz: a337f004cc876ca1b1be5a0fb2187767d568a45a05b2e8926e4490acb34e7354b72f3c9ff453f9980043e38a56a09f8796da4ea0f92d938c762908370ba9438a
+  metadata.gz: ac7641c5e60d758ac4aa3e4fe6237c7758e5c6a53dd096acbf3bd5ca266aa48a5fffe0b0e5e50b0b2ad54493482365fdf3a6de2bf6b938abff626b7864b5016b
+  data.tar.gz: 329fb7390b7183e14ee2d1b52a2d236e3afdf45d7a65ad3fa31ec871c01c0637716b72479f9de6e90e5d1a1b5eb5b1fae5630747509875387f17274689bdf3fd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ree_lib (1.0.1)
+    ree_lib (1.0.2)
       binding_of_caller (~> 1.0.0)
       i18n (~> 1.12.0)
       loofah (~> 2.18.0)

data/lib/ree_lib/packages/ree_json/package/ree_json.rb

@@ -6,5 +6,4 @@ module ReeJson
   package do
     depends_on :ree_hash
   end
-
 end

data/lib/ree_lib/packages/ree_logger/package/ree_logger/multi_logger.rb

@@ -83,7 +83,7 @@ class ReeLogger::MultiLogger < Logger
   end
 
   contract(String, Hash, Nilor[Exception], Bool => nil)
-  def unknown(message, parameters = {}, exception  =nil, log_args = true)
+  def unknown(message, parameters = {}, exception = nil, log_args = true)
     log(:unknown, message, parameters, exception, true)
   end
 

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/endpoint_dto.rb

@@ -1,5 +1,8 @@
 class ReeSwagger::EndpointDto
   include ReeDto::EntityDSL
+  include Ree::LinkDSL
+
+  link 'ree_swagger/dto/error_dto', -> { ErrorDto }
 
   properties(
     method: Or[:get, :post, :put, :patch, :delete],
@@ -8,6 +11,7 @@ class ReeSwagger::EndpointDto
     serializer: Nilor[ReeMapper::Mapper],
     description: Nilor[String],
     response_status: Integer,
-    response_description: Nilor[String]
+    response_description: Nilor[String],
+    errors: ArrayOf[ErrorDto]
   )
 end

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/error_dto.rb

@@ -0,0 +1,9 @@
+
+  class ReeSwagger::ErrorDto
+    include ReeDto::EntityDSL
+
+    properties(
+      status: Integer,
+      description: String,
+    )
+  end

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_endpoint_schema.rb

@@ -88,6 +88,35 @@ class ReeSwagger::BuildEndpointSchema
       endpoint.response_status => response_schema
     }
 
+    endpoint.errors.each do |error|
+      if responses.key?(error.status)
+        responses[error.status][:description] += "\n\n#{error.description}"
+        next
+      end
+
+      responses[error.status] = {
+        description: error.description,
+        content: {
+          :'application/json' => {
+            schema: {
+              type: 'object',
+              properties: {
+                code: {
+                  type: "string"
+                },
+                message: {
+                  type: "string"
+                },
+                type: {
+                  type: "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    end
+
     method_schema = {
       responses: responses
     }

data/lib/ree_lib/packages/ree_swagger/spec/functions/build_endpoint_schema_spec.rb

@@ -36,7 +36,21 @@ RSpec.describe :build_endpoint_schema do
       caster:          caster,
       serializer:      serializer,
       response_status: 200,
-      description:     nil
+      description:     nil,
+      errors:          [
+        ReeSwagger::ErrorDto.new(
+          status: 400,
+          description: "1st 400 error"
+        ),
+        ReeSwagger::ErrorDto.new(
+          status: 400,
+          description: "2nd 400 error"
+        ),
+        ReeSwagger::ErrorDto.new(
+          status: 401,
+          description: "401 error"
+        )
+      ]
     ))
 
     expect(schema).to eq(ReeSwagger::PathDto.new(
@@ -83,6 +97,48 @@ RSpec.describe :build_endpoint_schema do
                   }
                 }
               }
+            },
+            400 => {
+              description: "1st 400 error\n\n2nd 400 error",
+              content: {
+                :'application/json' => {
+                  schema: {
+                    type: 'object',
+                    properties: {
+                      code: {
+                        type: "string"
+                      },
+                      message: {
+                        type: "string"
+                      },
+                      type: {
+                        type: "string"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            401 => {
+              description: "401 error",
+              content: {
+                :'application/json' => {
+                  schema: {
+                    type: 'object',
+                    properties: {
+                      code: {
+                        type: "string"
+                      },
+                      message: {
+                        type: "string"
+                      },
+                      type: {
+                        type: "string"
+                      }
+                    }
+                  }
+                }
+              }
             }
           }
         }
@@ -109,7 +165,8 @@ RSpec.describe :build_endpoint_schema do
       caster:          caster,
       serializer:      nil,
       response_status: 200,
-      description:     nil
+      description:     nil,
+      errors:          []
     ))
 
     expect(schema).to eq(ReeSwagger::PathDto.new(
@@ -167,7 +224,8 @@ RSpec.describe :build_endpoint_schema do
         caster:          nil,
         serializer:      nil,
         response_status: 200,
-        description:     nil
+        description:     nil,
+        errors:          []
       ))
     }.to raise_error(
       ReeSwagger::BuildEndpointSchema::MissingCasterError,
@@ -187,7 +245,8 @@ RSpec.describe :build_endpoint_schema do
         caster:          caster,
         serializer:      nil,
         response_status: 200,
-        description:     nil
+        description:     nil,
+        errors:          []
       ))
     }.to raise_error(
       ReeSwagger::BuildEndpointSchema::MissingCasterError,

data/lib/ree_lib/packages/ree_swagger/spec/functions/build_schema_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe :build_schema do
         caster:          nil,
         serializer:      nil,
         response_status: 200,
-        description:     nil
+        description:     nil,
+        errors:          []
       )]
     )
 

data/lib/ree_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReeLib
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ree
@@ -1120,6 +1120,7 @@ files:
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/beans/type_definitions_repo.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/endpoint_dto.rb
+- lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/error_dto.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/path_dto.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_endpoint_schema.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_parameters.rb