dox 1.2.0 → 2.0.0.beta1

data/lib/dox/printers/document_printer.rb

@@ -1,26 +1,46 @@
 module Dox
   module Printers
     class DocumentPrinter < BasePrinter
+      def initialize(output)
+        super(body)
+        @output = output
+      end
+
       def print(passed_examples)
-        print_meta_info
+        spec['paths'] = {}
+        spec['tags'] = []
+        spec['x-tagGroups'] = []
 
         passed_examples.sort.each do |_, resource_group|
           group_printer.print(resource_group)
         end
+
+        @output.puts(JSON.pretty_generate(spec))
       end
 
       private
 
-      def group_printer
-        @group_printer ||= ResourceGroupPrinter.new(@output)
+      def body
+        {
+          openapi: Dox.config.openapi_version || '3.0.0',
+          info: {
+            title: Dox.config.title || 'API Documentation',
+            description: adjust_description(Dox.config.description || ''),
+            version: Dox.config.api_version || '1.0'
+          }
+        }
       end
 
-      def print_meta_info
-        @output.puts(print_desc(api_desc_path))
+      def adjust_description(description)
+        description.end_with?('.md') ? acquire_desc(description) : description
       end
 
-      def api_desc_path
-        Dox.config.header_file_path
+      def acquire_desc(path)
+        read_file(path)
+      end
+
+      def group_printer
+        @group_printer ||= ResourceGroupPrinter.new(spec)
       end
     end
   end

data/lib/dox/printers/example_request_printer.rb

@@ -0,0 +1,69 @@
+module Dox
+  module Printers
+    class ExampleRequestPrinter < BasePrinter
+      def print(example)
+        self.example = example
+        add_example_request
+      end
+
+      private
+
+      attr_accessor :example
+
+      def add_example_request
+        spec['parameters'] = add_new_header_params(find_or_add(spec, 'parameters', []))
+        return if example.request_body.empty?
+
+        add_content(find_or_add(spec, 'requestBody'))
+      end
+
+      def add_content(body)
+        add_content_name(body['content'] = find_or_add(body, 'content'))
+      end
+
+      def add_content_name(body)
+        req_header = find_headers(example.request_headers)
+        add_example(body[req_header] = find_or_add(body, req_header))
+        add_schema(body[req_header], Dox.config.schema_request_folder_path)
+      end
+
+      def add_example(body)
+        add_desc(body['examples'] = find_or_add(body, 'examples'))
+      end
+
+      def add_desc(body)
+        body[example.desc] = { 'summary' => example.desc,
+                               'value' => formatted_body(example.request_body,
+                                                         example.request_content_type) }
+      end
+
+      def add_schema(body, path)
+        return if example.request_schema.nil?
+        return unless path
+
+        file_path = File.join(path, "#{example.request_schema}.json")
+
+        body['schema'] = File.file?(file_path) ? { '$ref' => file_path } : JSON.parse(example.request_schema)
+      end
+
+      def find_headers(headers)
+        headers.find { |key, _| key == 'Accept' }&.last || 'any'
+      end
+
+      def acquire_header_params
+        example.request_headers.map do |key, value|
+          { name: key, in: :header, example: value }
+        end
+      end
+
+      def add_new_header_params(header_params)
+        example.request_headers.each do |key, value|
+          header_params.push(name: key, in: :header, example: value) unless
+            header_params.detect { |hash| hash[:name] == key }
+        end
+
+        header_params
+      end
+    end
+  end
+end

data/lib/dox/printers/example_response_printer.rb

