dox 1.2.0 → 2.0.0.beta1

data/lib/dox.rb

@@ -27,7 +27,8 @@ require 'dox/formatters/xml'
 require 'dox/printers/base_printer'
 require 'dox/printers/action_printer'
 require 'dox/printers/document_printer'
-require 'dox/printers/example_printer'
+require 'dox/printers/example_request_printer'
+require 'dox/printers/example_response_printer'
 require 'dox/printers/resource_group_printer'
 require 'dox/printers/resource_printer'
 require 'dox/util/http'
@@ -48,4 +49,11 @@ module Dox
   def self.full_headers_whitelist
     (config.headers_whitelist.to_a + DEFAULT_HEADERS_WHITELIST).uniq
   end
+
+  RSpec.configure do |config|
+    config.after(:each, :dox) do |example|
+      example.metadata[:request] = request
+      example.metadata[:response] = response
+    end
+  end
 end

data/lib/dox/config.rb

@@ -1,16 +1,49 @@
 module Dox
   class Config
-    attr_reader :header_file_path, :desc_folder_path
+    attr_reader :schema_request_folder_path
+    attr_reader :schema_response_folder_path
+    attr_reader :schema_response_fail_file_path
     attr_accessor :headers_whitelist
+    attr_accessor :openapi_version
+    attr_accessor :api_version
+    attr_accessor :title
+    attr_accessor :description
+    attr_reader :descriptions_location
 
-    def header_file_path=(file_path)
+    def descriptions_location=(folder_path)
+      raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)
+
+      @descriptions_location = folder_path
+    end
+
+    def schema_request_folder_path=(folder_path)
+      raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)
+
+      @schema_request_folder_path = folder_path
+    end
+
+    def schema_response_folder_path=(folder_path)
+      raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)
+
+      @schema_response_folder_path = folder_path
+    end
+
+    def schema_response_fail_file_path=(file_path)
       raise(Errors::FileNotFoundError, file_path) unless File.exist?(file_path)
-      @header_file_path = file_path
+
+      @schema_response_fail_file_path = file_path
     end
 
     def desc_folder_path=(folder_path)
-      raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)
-      @desc_folder_path = folder_path
+      warn(
+        'DEPRECATION WARNING: desc_folder_path will be removed in the next release, please use descriptions_location instead' # rubocop:disable Layout/LineLength
+      )
+
+      self.descriptions_location = folder_path
+    end
+
+    def header_file_path=(_file_path)
+      warn('WARNING: header_file_path is no longer used. Move header description to config.header_description.')
     end
   end
 end

data/lib/dox/dsl/action.rb

@@ -8,6 +8,10 @@ module Dox
       attr_writer :path
       attr_writer :desc
       attr_writer :params
+      attr_writer :query_params
+      attr_writer :request_schema
+      attr_writer :response_schema_success
+      attr_writer :response_schema_fail
 
       def initialize(name, &block)
         self.name = name
@@ -17,13 +21,15 @@ module Dox
       end
 
       def config
-        {
+        { action_request_schema: @request_schema.presence,
+          action_response_schema_success: @response_schema_success.presence,
+          action_response_schema_fail: @response_schema_fail.presence,
           action_name: @name.presence,
           action_verb: @verb.presence,
           action_path: @path.presence,
-          action_desc: @desc.presence,
-          action_params: @params
-        }
+          action_desc: @desc.presence || '',
+          action_params: @params,
+          action_query_params: @query_params.presence || [] }
       end
     end
   end

data/lib/dox/dsl/documentation.rb

@@ -14,6 +14,8 @@ module Dox
         self._resource = Resource.new(name, &block)
       end
 
+      alias tag resource
+
       def action(name, &block)
         self._action = Action.new(name, &block)
       end
@@ -22,6 +24,8 @@ module Dox
         self._group = ResourceGroup.new(name, &block)
       end
 
+      alias x_tag group
+
       def config
         {}.merge(_resource ? _resource.config : {})
           .merge(_action ? _action.config : {})

data/lib/dox/dsl/syntax.rb

@@ -10,6 +10,7 @@ module Dox
 
       def const_missing(name)
         documentation = _subjects[infer_subject(name)]
+
         return super unless documentation
 
         Module.new do

data/lib/dox/entities/action.rb

@@ -1,16 +1,17 @@
 module Dox
   module Entities
     class Action
-      attr_reader :name, :desc, :verb, :path, :uri_params
+      attr_reader :name, :desc, :verb, :path, :resource, :params
       attr_accessor :examples
 
-      def initialize(name, details, request)
+      def initialize(details, request)
         @request = request
-        @name = name
+        @name = details[:action_name]
+        @resource = details[:resource_name]
         @desc = details[:action_desc]
         @verb = details[:action_verb] || request.method
         @path = details[:action_path] || template_path
