webspicy 0.21.4 → 0.21.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba04baed1cda2292312644692901a18bc5a24f04a27be985a27097417ed731a9
-  data.tar.gz: 67edeff75f3cc4064c197efbd65b2bc4533b7214033226e31092b19f21bdc355
+  metadata.gz: dd39249e2d93a03a088b344c149394e112e57e8b34f5fb20ae2d48018a7c48c5
+  data.tar.gz: 73cbf44b32c9f8609106ddac8495e94d590d3d827325ca40ce7d7d483b35767d
 SHA512:
-  metadata.gz: 560122db62b3024ad5ab6c76f171438e2c45ed4bc1b23fcc9af895e444a7c86ba655826f59d1719ed3020e6bc75d224a072717391ab0862a09f37cb96f89c61a
-  data.tar.gz: 1ffb6d303cfcec6cc4d19c3f03c94f54acd16e50246f73171d00ab878229bf6fe16b18e4c16f9f8c139ca0557134d1b2c66af53c0c4c5cc3ef68782bd32c4710
+  metadata.gz: bddeb1dc84bcbe261f037df5051e575d2540eb781538bc240b736b33b15b7d6876362ffcce456510a9fa90e8b2574952c73006bec8e670a5cc737f625402b843
+  data.tar.gz: 8e0c0275a2b14909491ca835e002fb33869f0d44617605339869a1275ccaf5457b1e1cda356106cd23ef4bd4d73c595bac151d551cf9144bfb363062eb49ca5d

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,10 +21,18 @@ module Webspicy
         specification.config
       end
 
+      def name
+        @raw[:name]
+      end
+
       def description
         @raw[:description]
       end
 
+      def conditions
+        preconditions + postconditions
+      end
+
       def preconditions
         @preconditions ||= compile_preconditions
       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/version.rb

@@ -2,7 +2,7 @@ module Webspicy
   module Version
     MAJOR = 0
     MINOR = 21
-    TINY  = 4
+    TINY  = 6
   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/ext.rb

@@ -0,0 +1,18 @@
+module Webspicy
+  class Specification
+    module Pre
+
+      def contribute_to_openapi_verb(verb_defn)
+        verb_defn
+      end
+
+    end # module Pre
+    module Post
+
+      def contribute_to_openapi_verb(verb_defn)
+        verb_defn
+      end
+
+    end # module Post
+  end # class Specification
+end # module Webspicy

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(
@@ -14,18 +22,48 @@ module Webspicy
         attr_reader :config, :generator
 
         def call(info = {})
-          {
-            openapi: "3.0.2",
-            info: {
-              version: "1.0.0",
-              title: "Webspicy Specification"
-            }.merge(info),
-            paths: paths
-          }
+          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,13 +91,22 @@ 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
+            verb_defn = service.conditions.inject(verb_defn) do |memo, p|
+              if p.respond_to?(:contribute_to_openapi_verb)
+                p.contribute_to_openapi_verb(memo)
+              else
+                memo
+              end
+            end
             verbs.merge({ verb => verb_defn })
           end
         end
@@ -70,7 +117,7 @@ module Webspicy
           {
             required: true,
             content: {
-              "application/json" => {
+              'application/json' => {
                 schema: schema.to_json_schema,
                 example: example
               }.compact
@@ -84,7 +131,7 @@ module Webspicy
             {
               in: 'path',
               name: p,
-              schema: { type: "string" },
+              schema: { type: 'string' },
               required: true
             }
           }

data/lib/webspicy/web/openapi.rb

@@ -1 +1,2 @@
 require_relative 'openapi/generator'
+require_relative 'openapi/ext'

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

@@ -20,6 +20,7 @@ module Webspicy
         end
 
         def openapi_document
+          #puts JSON.pretty_generate(subject)
           document = Openapi3Parser.load(subject)
           document.errors.each do |err|
             puts err.inspect
@@ -29,7 +30,7 @@ module Webspicy
 
         it 'works fine' do
           expect(openapi_document.errors).to be_empty
-          expect(openapi_document.info.title).to eql('Webspicy Specification')
+          expect(openapi_document.info.title).to eql('Todo API')
         end
 
         describe 'when passing specific info' do
@@ -41,9 +42,9 @@ module Webspicy
           }
 
           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')
+            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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.21.4
+  version: 0.21.6
 platform: ruby
 authors:
 - Bernard Lambeau
@@ -351,6 +351,7 @@ files:
 - lib/webspicy/web/mocker.rb
 - lib/webspicy/web/mocker/config.ru
 - lib/webspicy/web/openapi.rb
+- lib/webspicy/web/openapi/ext.rb
 - lib/webspicy/web/openapi/generator.rb
 - lib/webspicy/web/specification.rb
 - lib/webspicy/web/specification/file_upload.rb