webspicy 0.21.3 → 0.21.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc3c1464cb9c8972496a11fedda7a0dfda39e34ba82c5ad60a71ccc574d712c
-  data.tar.gz: 892220efe2eadc8e1b62ea7e97039814de451f8949b5a89030cca027b3b4c383
+  metadata.gz: 1a55b29fa6f9f5f48358b4a050582679f7e32816b82ea818c3f8d07ee1f6e166
+  data.tar.gz: 045b1c9ea0127645ddfd8bb14a7b464daa1c9a309d0796d31898800f7629637e
 SHA512:
-  metadata.gz: 74243ff6d5c32357fa04da777ec9eede39a703405c8297abc7246b9f023dd1a34ed38c6ca6564326265fc9b59c46ae227ea0698de19c3256ffca2dc50d3a0ff0
-  data.tar.gz: 79ed95fa65038bfff561c1956f728de2cfa57f705bc6d7b73bf8ba541d53f30056fc99eb231c28a1a91a5c61e8ca9b2b0ad8eaf1c5d5b482f9178068c97472ad
+  metadata.gz: d8d6e028b67558796b58b9a24ec27e0594b33160613838e211557a75e924447acafe9c75ead65a2d91cc4c62b55b714b8c45a9af1af3ad3d30f1ad80a379fce6
+  data.tar.gz: 251d467be2ec28bf4dd9f6026b71dae998290911bb613a53a540c888e2287ae7b9d81c57e947f35c451c7c975b096709692c44dddc1534204895dcc24613dca5

data/lib/webspicy/configuration/scope.rb

@@ -22,7 +22,9 @@ module Webspicy
       def _each_specification_file(config, apply_filter = true)
         folder = config.folder
         world  = config.folder/"world"
-        fs = folder.glob("**/*.{yml, yaml}").reject{|f| f.to_s.start_with?(world.to_s) }
+        fs = folder.glob("**/*.{yml, yaml}").reject{|f|
+          f.to_s.start_with?(world.to_s) || f.to_s =~ /openapi.base.yml/
+        }
         fs = fs.sort
         fs = fs.select(&to_filter_proc(config.file_filter)) if apply_filter
         fs.each do |file|

data/lib/webspicy/specification/service.rb

@@ -21,6 +21,10 @@ module Webspicy
         specification.config
       end
 
+      def name
+        @raw[:name]
+      end
+
       def description
         @raw[:description]
       end

data/lib/webspicy/support/deep_merge.rb

@@ -3,6 +3,19 @@ module Webspicy
     class DeepMerge
       class << self
 
+        def symbolize_keys(arg)
+          case arg
+          when Hash
+            arg.each_pair.each_with_object({}){|(k,v),memo|
+              memo[k.to_sym] = symbolize_keys(v)
+            }
+          when Array
+            arg.map{|item| symbolize_keys(item) }
+          else
+            arg
+          end
+        end
+
         def deep_merge(h1, h2)
           merge_maps(deep_dup(h1), deep_dup(h2))
         end

data/lib/webspicy/tester/result.rb

@@ -13,6 +13,7 @@ module Webspicy
         @invocation = tester.invocation
         @assertions = []
         @failures = []
+        @warnings = []
         @errors = []
         if @invocation
           check!

data/lib/webspicy/version.rb

@@ -2,7 +2,7 @@ module Webspicy
   module Version
     MAJOR = 0
     MINOR = 21
-    TINY  = 3
+    TINY  = 5
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/lib/webspicy/web/formaldoc.fio

