swagger-dsl 1.5.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 786aa5eea8ae2c2ce700f8c9bf9777da355f5647788d0fd7a1756316017bc182
-  data.tar.gz: 879edc53b7549aa2d194428cdc66f94080adc7c1e306c9aa6d67612606d4639c
+  metadata.gz: 0705c9ed69ca2d85b649a9303ffedf6994945ceb125223d83d2a69b41f25b6c4
+  data.tar.gz: 8c36b3e9c7a2cfa3d259ab601ace110a204305306e9456950a1589dd6ee04da3
 SHA512:
-  metadata.gz: f3462fb293dfb7f055d80ec3d027a2b33c9d5a973c84a0aaa2b84c566e7587bbfaa456a0e17e24321e1d525e22356314e9aa203d58f5c33ffac6d47d90d0f0e3
-  data.tar.gz: eb112da3508f85283177a6bdfb375f487880b5f32a2c18f301d21f4f221981fe7cf3e42c84f868e933032254fa944d790618be327ceba1648d1b183be79d2df0
+  metadata.gz: cb8144de2b171a95c8a8ed1bd0ad49c0ada18ef8e4c997824b3c829fe68202ee8c5163686aae8a2b3c1d24f0d518e0edc84207d021517107eaca70d39c34bc56
+  data.tar.gz: e66d3beadaada0b4623d7506a05a6ba8843fdf0f8f5229c0ea7e4eee81d7d3242cba700a77d2caa1e620ce0987294d1742a51718606c3668706dad990bcb6c1d

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 2.0.2
+
+- fix: unique operation id
+
+## 2.0.1
+
+- fix(brake): nested class naming
+
+## 2.0.0
+
+- fix(brake): adjust to OAS3 spec
+
 ## 1.4.0
 
 - add: lazy_define_paths for Rails eager_load

data/lib/swagger/dsl/components.rb

@@ -18,7 +18,7 @@ module Swagger
       private
 
       def serializer_name(name)
-        name.to_s.sub(/(?:Serializer)?$/, "Serializer")
+        name.to_s.gsub(/-/, '::').sub(/(?:Serializer)?$/, "Serializer")
       end
     end
   end

data/lib/swagger/dsl/config.rb

@@ -13,7 +13,7 @@ module Swagger
       )
         @inject_key = inject_key
         @default_dsl = default_dsl
-        @dsl_options ||= { reference_name: ->(name) { name.sub(/Serializer$/, "") } }
+        @dsl_options ||= { reference_name: ->(name) { name.sub(/Serializer$/, "").gsub(/::/, '-') } }
         @eager = eager
         @default_required = default_required
         @lazy_define_paths = lazy_define_paths

data/lib/swagger/dsl/json_schema/jimmy_patch.rb

@@ -5,7 +5,7 @@ module Jimmy
   class SchemaCreation
     module Referencing
       def component(id)
-        name = "#/components/#{id}"
+        name = "#/components/schemas/#{id}"
         reference_name = Swagger::DSL.current.config.dsl_options[:reference_name]
         reference_name ? reference_name.call(name) : name
       end

data/lib/swagger/dsl/operation.rb

@@ -16,7 +16,6 @@ module Swagger
 
       def initialize(operation_id, format: :json, &block)
         self["operationId"] = operation_id
-        self["requestBody"] = { "content" => {}, "required" => true }
         self["responses"] = {}
         self["parameters"] = []
         self["tags"] = []
@@ -42,20 +41,24 @@ module Swagger
 
       def body(format: @format, dsl: nil, &block)
         formats(format).each do |f|
+          self["requestBody"] ||= { "required" => true }
+          self["requestBody"]["content"] ||= {}
           self["requestBody"]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
         end
       end
 
       def body_description(body_description = nil)
+        self["requestBody"] ||= { "required" => true }
         self["requestBody"]["description"] = body_description
       end
 
       def body_optional(optional = true)
