dox 1.0.0.alpha → 1.0.0

data/lib/dox/printers/base_printer.rb

@@ -1,7 +1,6 @@
 module Dox
   module Printers
     class BasePrinter
-
       def initialize(output)
         @output = output
       end
@@ -20,16 +19,20 @@ module Dox
         return if desc.blank?
 
         if desc.to_s =~ /.*\.md$/
-          if fullpath
-            path = desc
-          else
-            path = descriptions_folder_path.join(desc).to_s
-          end
-          "<!-- include(#{path}) -->"
+          path = if fullpath
+                   desc
+                 else
+                   descriptions_folder_path.join(desc).to_s
+                 end
+          content(path)
         else
           desc
         end
       end
+
+      def content(path)
+        File.read(path)
+      end
     end
   end
 end

data/lib/dox/printers/document_printer.rb

@@ -1,7 +1,6 @@
 module Dox
   module Printers
     class DocumentPrinter < BasePrinter
-
       def print(passed_examples)
         print_meta_info
 
@@ -23,7 +22,6 @@ module Dox
       def api_desc_path
         Dox.config.header_file_path
       end
-
     end
   end
 end

data/lib/dox/printers/example_printer.rb

@@ -1,22 +1,85 @@
 module Dox
   module Printers
     class ExamplePrinter < BasePrinter
-
       def print(example)
-        @output.puts "\n+ Request #{example.request_identifier} (#{example.request_content_type})"
+        self.example = example
+        print_example_request
+        print_example_response
+      end
 
-        if example.request_parameters.present?
-          @output.puts "\n#{indent_lines(8, pretty_json(example.request_parameters))}\n"
-        end
+      private
+
+      attr_accessor :example
 
-        @output.puts "+ Response #{example.response_status} (#{example.response_content_type})"
+      def print_example_request
+        @output.puts example_request_title
+        @output.puts example_request_headers
+        return unless example.request_parameters.present?
 
-        if example.response_body.present?
-          @output.puts "\n#{indent_lines(8, pretty_json(safe_json_parse(example.response_body)))}\n"
+        @output.puts example_request_body
+      end
+
+      def print_example_response
+        @output.puts example_response_title
+
+        if example.response_headers.present?
+          @output.puts example_response_headers
         end
+
+        return unless example.response_body.present?
+        @output.puts example_response_body
       end
 
-      private
+      def example_request_title
+        <<-HEREDOC
+
++ Request #{example.request_identifier}
+**#{example.request_method.upcase}**&nbsp;&nbsp;`#{CGI.unescape(example.request_fullpath)}`
+        HEREDOC
+      end
+
+      def example_request_headers
+        <<-HEREDOC
+
+    + Headers
+
+#{indent_lines(12, print_headers(example.request_headers))}
+        HEREDOC
+      end
+
+      def example_request_body
+        <<-HEREDOC
+
+    + Body
+
+#{indent_lines(12, pretty_json(example.request_parameters))}
+        HEREDOC
+      end
+
+      def example_response_title
+        <<-HEREDOC
+
++ Response #{example.response_status}
+        HEREDOC
+      end
+
+      def example_response_headers
+        <<-HEREDOC
+
+    + Headers
+
+#{indent_lines(12, print_headers(example.response_headers))}
+        HEREDOC
+      end
+
+      def example_response_body
+        <<-HEREDOC
+
+    + Body
+
+#{indent_lines(12, pretty_json(safe_json_parse(example.response_body)))}
+        HEREDOC
+      end
 
       def safe_json_parse(json_string)
         json_string.length >= 2 ? JSON.parse(json_string) : nil
@@ -30,6 +93,12 @@ module Dox
         end
       end
 
+      def print_headers(headers)
+        headers.map do |key, value|
+          "#{key}: #{value}"
+        end.join("\n")
+      end
+
       def indent_lines(number_of_spaces, string)
         string
           .split("\n")

data/lib/dox/printers/resource_group_printer.rb

@@ -1,9 +1,9 @@
 module Dox
   module Printers
     class ResourceGroupPrinter < BasePrinter
-
       def print(resource_group)
-        @output.puts "\n# Group #{resource_group.name}\n\n#{print_desc(resource_group.desc)}\n"
+        self.resource_group = resource_group
+        @output.puts resource_group_title
 
         resource_group.resources.each do |_, resource|
           resource_printer.print(resource)
@@ -12,10 +12,19 @@ module Dox
 
       private
 
+      attr_accessor :resource_group
+
+      def resource_group_title
+        <<-HEREDOC
+
+# Group #{resource_group.name}
+#{print_desc(resource_group.desc)}
+        HEREDOC
+      end
+
       def resource_printer
         @resource_printer ||= ResourcePrinter.new(@output)
       end
-
     end
   end
 end

data/lib/dox/printers/resource_printer.rb

@@ -1,9 +1,9 @@
 module Dox
   module Printers
     class ResourcePrinter < BasePrinter
-
       def print(resource)
-        @output.puts "\n## #{resource.name} [#{resource.endpoint}]\n\n#{print_desc(resource.desc)}\n"
+        self.resource = resource
+        @output.puts resource_title
 
         resource.actions.each do |_, action|
           action_printer.print(action)
@@ -12,10 +12,19 @@ module Dox
 
       private
 
+      attr_accessor :resource
+
+      def resource_title
+        <<-HEREDOC
+
+## #{resource.name} [#{resource.endpoint}]
+#{print_desc(resource.desc)}
+        HEREDOC
+      end
+
       def action_printer
         @action_printer ||= ActionPrinter.new(@output)
       end
-
     end
   end
 end

data/lib/dox/util/http.rb

@@ -0,0 +1,11 @@
+module Dox
+  module Util
+    module Http
+      VERB = ['POST', 'GET', 'PUT', 'PATCH', 'DELETE', 'HEAD'].freeze
+
+      def self.verb?(value)
+        VERB.include?(value.upcase)
+      end
+    end
+  end
+end

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = "1.0.0.alpha"
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha
+  version: 1.0.0
 platform: ruby
 authors:
 - Melita Kokot
+- Vedran Hrnčić
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2017-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +67,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  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: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -97,13 +126,18 @@ dependencies:
 description: 
 email:
 - melita.kokot@gmail.com
-executables: []
+- vrabac266@gmail.com
+executables:
+- dox
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- CHANGES.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -112,6 +146,8 @@ files:
 - bin/console
 - bin/setup
 - dox.gemspec
+- exe/dox
+- infinum.png
 - lib/dox.rb
 - lib/dox/config.rb
 - lib/dox/dsl/action.rb
@@ -136,6 +172,7 @@ files:
 - lib/dox/printers/example_printer.rb
 - lib/dox/printers/resource_group_printer.rb
 - lib/dox/printers/resource_printer.rb
+- lib/dox/util/http.rb
 - lib/dox/version.rb
 homepage: https://github.com/infinum/dox
 licenses:
@@ -153,9 +190,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1