oas_contrib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f307976e1fa84f0bcde3240b18bafb10f69cea84bb4b04560956ed1d085b337
+  data.tar.gz: ed0247bc4d18fa7b830050aec0fd879264bc4261272fa7e559df8711765d9636
+SHA512:
+  metadata.gz: 8366c0a1a36f68234baf045960f450d160fd61f7977ce19743a9bde3d7456dbc8315009e8f03845f0ab26c4f779980a540b6087794ff6ab32e66a85a3a9c602b
+  data.tar.gz: 0d3b58e9cbf30595d6f088b632b5a3237b1d5595397bb96e27b34c9baecb1dbbdf2f6129d5683ace381af2603535514318f4e52b999724f44e4081d8f14f310b

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+Gemfile.lock
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shimizumichinao@lifull.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in oas_contrib.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 “Michinao Shimizu"
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# oas_contrib
+
+Libraries and commands for OpenAPI Specification.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oas_contrib'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oas_contrib
+
+## Usage
+
+### Divide command
+
+Divide the OAS file into path units and schema units.
+
+`$ oas_contrib divide <input_file_path> <output_directory_path> (OPTIONS)`
+
+__Options__
+
+* `--in_type`  input file type (`yaml` or `json`, default `yaml`)
+* `--out_type` output file type (`yaml` or `json`, default `yaml`)
+
+You can below 4 case:
+
+* JSON OAS file -> JSON files
+* YAML OAS file -> YAML files
+* JSON OAS file -> YAML files
+* YAML OAS file -> JSON files
+
+### Merge command
+
+Merge multiple divided files into an OAS file.
+
+`$ oas_contrib merge <input_directory_path> <output_file_path> (OPTIONS)`
+
+__Options__
+
+* `--in_type`  input file type (`yaml` or `json`, default `yaml`)
+* `--out_type` output file type (`yaml` or `json`, default `yaml`)
+
+You can below 4 case:
+
+* JSON files -> JSON OAS file
+* YAML files -> YAML OAS file
+* JSON files -> YAML OAS file
+* YAML files -> JSON OAS file
+
+### Preview command
+
+Preview OAS file using Swagger-UI official Docker image.
+
+The preview command needs docker.
+
+`$ oas_contrib preview <input_file> (OPTIONS)`
+
+__Options__
+
+* `--port` Swagger UI listen port (default `50010`)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MichinaoShimizu/oas_contrib. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OasContrib project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/MichinaoShimizu/oas_contrib/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'oas_contrib'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/oas_contrib

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'oas_contrib/command'
+OasContrib::Command.start

data/lib/oas_contrib.rb

@@ -0,0 +1,8 @@
+require 'oas_contrib/version'
+
+#
+# <Description>
+#
+module OasContrib
+  # Your code goes here...
+end

data/lib/oas_contrib/command.rb

@@ -0,0 +1,68 @@
+require 'thor'
+require 'oas_contrib/command_util'
+
+module OasContrib
+  # OAS contrib commands
+  # @author Michinao Shimizu
+  class Command < Thor
+    include CommandUtil
+
+    option :in_type,  :type => :string, :aliases => '-it', :default => 'yaml', :desc => 'input file type (yaml or json)'
+    option :out_type, :type => :string, :aliases => '-ot', :default => 'yaml', :desc => 'output file type (yaml or json)'
+    desc 'divide <input_file_path> <output_directory_path>', 'Divide the OAS file into path units and schema units.'
+
+    # Divide the OAS file into path units and schema units
+    # @param [String] in_file input file path
+    # @param [String] out_dir output directory path
+    # @return [Boolean]
+    def divide(in_file, out_dir)
+      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)
+      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)
+    end
+
+    option :in_type,  :type => :string, :aliases => '-it', :default => 'yaml', :desc => 'input file type (yaml or json)'
+    option :out_type, :type => :string, :aliases => '-ot', :default => 'yaml', :desc => 'output file type (yaml or json)'
+    desc 'merge <input_directory_path> <output_file_path>', 'Merge multiple divided files into an OAS file.'
+
+    # Merge multiple divided files into an OAS file.
+    # @param [String] in_dir input directory path
+    # @param [String] out_file output file path
+    # @return [Boolean]
+    def merge(in_dir, out_file)
+      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)
+      hash = input_solo(meta_file, in_type)
+      hash['components'] = {}
+      hash['paths'] = input_multi(path_dir, in_type)
+      hash['components']['schemas'] = input_multi(schema_dir, in_type)
+      output_solo(hash, out_file, out_type)
+    end
+
+    option :port,  :type => :string, :aliases => '-p', :default => '50010', :desc => 'Swagger UI listen port'
+    desc 'preview <input_file>', 'Preview OAS file using Swagger-UI official Docker image.'
+
+    # Preview OAS file using Swagger-UI official Docker image.
+    # @param [String] in_file input file path
+    # @return [Boolean] return code
+    def preview(in_file)
+      raise ArgumentError, "in_file:[#{in_file}] is not exists." unless File.exist?(in_file)
+      port = options['port']
+      path = File.expand_path(in_file)
+      basename = File.basename(path)
+      puts "SwaggerUI listen: http://localhost:#{port} with: #{in_file}"
+      Kernel.exec "docker run --rm --name oas_contrib_preview_swagger_ui \
+      -p #{port}:8080 -e API_URL=#{basename} \
+      -v #{path}:/usr/share/nginx/html/#{basename} swaggerapi/swagger-ui"
+    end
+  end
+end

