grape-doc 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f00e6cadd228f64cd7fb2099ade14e6492f3089
-  data.tar.gz: 9996410f37a28e87a478bdafb9cb0ff75b65debb
+  metadata.gz: 6c9c454799bd7aea1036f9f1a05aa6a4105d9676
+  data.tar.gz: 39921c04e363881c8f85c037a322c06dfd10ce10
 SHA512:
-  metadata.gz: 488d1cf71281297eb741814477060490592ca15d58ed1b9590eae3516ca6a841f2ab4b2179a5325dea6ff25677e54ff22d1e22f43bd32223138ae2db912bb0d9
-  data.tar.gz: 21333f8855c6ffb17cae84e5d86903a7fc31f148ee4121136cee56ecd76e087015d3204d831861ba7b5e10a6a9785abbdc96624951febf58ed8731c1191f88ed
+  metadata.gz: f8c0d7e1916d2dcaeaa8940d61fbf71c449da3ba5fe57306d7b4fae1e267c64ed10e826b8331853e03e72a82c1b6f6ccd4eee7e8c69985c27e036de32b6fa870
+  data.tar.gz: e57b8ce60926e4f2eff95e8c4818332042c9a580e044b385e5cad0b6ceaa065da35618164da8f3a00c4c1c1f792bd3cbab018fa4eac8193d138ca4f88e9c5e69

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.3.0

data/grape-doc.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "loader"
   spec.add_dependency "RedCloth"
   spec.add_dependency "rack-test"
-  spec.add_dependency "rack-test-poc",">= 1.0.2"
+  spec.add_dependency "rack-test-poc",">= 1.1.0"
 
 end

data/lib/grape/doc/doc_class/parser.rb

@@ -48,6 +48,24 @@ module GrapeDoc
 
         end
 
+        def typer(obj)
+          case obj
+
+            when Array
+              obj.map(&:typer)
+
+            when Hash
+              obj.reduce({}){|m,o| m.merge!(o[0] => typer(o[1]) ) ;m}
+
+            when Class,Module
+              obj
+
+            else
+              obj.class
+
+          end
+
+        end
 
       end
     end

data/lib/grape/doc/generator.rb

@@ -1,17 +1,15 @@
+require 'json'
 module GrapeDoc
   class Generator
 
-    attr_accessor :file_path
+    attr_reader :options
     def initialize(opts={})
       
       raise(ArgumentError,'invalid options given') unless opts.class <= Hash
-      opts.merge!(
-          {
-              format: 'html'
-          }.merge(opts)
-      )
-
-      self.file_path= opts[:path] || opts['path'] || File.join(Helpers.doc_folder_path,'api_doc.html')
+      @options = {
+        'format' => 'html',
+		'path'   => File.join(Helpers.doc_folder_path,'api_doc.html')
+      }.merge(opts.reduce({}){|m,o| m.merge!(o[0].to_s => o[1]) ;m})
 
       process_head
       process_table_of_content
@@ -25,7 +23,7 @@ module GrapeDoc
 
     def save
 
-      File.write self.file_path,
+      File.write self.options['path'],
                  document.to_textile.to_html
 
       true;rescue;false
@@ -47,6 +45,8 @@ module GrapeDoc
       Helpers.each_grape_class do |rest_api_model|
         rest_api_model.routes.each do |route|
 
+          next if route.route_path =~ /\(\.:format\)\(\.:format\)$/
+
           document.add :h2, "#{route.route_method.to_s.upcase}: #{route.route_path}"
           document.add :h3, 'Request'
           document.add :h4, 'description'
@@ -81,33 +81,51 @@ module GrapeDoc
           route_path_var = route.route_path.to_s.sub(/\(\.:format\)$/,'')
           @poc_data ||= Helpers.poc_data
           if @poc_data && @poc_data.find{|k,v| k =~ /^#{route_path_var}/ }
-            if -> { @poc_data[route_path_var][route.route_method.to_s.upcase] rescue nil }.call
-              poc_opts = @poc_data[route_path_var][route.route_method.to_s.upcase]
+            route_method_var = route.route_method.to_s.upcase
 
-              document.add :h3,'Response'
-              # document.add :raw,poc_opts['response'].to_yaml
-              document.add :h4,'body'
-              document.add :raw,poc_opts['response']['raw_body']
+            poc_cases = @poc_data.select{|k,v|
+              k =~ /^#{route_path_var}\.?/ && v.keys.include?(route_method_var)
+            }
 
-              document.add :h5,'options:'
-
-              document.add :list,[
-                  "'status code: #{poc_opts['response']['status']}",
-                  "format: #{poc_opts['response']['format']}"
-              ]
+            document.add :h3,'Response'
 
+            poc_cases.each do |poc_path,poc_data|
+              poc_opts = poc_data[route_method_var] || next
 
               document.add :h4,'example'
 
               document.add :h5,'curl sample'
-
               document.add :raw,[
-                  "curl ",
-                  "-X #{route.route_method.to_s.upcase} ",
-                  "\"http://api_url#{route_path_var}?",
-                  "#{poc_opts['request']['query']['raw']}\""
+                  "$ curl ",
+                  "-X #{route_method_var} ",
+                  "\"http://#{ -> { poc_opts['response']['headers']['HTTP_HOST'] rescue 'example.org' }.call}",
+                  "#{poc_path}?","#{poc_opts['request']['query']['raw']}\" ",
+                  poc_opts['request']['headers'].map{|k,v| "-H \"#{k}: #{v}\"" }.join(' ')
               ].join
 
+              document.add :list,[
+                  "status code: #{poc_opts['response']['status']}",
+                  "format type: #{poc_opts['response']['format']}"
+              ]
+
+              document.add :h6,'raw body'
+              document.add :raw,poc_opts['response']['raw_body']
+
+              if JSON.respond_to?(:pretty_generate)
+
+                document.add :h6,'json formatted body with Class types'
+                document.add :raw,
+                             JSON.pretty_generate(
+                                 ApiDocParts::Parser.typer(poc_opts['response']['body'])
+                             )
+
+              end
+
+
+            end
+
+            if -> { @poc_data[route_path_var][route.route_method.to_s.upcase] rescue nil }.call
+              poc_opts = @poc_data[route_path_var][route.route_method.to_s.upcase]
 
 
             end

data/test/sample.html

@@ -13,4 +13,31 @@
 		<li>type: String</li>
 		<li>desc: it&#8217;s a test string</li>
 	</ul></li>
-</ul>
+</ul>
+<h3>Response</h3>
+<h4>example</h4>
+<h5>curl sample</h5>
+<pre>$ curl -X GET "http://example.org/hello?test=hy" -H "Accept-Version: v1" -H "X-Token: blabla"</pre>
+<ul>
+	<li>status code: 200</li>
+	<li>format type: json</li>
+</ul>
+<h6>raw body</h6>
+<pre>{"hello":"world!"}</pre>
+<h6>json formatted body with Class types</h6>
+<pre>{
+  "hello": "String"
+}</pre>
+<h4>example</h4>
+<h5>curl sample</h5>
+<pre>$ curl -X GET "http://example.org/hello.json?" -H "Accept-Version: v1" -H "X-Token: blabla"</pre>
+<ul>
+	<li>status code: 200</li>
+	<li>format type: json</li>
+</ul>
+<h6>raw body</h6>
+<pre>{"hello":"world!"}</pre>
+<h6>json formatted body with Class types</h6>
+<pre>{
+  "hello": "String"
+}</pre>

data/test/test_all.rb

@@ -0,0 +1,4 @@
+require_relative 'test_helper'
+require_relative 'test_sample_api'
+require_relative 'test_collector'
+require_relative 'test_generator'

data/test/test_generator.rb

@@ -0,0 +1,11 @@
+require_relative 'test_helper'
+describe 'Doc generating' do
+
+  specify 'test documentation generator' do
+
+    var = GrapeDoc.new
+    GrapeDoc.generate path: File.join(__dir__,'sample.html')
+
+  end
+
+end

data/test/test_sample_api.rb

@@ -9,6 +9,8 @@ describe 'Dummy test for rack-test-poc' do
 
   specify 'test the get call' do
 
+    header("Accept-Version","v1")
+    header("X-Token","blabla")
     get '/hello',test: 'hy'
     last_response.status.must_be :==, 200
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-doc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.0
 description: " Documentation generator for Grape module compatible with Redmine and
   Github formats "
 email:
@@ -136,9 +136,10 @@ files:
 - lib/grape/doc/helper.rb
 - lib/grape/doc/prototype.rb
 - test/sample.html
-- test/test_doc_gen.rb
+- test/test_all.rb
+- test/test_collector.rb
+- test/test_generator.rb
 - test/test_helper.rb
-- test/test_object_space_collector.rb
 - test/test_sample_api.rb
 homepage: https://github.com/adamluzsi/grape-doc
 licenses: []
@@ -165,8 +166,9 @@ specification_version: 4
 summary: Documentation generator for Grape module
 test_files:
 - test/sample.html
-- test/test_doc_gen.rb
+- test/test_all.rb
+- test/test_collector.rb
+- test/test_generator.rb
 - test/test_helper.rb
-- test/test_object_space_collector.rb
 - test/test_sample_api.rb
 has_rdoc: 

data/test/test_doc_gen.rb

@@ -1,15 +0,0 @@
-require_relative 'test_helper'
-describe 'Doc generating' do
-
-  specify 'test documentation generator' do
-
-    var = GrapeDoc.new
-    puts var.document.to_textile
-    File.write File.join(RackTestPoc.root,'test','sample.html'),
-               var.document.to_textile.to_html
-
-    GrapeDoc.generate
-
-  end
-
-end