documentary 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f25bb931fb9ce91753bde54f114a19362fbe8c46
-  data.tar.gz: 50e7f9a59d248706bb4d6267da0d76d06f3d0931
+  metadata.gz: cd84bd9760c92a88f2a23058eef1a64956485505
+  data.tar.gz: d26fb09cef9bb1407466551d81a18a06f37029d4
 SHA512:
-  metadata.gz: 82a11e37442205e9b68dd19c769768b499ba4f5248ef613a0eb1ad56d06463609d5d5e7b3a459a0292ab66475292cf79b52c4aa4b5dc9ffd35ee1068cb6cbb93
-  data.tar.gz: 799ad9bdff0459e89d134597cdb60f553be337a6c5544581c0a11c2cd8bce704b57cb8332ea1231dcea4c41d1251cf400a34222caea8ba579889b9fc906c8693
+  metadata.gz: a7df9aeb71f78599ababe886fccf93dee670295419949cf8e382d2d41f53be7eca3c43449214a4c3043daee4bc2f8c3d74475d6b779297f0667808c5f2f06349
+  data.tar.gz: 9b23ee2f9dd9d27354207c6526bf799c2446237ecbd47393b55d1529fbdd01569a94cc38db47d5b9e87947ae8724b582ddaf74909a2f5e8a14cfd6ccb2839504

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    documentary (0.1.2)
+    documentary (0.2.0)
       activesupport
+      builder
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +14,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    builder (3.2.2)
     byebug (9.0.5)
     i18n (0.7.0)
     json (1.8.3)

data/README.md

@@ -123,7 +123,19 @@ Of course not all enpoints are this simple, for `GET` requests especially you ma
 #     notes: >
 #       The filter for a specific user to find for example: `filter=Testy`
 # example_request: >
-#   /users?filter=Testy&page=1&count=3
+#   query:
+#     - filter: Testy
+#     - page: 1
+#     - count: 3
+#   body:
+#     - content_type: json
+#       payload:
+#         some:
+#           body: attributes
+#     - content_type: xml
+#       payload:
+#         some:
+#           body: attributes
 # example_response:
 #   page: 1
 #   total_pages: 1
@@ -158,6 +170,8 @@ There is a common practice on create and update (`POST` and `PUT`/`PATCH`) to re
 #     notes: >
 #       The email of the user
 # example_request: >
-#   /users?name=Testy%20McTesterson&email=test%40email.com
+#   query:
+#     - name: Testy McTesterson
+#     - email: test@email.com
 # --- end
 ```

data/circle.yml

@@ -0,0 +1,8 @@
+---
+machine:
+  ruby:
+    version: 2.2.4p230
+test:
+  post:
+    - bundle exec rake
+

data/documentary.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.license       = 'MIT'
 
   s.add_dependency 'activesupport'
+  s.add_dependency 'builder'
   s.add_development_dependency 'minitest', '~> 5.4.3'
   s.add_development_dependency 'rake', '~> 10.3.2'
 end

data/lib/documentary/version.rb

@@ -1,3 +1,3 @@
 module Documentary
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/documentary/view/helpers.rb

@@ -78,9 +78,20 @@ module Documentary
           io.puts new_line
           io.puts '#### Example Request'
           io.puts new_line
-          io.puts start_code_block
-          io.puts "#{endpoint.verb} #{endpoint.example_request.strip}"
-          io.puts end_code_block
+          example_request = YAML.load(endpoint.example_request)
+          if example_request['query']
+            io.puts start_code_block
+            io.puts "#{endpoint.verb} #{endpoint.endpoint}" << '?' << query_params(example_request['query'])
+            io.puts end_code_block
+          end
+          if example_request['body']
+            io.puts start_code_block
+            example_request['body'].each do |b|
+              io.puts request_payload(b)
+              io.puts new_line
+            end
+            io.puts start_code_block
+          end
         end
         if endpoint.example_response
           io.puts new_line
@@ -104,6 +115,20 @@ module Documentary
         "[#{title}](##{title.downcase.gsub(' ', '-')})"
       end
 
+      def query_params(params)
+        p = params.map {|p| "#{p.keys.first}=#{p[p.keys.first]}"}.join('&')
+        URI.escape(p)
+      end
+
+      def request_payload(payload)
+        case payload['content_type']
+        when 'json'
+          JSON.pretty_generate(payload['payload'])
+        when 'xml'
+          payload['payload'].to_xml
+        end
+      end
+
       def resource_attributes(resource, io)
         io.puts '#### Attributes'
         io.puts new_line

data/lib/documentary.rb

@@ -12,6 +12,7 @@ module Documentary
     require 'erb'
     require 'json'
     require 'active_support/inflector'
+    require 'active_support/core_ext/hash'
 
     include View
 

data/test/fixtures/kitchen_sink.txt

@@ -48,7 +48,19 @@
 #     notes: >
 #       The filter for a specific user to find for example: `filter=Testy`
 # example_request: >
-#   /some/path?filter=Testy&page=1&count=3
+#   query:
+#     - filter: Testy
+#     - page: 1
+#     - count: 3
+#   body:
+#     - content_type: json
+#       payload:
+#         some:
+#           body: attributes
+#     - content_type: xml
+#       payload:
+#         some:
+#           body: attributes
 # example_response:
 #   page: 1
 #   total_pages: 1

data/test/integration_test.rb

@@ -69,10 +69,15 @@ class Documentary::IntegrationTest < MiniTest::Test
     assert_includes generated_docs, 'filter | false | The filter for a specific user to find for example: `filter=Testy`'
   end
 
-  test 'enpoint example request is generated' do
+  test 'enpoint example request with query params is generated' do
     assert_includes generated_docs, "```\nGET /some/path?filter=Testy&page=1&count=3\n```"
   end
 
+  test 'enpoint example request with a JSON body is generated' do
+    assert_includes generated_docs, "{\n  \"some\": {\n    \"body\": \"attributes\"\n  }\n}\n"
+    assert_includes generated_docs, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <some>\n    <body>attributes</body>\n  </some>\n</hash>\n"
+  end
+
   test 'enpoint example response is generated' do
     assert_includes generated_docs, "#### Example Response\n\n```\n"
     assert_includes generated_docs, "\"page\": 1,\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentary
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dave Kennedy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  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: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,7 @@ files:
 - README.md
 - Rakefile
 - bin/documentary
+- circle.yml
 - documentary.gemspec
 - lib/default_layout.erb
 - lib/documentary.rb