open_api_import 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fad27ee774275917b7663c7701c7735ec6d8429e26a22c0189ce0eea2a3aa890
-  data.tar.gz: 98cc63a6ca33f56e01e0b3bdae727b721a5f37ed51d0c82553ccbcacdc7689d9
+  metadata.gz: 34a7117aedab4cd987fe9af035ebb047c04439068aba13fdea8431fc872354f4
+  data.tar.gz: 3e6517fb5517a848b757e7105306d82a4a5e624771a3a9bfe5835266d42aa336
 SHA512:
-  metadata.gz: 1e97a67f6e879e3c4336d91e91c0d616cf2a83c14a633d20145af9b9a891d6102fc59ed81513c81ef643c0d2788f6e2e3ddd67599a6012b829b855f65ff0af19
-  data.tar.gz: 6692473b740317892ec580b1b9a2e6028a47e69fabe4b156a1fa6ee49610f03ec622363955afd065c1b995dc2d8c786ffe016cff93e765dc416bff23f90cb253
+  metadata.gz: c9c355b6f63e6e9b877aea3e58cc3f48d6c6f472fa7e09bd1d3c4044d8bbb4a0275e8d52044f1d8532a8fe7330651709cdb9ad31e89292b2c5e897c41512211d
+  data.tar.gz: dfed0eccfe012f5eeaf728f01cacb933c5352368e8811116d7b2d881d781eb3a61fea9035c5354a23cc466b2a299322d30e2dacbd07ef54e7d227173988799f4

data/README.md

@@ -12,6 +12,8 @@ The output of this gem will be following the specification of Request Hashes: ht
 
 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
 
+A beautiful way to access and use the generated files is by using *pry*: https://github.com/pry/pry
+
 To be able to generate random requests take a look at the documentation for nice_hash gem: https://github.com/MarioRuiz/nice_hash
 
 This is an example of a generated request hash: 
@@ -108,6 +110,7 @@ In case no options supplied:
     -T, --tags_module                It will be used the tags key to create the module name
     -F, --fixed_module               all the requests will be under the module Requests
     -s, --silent                     It will display only errors
+    -c, --create_constants           For required arguments, it will create keyword arguments assigning by default a constant.
 ```
 
 
@@ -487,6 +490,14 @@ It will include this on the output file:
 ...
 ```
 
+### create_constants
+
+The methods will be generated using keyword arguments and for required arguments, it will create keyword arguments assigning by default a constant.
+
+```ruby
+def self.get_products(latitude: LATITUDE, longitude: LONGITUDE)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/marioruiz/open_api_import.

data/bin/open_api_import

@@ -46,6 +46,10 @@ optparse = OptionParser.new do |opts|
     options[:silent] = true
   end
 
+  opts.on("-c", "--create_constants", "For required arguments, it will create keyword arguments assigning by default a constant.") do
+    options[:create_constants] = true
+  end
+
 
 end
 

data/lib/open_api_import.rb

@@ -18,6 +18,7 @@ class OpenApiImport
   #   operation_id: it will be used the operationId field but using the snake_case version, for example for listUsers: list_users  
   #   operationId: it will be used the operationId field like it is, for example: listUsers
   # @param name_for_module [Symbol]. (:path, :path_file, :fixed, :tags, :tags_file) (default: :path). How the module names will be created.  
+  # @param create_constants [Boolean]. (default: false) For required arguments, it will create keyword arguments assigning by default a constant.
   # @param silent [Boolean]. (default: false) It will display only errors.
   #   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.  
@@ -25,7 +26,7 @@ class OpenApiImport
   #   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, silent: false)
+  def self.from(swagger_file, create_method_name: :operation_id, include_responses: true, mock_response: false, name_for_module: :path, silent: false, create_constants: false)
     begin
       f = File.new("#{swagger_file}_open_api_import.log", "w")
       f.sync = true
@@ -53,6 +54,7 @@ class OpenApiImport
       file_errors = file_to_convert + ".errors.log"
       File.delete(file_errors) if File.exist?(file_errors)
       import_errors = ""
+      required_constants = []
 
       begin
         definition = OasParser::Definition.resolve(swagger_file)
@@ -278,7 +280,12 @@ class OpenApiImport
                     path_txt.gsub!("{#{p[:name]}}", "\#{#{param_name}}")
                   end
                   unless params_path.include?(param_name)
-                    params_path << param_name
+                    if create_constants
+                      params_path << "#{param_name}: #{param_name.upcase}"
+                      required_constants << param_name.upcase
+                    else
+                      params_path << param_name
+                    end
                     #params_required << param_name if p[:required].to_s=="true"
                     description_parameters << "#    #{p[:name]}: (#{type}) #{"(required)" if p[:required].to_s=="true"} #{p[:description]}"
                   end
@@ -400,13 +407,27 @@ class OpenApiImport
               unless params_query.empty?
                 path_txt += "?"
                 params_required.each do |pr|
-                  if params_query.include?(pr)
-                    if create_method_name == :operationId
-                      path_txt += "#{pr}=\#{#{pr}}&"
-                      params << "#{pr}"
-                    else
-                      path_txt += "#{pr}=\#{#{pr.to_s.snake_case}}&"
-                      params << "#{pr.to_s.snake_case}"
+                  if create_constants
+                    if params_query.include?(pr)
+                      if create_method_name == :operationId
+                        path_txt += "#{pr}=\#{#{pr}}&"
+                        params << "#{pr}: #{pr.upcase}"
+                        required_constants << pr.upcase
+                      else
+                        path_txt += "#{pr}=\#{#{pr.to_s.snake_case}}&"
+                        params << "#{pr.to_s.snake_case}: #{pr.to_s.snake_case.upcase}"
+                        required_constants << pr.to_s.snake_case.upcase
+                      end
+                    end
+                  else
+                    if params_query.include?(pr)
+                      if create_method_name == :operationId
+                        path_txt += "#{pr}=\#{#{pr}}&"
+                        params << "#{pr}"
+                      else
+                        path_txt += "#{pr}=\#{#{pr.to_s.snake_case}}&"
+                        params << "#{pr.to_s.snake_case}"
+                      end
                     end
                   end
                 end
@@ -435,7 +456,12 @@ class OpenApiImport
               paramst = []
               prms = path_txt.scan(/[^#]{(\w+)}/)
               prms.each do |p|
-                paramst<<p[0].to_s.snake_case
+                #if create_constants
+                #  paramst<<"#{p[0].to_s.snake_case}: #{p[0].to_s.snake_case.upcase}"
+                #  required_constants << p[0].to_s.snake_case.upcase
+                #else
+                  paramst<<p[0].to_s.snake_case
+                #end
                 path_txt.gsub!("{#{p[0]}}", "\#{#{p[0].to_s.snake_case}}")
               end
               paramst.concat params
@@ -547,7 +573,6 @@ class OpenApiImport
           end
         end
       end
-
       output_footer = []
 
       output_footer << "end" unless (module_requests == "") && ([:path, :path_file, :tags, :tags_file].include?(name_for_module))
@@ -589,7 +614,18 @@ class OpenApiImport
             end
 
         requests_file_path = file_to_convert + ".rb"
-        File.open(requests_file_path, "w") { |file| file.write(requires_txt) }
+        if required_constants.size > 0
+          rconsts = "# Required constants\n"
+          required_constants.uniq!
+          required_constants.each do |rq|
+            rconsts += "#{rq} ||= ENV['#{rq}'] ||=''\n"
+          end
+          rconsts += "\n\n"
+        else
+          rconsts = ''
+        end
+
+        File.open(requests_file_path, "w") { |file| file.write(rconsts + requires_txt) }
         res_rufo = `rufo #{requests_file_path}`
         message = "** File that contains all the requires for all Request files: \n"
         message += "   - #{requests_file_path} "
@@ -801,6 +837,7 @@ class OpenApiImport
           rs.gsub!(/@(\w+):/,'\'@\1\':')
         end
       end
+      
       return response_example
     end
 
@@ -871,7 +908,7 @@ class OpenApiImport
         data_pattern << "'#{dpk}': #{dpv[:minimum]}..#{dpv[:maximum]}"
       elsif dpv.key?(:minimum) and !dpv.key?(:maximum)
         if RUBY_VERSION >= '2.6.0'
-          data_pattern << "#'#{dpk}': #{dpv[:minimum]}.. # Disabled until bug on rufo gem is fixed"
+          data_pattern << "'#{dpk}': #{dpv[:minimum]}.. "
         else
           data_pattern << "#'#{dpk}': #{dpv[:minimum]}.. # INFINITE only working on ruby>=2.6.0"
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_import
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oas_parser
@@ -34,22 +34,22 @@ dependencies:
   name: rufo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.11.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.11.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: nice_hash
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
         version: '1.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: 1.15.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,27 +69,27 @@ dependencies:
         version: '1.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: 1.15.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -146,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: OpenApiImport -- Import a Swagger or Open API file and create a Ruby Request