tomograph 2.5.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6c4366a0176b71d1c6b51227c8e26f1828c5fb26
-  data.tar.gz: 5cf804f81867664329fdc601e3adfd98166cfe7b
+SHA256:
+  metadata.gz: 6b82305a8afc3940fb54799c20a96c71685f1950addb5b0413572bb3ca6e5c2f
+  data.tar.gz: eddef2bcfd9ba3f22d3cf4511e0e7ce6a32c28992e0c022602c499210b72c2a1
 SHA512:
-  metadata.gz: 7bdcd5d49e4c51da0ea79c5b007eeb59dd02f19f72ef027471d807b9ef542c0bfc5bb7f8346b4176e8161f0a1bf93936d553356d6a4b06e3118ba2bc5a1c13d2
-  data.tar.gz: a43ea3338ce88798374d835a98ebd5084055f07cbab91dd3f49bbc4f893d0595031d1efb3cf4cd1f3f238dbdb2dc8dd7239760e99695532f7f3e38f197eed7ab
+  metadata.gz: 4843bb38871e842c26f63c6af9ac1d87fd5f153a56255c1b3d070eb35686c08b84c8279bf900d9dd4a0cf38fb9daff3b905bb58285e169c118ad7d36c7855b8c
+  data.tar.gz: 3df3afd4cc5064d767dad8640f156bd39972a728927621ac740f332609b21a3533be36d71099208f527e7d290970ab0e59814bc5d00239135687e2015a9e8b9d

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.6
+    - 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 +1,2 @@
-ruby 2.2.0
+ruby 2.7.1
+nodejs 11.3.0

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-- 2.2
-before_install: gem install bundler -v 1.12
-
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Change log
 
+### 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
+  * fix parser for new crafter version
+
 ### 2.5.1 - 2019-12-09
 
 * bug fixes

data/README.md

@@ -1,8 +1,6 @@
-# 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)
+# Tomograph 
 
-<a href="https://funbox.ru">
-  <img src="https://funbox.ru/badges/sponsored_by_funbox_compact.svg" alt="Sponsored by FunBox" width=250 />
-</a>
+[![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 to JSON Schema and search.
 
@@ -10,187 +8,203 @@ Convert API Blueprint to JSON Schema and search.
 
 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
 
 ```ruby
 require 'tomograph'
-```
 
-```ruby
-tomogram = Tomograph::Tomogram.new(apib_path: '/path/to/doc.apib')
+tomogram = Tomograph::Tomogram.new(drafter_yaml_path: '/path/to/doc.yaml')
 ```
 
 ### Command line tool
 
-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:
+CLI allows you to convert files from API Elements to JSON Schema.
+
+```bash
+tomograph doc.yaml doc.json
 ```
+
+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:
+
+```bash
 tomograph -d 4 doc_by_drafter4.yaml doc.json
 ```
-See
-```
+
+Run CLI with `-h` to get detailed help:
+
+```bash
 tomograph -h
 ```
-for more details on usage.
 
 ## Convert
 
+Use `to_json` for converting APIB to JSON:
+
 ```ruby
 tomogram.to_json
 ```
 
-Example input:
-```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)
-```
-
-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"
+<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"
+                ]
               },
-              "required": [
-                "id",
-                "type",
-                "operation"
-              ]
-            },
-            "captcha": {
-              "type": "string"
-            },
-            "captcha_does_not_match": {
-              "type": "boolean"
+              "captcha": {
+                "type": "string"
+              },
+              "captcha_does_not_match": {
+                "type": "boolean"
+              }
             }
           }
         }
-      }
-    ]
-  }
-]
-```
+      ]
+    }
+  ]
+  ```
+</details> 
 
 ## Search
 
-### find_request
+Use these methods to search through parsed API Blueprint spec to get request => responses hash maps.
+
+### `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')
@@ -198,68 +212,62 @@ responses = request.find_responses(status: '200')
 
 ## Other methods
 
-### prefix_match?
+### `prefix_match?`
 
-This can be useful if you use a prefix.
+This may be useful if you specify a prefix.
 
 ```ruby
 tomogram.prefix_match?('http://local/api/v2/users')
 ```
 
-## Params
+### `to_resources`
+
+Maps resources with possible requests.
 
-Example:
+Example output:
 
 ```ruby
-Tomograph::Tomogram.new(prefix: '/api/v2', apib_path: '/path/to/doc.apib')
+{
+  '/sessions' => ['POST /sessions']
+}
 ```
 
-or
+## Constructor params
+
+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')
 ```
 
-or
-
 ```ruby
 Tomograph::Tomogram.new(prefix: '/api/v2', tomogram_json_path: '/path/to/doc.json')
 ```
 
-### apib_path
-
-Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
-
-### drafter_yaml_path
+### `drafter_yaml_path`
 
 Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
 
-Drafter v.4
+### Drafter v4 & Crafter support
 
-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. 
+If you are using a `drafter v4`, you should use `drafter_yaml_path`. 
 
-Crafter
+In case when you want to use `сrafter`, then you should pass `crafter_yaml_path` respectively. 
 
-In case when you want to use `сrafter`, then you need to specify these parameters `crafter_apib_path`, `crafter_yaml_path`. 
-
-### tomogram_json_path
+### `tomogram_json_path`
 
 Path to API Blueprint documentation converted with `tomograph` to a JSON file.
 
-### prefix
+### `prefix`
 
-Default empty String. Prefix of API requests. Example: `'/api'`.
+Default: `''`
 
-### to_resources
+Prefix for API requests. 
 
-Hash resource with requests.
-The result for the example above:
-```ruby
-{
-  '/sessions' => ['POST /sessions']
-}
-```
+Example: `'/api'`.
 
 ## 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)