tomograph 2.5.2 → 3.1.0

data/exe/tomograph

@@ -12,11 +12,10 @@ include Methadone::CLILogging
 
 version Tomograph::VERSION
 description 'Converts API Blueprint to JSON Schema'
-on('-d DRAFTER_VERSION', '--drafter', 'Choose drafter version: crafter, 3 or 4. Default: use drafter v.3.')
-on('-f INPUT_FORMAT', '--format', 'Force input format: "apib" or "yaml". Default: detect by file extension.')
+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.apib (API Blueprint) or path/to/doc.yaml (API Elements)'
+arg :input, 'path/to/doc.yaml (API Elements)'
 arg :output, 'path/to/doc.json or path/to/dir if --split is used.'
 
 def prune!(obj, unwanted_key)
@@ -28,36 +27,18 @@ def prune!(obj, unwanted_key)
   end
 end
 
-def guess_format(opt_format, input)
-  case opt_format && opt_format.downcase
-  when 'apib'
-    :apib
-  when 'yaml'
-    :yaml
-  when nil
-    case File.extname(input).downcase
-    when '.apib'
-      :apib
-    when '.yaml', '.yml'
-      :yaml
-    else
-      fail 'Unsupported input file extension!'
-    end
-  else
-    fail 'Unsupported input format!'
-  end
-end
-
 def choose_drafter(opt_parser)
   case opt_parser
   when 'crafter'
     :crafter
-  when '3'
-    :drafter_3
   when '4'
     :drafter_4
+  when 'openapi2'
+    :openapi2
+  when 'openapi3'
+    :openapi3
   when nil
-    :drafter_3
+    :drafter_4
   else
     raise 'Unsupported drafter version!'
   end
@@ -77,35 +58,21 @@ def write_split_json(actions, output)
 end
 
 def write_json(obj, path)
-  json = MultiJson.dump(obj, pretty: true)
+  json = JSON.pretty_generate(obj)
   File.open(path, 'w') do |file|
     file.write(json)
   end
 end
 
 main do |input, output|
-  format = guess_format(options['format'], input)
   version = choose_drafter(options['drafter'])
-  format_key = case format
-               when :apib
-                 if version == :drafter_3
-                   :apib_path
-                 elsif version == :crafter
-                   :crafter_apib_path
-                 else
-                   :drafter_4_apib_path
-                 end
-               when :yaml
-                 if version == :drafter_3
-                   :drafter_yaml_path
-                 elsif version == :crafter
-                   :crafter_yaml_path
-                 else
-                   :drafter_4_yaml_path
-                 end
-               else
-                 fail NotImplementedError
-               end
+  format_key = {
+                  crafter:   :crafter_yaml_path,
+                  drafter_4: :drafter_yaml_path,
+                  openapi2: :openapi2_json_path,
+                  openapi3: :openapi3_yaml_path
+               }[version]
+
   tomogram = Tomograph::Tomogram.new(format_key => input)
   actions = tomogram.to_a.map(&:to_hash)
 

data/lib/tomograph/api_blueprint/crafter/yaml.rb

@@ -6,13 +6,9 @@ module Tomograph
   module ApiBlueprint
     class Crafter
       class Yaml
-        def initialize(prefix, apib_path, drafter_yaml_path)
+        def initialize(prefix, drafter_yaml_path)
           @prefix = prefix
-          @documentation = if apib_path
-                             YAML.safe_load(`drafter #{apib_path}`)
-                           elsif drafter_yaml_path
-                             YAML.safe_load(File.read(drafter_yaml_path))
-                           end
+          @documentation = YAML.safe_load(File.read(drafter_yaml_path))
         end
 
         def groups
@@ -101,15 +97,15 @@ module Tomograph
             path: "#{@prefix}#{related_actions.first.path}",
             method: related_actions.first.method,
             content_type: related_actions.first.content_type,
-            request: related_actions.first.request,
-            responses: related_actions.map(&:responses).flatten,
+            requests: related_actions.map(&:request).flatten.uniq,
+            responses: related_actions.map(&:responses).flatten.uniq,
             resource: related_actions.first.resource
           }
         end
 
         def to_tomogram
           @tomogram ||= actions.inject([]) do |result, action|
-            result.push(Tomograph::Tomogram::Action.new(action))
+            result.push(Tomograph::Tomogram::Action.new(**action))
           end
         end
 

data/lib/tomograph/api_blueprint/crafter/yaml/action.rb

@@ -37,8 +37,8 @@ module Tomograph
             end
             return {} unless schema_node
 
-            MultiJson.load(schema_node['content'])
-          rescue MultiJson::ParseError => e
+            JSON.parse(schema_node['content'])
+          rescue JSON::ParserError => e
             puts "[Tomograph] Error while parsing #{e}. skipping..."
             {}
           end
