/basic_model

A very thin wrapper around CouchRest, for use with CouchDB and Ruby on Rails.

Primary LanguageRuby

= BasicModel

* http://github.com/topfunky/basic_model (url)

== DESCRIPTION:

A very thin wrapper around CouchRest, for use with CouchDB.

== FEATURES/PROBLEMS:

* Usable with Rails in place of ActiveRecord (for forms and URLs)

== SYNOPSIS:

Subclass BasicModel. See the rdoc in basic_model.rb for examples.

  class Event < BasicModel
  
    def default_attributes
      {:some => "defaults"}
    end
    
    def on_update
      # Process @attributes before saving
    end
  
  end

== REQUIREMENTS:

* jchris-couchrest gem
* RestClient from Adam Wiggins of Heroku

== INSTALL:

* sudo gem install jchris-couchrest -a http://gems.github.com

== LICENSE:

(The MIT License)

Copyright (c) 2008 Topfunky Corporation

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.