@@ -0,0 +1,86 @@
+module Dox
+  module Printers
+    class ExampleResponsePrinter < BasePrinter
+      def print(example)
+        self.example = example
+        add_example_response
+      end
+
+      private
+
+      attr_accessor :example
+
+      def add_example_response
+        add_statuses(find_or_add(find_or_add(spec, 'responses'), example.response_status.to_s))
+      end
+
+      def add_statuses(body)
+        add_status_desc(body)
+        add_content(body)
+        add_headers(body)
+      end
+
+      def add_status_desc(body)
+        body['description'] = Util::Http::HTTP_STATUS_CODES[example.response_status]
+      end
+
+      def add_content(body)
+        add_content_name(body['content'] = find_or_add(body, 'content'))
+      end
+
+      def add_content_name(body)
+        resp_header = find_headers(example.response_headers)
+
+        add_example(body[resp_header] = find_or_add(body, resp_header))
+        add_schema(body[resp_header], Dox.config.schema_response_folder_path)
+      end
+
+      def add_example(body)
+        return if example.response_body.empty?
+
+        add_desc(body['examples'] = find_or_add(body, 'examples'))
+      end
+
+      def add_desc(body)
+        body[example.desc] = { 'summary' => example.desc,
+                               'value' => formatted_body(example.response_body,
+                                                         find_headers(example.response_headers)) }
+      end
+
+      def add_schema(body, path)
+        return unless path
+
+        schema = find_schema
+
+        return unless schema
+
+        add_schema_to_hash(body, path, schema)
+      end
+
+      def find_schema
+        if example.response_success?
+          example.response_schema_success
+        else
+          example.response_schema_fail || Dox.config.schema_response_fail_file_path
+        end
+      end
+
+      def add_schema_to_hash(body, path, schema)
+        body['schema'] =
+          if schema.is_a?(Pathname)
+            { '$ref' => schema }
+          else
+            { '$ref' => File.join(path, "#{schema}.json") }
+          end
+      end
+
+      def find_headers(headers)
+        headers.find { |key, _| key == 'Content-Type' }&.last || 'any'
+      end
+
+      def add_headers(body)
+        body['headers'] = Hash[example.response_headers.map { |key, value| [key, { description: value }] }]
+      end
+    end
+  end
+end

data/lib/dox/printers/resource_group_printer.rb

@@ -3,7 +3,7 @@ module Dox
     class ResourceGroupPrinter < BasePrinter
       def print(resource_group)
         self.resource_group = resource_group
-        @output.puts resource_group_title
+        add_resource_group
 
         resource_group.resources.each do |_, resource|
           resource_printer.print(resource)
@@ -14,16 +14,16 @@ module Dox
 
       attr_accessor :resource_group
 
-      def resource_group_title
-        <<-HEREDOC
+      def add_resource_group
+        spec['x-tagGroups'].push(name: resource_group.name, 'tags' => []) unless group_included?
+      end
 
-# Group #{resource_group.name}
-#{print_desc(resource_group.desc)}
-        HEREDOC
+      def group_included?
+        spec['x-tagGroups'].find { |group| group[:name] == resource_group.name }
       end
 
       def resource_printer
-        @resource_printer ||= ResourcePrinter.new(@output)
+        @resource_printer ||= ResourcePrinter.new(spec)
       end
     end
   end

data/lib/dox/printers/resource_printer.rb

@@ -3,7 +3,7 @@ module Dox
     class ResourcePrinter < BasePrinter
       def print(resource)
         self.resource = resource
-        @output.puts resource_title
+        add_resources
 
         resource.actions.each do |_, action|
           action_printer.print(action)
@@ -14,16 +14,21 @@ module Dox
 
       attr_accessor :resource
 
-      def resource_title
-        <<-HEREDOC
+      def add_resources
+        add_to_tags
+        add_to_groups
+      end
+
+      def add_to_tags
+        spec['tags'] = spec['tags'].push(name: resource.name, description: format_desc(resource.desc)).uniq
+      end
 
-## #{resource.name} [#{resource.endpoint}]
-#{print_desc(resource.desc)}
-        HEREDOC
+      def add_to_groups
+        spec['x-tagGroups'].find { |group| group[:name] == resource.group }['tags'].push(resource.name)
       end
 
       def action_printer
