api_canon 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f4993fa3f12d27e8ff54ca9ee6becafa5bb6080
-  data.tar.gz: 31e54ec37b2a8715bd0d8c31729734cc34d816ac
+  metadata.gz: 9fa91521da7d5fd5b48562111c5d99d83bb69a3f
+  data.tar.gz: 65e021ee8670382922e8211367dd53fa2e9a5df3
 SHA512:
-  metadata.gz: a851685829187972e5b14c379846f9a1fb42c587b16c52edccf46b79d67d5d61c3cd21653cb70948d07429cb1fc0ec133489462bdc41a7a074670d1613fe1880
-  data.tar.gz: 6d67a86a1019e78a56a566bdac9c5790ec63edfd958e95ee571526bd1814505cb033c23b71f247b1ee8a2841cd57630a8fc2bdaf2b27c309d65775b4e18e8d68
+  metadata.gz: 23746edbb6ce43120aed1fd73b374dee09865390eed1810364fd46a5864e1a81d2506ad98a7fe0c3ed13d3ee96a36469cf38fbd4659185c43ff4eba1abc94a1e
+  data.tar.gz: 33f3ae296a40dc414ad5cbf8871ad2d6d56227a3ebdc4bae5f6d63b0a60d4025082513fa0070a4e350c3c6ae1342ddb06d56945779920630b3baad57edb232a1

data/README.md

@@ -21,7 +21,8 @@ include ApiCanon
 
 ```ruby
 document_controller :as => 'optional_rename' do
-  describe "The actions here are awesome, they allow you to get a list of awesome things, and make awesome things, too!"
+  describe %Q{The actions here are awesome, they allow you to get a list of 
+              awesome things, and make awesome things, too!}
 end
 ```
 
@@ -31,7 +32,10 @@ More usefully you can document all the actions you want like this:
 
 ```ruby
 document_method :index do
-  param :category_codes, :type => :array, :multiple => true, :example_values => Category.all(:limit => 5, :select => :code).map(&:code), :description => "Return only categories for the given category codes", :default => 'some-awesome-category-code'
+  param :category_codes, :type => :array, :multiple => true, 
+        :example_values => Category.limit(5).pluck(:code),
+        :description => "Return only categories for the given category codes",
+        :default => 'some-awesome-category-code'
 end
 ```
 
@@ -56,8 +60,11 @@ class CategoriesController < ApplicationController
 
   document_method :index do
     describe "This gives you a bunch of categories."
-    param :node, :type => :string, :values => ['womens-fashion', 'mens-fashion'], :default => 'womens-fashion', :description => "Category code to start with"
-    param :depth, :type => :integer, :values => 1..4, :default => 1, :description => "Maximum depth to include child categories"
+    param :node, :type => :string, :default => 'womens-fashion',
+          :values => ['womens-fashion', 'mens-fashion'],
+          :description => "Category code to start with"
+    param :depth, :type => :integer, :values => 1..4, :default => 1, 
+          :description => "Maximum depth to include child categories"
   end
   def index
     # Do stuff.
@@ -86,18 +93,29 @@ class FunkyCategoriesController < ApplicationController
   include ApiCanon
 
   document_controller :as => 'Categories' do
-    describe "Categories are used for filtering products. They are hierarchical, with 4 levels. These 4 levels are known as Super-Categories, Categories, Sub-Categories and Types. Examples include \"Women's Fashion\", \"Shirts\" and so forth. They are uniquely identifiable by their category_code field."
+    describe %Q{Categories are used for filtering products. They are 
+      hierarchical, with 4 levels. Examples include "Women's Fashion",
+      "Shirts" and so forth. They are uniquely identifiable by their 
+      category_code field.}
   end
 
   document_method :index do
-    describe "This action returns a filtered tree of categories based on the parameters given in the request."
-    param :hierarchy_level, :values => 1..4, :type => :integer, :default => 1, :description => "Maximum depth to include child categories"
-    param :category_codes, :type => :array, :multiple => true, :example_values => Category.online.enabled.super_categories.all(:limit => 5, :select => :code).map(&:code), :description => "Return only categories for the given category codes", :default => 'mens-fashion-accessories'
+    describe %Q{This action returns a filtered tree of categories based on the 
+      parameters given in the request.}
+    param :hierarchy_level, :values => 1..4, :type => :integer, :default => 1,
+      :description => "Maximum depth to include child categories"
+    param :category_codes, :type => :array, :multiple => true, 
+      :example_values => Category.limit(5).pluck(:code), 
+      :description => "Return only categories for the given category codes", 
+      :default => 'mens-fashion-accessories'
   end
 
   document_method :show do
-    describe "This action returns a tree of categories starting at the requested root node."
-    param :id, :type => :string, :example_values => Category.online.enabled.super_categories.all(:limit => 5, :select => :code).map(&:code), :description => "Category code to show, the root node for the entire tree.", :default => 'mens-fashion-accessories'
+    describe %Q{This action returns a tree of categories starting at the 
+      requested root node.}
+    param :id, :type => :string,:default => 'mens-fashion-accessories',
+      :example_values => Category.limit(5).pluck(:code),
+      :description => "Category code to show, the root node for the entire tree."
   end
 
   #... code to support the above documented parameters etc.

data/lib/api_canon/version.rb

@@ -1,3 +1,3 @@
 module ApiCanon
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_canon
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Cameron Walsh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,20 +66,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |-
   api_canon is a declarative documentation generator
                          for APIs. Declare the parameters and response codes,