tomograph 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b82305a8afc3940fb54799c20a96c71685f1950addb5b0413572bb3ca6e5c2f
-  data.tar.gz: eddef2bcfd9ba3f22d3cf4511e0e7ce6a32c28992e0c022602c499210b72c2a1
+  metadata.gz: 39b59905a33024b038fb21b6561dcb9b607845aa7c9510f0ee91fc51d89a347c
+  data.tar.gz: a5f9e9d20b2b0dfcaec764967b6253eab832ac6d25bcd16d528c7e0780a7f967
 SHA512:
-  metadata.gz: 4843bb38871e842c26f63c6af9ac1d87fd5f153a56255c1b3d070eb35686c08b84c8279bf900d9dd4a0cf38fb9daff3b905bb58285e169c118ad7d36c7855b8c
-  data.tar.gz: 3df3afd4cc5064d767dad8640f156bd39972a728927621ac740f332609b21a3533be36d71099208f527e7d290970ab0e59814bc5d00239135687e2015a9e8b9d
+  metadata.gz: e6cc9c2abdef8c55223b86b888a6e5c2b003a8d770ba321ba799bc95c60f41dfd395de4b4570f7dcb6ea2aec2e7a7ae1f577871dd4155683606e5a2f09e64b27
+  data.tar.gz: 86624093fb9aafbc3705646f75dfec2ebda49f2a66b43419c205aaf358edeca111af2ba41ff02df240dd046a51cbd95fe2976d13bb2da660c25315545e971d48

data/.github/workflows/ruby.yml

@@ -23,10 +23,10 @@ jobs:
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@v1
+    # uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
       with:
