riik 0.2.0

data/.gitignore

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

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: "bundle exec rake spec"

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--markup-provider redcarpet

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in riik.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,15 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'ctags-bundler' do
+  watch(%r{^(app|lib)/.*\.rb$})  { ["lib"] }
+end
+
+guard 'yard' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+  watch(%r{ext/.+\.c})
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Critical Pair.
+
+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.markdown

@@ -0,0 +1,50 @@
+Riik
+====
+
+Lightweight object mapper for Riak.
+
+Motivation
+==========
+
+Riik doesn't support everything you would exepct from a full ORM.  There
+are no validations, no callbacks, and no error handling, as the primary
+motivation was providing an extremely thin abstraction over RObject
+allowing you to map an objects serialized fields into keys.  The
+benefits come from being able to work with a lightweight abstraction
+without dependencies on larger, external gems, such as activesupport and
+activemodel.
+
+If you're building an entire site with Riak as the primary data store,
+you should be looking at [Ripple](https://github.com/seancribbs/ripple).
+
+If you're looking at building a gem or Ruby application that needs to
+write serialized objects directly to Riak without any overhead, look no
+further.
+
+Usage 
+=====
+
+To define a class:
+
+```ruby
+class Person
+  include Riik::Document
+
+  property :first_name
+  property :last_name
+end
+```
+
+To use:
+
+```ruby
+p = Person.new(:first_name => 'Fat', :last_name => 'Mike')
+p.save # => true
+p.destroy # => true
+Person.find(p.key) # => p
+```
+
+License
+=======
+
+Riik is Copyright © 2011 Critical Pair.  Riik is free software, and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rdoc/task'
+require 'rake/clean'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'rdoc'
+require 'yard'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--no-private']
+end
+
+task :default => [:spec]

data/config/tddium.yml

@@ -0,0 +1,2 @@
+:tddium:
+  :riak: true

data/lib/riik.rb

@@ -0,0 +1,38 @@
+require 'riik/version'
+require 'riak'
+
+# Riik is a lightweight object mapper for Riak.
+#
+# To define a class:
+#
+# ```ruby
+# class Person
+#   include Riik::Document
+# 
+#   property :first_name
+#   property :last_name
+# end
+# ```
+# 
+# To use:
+#
+# ```ruby
+# p = Person.new(:first_name => 'Fat', :last_name => 'Mike')
+# p.save # => true
+# p.destroy # => true
+# Person.find(p.key) # => p
+# ```
+#
+module Riik
+  autoload :Document, 'riik/document'
+
+  class << self
+    def client=(client)
+      @client = client
+    end
+
+    def client
+      @client ||= Riak::Client.new
+    end
+  end
+end

data/lib/riik/document.rb

@@ -0,0 +1,116 @@
+module Riik
+
+  # Document is the base object for the Riik ORM.  Including it provides
+  # the basic functionality for assigning attributes to models,
+  # assigning a bucket name, and serializing objects.
+  #
+  module Document
+    autoload :Persistence, 'riik/document/persistence'
+    autoload :Finders,     'riik/document/finders'
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+
+      base.send :include, Finders
+      base.send :include, Persistence
+    end
+
+    module ClassMethods
+
+      # List of model properties that should be assigned from the attributes
+      # hash.
+      #
+      attr_reader :riik_attributes
+
+      # Create accessors for each of the properties of the model.
+      #
+      # @private
+      #
+      def property(attribute)
+        @riik_attributes ||= []
+        @riik_attributes << attribute
+
+        attr_accessor attribute
+      end
+
+      # Returns the Riak bucket for this object.
+      #
+      # @return [Riak::Bucket]
+      #
+      def bucket
+        @bucket ||= Riik.client.bucket(bucket_name)
+      end
+
+      # Returns the bucket name for this object.  Override in your class
+      # to change.
+      #
+      # @return [String] bucket name.
+      #
+      def bucket_name
+        self.to_s.gsub(/::/, '_').downcase
+      end
+    end
+
+    # Assign model attributes through initialization hash.
+    #
+    # @param [Hash] attributes
+    #
+    def initialize(attributes = {})
+      attributes.symbolize_keys.each do |key, value|
+        if riik_attributes.include?(key)
+          instance_variable_set "@#{key}", value
+        end
+      end
+    end
+
+    # Serialize the attributes of this model.
+    #
+    # @return [Hash] serialized attributes.
+    # @private
+    #
+    def attributes
+      Hash[riik_attributes.zip(riik_attributes.map { |attr| instance_variable_get "@#{attr}" })]
+    end
+
+    # Return the riik attribute list for this class.
+    #
+    # @return [Array] symbols for each model property.
+    # @private
+    #
+    def riik_attributes
+      self.class.riik_attributes
+    end
+
+    # Return the bucket for this class.
+    #
+    # @return [Riak::Bucket]
+    #
+    def bucket
+      self.class.bucket
+    end
+
+    # Delegate the object key to the Riak object.
+    # 
+    # @return [String]
+    #
+    def key
+      robject.key
+    end
+
+    # Store the current Riak client object.
+    #
+    attr_accessor :robject
+
+    # Create or return the current Riak client object.
+    #
+    # @return [Riak::RObject]
+    # @private
+    #
+    def robject
+      @robject ||= Riak::RObject.new(bucket).tap do |object|
+        object.content_type = "application/json"
+      end
+    end
+  end
+
+end

data/lib/riik/document/finders.rb

@@ -0,0 +1,40 @@
+module Riik
+  module Document
+
+    # Finders provide methods to find objects in Riak.
+    #
+    module Finders
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        # Find an object by key.
+        #
+        # @return [Object] instance of the object, if found, else nil.
+        #
+        def find(key)
+          if robject = get(key)
+            self.new(robject.data).tap do |object|
+              object.robject = robject
+            end
+          else
+            nil
+          end
+        end
+
+        # Get the key from Riak.
+        #
+        # @return [Riak::RObject] 
+        # @private
+        #
+        def get(key)
+          bucket.get(key)
+        end
+        private :get
+      end
+    end
+
+  end
+end

data/lib/riik/document/persistence.rb

@@ -0,0 +1,44 @@
+module Riik
+  module Document
+
+    # Persistence provides methods for creating and saving documents to
+    # Riak.
+    #
+    module Persistence
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        # Create a new object from provided attributes.
+        #
+        # @return [Object] instance of created object.
+        #
+        def create(attributes = {})
+          self.new(attributes).tap do |object|
+            object.save
+          end
+        end
+      end
+
+      # Save the object to Riak.
+      #
+      # @return [Boolean]
+      #
+      def save
+        robject.data = attributes
+        robject.store
+      end
+
+      # Destroy the object in Riak.
+      #
+      # @return [Boolean]
+      #
+      def destroy
+        robject.delete
+      end
+    end
+
+  end
+end

data/lib/riik/version.rb

@@ -0,0 +1,3 @@
+module Riik
+  VERSION = "0.2.0"
+end

data/riik.gemspec

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+$:.push File.expand_path("../lib", __FILE__)
+
+require "riik/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christopher Meiklejohn"]
+  gem.email         = ["cmeiklejohn@criticalpair.com"]
+  gem.description   = %q{Lightweight object mapper for Riak.}
+  gem.summary       = %q{Lightweight object mapper for Riak.}
+  gem.homepage      = "http://critialpair.com"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.name          = "riik"
+  gem.require_paths = ["lib"]
+  gem.version       = Riik::VERSION
+
+  gem.add_dependency('riak-client')
+  gem.add_dependency('excon')
+
+  gem.add_development_dependency('yard')
+  gem.add_development_dependency('rdoc')
+  gem.add_development_dependency('redcarpet')
+
+  gem.add_development_dependency('vcr')
+  gem.add_development_dependency('webmock')
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('rake','~> 0.9.2')
+
+  gem.add_development_dependency('ripple')
+
+  gem.add_development_dependency('guard')
+  gem.add_development_dependency('guard-rspec')
+  gem.add_development_dependency('guard-yard')
+  gem.add_development_dependency('guard-ctags-bundler')
+end

