restapi_doc 0.0.1 → 0.0.2

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+= Rest Api Doc Change Log
+
+
+=== Version 0.0.2
+
+Updated README.rdoc to show example of how to document a controller
+
+

data/README.rdoc

@@ -15,14 +15,53 @@ Run the following rake command to setup your environment.
 		
 This will create a 'restapi_doc' directory in your Rails config directory.
 In this directory you will now have a "restapi_doc.yml' file with some simple configuration options for your API document.
+== Documenting Controller class
+Below is a sample of how to document a class.
 
+        # =begin apidoc
+	# Description of class
+        # =end
 
-== Documenting controllers
+== Documenting controllers methods
 Below is a sample of how to document the controller to generate a document
 
+        # =begin apidoc
+        # method:: POST
+        # requires_authentication:: Yes
+        # response_format:: json
+        # response_format:: xml
+        # param:: Name - string - required - Users name
+        # param:: Email - string - required - Users email address
+        # param:: Password - string - required - Users password.
+        #
+        # http_response:: 201 - Created - Returns user object
+        # http_response:: 401 - Not Authorized - Not authorized
+        # http_response:: 422 - Unprocessable Entity - Unable to process parameters
+        #
+        # request:: json
+        # {
+        #  "name":"Linda Clarkson",
+        #  "email":"athatcher@yahoo.com",
+        #  "password":"Hl108dLpSr"
+        # }
+        # ::request-end::
+        #
+        # output:: json
+        # {
+        #    "_id":"4f9778fe4736df029c000003",
+        #    "created_at":"2012-04-24T21:09:34-07:00",
+        #    "email":"athatcher@yahoo.com",
+        #    "name":"Linda Clarkson"
+        # }
+        # ::output-end::
+        #
+        #
+        # Creates a new user
+        # =end
+
 
 == Creating Api Document
 
         rake restapi_doc:generate
 		
-You will now have a 'apidoc' directory located in your Rails 'public' directory
+You will now have a 'apidoc' directory located in your Rails 'public' directory

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/restapi_doc.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "restapi_doc"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Haight"]
-  s.date = "2012-04-26"
+  s.date = "2012-04-27"
   s.description = "REST API doc generates an easy way to create a twitter style document for your RESTful interface.  \n                        Leveraging Twitter Bootstrap to create an easy to read document for your RESTful api. "
   s.email = "kevinjhaight@gmail.com"
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
+    "CHANGELOG.rdoc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restapi_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-26 00:00:00.000000000 Z
+date: 2012-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152452280 !ruby/object:Gem::Requirement
+  requirement: &2152415760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2152452280
+  version_requirements: *2152415760
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &2152451780 !ruby/object:Gem::Requirement
+  requirement: &2152415240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152451780
+  version_requirements: *2152415240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152451180 !ruby/object:Gem::Requirement
+  requirement: &2152414660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152451180
+  version_requirements: *2152414660
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2152450340 !ruby/object:Gem::Requirement
+  requirement: &2152413760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152450340
+  version_requirements: *2152413760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152449700 !ruby/object:Gem::Requirement
+  requirement: &2152413180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *2152449700
+  version_requirements: *2152413180
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152449180 !ruby/object:Gem::Requirement
+  requirement: &2152412640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152449180
+  version_requirements: *2152412640
 description: ! "REST API doc generates an easy way to create a twitter style document
   for your RESTful interface.  \n                        Leveraging Twitter Bootstrap
   to create an easy to read document for your RESTful api. "
@@ -87,6 +87,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files:
+- CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - LICENSE