tomograph 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f6bd7ef6a03950f113a0492c08e4d9aa17f26eb
-  data.tar.gz: bd068832137f783a9d50b5d42b73824f7355f0a2
+  metadata.gz: 9b621ab5616dfc37ca938313d8b47e53ef40ca37
+  data.tar.gz: 848d61604096bddf13e6248d4adbe5eeeab9f205
 SHA512:
-  metadata.gz: 580304b7f2e90c5ed4f34e016549277025fef310ddb97deb758787e73376243da3e96fa58abd4d48adabcdb4751c4facaf47c02ccc2d97f5050ca2718fd6dd9a
-  data.tar.gz: fef696a261c995d5fa8c44cc8b553742271a99486738a8a70bca989f3b95341cf4b4f71fe3ed81ebe16dfb6d90f01eacba7b3fe7d840391729cfc7b6575646fc
+  metadata.gz: d01849bf00acd6939d1a2681083d22d846eed46cf2fca03948cc30de8bf6c83f7eec7eba0f4abba331df4c6abf37772bba6c1a0658243a5661b5edcab07b658a
+  data.tar.gz: e9c176086865d22445808b337111dd80a831418dfdb555a6535cd5191bf46898586cb51bd5187e089fff896af9da34411b4045be799b8d6f450dabe7557f3d47

data/.gitignore

@@ -1,4 +1,5 @@
 .idea/
+/pkg/
 .byebug_history
 Gemfile.lock
 coverage

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+### 2.2.0 - 2018-07-05
+
+* API changes
+  * Tomogram: add to_a method
+* deprecations
+  * Tomogram: to_hash method
+* features
+  * add command-line tool
+  * include Action's "resource" in serialization to JSON
+  * add support for loading Tomogram JSON
+
 ### 2.1.0 - 2018-03-16
 
 * features

data/README.md

@@ -35,6 +35,18 @@ require 'tomograph'
 tomogram = Tomograph::Tomogram.new(apib_path: '/path/to/doc.apib')
 ```
 
+### 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
+```
+See
+```
+tomograph -h
+```
+for details on usage.
+
 ## Convert
 
 ```ruby
@@ -205,6 +217,12 @@ or
 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.
@@ -213,6 +231,10 @@ Path to API Blueprint documentation. There must be an installed [drafter](https:
 
 Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
 
+### tomogram_json_path
+
+Path to API Blueprint documentation converted with `tomograph` to a JSON file.
+
 ### prefix
 
 Default empty String. Prefix of API requests. Example: `'/api'`.

data/exe/tomograph

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'methadone'
+
+require 'tomograph'
+require 'tomograph/version'
+
+
+include Methadone::Main
+include Methadone::CLILogging
+
+version Tomograph::VERSION
+description 'Converts API Blueprint to JSON Schema'
+on('-f INPUT_FORMAT', '--format', 'Force input format: "apib" or "yaml". Default: detect by file extension.')
+arg :input, 'path/to/doc.apib (API Blueprint) or path/to/doc.yaml (API Elements)'
+arg :output, 'path/to/doc.json'
+
+main do |input, output|
+  opt_format = options['format']
+  format = case opt_format && opt_format.downcase
+           when 'apib'
+             :apib
+           when 'yaml'
+             :yaml
+           when nil
+             case File.extname(input).downcase
+             when '.apib'
+               :apib
+             when '.yaml'
+               :yaml
+             else
+               fail 'Unsupported input file extension!'
+             end
+           else
+             fail 'Unsupported input format!'
+           end
+
+  format_key = case format
+               when :apib
+                 :apib_path
+               when :yaml
+                 :drafter_yaml_path
+               else
+                 fail 'Unimplemented!'
+               end
+  tomogram = Tomograph::Tomogram.new({format_key => input})
+  File.open(output, 'w') do |f|
+    f.write(tomogram.to_json)
+  end
+  0
+end
+
+go!

data/lib/tomograph/api_blueprint/json_schema.rb

@@ -0,0 +1,36 @@
+require 'tomograph/tomogram/action'
+
+module Tomograph
+  module ApiBlueprint
+    class JsonSchema
+      def initialize(prefix, json_schema_path)
+        @prefix = prefix
+        @documentation = MultiJson.load(File.read(json_schema_path))
+      end
+
+      def to_tomogram
+        @tomogram ||= @documentation.inject([]) do |result, action|
+          result.push(Tomograph::Tomogram::Action.new(
+                        path: "#{@prefix}#{action['path']}",
+                        method:  action['method'],
+                        content_type: action['content-type'],
+                        request: action['request'],
+                        responses: action['responses'],
+                        resource: action['resource']))
+        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']} #{action['path']}"
+          end
+          resource_map[resource] = requests
+        end
+      end
+    end
+  end
+end

data/lib/tomograph/api_blueprint/yaml.rb

@@ -9,7 +9,7 @@ module Tomograph
         @prefix = prefix
         @documentation = if apib_path
                            YAML.safe_load(`drafter #{apib_path}`)