data/spec/fixtures/vcr_cassettes/creation_of_nonexistent_key.yml

@@ -0,0 +1,69 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://127.0.0.1:8098/
+    body: 
+    headers:
+      accept:
+      - multipart/mixed, application/json;q=0.7, */*;q=0.5
+      x-riak-clientid:
+      - jmE3aA==
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      vary:
+      - Accept
+      server:
+      - MochiWeb/1.1 WebMachine/1.9.0 (participate in the frantic)
+      link:
+      - </buckets>; rel="riak_kv_wm_buckets",</riak>; rel="riak_kv_wm_buckets",</buckets>;
+        rel="riak_kv_wm_index",</buckets>; rel="riak_kv_wm_keylist",</buckets>; rel="riak_kv_wm_link_walker",</riak>;
+        rel="riak_kv_wm_link_walker",</mapred>; rel="riak_kv_wm_mapred",</buckets>;
+        rel="riak_kv_wm_object",</riak>; rel="riak_kv_wm_object",</ping>; rel="riak_kv_wm_ping",</buckets>;
+        rel="riak_kv_wm_props",</stats>; rel="riak_kv_wm_stats"
+      date:
+      - Tue, 29 Nov 2011 05:43:22 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '366'
+    body: ! '{"riak_kv_wm_buckets":"/buckets","riak_kv_wm_buckets":"/riak","riak_kv_wm_index":"/buckets","riak_kv_wm_keylist":"/buckets","riak_kv_wm_link_walker":"/buckets","riak_kv_wm_link_walker":"/riak","riak_kv_wm_mapred":"/mapred","riak_kv_wm_object":"/buckets","riak_kv_wm_object":"/riak","riak_kv_wm_ping":"/ping","riak_kv_wm_props":"/buckets","riak_kv_wm_stats":"/stats"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://127.0.0.1:8098/riak/riik_person?returnbody=true
+    body: ! '{"first_name":"Fat","last_name":"Mike"}'
+    headers:
+      accept:
+      - multipart/mixed, application/json;q=0.7, */*;q=0.5
+      x-riak-clientid:
+      - jmE3aA==
+      content-type:
+      - application/json
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 201
+      message: Created
+    headers:
+      x-riak-vclock:
+      - a85hYGBgzGDKBVIcypz/fvodtcjOYEpkzGNl+PXG4wRfFgA=
+      vary:
+      - Accept-Encoding
+      server:
+      - MochiWeb/1.1 WebMachine/1.9.0 (participate in the frantic)
+      location:
+      - /riak/riik_person/UVYQ98eLNZNieppMGN5BcTwKpxC
+      link:
+      - </riak/riik_person>; rel="up"
+      date:
+      - Tue, 29 Nov 2011 05:43:22 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '39'
+    body: ! '{"first_name":"Fat","last_name":"Mike"}'
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/deletion_of_valid_key.yml

