open_api_import 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6272d1b18625fd79a6bce972cc8f5d59a9f227887a9f49bd75428b00ce8ead31
-  data.tar.gz: 2df97329435c449358524f6df94c0fcfb396a01907bf5956e39978b26d9db509
+  metadata.gz: 1f87b9b81f1429055c87f8a1008e79051eab82269f976fd4c1aa4fbe8ed4f748
+  data.tar.gz: 82a6fdc38c437e350dd16cac5daad820af3f1bffa7705799f33a5aa92b65cbf8
 SHA512:
-  metadata.gz: c26f0ddd02df9ebca565c2f3988e5bd76c4323669dfa1dd5c329b1eb697cf251ff4026a25e9955820d2680f7490c6084bffe04bd311e46963fcdfb1de1e0fbdf
-  data.tar.gz: e40ff5eff7f1755369c0bf83e0072c7e2c335b6ef4efa443ff539c57a5c231562a412be0a2bb18f29150f03c03edfa4c315aa4b5d90c9489397b4577d5a90d04
+  metadata.gz: 0ad5187d6bfd18bbbdacd09968a8c142c687bab121600a2f052e9fcc91729fddc2b7b11327cc1b79227b4e273921ec2a3d7b5893b613dfbd488471f22ed7b393
+  data.tar.gz: 5eafedf7aba260a9c4ad6aecd621a1f0fc2607993a519bd883c46814d67195f08d95c5d3019cd8618549659be26add433f2b02c534df7b6a607073d4c3e5d869

data/README.md

@@ -196,12 +196,16 @@ The output will generate methods like this:
 
 How the module names will be created.
 
-Accepts three different options: :path, :path_file and :fixed. By default :path. 
+Accepts five different options: :path, :path_file, :tags, :tags_file and :fixed. By default :path. 
 
   path: It will be used the first folder of the path to create the module name, for example the path /users/list will be in the module Users and all the requests from all modules in the same file.
   
   path_file: It will be used the first folder of the path to create the module name, for example the path /users/list will be in the module Users and each module will be in a new requests file.
 
+  tags: It will be used the tags key to create the module name, for example the tags: \[users, list] will create the module UsersList and all the requests from all modules in the same file. In case the tags are equal to the beginning of the operationId then it will be removed from the method name.
+  
+  tags_file: It will be used the tags key to create the module name, for example the tags: \[users, list] will create the module UsersList and and each module will be in a new requests file. In case the tags are equal to the beginning of the operationId then it will be removed from the method name.
+
   fixed: all the requests will be under the module Requests
 
 ```ruby
@@ -280,6 +284,37 @@ This is the output of the run:
   - /petstore-simple.yaml.rb
 ```
 
+In case using :tags
+
+```ruby
+  require 'open_api_import'
+
+  OpenApiImport.from "./spec/fixtures/v2.0/yaml/uber.yaml", name_for_module: :tags, create_method_name: :path
+
+```
+
+It will generate just one file including every request under the module generated from the first folder of the path
+
+```ruby
+module Swagger
+  module UberApi
+    module V1_0_0
+      module Products
+
+        # operationId: unknown, method: get
+        # summary: Product Types
+        # description:
+        #     The Products endpoint returns information about the Uber products offered at a given location. 
+        #     The response includes the display name and other details about each product, and lists the products in the proper display order.
+        # parameters description:
+        #    latitude: (number) (required) Latitude component of location.
+        #    longitude: (number) (required) Longitude component of location.
+        def self.get_products(latitude, longitude)
+...
+...
+```
+
+
 ### include_responses
 
 If you want to add the examples of responses in the resultant file.

data/lib/open_api_import.rb

@@ -20,6 +20,8 @@ class OpenApiImport
   # @param name_for_module [Symbol]. (:path, :path_file, :fixed) (default: :path). How the module names will be created.
   #   path: It will be used the first folder of the path to create the module name, for example the path /users/list will be in the module Users and all the requests from all modules in the same file.
   #   path_file: It will be used the first folder of the path to create the module name, for example the path /users/list will be in the module Users and each module will be in a new requests file.
+  #   tags: It will be used the tags key to create the module name, for example the tags: [users,list] will create the module UsersList and all the requests from all modules in the same file.
+  #   tags_file: It will be used the tags key to create the module name, for example the tags: [users,list] will create the module UsersList and and each module will be in a new requests file.
   #   fixed: all the requests will be under the module Requests
   ##############################################################################################
   def self.from(swagger_file, create_method_name: :operation_id, include_responses: true, mock_response: false, name_for_module: :path)
@@ -93,13 +95,15 @@ class OpenApiImport
       module_requests = ""
 
       definition.paths.each do |path|
+
         raw = path.raw.deep_symbolize_keys
 
         if raw.key?(:parameters)
           raw.each do |met, cont|
             if met != :parameters
               if raw[met].key?(:parameters)
-                raw[met][:parameters] = raw[met][:parameters] & raw[:parameters]
+                #todo: check if in some cases the parameters on the method can be added to the ones in the path
+                #raw[met][:parameters] = raw[met][:parameters] & raw[:parameters]
               else
                 raw[met][:parameters] = raw[:parameters]
               end
@@ -109,6 +113,7 @@ class OpenApiImport
         end
 
         raw.each do |met, cont|
+
           if %w[get post put delete patch].include?(met.to_s.downcase)
             params = []
             params_path = []
@@ -129,31 +134,48 @@ class OpenApiImport
               method_name = (met.to_s + "_" + path.path.to_s).snake_case
               method_name.chop! if method_name[-1] == "_"
             elsif create_method_name == :operation_id
-              method_name = (cont[:operationId]).to_s.snake_case
+              if (name_for_module == :tags or name_for_module == :tags_file) and cont.key?(:tags) and cont[:tags].is_a?(Array) and cont[:tags].size>0
+                metnametmp = cont[:operationId].gsub(/^#{cont[:tags].join}[\s_]*/, '')
+              else
+                metnametmp = cont[:operationId]
+              end
+              method_name = metnametmp.to_s.snake_case
             else
-              method_name = cont[:operationId]
+              if (name_for_module == :tags or name_for_module == :tags_file) and cont.key?(:tags) and cont[:tags].is_a?(Array) and cont[:tags].size>0
+                method_name = cont[:operationId].gsub(/^#{cont[:tags].join}[\s_]*/, '')
+              else
+                method_name = cont[:operationId]
+              end
             end
 
             path_txt = path.path.dup.to_s
-            if name_for_module == :path or name_for_module == :path_file
+            if [:path, :path_file, :tags, :tags_file].include?(name_for_module)
               old_module_requests = module_requests
-              # to remove version from path fex: /v1/Customer
-              path_requests = path_txt.gsub(/^\/v[\d\.]*\//i, "")
-              # to remove version from path fex: /1.0/Customer
-              path_requests = path_requests.gsub(/^\/[\d\.]*\//i, "")
-              if (path_requests == path_txt) && (path_txt.scan("/").size == 1)
-                # no folder in path
-                module_requests = "Root"
+              if [:path, :path_file].include?(name_for_module)
+                # to remove version from path fex: /v1/Customer
+                path_requests = path_txt.gsub(/^\/v[\d\.]*\//i, "")
+                # to remove version from path fex: /1.0/Customer
+                path_requests = path_requests.gsub(/^\/[\d\.]*\//i, "")
+                if (path_requests == path_txt) && (path_txt.scan("/").size == 1)
+                  # no folder in path
+                  module_requests = "Root"
+                else
+                  res_path = path_requests.scan(/(\w+)/)
+                  module_requests = res_path[0][0].camel_case
+                end
               else
-                res_path = path_requests.scan(/(\w+)/)
-                module_requests = res_path[0][0].camel_case
+                if cont.key?(:tags) and cont[:tags].is_a?(Array) and cont[:tags].size>0
+                  module_requests = cont[:tags].join(" ").camel_case
+                else
+                  module_requests = "Unknown"
+                end
               end
               if old_module_requests != module_requests
-                output << "end" unless old_module_requests == "" or name_for_module == :path_file
-                if name_for_module == :path
+                output << "end" unless old_module_requests == "" or name_for_module == :path_file or name_for_module == :tags_file
+                if name_for_module == :path or name_for_module == :tags
                   # to add the end for the previous module unless is the first one
                   output << "module #{module_requests}"
-                else #:path_file
+                else #:path_file, :tags_file
                   if old_module_requests != ""
                     unless files.key?(old_module_requests)
                       files[old_module_requests] = Array.new
@@ -161,7 +183,7 @@ class OpenApiImport
                     files[old_module_requests].concat(output)
                     output = Array.new
                   end
-                  output << "module #{module_requests}" unless files.key?(module_requests) # dont add in case already existed
+                  output << "module #{module_requests}" unless files.key?(module_requests) # don't add in case already existed
                 end
               end
             end
@@ -186,7 +208,6 @@ class OpenApiImport
 
                 response_example = get_response_examples(v)
                 
-
                 if !response_example.empty?
                   responses << "'#{k}': { "
                   responses << "message: '#{v[:description]}', "
@@ -257,7 +278,11 @@ class OpenApiImport
                           if dpv.keys.include?(:example)
                             valv = dpv[:example]
                           else
-                            valv = ""
+                            if dpv.type == "object"
+                              valv = "{}"
+                            else  
+                              valv = ""
+                            end
                           end
                           if dpv.keys.include?(:description)
                             description_parameters << "#    #{dpk}: (#{dpv[:type]}) #{dpv[:description]}"
@@ -405,7 +430,7 @@ class OpenApiImport
 
       output_footer = []
 
-      output_footer << "end" unless (module_requests == "") && (name_for_module == :path or name_for_module == :path_file)
+      output_footer << "end" unless (module_requests == "") && ([:path, :path_file, :tags, :tags_file].include?(name_for_module))
       output_footer << "end" << "end" << "end"
 
       if files.size == 0

metadata

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