-        @action_printer ||= ActionPrinter.new(@output)
+        @action_printer ||= ActionPrinter.new(spec['paths'])
       end
     end
   end

data/lib/dox/util/http.rb

@@ -2,6 +2,70 @@ module Dox
   module Util
     module Http
       VERB = ['POST', 'GET', 'PUT', 'PATCH', 'DELETE', 'HEAD'].freeze
+      HTTP_STATUS_CODES = {
+        100 => 'Continue',
+        101 => 'Switching Protocols',
+        102 => 'Processing',
+        103 => 'Early Hints',
+        200 => 'OK',
+        201 => 'Created',
+        202 => 'Accepted',
+        203 => 'Non-Authoritative Information',
+        204 => 'No Content',
+        205 => 'Reset Content',
+        206 => 'Partial Content',
+        207 => 'Multi-Status',
+        208 => 'Already Reported',
+        226 => 'IM Used',
+        300 => 'Multiple Choices',
+        301 => 'Moved Permanently',
+        302 => 'Found',
+        303 => 'See Other',
+        304 => 'Not Modified',
+        305 => 'Use Proxy',
+        307 => 'Temporary Redirect',
+        308 => 'Permanent Redirect',
+        400 => 'Bad Request',
+        401 => 'Unauthorized',
+        402 => 'Payment Required',
+        403 => 'Forbidden',
+        404 => 'Not Found',
+        405 => 'Method Not Allowed',
+        406 => 'Not Acceptable',
+        407 => 'Proxy Authentication Required',
+        408 => 'Request Timeout',
+        409 => 'Conflict',
+        410 => 'Gone',
+        411 => 'Length Required',
+        412 => 'Precondition Failed',
+        413 => 'Payload Too Large',
+        414 => 'URI Too Long',
+        415 => 'Unsupported Media Type',
+        416 => 'Range Not Satisfiable',
+        417 => 'Expectation Failed',
+        421 => 'Misdirected Request',
+        422 => 'Unprocessable Entity',
+        423 => 'Locked',
+        424 => 'Failed Dependency',
+        425 => 'Too Early',
+        426 => 'Upgrade Required',
+        428 => 'Precondition Required',
+        429 => 'Too Many Requests',
+        431 => 'Request Header Fields Too Large',
+        451 => 'Unavailable for Legal Reasons',
+        500 => 'Internal Server Error',
+        501 => 'Not Implemented',
+        502 => 'Bad Gateway',
+        503 => 'Service Unavailable',
+        504 => 'Gateway Timeout',
+        505 => 'HTTP Version Not Supported',
+        506 => 'Variant Also Negotiates',
+        507 => 'Insufficient Storage',
+        508 => 'Loop Detected',
+        509 => 'Bandwidth Limit Exceeded',
+        510 => 'Not Extended',
+        511 => 'Network Authentication Required'
+      }.freeze
 
       def self.verb?(value)
         VERB.include?(value.upcase)

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = '1.2.0'
+  VERSION = '2.0.0.beta1'.freeze
 end

metadata

@@ -1,60 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0.beta1
 platform: ruby
 authors:
 - Melita Kokot
 - Vedran Hrnčić
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: pry-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,34 +96,90 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-core
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-description: 
+        version: '0'
+description:
 email:
 - melita.kokot@gmail.com
 - vrabac266@gmail.com
@@ -174,7 +230,8 @@ files:
 - lib/dox/printers/action_printer.rb
 - lib/dox/printers/base_printer.rb
 - lib/dox/printers/document_printer.rb
-- lib/dox/printers/example_printer.rb
+- lib/dox/printers/example_request_printer.rb
+- lib/dox/printers/example_response_printer.rb
 - lib/dox/printers/resource_group_printer.rb
 - lib/dox/printers/resource_printer.rb
 - lib/dox/util/http.rb
@@ -184,7 +241,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,13 +252,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: Generates API documentation for rspec in api blueprint format.
+summary: Generates API documentation for rspec in OpenAPI format.
 test_files: []