dox 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3696fee9fddea2f824f129a0a25e61383b01cec
-  data.tar.gz: c69809b3ce6618fc593dd8897938e5f34d8788c9
+  metadata.gz: 658311eb3318384ac31608e40c9926544f24e170
+  data.tar.gz: 35832e0fa318b5d019a3d03765612fe1f7523b4e
 SHA512:
-  metadata.gz: 28f6f85ab7471792a741658f83a1a1b522359da8bed3e4bd5f9e9a4cf71d9e28e80fe1a087fc459bd9c4c58afbde4cb797ceb0732d7a3980556c2c973bf7838e
-  data.tar.gz: 2e71c5e388fc0c7bb727f057219e6376b4a2fe80a645738fef539ced75d1099227a27c8ac786b2c8c160c98e99fc99b22a2e0404dc414d7b3a0f2276b1e9bd7a
+  metadata.gz: 81e5317ed65beaf22e632932e1b03df01e4933fa982b57ec85d3e1b07a5bf8a95512e67b726a6e2370a88dc3799ac0dd0fb60b8ebab66ee5db1ed6344867abca
+  data.tar.gz: 5cf6550f640579aa530c229e60ceb6c1fbdaeb9d4910dba247dc961503c21eb020044fd203dab03e21c6ed33716c14ad8917033b253cf8e7e8c5d68f57382baf

data/CHANGES.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Version 1.0.1
+
+Released on June 10, 2017
+
+New:
+- Add Rake tasks for generating documentation to Readme
+
+Fix:
+- Fix printing request body for test examples
+
+
 ## Version 1.0.0
 
 Released on May 6, 2017

data/README.md

@@ -242,13 +242,46 @@ end
 ### Generate documentation
 Documentation is generated in 2 steps:
 
-1. generate API Blueprint markdown with dox command:
-```bundle exec dox spec/controllers/api/v1 > docs.md```
+1. generate API Blueprint markdown:
+```bundle exec rspec spec/controllers/api/v1 -f Dox::Formatter --order defined --tag dox --out docs.md```
 
 2. render HTML with some renderer, for example, with Aglio:
 ```aglio -i docs.md -o docs.html```
 
 
+#### Use Rake tasks
+It's recommendable to write a few Rake tasks to make things easier. Here's an example:
+
+```ruby
+namespace :api do
+  namespace :doc do
+    desc 'Generate API documentation markdown'
+    task :md do
+      require 'rspec/core/rake_task'
+
+      RSpec::Core::RakeTask.new(:api_spec) do |t|
+        t.pattern = 'spec/controllers/api/v1/'
+        t.rspec_opts = "-f Dox::Formatter --order defined --tag dox --out public/api/docs/v1/apispec.md"
+      end
+
+      Rake::Task['api_spec'].invoke
+    end
+
+    task html: :md do
+      `aglio -i public/api/docs/v1/apispec.md -o public/api/docs/v1/index.html`
+    end
+
+    task open: :html do
+      `open public/api/docs/v1/index.html`
+    end
+
+    task publish: :md do
+      `apiary publish --path=public/api/docs/v1/apispec.md --api-name=doxdemo`
+    end
+  end
+end
+```
+
 #### Renderers
 You can render the HTML yourself with one of the renderers:
 

data/lib/dox/entities/example.rb

@@ -15,10 +15,8 @@ module Dox
         @response = response
       end
 
-      def request_parameters
-        request.parameters
-               .except(*request.path_parameters.keys.map(&:to_s))
-               .except(*request.query_parameters.keys.map(&:to_s))
+      def request_body
+        @request_body ||= parse_request_body
       end
 
       def request_identifier
@@ -67,6 +65,12 @@ module Dox
       def request_url_query_parameters
         CGI.unescape(request.query_parameters.to_query)
       end
+
+      def parse_request_body
+        body = request.body.read
+        return body if body.blank?
+        JSON.parse(body)
+      end
     end
   end
 end

data/lib/dox/printers/example_printer.rb

@@ -14,7 +14,7 @@ module Dox
       def print_example_request
         @output.puts example_request_title
         @output.puts example_request_headers
-        return unless example.request_parameters.present?
+        return unless example.request_body.present?
 
         @output.puts example_request_body
       end
@@ -52,7 +52,7 @@ module Dox
 
     + Body
 
-#{indent_lines(12, pretty_json(example.request_parameters))}
+#{indent_lines(12, pretty_json(example.request_body))}
         HEREDOC
       end
 

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Melita Kokot
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2017-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler