sinatra-docdsl 0.8.3 → 0.8.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
 SHA1:
-  metadata.gz: !binary |-
-    MzkxOTc5MTA5MjQ3MjA3ZDU2YjYxNzU3MTcwZTMxOGVjZWE3NGM0ZQ==
-  data.tar.gz: !binary |-
-    OGIzYTJiNDE4ZmRiYTMxNDgxYmMxNDJmMWUzOGVhZGRkOTk0NjBmOQ==
+  metadata.gz: 50ed51e11b947de2d96212b08c9a577f5d182525
+  data.tar.gz: f48deba4353e341b1adf8f38aecf8ffb6db81180
 SHA512:
-  metadata.gz: !binary |-
-    YmFjNTk3MWE3MWRiZWY3ZTU1ODUyNDMyYTUwNjIwMDA2MzJjNmFlZGNjN2Ji
-    NzA2ODc1ZWJmY2EyZDI3Yjg0ZWQ0MWZkYTdhNzYwMjliZDY4NWQzZjIyOWFk
-    OWUzOGM4MjdkMjE0NjQ0ODA2NGY4YTU0YTE1ODhhZjk3ZGU1OWY=
-  data.tar.gz: !binary |-
-    NGZmYjc0NTJlZDEyNjJiNzQxYjlmZmMyY2M3MDlmNjI4ZTljMTdlYmRiZTIz
-    NGJhZWEyOWM4MGVjNzFiNjgyMWIzZTIyMTM3OWM0Mzc1ZmJjNDA4NGUxZmZk
-    MmVkNDJiM2U1NWNhMThkNWZjNGM5ODI4ODk1MzEzMDhmMjI0Zjg=
+  metadata.gz: ff01d25759bd3d99288f1e6a5b1f44d6b81465b5eeeba6f3f42f8bf40d2f3681d541a91553d61bbdbb215b2a14cbb33c4d97ebf60a842f0970ebaa33ee8e1d8b
+  data.tar.gz: ef6cf62bfa46d797e64a6c92f90445e1e6b6ae0eddd086a625c1e6b4a0987453c9d9bb748e1292a1986810c23701841cda0c02a14b4838732852b2dadd6e3a81

data/lib/docdsl.rb

@@ -5,7 +5,7 @@ module Sinatra
   module DocDsl
     class PageDoc
       attr_accessor :the_title,:the_header,:the_footer,:the_introduction,:entries,:the_url_prefix
-      
+
       def initialize(&block)
         @the_title='DocDSL Documentation'
         @the_header="API"
@@ -24,35 +24,35 @@ module Sinatra
           end
         end
       end
-      
+
       def title(t)
         @the_title=t
       end
-      
+
       def header(h)
         @the_header=h
       end
-      
+
       def footer(f)
         @the_footer=f
       end
-      
+
       def introduction(i)
         @the_introduction=i
       end
-      
+
       def configure_renderer(&block)
         @render_function=block
-      end      
-      
+      end
+
       def render
         @render_function.call
       end
-      
+
       def url_prefix(prefix)
         @the_url_prefix=prefix
       end
-      
+
       def json
         entries=[]
         @entries.each do |entry|
@@ -62,11 +62,11 @@ module Sinatra
           :title=> @the_title,:header=>@the_header,:footer=>@the_footer,:introduction=>@the_introduction,
           :endPoints=>entries
         }
-      
+
         [200,{'content-type' => 'application/json;charset=UTF8'},object.to_json]
       end
-      
-      def definition_list(title, definitions) 
+
+      def definition_list(title, definitions)
         if definitions.length > 0
           definitions.inject("### #{title}\n\n") do | dl, (k,v) |
             dl << "
@@ -78,7 +78,7 @@ module Sinatra
           ''
         end
       end
-      
+
       def render_md
         begin
           html=Kramdown::Document.new(to_markdown).to_html
@@ -104,15 +104,15 @@ HTML
           [500,"oops, #{e.to_s}\n#{e.backtrace}"]
         end
       end
-      
+
       def md
         [200,{'content-type' => 'text/plain;charset=UTF8'},to_markdown]
       end
-      
+
       def to_markdown
         markdown="
 #{@the_header}
-        
+
 # #{@the_title}
 
 #{@the_introduction}
@@ -123,36 +123,36 @@ HTML
           params = definition_list("Url Parameters", entry.params)
           query_params = definition_list("Query Parameters", entry.query_params)
           header_params = definition_list("Header Parameters", entry.headers)
-                
+
           if entry.the_payload
             payload="
 ### Request body
 
-#{entry.the_payload} 
-           
+#{entry.the_payload}
+
 "
             if(entry.sample_request)
               payload << "
 ~~~ javascript
-#{JSON.pretty_generate(entry.sample_request)}
+#{::JSON.pretty_generate(entry.sample_request)}
 ~~~
 
 "
             end
           end
           payload ||=''
-          
-          
-          if entry.the_response            
+
+
+          if entry.the_response
             response="
 ### Response
 #{entry.the_response}
 
-"          
+"
             if(entry.sample_response)
               response << "
 ~~~ javascript
-#{JSON.pretty_generate(entry.sample_response)}
+#{::JSON.pretty_generate(entry.sample_response)}
 ~~~
 
 "
@@ -180,13 +180,13 @@ HTML
 #{status_codes}
 "
         end
-        
+
         markdown << "
 #{@the_footer}
 "
         markdown
       end
-      
+
       def html
         begin
           body= <<-HTML
@@ -203,7 +203,7 @@ HTML
                 <div id="container">
                   <h1 id="title">#{@the_header}</h1>
                   <p>#{@the_introduction}</p>
