classproxy 0.7.0 → 0.7.1

data/README.md

@@ -1,7 +1,7 @@
 class-proxy
 ===========
 
-A generic (yet ActiveRecord compliant) class proxy to setup proxy methods for your classes.
+A generic (ActiveRecord compatible) class proxy to setup proxy methods for your classes.
 
 ## Using
 
@@ -10,6 +10,35 @@ provided by this gem.
 
 ### Example
 
+#### Basic example
+
+```ruby
+class UserDb
+  include MongoMapper::Document
+  include ClassProxy
+
+  primary_fetch  { |args| where(args).first or (raise NotFound) }
+  fallback_fetch { |args| Octokit.user(args[:login]) }
+
+  key :name, String
+  key :login, String
+end
+```
+
+```ruby
+> user = UserDb.fetch(login: 'heelhook')
+=> #<UserDb _id: 779813, name: "Pablo Fernandez", login: "heelhook">
+```
+
+In this example the database will be hit with a `where(login: 'heelhook')` and
+if it comes back empty `Octokit` will be used to retrieve the information requested.
+
+The default action (overwritten with `after_fallback_fetch`, not used in this example)
+is to return a new object of the parent class (`UserDb`) with the proper keys set,
+in this example `:id`, `:name` and `:login`.
+
+#### Detailed example
+
 ```ruby
 class UserDb
   include MongoMapper::Document

data/lib/classproxy/version.rb

@@ -1,3 +1,3 @@
 module ClassProxy
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: classproxy
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -55,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1757276134507409389
+      hash: 1986855267871768364
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: