api_canon 0.3.0 → 0.3.1

data/README.md

@@ -15,7 +15,12 @@ If you're using bundler, then put this in your Gemfile:
 ```ruby
 gem 'api_canon'
 ```
-Then, in each controller you want to document, add the line
+Add this to your routes.rb file:
+
+```ruby
+ApiCanon::Routes.draw(self) # Or 'map' instead of 'self' for Rails 2
+```
+Then, in each controller you want to document, add the line:
 
 ```ruby
 include ApiCanon
@@ -30,7 +35,7 @@ document_controller :as => 'optional_rename' do
 end
 ```
 
-That is optional, but reccomended, as it gives context to users of your API.
+That is optional, but recommended, as it gives context to users of your API.
 
 More usefully you can document all the actions you want like this:
 
@@ -45,12 +50,6 @@ end
 
 To view the api documentation, visit the documented controller's index action with '.html' as the format.
 
-To enable the 'test' button on the generated documentation pages, you'll need to add this to your config/routes.rb file:
-
-```ruby
-ApiCanon::Routes.draw(self) # Or 'map' instead of 'self' for Rails 2
-```
-
 ## Examples
 
 ### Standard Rails actions

data/app/helpers/api_canon/api_canon_view_helper.rb

@@ -1,6 +1,6 @@
 module ApiCanon
   module ApiCanonViewHelper
-    if Rails.version.starts_with?('2')
+    if ::Rails.version.starts_with?('2')
       def content_for?(content_partial_name)
         instance_variable_get("@content_for_#{content_partial_name}")
       end

data/lib/api_canon.rb

@@ -28,7 +28,7 @@ module ApiCanon
   # which renders the ApiCanon documentation if params[:format] is html, and defaults
   # to the existing method otherwise.
   def index
-    if params[:format].blank? || params[:format] == 'html'
+    if request.format.html?
       api_canon_docs
     else
       super

data/lib/api_canon/version.rb

@@ -1,3 +1,3 @@
 module ApiCanon
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/spec_helper.rb

@@ -1,6 +1,12 @@
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
-require 'rails'
+require 'bundler'
+Bundler.setup
+class Rails
+  def self.version
+    '2.3.17'
+  end
+end
 require 'singleton'
 require 'action_controller'
 require 'api_canon'

metadata

@@ -1,82 +1,95 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: api_canon
-version: !ruby/object:Gem::Version
-  version: 0.3.0
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
-authors:
+authors: 
 - Cameron Walsh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-07-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.17
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.17
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.13.0
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 2
+        - 13
+        - 0
         version: 2.13.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: |-
   api_canon is a declarative documentation generator
                          for APIs. Declare the parameters and response codes,
                          describe them, and give some example values. api_canon
                          handles the rest for you.
-email:
+email: 
 - cameron.walsh@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - app/views/api_canon/api_canon.html.erb
 - app/views/api_canon/_form.html.erb
 - app/views/api_canon/_api_canon.html.erb
@@ -101,35 +114,45 @@ files:
 - spec/lib/api_canon/documented_param_spec.rb
 - spec/lib/api_canon/documented_action_spec.rb
 - spec/lib/api_canon_spec.rb
-- spec/dummy/log/test.log
+- spec/internal/log/test.log
 homepage: http://github.com/cwalsh/api_canon
-licenses:
+licenses: 
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - app
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Declarative documentation generator for APIs.
-test_files:
+test_files: 
 - spec/spec_helper.rb
 - spec/lib/api_canon/documented_param_spec.rb
 - spec/lib/api_canon/documented_action_spec.rb
 - spec/lib/api_canon_spec.rb
-- spec/dummy/log/test.log
+- spec/internal/log/test.log
+has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 015c10ce864e09df6f0aafddd61441588d89c016
-  data.tar.gz: 283d2444de9b879f4f435a466ddeb8ff9f8e7cd3
-SHA512:
-  metadata.gz: 43326d08ee1eeb4aaa3705672114b1421bb566f33dfb5992651a21b2473cd7a54bf82626b2a8a6594f3f0950cdf808d977f706078e8cea7ab48cef2b5614e5d0
-  data.tar.gz: 4c5cfb283e87a533c01b39d7c00cc6b4a49859f4809a24abbda6a1c43016dbffb42016f02f38a20760fd8826fc2fd1d2db7f48ed3c7500e7e335cdd8f546fc61