-              
+
                   #{render_html_entries}
                   <br/>
                   <hr>
@@ -215,10 +215,10 @@ HTML
           [200,{'content-type' => 'text/html;charset=UTF8'},body]
         rescue => e
           [500,"oops, #{e.to_s}\n#{e.backtrace}"]
-        end        
-      end 
-    
-      def render_html_entries 
+        end
+      end
+
+      def render_html_entries
         @entries.inject('') { | markup, entry|
           path = entry.paths.join(', ')
           if entry.params.length >0
@@ -228,16 +228,16 @@ HTML
             params << "</dl>\n"
           end
           params ||= ''
-        
+
           if entry.query_params.length >0
             query_params = entry.query_params.inject("<h3>Query Parameters</h3>\n<dl>") { |li,(k,v)|
               li << "<dt>:%s</dt><dd>%s</dd>" % [k,v]
             }
             query_params << "</dl>\n"
-          end 
+          end
           query_params ||=''
-        
-        
+
+
           if entry.headers.length >0
             headers = entry.headers.inject("<h3>Header Parameters</h3>\n<dl>") { |li,(k,v)|
               li << "<dt>%s</dt><dd>%s</dd>" % [k,v]
@@ -245,11 +245,11 @@ HTML
             headers << "</dl>\n"
           end
           headers ||= ''
-        
+
           if entry.the_payload
             payload="<dt>Payload</dt><dd>#{entry.the_payload}\n"
             if(entry.sample_request)
-              payload << "<pre>#{JSON.pretty_generate(entry.sample_request)}</pre>"
+              payload << "<pre>#{::JSON.pretty_generate(entry.sample_request)}</pre>"
             end
             payload << "</dd>"
           end
@@ -263,10 +263,10 @@ HTML
               end
               status_codes << "</dl>\n"
             end
-            
-            response="<dt>Response</dt><dd>#{entry.the_response}\n#{statuscodes}\n"          
+
+            response="<dt>Response</dt><dd>#{entry.the_response}\n#{statuscodes}\n"
             if(entry.sample_response)
-              response << "<pre>#{JSON.pretty_generate(entry.sample_response)}</pre>"
+              response << "<pre>#{::JSON.pretty_generate(entry.sample_response)}</pre>"
             end
             response << "</dd>"
           end
@@ -276,19 +276,19 @@ HTML
         } << ""
       end
     end
-    
+
     class DocEntry
       attr_accessor :desc,:params,:paths,:query_params,:headers,:the_payload,:the_response,:sample_request,:sample_response,:status_codes
-      
+
       def initialize(description, &block)
         @paths=[]
         @desc=description
         @params={}
         @query_params={}
-        @headers={} 
+        @headers={}
         @the_payload=nil
         @sample_request=nil
-        @the_response=nil 
+        @the_response=nil
         @sample_response=nil
         @status_codes={}
         if(block)
@@ -299,41 +299,41 @@ HTML
           end
         end
       end
-            
+
       def <<(path)
         self.paths << path
       end
-      
+
       def to_s
         self.inspect
       end
-      
+
       def describe(desc)
         @desc=desc
       end
-      
+
       def payload(desc, example=nil)
         @the_payload=desc
         @sample_request=example
       end
-      
+
       def response(desc,example=nil)
-        @the_response=desc 
-        @sample_response=example     
+        @the_response=desc
+        @sample_response=example
       end
-      
+
       def param(name,desc)
-        @params[name]=desc      
+        @params[name]=desc
       end
-      
+
       def header(name,desc)
-        @headers[name]=desc      
+        @headers[name]=desc
       end
-      
+
       def query_param(name,desc)
-        @query_params[name]=desc      
+        @query_params[name]=desc
       end
-      
+
       def status(code,meaning=nil)
         official_meaning=status_codes_map[code]
         if meaning
@@ -342,7 +342,7 @@ HTML
           @status_codes[code]=official_meaning
         end
       end
-      
+
       def status_codes_map
         {
           100=> 'Continue',
@@ -385,44 +385,44 @@ HTML
           503=> 'Temporarily Unavailable'
         }
       end
-      
+
       def json
         {
-            :description=>@desc, 
-            :url_parameters=>@params, 
-            :paths=>@paths, 
-            :query_parameters=>@query_params, 
-            :headers=>@headers, 
-            :payload=>@the_payload, 
+            :description=>@desc,
+            :url_parameters=>@params,
+            :paths=>@paths,
+            :query_parameters=>@query_params,
+            :headers=>@headers,
+            :payload=>@the_payload,
             :sample_request=>@sample_request,
             :response=>@the_response,
             :status_codes=>@status_codes,
             :sample_response=>@sample_response
         }
       end
-    end  
-        
-    def doc_endpoint(path) 
+    end
+
+    def doc_endpoint(path)
       page_doc=@page_doc
-      get path do     
+      get path do
         begin
           page_doc.render
         rescue Exception=>e
           [500,"#{e.message} #{e.backtrace.inspect}"]
         end
-      end      
+      end
     end
-                  
+
     def page(&block)
       @page_doc ||= PageDoc.new(&block)
     end
-    
+
     def documentation(description,&block)
       @page_doc ||= PageDoc.new
       @last_doc=DocEntry.new(description,&block)
       (@page_doc.entries ||= []) << @last_doc
     end
-    
+
     def method_added(method)
       # gets called everytime a method is added to the app.
       # only triggers if the previous method was a documentation ... call

metadata

@@ -1,25 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-docdsl
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Jilles van Gurp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   prerelease: false
@@ -41,17 +41,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key:
 specification_version: 4
 summary: Documentation DSL for Sinatra