ree_lib 1.0.7 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 956fffa1a41176330384decf8f4f3b45ce70801785ea5498a07e0cb0afdd6b0f
-  data.tar.gz: 4745a3465a5ad18a6353ba21a8ef62b13991cd3cfc0fde7bf05ec41c7e561433
+  metadata.gz: 44e1a436822756b530e7f11947c68f43377096b4b15d8c6d60880a8f2116d1b2
+  data.tar.gz: cea2b849ec06361e461b282c93632cbcc2131bedfcbf260c87fcca56dfb53539
 SHA512:
-  metadata.gz: afd9719357108c5bff745a3112c581f333de679e0ac9d41e02624d43f006584cdfec1080f40047be3fcfb816ea74275509ca2a841e718c06463e489d32e7a473
-  data.tar.gz: 398d3fc0469aa20e71d37eaaf6422c76f8a0a86d155d548199bff1867a27612f0602ea7919715efd1aaf4f479417a2f03e2254d2e9ff4ba09b97fd2d1250632a
+  metadata.gz: 53f014bef46e41b7f1826ef4487ff0fce03c66b4578a7d6ddd65a37aaa94989aef52523dd368514f1e533b141aac9e9fedc341e4cc14b69dc4a1528482c53ed1
+  data.tar.gz: fe75d4036275c8a4013fbb064ced2f61b014c7ccccb5e48b7966e83f22f44adbc47345b37c01c2498f6f1d1dc035a21bf3ffa6a86a9aca0ac85665d8a13ac74b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ree_lib (1.0.7)
+    ree_lib (1.0.10)
       binding_of_caller (~> 1.0.0)
       i18n (~> 1.12.0)
       loofah (~> 2.18.0)
@@ -36,9 +36,11 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     msgpack (1.5.4)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
     nokogiri (1.13.8-x86_64-linux)
       racc (~> 1.4)
-    oj (3.13.19)
+    oj (3.13.20)
     pg (1.4.2)
     public_suffix (4.0.7)
     racc (1.6.0)

data/lib/ree_lib/packages/ree_http/package/ree_http/functions/build_request_executor.rb

@@ -5,7 +5,7 @@ class ReeHttp::BuildRequestExecutor
 
   fn :build_request_executor do
     link 'ree_http/constants', -> {
-      DEFAULT_TIMEOUT & DEFAULT_WRITE_TIMEOUT & DEFAULT_FORCE_SSL
+      HTTPS & DEFAULT_TIMEOUT & DEFAULT_WRITE_TIMEOUT & DEFAULT_FORCE_SSL
     }
   end
 
@@ -47,7 +47,8 @@ class ReeHttp::BuildRequestExecutor
     request_executor.write_timeout = opts[:write_timeout]
     request_executor.read_timeout = opts[:timeout]
 
-    request_executor.use_ssl = opts[:force_ssl]
+    request_executor.use_ssl = opts[:force_ssl] || uri.scheme == HTTPS
+
 
     if opts[:ca_certs?]
       request_executor = build_ca_certs(request_executor, opts[:ca_certs?])

data/lib/ree_lib/packages/ree_swagger/Package.schema.json

@@ -48,6 +48,10 @@
       "name": "get_caster_definition",
       "schema": "packages/ree_swagger/schemas/ree_swagger/functions/get_caster_definition.schema.json"
     },
