interpol_to_open_api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b700570441ee836e99a610386695ba4863e37a0
+  data.tar.gz: 6c5688b27258dc36774e95b620ee96b108d8caa4
+SHA512:
+  metadata.gz: 687a06d8a163025c9fe03ee79c91c0db8e81ac3ccc5fb0274ad6041fd07aa2ba7d870912609e0727378e180b9d427f1dc03464d442b66b23b81f98be3c85b47f
+  data.tar.gz: 5917ee6f527ef6910309e72f89c54556007efe2103618cc65f308358221cbff29f0cc85c81282b5fe857e78e9c092d7cdf94538074ad54a07cb4025d73fecc1d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/interpol_to_open_api-*.gem

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+before_install: gem install bundler -v 1.14.5
+notifications:
+  email: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,18 @@
+# InterpolToOpenAPI
+
+This tool is made to be used in a process of work to convert Interpol definitions into Open API Specification v2.0.
+
+Note that this does not aim complete conversion. Manual modification is premised and developed for only my use-case.
+
+## Usage
+
+Clone this repository and build. Publishing on Rubygem is not planned for now.
+
+```
+git clone https://github.com/Joe-noh/interpol_to_open_api
+
+cd ./interpol_to_open_api
+
+gem build interpol_to_open_api.gemspec
+gem install interpol_to_open_api-0.x.x,gem
+```

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_to_open_api"
+
+# 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/interpol_to_open_api

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'interpol_to_open_api'
+
+cli = InterpolToOpenAPI::CLI.new(ARGV)
+cli.run

data/interpol_to_open_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interpol_to_open_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "interpol_to_open_api"
+  spec.version = InterpolToOpenAPI::VERSION
+  spec.authors = ["Joe-noh"]
+  spec.email = ["goflb.jh@gmail.com"]
+
+  spec.summary = "Converts interpol endpoint definition into Open API spec."
+  spec.homepage = "https://github.com/Joe-noh/interpol_to_open_api"
+
+  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.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/interpol_to_open_api.rb

@@ -0,0 +1,7 @@
+require 'interpol_to_open_api/ext/string'
+require 'interpol_to_open_api/version'
+require 'interpol_to_open_api/cli'
+require 'interpol_to_open_api/converter'
+
+module InterpolToOpenAPI
+end

data/lib/interpol_to_open_api/cli.rb

@@ -0,0 +1,36 @@
+require 'optparse'
+require 'yaml'
+
+module InterpolToOpenAPI
+  class CLI
+    def initialize(argv)
+      @src = nil
+
+      define_cli_options(argv)
+    end
+
+    def run
+      raise 'Give input yaml path with -i option.' if @src.nil?
+
+      converter = InterpolToOpenAPI::Converter.new
+      puts converter.convert(@src).to_yaml
+    end
+
+    private
+
+    def define_cli_options(argv)
+      @opt = OptionParser.new
+
+      @opt.on('-v', '--version', 'print the version') do
+        puts InterpolToOpenAPI::VERSION
+        exit
+      end
+
+      @opt.on('-i path', '--input', 'path to input endpoint definition yaml') do |path|
+        @src = path
+      end
+
+      @opt.parse!(argv)
+    end
+  end
+end

data/lib/interpol_to_open_api/converter.rb