@@ -51,7 +51,7 @@ module Tomograph
             end
             @responses = @responses.map do |response|
               {
-                'status' => response['attributes']['statusCode']['content'],
+                'status' => response['attributes']['statusCode']['content'].to_s,
                 'body' => json_schema(response['content']),
                 'content-type' => response['attributes'].has_key?('headers') ?
                   response['attributes']['headers']['content'][0]['content']['value']['content'] : nil

data/lib/tomograph/api_blueprint/drafter_4/yaml.rb

@@ -6,13 +6,9 @@ module Tomograph
   module ApiBlueprint
     class Drafter4
       class Yaml
-        def initialize(prefix, apib_path, drafter_yaml_path)
+        def initialize(prefix, drafter_yaml_path)
           @prefix = prefix
-          @documentation = if apib_path
-                             YAML.safe_load(`drafter #{apib_path}`)
-                           elsif drafter_yaml_path
-                             YAML.safe_load(File.read(drafter_yaml_path))
-                           end
+          @documentation = YAML.safe_load(File.read(drafter_yaml_path))
         end
 
         def groups
@@ -101,15 +97,15 @@ module Tomograph
             path: "#{@prefix}#{related_actions.first.path}",
             method: related_actions.first.method,
             content_type: related_actions.first.content_type,
-            request: related_actions.first.request,
-            responses: related_actions.map(&:responses).flatten,
+            requests: related_actions.map(&:request).flatten.uniq,
+            responses: related_actions.map(&:responses).flatten.uniq,
             resource: related_actions.first.resource
           }
         end
 
         def to_tomogram
           @tomogram ||= actions.inject([]) do |result, action|
-            result.push(Tomograph::Tomogram::Action.new(action))
+            result.push(Tomograph::Tomogram::Action.new(**action))
           end
         end
 

data/lib/tomograph/api_blueprint/drafter_4/yaml/action.rb

@@ -37,8 +37,8 @@ module Tomograph
             end
             return {} unless schema_node
 
-            MultiJson.load(schema_node['content'])
-          rescue MultiJson::ParseError => e
+            JSON.parse(schema_node['content'])
+          rescue JSON::ParserError => e
             puts "[Tomograph] Error while parsing #{e}. skipping..."
             {}
           end
@@ -51,7 +51,7 @@ module Tomograph
             end
             @responses = @responses.map do |response|
               {
-                'status' => response['attributes']['statusCode']['content'],
+                'status' => response['attributes']['statusCode']['content'].to_s,
                 'body' => json_schema(response['content']),
                 'content-type' => response['attributes'].has_key?('headers') ?
                   response['attributes']['headers']['content'][0]['content']['value']['content'] : nil

data/lib/tomograph/api_blueprint/json_schema.rb

@@ -5,7 +5,7 @@ module Tomograph
     class JsonSchema
       def initialize(prefix, json_schema_path)
         @prefix = prefix
-        @documentation = MultiJson.load(File.read(json_schema_path))
+        @documentation = JSON.parse(File.read(json_schema_path))
       end
 
       def to_tomogram
@@ -14,7 +14,7 @@ module Tomograph
                         path: "#{@prefix}#{action['path']}",
                         method:  action['method'],
                         content_type: action['content-type'],
-                        request: action['request'],
+                        requests: action['requests'],
                         responses: action['responses'],
                         resource: action['resource']))
         end

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

@@ -1,23 +1,26 @@
-require 'multi_json'
+require 'json'
 require 'tomograph/path'
 require 'tomograph/api_blueprint/json_schema'
-require 'tomograph/api_blueprint/drafter_3/yaml'
 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: '', apib_path: nil, drafter_yaml_path: nil, tomogram_json_path: nil, drafter_4_apib_path: nil, drafter_4_yaml_path: nil, crafter_apib_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 drafter_4_yaml_path || drafter_4_apib_path
-                         Tomograph::ApiBlueprint::Drafter4::Yaml.new(prefix, drafter_4_apib_path, drafter_4_yaml_path)
-                       elsif crafter_yaml_path || crafter_apib_path
-                         Tomograph::ApiBlueprint::Crafter::Yaml.new(prefix, crafter_apib_path, crafter_yaml_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::Drafter3::Yaml.new(prefix, apib_path, drafter_yaml_path)
+                         Tomograph::ApiBlueprint::Drafter4::Yaml.new(prefix, drafter_yaml_path)
                        end
       @prefix = prefix
     end
@@ -26,13 +29,8 @@ 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
-      MultiJson.dump(to_a.map(&:to_hash), pretty: true)
+      JSON.pretty_generate(to_a.map(&:to_hash))
     end
 
     def find_request(method:, path:)