oas_contrib 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f307976e1fa84f0bcde3240b18bafb10f69cea84bb4b04560956ed1d085b337
-  data.tar.gz: ed0247bc4d18fa7b830050aec0fd879264bc4261272fa7e559df8711765d9636
+  metadata.gz: 7c8a1b78e6c65c71f5d0053bd8b1a268213a8cb0e1eecfe423f2321c27aea23e
+  data.tar.gz: 8d705ccbd6fbabb6e11e418c08423707cbd14ae47f67bf3eaa8b689d52484f21
 SHA512:
-  metadata.gz: 8366c0a1a36f68234baf045960f450d160fd61f7977ce19743a9bde3d7456dbc8315009e8f03845f0ab26c4f779980a540b6087794ff6ab32e66a85a3a9c602b
-  data.tar.gz: 0d3b58e9cbf30595d6f088b632b5a3237b1d5595397bb96e27b34c9baecb1dbbdf2f6129d5683ace381af2603535514318f4e52b999724f44e4081d8f14f310b
+  metadata.gz: 587adc04a079ca0030fd341df911947edbb4722ee583df1bd6487e78a8d7be29221833855d0665fa17424b729516422aa13630da48776a89a342f1844a278d1b
+  data.tar.gz: 4b6876e829bd6f7a1e1bebd662c7533a01b1b6e6796d6467f5a9eb8ccd8d9b4b9a6ba9fcaaf1f3c82f036cf9e1f02f86bae850da8aa89eae19de2359be20e626

data/README.md

@@ -1,5 +1,7 @@
 # oas_contrib
 
