hikki-mongo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1eccb282c442683c86df80e52682f941e917ab07
+  data.tar.gz: 47398297ba69d242726630ea455addb0ef99b032
+SHA512:
+  metadata.gz: bf3fbcbeaf1c272b3e49d3d6f2f077a7d3d8fbb5111a8c88ab38c50785288b4b5b98284922c187d916492b6306999db143f598012271c6cfa5256da6bf55b1e7
+  data.tar.gz: ccbcee27da2ca08f8eada4649179bf432b5a2651af67168ba65840db0c3a15f1c204ce0cdf599c8e1570210a1e822397258d8bab4db269bbcb6c98c700a4ca08

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hikki-mongo.gemspec
+gemspec
+
+# Grab Hikki from local relative
+gem 'hikki', path: '../../'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 alexpeachey
+
+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,44 @@
+# Hikki::Adapters::MongoAdapter
+
+A Mongo adapter for Hikki.
+It uses the `mongo` gem to communicate with Mongo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hikki-mongo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hikki-mongo
+
+## Usage
+
+By default, the adapter will use `Mongo::MongoClient.new` as it's connection which uses the defaults in that gem.
+You can pass in your own connection to use instead, useful for specifying a server and other options.
+
+```ruby
+# Use the default connection
+adapter = Hikki::Adapters::MongoAdapter.new
+
+# Use a specific connection
+mongo = Mongo::MongoClient.new("db.example.com", 27017)
+adapter = Hikki::Adapters::MongoAdapter.new(mongo)
+```
+
+If you do not specify an `id` when saving, the adapter will generate a `BSON::ObjectId`.
+
+## Contributing
+
+1. Fork it ( http://github.com/originate/hikki/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your specifications
+4. Implement your specifications
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hikki-mongo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+require File.expand_path('../../../lib/hikki/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hikki-mongo'
+  spec.version       = Hikki::VERSION
+  spec.authors       = ['alexpeachey']
+  spec.email         = ['alex.peachey@originate.com']
+  spec.summary       = 'A Mongo adapter for Hikki.'
+  spec.description   = 'A Mongo adapter for Hikki.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hikki', Hikki::VERSION
+  spec.add_dependency 'mongo'
+  spec.add_dependency 'bson_ext'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/hikki/adapters/mongo_adapter.rb

@@ -0,0 +1,22 @@
+require 'mongo'
+require 'hikki'
+require_relative './mongo_collection'
+
+module Hikki
+  module Adapters
+    class MongoAdapter < Hikki::Adapters::Adapter
+      attr_reader :connection, :db, :uuid_generator
+
+      def initialize(connection=Mongo::MongoClient.new, db=connection['hikki'], uuid_generator=BSON::ObjectId)
+        super()
+        @connection = connection
+        @db = db
+        @uuid_generator = uuid_generator
+      end
+
+      def collection_for(collection)
+        collections.fetch(collection, MongoCollection.new(collection, connection, db, uuid_generator))
+      end
+    end
+  end
+end

data/lib/hikki/adapters/mongo_collection.rb

@@ -0,0 +1,86 @@
+module Hikki
+  module Adapters
+    class MongoCollection < Hikki::Collection
+      attr_reader :connection, :db, :uuid_generator
+
+      def initialize(collection, connection, db, uuid_generator)
+        super(collection)
+        @connection = connection
+        @db = db
+        @uuid_generator = uuid_generator
+      end
+
+      def index(field)
+        db[collection].create_index(field.to_s)
+        true
+      end
+
+      def save(data)
+        data = normalize_data(data)
+        db[collection].update({ '_id' => data['_id'] }, data, { upsert: true })
+        data['_id'] = data['_id'].to_s
+        data
+      end
+
+      def find(id)
+        stringify_ids(db[collection].find('_id' => bson(id)).to_a).first || {}
+      end
+
+      def all(options={})
+        options = normalize_options(options)
+        stringify_ids(limit(offset(db[collection].find.sort({ '_id' => 1 }), options[:offset]), options[:limit]).to_a)
+      end
+
+      def find_by(field, value, options={})
+        options = normalize_options(options)
+        stringify_ids(limit(offset(db[collection].find({ field.to_s => value }).sort({ '_id' => 1 }), options[:offset]), options[:limit]).to_a)
+      end
+
+      def remove(id)
+        db[collection].remove({ '_id' => bson(id)})
+        true
+      end
+
+      def remove_all
+        db[collection].remove
+        true
+      end
+
+      def stringify_ids(results)
+        results.each do |result|
+          result['_id'] = result['_id'].to_s if result.has_key? '_id'
+        end
+        results
+      end
+
+      def normalize_data(data)
+        deep_copy(data).tap do |d|
+          d.merge!('id' => id_for(d))
+          d.merge!('_id' => bson(d['id']))
+        end
+      end
+
+      def id_for(data)
+        data.fetch('id', data.fetch('_id', uuid_generator.new)).to_s
+      end
+
+      private
+      def bson(id)
+        uuid_generator.from_string(id.to_s)
+      rescue
+        id.to_s
+      end
+
+      def offset(cursor, offset)
+        return cursor unless offset > 0
+        cursor.skip(offset)
+      end
+
+      def limit(cursor, limit)
+        return cursor unless limit > 0
+        cursor.limit(limit)
+      end
+
+    end
+  end
+end

data/spec/hikki/adapters/mongo_adapter_integration_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Hikki
+  module Adapters
+    describe MongoAdapter, :integration do
+      context 'when actually using Mongo' do
+        subject(:adapter) { MongoAdapter.new }
+        let(:data) { { id: id, field1: 'test', field2: 123 } }
+        let(:expected) { { 'id' => id, '_id' => id, 'field1' => 'test', 'field2' => 123 } }
+        let(:id) { '1' }
+        let(:collection) { 'collection1' }
+
+        it 'can store and retreive data' do
+          adapter.remove_all(collection)
+          adapter.index(collection, :field1)
+          adapter.save(collection, data)
+          expect(adapter.find(collection, id)).to eq expected
+          expect(adapter.find(collection, '2')).to eq Hash.new
+          expect(adapter.all(collection)).to eq [expected]
+          expect(adapter.find_by(collection, :field1, 'test')).to eq [expected]
+          expect(adapter.find_by(collection, :field2, 123)).to eq [expected]
+          expect(adapter.find_by(collection, :field1, 'foo')).to eq []
+          expect(adapter.find_by(collection, :field2, 1)).to eq []
+          adapter.remove(collection, id)
+          expect(adapter.find(collection, id)).to eq Hash.new
+          expect(adapter.all(collection)).to eq []
+          10.times do |i|
+            adapter.save(collection, { id: i, field1: "test-#{i%2}" })
+          end
+          expect(adapter.all(collection, {limit: 2, offset: 6})).to eq [{'id' => '6', '_id' => '6', 'field1' => 'test-0'}, {'id' => '7', '_id' => '7', 'field1' => 'test-1'}]
+          expect(adapter.find_by(collection, :field1, 'test-0', {limit: 2})).to eq [{'id' => '0', '_id' => '0', 'field1' => 'test-0'}, {'id' => '2', '_id' => '2', 'field1' => 'test-0'}]
+          adapter.remove_all(collection)
+          expect(adapter.find(collection, id)).to eq Hash.new
+          expect(adapter.all(collection)).to eq []
+        end
+      end
+    end
+  end
+end

data/spec/hikki/adapters/mongo_adapter_spec.rb

@@ -0,0 +1,231 @@
+require 'spec_helper'
+
+module Hikki
+  module Adapters
+    describe MongoAdapter do
+      subject(:adapter) { MongoAdapter.new(connection, db, uuid_generator) }
+      let(:connection) { double :connection }
+      let(:db) { double :db }
+      let(:mongo_collection) { double :mongo_collection, create_index: true, update: true, remove: true }
+      let(:uuid_generator) { double :uuid_generator, new: '12345' }
+      let(:collection) { 'collection1' }
+      before do 
+        db.stub(:[]).with(collection).and_return(mongo_collection)
+        uuid_generator.stub(:from_string) { |arg| arg }
+      end
+
+      describe '#index' do
+        it 'returns true' do
+          expect(adapter.index(collection, :field1)).to be_true
+        end
+
+        it 'adds an index to the collection' do
+          adapter.index(collection, :field1)
+          expect(mongo_collection).to have_received(:create_index).with('field1')
+        end
+      end
+
+      describe '#save' do
+        context 'when an id is provided in the data' do
+          let(:data) { { id: id, field1: 'test', field2: 123 } }
+          let(:expected) { { 'id' => id, '_id' => id, 'field1' => 'test', 'field2' => 123 } }
+          let(:id) { '1' }
+
+          it 'returns the data' do
+            expect(adapter.save(collection, data)).to eq expected
+          end
+
+          it 'persists the data in the store' do
+            adapter.save(collection, data)
+            expect(mongo_collection).to have_received(:update).with({'_id' => '1'}, expected, { upsert: true })
+          end
+        end
+
+        context 'when an id is not provided in the data' do
+          let(:data) { { field1: 'test', field2: 123 } }
+          let(:expected) { { 'id' => id, '_id' => id, 'field1' => 'test', 'field2' => 123 } }
+          let(:id) { '12345' }
+
+          it 'returns the data with the id added' do
+            expect(adapter.save(collection, data)).to eq expected
+          end
+
+          it 'persists the data in the store' do
+            adapter.save(collection, data)
+            expect(mongo_collection).to have_received(:update).with({'_id' => '12345'}, expected, { upsert: true })
+          end
+        end
+      end
+
+      describe '#find' do
+        let(:id) { '1' }
+
+        context 'when the id exists' do
+          let(:found) { { 'id' => id, '_id' => 1, 'field1' => 'test', 'field2' => 123 } }
+          let(:expected) { { 'id' => id, '_id' => '1', 'field1' => 'test', 'field2' => 123 } }
+          before { mongo_collection.stub(:find).with({ '_id' => id }).and_return([found]) }
+
+          it 'retrieves the data' do
+            expect(adapter.find(collection, id)).to eq expected
+          end
+        end
+
+        context 'when the id does not exist' do
+          let(:expected) { {} }
+          before { mongo_collection.stub(:find).with({ '_id' => id }).and_return([]) }
+
+          it 'returns an empty hash' do
+            expect(adapter.find(collection, id)).to eq expected
+          end
+        end
+      end
+
+      describe '#all' do
+        context 'with a record in the collection' do
+          let(:data) { { id: '1', field1: 'test', field2: 123 } }
+          let(:found) { { 'id' => '1', '_id' => 1, 'field1' => 'test', 'field2' => 123 } }
+          let(:expected) { { 'id' => '1', '_id' => '1', 'field1' => 'test', 'field2' => 123 } }
+          let(:cursor) { double :cursor }
+          before do
+            mongo_collection.stub(:find).and_return(cursor)
+            cursor.stub(:sort).with({ '_id' => 1 }).and_return([found])
+          end
+
+          it 'returns an array containing the record' do
+            expect(adapter.all(collection)).to eq [expected]
+          end
+        end
+
+        context 'with no records in the collection' do
+          let(:cursor) { double :cursor }
+          before do
+            mongo_collection.stub(:find).and_return(cursor)
+            cursor.stub(:sort).with({ '_id' => 1 }).and_return([])
+          end
+
+          it 'returns an array containing the record' do
+            expect(adapter.all(collection)).to eq []
+          end
+        end
+
+        context 'with multiple records and paging options specified' do
+          let(:cursor) { double :cursor, limit: nil, skip: nil, sort: nil }
+
+          before do
+            mongo_collection.stub(:find).and_return(cursor)
+            cursor.stub(:sort).and_return(cursor)
+          end
+
+          context 'with limit 2' do
+            let(:found) { [{'id' => '1', '_id' => 1, 'a' => 1 }, {'id' => '2', '_id' => 2, 'a' => 1 }] }
+            let(:expected) { [{'id' => '1', '_id' => '1', 'a' => 1 }, {'id' => '2', '_id' => '2', 'a' => 1 }] }
+            before { cursor.stub(:limit).and_return(found) }
+
+            it 'returns the first 2 records' do
+              expect(adapter.all(collection, {limit: 2})).to eq expected
+            end
+
+            context 'with an offset of 4' do
+              let(:found) { [{'id' => '5', '_id' => 5, 'a' => 1 }, {'id' => '6', '_id' => 6, 'a' => 1 }] }
+              let(:expected) { [{'id' => '5', '_id' => '5', 'a' => 1 }, {'id' => '6', '_id' => '6', 'a' => 1 }] }
+              let(:skip_cursor) { double :skip_cursor, limit: nil }
+              before do
+                cursor.stub(:skip).with(4).and_return(skip_cursor)
+                skip_cursor.stub(:limit).with(2).and_return(found)
+              end
+
+              it 'returns the 2 records starting with the offset' do
+                expect(adapter.all(collection, {limit: 2, offset: 4})).to eq expected
+              end
+            end
+          end
+        end
+      end
+
+      describe '#find_by' do
+        context 'with a record in the collection' do
+          let(:data) { { id: '1', field1: 'test', field2: 123 } }
+          let(:found) { { 'id' => '1', '_id' => 1, 'field1' => 'test', 'field2' => 123 } }
+          let(:expected) { { 'id' => '1', '_id' => '1', 'field1' => 'test', 'field2' => 123 } }
+          let(:cursor) { double :cursor }
+          before do
+            mongo_collection.stub(:find).with({ 'field1' => 'test' }).and_return(cursor)
+            cursor.stub(:sort).with({ '_id' => 1 }).and_return([found])
+          end
+
+          it 'returns an array containing the record' do
+            expect(adapter.find_by(collection, :field1, 'test')).to eq [expected]
+          end
+        end
+
+        context 'with no records in the collection' do
+          let(:cursor) { double :cursor }
+          before do
+            mongo_collection.stub(:find).with({ 'field1' => 'test' }).and_return(cursor)
+            cursor.stub(:sort).with({ '_id' => 1 }).and_return([])
+          end
+
+          it 'returns an array containing the record' do
+            expect(adapter.find_by(collection, :field1, 'test')).to eq []
+          end
+        end
+
+        context 'with multiple records and paging options specified' do
+          let(:cursor) { double :cursor, limit: nil, skip: nil, sort: nil }
+
+          before do
+            mongo_collection.stub(:find).with({ 'a' => 1 }).and_return(cursor)
+            cursor.stub(:sort).and_return(cursor)
+          end
+
+          context 'with limit 2' do
+            let(:found) { [{'id' => '1', '_id' => 1, 'a' => 1 }, {'id' => '2', '_id' => 2, 'a' => 1 }] }
+            let(:expected) { [{'id' => '1', '_id' => '1', 'a' => 1 }, {'id' => '2', '_id' => '2', 'a' => 1 }] }
+            before { cursor.stub(:limit).and_return(found) }
+
+            it 'returns the first 2 records' do
+              expect(adapter.find_by(collection, :a, 1, {limit: 2})).to eq expected
+            end
+
+            context 'with an offset of 4' do
+              let(:found) { [{'id' => '5', '_id' => 5, 'a' => 1 }, {'id' => '6', '_id' => 6, 'a' => 1 }] }
+              let(:expected) { [{'id' => '5', '_id' => '5', 'a' => 1 }, {'id' => '6', '_id' => '6', 'a' => 1 }] }
+              let(:skip_cursor) { double :skip_cursor, limit: nil }
+              before do
+                cursor.stub(:skip).with(4).and_return(skip_cursor)
+                skip_cursor.stub(:limit).with(2).and_return(found)
+              end
+
+              it 'returns the 2 records starting with the offset' do
+                expect(adapter.find_by(collection, :a, 1, {limit: 2, offset: 4})).to eq expected
+              end
+            end
+          end
+        end
+      end
+
+      describe '#remove' do
+        it 'returns true' do
+          expect(adapter.remove(collection, '1')).to be_true
+        end
+
+        it 'removes the record from the store' do
+          adapter.remove(collection, '1')
+          expect(mongo_collection).to have_received(:remove).with({'_id' => '1'})
+        end
+      end
+
+      describe '#remove_all' do
+        it 'returns true' do
+          expect(adapter.remove_all(collection)).to be_true
+        end
+
+        it 'removes all of the records from the store' do
+          adapter.remove_all(collection)
+          expect(mongo_collection).to have_received(:remove).with()
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hikki/adapters/mongo_adapter'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding :integration
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: hikki-mongo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- alexpeachey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hikki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Mongo adapter for Hikki.
+email:
+- alex.peachey@originate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hikki-mongo.gemspec
+- lib/hikki/adapters/mongo_adapter.rb
+- lib/hikki/adapters/mongo_collection.rb
+- spec/hikki/adapters/mongo_adapter_integration_spec.rb
+- spec/hikki/adapters/mongo_adapter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A Mongo adapter for Hikki.
+test_files:
+- spec/hikki/adapters/mongo_adapter_integration_spec.rb
+- spec/hikki/adapters/mongo_adapter_spec.rb
+- spec/spec_helper.rb