riak-shim 0.0.1 → 0.0.2

data/README.md

@@ -4,6 +4,8 @@ A teeny shim between your code and the riak-client gem.  Reads database configur
 out of config/database.yml and derives bucket names from your class names and an
 appropriate prefix.
 
+Riak is a database from the good people at Basho.  Check it out:  http://basho.com/products/riak-overview/
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +22,38 @@ Or install it yourself as:
 
 ## Usage
 
+Create a config/database.yml containing the details of your Riak like so:
+
+  development: &default
+    bucket_prefix: dev_
+    host: localhost
+    http_port: 8098
+
+  test:
+    <<: *default
+    bucket_prefix: test_
+
+In any class you wish to persist:
+  include Riak::Shim::Persistable
+
+  def to_hash
+    # Return hashified version of your class
+  end
+
+  def fields_to_index
+    # Return an Array of hash keys you would like placed into a secondary index.
+    # Return an empty Array if you don't know what this means.  :)
+  end
 
+Now you can save instances of that class by calling #save on them and retrieve them from Riak by calling
+
+  YourClass.for_index(index_name, value)
+
+Where `index_name` is what you defined in `fields_to_index` plus the suffix "_bin" .
+
+The `value` is what you want to look up.
+
+Return value is an Array of instances of your class matching the query.
 
 ## Contributing
 
@@ -29,3 +62,7 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## TODOS
+
+- Implement a #for_key lookup method.

data/lib/riak-shim/persistable.rb

@@ -3,6 +3,11 @@ module Riak
 
     module Persistable
       attr_writer :store
+      attr_accessor :key
+
+      def key
+        @key ||= gen_key
+      end
 
       def bucket
         return self.class.store.bucket(bucket_name)

data/lib/riak-shim/version.rb

@@ -1,5 +1,5 @@
 module Riak
   module Shim
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: riak-shim
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Brodhead & Shai Rosenfeld