interpol_schema_2_openapi_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c66000ad88b22628fbdb3575cf380b15ae3254e525336564b8d36fbc1e8a1ede
+  data.tar.gz: f1df4a032f7951304f2b2ab7133477259fafba620cd6418265e11b05c7f93096
+SHA512:
+  metadata.gz: '028d16c280eef252132972b73cd79c7c2f0655f90825af70af8cb21ed77002de0bebc1408678f7bdfcee610b027a43299cd579052c293982e5479e13ab3b4524'
+  data.tar.gz: 8e9aea032b574d65236c2d830e7630a7dc453b6e659e0296d88f7f4d3aedd19e5405921f03299a03822647cb2adaa02dbd470f8f22d5bba47ebcf2cdece7b1f7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in interpol_schema_2_openapi_schema.gemspec
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# InterpolSchema2OpenapiSchema
+
+This gem provides the CLI to convert [Interpol](https://github.com/seomoz/interpol) endpoint definition to [OpenAPI](https://github.com/OAI/OpenAPI-Specification) definition.
+
+## Supported OpenAPI Version
+
+- OpenAPI 2.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interpol_schema_2_openapi_schema'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install interpol_schema_2_openapi_schema
+
+## Usage
+
+### Convert to Path Objects
+
+Give an endpoint definition yaml.
+
+```
+$ istos ./path/to/index.yaml
+
+# dump to stdout
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/interpol_schema_2_openapi_schema.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "interpol_schema_2_openapi_schema"
+
+# 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/istos

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "interpol_schema_2_openapi_schema"
+
+InterpolSchema2OpenapiSchema::Cli.start(ARGV)

data/interpol_schema_2_openapi_schema.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/interpol_schema_2_openapi_schema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interpol_schema_2_openapi_schema"
+  spec.version       = InterpolSchema2OpenapiSchema::VERSION
+  spec.authors       = ["ku00"]
+  spec.email         = ["skentaro36@gmail.com"]
+
+  spec.summary       = %q{Convert Interpol definition to OpenAPI definition.}
+  spec.description   = %q{Convert Interpol definition to OpenAPI definition.}
+  spec.homepage      = "https://github.com/ku00/interpol_schema_2_openapi_schema"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.1")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ku00/interpol_schema_2_openapi_schema"
+  spec.metadata["changelog_uri"] = "https://github.com/ku00/interpol_schema_2_openapi_schema"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 2.1.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/interpol_schema/parser.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module InterpolSchema
+  class Parser
+    attr_reader :schema
+
+    def initialize(path)
+      @schema = YAML.load_file path
+    end
+
+    def http_method
+      schema.dig("method")
+    end
+
+    def request_params_in_path
+      schema.dig("definitions", 0, "path_params")
+    end
+
+    def request_params_in_query
+      schema.dig("definitions", 0, "query_params")
+    end
+
+    def response_code
+      schema.dig("definitions", 1, "status_codes", 0)
+    end
+
+    def response_params
+      schema.dig("definitions", 1, "schema")
+    end
+  end
+end

data/lib/interpol_schema_2_openapi_schema.rb

@@ -0,0 +1,29 @@
+require 'thor'
+
+require "interpol_schema_2_openapi_schema/version"
+require "interpol_schema/parser"
+require "openapi_schema/path_object/builder"
+
+module InterpolSchema2OpenapiSchema
+  class Error < StandardError; end
+
+  class Cli < Thor
+    default_command :build_path_object
+
+    desc "build_path_object YAML_FILE_PATH", "Build OpenAPI path object"
+    def build_path_object(file_path)
+      puts OpenapiSchema::PathObject::Builder.new(
+        InterpolSchema::Parser.new(file_path)
+      ).build
+    end
+
+    map %w[--version -v] => :version
+    desc "--version, -v", "Print the version"
+    def version
+      puts InterpolSchema2OpenapiSchema::VERSION
+    end
+
+    # To make build-command available in no calling itself
+    ARGV.unshift(self.default_command) unless self.all_tasks.has_key?(ARGV[0]) || self.instance_variable_get(:@map).has_key?(ARGV[0])
+  end
+end

data/lib/interpol_schema_2_openapi_schema/version.rb

@@ -0,0 +1,3 @@
+module InterpolSchema2OpenapiSchema
+  VERSION = "0.1.0"
+end

data/lib/openapi_schema/path_object/builder.rb

@@ -0,0 +1,88 @@
+require 'yaml'
+
+module OpenapiSchema
+  module PathObject
+    class Builder
+      attr_reader :interpol_schema
+
+      def initialize(interpol_schema)
+        @interpol_schema = interpol_schema
+      end
+
+      def build
+        base_template.to_yaml
+      end
+
+      def base_template
+        {
+          "#{interpol_schema.http_method.downcase}" => {
+            "summary" => "summary",
+            "description" => "description",
+            "parameters" => request_params,
+            "responses" => {
+              "#{interpol_schema.response_code}" => {
+                "description" => "response description",
+                "schema" => interpol_schema.response_params
+              }
+            }
+          }
+        }
+      end
+
+      def request_params
+        [
+          request_params_in_path_template,
+          request_params_in_query_template,
+        ].flatten.compact
+      end
+
+      def request_params_in_path_template
+        return if empty_param?(interpol_schema.request_params_in_path)
+
+        interpol_schema.request_params_in_path["properties"].map do |name, detail|
+          {
+            "in" => "path",
+            "name" => name,
+            "type" => detail["type"],
+            "required" => true,
+          }.merge(
+            enum_params_template(detail)
+          )
+        end
+      end
+
+      def request_params_in_query_template
+        return if empty_param?(interpol_schema.request_params_in_query)
+
+        interpol_schema.request_params_in_query["properties"].map do |name, detail|
+          {
+            "in" => "query",
+            "name" => name,
+            "type" => detail["type"],
+          }.merge(enum_params_template(detail))
+            .merge(required_param_template(detail))
+        end
+      end
+
+      def enum_params_template(target)
+        return {} if target["enum"].nil?
+
+        {
+          "enum" => target["enum"],
+        }
+      end
+
+      def required_param_template(target)
+        return {} if target["optional"].nil? || target["optional"] === true
+
+        {
+          "required" => true
+        }
+      end
+
+      def empty_param?(target)
+        target.nil? || target === {}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: interpol_schema_2_openapi_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ku00
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Convert Interpol definition to OpenAPI definition.
+email:
+- skentaro36@gmail.com
+executables:
+- istos
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/istos
+- interpol_schema_2_openapi_schema.gemspec
+- lib/interpol_schema/parser.rb
+- lib/interpol_schema_2_openapi_schema.rb
+- lib/interpol_schema_2_openapi_schema/version.rb
+- lib/openapi_schema/path_object/builder.rb
+homepage: https://github.com/ku00/interpol_schema_2_openapi_schema
+licenses: []
+metadata:
+  homepage_uri: https://github.com/ku00/interpol_schema_2_openapi_schema
+  source_code_uri: https://github.com/ku00/interpol_schema_2_openapi_schema
+  changelog_uri: https://github.com/ku00/interpol_schema_2_openapi_schema
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Convert Interpol definition to OpenAPI definition.
+test_files: []