data/lib/oas_contrib/command_util.rb

@@ -0,0 +1,92 @@
+require 'yaml'
+require 'json'
+
+module OasContrib
+  # Command class utility
+  module CommandUtil
+    # @return [String]
+    FILE_TYPE_YAML = 'yaml'.freeze
+    # @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"
+      ]
+    end
+
+    # Get file extension
+    # @param [String] file_type yaml or json
+    # @return [String] .yml or .json
+    def file_type_ext(file_type)
+      case file_type
+      when FILE_TYPE_YAML then '.yml'
+      when FILE_TYPE_JSON then '.json'
+      end
+    end
+
+    # Get hash from yaml or json file
+    # @param [String] path <description>
+    # @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
+    end
+
+    # Load path files and get hash
+    # @param [String] dir_path target directory path
+    # @param [String] file_type yaml or json
+    # @return [Hash] parsed hash
+    def input_multi(dir_path, file_type)
+      path = "#{dir_path}/*#{file_type_ext(file_type)}"
+      Dir.glob(path).each_with_object({}) do |input_file_path, result|
+        hash = input_solo(input_file_path, file_type)
+        key = hash.keys[0]
+        result[key] = hash[key]
+      end
+    end
+
+    # <Description>
+    # @param [<Type>] hash <description>
+    # @param [<Type>] path <description>
+    # @param [<Type>] file_type <description>
+    # @return [<Type>] <description>
+    def output_solo(hash, path, file_type)
+      output_lambda = case file_type
+                      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) }
+    end
+
+    # Output path definition files
+    # @param [Hash] hash data source hash
+    # @param [String] dir_path output directory path
+    # @param [String] file_type output file type (yaml, json)
+    # @return [Boolean]
+    def output_multi(hash, dir_path, file_type)
+      hash.each do |k, _|
+        key = k.tr('/', '_').gsub(/^\_/, '')
+        path = "#{dir_path}/#{key}#{file_type_ext(file_type)}"
+        val = hash.select { |hash_key, _| hash_key == k }
+        output_solo(val, path, file_type)
+      end
+    end
+
+    # Return meta section hash
+    # @param [Hash] hash data source hash
+    # @return [Hash] filtered hash
+    def meta_filter(hash)
+      hash.select { |k, _| k != 'paths' && k != 'components' }
+    end
+  end
+end

data/lib/oas_contrib/version.rb

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

data/oas_contrib.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oas_contrib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'oas_contrib'
+  spec.version       = OasContrib::VERSION
+  spec.authors       = ['Michinao Shimizu']
+  spec.email         = ['shimizu.michinao@gmail.com']
+
+  spec.summary       = 'Open API Specification related commands and libraries.'
+  spec.description   = 'Open API Specification related commands and libraries.'
+  spec.homepage      = "https://github.com/MichinaoShimizu/oas_contrib"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: oas_contrib
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michinao Shimizu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Open API Specification related commands and libraries.
+email:
+- shimizu.michinao@gmail.com
+executables:
+- oas_contrib
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/oas_contrib
+- lib/oas_contrib.rb
+- lib/oas_contrib/command.rb
+- lib/oas_contrib/command_util.rb
+- lib/oas_contrib/version.rb
+- oas_contrib.gemspec
+homepage: https://github.com/MichinaoShimizu/oas_contrib
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Open API Specification related commands and libraries.
+test_files: []