@@ -36,6 +36,7 @@ Specification = .Webspicy::Web::Specification
 
 Service =
     .Webspicy::Web::Specification::Service <info> {
+        name            :? String
         method          :  Method
         description     :  String
         preconditions   :? [String]|String

data/lib/webspicy/web/openapi/generator.rb

@@ -1,10 +1,18 @@
-require "finitio/generation"
-require "finitio/json_schema"
+require 'finitio/generation'
+require 'finitio/json_schema'
 module Webspicy
   module Web
     module Openapi
       class Generator
 
+        DEFAULT_OPENAPI = {
+          openapi: '3.0.2',
+          info: {
+            version: '1.0.0',
+            title: 'Webspicy Specification'
+          }
+        }
+
         def initialize(config)
           @config = Configuration.dress(config)
           @generator = config.generator || Finitio::Generation.new(
@@ -13,19 +21,49 @@ module Webspicy
         end
         attr_reader :config, :generator
 
-        def call
-          {
-            openapi: "3.0.2",
-            info: {
-              version: "1.0.0",
-              title: "Hello API"
-            },
-            paths: paths
-          }
+        def call(info = {})
+          base = Support::DeepMerge.deep_merge(
+            DEFAULT_OPENAPI,
+            base_openapi
+          )
+          Support::DeepMerge.deep_merge(
+            base,
+            {
+              info: info,
+              tags: tags,
+              paths: paths
+            }
+          )
         end
 
       private
 
+        def base_openapi
+          file = config.folder/'openapi.base.yml'
+          if file.exists?
+            Support::DeepMerge.symbolize_keys(file.load)
+          else
+            {}
+          end
+        end
+
+        def tags
+          config.each_scope.inject([]) do |tags,scope|
+            scope.each_specification.inject(tags) do |tags,specification|
+              tags + tags_for(specification)
+            end
+          end.uniq.sort_by{|t| t[:name] }
+        end
+
+        def tags_for(specification)
+          return [] unless specification.name.is_a?(String)
+          return [] if specification.name.empty?
+
+          [{
+            name: specification.name.gsub(/\n/, ' ').strip
+          }]
+        end
+
         def paths
           config.each_scope.inject({}) do |paths,scope|
             scope.each_specification.inject(paths) do |paths,specification|
@@ -53,11 +91,13 @@ module Webspicy
           specification.services.inject({}) do |verbs,service|
             verb = service.method.downcase.gsub(/_form$/, '')
             verb_defn = {
+              summary: service.name,
               description: service.description,
+              tags: tags_for(specification).map{|s| s[:name] },
               parameters: parameters_for(service),
               responses: responses_for(service)
             }.compact
-            unless ["get", "options", "delete", "head"].include?(verb)
+            unless ['get', 'options', 'delete', 'head'].include?(verb)
               verb_defn[:requestBody] = request_body_for(service)
             end
             verbs.merge({ verb => verb_defn })
@@ -70,7 +110,7 @@ module Webspicy
           {
             required: true,
             content: {
-              "application/json" => {
+              'application/json' => {
                 schema: schema.to_json_schema,
                 example: example
               }.compact
@@ -84,7 +124,7 @@ module Webspicy
             {
               in: 'path',
               name: p,
-              schema: { type: "string" },
+              schema: { type: 'string' },
               required: true
             }
           }

data/lib/webspicy/web/specification/service.rb

@@ -2,11 +2,9 @@ module Webspicy
   module Web
     class Specification
       class Service < Webspicy::Specification::Service
-
         def method
           @raw[:method]
         end
-
       end # class Service
     end # class Specification
   end # module Web

data/spec/unit/configuration/scope/test_each_specification.rb

@@ -18,7 +18,8 @@ module Webspicy
         }
 
         it 'returns all files' do
-          expect(subject.size).to eql(restful_folder.glob('**/*.{yml, yaml}').size)
+          # -1 because of openapi.base.yml
+          expect(subject.size).to eql(restful_folder.glob('**/*.{yml, yaml}').size - 1)
         end
       end
 
@@ -59,7 +60,8 @@ module Webspicy
         }
 
         it 'returns all files' do
-          expect(subject.size).to eql(restful_folder.glob('**/*.{yml, yaml}').size)
+          # -1 because of openapi.base.yml
+          expect(subject.size).to eql(restful_folder.glob('**/*.{yml, yaml}').size - 1)
         end
       end
 

data/spec/unit/web/openapi/test_generator.rb

@@ -6,23 +6,46 @@ module Webspicy
   module Web
     module Openapi
       describe Generator do
-
-        let(:config) {
+        let(:config) do
           Configuration.new(restful_folder)
-        }
+        end
 
-        subject {
-          ruby_objs = Generator.new(config).call
+        subject do
+          ruby_objs = Generator.new(config).call(info)
           JSON.parse(ruby_objs.to_json)
-        }
+        end
 
-        it 'works fine' do
-          document = Openapi3Parser.load(subject)
+        let(:info) do
+          {}
+        end
+
+        def openapi_document
           #puts JSON.pretty_generate(subject)
+          document = Openapi3Parser.load(subject)
           document.errors.each do |err|
             puts err.inspect
           end unless document.errors.empty?
-          expect(document.errors).to be_empty
+          document
+        end
+
+        it 'works fine' do
+          expect(openapi_document.errors).to be_empty
+          expect(openapi_document.info.title).to eql('Todo API')
+        end
+
+        describe 'when passing specific info' do
+          let(:info) {
+            {
+              version: '1.1.1',
+              title: 'Webspicy API'
+            }
+          }
+
+          it 'takes it into account' do
+            expect(openapi_document.errors).to be_empty
+            expect(openapi_document.info.title).to eql('Webspicy API')
+            expect(openapi_document.info.version).to eql('1.1.1')
+          end
         end
 
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.21.3
+  version: 0.21.5
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -408,7 +408,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!