= omnivorous_etag
http://github.com/julik/omnivorous_etag
== DESCRIPTION:
ETags are good, however normally they are generated based on strings. However, very often it is easier
to pass in a complete model object as your ETag, or it's parametrized represenation (record id) together
with the version. Or an array of objects (if you want to cache your object listing page and prevent it
from spending time on template rendering).
This module will take care of transforming any object into a stringified representation that is usable as an etag
with minimum fuss.
== SYNOPSIS:
In the body of your Sinatra application or any other web application responder class that
has to send ETags
include OmnivorousEtag
If the superclass of your request handler has an etag method this method will be called with the stringified
result of the omnivirous etag generation (so that for example the request can be 304-terminated).
== REQUIREMENTS:
* FIX (list of requirements)
== INSTALL:
* FIX (sudo gem install, anything else)
== LICENSE:
(The MIT License)
Copyright (c) 2011 [email protected]
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://github.com/julik/omnivorous_etag
== DESCRIPTION:
ETags are good, however normally they are generated based on strings. However, very often it is easier
to pass in a complete model object as your ETag, or it's parametrized represenation (record id) together
with the version. Or an array of objects (if you want to cache your object listing page and prevent it
from spending time on template rendering).
This module will take care of transforming any object into a stringified representation that is usable as an etag
with minimum fuss.
== SYNOPSIS:
In the body of your Sinatra application or any other web application responder class that
has to send ETags
include OmnivorousEtag
If the superclass of your request handler has an etag method this method will be called with the stringified
result of the omnivirous etag generation (so that for example the request can be 304-terminated).
== REQUIREMENTS:
* FIX (list of requirements)
== INSTALL:
* FIX (sudo gem install, anything else)
== LICENSE:
(The MIT License)
Copyright (c) 2011 [email protected]
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.