@@ -0,0 +1,95 @@
+require 'yaml'
+require_relative 'interpol/schema'
+
+module InterpolToOpenAPI
+  class Converter
+    def convert(path)
+      interpol = YAML.load_file(path)
+
+      req, res = interpol['definitions'].partition {|definition| definition['message_type'] == 'request' }
+
+      {
+        camelize_path_parameters(interpol['route']) => {
+          interpol['method'].downcase => {
+            'summary' => '',
+            'description' => req.first['schema']['description'] || '',
+            'operationId' => interpol['name'].camelize,
+            'tags' => [],
+            'parameters' => build_parameters(req.first),
+            'responses' => build_responses(res.first)
+          }
+        }
+      }
+    end
+
+    private
+
+    def build_parameters(request)
+      [
+        parameters_in_path(request['path_params']['properties']),
+        parameters_in_query(request['query_params']['properties']),
+        parameters_in_body(request['schema'])
+      ].flatten
+    end
+
+    def build_responses(response)
+      status_code = response['status_codes'].first
+      schema = Interpol::Schema.new response['schema'].merge({
+        'example' => response['examples'].first
+      })
+
+      {
+        status_code => {
+          'description' => '',
+          'schema' => schema.to_openapi
+        }
+      }
+    end
+
+    def parameters_in_path(properties)
+      return [] unless properties.is_a? Hash
+
+      properties.map do |name, schema|
+        {
+          'in' => 'path',
+          'name' => name.camelize,
+          'description' => '',
+          'required' => true,
+          'type' => schema['type']
+        }
+      end
+    end
+
+    def parameters_in_query(properties)
+      return [] unless properties.is_a? Hash
+
+      properties.map do |name, schema|
+        {
+          'in' => 'query',
+          'name' => name,
+          'description' => '',
+          'type' => schema['type']
+        }
+      end
+    end
+
+    def parameters_in_body(schema)
+      return [] unless schema['properties'].is_a? Hash
+
+      schema['properties'].map do |name, schema|
+        {
+          'in' => 'body',
+          'name' => name,
+          'description' => '',
+          'schema' => Interpol::Schema.new(schema).to_openapi
+        }
+      end
+    end
+
+    def camelize_path_parameters(path)
+      path.gsub(/:([\w]+)/) do |_matched|
+        "{" + $1.camelize + "}"
+      end
+    end
+  end
+end

data/lib/interpol_to_open_api/ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def camelize
+    self.gsub(/_([a-z])/) { $1.upcase }
+  end
+end

data/lib/interpol_to_open_api/interpol/property.rb

@@ -0,0 +1,42 @@
+module InterpolToOpenAPI
+  module Interpol
+    class Property
+      def self.array_to_openapi(properties)
+        properties.map {|name, attrs|
+          Property.new(name, attrs).to_openapi
+        }.inject {|acc, hash|
+          acc.merge(hash)
+        }
+      end
+
+      def initialize(name, attrs)
+        @name  = name
+        @attrs = attrs
+
+        @attrs["properties"] = Property.array_to_openapi(@attrs["properties"]) if @attrs.has_key?("properties")
+      end
+
+      def to_openapi
+        if nullable?
+          attrs = @attrs.merge({
+            "type" => type_without_null,
+            "x-nullable" => true
+          })
+        else
+          attrs = @attrs
+        end
+
+        {@name => attrs}
+      end
+
+      def nullable?
+        @attrs["type"].is_a?(Array) && @attrs["type"].member?("null")
+      end
+
+      def type_without_null
+        type = @attrs["type"].select {|t| t != "null"}
+        type.size == 1 ? type.first : type
+      end
+    end
+  end
+end

data/lib/interpol_to_open_api/interpol/schema.rb

@@ -0,0 +1,18 @@
+require_relative "property"
+
+module InterpolToOpenAPI
+  module Interpol
+    class Schema
+      def initialize(schema)
+        @schema = schema
+      end
+
+      def to_openapi
+        update = {}
+        update["properties"] = Property.array_to_openapi(@schema["properties"]) if @schema.has_key?("properties")
+
+        @schema.merge(update)
+      end
+    end
+  end
+end

data/lib/interpol_to_open_api/version.rb

@@ -0,0 +1,3 @@
+module InterpolToOpenAPI
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: interpol_to_open_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Joe-noh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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: 
+email:
+- goflb.jh@gmail.com
+executables:
+- interpol_to_open_api
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/interpol_to_open_api
+- interpol_to_open_api.gemspec
+- lib/interpol_to_open_api.rb
+- lib/interpol_to_open_api/cli.rb
+- lib/interpol_to_open_api/converter.rb
+- lib/interpol_to_open_api/ext/string.rb
+- lib/interpol_to_open_api/interpol/property.rb
+- lib/interpol_to_open_api/interpol/schema.rb
+- lib/interpol_to_open_api/version.rb
+homepage: https://github.com/Joe-noh/interpol_to_open_api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Converts interpol endpoint definition into Open API spec.
+test_files: []