yard-rest-plugin 0.2.1 → 0.2.2

data/README.markdown

@@ -26,6 +26,10 @@ In addition to starting your comment with the normal RDoc description. The follo
 - @argument [type] name description. Specifies an argument that is passed to the service. You can specify as 
     many of these as required
 
+- @example_request example. An example of the request that is send to the service
+
+- @request_field name description. Further specifies the fields that are send within the request
+
 - @example_response example. An example of the response that is returned from the service
 
 - @response_field name description. Further specifies the fields that are returned within the response
@@ -41,15 +45,29 @@ The rationale here is that you are documenting external services (as represented
     ##
     # Retuns all samples, as XML, for the current user that match the given parameters.
     # 
-    # @url
-    # [GET] /samples/index.[format]?[arguments]
+    # @url [GET] /samples.[format]?[arguments]
+    # @url [GET] /samples/index.[format]?[arguments]
     # 
     # @argument [String] format Only "xml" is support at this time.
     # @argument [String] name The name of the sample
     # @argument [String] reource The resource that sample belongs to
-    # @argument ["@assigned"|"@complete"|"!@complete"] search Return jobs that are assigned, complete, or
+    # @argument ["@assigned"|"@complete"|"!@complete"] search Return samples that are assigned, complete, or
     #   uncomplete.
-    # 
+    #
+    # @example_request
+    #   <samples type="array">
+    #     <sample>
+    #       <id>961</id>
+    #       <name>My Sample</name>
+    #       <state>complete</state>
+    #       <last_unassigned_user_id type="integer"></last_unassigned_user_id>
+    #       <resource_id type="integer">127</resource_id>
+    #       <notes></notes>
+    #       <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
+    #       <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
+    #     </interval>
+    #   <intervals>
+    #
     # @example_response
     #   <samples type="array">
     #     <sample>
@@ -73,6 +91,63 @@ The rationale here is that you are documenting external services (as represented
     # 
     def index
     end
+    
+    ##
+    # Retuns all samples, as XML, for the current user that match the given parameters.
+    # 
+    # @url [POST] /samples.[format]?[arguments]
+    # 
+    # @argument [String] format Only "xml" is support at this time.
+    #
+    # @example_request
+    #   <sample>
+    #     <id>961</id>
+    #     <name>My Sample</name>
+    #     <state>complete</state>
+    #     <last_unassigned_user_id type="integer"></last_unassigned_user_id>
+    #     <resource_id type="integer">127</resource_id>
+    #     <note_attributes type="array">
+    #       <note>
+    #         <id>new_123</id>
+    #         <text>Note One</note>
+    #       </note>
+    #     </note_attributes>
+    #     <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
+    #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
+    #   </sample>
+    #
+    # @request_field id A unique ID identifying the Sample
+    # @request_field name The name of the sample
+    # @request_field state The current status of the Sample. Can be complete, uncomplete, etc.
+    # @request_field note_attributes Any notes given for the sample that will be created
+    # @request_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
+    # @request_field created_at The Date/Time (in ISO8601) that the Sample was created
+    #
+    # @example_response
+    #   <sample>
+    #     <id>961</id>
+    #     <name>My Sample</name>
+    #     <state>complete</state>
+    #     <last_unassigned_user_id type="integer"></last_unassigned_user_id>
+    #     <resource_id type="integer">127</resource_id>
+    #     <notes type="array">
+    #       <note>
+    #         <text>Note One</note>
+    #       </note>
+    #     </notes>
+    #     <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
+    #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
+    #   </sample>
+    # 
+    # @response_field id A unique ID identifying the Sample
+    # @response_field name The name of the sample
+    # @response_field state The current status of the Sample. Can be complete, uncomplete, etc.
+    # @response_field notes Any notes given for the sample
+    # @response_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
+    # @response_field created_at The Date/Time (in ISO8601) that the Sample was created
+    #
+    def create
+    end
 
 ## Development
 

data/Rakefile

@@ -10,7 +10,9 @@ begin
     gem.email = "aisha.fenton@visfleet.com"
     gem.homepage = "http://github.com/visfleet/yard-rest-plugin"
     gem.authors = ["Aisha Fenton"]
-    gem.add_dependency("yard", '>= 0.5') 
+    gem.add_dependency("yard", '~>0.6.1')
+    gem.files = Dir.glob("{lib,example,templates/rest}/**/*.rb").concat(["Rakefile"])
+    gem.extra_rdoc_files = ['VERSION', 'README.markdown']
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -28,5 +30,4 @@ namespace :ex do
     `rm -R doc`
     `rm -R .yardoc`
   end
-  
 end

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/example/SampleController.rb

@@ -8,8 +8,8 @@ class SampleController
   ##
   # Retuns all samples, as XML, for the current user that match the given parameters.
   # 
-  # @url
-  # [GET] /samples/index.[format]?[arguments]
+  # @url [GET] /samples/index.[format]?[arguments]
+  # @url [GET] /samples.[format]?[arguments]
   # 
   # @argument [String] format Only "xml" is support at this time.
   # @argument [String] name The name of the sample
@@ -48,10 +48,59 @@ class SampleController
   end
 
   ##
-  # Creates a new Sample
-  # @url [POST] /new
-  # @url [POST] /really_new
+  # Creates a new sample
   # 
+  # @url [POST] /samples.[format]?[arguments]
+  # 
+  # @argument [String] format Only "xml" is support at this time.
+  #
+  # @example_request
+  #   <sample>
+  #     <id>961</id>
+  #     <name>My Sample</name>
+  #     <state>complete</state>
+  #     <last_unassigned_user_id type="integer"></last_unassigned_user_id>
+  #     <resource_id type="integer">127</resource_id>
+  #     <note_attributes type="array">
+  #       <note>
+  #         <id>new_123</id>
+  #         <text>Note One</note>
+  #       </note>
+  #     </note_attributes>
+  #     <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
+  #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
+  #   </sample>
+  #
+  # @request_field id A unique ID identifying the Sample
+  # @request_field name The name of the sample
+  # @request_field state The current status of the Sample. Can be complete, uncomplete, etc.
+  # @request_field note_attributes Any notes given for the sample that will be created
+  # @request_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
+  # @request_field created_at The Date/Time (in ISO8601) that the Sample was created
+  #
+  # @example_response
+  #   <sample>
+  #     <id>961</id>
+  #     <name>My Sample</name>
+  #     <state>complete</state>
+  #     <last_unassigned_user_id type="integer"></last_unassigned_user_id>
+  #     <resource_id type="integer">127</resource_id>
+  #     <notes type="array">
+  #       <note>
+  #         <text>Note One</note>
+  #       </note>
+  #     </notes>
+  #     <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
+  #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
+  #   </sample>
+  # 
+  # @response_field id A unique ID identifying the Sample
+  # @response_field name The name of the sample
+  # @response_field state The current status of the Sample. Can be complete, uncomplete, etc.
+  # @response_field notes Any notes given for the sample
+  # @response_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
+  # @response_field created_at The Date/Time (in ISO8601) that the Sample was created
+  #
   def create
   end
 

data/lib/yard-rest-plugin.rb

@@ -5,11 +5,15 @@ $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 require "yard-rest-plugin/base_helper"
 
 YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'
+# TODO: Check ruby version and support ruby 1.9 in future
+YARD::Parser::SourceParser.parser_type = :ruby18
 
 # Define custom tags
 YARD::Tags::Library.define_tag("URL for Service", :url)
 YARD::Tags::Library.define_tag("Topic for Service", :topic)
 YARD::Tags::Library.define_tag("Arguments", :argument, :with_types_and_name)
-YARD::Tags::Library.define_tag("Example Responses", :example_response)
+YARD::Tags::Library.define_tag("Example Request", :example_request)
+YARD::Tags::Library.define_tag("Request Fields", :request_field, :with_name)
+YARD::Tags::Library.define_tag("Example Response", :example_response)
 YARD::Tags::Library.define_tag("Response Fields", :response_field, :with_name)
 

data/templates/rest/tags/setup.rb

@@ -1,5 +1,10 @@
 def init
-  sections :index, [:argument, :example_response, :response_field]
+  super
+  sections.place([:argument, :example_request, :request_field, :example_response, :response_field]).before(:index)
+end
+
+def request_field
+  generic_tag :request_field
 end
 
 def response_field

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yard-rest-plugin
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Aisha Fenton
@@ -14,20 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-19 00:00:00 +12:00
+date: 2010-11-08 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yard
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 5
         segments: 
         - 0
-        - 5
-        version: "0.5"
+        - 6
+        - 1
+        version: 0.6.1
   type: :runtime
   version_requirements: *id001
 description: A plugin for Yardoc that produces API documentation for Restful web services. See README.markdown for more details
@@ -38,53 +42,22 @@ extensions: []
 
 extra_rdoc_files: 
 - README.markdown
+- VERSION
 files: 
-- README.markdown
 - Rakefile
-- VERSION
-- example/README.markdown
 - example/SampleController.rb
 - lib/yard-rest-plugin.rb
 - lib/yard-rest-plugin/base_helper.rb
-- pkg/yard-rest-plugin-0.1.5.gem
-- pkg/yard-rest-plugin-0.2.0.gem
-- pkg/yard-rest-plugin-0.2.1.gem
-- templates/rest/.DS_Store
-- templates/rest/class/html/header.erb
-- templates/rest/class/html/method_details_list.erb
 - templates/rest/class/html/setup.rb
-- templates/rest/disqus/html/disqus.erb
 - templates/rest/disqus/setup.rb
 - templates/rest/docstring/html/setup.rb
-- templates/rest/docstring/html/text.erb
-- templates/rest/fulldoc/.DS_Store
-- templates/rest/fulldoc/html/.DS_Store
-- templates/rest/fulldoc/html/css/common.css
-- templates/rest/fulldoc/html/css/full_list.css
-- templates/rest/fulldoc/html/css/style.css
-- templates/rest/fulldoc/html/full_list.erb
-- templates/rest/fulldoc/html/full_list_files.erb
-- templates/rest/fulldoc/html/full_list_resource.erb
-- templates/rest/fulldoc/html/full_list_topic.erb
-- templates/rest/fulldoc/html/js/app.js
-- templates/rest/fulldoc/html/js/full_list.js
-- templates/rest/fulldoc/html/js/jquery.js
 - templates/rest/fulldoc/html/setup.rb
-- templates/rest/layout/html/footer.erb
-- templates/rest/layout/html/headers.erb
-- templates/rest/layout/html/index.erb
-- templates/rest/layout/html/layout.erb
-- templates/rest/layout/html/search.erb
 - templates/rest/layout/html/setup.rb
-- templates/rest/method_details/html/header.erb
-- templates/rest/method_details/html/method_signature.erb
 - templates/rest/method_details/html/setup.rb
 - templates/rest/module/setup.rb
-- templates/rest/tags/html/example_response.erb
-- templates/rest/tags/html/generic_tag.erb
-- templates/rest/tags/html/index.erb
 - templates/rest/tags/setup.rb
-- yard-rest-plugin.gemspec
+- README.markdown
+- VERSION
 has_rdoc: true
 homepage: http://github.com/visfleet/yard-rest-plugin
 licenses: []
@@ -95,23 +68,27 @@ rdoc_options:
 require_paths: 
 - lib
 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: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A plugin for Yardoc that produces API documentation for Restful web services

data/example/README.markdown

@@ -1,11 +0,0 @@
-Sample API
-==========
-This is a sample API. You should see:
-
-  - This file
-  - An index containing one service /sample.
-  - That service should contain only one action: Index
-  - Index should have a description, list of arguments, an example response, and a list of response fields. 
-  - Nothing else should be included because it doesn't have a URL specified.
-  
-Click [here](./_index.html) to go to the Index

data/templates/rest/class/html/header.erb

@@ -1,24 +0,0 @@
-<div class="service">
-  <h1><span class="minor_heading">Resource: </span><%= object.tag("url").text %></h1>
-  <% unless object.tags("topic").empty? %>
-    <h3 class="topic">Topics:</h3> 
-    <ul class="box">
-      <% object.tags("topic").each do |topic| %>
-        <li><%= topic.text %></li>
-      <% end %>
-    </ul>
-  <% end %>
-  <%= yieldall %>
-</div>
-
-
-
-
-  
-  
-    
-  
-    
-  
-  
-  

data/templates/rest/class/html/method_details_list.erb

@@ -1,6 +0,0 @@
-<div id="Services" class="method_details_list">
-<h2>Actions</h2>
-<% @meths.each_with_index do |meth, i| %>
-  <%= yieldall :object => meth, :index => i %>
-<% end %>
-</div>

data/templates/rest/disqus/html/disqus.erb

@@ -1,24 +0,0 @@
-<h2>Discuss this Resource</h2>
-<div id="disqus_thread"></div>
-<script type="text/javascript">
-  var disqus_shortname = 'vworkapi';
-  var disqus_identifier = "<%= @disqus_identifier %>";
-  // var disqus_developer = 1;
-  /**
-    * var disqus_identifier; [Optional but recommended: Define a unique identifier (e.g. post id or slug) for this thread] 
-    */
-  (function() {
-   var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
-   dsq.src = 'http://vworkapi.disqus.com/embed.js';
-   (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
-  })();
-</script>
-<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript=vworkapi">comments powered by Disqus.</a></noscript>
-<a href="http://disqus.com" class="dsq-brlink">API comments powered by <span class="logo-disqus">Disqus</span></a>
-<script type="text/javascript">
-(function () {
-  var s = document.createElement('script'); s.async = true;
-  s.src = 'http://disqus.com/forums/vworkapi/count.js';
-  (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
-}());
-</script>

data/templates/rest/docstring/html/text.erb

@@ -1 +0,0 @@
-<%= htmlify(object.docstring.strip) %>