open_api_import 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f87b9b81f1429055c87f8a1008e79051eab82269f976fd4c1aa4fbe8ed4f748
-  data.tar.gz: 82a6fdc38c437e350dd16cac5daad820af3f1bffa7705799f33a5aa92b65cbf8
+  metadata.gz: 9b391f64d44cb78f95b9e4765f98023d3939752f5802e390fd8b972502061579
+  data.tar.gz: '08f6d8b7427f2dd8251c220314288b7e36cfdad30d89cf5d83e462640a5679cd'
 SHA512:
-  metadata.gz: 0ad5187d6bfd18bbbdacd09968a8c142c687bab121600a2f052e9fcc91729fddc2b7b11327cc1b79227b4e273921ec2a3d7b5893b613dfbd488471f22ed7b393
-  data.tar.gz: 5eafedf7aba260a9c4ad6aecd621a1f0fc2607993a519bd883c46814d67195f08d95c5d3019cd8618549659be26add433f2b02c534df7b6a607073d4c3e5d869
+  metadata.gz: 8e42c5dbde362282c5385b48d21852166dacb9283f5fd0e19a52a45f001a94a92d85df840c462c87252521b3a70f90bc2a1911b3cf55a787127df35bc6ca177f
+  data.tar.gz: 589ce2df15ad9589fe1900db1a2ff455b7c9e73cd98f07eda7005f79c221f65f2f149bc99ce45246979fe84a5cf993ff2a0809cea481799a99637698c9b57acd

data/README.md

@@ -57,7 +57,43 @@ Take in consideration open_api_import gem is using the 'rufo' gem that executes
 
 ## Usage
 
-You have all the json and yaml examples that the Open API project supplies on /spec/fixtures/ folder. You can use any of those ones or your own Swagger or Open API file. To convert the Swagger or Open API file into a Request Hash:
+After installation you can run using command line executable or importing from Ruby.
+
+You have all the json and yaml examples that the Open API project supplies on /spec/fixtures/ folder. To test it you can use any of those ones or your own Swagger or Open API file. 
+
+### Executable
+
+For help and see the options, run in command line / bash: `open_api_import -h`
+
+Example: 
+```bash
+ open_api_import ./spec/fixtures/v2.0/yaml/uber.yaml -fp
+```
+
+This is the output:
+
+```
+Usage: open_api_import [open_api_file] [options]
+Import a Swagger or Open API file and create a Ruby Request Hash file including all requests and responses.
+More info: https://github.com/MarioRuiz/open_api_import
+
+In case no options supplied:
+  * It will be used the value of operation_id on snake_case for the name of the methods
+  * It will be used the first folder of the path to create the module name
+    -n, --no_responses               if you don't want to add the examples of responses in the resultant file.
+    -m, --mock                       Add the first response on the request as mock_response
+    -p, --path_method                it will be used the path and http method to create the method names
+    -o, --operationId_method         It will be used the operationId field like it is to create the method names
+    -f, --create_files               It will create a file per module
+    -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
+```
+
+
+### Ruby file
+Write your ruby code on a file and in command line/bash: `ruby my_file.rb`
+
+To convert the Swagger or Open API file into a Request Hash:
 
 ```ruby
   require 'open_api_import'

data/bin/open_api_import

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'open_api_import'
+
+options = {
+  name_for_module: :path
+}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: open_api_import [open_api_file] [options]\n"
+  opts.banner+= "Import a Swagger or Open API file and create a Ruby Request Hash file including all requests and responses.\n"
+  opts.banner+= "More info: https://github.com/MarioRuiz/open_api_import\n\n"
+  opts.banner+= "In case no options supplied: \n"
+  opts.banner+= "  * It will be used the value of operation_id on snake_case for the name of the methods\n"
+  opts.banner+= "  * It will be used the first folder of the path to create the module name\n"
+  
+  opts.on("-n", "--no_responses", "if you don't want to add the examples of responses in the resultant file.") do
+    options[:include_responses] = false
+  end
+
+  opts.on("-m", "--mock", "Add the first response on the request as mock_response") do
+    options[:mock_response] = true
+  end
+
+  opts.on("-p", "--path_method", "it will be used the path and http method to create the method names") do
+    options[:create_method_name] = :path
+  end
+
+  opts.on("-o", "--operationId_method", "It will be used the operationId field like it is to create the method names") do
+    options[:create_method_name] = :operationId
+  end
+
+  opts.on("-f", "--create_files", "It will create a file per module") do
+    options[:create_files] = true
+  end
+
+  opts.on("-T", "--tags_module", "It will be used the tags key to create the module name") do
+    options[:name_for_module] = :tags
+  end
+
+  opts.on("-F", "--fixed_module", "all the requests will be under the module Requests") do
+    options[:name_for_module] = :fixed
+  end
+
+
+end
+
+optparse.parse!
+
+if options.key?(:create_files)
+  if options[:name_for_module] == :path
+    options[:name_for_module] = :path_file
+  elsif options[:name_for_module] == :tags
+    options[:name_for_module] = :tags_file
+  end
+  options.delete(:create_files)
+end
+
+filename = ARGV.pop
+if filename.to_s==''
+  puts optparse
+  puts "** Need to specify at least a file to import."
+else
+  OpenApiImport.from filename, options
+end

data/lib/open_api_import.rb

@@ -17,7 +17,7 @@ class OpenApiImport
   #   path: it will be used the path and http method, for example for a GET on path: /users/list, the method name will be get_users_list
   #   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) (default: :path). How the module names will be created.
+  # @param name_for_module [Symbol]. (:path, :path_file, :fixed, :tags, :tags_file) (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.
@@ -443,7 +443,11 @@ class OpenApiImport
         puts message
         @logger.info message
       else
-        files[module_requests] = output #for the last one
+        unless files.key?(module_requests)
+          files[module_requests] = Array.new
+        end
+        files[module_requests].concat(output) #for the last one
+
         requires_txt = ""
         message = "** Generated files that contain the code of the requests after importing the Swagger file: "
         puts message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_import
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oas_parser
@@ -54,16 +54,22 @@ dependencies:
   name: nice_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +114,8 @@ description: OpenApiImport -- Import a Swagger or Open API file and create a Rub
   Request Hash file including all requests and responses with all the examples. The
   file can be in JSON or YAML
 email: marioruizs@gmail.com
-executables: []
+executables:
+- open_api_import
 extensions: []
 extra_rdoc_files:
 - LICENSE
@@ -117,6 +124,7 @@ files:
 - ".yardopts"
 - LICENSE
 - README.md
+- bin/open_api_import
 - lib/open_api_import.rb
 - lib/open_api_import/utils.rb
 homepage: https://github.com/MarioRuiz/open_api_import