-                         else
+                         elsif drafter_yaml_path
                            YAML.safe_load(File.read(drafter_yaml_path))
                          end
       end

data/lib/tomograph/tomogram.rb

@@ -1,26 +1,38 @@
 require 'multi_json'
 require 'tomograph/path'
+require 'tomograph/api_blueprint/json_schema'
 require 'tomograph/api_blueprint/yaml'
 
 module Tomograph
   class Tomogram
-    def initialize(prefix: '', apib_path: nil, drafter_yaml_path: nil)
-      @documentation = Tomograph::ApiBlueprint::Yaml.new(prefix, apib_path, drafter_yaml_path)
+    extend Gem::Deprecate
+
+    def initialize(prefix: '', apib_path: nil, drafter_yaml_path: nil, tomogram_json_path: nil)
+      @documentation = if tomogram_json_path
+                         Tomograph::ApiBlueprint::JsonSchema.new(prefix, tomogram_json_path)
+                       else
+                         Tomograph::ApiBlueprint::Yaml.new(prefix, apib_path, drafter_yaml_path)
+                       end
       @prefix = prefix
     end
 
+    def to_a
+      @actions ||= @documentation.to_tomogram
+    end
+
     def to_hash
-      @documentation.to_tomogram.map(&:to_hash)
+      to_a.map(&:to_hash)
     end
+    deprecate :to_hash, 'to_a with method access', 2018, 8
 
     def to_json
-      MultiJson.dump(to_hash)
+      MultiJson.dump(to_a.map(&:to_hash), pretty: true)
     end
 
     def find_request(method:, path:)
       path = Tomograph::Path.new(path).to_s
 
-      @documentation.to_tomogram.find do |action|
+      to_a.find do |action|
         action.method == method && action.path.match(path)
       end
     end
@@ -28,13 +40,13 @@ module Tomograph
     def find_request_with_content_type(method:, path:, content_type:)
       path = Tomograph::Path.new(path).to_s
 
-      @documentation.to_tomogram.find do |action|
+      to_a.find do |action|
         action.method == method && action.path.match(path) && action.content_type == content_type
       end
     end
 
     def to_resources
-      @documentation.to_resources
+      @resources ||= @documentation.to_resources
     end
 
     def prefix_match?(raw_path)

data/lib/tomograph/tomogram/action.rb

@@ -3,7 +3,7 @@ require 'tomograph/path'
 module Tomograph
   class Tomogram
     class Action
-      attr_reader :path, :method, :content_type, :request, :responses
+      attr_reader :path, :method, :content_type, :request, :responses, :resource
 
       def initialize(path:, method:, content_type:, request:, responses:, resource:)
         @path ||= Tomograph::Path.new(path)
@@ -24,9 +24,10 @@ module Tomograph
         @action ||= {
           'path' => path,
           'method' => method,
-          'content-type': content_type,
+          'content-type' => content_type,
           'request' => request,
-          'responses' => responses
+          'responses' => responses,
+          'resource' => resource
         }
       end
     end

data/lib/tomograph/version.rb

@@ -1,3 +1,3 @@
 module Tomograph
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/script/update_json_fixtures

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+def system!(*args)
+  puts "+ #{args.join(' ')}"
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+Dir.glob('spec/fixtures/*.yaml').each do |path|
+  path.delete_suffix!('.yaml')
+  system! "tomograph \"#{path}.yaml\" \"#{path}.json\""
+end

data/tomograph.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors        = ['d.efimov']
   spec.email          = ['d.efimov@fun-box.ru']
 
-  spec.summary        = 'Convert API Blueprint to JSON Schema and search'
+  spec.summary        = 'Convert API Blueprint to Tomogram'
+  spec.description    = 'Convert API Blueprint to routes and JSON-Schemas'
   spec.homepage       = 'https://github.com/funbox/tomograph'
   spec.license        = 'MIT'
 
@@ -17,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'methadone', '~> 1.9', '>= 1.9.5'
   spec.add_runtime_dependency 'multi_json', '~> 1.11', '>= 1.11.1'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'byebug', '~> 8.2', '>= 8.2.1'

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: tomograph
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.5
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -138,10 +158,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.2
-description: 
+description: Convert API Blueprint to routes and JSON-Schemas
 email:
 - d.efimov@fun-box.ru
-executables: []
+executables:
+- tomograph
 extensions: []
 extra_rdoc_files: []
 files:
@@ -156,13 +177,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/tomograph
 - lib/tomograph.rb
+- lib/tomograph/api_blueprint/json_schema.rb
 - lib/tomograph/api_blueprint/yaml.rb
 - lib/tomograph/api_blueprint/yaml/action.rb
 - lib/tomograph/path.rb
 - lib/tomograph/tomogram.rb
 - lib/tomograph/tomogram/action.rb
 - lib/tomograph/version.rb
+- script/update_json_fixtures
 - tomograph.gemspec
 homepage: https://github.com/funbox/tomograph
 licenses:
@@ -187,5 +211,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Convert API Blueprint to JSON Schema and search
+summary: Convert API Blueprint to Tomogram
 test_files: []