rspec_api_documentation 5.1.0 → 6.0.0

data/lib/rspec_api_documentation/writers/slate_writer.rb

@@ -21,17 +21,11 @@ module RspecApiDocumentation
       def write
         File.open(configuration.docs_dir.join("#{FILENAME}.#{extension}"), 'w+') do |file|
 
-          file.write %Q{---\n}
-          file.write %Q{title: "#{configuration.api_name}"\n}
-          file.write %Q{language_tabs:\n}
-          file.write %Q{  - json: JSON\n}
-          file.write %Q{  - shell: cURL\n}
-          file.write %Q{---\n\n}
+          file.write markup_index_class.new(index, configuration).render
 
           IndexHelper.sections(index.examples, @configuration).each do |section|
-
             file.write "# #{section[:resource_name]}\n\n"
-            section[:examples].sort_by!(&:description) unless configuration.keep_source_order
+            file.write "#{section[:resource_explanation]}\n\n"
 
             section[:examples].each do |example|
               markup_example = markup_example_class.new(example, configuration)

data/templates/rspec_api_documentation/api_blueprint_index.mustache

@@ -1,4 +1,5 @@
-FORMAT: A1
+FORMAT: 1A
+# {{ api_name }}
 {{# sections }}
 
 # Group {{ resource_name }}
@@ -48,13 +49,13 @@ explanation: {{ explanation }}
 
     + Headers
 
-        {{{ request_headers_text }}}
+            {{{ request_headers_text }}}
 {{/ request_headers_text }}
 {{# request_body }}
 
     + Body
 
-        {{{ request_body }}}
+            {{{ request_body }}}
 {{/ request_body }}
 {{# has_response? }}
 
@@ -64,13 +65,13 @@ explanation: {{ explanation }}
 
     + Headers
 
-        {{{ response_headers_text }}}
+            {{{ response_headers_text }}}
 {{/ response_headers_text }}
 {{# response_body }}
 
     + Body
 
-        {{{ response_body }}}
+            {{{ response_body }}}
 {{/ response_body }}
 {{/ requests }}
 {{/ examples }}

data/templates/rspec_api_documentation/slate_index.mustache

@@ -0,0 +1,8 @@
+---
+title: {{ api_name }}
+language_tabs:
+  - json: JSON
+  - shell: cURL
+---
+
+{{{ api_explanation }}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Chris Cahoon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -252,6 +252,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
 description: Generate API docs from your test suite
 email:
 - chris@smartlogicsolutions.com
@@ -279,6 +313,25 @@ files:
 - lib/rspec_api_documentation/http_test_client.rb
 - lib/rspec_api_documentation/index.rb
 - lib/rspec_api_documentation/oauth2_mac_client.rb
+- lib/rspec_api_documentation/open_api/contact.rb
+- lib/rspec_api_documentation/open_api/example.rb
+- lib/rspec_api_documentation/open_api/header.rb
+- lib/rspec_api_documentation/open_api/headers.rb
+- lib/rspec_api_documentation/open_api/helper.rb
+- lib/rspec_api_documentation/open_api/info.rb
+- lib/rspec_api_documentation/open_api/license.rb
+- lib/rspec_api_documentation/open_api/node.rb
+- lib/rspec_api_documentation/open_api/operation.rb
+- lib/rspec_api_documentation/open_api/parameter.rb
+- lib/rspec_api_documentation/open_api/path.rb
+- lib/rspec_api_documentation/open_api/paths.rb
+- lib/rspec_api_documentation/open_api/response.rb
+- lib/rspec_api_documentation/open_api/responses.rb
+- lib/rspec_api_documentation/open_api/root.rb
+- lib/rspec_api_documentation/open_api/schema.rb
+- lib/rspec_api_documentation/open_api/security_definitions.rb
+- lib/rspec_api_documentation/open_api/security_schema.rb
+- lib/rspec_api_documentation/open_api/tag.rb
 - lib/rspec_api_documentation/rack_test_client.rb
 - lib/rspec_api_documentation/railtie.rb
 - lib/rspec_api_documentation/test_server.rb
@@ -305,6 +358,7 @@ files:
 - lib/rspec_api_documentation/writers/json_iodocs_writer.rb
 - lib/rspec_api_documentation/writers/json_writer.rb
 - lib/rspec_api_documentation/writers/markdown_writer.rb
+- lib/rspec_api_documentation/writers/open_api_writer.rb
 - lib/rspec_api_documentation/writers/slate_writer.rb
 - lib/rspec_api_documentation/writers/textile_writer.rb
 - lib/rspec_api_documentation/writers/writer.rb
@@ -315,6 +369,7 @@ files:
 - templates/rspec_api_documentation/markdown_example.mustache
 - templates/rspec_api_documentation/markdown_index.mustache
 - templates/rspec_api_documentation/slate_example.mustache
+- templates/rspec_api_documentation/slate_index.mustache
 - templates/rspec_api_documentation/textile_example.mustache
 - templates/rspec_api_documentation/textile_index.mustache
 homepage: http://smartlogicsolutions.com
@@ -342,4 +397,3 @@ signing_key:
 specification_version: 4
 summary: A double black belt for your docs
 test_files: []
-has_rdoc: