kanpachi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e70d69f07c62ef21800d0be7c54619c19e3fdad
-  data.tar.gz: ff42d674ead45d9b803056b26f9abcacc412fc05
+  metadata.gz: 6b32fca8beebd8f5825ae812e10da8afcc954e1e
+  data.tar.gz: e9b1afcb5063c31d7a34a00df982df90b2018444
 SHA512:
-  metadata.gz: 7de088c8bd7856c838b41d9c5918b3a153152779500f3bbb94c4d94ad667e7bf322ca5fe391e763696a80d46d7e18196a78ebbc3d7b609384308e18b04a29629
-  data.tar.gz: 01289cc3cdc94e99c2a2fc1c082420c78ba031ec0413634f5c25744120450bcbdac5f3b2d7146cd0351d65ba1209c0408c90783f43f02b29b8fb42df9755ec7d
+  metadata.gz: 13b00d7801dcaa54c0a1ecb266cbfce68ee90f453b72c4d4fc502eb65ad4e701436906ea1e5e8dd773c14095798732484b749968aaef02b7c333d9b8052c902b
+  data.tar.gz: c522f30028ccaf62e7161b622090fb318d3df0ae86a9ae6a2c0623f44ab8558722b1e00dbca5466a7263c512f37910f2bba3b0825911f91edb4fff63499315a9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Kanpachi Changelog
 
+## 0.0.2
+
+* Add error codes and responses documentation page.
+* Add ability to customize the middleman config for your project.
+* Replace invalid url resource paths for documentation links.
+* Fix naviation link paths.
+* Remove About and Contact sections from the generated documentation navigation.
+
 ## 0.0.1
 
 * First version.

data/README.md