+    {
+      "name": "get_mime_type",
+      "schema": "packages/ree_swagger/schemas/ree_swagger/functions/get_mime_type.schema.json"
+    },
     {
       "name": "get_serializer_definition",
       "schema": "packages/ree_swagger/schemas/ree_swagger/functions/get_serializer_definition.schema.json"

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

@@ -3,12 +3,17 @@ class ReeSwagger::EndpointDto
   include Ree::LinkDSL
 
   link 'ree_swagger/dto/error_dto', -> { ErrorDto }
+  link 'ree_swagger/functions/get_mime_type', -> { MIME_TYPES }
+
 
   properties(
     method: Or[:get, :post, :put, :patch, :delete],
+    respond_to: Or[*MIME_TYPES.keys],
+    sections: Nilor[ArrayOf[String]],
     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

@@ -4,6 +4,7 @@ class ReeSwagger::BuildEndpointSchema
   include Ree::FnDSL
 
   fn :build_endpoint_schema do
+    link :get_mime_type
     link :build_parameters
     link :build_request_body_schema
     link :build_serializer_schema
@@ -31,6 +32,8 @@ class ReeSwagger::BuildEndpointSchema
       }
       .join('/')
 
+    mime_type = get_mime_type(endpoint.respond_to)
+
     missed_caster = path_params - endpoint.caster&.fields&.keys.to_a
 
     if missed_caster.any?
@@ -47,7 +50,7 @@ class ReeSwagger::BuildEndpointSchema
 
       request_body = request_body_schema && {
         content: {
-          :'application/json' => {
+          :"#{mime_type}" => {
             schema: request_body_schema
           }
         }
@@ -65,7 +68,7 @@ class ReeSwagger::BuildEndpointSchema
 
         request_body_schema && {
           content: {
-            :'application/json' => {
+            :"#{mime_type}" => {
               schema: request_body_schema
             }
           }
@@ -78,7 +81,7 @@ class ReeSwagger::BuildEndpointSchema
 
     if endpoint.serializer
       response_schema[:content] = {
-        :'application/json' => {
+        :"#{mime_type}" => {
           schema: build_serializer_schema(endpoint.serializer)
         }
       }
@@ -105,9 +108,11 @@ class ReeSwagger::BuildEndpointSchema
 
     method_schema[:summary] =  endpoint.summary if endpoint.summary
     method_schema[:description] =  endpoint.description if endpoint.description
+    method_schema[:tags] = endpoint.sections if endpoint.sections
 
     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

@@ -16,11 +16,14 @@ class ReeSwagger::BuildRequestBodySchema
       return get_caster_definition(mapper.type, method(:call).to_proc)
     end
 
+    required_fields = []
+
     properties = mapper.fields.each_with_object({}) do |(_name, field), acc|
       next if path_params.include?(field.name)
 
       swagger_field = {}
 
+      required_fields << field.name.to_s if !field.optional
       field_mapper = field.type
       swagger_type = call(field_mapper)
       swagger_field.merge!(swagger_type) if swagger_type
@@ -35,9 +38,11 @@ class ReeSwagger::BuildRequestBodySchema
 
     return if properties.empty?
 
-    {
+    obj = {
       type: 'object',
-      properties: properties
+      properties: properties,
     }
+    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/package/ree_swagger/functions/get_mime_type.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class ReeSwagger::GetMimeType
+  include Ree::FnDSL
+
+  MIME_TYPES = {
+    :html => "text/html", 
+    :text => "text/plain", 
+    :js => "text/javascript", 
+    :css => "text/css", 
+    :ics => "text/calendar", 
+    :csv => "text/csv", 
+    :vcf => "text/vcard", 
+    :vtt => "text/vtt", 
+    :png => "image/png", 
+    :jpeg => "image/jpeg", 
+    :gif => "image/gif", 
+    :bmp => "image/bmp", 
+    :tiff => "image/tiff", 
+    :svg => "image/svg+xml", 
+    :mpeg => "video/mpeg", 
+    :mp3 => "audio/mpeg", 
+    :ogg => "audio/ogg", 
+    :m4a => "audio/aac", 
+    :webm => "video/webm", 
+    :mp4 => "video/mp4", 
+    :otf => "font/otf", 
+    :ttf => "font/ttf", 
+    :woff => "font/woff", 
+    :woff2 => "font/woff2", 
+    :xml => "application/xml", 
+    :rss => "application/rss+xml", 
+    :atom => "application/atom+xml", 
+    :yaml => "application/x-yaml", 
+    :multipart_form => "multipart/form-data", 
+    :url_encoded_form => "application/x-www-form-urlencoded", 
+    :json => "application/json", 
+    :pdf => "application/pdf", 
+    :zip => "application/zip", 
+    :gzip => "application/gzip"
+  }.freeze
+
+  fn :get_mime_type
+
+  contract(Or[*MIME_TYPES.keys] => String)
+  def call(type)
+    MIME_TYPES.fetch(type)
+  end
+end

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

@@ -44,6 +44,14 @@
       "as": "build_serializer_schema",
       "imports": [
 
+      ]
+    },
+    {
+      "target": "get_mime_type",
+      "package_name": "ree_swagger",
+      "as": "get_mime_type",
+      "imports": [
+
       ]
     }
   ]

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/schemas/ree_swagger/functions/get_mime_type.schema.json

@@ -0,0 +1,27 @@
+{
+  "schema_type": "object",
+  "schema_version": "1.0",
+  "name": "get_mime_type",
+  "path": "packages/ree_swagger/package/ree_swagger/functions/get_mime_type.rb",
+  "mount_as": "fn",
+  "class": "ReeSwagger::GetMimeType",
+  "factory": null,
+  "methods": [
+    {
+      "doc": "",
+      "throws": [
+
+      ],
+      "return": "String",
+      "args": [
+        {
+          "arg": "type",
+          "type": "Or[html, text, js, css, ics, csv, vcf, vtt, png, jpeg, gif, bmp, tiff, svg, mpeg, mp3, ogg, m4a, webm, mp4, otf, ttf, woff, woff2, xml, rss, atom, yaml, multipart_f..., url_encoded..., json, pdf, zip, gzip]"
+        }
+      ]
+    }
+  ],
+  "links": [
+
+  ]
+}

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

@@ -60,9 +60,20 @@ RSpec.describe :build_endpoint_schema do
       locales :locale
     end
 
+    file_caster = mapper_factory.call.use(:cast) do
+      integer :id
+    end
+
+    file_serializer = mapper_factory.call.use(:serialize) do
+      string :data
+    end
+
     schema = build_endpoint_schema(ReeSwagger::EndpointDto.new(
       method:          :post,
+      respond_to:      :json,
+      authenticate:    false,
       path:            '/versions/:id',
+      sections:        ["versions"],
       caster:          caster,
       serializer:      serializer,
       response_status: 200,
@@ -84,6 +95,20 @@ 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,
+      serializer:      file_serializer,
+      response_status: 200,
+      description:     "file",
+      summary:         "file summary",
+      errors:          []
+    ))
+
     expect(schema).to eq(ReeSwagger::PathDto.new(
       path: '/versions/{id}',
       schema: {
@@ -108,13 +133,15 @@ RSpec.describe :build_endpoint_schema do
                       properties: {
                         name: { type: 'string' },
                         value: { type: 'string' }
-                      }
+                      },
+                      required: ['name', 'value']
                     },
                     locale: {
                       type: 'string',
                       enum: ['en', 'ru']
                     }
-                  }
+                  },
+                  required: ['name', 'tag', 'locale']
                 }
               }
             }
@@ -143,6 +170,41 @@ RSpec.describe :build_endpoint_schema do
           },
           summary: "summary",
           description: "description",
