riak-shim 0.0.4 → 0.0.5

data/.gitignore

@@ -2,17 +2,10 @@
 *.rbc
 .bundle
 .config
-.yardoc
+.rspec
 Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
-lib/bundler/man
 pkg
-rdoc
 spec/reports
-test/tmp
-test/version_tmp
 tmp
 vendor/bundle

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/README.md

@@ -6,6 +6,9 @@ appropriate prefix.
 
 Riak is a database from the good people at Basho.  Check it out:  http://basho.com/products/riak-overview/
 
+[![Build Status](https://secure.travis-ci.org/mkb/riak-shim.png?branch=master)](http://travis-ci.org/mkb/riak-shim)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,34 +27,58 @@ Or install it yourself as:
 
 Create a config/database.yml containing the details of your Riak like so:
 
-  development: &default
-    bucket_prefix: dev_
-    host: localhost
-    http_port: 8098
+    development: &default
+      bucket_prefix: dev_
+      host: localhost
+      http_port: 8098
+
+    test:
+      <<: *default
+      bucket_prefix: test_
+
+## Converting a model to use Riak
+
+In any class you wish to persist, you must include the module:
+
+    require 'riak-shim'
+    include Riak::Shim::Persistable
 
-  test:
-    <<: *default
-    bucket_prefix: test_
+Then, write a #to_hash method which returns a hash representing your object (and consequently, what you are
+going to store):
 
-In any class you wish to persist:
-  include Riak::Shim::Persistable
+    def to_hash
+      # Return hashified version of your class
+    end
 
-  def to_hash
-    # Return hashified version of your class
-  end
+You'll use Class#from_hash to create an instance from the hash which was pulled from Riak:
 
-  def self.from_hash(key)
-    # Return a fresh instance of your class populated by the hash provided
-  end
+    def self.from_hash(data)
+      your_obj = new
+      your_obj.foo = data['foo']
+      # Return a fresh instance of your class populated by the hash provided
+      return your_obj
+    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
+You can now save instances of yoru class by calling #save and later retrieve them from Riak
+by calling...
 
-Now you can save instances of that class by calling #save on them and retrieve them from Riak by calling
+    YourClass.for_key(key)
 
-  YourClass.for_index(index_name, value)
+### Secondary indexes
+
+Secondary indexes in Riak allow you to query based on the contents of a particular field.  Define
+YourClass#fields_to_index and return the names of any fields you wish to query on.  When you #save
+an instance of YourClass, riak-shim will populate a secondary index for that field.
+
+    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
+
+You can now retrieve records based on the content of those fields by calling...
+The `for_index` method retrieves all records whose value for the given index matches.
+
+    YourClass.for_index(index_name, value)
 
 Where `index_name` is what you defined in `fields_to_index` plus the suffix "_bin" .
 
@@ -59,6 +86,7 @@ The `value` is what you want to look up.
 
 Return value is an Array of instances of your class matching the query.
 
+
 ## Contributing
 
 1. Fork it
@@ -69,7 +97,5 @@ Return value is an Array of instances of your class matching the query.
 
 ## TODOS
 
-- #from_hash does not work as advertised
-- Implement a #for_key lookup method
 - Examples directory
 - Revisit tests

data/lib/riak-shim/persistable.rb

@@ -1,6 +1,5 @@
 module Riak
   module Shim
-
     module Persistable
       attr_writer :store
       attr_accessor :key
@@ -50,11 +49,11 @@ module Riak
         end
 
         def bucket_name
-          myclass = de_cammel(self.to_s)
+          myclass = de_camel(self.to_s)
           "#{store.bucket_prefix}#{myclass}"
         end
 
-        def de_cammel(classname)
+        def de_camel(classname)
           classname.gsub(/::/, '__').
             gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
             gsub(/([a-z\d])([A-Z])/,'\1_\2').
@@ -66,9 +65,19 @@ module Riak
           return store.bucket(bucket_name)
         end
 
+        def for_key(key)
+          begin
+            raw = bucket.get(key)
+            data = raw.data
+            from_hash(data)
+          rescue Riak::HTTPFailedRequest
+            return nil
+          end
+        end
+
         def for_index(index, value)
           bucket.get_index(index, value).map do |key|
-            from_hash(key)
+            for_key(key)
           end
         end
 
@@ -82,4 +91,4 @@ module Riak
       end
     end
   end
-end
+end

data/lib/riak-shim/store.rb

@@ -3,10 +3,9 @@ require 'uuidtools'
 
 module Riak
   module Shim
-
     class Store
       attr_writer :config_location
-      attr_reader :riak
+      attr_writer :riak
 
       def config
         env = ENV['RACK_ENV'] || 'test'
@@ -24,7 +23,7 @@ module Riak
       def bucket_prefix
         return config['bucket_prefix']
       end
-      
+
       def riak
         @riak ||= Riak::Client.new(:http_backend => :Excon,
             :nodes => [{:host => config['host'], :http_port => config['http_port']}])
@@ -34,6 +33,5 @@ module Riak
         riak.bucket(name)
       end
     end
-
   end
-end
+end

data/lib/riak-shim/version.rb

@@ -1,5 +1,5 @@
 module Riak
   module Shim
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/riak-shim.rb

@@ -1,7 +1,6 @@
 require "riak-shim/version"
 require "riak-shim/persistable"
 require "riak-shim/store"
-require "riak-shim/core_ext"
 
 module Riak
   module Shim

data/riak-shim.gemspec

@@ -2,14 +2,14 @@
 require File.expand_path('../lib/riak-shim/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Michael Brodhead & Shai Rosenfeld"]
+  gem.authors       = ["Michael Brodhead, Shai Rosenfeld, and Larry Diehl"]
   gem.email         = ["mkb@engineyard.com"]
-  gem.description   = %q{Riak shim for bucket names and config.}
+  gem.description   = %q{Riak shim for bucket naming and config.}
   gem.summary       = %q{A tiny shim between you and riak-client. Reads config/database.yml and generates sensible bucket names.}
   gem.homepage      = "https://github.com/mkb/riak-shim"
 
   gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files.reject!   {|f| f =~ %r{^vendor}}
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "riak-shim"
   gem.require_paths = ["lib"]
@@ -22,4 +22,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "guard"
   gem.add_development_dependency "guard-rspec"
+
+  if RUBY_PLATFORM.include? 'darwin'
+    gem.add_development_dependency 'growl'
+    gem.add_development_dependency 'rb-fsevent'
+  end
 end

metadata

@@ -1,117 +1,153 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: riak-shim
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
-- Michael Brodhead & Shai Rosenfeld
+authors:
+- Michael Brodhead, Shai Rosenfeld, and Larry Diehl
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: riak-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: uuidtools
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: guard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-description: Riak shim for bucket names and config.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Riak shim for bucket naming and config.
+email:
 - mkb@engineyard.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -128,38 +164,30 @@ files:
 - spec/support/database.yml
 homepage: https://github.com/mkb/riak-shim
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A tiny shim between you and riak-client. Reads config/database.yml and generates sensible bucket names.
-test_files: 
+summary: A tiny shim between you and riak-client. Reads config/database.yml and generates
+  sensible bucket names.
+test_files:
 - spec/persistable_spec.rb
 - spec/spec_helper.rb
 - spec/store_spec.rb