api_canon 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e23c8290bec0b00853a4ad4f768deec9f173bc
-  data.tar.gz: 8ebfaadf92a10be7c8ec6db1c84df8adaa96c367
+  metadata.gz: 249490f7cc9a83ad56dd8565ca49cb50d6e1e96e
+  data.tar.gz: 1267e0d3ef61a234622e8227c45cf27b5b10eaca
 SHA512:
-  metadata.gz: a287b10bf7431460d20f4e04310cbc9af2dbb6ca51ad1bce073773a89364f9296e11d9c14c46052f2b5de16ebe115ea91d54a98237ffc050f96e446915d58af1
-  data.tar.gz: c1406e5b9fb6f1af36747429c23d33c01d2578cf7456fc870d678b19b77eb50ad62aa33112a464cca57e1f012e8a15176e2981f8a885e0fb03a57163801492d0
+  metadata.gz: 78c97fdc96307a82fd071559aa9da85aaf7ecfc45c8cbd14d33b80c915e2127e9f6517ecbab04024ac5c3bdaa3a7c03f2f4274bce7c0d89101630be87ab64d73
+  data.tar.gz: 5542805bec9fdfc19eb64a52c3d841870726acb3bad33e1735766394457a656f46b810a1a1b518f3410adf5efa5e23bc23b68e8fb5394e9b3236a07bbe849802

data/README.md

@@ -1,9 +1,13 @@
 # API Canon
 
+Because API documentation should show you, not tell you.
+
 [![Build Status](https://travis-ci.org/cwalsh/api_canon.png?branch=master)](https://travis-ci.org/cwalsh/api_canon)
 
 ## Introduction
-API Canon is a tool for programatically documenting Ruby on Rails APIs with example usage.
+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
+[http://www.westfield.com.au/api/product/latest/categories](http://www.westfield.com.au/api/product/latest/categories)
 
 ## Installation and usage
 If you're using bundler, then put this in your Gemfile:

data/lib/api_canon/version.rb

@@ -1,3 +1,3 @@
 module ApiCanon
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

data/lib/api_canon.rb

@@ -50,7 +50,7 @@ module ApiCanon
     def document_controller(opts={}, &block)
       document = DocumentationStore.fetch controller_path
       document ||= Document.new controller_path, controller_name, opts
-      document.instance_eval &block
+      document.instance_eval &block if block_given?
       DocumentationStore.store document
     end
 
@@ -72,7 +72,7 @@ module ApiCanon
       document = DocumentationStore.fetch controller_path
       document ||= Document.new controller_path, controller_name
       documented_action = ApiCanon::DocumentedAction.new method_name
-      documented_action.instance_eval &block
+      documented_action.instance_eval &block if block_given?
       document.add_action documented_action
       DocumentationStore.store document
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_canon
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Cameron Walsh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails