tomograph 2.5.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c550f25a39d3af26024322e5ccd5b428608f28c1
-  data.tar.gz: 099113e9247bef9757f289dab271e1319970c61a
+SHA256:
+  metadata.gz: 39b59905a33024b038fb21b6561dcb9b607845aa7c9510f0ee91fc51d89a347c
+  data.tar.gz: a5f9e9d20b2b0dfcaec764967b6253eab832ac6d25bcd16d528c7e0780a7f967
 SHA512:
-  metadata.gz: 457d0fe4bec4d3b0860ee35834e80d9c04dbcf97663fba44ae0dd75d6eb2247e1b7f66184c4bcb4f552aea5363565b3663401b7a9b9154ebdc64409110236868
-  data.tar.gz: bcef745a49b32511bd2a4655516e393d1acb956a85785bb87a5d6421cd3ad71099ea7b52b037b4361dc8f3c7dc7b351cb05683874db4ef05a97284d0193d38ea
+  metadata.gz: e6cc9c2abdef8c55223b86b888a6e5c2b003a8d770ba321ba799bc95c60f41dfd395de4b4570f7dcb6ea2aec2e7a7ae1f577871dd4155683606e5a2f09e64b27
+  data.tar.gz: 86624093fb9aafbc3705646f75dfec2ebda49f2a66b43419c205aaf358edeca111af2ba41ff02df240dd046a51cbd95fe2976d13bb2da660c25315545e971d48

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - 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
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.7
 
 Metrics/LineLength:
   Max: 120

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.7.1

data/.tool-versions

@@ -1,2 +1,2 @@
-ruby 2.2.0
+ruby 2.7.1
 nodejs 11.3.0

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # 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
+  * delete apib_path [#31](https://github.com/funbox/tomograph/issues/31)
+  * delete drafter_4_apib_path [#32](https://github.com/funbox/tomograph/issues/32)
+  * replace drafter_yaml_path with drafter_4_yaml_path [#33](https://github.com/funbox/tomograph/issues/33)
+  * delete crafter_apib_path [#34](https://github.com/funbox/tomograph/issues/34)
+  * delete multi_json [#35](https://github.com/funbox/tomograph/issues/35)
+
+### 3.0.0 - 2020-08-27
+
+* features
+  * support multi request for one resource path [#27](https://github.com/funbox/tomograph/issues/27)
+* removed
+  * delete support drafter 3 [#29](https://github.com/funbox/tomograph/issues/29)
+
+### 2.5.4 - 2020-04-06
+
+* fixed warnings on ruby 2.7
+* updated dependences
+
+# Change log
+
+### 2.5.3 - 2020-03-10
+
+* bug fixes
+  * fix parser status to string
+
 ### 2.5.2 - 2020-01-10
 
 * bug fixes

data/README.md

@@ -1,265 +1,386 @@
-# 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)
-
-<a href="https://funbox.ru">
-  <img src="https://funbox.ru/badges/sponsored_by_funbox_compact.svg" alt="Sponsored by FunBox" width=250 />
-</a>
-
-Convert API Blueprint to JSON Schema and search.
+# Tomograph 
+
+Convert API Blueprint, Swagger and OpenAPI to minimal routes with JSON Schema. For ease of use and creation of new tools.
+
+Will look like
+
+  ```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"
+              }
+            }
+          }
+        }
+      ]
+    }
+  ]
+  ```
 
 ## Installation
 
-First you need to install [drafter](https://github.com/apiaryio/drafter).
-
-Second add this line to your application's Gemfile:
+Then add this line to your application's Gemfile:
 
 ```ruby
 gem 'tomograph'
 ```
 
-And then execute:
+After that execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Or install the gem by yourself:
 
-    $ gem install tomograph
+```bash
+$ gem install tomograph
+```
 
 ## Usage
 
+### In code
+
+#### OpenAPI 2.0
+
+Also Swagger
+
 ```ruby
 require 'tomograph'
-```
 
-```ruby
-tomogram = Tomograph::Tomogram.new(apib_path: '/path/to/doc.apib')
+tomogram = Tomograph::Tomogram.new(openapi2_json_path: '/path/to/doc.json')
 ```
 
-### Command line tool
+#### OpenAPI 3.0
 
-The command line tool allows you to convert files from API Blueprint or API Elements to JSON Schema.
-```
-tomograph doc.apib doc.json
-```
-Now there is support for documents pre-parsed by [drafter](https://github.com/apiaryio/drafter) versions 3 and 4, or crafter. To select the handler version, use the -d key and specify the required version. For example:
-```
-tomograph -d 4 doc_by_drafter4.yaml doc.json
-```
-See
-```
-tomograph -h
-```
-for more details on usage.
-
-## Convert
+Also OpenAPI
 
 ```ruby
-tomogram.to_json
+require 'tomograph'
+
+tomogram = Tomograph::Tomogram.new(openapi3_yaml_path: '/path/to/doc.yaml')
 ```
 
-Example input:
-```apib
-FORMAT: 1A
-HOST: http://test.local
+#### API Blueprint
 
-# project
+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.
 
-# Group project
+That is, I mean that you first need to do this
 
-Project
+```bash
+drafter doc.apib -o doc.yaml
+```
 
-## Authentication [/sessions]
+and then
 
-### Sign In [POST]
+```ruby
+require 'tomograph'
 
-+ Request (application/json)
+tomogram = Tomograph::Tomogram.new(drafter_yaml_path: '/path/to/doc.yaml')
+```
 
-    + Attributes
-     + login (string, required)
-     + password (string, required)
-     + captcha (string, optional)
+#### Tomograph
 
-+ Response 401 (application/json)
+To use additional features of the pre-converted
 
-+ Response 429 (application/json)
+```ruby
+require 'tomograph'
 
-+ Response 201 (application/json)
+tomogram = Tomograph::Tomogram.new(tomogram_json_path: '/path/to/doc.json')
+```
 
-    + Attributes
-     + confirmation (Confirmation, optional)
-     + captcha (string, optional)
-     + captcha_does_not_match (boolean, optional)
+#### prefix
+Default: `''`
 
+You can specify API prefix and path to the spec using one of the possible formats:
 
-# Data Structures
+```ruby
+Tomograph::Tomogram.new(prefix: '/api/v2', drafter_yaml_path: '/path/to/doc.yaml')
+```
 
-## Confirmation (object)
-  + id (string, required)
-  + type (string, required)
-  + operation (string, required)
+```ruby
+Tomograph::Tomogram.new(prefix: '/api/v2', tomogram_json_path: '/path/to/doc.json')
 ```
 
-Example output:
-```json
-[
-  {
-    "path": "/sessions",
-    "method": "POST",
-    "content-type": "application/json",
-    "request": {
-      "$schema": "http://json-schema.org/draft-04/schema#",
-      "type": "object",
-      "properties": {
-        "login": {
-          "type": "string"
+#### to_json
+Use `to_json` for converting to JSON, example from API Blueprint:
+
+```ruby
+tomogram.to_json
+```
+
+<details>
+  <summary>Example input</summary>
+
+  ```apib
+  FORMAT: 1A
+  HOST: http://test.local
+  
+  # project
+  
+  # Group project
+  
+  Project
+  
+  ## Authentication [/sessions]
+  
+  ### Sign In [POST]
+  
+  + Request (application/json)
+  
+      + Attributes
+       + login (string, required)
+       + password (string, required)
+       + captcha (string, optional)
+  
+  + Response 401 (application/json)
+  
+  + Response 429 (application/json)
+  
+  + Response 201 (application/json)
+  
+      + Attributes
+       + confirmation (Confirmation, optional)
+       + captcha (string, optional)
+       + captcha_does_not_match (boolean, optional)
+  
+  
+  # Data Structures
+  
+  ## Confirmation (object)
+    + id (string, required)
+    + type (string, required)
+    + operation (string, required)
+  ```
+</details>
+
+<details>
+  <summary>Example output</summary>
+
+  ```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"
+          }
         },
-        "password": {
-          "type": "string"
+        "required": [
+          "login",
+          "password"
+        ]
+      }],
+      "responses": [
+        {
+          "status": "401",
+          "content-type": "application/json",
+          "body": {}
         },
-        "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"
+        {
+          "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"
+                  }
                 },
-                "operation": {
-                  "type": "string"
-                }
+                "required": [
+                  "id",
+                  "type",
+                  "operation"
+                ]
+              },
+              "captcha": {
+                "type": "string"
               },
-              "required": [
-                "id",
-                "type",
-                "operation"
-              ]
-            },
-            "captcha": {
-              "type": "string"
-            },
-            "captcha_does_not_match": {
-              "type": "boolean"
+              "captcha_does_not_match": {
+                "type": "boolean"
+              }
             }
           }
         }
-      }
-    ]
-  }
-]
-```
-
-## Search
+      ]
+    }
+  ]
+  ```
+</details> 
 
-### find_request
+#### to_a
+```ruby
+tomogram.to_a
+```
 
+#### find_request
 ```ruby
 request = tomogram.find_request(method: 'GET', path: '/status/1?qwe=rty')
 ```
 
-### find_request
-
+#### 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?
-
-This can be useful if you use a prefix.
+#### prefix_match?
+This may be useful if you specify a prefix.
 
 ```ruby
 tomogram.prefix_match?('http://local/api/v2/users')
 ```
 
-## Params
+#### to_resources
+Maps resources for API Blueprint with possible requests.
 
-Example:
+Example output:
 
 ```ruby
-Tomograph::Tomogram.new(prefix: '/api/v2', apib_path: '/path/to/doc.apib')
+{
+  '/sessions' => ['POST /sessions']
+}
 ```
 
-or
+### Command line tool
 
-```ruby
-Tomograph::Tomogram.new(prefix: '/api/v2', drafter_yaml_path: '/path/to/doc.yaml')
-```
+CLI allows you to convert files from API Blueprint (API Elements), Swagger and OpenAPI to JSON Schema.
 
-or
+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
 ```
 
-### apib_path
-
-Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
-
-### drafter_yaml_path
+To specify the handler version use the `-d` flag:
 
-Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
-
-Drafter v.4
-
-If you are using a `drafter v.4`, then you need to use the following parameters`drafter_4_apib_path` and `drafter_4_yaml_path` respectively. 
+#### OpenAPI 2.0
+```bash
+tomograph -d openapi2 openapi2.json tomogram.json
+```
 
-Crafter
+#### OpenAPI 3.0
+```bash
+tomograph -d openapi3 openapi3.yaml doc.json
+```
 
-In case when you want to use `сrafter`, then you need to specify these parameters `crafter_apib_path`, `crafter_yaml_path`. 
+#### 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 empty String. Prefix of API requests. Example: `'/api'`.
+#### split
 
-### to_resources
+Split output into files by method. Output in dir path.
 
-Hash resource with requests.
-The result for the example above:
-```ruby
-{
-  '/sessions' => ['POST /sessions']
-}
+```bash
+tomograph -d 4 --split apielemetns.yaml jsons/
 ```
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)