@@ -0,0 +1,28 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :delete
+    uri: http://127.0.0.1:8098/riak/riik_person/UVYQ98eLNZNieppMGN5BcTwKpxC
+    body: 
+    headers:
+      accept:
+      - multipart/mixed, application/json;q=0.7, */*;q=0.5
+      x-riak-clientid:
+      - jmE3aA==
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 204
+      message: No Content
+    headers:
+      vary:
+      - Accept-Encoding
+      server:
+      - MochiWeb/1.1 WebMachine/1.9.0 (participate in the frantic)
+      date:
+      - Tue, 29 Nov 2011 05:43:22 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '0'
+    body: 
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/loading_of_valid_key.yml

@@ -0,0 +1,63 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://127.0.0.1:8098/riak/riik_person/UVYQ98eLNZNieppMGN5BcTwKpxC
+    body: 
+    headers:
+      accept:
+      - multipart/mixed, application/json;q=0.7, */*;q=0.5
+      x-riak-clientid:
+      - jmE3aA==
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      x-riak-vclock:
+      - a85hYGBgzGDKBVIcypz/fvodtcjOYEpkzGNl+PXG4wRfFgA=
+      vary:
+      - Accept-Encoding
+      server:
+      - MochiWeb/1.1 WebMachine/1.9.0 (participate in the frantic)
+      link:
+      - </riak/riik_person>; rel="up"
+      last-modified:
+      - Sun, 27 Nov 2011 18:48:09 GMT
+      etag:
+      - ! '"3mkiscq9OZrqDd9HOz6l21"'
+      date:
+      - Tue, 29 Nov 2011 05:43:22 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '39'
+    body: ! '{"first_name":"Fat","last_name":"Mike"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://127.0.0.1:8098/riak/riik_person/invalid
+    body: 
+    headers:
+      accept:
+      - multipart/mixed, application/json;q=0.7, */*;q=0.5
+      x-riak-clientid:
+      - jmE3aA==
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 404
+      message: Object Not Found
+    headers:
+      server:
+      - MochiWeb/1.1 WebMachine/1.9.0 (participate in the frantic)
+      date:
+      - Tue, 29 Nov 2011 05:43:22 GMT
+      content-type:
+      - text/plain
+      content-length:
+      - '10'
+    body: ! 'not found
+
+'
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/updating_of_valid_key.yml

@@ -0,0 +1,38 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :put
+    uri: http://127.0.0.1:8098/riak/riik_person/UVYQ98eLNZNieppMGN5BcTwKpxC?returnbody=true
+    body: ! '{"first_name":"Eric","last_name":"Melvin"}'
+    headers:
+      accept:
+      - multipart/mixed, application/json;q=0.7, */*;q=0.5
+      x-riak-clientid:
+      - jmE3aA==
+      content-type:
+      - application/json
+      x-riak-vclock:
+      - a85hYGBgzGDKBVIcypz/fvodtcjOYEpkzGNl+PXG4wRfFgA=
+      link:
+      - ''
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      x-riak-vclock:
+      - a85hYGBgzGDKBVIcypz/fvodtcjOYEpkymNl+PXG4wRfFgA=
+      vary:
+      - Accept-Encoding
+      server:
+      - MochiWeb/1.1 WebMachine/1.9.0 (participate in the frantic)
+      link:
+      - </riak/riik_person>; rel="up"
+      date:
+      - Tue, 29 Nov 2011 05:43:22 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '42'
+    body: ! '{"first_name":"Eric","last_name":"Melvin"}'
+    http_version: '1.1'