+[![Gem Version](https://badge.fury.io/rb/oas_contrib.svg)](https://badge.fury.io/rb/oas_contrib)
+
 Libraries and commands for OpenAPI Specification.
 
 ## Installation

data/lib/oas_contrib/command.rb

@@ -19,13 +19,19 @@ module OasContrib
       raise ArgumentError, "in_file:[#{in_file}] is not exists." unless File.exist?(in_file)
       in_type  = options['in_type']
       out_type = options['out_type']
-      meta_file, path_dir, schema_dir = env_paths(out_dir, out_type)
       hash = input_solo(in_file, in_type)
+      version = definition_version(hash)
+
+      meta_file = get_meta_file_path(out_dir, out_type)
+      path_dir = get_path_dir_path(out_dir)
+      schema_dir = get_schema_dir_path(out_dir, version)
+
       FileUtils.mkdir_p(path_dir)
       FileUtils.mkdir_p(schema_dir)
+
       output_solo(meta_filter(hash), meta_file, out_type)
       output_multi(hash['paths'], path_dir, out_type)
-      output_multi(hash['components']['schemas'], schema_dir, out_type)
+      output_multi(schema_filter(hash, version), schema_dir, out_type)
     end
 
     option :in_type,  :type => :string, :aliases => '-it', :default => 'yaml', :desc => 'input file type (yaml or json)'
@@ -40,11 +46,20 @@ module OasContrib
       raise ArgumentError, "in_dir:[#{in_dir}] is not exists." unless File.exist?(in_dir)
       in_type  = options['in_type']
       out_type = options['out_type']
-      meta_file, path_dir, schema_dir = env_paths(in_dir, in_type)
+
+      meta_file = get_meta_file_path(in_dir, in_type)
       hash = input_solo(meta_file, in_type)
+      version = definition_version(hash)
+
+      path_dir = get_path_dir_path(in_dir)
+      schema_dir = get_schema_dir_path(in_dir, version)
+
       hash['components'] = {}
       hash['paths'] = input_multi(path_dir, in_type)
-      hash['components']['schemas'] = input_multi(schema_dir, in_type)
+      case version
+      when 'v2' then hash['definitions'] = input_multi(schema_dir, in_type)
+      when 'v3' then hash['components']['schemas'] = input_multi(schema_dir, in_type)
+      end
       output_solo(hash, out_file, out_type)
     end
 

data/lib/oas_contrib/command_util.rb

@@ -9,16 +9,42 @@ module OasContrib
     # @return [String]
     FILE_TYPE_JSON = 'json'.freeze
 
-    # Get directory, file paths
-    # @param [String] root target root directory
-    # @param [String] file_type yaml or json
-    # @return [Array] meta file path, path direcotry path, schema directory path
-    def env_paths(root, file_type)
-      [
-        "#{root}/meta#{file_type_ext(file_type)}",
-        "#{root}/paths",
-        "#{root}/components/schemas"
-      ]
+    def definition_version(hash)
+      if hash['swagger']
+        puts 'OK. input file is swagger 2.0 format.'
+        return 'v2'
+      end
+
+      if hash['openapi']
+        puts 'OK. input file is openapi 3.0 format.'
+        return 'v3'
+      end
+
+      raise 'input file must be swagger 2.0, or openapi 3.0 format.'
+    end
+
+    def schema_filter(hash, version)
+      case version
+      when 'v2' then hash['definitions']
+      when 'v3' then hash['components']['schemas']
+      end
+    end
+
+    def get_meta_file_path(root, file_type)
+      "#{root}/meta#{file_type_ext(file_type)}"
+    end
+
+    def get_path_dir_path(root)
+      "#{root}/paths"
+    end
+
+    def get_schema_dir_path(root, version)
+      schema_path = case version
+                    when 'v2' then '/definitions'
+                    when 'v3' then '/components/schemas'
+                    end
+
+      "#{root}#{schema_path}"
     end
 
     # Get file extension
@@ -36,10 +62,13 @@ module OasContrib
     # @param [String] file_type <description>
     # @return [Hash]
     def input_solo(path, file_type)
-      case file_type
-      when FILE_TYPE_YAML then YAML.load_file(path)
-      when FILE_TYPE_JSON then JSON.parse(File.read(path))
-      end
+      hash = case file_type
+             when FILE_TYPE_YAML then YAML.load_file(path)
+             when FILE_TYPE_JSON then JSON.parse(File.read(path))
+             end
+
+      puts "Load #{file_type} complete: #{path}"
+      hash
     end
 
     # Load path files and get hash
@@ -65,7 +94,11 @@ module OasContrib
                       when FILE_TYPE_YAML then ->(file) { YAML.dump(hash, file) }
                       when FILE_TYPE_JSON then ->(file) { JSON.dump(hash, file) }
                       end
-      File.open(path, 'w') { |f| output_lambda.call(f) }
+
+      File.open(path, 'w') do |f|
+        output_lambda.call(f)
+        puts "Generate #{file_type} complete: #{path}"
+      end
     end
 
     # Output path definition files
@@ -86,7 +119,7 @@ module OasContrib
     # @param [Hash] hash data source hash
     # @return [Hash] filtered hash
     def meta_filter(hash)
-      hash.select { |k, _| k != 'paths' && k != 'components' }
+      hash.select { |k, _| k != 'paths' && k != 'components' && k != 'definitions' }
     end
   end
 end

data/lib/oas_contrib/version.rb

@@ -1,4 +1,4 @@
 module OasContrib
   # @return [String] semantic version
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/sample_petstore_2.yml

@@ -0,0 +1,103 @@
+---
+swagger: '2.0'
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+host: petstore.swagger.io
+basePath: "/v1"
+schemes:
+- http
+consumes:
+- application/json
+produces:
+- application/json
+components: {}
+paths:
+  "/pets":
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+      - pets
+      parameters:
+      - name: limit
+        in: query
+        description: How many items to return at one time (max 100)
+        required: false
+        type: integer
+        format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              type: string
+              description: A link to the next page of responses
+          schema:
+            "$ref": "#/definitions/Pets"
+        default:
+          description: unexpected error
+          schema:
+            "$ref": "#/definitions/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+      - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          schema:
+            "$ref": "#/definitions/Error"
+  "/pets/{petId}":
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+      - pets
+      parameters:
+      - name: petId
+        in: path
+        required: true
+        description: The id of the pet to retrieve
+        type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          schema:
+            "$ref": "#/definitions/Pets"
+        default:
+          description: unexpected error
+          schema:
+            "$ref": "#/definitions/Error"
+definitions:
+  Pet:
+    required:
+    - id
+    - name
+    properties:
+      id:
+        type: integer
+        format: int64
+      name:
+        type: string
+      tag:
+        type: string
+  Error:
+    required:
+    - code
+    - message
+    properties:
+      code:
+        type: integer
+        format: int32
+      message:
+        type: string
+  Pets:
+    type: array
+    items:
+      "$ref": "#/definitions/Pet"

data/sample_petstore_3.yml

@@ -0,0 +1,110 @@
+---
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+- url: http://petstore.swagger.io/v1
+components:
+  schemas:
+    Pet:
+      required:
+      - id
+      - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Error:
+      required:
+      - code
+      - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
+    Pets:
+      type: array
+      items:
+        "$ref": "#/components/schemas/Pet"
+paths:
+  "/pets":
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+      - pets
+      parameters:
+      - name: limit
+        in: query
+        description: How many items to return at one time (max 100)
+        required: false
+        schema:
+          type: integer
+          format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+      - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+  "/pets/{petId}":
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+      - pets
+      parameters:
+      - name: petId
+        in: path
+        required: true
+        description: The id of the pet to retrieve
+        schema:
+          type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michinao Shimizu
@@ -88,6 +88,8 @@ files:
 - lib/oas_contrib/command_util.rb
 - lib/oas_contrib/version.rb
 - oas_contrib.gemspec
+- sample_petstore_2.yml
+- sample_petstore_3.yml
 homepage: https://github.com/MichinaoShimizu/oas_contrib
 licenses:
 - MIT