@@ -11,7 +11,9 @@ their [wiki](https://github.com/cypriss/mutations/wiki/Filtering-Input) to find
 Response representations are defined as [Roar](https://github.com/apotonick/roar) representers. You can check out the
 [representable docs](https://github.com/apotonick/representable) to figure out how to customize your responses.
 
-To check out an example API project, checkout [kanpachi-example](https://github.com/kamui/kanpachi-example).
+To demo an example API project, checkout [kanpachi-example](https://github.com/kamui/kanpachi-example). If you want to see what the html documentation looks like it's available at <http://kamui.github.io/kanpachi-example>.
+
+This project was inspired by [@mattetti](https://github.com/mattetti/)'s [Weasel-Diesel](https://github.com/mattetti/Weasel-Diesel) project, of which I am also a contributor. I created Kanpachi as a way of experimenting and leaning how to create a DSL in ruby.
 
 ## Example
 
@@ -51,7 +53,7 @@ This method can only return up to 800 tweets.
 
 See [__Working with Timelines__](https://dev.twitter.com/docs/working-with-timelines) for instructions on traversing timelines.
 TEXT
-      versions '1.1', 1.0
+      versions '1.1'
       ssl true
       formats :json
 

data/lib/kanpachi/documentation/config.rb

@@ -39,7 +39,7 @@ set :api, Kanpachi::APIList.all.first
 #  :which_fake_page => "Rendering a fake page with a local variable" }
 
 api.resources.all.each do |resource|
-  proxy "/#{resource.http_verb}#{resource.url}", "/resource.html", locals: { resource: resource }, ignore: true
+  proxy "/#{resource.http_verb}#{resource.url.gsub(/[.:]/, '_')}/index.html", 'resource.html', locals: { resource: resource }, ignore: true
 end
 
 ###
@@ -49,8 +49,8 @@ end
 # Automatic image dimensions on image_tag helper
 # activate :automatic_image_sizes
 
-# Reload the browser automatically whenever files change
-activate :livereload
+# Pretty URLs
+activate :directory_indexes
 
 # Methods defined in the helpers block are available in templates
 # helpers do
@@ -65,20 +65,31 @@ set :js_dir, 'javascripts'
 
 set :images_dir, 'images'
 
-# Build-specific configuration
-configure :build do
-  # For example, change the Compass output style for deployment
-  # activate :minify_css
+project_config_file = File.join(Dir.pwd, 'documentation', 'config.rb')
+if File.exist?(project_config_file)
+  self.instance_eval File.read(project_config_file)
+  puts 'Loaded documentation/config.rb'
+else
+  puts 'No documentation/config.rb file found'
 
-  # Minify Javascript on build
-  # activate :minify_javascript
+  # Reload the browser automatically whenever files change
+  activate :livereload
 
-  # Enable cache buster
-  # activate :asset_hash
+  # Build-specific configuration
+  configure :build do
+    # For example, change the Compass output style for deployment
+    activate :minify_css
 
-  # Use relative URLs
-  # activate :relative_assets
+    # Minify Javascript on build
+    activate :minify_javascript
 
-  # Or use a different image path
-  # set :http_prefix, "/Content/images/"
-end
+    # Enable cache buster
+    activate :asset_hash
+
+    # Use relative URLs
+    # activate :relative_assets
+
+    # Or use a different image path
+    # set :http_prefix, "/Content/images/"
+  end
+end

data/lib/kanpachi/documentation/source/errors/index.html.slim

@@ -0,0 +1,39 @@
+.container
+  .row
+    .content.col-md-12
+      h1 Error Codes & Responses
+      - api.errors.all.each do |error|
+        h2= Inflecto.humanize(error.name)
+        p= Kanpachi::Markdown.to_html(error.description)
+        .table-responsive
+          table.table.table-hover
+            thead
+              tr colspan="2"
+                strong Response (#{Inflecto.humanize(error.response.name)})
+              tr colspan="2"
+                Status: #{error.response.status}
+                br
+
+            tbody
+              - error.response.representation.properties.each do |k, v|
+                tr
+                  td
+                    strong= k.to_s.downcase
+                    br
+                    - if v[:hash]
+                      span object
+                    - elsif v[:collection]
+                      span array
+                    - else
+                      span= v[:type].to_s.downcase
+                  td
+                    p= Kanpachi::Markdown.to_html(v[:doc]) if v[:doc]
+                    - if v[:example]
+                      strong
+                        | Example:
+                      |  #{v[:example]}
+
+              tr
+                td colspan="2"
+                  strong Example
+                  pre= JSON.pretty_generate(error.response.representation.example)

data/lib/kanpachi/documentation/source/index.html.slim

@@ -20,6 +20,6 @@
                 - resource = api.resources.find(*route)
                 tr
                   td
-                    a href="#{resource.http_verb}#{resource.url}" #{resource.route}
+                    = link_to resource.route, "#{resource.http_verb}#{resource.url.gsub(/[.:]/, '_')}"
                   td= Kanpachi::Markdown.to_html(resource.description)
       hr

data/lib/kanpachi/documentation/source/layouts/layout.slim

@@ -8,13 +8,13 @@ html
     link href="/favicon.png" rel="shortcut icon"
     title= "#{api.title} - #{api.name}"
     /! Bootstrap core CSS
-    link href="/stylesheets/bootstrap.css" rel="stylesheet"
+    = stylesheet_link_tag "bootstrap.css"
     /! Custom styles for this template
-    link href="/stylesheets/jumbotron.css" rel="stylesheet"
+    = stylesheet_link_tag "jumbotron.css"
     /! HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries
-    /![if lt IE 9]
-      script src="/javascripts/html5shiv.js"
-      script src="/javascripts/respond.min.js"
+    /[if lt IE 9]
+      = javascript_include_tag "html5shiv.js"
+      = javascript_include_tag "respond.min.js"
   body
     .navbar.navbar-inverse.navbar-fixed-top
       .container
@@ -27,7 +27,7 @@ html
         .navbar-collapse.collapse
           ul.nav.navbar-nav
             li.active
-              a href="/" Home
+              = link_to 'Home', '/index.html'
             li.dropdown
               a.dropdown-toggle data-toggle="dropdown" href="#"
                 | Sections
@@ -35,11 +35,14 @@ html
               ul.dropdown-menu
                 - api.sections.to_hash.keys.each do |section|
                   li
-                    a href="/##{section.downcase}" #{section}
-            li
-              a href="#about" About
+                    = link_to section, "/index.html##{section.downcase}"
+
             li
-              a href="#contact" Contact
+              = link_to 'Errors', '/errors/index.html'
+            / li
+            /   = link_to 'About', '/index.html#about'
+            / li
+            /   = link_to 'Contact', '/index.html#contact'
         /! /.navbar-collapse
     = yield
     hr
@@ -51,5 +54,5 @@ html
     /! Bootstrap core JavaScript
     /! ==================================================
     /! Placed at the end of the document so the pages load faster
-    script src="/javascripts/jquery-1.10.2.min.js"
-    script src="/javascripts/bootstrap.min.js"
+    = javascript_include_tag "jquery-1.10.2.min.js"
+    = javascript_include_tag "bootstrap.min.js"

data/lib/kanpachi/documentation/source/resource.html.slim

@@ -1,14 +1,14 @@
 .container
   .row
     .content.col-md-12
-      h2= resource.route
+      h1= resource.route
       p= Kanpachi::Markdown.to_html(resource.description)
       .table-responsive
         table.table.table-hover
           thead
             tr
               td colspan="2"
-                strong Parameters
+                h4 Parameters
           tbody
             - [[resource.params.input_filters.required_inputs, true], [resource.params.input_filters.optional_inputs, false]].each do |input, required|
               - input.each do |k, v|
@@ -31,7 +31,7 @@
           table.table.table-hover
             thead
               tr colspan="2"
-                strong Response (#{response.name.to_s})
+                h4 Response (#{Inflecto.humanize(response.name.to_s)})
               tr colspan="2"
                 Status: #{response.status}
                 br

data/lib/kanpachi/templates/documentation/config.rb

@@ -0,0 +1,22 @@
+# Middleman extended configuration
+# For options, refer to http://middlemanapp.com/advanced/configuration
+
+# Reload the browser automatically whenever files change
+activate :livereload
+
+configure :build do
+  # For example, change the Compass output style for deployment
+  activate :minify_css
+
+  # Minify Javascript on build
+  activate :minify_javascript
+
+  # Enable cache buster
+  activate :asset_hash
+
+  # Use relative URLs
+  # activate :relative_assets
+
+  # Or use a different image path
+  # set :http_prefix, '/docs/'
+end

data/lib/kanpachi/version.rb

@@ -1,3 +1,3 @@
 module Kanpachi
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanpachi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-28 00:00:00.000000000 Z
+date: 2013-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -275,6 +275,7 @@ files:
 - lib/kanpachi/cli/doc.rb
 - lib/kanpachi/commands/new.rb
 - lib/kanpachi/documentation/config.rb
+- lib/kanpachi/documentation/source/errors/index.html.slim
 - lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.eot
 - lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.svg
 - lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.ttf
@@ -317,6 +318,7 @@ files:
 - lib/kanpachi/templates/api/errors.rb
 - lib/kanpachi/templates/api/posts.rb
 - lib/kanpachi/templates/api/users.rb
+- lib/kanpachi/templates/documentation/config.rb
 - lib/kanpachi/version.rb
 - spec/api_list_spec.rb
 - spec/api_spec.rb