data/spec/lib/performance_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'ripple'
+require 'benchmark'
+
+module Riik
+
+  class RiikDocument; include Riik::Document; property :number; end
+  class RippleDocument; include Ripple::Document; property :number, Integer; end
+
+  describe 'The performance' do 
+    before do 
+      WebMock.allow_net_connect!
+    end
+
+    after do 
+      WebMock.disable_net_connect!
+    end
+
+    context 'when creating one record' do 
+      it 'is faster than ripple' do 
+        ripple_time = Benchmark.realtime do 
+          RippleDocument.create(:number => 1)
+        end
+        riik_time = Benchmark.realtime do 
+          RiikDocument.create(:number => 1)
+        end
+        riik_time.should < ripple_time
+      end
+    end
+
+    context 'when creating 300 records' do 
+      it 'is faster than ripple' do 
+        ripple_time = Benchmark.realtime do 
+          300.times.each do |i|
+            RippleDocument.create(:number => i)
+          end
+        end
+        riik_time = Benchmark.realtime do 
+          300.times.each do |i|
+            RiikDocument.create(:number => i)
+          end
+        end
+        riik_time.should < ripple_time
+      end
+    end
+
+    context 'when creating 1000 records' do 
+      it 'is faster than ripple' do 
+        ripple_time = Benchmark.realtime do 
+          1000.times.each do |i|
+            RippleDocument.create(:number => i)
+          end
+        end
+        riik_time = Benchmark.realtime do 
+          1000.times.each do |i|
+            RiikDocument.create(:number => i)
+          end
+        end
+        riik_time.should < ripple_time
+      end
+    end
+  end
+
+end

