ree_lib 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756ef68a2b67f69d7b39d4877f51bebef0bf9f16c2d826f75a66fa43784ac779
-  data.tar.gz: f9668ac762030ae0b4e0d53d9edafd7751396b30e4b1f4ae67188b889aef6360
+  metadata.gz: 44e1a436822756b530e7f11947c68f43377096b4b15d8c6d60880a8f2116d1b2
+  data.tar.gz: cea2b849ec06361e461b282c93632cbcc2131bedfcbf260c87fcca56dfb53539
 SHA512:
-  metadata.gz: 7f0f85267b26e8249d4c8c9d46532717acc53a4378e19e20e5f07e2431b751cee6591ac97677ffc528b651fef7428f868a73e9d87ef44103f94a21b412ff5f6d
-  data.tar.gz: c31dd2b537126f8590b656002f169fbce184448bedc79d4c0c58b7de769a940e5f780a7d73e70595a68966bafda85a13ef73031da79df69808d3eea5fb224352
+  metadata.gz: 53f014bef46e41b7f1826ef4487ff0fce03c66b4578a7d6ddd65a37aaa94989aef52523dd368514f1e533b141aac9e9fedc341e4cc14b69dc4a1528482c53ed1
+  data.tar.gz: fe75d4036275c8a4013fbb064ced2f61b014c7ccccb5e48b7966e83f22f44adbc47345b37c01c2498f6f1d1dc035a21bf3ffa6a86a9aca0ac85665d8a13ac74b

data/Gemfile.lock

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

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

@@ -13,6 +13,7 @@ class ReeSwagger::EndpointDto
     path: String,
     caster: Nilor[ReeMapper::Mapper],
     serializer: Nilor[ReeMapper::Mapper],
+    authenticate: Bool,
     summary: Nilor[String],
     description: Nilor[String],
     response_status: Integer,

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

@@ -112,6 +112,7 @@ class ReeSwagger::BuildEndpointSchema
 
     method_schema[:parameters]  = parameters   if parameters
     method_schema[:requestBody] = request_body if request_body
+    method_schema[:security] = [{ ApiKeyAuth: [] }] if endpoint.authenticate
 
     schema = {endpoint.method => method_schema}
 

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

@@ -38,10 +38,11 @@ class ReeSwagger::BuildRequestBodySchema
 
     return if properties.empty?
 
-    {
+    obj = {
       type: 'object',
       properties: properties,
-      required: required_fields
     }
+    obj[:required] = required_fields if required_fields.size != 0
+    obj
   end
 end

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

@@ -8,8 +8,8 @@ class ReeSwagger::BuildSchema
     link 'ree_swagger/dto/endpoint_dto', -> { EndpointDto }
   end
 
-  contract(String, String, String, ArrayOf[EndpointDto] => Hash)
-  def call(title:, description:, version:, endpoints:)
+  contract(String, String, String, String, ArrayOf[EndpointDto] => Hash)
+  def call(title:, description:, version:, api_url:, endpoints:)
     {
       openapi: "3.0.0",
       info: {
@@ -17,6 +17,16 @@ class ReeSwagger::BuildSchema
         description: description,
         version:     version
       },
+      components: {
+        securitySchemes: {
+          ApiKeyAuth: {
+            type: 'apiKey',
+            in: 'header',
+            name: 'Authorization'
+          }
+        }
+      },
+      servers: [{ url: api_url }],
       paths: endpoints.each_with_object(Hash.new { _1[_2] = {} }) {
         path_dto = build_endpoint_schema(_1)
         _2[path_dto.path].merge!(path_dto.schema)

data/lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/functions/build_schema.schema.json

@@ -26,6 +26,10 @@
           "arg": "version",
           "type": "String"
         },
+        {
+          "arg": "api_url",
+          "type": "String"
+        },
         {
           "arg": "endpoints",
           "type": "ArrayOf[ReeSwagger::EndpointDto]"

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

@@ -71,6 +71,7 @@ RSpec.describe :build_endpoint_schema do
     schema = build_endpoint_schema(ReeSwagger::EndpointDto.new(
       method:          :post,
       respond_to:      :json,
+      authenticate:    false,
       path:            '/versions/:id',
       sections:        ["versions"],
       caster:          caster,
@@ -97,6 +98,7 @@ RSpec.describe :build_endpoint_schema do
     csv_schema = build_endpoint_schema(ReeSwagger::EndpointDto.new(
       method:          :get,
       respond_to:      :csv,
+      authenticate:    false,
       path:            '/files/:id',
       sections:        ["files"],
       caster:          file_caster,
@@ -226,6 +228,7 @@ RSpec.describe :build_endpoint_schema do
       path:            '/versions/:id',
       caster:          caster,
       respond_to:      :json,
+      authenticate:    false,
       serializer:      nil,
       response_status: 200,
       description:     nil,
@@ -288,6 +291,7 @@ RSpec.describe :build_endpoint_schema do
         method:          :get,
         path:            '/versions/:id',
         respond_to:      :json,
+        authenticate:    false,
         caster:          nil,
         serializer:      nil,
         response_status: 200,
@@ -311,6 +315,7 @@ RSpec.describe :build_endpoint_schema do
         method:          :get,
         path:            '/versions/:id',
         respond_to:      :json,
+        authenticate:    false,
         caster:          caster,
         serializer:      nil,
         response_status: 200,

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

@@ -6,8 +6,10 @@ RSpec.describe :build_schema do
       title: 'Sample API',
       description: 'Sample API description',
       version: '0.0.1',
+      api_url: 'https://some-api.com/api/v1',
       endpoints: [ReeSwagger::EndpointDto.new(
         method:          :get,
+        authenticate:    true,
         path:            '/version',
         respond_to:      :json,
         caster:          nil,
@@ -27,9 +29,24 @@ RSpec.describe :build_schema do
           description: 'Sample API description',
           version: '0.0.1'
         },
+        components: {
+          securitySchemes: {
+            bearerAuth: {
+              type: 'http',
+              scheme: 'bearer',
+              bearerFormat: 'JWT'
+            }
+          }
+        },
+        servers: [
+          { url: 'https://some-api.com/api/v1' }
+        ],
         paths: {
           '/version' => {
             get: {
+              security: [
+                {bearerAuth: []}
+              ],
               responses: {
                 200 => {
                   description: ''

data/lib/ree_lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Ruslan Gatiyatov