+          tags: ["versions"]
+        }
+      }
+    ))
+
+    expect(csv_schema).to eq(ReeSwagger::PathDto.new(
+      path: '/files/{id}',
+      schema: {
+        get: {
+          parameters: [
+            {
+              name: 'id',
+              in: 'path',
+              required: true,
+              schema: { type: 'integer' }
+            }
+          ],
+          responses: {
+            200 => {
+              description: '',
+              content: {
+                :'text/csv' => {
+                  schema: {
+                    type: 'object',
+                    properties: {
+                      data: { type: 'string' }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          summary: "file summary",
+          description: "file",
+          tags: ["files"]
         }
       }
     ))
@@ -165,6 +227,8 @@ RSpec.describe :build_endpoint_schema do
       method:          :get,
       path:            '/versions/:id',
       caster:          caster,
+      respond_to:      :json,
+      authenticate:    false,
       serializer:      nil,
       response_status: 200,
       description:     nil,
@@ -202,9 +266,11 @@ RSpec.describe :build_endpoint_schema do
                     properties: {
                       x: { type: 'integer' },
                       y: { type: 'integer' }
-                    }
+                    },
+                    required: ['x', 'y']
                   }
-                }
+                },
+                required: ['text', 'point']
               },
               style: 'deepObject'
             }
@@ -224,6 +290,8 @@ RSpec.describe :build_endpoint_schema do
       build_endpoint_schema(ReeSwagger::EndpointDto.new(
         method:          :get,
         path:            '/versions/:id',
+        respond_to:      :json,
+        authenticate:    false,
         caster:          nil,
         serializer:      nil,
         response_status: 200,
@@ -246,6 +314,8 @@ RSpec.describe :build_endpoint_schema do
       build_endpoint_schema(ReeSwagger::EndpointDto.new(
         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_request_body_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe :build_request_body_schema_spec do
+  link :build_request_body_schema, from: :ree_swagger
+  link :build_mapper_factory, from: :ree_mapper
+  link :build_mapper_strategy, from: :ree_mapper
+
+  let(:mapper_factory) {
+    strategies = [
+      build_mapper_strategy(method: :cast, output: :symbol_key_hash),
+    ]
+
+    build_mapper_factory(
+      strategies: strategies
+    )
+  }
+
+  it {
+    caster = mapper_factory.call.use(:cast) do
+      string :name
+      string :email
+      string? :last_name
+    end
+
+    schema = {
+      type: "object",
+      properties: {
+        name: { type: "string" },
+        email: { type: "string" },
+        last_name: { type: "string" }
+      },
+      required: ["name", "email"]
+    }
+
+    expect(build_request_body_schema(caster)).to eq(schema)
+  }
+end

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

@@ -6,9 +6,12 @@ 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,
         serializer:      nil,
         response_status: 200,
@@ -26,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.7"
+  VERSION = "1.0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.10
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-07 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ree
@@ -1122,6 +1122,7 @@ files:
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_schema.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_serializer_schema.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/get_caster_definition.rb
+- lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/get_mime_type.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/get_serializer_definition.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/register_type.rb
 - lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/beans/type_definitions_repo.schema.json
@@ -1131,10 +1132,12 @@ files:
 - lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/functions/build_schema.schema.json
 - lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/functions/build_serializer_schema.schema.json
 - lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/functions/get_caster_definition.schema.json
+- lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/functions/get_mime_type.schema.json
 - lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/functions/get_serializer_definition.schema.json
 - lib/ree_lib/packages/ree_swagger/schemas/ree_swagger/functions/register_type.schema.json
 - lib/ree_lib/packages/ree_swagger/spec/functions/build_endpoint_schema_spec.rb
 - lib/ree_lib/packages/ree_swagger/spec/functions/build_parameters_spec.rb
+- lib/ree_lib/packages/ree_swagger/spec/functions/build_request_body_spec.rb
 - lib/ree_lib/packages/ree_swagger/spec/functions/build_schema_spec.rb
 - lib/ree_lib/packages/ree_swagger/spec/functions/build_serializer_schema_spec.rb
 - lib/ree_lib/packages/ree_swagger/spec/functions/register_type_spec.rb