data/spec/lib/riik/document/finders_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module Riik
+  module Document
+    describe Finders do
+      context 'when finding a valid key' do
+        subject { person }
+
+        let(:preexisting_record) do
+          VCR.use_cassette('creation_of_nonexistent_key') do
+            Person.create(attributes)
+          end
+        end
+
+        let(:attributes) do
+          { :first_name => 'Fat', :last_name => 'Mike' }
+        end
+
+        it 'can be found' do
+          VCR.use_cassette('loading_of_valid_key') do
+            Person.find(preexisting_record.key).should be_an_instance_of(Person)
+          end
+        end
+
+        context 'when found' do
+          let(:person) do
+            VCR.use_cassette('loading_of_valid_key') do
+              Person.find(preexisting_record.key)
+            end
+          end
+
+          it 'sets the riak client object' do
+            subject.robject.should be_an_instance_of(Riak::RObject)
+          end
+
+          it 'set the model attributes' do
+            attributes.each do |key, value|
+              subject.send(key).should == value
+            end
+          end
+        end
+
+        context 'when not found' do 
+          let(:person) do
+            VCR.use_cassette('loading_of_valid_key') do
+              Person.find('invalid')
+            end
+          end
+
+          it 'returns nil if it can not be found' do
+            expect { subject.should be_nil }.to raise_error
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/riik/document/persistence_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+module Riik
+  module Document
+    describe Persistence do
+      subject { person }
+
+      context 'when creating' do 
+        let(:person) { Person } 
+
+        let(:attributes) do 
+          { :first_name => 'Fat', :last_name => 'Mike' }
+        end
+
+        it 'can be created' do 
+          VCR.use_cassette('creation_of_nonexistent_key') do 
+            subject.create(attributes).should be_an_instance_of(Person)
+          end
+        end
+
+        context 'once created' do 
+          let(:person) do 
+            VCR.use_cassette('creation_of_nonexistent_key') do 
+              Person.create(attributes)
+            end
+          end
+
+          it 'should exist in riak correctly' do
+            VCR.use_cassette('loading_of_valid_key') do 
+              subject.bucket.get(subject.key).should be_an_instance_of(Riak::RObject)
+
+              attributes.each do |key, value|
+                subject.send(key).should == value
+              end
+            end
+          end
+
+          it 'can be updated' do 
+            VCR.use_cassette('updating_of_valid_key') do 
+              subject.first_name = 'Eric'
+              subject.last_name  = 'Melvin'
+              subject.save
+            end
+          end
+
+          it 'can be destroyed' do 
+            VCR.use_cassette('deletion_of_valid_key') do 
+              subject.destroy
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/riik/document_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module Riik
+  describe Document do 
+    subject { person }
+
+    let(:person) { Person }
+
+    it 'contains a bucket name derived from the name' do
+      subject.bucket_name.should == "riik_person"
+    end
+
+    it 'contains a bucket' do
+      subject.bucket.should be_an_instance_of(Riak::Bucket)
+    end
+
+    context 'an empty document' do 
+      let(:person) { Person.new } 
+
+      it 'knows its properties' do 
+        [:first_name, :last_name].each do |attr|
+          subject.class.riik_attributes.should include(attr)
+        end
+      end
+
+      it 'responds to properties' do 
+        [:first_name, :last_name].each do |attr|
+          subject.should respond_to(attr)
+        end
+      end
+
+      it 'contains a robject of content type json' do 
+        subject.robject.should be_an_instance_of(Riak::RObject)
+        subject.robject.content_type.should == "application/json"
+      end
+    end
+
+    context 'with some attributes' do 
+      let(:person) { Person.new(attributes) } 
+
+      let(:attributes) do 
+        { :first_name => 'Fat', :last_name => 'Mike' }
+      end
+
+      it 'assigns properties through an attributes hash' do
+        attributes.each do |key, value|
+          subject.send(key).should == value
+        end
+      end
+
+      it 'has a valid attributes hash' do
+        attributes.should == subject.attributes
+      end
+    end
+  end
+end

data/spec/lib/riik_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module Riik
+  describe self do
+    subject { Riik } 
+
+    let(:client) { Riak::Client.new }
+
+    it 'has a client' do 
+      subject.client.should be_a_kind_of(Riak::Client)
+    end
+
+    it 'has a client that can be set' do
+      subject.client = client
+      subject.client.should == client
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+PROJECT_ROOT = File.expand_path("../..", __FILE__)
+$LOAD_PATH << File.join(PROJECT_ROOT, "lib")
+
+Bundler.require
+
+require 'riik'
+
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.stub_with :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+end
+
+# Test class.
+#
+module Riik
+  class Person
+    include Riik::Document
+
+    property :first_name
+    property :last_name
+  end
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: riik
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Meiklejohn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riak-client
+  requirement: &11983080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11983080
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: &11982220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11982220
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &11981240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11981240
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &11980600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11980600
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &11980100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11980100
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &11979540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11979540
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &11979020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11979020
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11978500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11978500
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &11977820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *11977820
+- !ruby/object:Gem::Dependency
+  name: ripple
+  requirement: &11977240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11977240
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &12025440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12025440
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &12024880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12024880
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: &12024380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12024380
+- !ruby/object:Gem::Dependency
+  name: guard-ctags-bundler
+  requirement: &12023860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12023860
+description: Lightweight object mapper for Riak.
+email:
+- cmeiklejohn@criticalpair.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- config/tddium.yml
+- lib/riik.rb
+- lib/riik/document.rb
+- lib/riik/document/finders.rb
+- lib/riik/document/persistence.rb
+- lib/riik/version.rb
+- riik.gemspec
+- spec/fixtures/vcr_cassettes/creation_of_nonexistent_key.yml
+- spec/fixtures/vcr_cassettes/deletion_of_valid_key.yml
+- spec/fixtures/vcr_cassettes/loading_of_valid_key.yml
+- spec/fixtures/vcr_cassettes/updating_of_valid_key.yml
+- spec/lib/performance_spec.rb
+- spec/lib/riik/document/finders_spec.rb
+- spec/lib/riik/document/persistence_spec.rb
+- spec/lib/riik/document_spec.rb
+- spec/lib/riik_spec.rb
+- spec/spec_helper.rb
+homepage: http://critialpair.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3432467302917107998
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3432467302917107998
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Lightweight object mapper for Riak.
+test_files: []
+has_rdoc: