ree_lib 1.0.5 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9481a0ea7f7bebebf1386a48fb558859ff18c761ebece7f56b0e43e279fd1945
-  data.tar.gz: 98aa337a94ab47d178e45f54f94b15027c0d6a71c164df5d0450874fe8e876d1
+  metadata.gz: 21753e8008242096b9b9f780b264e6826a963d0b3e18ae04a2996ed00426ef6d
+  data.tar.gz: 5fc2d171c79e6c657358fec5caf57f0fde2adb19a19e95361290725144c9f4b3
 SHA512:
-  metadata.gz: 7b5b129cb9045109d08a53a938d446eb6210ea23f63f9656abd77d0c1344fb2c7297c51a5983e1ebb61d9829977f40facc83ae6e4f8c8e7f9845e869292c25be
-  data.tar.gz: b1e945345d629c4fe23283660d0328a186308559f2b3c4c6fd2e2ed2cadcf6d300f8c9946e947b51010902a732547dbe408e2248075030466d0a9387871d3f08
+  metadata.gz: d345bf12b261d42a34cb0fcfe17345f012218a2eb63bef1b4c132283f3b87fd9285775ab36b246330573f5247515c156e2f76c784f34d790f1cf3ea4ed327d14
+  data.tar.gz: cbe232fb49e266695f68db6c60fbcf7568ceeae79a15bae9c73c051bd97ab44a255f26edf942fae9fafac99bbe474af9d1dbd0a5075aa344a519e8238a92e2c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ree_lib (1.0.5)
+    ree_lib (1.0.8)
       binding_of_caller (~> 1.0.0)
       i18n (~> 1.12.0)
       loofah (~> 2.18.0)
@@ -36,8 +36,6 @@ 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)
@@ -46,7 +44,7 @@ GEM
     racc (1.6.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    ree (1.0.2)
+    ree (1.0.3)
       commander (~> 4.6.0)
     rexml (3.2.5)
     rollbar (3.3.1)

data/lib/ree_lib/packages/ree_logger/package/ree_logger/appenders/rollbar_appender.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'appender'
-require 'rollbar'
 require 'digest'
 
 class ReeLogger::RollbarAppender < ReeLogger::Appender
@@ -23,6 +22,8 @@ class ReeLogger::RollbarAppender < ReeLogger::Appender
   def initialize(level, access_token:, environment:, **opts)
     super(level, nil)
 
+    require 'rollbar'
+
     Rollbar.configure do |config|
       config.enabled = true
       config.access_token = access_token

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],
+    summary: Nilor[String],
     description: Nilor[String],
     response_status: Integer,
     response_description: Nilor[String],

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
@@ -14,7 +15,7 @@ class ReeSwagger::BuildEndpointSchema
   METHODS_WITH_BODY = [:post, :put, :patch].freeze
   MissingCasterError = Class.new(StandardError)
 
-  contract(EndpointDto => ReeSwagger::PathDto)
+  contract(EndpointDto => PathDto)
   def call(endpoint)
     path_params = []
 
@@ -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)
         }
       }
@@ -103,12 +106,16 @@ class ReeSwagger::BuildEndpointSchema
       responses: responses
     }
 
+    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
 
     schema = {endpoint.method => method_schema}
 
-    ReeSwagger::PathDto.new(
+    PathDto.new(
       path: path,
       schema: 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
@@ -37,7 +40,8 @@ class ReeSwagger::BuildRequestBodySchema
 
     {
       type: 'object',
-      properties: properties
+      properties: properties,
+      required: required_fields
     }
   end
 end

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/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,13 +60,24 @@ 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,
       path:            '/versions/:id',
+      sections:        ["versions"],
       caster:          caster,
       serializer:      serializer,
       response_status: 200,
-      description:     nil,
+      description:     "description",
+      summary:         "summary",
       errors:          [
         ReeSwagger::ErrorDto.new(
           status: 400,
@@ -83,6 +94,19 @@ RSpec.describe :build_endpoint_schema do
       ]
     ))
 
+    csv_schema = build_endpoint_schema(ReeSwagger::EndpointDto.new(
+      method:          :get,
+      respond_to:      :csv,
+      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: {
@@ -107,13 +131,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']
                 }
               }
             }
@@ -139,7 +165,44 @@ RSpec.describe :build_endpoint_schema do
             401 => {
               description: "- 401 error",
             }
-          }
+          },
+          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"]
         }
       }
     ))
@@ -162,9 +225,11 @@ RSpec.describe :build_endpoint_schema do
       method:          :get,
       path:            '/versions/:id',
       caster:          caster,
+      respond_to:      :json,
       serializer:      nil,
       response_status: 200,
       description:     nil,
+      summary:         nil,
       errors:          []
     ))
 
@@ -198,9 +263,11 @@ RSpec.describe :build_endpoint_schema do
                     properties: {
                       x: { type: 'integer' },
                       y: { type: 'integer' }
-                    }
+                    },
+                    required: ['x', 'y']
                   }
-                }
+                },
+                required: ['text', 'point']
               },
               style: 'deepObject'
             }
@@ -220,10 +287,12 @@ RSpec.describe :build_endpoint_schema do
       build_endpoint_schema(ReeSwagger::EndpointDto.new(
         method:          :get,
         path:            '/versions/:id',
+        respond_to:      :json,
         caster:          nil,
         serializer:      nil,
         response_status: 200,
         description:     nil,
+        summary:         nil,
         errors:          []
       ))
     }.to raise_error(
@@ -241,10 +310,12 @@ RSpec.describe :build_endpoint_schema do
       build_endpoint_schema(ReeSwagger::EndpointDto.new(
         method:          :get,
         path:            '/versions/:id',
+        respond_to:      :json,
         caster:          caster,
         serializer:      nil,
         response_status: 200,
         description:     nil,
+        summary:         nil,
         errors:          []
       ))
     }.to raise_error(

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

@@ -9,10 +9,12 @@ RSpec.describe :build_schema do
       endpoints: [ReeSwagger::EndpointDto.new(
         method:          :get,
         path:            '/version',
+        respond_to:      :json,
         caster:          nil,
         serializer:      nil,
         response_status: 200,
         description:     nil,
+        summary:         nil,
         errors:          []
       )]
     )

data/lib/ree_lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.8
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2022-08-15 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