api_canon 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 936137d1ba8d5b45575054ffa7256e7468fbd457
-  data.tar.gz: 4bf72194dbd52c8a611f8061a704af227d2ef6ee
+  metadata.gz: c187459fb3312f6a298e12416a51499ce9f5c60a
+  data.tar.gz: 88a9d06fddf3b3f413dce2e93c93ce5922927fe8
 SHA512:
-  metadata.gz: 909f47fb720e0abf57913eaf50d6aad5431b4c9c1f4b65f5488895eff417fd10f28bd8bd80ebe496ec9d6cf69f91da2e754523c8fb927695b5a19afc3be72b15
-  data.tar.gz: 727389d6de3213745959a73c1b3e422b9ffae6d86fc16f515b358c60264a4f13e6833f6c219ca5102a487576594db3de0d827938a62439710527d68d2d91c48e
+  metadata.gz: 1347370f6ee8ae03530a0c343100b3ea2cc5a92e6cd9b3ba2016744f735db4b6069c247ae254213051bb2e5559c7e44b08be4f1ff8ba16ea099009bd0e80874a
+  data.tar.gz: de9d214e7053256806977ca2e73a4b3a89263fb59baf030b35cccf0a959e8d77078f66df2e3ca5af7f76155472a457312b23769bb2d30453c225aaa8ce6aa71f

data/README.md

@@ -6,9 +6,11 @@ Because API documentation should show you, not tell you.
 
 ## Introduction
 API Canon is a tool for programatically documenting Ruby on Rails APIs with example usage. 
-It supports Rails 2, 3 and 4. You can see a real live example at
+It supports Rails 2 (see the Rails2 branch, api_canon versions less than 0.4), 3 and 4. You can see a real live example at
 [http://www.westfield.com.au/api/product/latest/categories](http://www.westfield.com.au/api/product/latest/categories)
 
+As of 0.4.1, api_canon now supports [https://developers.helloreverb.com/swagger/](Swagger) json output, but only supports Rails 3+.
+
 ## Installation and usage
 If you're using bundler, then put this in your Gemfile:
 
@@ -30,6 +32,7 @@ include ApiCanon
 
 ```ruby
 document_controller :as => 'optional_rename' do
+  link_path '/foo' #Optionally override the sidebar link.
   describe %Q{The actions here are awesome, they allow you to get a list of 
               awesome things, and make awesome things, too!}
 end
@@ -144,3 +147,6 @@ Right now, api_canon is changing a lot.  I plan to support the following feature
 3. Pull request
 4. ???
 5. Profit.
+
+# License
+See MIT-LICENSE.

data/app/views/api_canon/_api_canon.html.erb

@@ -65,7 +65,10 @@
 <% content_for :sidebar do %>
 <ul class='nav nav-list'>
   <% ApiCanon::DocumentationStore.instance.docos.each do |key, doco| %>
-    <li><%= link_to doco.display_name, url_for(:controller => doco.controller_path, :action => :index, :format => :html) %></li>
+    <li>
+      <%- doco_link = doco.sidebar_link || url_for(:controller => doco.controller_path, :action => :index, :format => :html) -%>
+      <%= link_to doco.display_name, doco_link %>
+    </li>
   <% end %>
 </ul>
 <% end %>

data/lib/api_canon/document.rb

@@ -1,7 +1,7 @@
 module ApiCanon
   class Document
     include ActiveModel::Serialization
-    attr_reader :description, :controller_path, :controller_name, :version
+    attr_reader :description, :controller_path, :controller_name, :version, :sidebar_link
     attr_accessor :documented_actions
     def initialize(controller_path, controller_name, opts={})
       @controller_path = controller_path
@@ -17,6 +17,9 @@ module ApiCanon
     def describe(desc)
       @description = desc
     end
+    def link_path(link)
+      @sidebar_link = link
+    end
     def display_name
       @display_name || @controller_name.titleize
     end

data/lib/api_canon/version.rb

@@ -1,3 +1,3 @@
 module ApiCanon
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_canon
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Cameron Walsh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails