apiculture 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22ff31bb7b740ba2994dadcf1e76b10c5e47d5e4
-  data.tar.gz: 7a0f4a80554d338542dd0eb9c1ecd39820218066
+  metadata.gz: 0bf044e0978c4650b72aa2b337fe9cb000ecd546
+  data.tar.gz: 010b7cfb597e96aba2554b32e00b9fd3773e5169
 SHA512:
-  metadata.gz: af3e86d8c2b3c1f8a6f42b03f96d4ff904afe5c7874a28d84ecdc41bec3bb0dea2984fa173ac111ba1e32343e7cebc6826af46dca93e17c61e2d94ba307168a3
-  data.tar.gz: 21674f0cd0a3b0ca724724920184210661b7de00f40d834daf74d95c66371938c7408d56401580ded47955d9ba9e240ee95a4778963a5b3c128d7e9cd0eff819
+  metadata.gz: 3b2db79c161620c9f1d8cd22cfb252d7e0ac6013c42de0e87368c819334df7c5b9f8b6a666e0ea380e847d8d0c52dca98afdf94db97e25b3670880f5dc0eff7d
+  data.tar.gz: 2b89340ef4473feb21e7c5c49018f5b0bb68748dd8b0d536c5bc0090253bc1d1952db3900839dc40e412a19ba02051cd8889c4a5b0d5afa3fc03a86eeec5816e

data/gemfiles/Gemfile.rack-1.x

@@ -12,6 +12,6 @@ group :development do
   gem "rspec", "~> 3.1", '< 3.2'
   gem "rdoc", "~> 6.0"
   gem "rake", "~> 10"
-  gem "bundler", "~> 1.0"
   gem "simplecov", ">= 0"
+  gem "bundler"
 end

data/gemfiles/Gemfile.rack-2.x

@@ -12,6 +12,6 @@ group :development do
   gem "rspec", "~> 3.1", '< 3.2'
   gem "rdoc", "~> 6.0"
   gem "rake", "~> 10"
-  gem "bundler", "~> 1.0"
   gem "simplecov", ">= 0"
+  gem "bundler"
 end

data/lib/apiculture/method_documentation.rb

@@ -1,4 +1,6 @@
 require 'builder'
+require 'rdiscount'
+
 # Generates Markdown/HTML documentation about a single API action.
 #
 # Formats route parameters and request/QS parameters as a neat HTML
@@ -26,12 +28,15 @@ class Apiculture::MethodDocumentation
 
   # Compose an HTML string by converting the result of +to_markdown+
   def to_html_fragment
-    require 'rdiscount'
-    RDiscount.new(to_markdown).to_html
+    markdown_string_to_html(to_markdown)
   end
 
   private
 
+  def markdown_string_to_html(str)
+    RDiscount.new(str.to_s).to_html
+  end
+
   class StringBuf #:nodoc:
     def initialize; @blocks = []; end
     def <<(block); @blocks << block.to_s; self; end
@@ -59,7 +64,7 @@ class Apiculture::MethodDocumentation
       @definition.route_parameters.each do | param |
         html.tr do
           html.td { html.tt(':%s' % param.name) }
-          html.td(param.description)
+          html.td { html << markdown_string_to_html(param.description) }
         end
       end
     end
@@ -98,7 +103,7 @@ class Apiculture::MethodDocumentation
       @definition.responses.each do | resp |
         html.tr do
           html.td { html.b(resp.http_status_code) }
-          html.td resp.description
+          html.td { html << markdown_string_to_html(resp.description) }
           html.td { html.pre { html.code(body_example(resp)) }}
         end
       end
@@ -139,7 +144,7 @@ class Apiculture::MethodDocumentation
           html.td { html.tt(param.name.to_s) }
           html.td(param.required ? 'Yes' : 'No')
           html.td(param.matchable.inspect)
-          html.td(param.description.to_s)
+          html.td { html << markdown_string_to_html(param.description) }
         end
       end
     end

data/lib/apiculture/version.rb

@@ -1,3 +1,3 @@
 module Apiculture
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/apiculture/app_documentation_spec.rb

@@ -10,9 +10,16 @@ describe "Apiculture.api_documentation" do
       documentation_build_time!
       
       desc 'Order a pancake'
-      required_param :diameter, "Diameter of the pancake", Integer
+      required_param :diameter, "Diameter of the pancake. The pancake will be **bold**", Integer
       param :topping, 'Type of topping', String
-      responds_with 200, 'When the pancake is created succesfully', {id: 'abdef..c21'}
+      pancake_response_info = <<~EOS
+        When the pancake has been baked succesfully
+        The pancake will have the following properties:
+        
+        * It is going to be round
+        * It is going to be delicious
+        EOS
+      responds_with 200, pancake_response_info, {id: 'abdef..c21'}
       api_method :post, '/pancakes' do
       end
       
@@ -58,7 +65,7 @@ describe "Apiculture.api_documentation" do
    
     expect(generated_html).to include('<body')
     expect(generated_html).to include('Pancake ID to check status on')
-    expect(generated_html).to include('When the pancake is created succesfully')
+    expect(generated_html).to include('When the pancake has been baked succesfully')
     expect(generated_html).to include('"id": "abdef..c21"')
   end
   

data/spec/apiculture/method_documentation_spec.rb

@@ -7,7 +7,7 @@ describe Apiculture::MethodDocumentation do
     
     definition.description = "This action bakes pancakes"
     definition.parameters << Apiculture::Parameter.new(:name, 'Pancake name', true, String, :to_s)
-    definition.parameters << Apiculture::Parameter.new(:thickness, 'Pancake thickness', false, Float, :to_f)
+    definition.parameters << Apiculture::Parameter.new(:thickness, 'Pancake **thick**ness', false, Float, :to_f)
     definition.parameters << Apiculture::Parameter.new(:diameter, 'Pancake diameter', false, Integer, :to_i)
     
     definition.route_parameters << Apiculture::RouteParameter.new(:pan_id, 'ID of the pancake frying pan')
@@ -28,9 +28,9 @@ describe Apiculture::MethodDocumentation do
     expect(generated_html).to include('<h3>URL parameters</h3>')
     expect(generated_html).to include('ID of the pancake frying pan')
     expect(generated_html).to include('<h3>Request parameters</h3>')
-    expect(generated_html).to include('<td>Pancake name</td>')
-    expect(generated_html).to include('<td>Pancake has been baked</td>')
-    expect(generated_html).to include('<td>Frying pan too cold</td>')
+    expect(generated_html).to include('<p>Pancake name</p>')
+    expect(generated_html).to include('<p>Pancake has been baked</p>')
+    expect(generated_html).to include('<p>Frying pan too cold</p>')
   end
   
   it 'generates HTML from an ActionDefinition without route params' do
@@ -38,7 +38,7 @@ describe Apiculture::MethodDocumentation do
     
     definition.description = "This action bakes pancakes"
     definition.parameters << Apiculture::Parameter.new(:name, 'Pancake name', true, String, :to_s)
-    definition.parameters << Apiculture::Parameter.new(:thickness, 'Pancake thickness', false, Float, :to_f)
+    definition.parameters << Apiculture::Parameter.new(:thickness, 'Pancake **thick**ness', false, Float, :to_f)
     definition.parameters << Apiculture::Parameter.new(:diameter, 'Pancake diameter', false, Integer, :to_i)
     
     definition.http_verb = 'get'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiculture
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustermann