riak-shim 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in riak-shim.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Brodhead & Ines Sombra
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,31 @@
+# Riak::Shim
+
+A teeny shim between your code and the riak-client gem.  Reads database configuration
+out of config/database.yml and derives bucket names from your class names and an
+appropriate prefix.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'riak-shim'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install riak-shim
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/riak-shim/core_ext.rb

@@ -0,0 +1,12 @@
+## taken from active support, but don't want all the baggage...
+## converts camel case to all lower case name delimited by underscores
+## for bucket name prettyness
+class String
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+end

data/lib/riak-shim/persistable.rb

@@ -0,0 +1,72 @@
+module Riak
+  module Shim
+
+    module Persistable
+      attr_writer :store
+
+      def bucket
+        return self.class.store.bucket(bucket_name)
+      end
+
+      def bucket_name
+        self.class.bucket_name
+      end
+
+      def store
+        self.class.store
+      end
+
+      def save
+        doc = bucket.get_or_new(key)
+        doc.data = to_hash
+        set_indexes(doc.indexes)
+        doc.store
+        self
+      end
+
+      def set_indexes(indexes)
+        indexes.clear
+        fields_to_index.each do |field|
+          index_name = "#{field}_bin"
+          index_value = send(field)
+          indexes[index_name] << index_value
+        end
+      end
+
+      module ClassMethods
+        def delete_all
+          bucket.keys.each do |key|
+            bucket.delete key
+          end
+        end
+
+        def store
+          @store ||= Store.new
+        end
+
+        def bucket_name
+          myclass = self.to_s.underscore
+          "#{store.bucket_prefix}#{myclass}"
+        end
+
+        def bucket
+          return store.bucket(bucket_name)
+        end
+
+        def for_index(index, value)
+          bucket.get_index(index, value).map do |key|
+            from_hash(key)
+          end
+        end
+
+        def gen_key
+          UUIDTools::UUID.random_create.to_s
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/riak-shim/store.rb

@@ -0,0 +1,39 @@
+require 'riak'
+require 'uuidtools'
+
+module Riak
+  module Shim
+
+    class Store
+      attr_writer :config_location
+      attr_reader :riak
+
+      def config
+        env = ENV['RACK_ENV'] || 'test'
+        @config ||= read_config[env]
+      end
+
+      def read_config
+        YAML.load_file(config_location)
+      end
+
+      def config_location
+        @config_location ||= 'config/database.yml'
+      end
+
+      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']}])
+      end
+
+      def bucket(name)
+        riak.bucket(name)
+      end
+    end
+
+  end
+end

data/lib/riak-shim/version.rb

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

data/lib/riak-shim.rb

@@ -0,0 +1,10 @@
+require "riak-shim/version"
+require "riak-shim/persistable"
+require "riak-shim/store"
+require "riak-shim/core_ext"
+
+module Riak
+  module Shim
+
+  end
+end

data/riak-shim.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/riak-shim/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Brodhead & Shai Rosenfeld"]
+  gem.email         = ["mkb@engineyard.com"]
+  gem.description   = %q{Riak shim for bucket names 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.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "riak-shim"
+  gem.require_paths = ["lib"]
+  gem.version       = Riak::Shim::VERSION
+
+  gem.add_dependency 'riak-client'
+  gem.add_dependency 'uuidtools'
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/spec/persistable_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'riak-shim/persistable'
+
+class PersistableTester
+  include Riak::Shim::Persistable
+end
+
+describe 'persistable' do
+  let(:persistable) { PersistableTester.new }
+
+  before do
+    Riak::Shim::Store.any_instance.stub(:read_config).and_return(DB_CONFIG)
+  end
+
+  describe '#bucket_name' do
+    it 'composes #db_name and class name' do
+      persistable.bucket_name.should == 'test_persistable_tester'
+    end
+  end
+
+  describe '#bucket' do
+    it 'returns the correct bucket' do
+      persistable.bucket.name.should == 'test_persistable_tester'
+    end
+  end
+
+  describe '#store' do
+    it 'returns a something that provides buckets' do
+      persistable.store.should respond_to(:bucket)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$: << './lib'
+require 'riak-shim'
+
+DB_CONFIG = { 'development' => { 'bucket_prefix' => 'dev_', 'host' => "localhost", 'http_port' => 8098},
+    'test' => {'bucket_prefix' => 'test_', 'host' => "localhost", 'http_port' => 8098 }}

data/spec/store_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'riak-shim/store'
+
+describe Riak::Shim::Store do
+  let(:store) { Riak::Shim::Store.new }
+
+
+  describe '#config_location' do
+    it 'keeps a path of the database config file' do
+      path = store.config_location
+      path.should_not be_nil
+    end
+  end
+
+  context 'with test config' do
+    before do
+      tmpdir = Dir.tmpdir
+      FileUtils.cp('./spec/support/database.yml', tmpdir)
+      store.stub(:config_location).and_return("#{tmpdir}/database.yml")
+    end
+
+    describe '#read_config' do
+      it 'reads yaml from config_location' do
+        store.read_config.should == DB_CONFIG
+      end
+    end
+
+    describe '#config' do
+      context 'with RACK_ENV=test' do
+        before do
+          @stashed_rack_env = ENV['RACK_ENV']
+          ENV['RACK_ENV'] = 'test'
+        end
+
+        after do
+          ENV['RACK_ENV'] = @stashed_rack_env
+        end
+
+        it "says prefix is test_" do
+          store.config['bucket_prefix'].should == 'test_'
+        end
+      end
+    end
+
+    describe '#bucket_prefix' do
+      it 'uses the prefix from the config' do
+        store.bucket_prefix.should == 'test_'
+      end
+    end
+  end
+end

data/spec/support/database.yml

@@ -0,0 +1,9 @@
+development: &default
+  bucket_prefix: dev_
+  host: localhost
+  http_port: 8098
+
+test:
+  <<: *default
+  bucket_prefix: test_
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: riak-shim
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Brodhead & Shai Rosenfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-11 00:00:00 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"
+  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"
+  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"
+  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"
+  type: :development
+  version_requirements: *id004
+description: Riak shim for bucket names and config.
+email: 
+- mkb@engineyard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/riak-shim.rb
+- lib/riak-shim/core_ext.rb
+- lib/riak-shim/persistable.rb
+- lib/riak-shim/store.rb
+- lib/riak-shim/version.rb
+- riak-shim.gemspec
+- spec/persistable_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+- spec/support/database.yml
+homepage: https://github.com/mkb/riak-shim
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      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: 
+- spec/persistable_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+- spec/support/database.yml