described_routes 0.5.1 → 0.6.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.6.0 2009-06-28
+
+* Add automatic link header/element generation
+* LICENSE, README tweaks
+
 == 0.5.1 2009-05-22
 
 * Add ResourceTemplate::ResourceTemplate.find_by_rel

data/LICENSE

@@ -1,4 +1,4 @@
-path-to, Copyright (c) 2009 Mike Burrows
+described_routes, Copyright (c) 2009 Mike Burrows
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -5,6 +5,7 @@ PostInstall.txt
 README.rdoc
 Rakefile
 lib/described_routes.rb
+lib/described_routes/helpers/described_routes_helper.rb
 lib/described_routes/rails_controller.rb
 lib/described_routes/rails_routes.rb
 lib/described_routes/rake_task_methods.rb
@@ -19,7 +20,10 @@ test/test_helper.rb
 test/test_resource_template.rb
 test_rails_app/Rakefile
 test_rails_app/app/controllers/application_controller.rb
+test_rails_app/app/controllers/users_controller.rb
+test_rails_app/app/controllers/welcome_controller.rb
 test_rails_app/app/helpers/application_helper.rb
+test_rails_app/app/views/layouts/default.html.erb
 test_rails_app/config/boot.rb
 test_rails_app/config/environment.rb
 test_rails_app/config/environments/development.rb
@@ -43,5 +47,6 @@ test_rails_app/test/fixtures/run_time/described_routes.text
 test_rails_app/test/fixtures/run_time/described_routes.xml
 test_rails_app/test/fixtures/run_time/described_routes.yaml
 test_rails_app/test/integration/described_routes_run_time_test.rb
+test_rails_app/test/integration/headers_test.rb
 test_rails_app/test/integration/rake_tasks_test.rb
 test_rails_app/test/test_helper.rb

data/README.rdoc

@@ -2,9 +2,7 @@
 
 == DESCRIPTION
 
-Framework-neutral metadata, describing (among other things) your Rails routes in JSON, YAML, XML and plain text formats.
-
-Also the home (for now at least) of the ResourceTemplate class.
+Dynamic, framework-neutral metadata describing path/URI structures, with natural translations to/from JSON, YAML and XML.  Bonus features: easy Rails integration, link element / link header generation and a plain text report format!
 
 See roadmap for described_routes and path-to[http://github.com/asplake/path-to/tree] at http://positiveincline.com/?p=213.
 
@@ -164,6 +162,24 @@ JSON example (after pretty printing):
         }
      ]
   }
+  
+=== Link Generation
+
+TODO: document how to integrate described_routes_helper; meanwhile see the test_rails_app for guidance.
+ 
+Generate HTML link elements by generated by adding
+
+  <%= link_elements %>
+  
+to the &lt;head&gt; part of you layout.
+
+Generate link headers (see the draft spec http://tools.ietf.org/id/draft-nottingham-http-link-header-05.txt) by including
+
+  before_filter :set_link_header
+
+in your controllers.  You can do this once in ApplicationController to get this behaviour across all controllers.
+
+See DescribedRoutes::DescribedRoutesHelper#link_data for configuration options.
 
 == DATA STRUCTURES and FORMATS
 

data/lib/described_routes/helpers/described_routes_helper.rb

@@ -0,0 +1,131 @@
+module DescribedRoutes
+  module DescribedRoutesHelper
+    # Map rels to standard relation types, used by #link_data
+    REGISTERED_RELS = {
+      'edit' => 'edit'
+    }
+    
+    # The default options parameter to #link_elements; controls which links appear in html link elements 
+    LINK_ELEMENT_OPTIONS = {
+      :self => true, :describedby => true, :describedby => true, :describedbywithparams => true, :up => true, :related => true
+    }
+    
+    # The default options parameter to #link_headers; controls which links appear in html link elements 
+    LINK_HEADER_OPTIONS = {
+      :self => true, :describedby => true, :describedby => true, :describedbywithparams => true, :up => true, :related => true
+    }
+    
+    # get the resource template structure, initialised (once) from Rails routes
+    def resource_templates
+      @@resource_templates ||= begin
+        base_url = root_url rescue nil
+        RailsRoutes.get_resource_templates(base_url)
+      end
+    end
+    
+    # get the resource template for the current request
+    def resource_template
+      r = resource_templates.routing[[controller_name, action_name]]
+      r[0] if r
+    end
+    
+    # combined path and query parameters (not POST parameters), with the id param renamed to foo_id (say)
+    def resource_parameters
+      @resource_parameters ||= begin
+        p = request.path_parameters.merge(request.query_parameters)
+        r = resource_templates.routing[[controller_name, action_name]]
+        if r && r[1] && p[:id]
+          p[r[1]] = p.delete(:id)
+        end
+        p.except("action", "controller")
+      end
+    end
+  
+    # Render link_data as <link <url> rel=<rel> ... type=<type>> elements.  Add to the <head> part of your layout with:
+    #   <%= link_elements %>
+    def link_elements(options=LINK_ELEMENT_OPTIONS)
+      link_data(options).map{|url, rels, type|
+        %Q(<link href="#{url}" #{rels.map{|r| %Q(rel="#{r}")}.join(" ")} type="#{type}">)
+      }.join("\n")
+    end
+  
+    # Render link_data as a link header.  Usage:
+    #   response.headers["Link"] = link_header(options)
+    # or use #set_link_header
+    def link_header(options=LINK_HEADER_OPTIONS)
+      link_data(options).map{|url, rels, type|
+        %Q(<#{url}>; #{rels.map{|r| %Q(rel="#{r}")}.join("; ")}; type="#{type}")
+      }.join(', ')
+    end
+    
+    # Sets a link header in the response
+    #     before_filter :set_link_header 
+    def set_link_header(options=LINK_HEADER_OPTIONS)
+      response.headers["Link"] = link_header(options)
+    end
+
+    # Returns an array of link information, each element containing 
+    # 0) a URL
+    # 1) a *list* of link relation types (there can be more than one) - see explanation below
+    # 2) a "type" - actually a route name or (literally) "ResourceTemplate"
+    # The list of link relations types will contain a standard type ('self', 'up', 'describedby') &/or an extention type
+    # in the form "described_route_url(name)#rel", using the name and rel of the resource template.
+    #
+    # Example output for a request to a "user" route:
+    # 
+    #   [
+    #     ['http://example.com/users/dojo', ['self'], 'user'],
+    #     ['http://example.com/users', ['up'], 'users'],
+    #     ['http://example.com/users/described_routes/user?user_id=dojo', ['describedby'], 'ResourceTemplate'],
+    #     ['http://example.com/users/dojo/edit', ['edit', 'http://example.com/user/described_routes/user#edit'], 'edit_user'],
+    #     ['http://example.com/users/dojo/edit', ['http://example.com/user/described_routes/user#profile'], 'user_profile']
+    #   ]
+    #
+    # The output is filtered by the options hash, with members :self, :describedby, :describedby, :describedbywithparams, :up, :related.
+    # Rel values will include a short value (e.g. 'edit') if the template's rel has a mapping in REGISTERED_RELS. 
+    #
+    def link_data(options)
+      result = []
+      rt = resource_template
+      if rt
+        if rt.name == 'root'
+          described_by = described_routes_url
+          related = resource_templates
+        else
+          described_by = described_route_url(rt.name)
+          related = rt.resource_templates
+        end
+        
+        if resource_parameters.empty?
+          described_by_with_params = described_by
+        else
+          described_by_with_params = described_by + '?' + resource_parameters.to_query
+        end
+        
+        type_prefix = described_routes_url + '#'
+        
+        result << [request.url, ['self'], type_prefix + rt.name] if options[:self]
+        result << [described_by, ['describedby'], type_prefix + 'ResourceTemplate'] if options[:describedby]
+        if options[:describedbywithparams]
+          result << [described_by_with_params, ['describedby'], type_prefix + 'ResourceTemplate'] if described_by_with_params != described_by || !options[:describedby]
+        end
+        if options[:up]
+          if rt.parent
+            result << [rt.parent.uri_for(resource_parameters), ['up'], type_prefix + rt.parent.name]
+          elsif rt.name != 'root'
+            result << [root_url, ['up'], type_prefix + "root"]
+          end
+        end
+        if options[:related]
+          related.expand_links(resource_parameters).map do |l|
+            if l.name != rt.name
+              rel = l.rel || l.name
+              result << [l.uri, REGISTERED_RELS[rel].to_a + [described_by + '#' + rel], type_prefix + l.name]
+            end
+          end
+        end
+      end
+      result
+    end
+  end
+end

data/lib/described_routes/rails_controller.rb

@@ -1,30 +1,31 @@
 require 'described_routes/rails_routes'
+require 'described_routes/helpers/described_routes_helper'
 require 'active_support'
 
 module DescribedRoutes
   class RailsController < ActionController::Base
+    include DescribedRoutes::DescribedRoutesHelper
+    
     def index
-      base_url = root_url rescue nil
-      resource_templates = RailsRoutes.get_resource_templates(base_url).partial_expand(request.query_parameters)
+      expanded_templates = resource_templates.partial_expand(request.query_parameters)
       
       respond_to do |format|
-        format.html # index.html.erb
-        format.json { render :json => resource_templates.to_json }
-        format.text { render :text => resource_templates.to_text }
-        format.yaml { render :text => resource_templates.to_yaml }
-        format.xml  { render :xml  => resource_templates.to_xml(Builder::XmlMarkup.new(:indent => 2)).target! }
+        format.html { render rescue redirect_to :format => :text } # render index.html.erb or fall back to text
+        format.json { render :json => expanded_templates.to_json }
+        format.text { render :text => expanded_templates.to_text }
+        format.yaml { render :text => expanded_templates.to_yaml }
+        format.xml  { render :xml  => expanded_templates.to_xml(Builder::XmlMarkup.new(:indent => 2)).target! }
       end
     end
-    
+
     def show
-      base_url = root_url rescue nil
-      resource_templates = RailsRoutes.get_resource_templates(base_url).partial_expand(request.query_parameters)
+      expanded_templates = resource_templates.partial_expand(request.query_parameters)
       resource_template = resource_templates.all_by_name[params[:id]]
       # TODO 404 if nil
       resource_template = resource_template.partial_expand(request.query_parameters)
       
       respond_to do |format|
-        format.html # show.html.erb
+        format.html { render rescue redirect_to :format => :text } # render show.html.erb or fall back to text
         format.json { render :json => resource_template.to_json }
         format.text { render :text => resource_template.to_text }
         format.yaml { render :text => resource_template.to_yaml }

data/lib/described_routes/rails_routes.rb

@@ -2,6 +2,33 @@ require 'resource_template'
 
 module DescribedRoutes
   module RailsRoutes
+    # This is just glue really.  It captures some extra data in the top level ResourceTemplates container to help address a
+    # couple of issues:
+    # 1) Inconsistent id parameter naming - id become {foo}_id when foo becomes the parent of another type of resources
+    # 2) Rails doesn't pass in the route object (not even its name) when routing a request to a controller so we have
+    # to keep enough information here for us to be able to guess it. Controller and action will be enough 99% of the time.
+    class RailsResourceTemplates < ResourceTemplate::ResourceTemplates
+      # Maps [controller, action] to [resource_template, id_name]
+      attr_reader :routing
+      
+      def initialize(parsed)
+        super
+        
+        @routing = {}
+        save_routing(parsed)
+      end
+      
+      private
+      
+      def save_routing(parsed)
+        if parsed
+          parsed.each do |p|
+            @routing[[p["controller"], p["action"]]] = [all_by_name[p["name"]], p["id_name"]]
+            save_routing(p["resource_templates"])
+          end
+        end
+      end
+    end
     
     #
     # Hook to customise the "parsed" (Array/Hash) data.  For example, to remove certain sensitive routes:
@@ -11,12 +38,12 @@ module DescribedRoutes
     mattr_accessor :parsed_hook
     
     #
-    # Process Rails routes and return an array of ResourceTemplate objects
+    # Process Rails routes and return an array of ResourceTemplate objects.
     #
-    def self.get_resource_templates(base_url = nil)
+    def self.get_resource_templates(base_url=nil, routing=nil)
       parsed = get_parsed_rails_resources(base_url)
       parsed = parsed_hook.call(parsed) if parsed_hook
-      ResourceTemplate::ResourceTemplates.new(parsed)
+      RailsResourceTemplates.new(parsed)
     end
 
     #
@@ -34,13 +61,11 @@ module DescribedRoutes
 
         # prefix :id parameters consistently
         # TODO - probably a better way to do this, just need a pattern that matches :id and not :id[a-zA-Z0-9_]+
+        id_name = nil
         segs.gsub!(/:[a-zA-Z0-9_]+/) do |match|
           if match == ":id" && controller
-            if controller == "described_routes/rails"
-              ":route_name"
-            else
-              ":#{controller.singularize.sub(/.*\//, "")}_id"
-            end
+            id_name = (controller == "described_routes/rails") ? "route_name" : "#{controller.singularize.sub(/.*\//, "")}_id"
+            ':' + id_name
           else
             match
           end
@@ -81,12 +106,15 @@ module DescribedRoutes
           #   options           #=> ["GET"]
           #   name              #=> "edit_user"
           #   controller        #=> "rails"
+          #   id_name           #=> "user_id"
 
           # create a new route hash
           resource = {
             "path_template" => template,
             "options"       => options,
-            "controller"    => controller
+            "controller"    => controller,
+            "action"        => action,
+            "id_name"       => id_name
           }
           resource["params"] = params unless params.empty?
           resource["optional_params"] = optional_params unless optional_params.empty?

data/lib/described_routes.rb

@@ -2,5 +2,5 @@ require 'resource_template'
 
 module DescribedRoutes
   # rubygem version
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/resource_template.rb

@@ -27,6 +27,9 @@ class ResourceTemplate
   # Nested resource templates, a Resources object
   attr_reader :resource_templates
   
+  # Inverse of resource_templates
+  attr_reader :parent
+  
   #
   # Initialize a ResourceTemplate from a hash.  For example:
   #
@@ -46,10 +49,11 @@ class ResourceTemplate
   #   user_articles = ResourceTemplate.new(JSON.parse(json))
   #   user_articles = ResourceTemplate.new(YAML.load(yaml))
   #
-  def initialize(hash={})
+  def initialize(hash={}, parent=nil)
     @name, @rel, @uri_template, @path_template = %w(name rel uri_template path_template).map{|attr| hash[attr]}
     @params, @optional_params, @options = %w(params optional_params options).map{|attr| hash[attr] || []}
-    @resource_templates = ResourceTemplates.new(hash["resource_templates"])
+    @resource_templates = ResourceTemplates.new(hash["resource_templates"], self)
+    @parent = parent
   end
   
   # Convert to a hash (equivalent to its JSON or YAML representation)
@@ -156,6 +160,11 @@ class ResourceTemplate
     Addressable::Template.new(t).expand(params_hash).to_s
   end
   
+  # Returns a URI (assuming the template needs to parameters!)
+  def uri
+    uri_for({}, nil)
+  end
+  
   # Returns an expanded path template with template variables filled from the given params hash.
   # Raises ArgumentError if params doesn't contain all mandatory params, and a RuntimeError if there is no path_template.
   def path_for(params_hash)
@@ -165,7 +174,13 @@ class ResourceTemplate
     Addressable::Template.new(path_template).expand(params_hash).to_s
   end
   
-  # Return a new resource template with the path_template or uri_template partially expanded with the given params
+  # Returns a path (assuming the template needs to parameters!)
+  def path
+    path_for({})
+  end
+  
+  # Return a new resource template with the path_template or uri_template partially expanded with the given params; does the same
+  # recursively descending through child resource templates.
   def partial_expand(actual_params)
     self.class.new(
         "name"               => name,
@@ -183,14 +198,14 @@ class ResourceTemplate
     template && Addressable::Template.new(template).partial_expand(params).pattern
   end
   
-  # Find member ResourceTemplate objects with the given rel
-  def find_by_rel(rel)
-    resource_templates.select{|resource_template| resource_template.rel == rel}
+  # Find member ResourceTemplate objects matching the given rel
+  def find_by_rel(matching_rel)
+    resource_templates.select{|resource_template| matching_rel === resource_template.rel}
   end
   
   class ResourceTemplates < Array
     # Initialize Resources (i.e. a new collection of ResourceTemplate objects) from given collection of ResourceTemplates or hashes
-    def initialize(collection=[])
+    def initialize(collection=[], parent=nil)
       if collection
         raise ArgumentError.new("#{collection.inspect} is not a collection") unless collection.kind_of?(Enumerable)
 
@@ -198,7 +213,7 @@ class ResourceTemplate
           if r.kind_of?(ResourceTemplate)
             push(r)
           elsif r.kind_of?(Hash)
-            push(ResourceTemplate.new(r))
+            push(ResourceTemplate.new(r, parent))
           else
             raise ArgumentError.new("#{r.inspect} is neither a ResourceTemplate nor a Hash")
           end
@@ -267,7 +282,6 @@ class ResourceTemplate
         ] 
         resource_template.resource_templates.to_table(resource_template, t, indent + '  ')
       end
-      t
     end
   
     # text report
@@ -287,7 +301,24 @@ class ResourceTemplate
     # Partially expand the path_template or uri_template of the given resource templates with the given params,
     # returning new resource templates
     def partial_expand(actual_params)
-      self.class.new(map{|resource_template| resource_template.partial_expand(actual_params)})
+      ResourceTemplates.new(map{|resource_template| resource_template.partial_expand(actual_params)})
+    end
+    
+    # Return a new resource template with the path_template or uri_template expanded; expands also any child resource templates
+    # that don't require additional parameters.
+    def expand_links(actual_params)
+      ResourceTemplates.new(
+        select{|rt| (rt.positional_params(rt.parent) - rt.optional_params).empty?}.map {|rt|
+          {
+            "name"               => rt.name,
+            "rel"                => rt.rel,
+            "uri_template"       => rt.partial_expand_uri_template(rt.uri_template, actual_params),
+            "path_template"      => rt.partial_expand_uri_template(rt.path_template, actual_params),
+            "params"             => rt.params - actual_params.keys,
+            "optional_params"    => rt.optional_params - actual_params.keys,
+            "options"            => rt.options
+          }
+        })
     end
   end
 end

data/test/test_resource_template.rb

@@ -99,4 +99,33 @@ class TestResourceTemplate < Test::Unit::TestCase
       ResourceTemplate.new.path_for({}) # no path_template
     end
   end
+  
+  def test_parent
+    assert_equal("user", user_articles.parent.name)
+    assert_equal("users", user_articles.parent.parent.name)
+    assert_nil(user_articles.parent.parent.parent)
+  end
+  
+  def test_expand_links
+    assert_equal(
+      [
+        {
+          "name"            => "new_user_article",
+          "options"         => ["GET"],
+          "path_template"   => "/users/dojo/articles/new{-prefix|.|format}",
+          "uri_template"    => "http://localhost:3000/users/dojo/articles/new{-prefix|.|format}",
+          "rel"             => "new_user_article",
+          "optional_params" => ["format"]
+        },
+        {
+          "name"            => "recent_user_articles",
+          "options"         => ["GET"],
+          "path_template"   => "/users/dojo/articles/recent{-prefix|.|format}",
+          "uri_template"    => "http://localhost:3000/users/dojo/articles/recent{-prefix|.|format}",
+          "rel"             => "recent",
+          "optional_params" => ["format"]
+        }
+      ],
+      user_articles.resource_templates.expand_links({'user_id' => 'dojo'}).to_parsed)
+  end
 end

data/test_rails_app/app/controllers/application_controller.rb

@@ -1,8 +1,15 @@
+require 'described_routes/helpers/described_routes_helper'
+
 # Filters added to this controller apply to all controllers in the application.
 # Likewise, all the methods added will be available for all controllers.
-
 class ApplicationController < ActionController::Base
   helper :all # include all helpers, all the time
+  include DescribedRoutes::DescribedRoutesHelper
+  helper DescribedRoutes::DescribedRoutesHelper
+
+  before_filter :set_link_header
+  layout "default"
+  
   protect_from_forgery # See ActionController::RequestForgeryProtection for details
 
   # Scrub sensitive parameters from your log

data/test_rails_app/app/controllers/users_controller.rb

@@ -0,0 +1,9 @@
+class UsersController < ApplicationController
+  def index
+    render :text => "<h1>index</h1>", :layout => true
+  end
+
+  def show
+    render :text => "<h1>show #{params[:id]}</h1>", :layout => true
+  end
+end

data/test_rails_app/app/controllers/welcome_controller.rb

@@ -0,0 +1,9 @@
+class WelcomeController < ApplicationController
+  def index
+    render :text => "<h1>index</h1>", :layout => true
+  end
+
+  def show
+    render :text => "<h1>show #{params[:id]}</h1>", :layout => true
+  end
+end

data/test_rails_app/app/views/layouts/default.html.erb

@@ -0,0 +1,9 @@
+<html>
+<head>
+<title>A test page with links</title>
+<%= link_elements %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/test_rails_app/test/integration/headers_test.rb

@@ -0,0 +1,38 @@
+require 'test/test_helper'
+
+class DescribedRoutesRunTimeTest < ActionController::IntegrationTest
+  def test_root_headers
+    get "/"
+    assert_equal(
+      '<http://www.example.com/>; rel="self"; type="http://www.example.com/described_routes#root", ' +
+      '<http://www.example.com/described_routes>; rel="describedby"; type="http://www.example.com/described_routes#ResourceTemplate", ' +
+      '<http://www.example.com/admin/products>; rel="http://www.example.com/described_routes#admin_products"; type="http://www.example.com/described_routes#admin_products", ' +
+      '<http://www.example.com/described_routes>; rel="http://www.example.com/described_routes#described_routes"; type="http://www.example.com/described_routes#described_routes", ' +
+      '<http://www.example.com/pages>; rel="http://www.example.com/described_routes#pages"; type="http://www.example.com/described_routes#pages", ' +
+      '<http://www.example.com/users>; rel="http://www.example.com/described_routes#users"; type="http://www.example.com/described_routes#users"',
+      headers["Link"])
+  end
+
+  def test_users_headers
+    get "/users"
+    assert_equal(
+      '<http://www.example.com/users>; rel="self"; type="http://www.example.com/described_routes#users", ' +
+      '<http://www.example.com/described_routes/users>; rel="describedby"; type="http://www.example.com/described_routes#ResourceTemplate", ' +
+      '<http://www.example.com/>; rel="up"; type="http://www.example.com/described_routes#root", ' +
+      '<http://www.example.com/users/new>; rel="http://www.example.com/described_routes/users#new_user"; type="http://www.example.com/described_routes#new_user"',
+      headers["Link"])
+  end
+
+  def test_user_headers
+    get "/users/dojo"
+    assert_equal(
+      '<http://www.example.com/users/dojo>; rel="self"; type="http://www.example.com/described_routes#user", ' +
+      '<http://www.example.com/described_routes/user>; rel="describedby"; type="http://www.example.com/described_routes#ResourceTemplate", ' +
+      '<http://www.example.com/described_routes/user?user_id=dojo>; rel="describedby"; type="http://www.example.com/described_routes#ResourceTemplate", ' +
+      '<http://www.example.com/users>; rel="up"; type="http://www.example.com/described_routes#users", ' +
+      '<http://www.example.com/users/dojo/edit>; rel="edit"; rel="http://www.example.com/described_routes/user#edit"; type="http://www.example.com/described_routes#edit_user", ' +
+      '<http://www.example.com/users/dojo/articles>; rel="http://www.example.com/described_routes/user#articles"; type="http://www.example.com/described_routes#user_articles", ' +
+      '<http://www.example.com/users/dojo/profile>; rel="http://www.example.com/described_routes/user#profile"; type="http://www.example.com/described_routes#user_profile"',
+      headers["Link"])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: described_routes
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Mike Burrows
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-25 00:00:00 +01:00
+date: 2009-06-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,9 +43,7 @@ dependencies:
         version: 1.8.0
     version: 
 description: |-
-  Framework-neutral metadata, describing (among other things) your Rails routes in JSON, YAML, XML and plain text formats.
-  
-  Also the home (for now at least) of the ResourceTemplate class.
+  Dynamic, framework-neutral metadata describing path/URI structures, with natural translations to/from JSON, YAML and XML.  Bonus features: easy Rails integration, link element / link header generation and a plain text report format!
   
   See roadmap for described_routes and path-to[http://github.com/asplake/path-to/tree] at http://positiveincline.com/?p=213.
 email: 
@@ -67,6 +65,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/described_routes.rb
+- lib/described_routes/helpers/described_routes_helper.rb
 - lib/described_routes/rails_controller.rb
 - lib/described_routes/rails_routes.rb
 - lib/described_routes/rake_task_methods.rb
@@ -81,7 +80,10 @@ files:
 - test/test_resource_template.rb
 - test_rails_app/Rakefile
 - test_rails_app/app/controllers/application_controller.rb
+- test_rails_app/app/controllers/users_controller.rb
+- test_rails_app/app/controllers/welcome_controller.rb
 - test_rails_app/app/helpers/application_helper.rb
+- test_rails_app/app/views/layouts/default.html.erb
 - test_rails_app/config/boot.rb
 - test_rails_app/config/environment.rb
 - test_rails_app/config/environments/development.rb
@@ -105,6 +107,7 @@ files:
 - test_rails_app/test/fixtures/run_time/described_routes.xml
 - test_rails_app/test/fixtures/run_time/described_routes.yaml
 - test_rails_app/test/integration/described_routes_run_time_test.rb
+- test_rails_app/test/integration/headers_test.rb
 - test_rails_app/test/integration/rake_tasks_test.rb
 - test_rails_app/test/test_helper.rb
 has_rdoc: true
@@ -132,10 +135,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: describedroutes
-rubygems_version: 1.3.3
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: Framework-neutral metadata, describing (among other things) your Rails routes in JSON, YAML, XML and plain text formats
+summary: Dynamic, framework-neutral metadata describing path/URI structures, with natural translations to/from JSON, YAML and XML
 test_files: 
 - test/test_described_routes.rb
 - test/test_helper.rb