cabbage_doc 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02e3cccfa65913a1525028740ac3965dabb841d6
-  data.tar.gz: e5bd2ff47666cd7ec72ae81dbbc64a946f2db9c0
+  metadata.gz: 91e6336597672b91cdc338a24ad44aa2856e8cfa
+  data.tar.gz: 1ccc5abce46f5a6a37dae2665c9def1fcce02130
 SHA512:
-  metadata.gz: 429e21350f3360728f512015cc0b0feb78a9fd0802e0bbac120039d7cecbf51eb803051372c6f2981ee62a1504ac8b7e5aa991ab49367679bc8f9398586bac02
-  data.tar.gz: 6ee6ebd33a9dbefa266e9d3dd46200c8f3edf3344230e70c5cedfdc497df2299dc654b870199e4783b8520e0df3747f9ce62f725628a6159d0c746b5a6eb7dbb
+  metadata.gz: 4474ce6a1de2aaecfc981d344cafe6ebe794d0d4f2dfd9ead19a9d970caeb1e4dd5f18045d2211d0d40b8f5c0e89eaedb06ba978bd5453c13fb54f4ca3b8a86a
+  data.tar.gz: 55d173af4aed9f1cef47583c9b63def698741f3b173b28fd99fb6ba21f1b57fb98603da7e23b1aa7f0fc99c2c7f32c6e1c21eada54673ead26d831462eb4b013

data/lib/cabbage_doc.rb

@@ -1,6 +1,6 @@
 module CabbageDoc
   MARKER = ':cabbagedoc:'.freeze
-  VISIBILITY = %i(public private internal).freeze
+  VISIBILITY = %i(public private internal beta).freeze
   VISIBILITY_REGEXP = VISIBILITY.map(&:to_s).map(&:capitalize).join('|').freeze
 
   autoload :Path,           'cabbage_doc/path'

data/lib/cabbage_doc/authentication.rb

@@ -54,10 +54,8 @@ module CabbageDoc
       case type
       when :basic
         username && password
-      when :token
-        !token.nil?
       else
-        false
+        !token.nil?
       end
     end
 

data/lib/cabbage_doc/configuration.rb

@@ -2,6 +2,34 @@ module CabbageDoc
   class Configuration
     include Singleton
 
+    class << self
+      def format_example(example, action, auth)
+        cmd = ["$", "curl"]
+
+        if auth.type == :basic
+          cmd << "-u \"user:pass\""
+        elsif auth.token
+          cmd << "-H \"Authorization: #{auth.type.to_s.capitalize} token\""
+        end
+
+        if action.method == "GET"
+          path = [action.path, example.to_query].join("?")
+        else
+          cmd << "-X #{action.method}"
+
+          example.params.each do |k, v|
+            cmd << "-d \"#{k}=#{v}\""
+          end
+
+          path = action.path
+        end
+
+        cmd << "\"#{[auth.uri, path].join}\""
+
+        cmd.join(' ')
+      end
+    end
+
     DEFAULTS = {
       path: 'api/v1',
       title: 'Cabbage Doc',
@@ -11,13 +39,15 @@ module CabbageDoc
       visibility: [VISIBILITY.first],
       cache: Cache.new,
       request: proc { |request| request.perform },
-      theme: 'github'
+      theme: 'github',
+      examples: false,
+      format_example: method(:format_example)
     }.freeze
 
-    OPTIONAL_ATTRIBUTES = %i(welcome path scheme title verbose authentication dev request cache theme visibility).freeze
+    OPTIONAL_ATTRIBUTES = %i(welcome path scheme title verbose authentication dev request cache theme visibility examples format_example).freeze
     REQUIRED_ATTRIBUTES = %i(domain controllers root).freeze
     ATTRIBUTES          = (OPTIONAL_ATTRIBUTES + REQUIRED_ATTRIBUTES).freeze
-    CALLABLE_ATTRIBUTES = %i(controllers authentication request).freeze
+    CALLABLE_ATTRIBUTES = %i(controllers authentication request format_example).freeze
 
     attr_accessor *ATTRIBUTES 
 

data/lib/cabbage_doc/example.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module CabbageDoc
   class Example
     include Parser
@@ -18,6 +20,10 @@ module CabbageDoc
       valid?
     end
 
+    def to_query
+      params.map { |k, v| "#{k}=#{CGI.escape(v)}" }.join("&")
+    end
+
     def valid?
       !@label.nil?
     end

data/lib/cabbage_doc/version.rb

@@ -1,3 +1,3 @@
 module CabbageDoc
-  VERSION = "0.0.6".freeze
+  VERSION = "0.0.7".freeze
 end

data/lib/cabbage_doc/web.rb

@@ -5,6 +5,8 @@ require 'json'
 require 'cgi'
 
 module CabbageDoc
+  module Helpers; end
+
   class Web < Sinatra::Base
     ROOT = File.expand_path("../../../web", __FILE__).freeze
 
@@ -21,6 +23,15 @@ module CabbageDoc
 
     helpers WebHelper
 
+    Dir.glob("#{root}/**/*.rb").sort.each do |helper|
+      require helper
+    end
+
+    CabbageDoc::Helpers.constants.each do |c|
+      mod = CabbageDoc::Helpers.const_get(c)
+      helpers mod if mod.is_a?(Module)
+    end
+
     get '/' do
       haml :index
     end

data/web/helpers/helper.rb

@@ -0,0 +1,7 @@
+module CabbageDoc
+  module Helpers
+    module Helper
+      # nop
+    end
+  end
+end

data/web/public/css/application.css

@@ -205,5 +205,13 @@ a:hover
 
 .action .description
 {
-  margin-bottom: 20px;
+  margin-bottom: 10px;
+}
+
+.warning
+{
+  border: 2px solid #FFC40F;
+  background-color: #FFF8E1;
+  padding: 10px;
+  margin-bottom: 10px;
 }

data/web/views/action.haml

@@ -8,9 +8,15 @@
   .clear
   %form.hidden{ action: action.path, method: action.method }
     - if action.description
-      .description= action.description
+      .description= markdown.render(action.description)
+    - if action.visibility == :beta
+      .warning= 'This API is still under development and will continue to evolve.'
+    - if config.examples && action.examples.any?
+      .examples
+        - action.examples.each do |example|
+          = haml :example, locals: { action: action, example: example }
     - if action.parameters.any?
-      %table
+      %table.parameters
         %tr
           %th='Parameter'
           %th='Value'

data/web/views/example.haml

@@ -0,0 +1,5 @@
+.example
+  .label="#{example.label}:"
+  %pre
+    %code.bash
+      = config.format_example.call(example, action, auth)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cabbage_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Mihail Szabolcs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -153,6 +153,7 @@ files:
 - lib/cabbage_doc/web.rb
 - lib/cabbage_doc/web_helper.rb
 - lib/cabbage_doc/worker.rb
+- web/helpers/helper.rb
 - web/public/css/application.css
 - web/public/css/highlight/agate.css
 - web/public/css/highlight/androidstudio.css
@@ -198,6 +199,7 @@ files:
 - web/views/controller.haml
 - web/views/documentation.haml
 - web/views/enumeration.haml
+- web/views/example.haml
 - web/views/index.haml
 - web/views/layout.haml
 - web/views/parameter.haml