-        ruby-version: 2.6
+        ruby-version: 2.7
     - name: Install dependencies
       run: bundle install
     - name: Run tests

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+### 3.1.0 - 2021-02-09
+
+* features
+  * support Swagger/OpenAPI 2.0 [#47](https://github.com/funbox/tomograph/issues/47)
+  * support OpenAPI 3.0 [#50](https://github.com/funbox/tomograph/issues/50)
+* removed
+  * delete travis [#45](https://github.com/funbox/tomograph/issues/45)
+
 ### 3.0.1 - 2020-10-14
 
 * removed

data/README.md

@@ -1,12 +1,86 @@
 # Tomograph 
 
-[![Build Status](https://travis-ci.org/funbox/tomograph.svg?branch=master)](https://travis-ci.org/funbox/tomograph) [![Gem Version](https://badge.fury.io/rb/tomograph.svg)](https://badge.fury.io/rb/tomograph)
+Convert API Blueprint, Swagger and OpenAPI to minimal routes with JSON Schema. For ease of use and creation of new tools.
 
-Convert API Blueprint to JSON Schema and search.
+Will look like
 
-## Installation
+  ```json
+  [
+    {
+      "path": "/sessions",
+      "method": "POST",
+      "content-type": "application/json",
+      "requests": [{
+        "$schema": "http://json-schema.org/draft-04/schema#",
+        "type": "object",
+        "properties": {
+          "login": {
+            "type": "string"
+          },
+          "password": {
+            "type": "string"
+          },
+          "captcha": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "login",
+          "password"
+        ]
+      }],
+      "responses": [
+        {
+          "status": "401",
+          "content-type": "application/json",
+          "body": {}
+        },
+        {
+          "status": "429",
+          "content-type": "application/json",
+          "body": {}
+        },
+        {
+          "status": "201",
+          "content-type": "application/json",
+          "body": {
+            "$schema": "http://json-schema.org/draft-04/schema#",
+            "type": "object",
+            "properties": {
+              "confirmation": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "type": {
+                    "type": "string"
+                  },
+                  "operation": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "type",
+                  "operation"
+                ]
+              },
+              "captcha": {
+                "type": "string"
+              },
+              "captcha_does_not_match": {
+                "type": "boolean"
+              }
+            }
+          }
+        }
+      ]
+    }
+  ]
+  ```
 
-First you need to install [drafter](https://github.com/apiaryio/drafter).
+## Installation
 
 Then add this line to your application's Gemfile:
 
@@ -28,36 +102,72 @@ $ gem install tomograph
 
 ## Usage
 
+### In code
+
+#### OpenAPI 2.0
+
+Also Swagger
+
 ```ruby
 require 'tomograph'
 
-tomogram = Tomograph::Tomogram.new(drafter_yaml_path: '/path/to/doc.yaml')
+tomogram = Tomograph::Tomogram.new(openapi2_json_path: '/path/to/doc.json')
 ```
 
-### Command line tool
+#### OpenAPI 3.0
 
-CLI allows you to convert files from API Elements to JSON Schema.
+Also OpenAPI
 
-```bash
-tomograph doc.yaml doc.json
+```ruby
+require 'tomograph'
+
+tomogram = Tomograph::Tomogram.new(openapi3_yaml_path: '/path/to/doc.yaml')
 ```
 
-There is also support for documents pre-parsed by [drafter](https://github.com/apiaryio/drafter) versions 3 and 4, or `crafter`. 
-To specify the handler version use the `-d` flag:
+#### API Blueprint
+
+First you need to install [drafter](https://github.com/apiaryio/drafter).
+Works after conversion from API Blueprint to API Elements (in YAML file) with Drafter.
+
+That is, I mean that you first need to do this
 
 ```bash
-tomograph -d 4 doc_by_drafter4.yaml doc.json
+drafter doc.apib -o doc.yaml
 ```
 
-Run CLI with `-h` to get detailed help:
+and then
 
-```bash
-tomograph -h
+```ruby
+require 'tomograph'
+
+tomogram = Tomograph::Tomogram.new(drafter_yaml_path: '/path/to/doc.yaml')
+```
+
+#### Tomograph
+
+To use additional features of the pre-converted
+
+```ruby
+require 'tomograph'
+
+tomogram = Tomograph::Tomogram.new(tomogram_json_path: '/path/to/doc.json')
 ```
 
-## Convert
+#### prefix
+Default: `''`
+
+You can specify API prefix and path to the spec using one of the possible formats:
+
+```ruby
+Tomograph::Tomogram.new(prefix: '/api/v2', drafter_yaml_path: '/path/to/doc.yaml')
+```
+
+```ruby
+Tomograph::Tomogram.new(prefix: '/api/v2', tomogram_json_path: '/path/to/doc.json')
+```
 
-Use `to_json` for converting APIB to JSON:
+#### to_json
+Use `to_json` for converting to JSON, example from API Blueprint:
 
 ```ruby
 tomogram.to_json
@@ -65,7 +175,7 @@ tomogram.to_json
 
 <details>
   <summary>Example input</summary>
-  
+
   ```apib
   FORMAT: 1A
   HOST: http://test.local
@@ -110,7 +220,7 @@ tomogram.to_json
 
 <details>
   <summary>Example output</summary>
-  
+
   ```json
   [
     {
@@ -188,41 +298,35 @@ tomogram.to_json
   ```
 </details> 
 
-## Search
-
-Use these methods to search through parsed API Blueprint spec to get request => responses hash maps.
-
-### `find_request`
+#### to_a
+```ruby
+tomogram.to_a
+```
 
+#### find_request
 ```ruby
 request = tomogram.find_request(method: 'GET', path: '/status/1?qwe=rty')
 ```
 
-### `find_request_with_content_type`
-
+#### find_request_with_content_type
 ```ruby
 request = tomogram.find_request_with_content_type(method: 'GET', path: '/status/1?qwe=rty', content_type: 'application/json')
 ```
 
-### `find_responses`
-
+#### `find_responses`
 ```ruby
 responses = request.find_responses(status: '200')
 ```
 
-## Other methods
-
-### `prefix_match?`
-
+#### prefix_match?
 This may be useful if you specify a prefix.
 
 ```ruby
 tomogram.prefix_match?('http://local/api/v2/users')
 ```
 
-### `to_resources`
-
-Maps resources with possible requests.
+#### to_resources
+Maps resources for API Blueprint with possible requests.
 
 Example output:
 
@@ -232,39 +336,48 @@ Example output:
 }
 ```
 
-## Constructor params
+### Command line tool
 
-You can specify API prefix and path to the spec using one of the possible formats:
+CLI allows you to convert files from API Blueprint (API Elements), Swagger and OpenAPI to JSON Schema.
 
-```ruby
-Tomograph::Tomogram.new(prefix: '/api/v2', drafter_yaml_path: '/path/to/doc.yaml')
-```
+Run CLI with `-h` to get detailed help:
 
-```ruby
-Tomograph::Tomogram.new(prefix: '/api/v2', tomogram_json_path: '/path/to/doc.json')
+```bash
+tomograph -h
 ```
 
-### `drafter_yaml_path`
-
-Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
+To specify the handler version use the `-d` flag:
 
-### Drafter v4 & Crafter support
+#### OpenAPI 2.0
+```bash
+tomograph -d openapi2 openapi2.json tomogram.json
+```
 
-If you are using a `drafter v4`, you should use `drafter_yaml_path`. 
+#### OpenAPI 3.0
+```bash
+tomograph -d openapi3 openapi3.yaml doc.json
+```
 
-In case when you want to use `сrafter`, then you should pass `crafter_yaml_path` respectively. 
+#### API Blueprint
+```bash
+tomograph -d 4 apielemetns.yaml doc.json
+```
 
-### `tomogram_json_path`
+#### exclude-description
 
-Path to API Blueprint documentation converted with `tomograph` to a JSON file.
+Exclude "description" keys from json-schemas.
 
-### `prefix`
+```bash
+tomograph -d 4 apielemetns.yaml doc.json --exclude-description
+```
 
-Default: `''`
+#### split
 
-Prefix for API requests. 
+Split output into files by method. Output in dir path.
 
-Example: `'/api'`.
+```bash
+tomograph -d 4 --split apielemetns.yaml jsons/
+```
 
 ## License
 

data/exe/tomograph

@@ -12,7 +12,7 @@ include Methadone::CLILogging
 
 version Tomograph::VERSION
 description 'Converts API Blueprint to JSON Schema'
-on('-d DRAFTER_VERSION', '--drafter', 'Choose drafter version: crafter or 4. Default: use drafter v.4.')
+on('-d DRAFTER_VERSION', '--drafter', 'Choose drafter version: crafter or 4, or OpenAPI version: openapi2 or openapi3. Default: use drafter v.4.')
 on('--exclude-description', 'Exclude "description" keys.')
 on('--split', 'Split output into files by method.')
 arg :input, 'path/to/doc.yaml (API Elements)'
@@ -33,6 +33,10 @@ def choose_drafter(opt_parser)
     :crafter
   when '4'
     :drafter_4
+  when 'openapi2'
+    :openapi2
+  when 'openapi3'
+    :openapi3
   when nil
     :drafter_4
   else
@@ -64,7 +68,9 @@ main do |input, output|
   version = choose_drafter(options['drafter'])
   format_key = {
                   crafter:   :crafter_yaml_path,
-                  drafter_4: :drafter_yaml_path
+                  drafter_4: :drafter_yaml_path,
+                  openapi2: :openapi2_json_path,
+                  openapi3: :openapi3_yaml_path
                }[version]
 
   tomogram = Tomograph::Tomogram.new(format_key => input)

data/lib/tomograph/openapi/openapi2.rb

@@ -0,0 +1,91 @@
+require 'tomograph/tomogram/action'
+
+module Tomograph
+  module OpenApi
+    class OpenApi2
+      def initialize(prefix, json_schema_path)
+        @prefix = prefix
+        @documentation = JSON.parse(File.read(json_schema_path))
+      end
+
+      def to_tomogram
+        @tomogram ||= @documentation['paths'].inject([]) do |result, action|
+          action[1].keys.each do |method|
+            result.push(Tomograph::Tomogram::Action.new(
+                path: "#{@prefix}#{action[0]}",
+                method: method.upcase,
+                content_type: '',
+                requests: [],
+                responses: responses(action[1][method]['responses'], @documentation['definitions']),
+                resource: ''))
+          end
+          result
+        end
+      end
+
+      def responses(resp, defi)
+        resp.inject([]) do |result, reponse|
+          if reponse[1]['schema']
+          result.push(
+              status: reponse[0],
+              body: schema(reponse[1]['schema'], defi),
+              'content-type': ''
+          )
+          else
+            result.push(
+                status: reponse[0],
+                body: {},
+                'content-type': ''
+            )
+          end
+        end
+      end
+
+      def schema(sche, defi)
+        if sche.keys.include?('$ref')
+          res = sche.merge('definitions' => {sche["$ref"][14..-1] => defi[sche["$ref"][14..-1]]})
+          if defi[sche["$ref"][14..-1]].to_s.include?('$ref')
+            keys = defi[sche["$ref"][14..-1]].to_s.split('"').find_all{|word| word.include?('definitions') }
+            keys.each do |key|
+              res["definitions"].merge!({key[14..-1] => defi[key[14..-1]]})
+            end
+          end
+          res
+        else
+          if sche.to_s.include?('$ref')
+            res = sche.merge('definitions' => {})
+            keys = sche.to_s.split('"').find_all{|word| word.include?('definitions') }
+            keys.each do |key|
+              res["definitions"].merge!({key[14..-1] => defi[key[14..-1]]})
+            end
+            res
+          else
+            sche
+          end
+        end
+      end
+
+      def search_hash(hash, key)
+        return hash[key] if hash.assoc(key)
+        hash.delete_if{|key, value| value.class != Hash}
+        new_hash = Hash.new
+        hash.each_value {|values| new_hash.merge!(values)}
+        unless new_hash.empty?
+          search_hash(new_hash, key)
+        end
+      end
+
+      def to_resources
+        return @to_resources if @to_resources
+
+        @to_resources = @documentation.group_by { |action| action['resource'] }
+        @to_resources = @to_resources.each_with_object({}) do |(resource, actions), resource_map|
+          requests = actions.map do |action|
+            "#{action['method']} #{@prefix}#{action['path']}"
+          end
+          resource_map[resource] = requests
+        end
+      end
+    end
+  end
+end

data/lib/tomograph/openapi/openapi3.rb

@@ -0,0 +1,118 @@
+require 'tomograph/tomogram/action'
+
+module Tomograph
+  module OpenApi
+    class OpenApi3
+      def initialize(prefix, openapi3_yaml_path)
+        @prefix = prefix
+        @documentation = YAML.load(File.read(openapi3_yaml_path))
+      end
+
+      def to_tomogram
+        @tomogram ||= @documentation['paths'].inject([]) do |result, action|
+          action[1].keys.each do |method|
+            result.push(Tomograph::Tomogram::Action.new(
+                path: "#{@prefix}#{action[0]}",
+                method: method.upcase,
+                content_type: '',
+                requests: [],
+                responses: responses(action[1][method]['responses'], @documentation['components']['schemas']),
+                resource: ''))
+          end
+          result
+        end
+      end
+
+      def responses(resp, defi)
+        resp.inject([]) do |result, response|
+          if response[1]['content'] == nil
+            #TODO 403Forbidden
+            result.push(
+                status: response[0],
+                body: {},
+                'content-type': ''
+            )
+          elsif response[1]['content'].values[0]['schema']
+            result.push(
+                status: response[0],
+                body: schema(response[1]['content'].values[0]['schema'], defi),
+                'content-type': ''
+            )
+          else
+            result.push(
+                status: response[0],
+                body: {},
+                'content-type': ''
+            )
+          end
+        end
+      end
+
+      def schema(sche, defi)
+        if sche.keys.include?('$ref')
+          sche.merge!('components' => {})
+          sche['components'].merge!('schemas' => {})
+          sche['components']['schemas'].merge!({sche["$ref"][21..-1] => defi[sche["$ref"][21..-1]]})
+
+          if defi[sche["$ref"][21..-1]].to_s.include?('$ref')
+            keys = defi[sche["$ref"][21..-1]].to_s.split('"').find_all{|word| word.include?('#/components/schemas/') }
+            keys.each do |key|
+              sche['components']['schemas'].merge!({key[21..-1] => defi[key[21..-1]]})
+
+              if defi[key[21..-1]].to_s.include?('$ref')
+                keys2 = defi[key[21..-1]].to_s.split('"').find_all{|word| word.include?('#/components/schemas/') }
+                keys2.each do |key2|
+                  sche['components']['schemas'].merge!({key2[21..-1] => defi[key2[21..-1]]})
+
+                  if defi[key2[21..-1]].to_s.include?('$ref')
+                    keys3 = defi[key2[21..-1]].to_s.split('"').find_all { |word| word.include?('#/components/schemas/') }.uniq
+                    keys3.each do |key3|
+                      sche['components']['schemas'].merge!({ key3[21..-1] => defi[key3[21..-1]] })
+                    end
+                  end
+
+                end
+              end
+
+            end
+          end
+          sche
+
+        else
+          if sche.to_s.include?('$ref')
+            res = sche.merge('definitions' => {})
+            keys = sche.to_s.split('"').find_all{|word| word.include?('definitions') }
+            keys.each do |key|
+              res["definitions"].merge!({key[21..-1] => defi[key[21..-1]]})
+            end
+            res
+          else
+            sche
+          end
+        end
+      end
+
+      def search_hash(hash, key)
+        return hash[key] if hash.assoc(key)
+        hash.delete_if{|key, value| value.class != Hash}
+        new_hash = Hash.new
+        hash.each_value {|values| new_hash.merge!(values)}
+        unless new_hash.empty?
+          search_hash(new_hash, key)
+        end
+      end
+
+      def to_resources
+        return @to_resources if @to_resources
+
+        @to_resources = @documentation.group_by { |action| action['resource'] }
+        @to_resources = @to_resources.each_with_object({}) do |(resource, actions), resource_map|
+          requests = actions.map do |action|
+            "#{action['method']} #{@prefix}#{action['path']}"
+          end
+          resource_map[resource] = requests
+        end
+      end
+    end
+  end
+end

data/lib/tomograph/tomogram.rb

@@ -3,16 +3,22 @@ require 'tomograph/path'
 require 'tomograph/api_blueprint/json_schema'
 require 'tomograph/api_blueprint/drafter_4/yaml'
 require 'tomograph/api_blueprint/crafter/yaml'
+require 'tomograph/openapi/openapi2'
+require 'tomograph/openapi/openapi3'
 
 module Tomograph
   class Tomogram
     extend Gem::Deprecate
 
-    def initialize(prefix: '', drafter_yaml_path: nil, tomogram_json_path: nil, crafter_yaml_path: nil)
+    def initialize(prefix: '', drafter_yaml_path: nil, tomogram_json_path: nil, crafter_yaml_path: nil, openapi2_json_path: nil, openapi3_yaml_path: nil)
       @documentation = if tomogram_json_path
                          Tomograph::ApiBlueprint::JsonSchema.new(prefix, tomogram_json_path)
                        elsif crafter_yaml_path
                          Tomograph::ApiBlueprint::Crafter::Yaml.new(prefix, crafter_yaml_path)
+                       elsif openapi2_json_path
+                         Tomograph::OpenApi::OpenApi2.new(prefix, openapi2_json_path)
+                       elsif openapi3_yaml_path
+                         Tomograph::OpenApi::OpenApi3.new(prefix, openapi3_yaml_path)
                        else
                          Tomograph::ApiBlueprint::Drafter4::Yaml.new(prefix, drafter_yaml_path)
                        end
@@ -23,11 +29,6 @@ module Tomograph
       @actions ||= @documentation.to_tomogram
     end
 
-    def to_hash
-      to_a.map(&:to_hash)
-    end
-    deprecate :to_hash, 'to_a with method access', 2018, 8
-
     def to_json
       JSON.pretty_generate(to_a.map(&:to_hash))
     end

data/lib/tomograph/version.rb

@@ -1,3 +1,3 @@
 module Tomograph
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/tomograph.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
   spec.add_development_dependency 'rubocop', '~> 0.81', '>= 0.81.0'
   spec.add_development_dependency 'simplecov', '~> 0.18', '>= 0.18.5'
+  spec.add_development_dependency 'json-schema', '~> 2.8', '>= 2.8.1'
   spec.required_ruby_version = '>= 2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tomograph
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: methadone
@@ -124,6 +124,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
 description: Convert API Blueprint to routes and JSON-Schemas
 email:
 - d.efimov@fun-box.ru
@@ -137,7 +157,6 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".tool-versions"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -153,6 +172,8 @@ files:
 - lib/tomograph/api_blueprint/drafter_4/yaml.rb
 - lib/tomograph/api_blueprint/drafter_4/yaml/action.rb
 - lib/tomograph/api_blueprint/json_schema.rb
+- lib/tomograph/openapi/openapi2.rb
+- lib/tomograph/openapi/openapi3.rb
 - lib/tomograph/path.rb
 - lib/tomograph/tomogram.rb
 - lib/tomograph/tomogram/action.rb

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7