+        self["requestBody"] ||= {}
         self["requestBody"]["required"] = optional
       end
 
       def render(code = 200, format: @format, dsl: nil, &block)
-        self["responses"][code] ||= { "content" => {} }
+        self["responses"][code] ||= { "content" => {}, "description" => "#{code}" }
         formats(format).each do |f|
           self["responses"][code]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
         end

data/lib/swagger/dsl/rails_controller.rb

@@ -17,8 +17,6 @@ module Swagger
       end
 
       def swagger_define_path(action, format = :json, path: nil, method: nil, &block)
-        operation_id = "#{name}##{action}"
-
         defaults = { action: action.to_s, controller: name.underscore.sub(/_controller$/, "") }
         route = Rails.application.routes.routes.routes.find { |r| r.required_defaults == defaults }
         unless route
@@ -32,6 +30,7 @@ module Swagger
         method = %w[put patch] if %w[put patch].include?(method)
         path ||= route.path.spec.to_s.sub("(.:format)", "").gsub(/:(\w+)/, "{\\1}")
 
+        operation_id = "#{name}##{action}.#{method}"
         operation = Swagger::DSL::Operation.new(operation_id, format: format, &block)
         Swagger::DSL.current["paths"][path] ||= {}
         Array(method).each { |single_method| Swagger::DSL.current["paths"][path][single_method] = operation }

data/lib/swagger/dsl/serializer.rb

@@ -5,8 +5,8 @@ module Swagger
   class DSL < Hash
     module Serializer
       def swagger(dsl: nil, &block)
-        name = self.name.sub(/Serializer$/, "")
-        Swagger::DSL.current["components"][name] =
+        name = self.name.sub(/Serializer$/, "").gsub(/::/, '-')
+        Swagger::DSL.current["components"]["schemas"][name] =
           Swagger::DSL::JsonSchema.by(dsl).dsl(&block).merge(Swagger::DSL.current.config.inject_key => name)
       end
 

data/lib/swagger/dsl/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   class DSL < Hash
-    VERSION = "1.5.1".freeze
+    VERSION = "2.0.2".freeze
   end
 end

data/lib/swagger/dsl.rb

@@ -20,9 +20,10 @@ module Swagger
     def initialize(schema = nil, config: Config.new)
       merge!(schema || {})
       self["openapi"] ||= "3.0.0"
-      self["info"] ||= {}
+      self["info"] ||= { "title" => "OpenAPI schema", "version" => "0.0.0" }
       self["paths"] ||= {}
-      self["components"] = Components[self["components"] || {}]
+      self["components"] ||= {}
+      self["components"]["schemas"] = Components[self["components"]["schemas"] || {}]
       @config = config
       @define_paths_procs = []
     end

data/swagger-dsl.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency "jimmy", "~> 0.5"
-  spec.add_dependency "json-schema-subset-dsl", "~> 1.2"
+  spec.add_dependency "json-schema-subset-dsl", "~> 2.0"
   spec.add_dependency "hana", "~> 1.3"
   spec.add_dependency "json_refs", "~> 0.1"
   spec.add_dependency "activesupport", ">= 4.0.2"
@@ -42,4 +42,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-config-prettier", "~> 0.1"
   spec.add_development_dependency "yard", "~> 0.9"
   spec.add_development_dependency "pry-byebug", "~> 3.7"
+  spec.add_development_dependency "json_spec", "~> 1"
+  spec.add_development_dependency "openapi3_parser", "~> 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-dsl
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Narazaka
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jimmy
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: hana
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: 
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: openapi3_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description:
 email:
 - info@narazaka.net
 executables: []
@@ -264,8 +292,8 @@ metadata:
   homepage_uri: https://github.com/Narazaka/swagger-dsl
   source_code_uri: https://github.com/Narazaka/swagger-dsl.git
   changelog_uri: https://github.com/Narazaka/swagger-dsl/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/1.5.1
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/2.0.2
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -281,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Swagger (OpenAPI 3) DSL
 test_files: []