open_api_import 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b391f64d44cb78f95b9e4765f98023d3939752f5802e390fd8b972502061579
-  data.tar.gz: '08f6d8b7427f2dd8251c220314288b7e36cfdad30d89cf5d83e462640a5679cd'
+  metadata.gz: 17c79278e2222735a82cd0665f8f5d616e1dfd347d5b90bd30bf30cafbcefbe3
+  data.tar.gz: 8987e63d22bc8ba904c28176847092a9852977a0f096642eb86421f9738a2371
 SHA512:
-  metadata.gz: 8e42c5dbde362282c5385b48d21852166dacb9283f5fd0e19a52a45f001a94a92d85df840c462c87252521b3a70f90bc2a1911b3cf55a787127df35bc6ca177f
-  data.tar.gz: 589ce2df15ad9589fe1900db1a2ff455b7c9e73cd98f07eda7005f79c221f65f2f149bc99ce45246979fe84a5cf993ff2a0809cea481799a99637698c9b57acd
+  metadata.gz: e70c1b50b46943027b866fcb05039de1f6bb3349188d37968e014ff4eed41112e99830d3e4caae33933ed7951395efc54351d7e01c9fc11794e49f6c38c14836
+  data.tar.gz: 1840e5b30244b7de1ed8fd60c5d62b87de9cd25709ff0506b43f17db994ee3301d27cc555bb1d89d7d395d0ea2a1fefbaf1f1e112aa7a2854704b529130ae65b

data/README.md

@@ -8,8 +8,6 @@ Import a Swagger or Open API file and create a Ruby Request Hash file including
 
 The Request Hash will include also the pattern (regular expressions) of the fields,  parameters, default values...
 
-On this first preliminary version we only fully support Open API v2. Open API v3 is not fully supported yet.
-
 The output of this gem will be following the specification of Request Hashes: https://github.com/MarioRuiz/Request-Hash
 
 The Request Hashes generated will be able to be used with any Ruby Http Client and it is adapted even better with nice_http gem: https://github.com/MarioRuiz/nice_http

data/lib/open_api_import.rb

@@ -60,10 +60,6 @@ class OpenApiImport
       end
       if raw[:swagger].to_f < 2.0
         raise "Unsupported Swagger version. Only versions >= 2.0 are valid."
-      elsif raw[:swagger].to_f >= 3.0
-        message = "Take in consideration Open API #{raw[:swagger]} is not fully supported for the moment while we are in preliminary version of open_api_import."
-        warn message
-        @logger.warn message
       end
 
       base_host = ""
@@ -228,10 +224,26 @@ class OpenApiImport
 
               end
             end
+            # todo: for open api 3.0 add the new Link feature: https://swagger.io/docs/specification/links/
+            # todo: for open api 3.0 is not getting the required params in all cases
+
+            # for the case open api 3 with cont.requestBody.content.'applicatin/json'.schema
+            # example: petstore-expanded.yaml operationId=addPet
+            if cont.key?(:requestBody) and cont[:requestBody].key?(:content) and 
+              cont[:requestBody][:content].key?(:'application/json') and cont[:requestBody][:content][:'application/json'].key?(:schema)
+              cont[:parameters] = [] unless cont.key?(:parameters)
+              cont[:parameters] << {in: 'body', schema: cont[:requestBody][:content][:'application/json'][:schema] }
+            end
 
-            # todo: for open api 3.0 is not getting the required params
             if cont.key?(:parameters) && cont[:parameters].is_a?(Array)
               cont[:parameters].each do |p|
+                if p.keys.include?(:schema) and p[:schema].include?(:type)
+                  type = p[:schema][:type]
+                elsif p.keys.include?(:type)
+                  type = p[:type]
+                else
+                  type = ""
+                end
                 if p[:in] == "path"
                   if create_method_name == :operationId
                     param_name = p[:name]
@@ -242,19 +254,13 @@ class OpenApiImport
                   end
                   params_path << param_name
                   #params_required << param_name if p[:required].to_s=="true"
-
-                  if p.keys.include?(:description)
-                    description_parameters << "#    #{p[:name]}: (#{p[:type]}) #{"(required)" if p[:required].to_s=="true"} #{p[:description]}"
-                  end
+                  description_parameters << "#    #{p[:name]}: (#{type}) #{"(required)" if p[:required].to_s=="true"} #{p[:description]}"
                 elsif p[:in] == "query"
                   params_query << p[:name]
                   params_required << p[:name] if p[:required].to_s=="true"
-                  if p.keys.include?(:description)
-                    description_parameters << "#    #{p[:name]}: (#{p[:type]}) #{"(required)" if p[:required].to_s=="true"} #{p[:description]}"
-                  end
+                  description_parameters << "#    #{p[:name]}: (#{type}) #{"(required)" if p[:required].to_s=="true"} #{p[:description]}"
                 elsif p[:in] == "body"
                   if p.keys.include?(:schema)
-                    #jal
                     if p[:schema].key?(:oneOf)
                       bodies = p[:schema][:oneOf]
                     elsif p[:schema].key?(:anyOf)
@@ -556,7 +562,14 @@ class OpenApiImport
     private def get_response_examples(v)
       # TODO: take in consideration the case allOf, oneOf... schema.items.allOf[0].properties schema.items.allOf[1].properties
       # example on https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v2.0/yaml/petstore-expanded.yaml
+      v=v.dup
       response_example = Array.new()
+      # for open api 3.0 with responses schema inside content
+      if v.key?(:content) && v[:content].is_a?(Hash) && v[:content].key?(:'application/json') &&
+        v[:content][:'application/json'].key?(:schema)
+        v=v[:content][:'application/json'].dup
+      end
+
       if v.key?(:examples) && v[:examples].is_a?(Hash) && v[:examples].key?(:'application/json')
         if v[:examples][:'application/json'].is_a?(String)
           response_example << v[:examples][:'application/json']
@@ -575,6 +588,36 @@ class OpenApiImport
           end
           response_example << "]"
         end
+      # for open api 3.0. examples on reponses, for example: api-with-examples.yaml
+      elsif v.key?(:content) && v[:content].is_a?(Hash) && v[:content].key?(:'application/json') &&
+        v[:content][:'application/json'].key?(:examples)
+        v[:content][:'application/json'][:examples].each do |tk, tv|
+          #todo: for the moment we only take in consideration the first example of response. 
+          # we need to decide how to manage to do it correctly
+          if tv.key?(:value)
+            tresp = tv[:value]
+          else
+            tresp = ""
+          end
+          if tresp.is_a?(String)
+            response_example << tresp
+          elsif tresp.is_a?(Hash)
+            exs = tresp.to_s
+            exs.gsub!(/:(\w+)=>/, "\n\\1: ")
+            response_example << exs
+          elsif tresp.is_a?(Array)
+            response_example << "["
+            tresp.each do |ex|
+              exs = ex.to_s
+              if ex.is_a?(Hash)
+                exs.gsub!(/:(\w+)=>/, "\n\\1: ")
+              end
+              response_example << (exs + ", ")
+            end
+            response_example << "]"
+          end
+          break #only the first one it is considered
+        end
       elsif v.key?(:schema) && v[:schema].is_a?(Hash) &&
             (v[:schema].key?(:properties) ||
              (v[:schema].key?(:items) && v[:schema][:items].key?(:properties)) ||

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_import
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oas_parser