-        @uri_params = details[:action_params] || template_path_params
+        @params = template_params(details[:action_params], details[:action_query_params] || [])
         @examples = []
 
         validate!
@@ -22,25 +23,44 @@ module Dox
 
       # /pokemons/1 => pokemons/{id}
       def template_path
-        path = request.path.dup.presence || request.fullpath.split("?").first
+        path = request.path.dup.presence || request.fullpath.split('?').first
         path_params.each do |key, value|
           path.sub!(%r{\/#{value}(\/|$)}, "/{#{key}}\\1")
         end
+
         path
       end
 
+      def template_params(defined_params, query_params)
+        acquire_path_params + acquire_defined_params(defined_params) + query_params
+      end
+
       def path_params
-        @path_params ||=
-          request.path_parameters.symbolize_keys.except(:action, :controller, :format, :subdomain)
+        request.path_parameters.symbolize_keys.except(:action, :controller, :format, :subdomain)
+      end
+
+      def acquire_path_params
+        return [] if path_params.nil?
+
+        path_params.map do |param, value|
+          { name: param,
+            in: :path,
+            schema: { type: guess_param_type(value) },
+            example: value }
+        end
       end
 
-      def template_path_params
-        h = {}
-        path_params.each do |param, value|
-          param_type = guess_param_type(value)
-          h[param] = { type: param_type, required: :required, value: value }
+      def acquire_defined_params(defined_params)
+        return [] if defined_params.nil?
+
+        defined_params.map do |key, value|
+          { name: key,
+            in: 'query',
+            required: value[:required],
+            example: value[:value],
+            description: value[:description].presence || '',
+            schema: { type: value[:type] } }
         end
-        h
       end
 
       def guess_param_type(param)

data/lib/dox/entities/example.rb

@@ -3,6 +3,8 @@ module Dox
     class Example
       extend Forwardable
 
+      attr_reader :desc, :name, :request_schema, :response_schema_success, :response_schema_fail
+
       def_delegator :response, :status, :response_status
       def_delegator :response, :content_type, :response_content_type
       def_delegator :request, :content_type, :request_content_type
@@ -10,6 +12,10 @@ module Dox
 
       def initialize(details, request, response)
         @desc = details[:description]
+        @name = details[:resource_name].downcase
+        @request_schema = details[:action_request_schema]
+        @response_schema_success = details[:action_response_schema_success]
+        @response_schema_fail = details[:action_response_schema_fail]
         @request = request
         @response = response
       end
@@ -34,6 +40,10 @@ module Dox
         @request_headers ||= filter_headers(request)
       end
 
+      def response_success?
+        response.successful?
+      end
+
       # Rails 4 includes the body params in the request_fullpath
       def request_fullpath
         if request.query_parameters.present?
@@ -67,7 +77,7 @@ module Dox
         request.path.presence || request.fullpath.split('?')[0]
       end
 
-      attr_reader :desc, :request, :response
+      attr_reader :request, :response
 
       def filter_headers(obj)
         headers_whitelist.map do |header|

data/lib/dox/entities/resource.rb

@@ -1,17 +1,16 @@
 module Dox
   module Entities
     class Resource
-
-      attr_reader :name, :desc, :endpoint
+      attr_reader :name, :desc, :endpoint, :group
       attr_accessor :actions
 
-      def initialize(name, details)
-        @name = name
+      def initialize(details)
+        @name = details[:resource_name]
+        @group = details[:resource_group_name]
         @desc = details[:resource_desc]
         @endpoint = details[:resource_endpoint]
         @actions = {}
       end
-
     end
   end
 end

data/lib/dox/entities/resource_group.rb

@@ -1,12 +1,11 @@
 module Dox
   module Entities
     class ResourceGroup
-
       attr_reader :name
       attr_accessor :desc, :resources
 
-      def initialize(name, details)
-        @name = name
+      def initialize(details)
+        @name = details[:resource_group_name]
         @desc = details[:resource_group_desc]
         @resources = {}
       end

data/lib/dox/formatter.rb

@@ -20,7 +20,7 @@ module Dox
 
     def stop(notification)
       if notification.failed_examples.any?
-        $stderr.puts(notification.fully_formatted_failed_examples)
+        warn(notification.fully_formatted_failed_examples)
       else
         printer.print(passed_examples)
       end
@@ -28,7 +28,8 @@ module Dox
 
     def dump_summary(summary)
       return if summary.failed_examples.none?
-      $stderr.puts(summary.fully_formatted)
+
+      warn(summary.fully_formatted)
       exit(-1)
     end
 
@@ -44,28 +45,26 @@ module Dox
       if group
         group.tap { |g| g.desc ||= current_example.resource_group_desc }
       else
-        passed_examples[group_name] = Entities::ResourceGroup.new(group_name,
-                                                                  current_example.metadata)
+        passed_examples[group_name] = Entities::ResourceGroup.new(current_example.metadata)
       end
     end
 
     def load_or_save_resource_to_group(group)
-      resource_name = current_example.resource_name
-      group.resources[resource_name] ||= Entities::Resource.new(resource_name,
-                                                                current_example.metadata)
+      group.resources[current_example.resource_name] ||= Entities::Resource.new(current_example.metadata)
     end
 
     def load_or_save_action_to_resource(resource)
-      action_name = current_example.action_name
-      resource.actions[action_name] ||= Entities::Action.new(action_name, current_example.metadata,
-                                                             current_example.request)
+      resource.actions[current_example.action_name] ||= Entities::Action.new(current_example.metadata,
+                                                                             current_example.request)
     end
 
     def move_example_to_passed
       group = load_or_save_group
       resource = load_or_save_resource_to_group(group)
       action = load_or_save_action_to_resource(resource)
-      action.examples << Entities::Example.new(current_example.metadata, current_example.request, current_example.response)
+      action.examples << Entities::Example.new(current_example.metadata,
+                                               current_example.request,
+                                               current_example.response)
     end
 
     def printer

data/lib/dox/printers/action_printer.rb

@@ -3,44 +3,35 @@ module Dox
     class ActionPrinter < BasePrinter
       def print(action)
         self.action = action
-        @output.puts action_title
-        @output.puts action_uri_params if action.uri_params.present?
+        @action_hash = find_or_add(find_or_add(spec, action.path.to_s), action.verb.downcase.to_sym)
 
-        action.examples.each do |example|
-          example_printer.print(example)
-        end
+        add_action
+        add_action_params
+
+        print_examples
       end
 
       private
 
-      attr_accessor :action
-
-      def action_title
-        <<-HEREDOC
+      attr_accessor :action, :action_hash
 
-### #{action.name} [#{action.verb.upcase} #{action.path}]
-#{print_desc(action.desc)}
-        HEREDOC
+      def add_action
+        action_hash['summary'] = action.name
+        action_hash['tags'] = [action.resource]
+        action_hash['description'] = format_desc(action.desc)
       end
 
-      def action_uri_params
-        <<-HEREDOC
-+ Parameters
-#{formatted_params(action.uri_params)}
-        HEREDOC
-      end
+      def add_action_params
+        return unless action.params.present?
 
-      def example_printer
-        @example_printer ||= ExamplePrinter.new(@output)
+        action_hash['parameters'] = action.params
       end
 
-      def formatted_params(uri_params)
-        uri_params.map do |param, details|
-          desc = "    + #{CGI.escape(param.to_s)}: `#{CGI.escape(details[:value].to_s)}` (#{details[:type]}, #{details[:required]})"
-          desc += " - #{details[:description]}" if details[:description].present?
-          desc += "\n        + Default: #{details[:default]}" if details[:default].present?
-          desc
-        end.flatten.join("\n")
+      def print_examples
+        action.examples.each do |example|
+          ExampleRequestPrinter.new(action_hash).print(example)
+          ExampleResponsePrinter.new(action_hash).print(example)
+        end
       end
     end
   end

data/lib/dox/printers/base_printer.rb

@@ -1,37 +1,56 @@
+require 'rexml/document'
+
 module Dox
   module Printers
     class BasePrinter
-      def initialize(output)
-        @output = output
+      attr_reader :spec
+
+      def initialize(spec)
+        @spec = spec || {}
       end
 
       def print
         raise NotImplementedError
       end
 
-      private
+      def find_or_add(hash, key, default = {})
+        return hash[key] if hash.key?(key)
 
-      def descriptions_folder_path
-        Dox.config.desc_folder_path
+        hash[key] = default
       end
 
-      def print_desc(desc, fullpath = false)
-        return if desc.blank?
+      def read_file(path, root_path: Dox.config.descriptions_location)
+        return '' unless root_path
+
+        File.read(File.join(root_path, path))
+      end
 
-        if desc.to_s =~ /.*\.md$/
-          path = if fullpath
-                   desc
-                 else
-                   descriptions_folder_path.join(desc).to_s
-                 end
-          content(path)
+      def formatted_body(body_str, content_type)
+        case content_type
+        when %r{application\/.*json}
+          JSON.parse(body_str)
+        when /xml/
+          pretty_xml(body_str)
         else
-          desc
+          body_str
         end
       end
 
-      def content(path)
-        File.read(path)
+      def pretty_xml(xml_string)
+        doc = REXML::Document.new(xml_string)
+        formatter = REXML::Formatters::Pretty.new
+        formatter.compact = true
+        result = ''
+        formatter.write(doc, result)
+        result
+      end
+
+      def format_desc(description)
+        desc = description
+        desc = '' if desc.nil?
+        desc = read_file(desc) if desc.end_with?('.md')
+
+        desc
       end
     end
   end