hikki 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08957b3a154474bf8776ae760a82d17b320fbd9c
+  data.tar.gz: 2d91c550f7242fb6ba5e8a9279dd5da0067940f0
+SHA512:
+  metadata.gz: 1b6aa2e88a9ebc8a0e473840f923cab9d0ebb68139f9b046b829baf04fd559019f5b80eb40d7e9993f8ca49c77ce56626280efba0b2c1723e1b0a304c55e905d
+  data.tar.gz: bb482c366cabd64be93648c020ac5ea5363c6b9f15121d5b987a28514a4173dcc1103ab3605519abe22f4de5e73c589fae18d4f0cc3cbfd5b96293e11897111b

data/.gitignore

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

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hikki.gemspec
+gemspec

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,98 @@
+# Hikki
+
+A light weight persistence system for use with key/value type data.
+Hikki allows you to use a repository with one or more adapters for reading and writing data.
+Data is represented as a `Hash` and should be seralizable to/from JSON.
+Current adapters include:
+
+* `Hikki:Adapters::MemoryAdapter`
+* `Hikki:Adapters::RedisAdapter`
+* `Hikki:Adapters::MongoAdapter`
+* `Hikki:Adapters::MemcacheAdapter`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hikki'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hikki
+
+## Usage
+
+By default Hikki will use the included memory adapter.
+
+```ruby
+# Create a new repository
+repository = Hikki::Repository.new
+
+# Create an index on the name field for the people collection
+repository.index :people, :name
+
+# Save a hash of data
+repository.save :people, { id: '1', name: 'Alex' }
+
+# If you don't specify an id, most adapters will make one for you
+repository.save :people, { name: 'Jim' } # => { 'id' => '8107326a-77b6-4018-bd0b-7588442ce36b', 'name' => 'Jim' }
+
+# Get the data back
+repository.find :people, '1' # => { 'id' => '1', 'name' => 'Jim' }
+
+# Grab all of the records in a collection
+repository.all :people
+
+# You can add a limit and/or offset
+repository.all :people, { limit: 10, offset: 20 }
+
+# Find by a field (Also can take limit/offset options)
+repository.find_by :people, :name, 'Alex'
+
+# Remove a record
+repository.remove :people, '1'
+
+# Remove all records
+repository.remove_all :people
+```
+
+Hikki supports repositories with multiple adapters for reading and writing.
+It will write to all specified writers and read from the specified readers until a non-empty result is found.
+
+```ruby
+redis = Hikki::Adapters::RedisAdapter.new
+mongo = Hikki::Adapters::MongoAdapter.new
+
+# Hikki::Repository.new(writers, readers)
+repository = Hikki::Repository.new([redis, mongo], [redis, mongo])
+```
+
+You can subclass `Hikki::Repository` and add conversions to your models.
+
+```ruby
+class MyRepository < Hikki::Repository
+  def save(model)
+    result = super(model.class.name, model.to_hash)
+    model.update_from_hash(result)
+  end
+
+  def find(klass, id)
+    result = super(klass.name, id)
+    klass.new(result)
+  end
+end
+```
+
+## 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/adapters/hikki-memcache/.rspec

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

data/adapters/hikki-memcache/.travis.yml

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

data/adapters/hikki-memcache/Gemfile

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

data/adapters/hikki-memcache/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/adapters/hikki-memcache/README.md

@@ -0,0 +1,50 @@
+# Hikki::Adapters::MemcacheAdapter
+
+A Memcache adapter for Hikki.
+It uses the `dalli` gem to communicate with Memcache.
+Depending on expiry options and size of memory, all objects are not guaranteed to be available.
+As such, `index`, `all`, and `find_by` are not implemented.
+The `index` method will just return `false` if called.
+The `all` and `find_by` will return `[]`. Due to the repository logic, if this adapter is your first
+adapter then calling `all` on the repository will immediately try the next reader in the list.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hikki-memcache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hikki-memcache
+
+## Usage
+
+By default, the adapter will use `Dalli::Client.new('localhost:11211', { namespace: 'hikki', compress: true })` as
+it's connection.
+You can pass in your own connection to use instead, useful for specifying a server, namespace and other options.
+
+```ruby
+# Use the default connection
+adapter = Hikki::Adapters::MemcacheAdapter.new
+
+# Use a specific connection
+cache = Dalli::Client.new('cache.example.com:11211', { namespace: 'my_cache' })
+adapter = Hikki::Adapters::MemcacheAdapter.new(cache)
+```
+
+If you do not specify an `id` when saving, the adapter will generate a uuid using `SecureRandom`.
+
+## 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/adapters/hikki-memcache/Rakefile

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

data/adapters/hikki-memcache/hikki-memcache.gemspec

@@ -0,0 +1,27 @@
+# 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-memcache"
+  spec.version       = Hikki::VERSION
+  spec.authors       = ["alexpeachey"]
+  spec.email         = ["alex.peachey@originate.com"]
+  spec.summary       = 'A Memcache adapter for Hikki.'
+  spec.description   = 'A Memcache 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 'dalli'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/adapters/hikki-memcache/lib/hikki/adapters/memcache_adapter.rb

@@ -0,0 +1,22 @@
+require 'dalli'
+require 'hikki'
+require_relative './memcache_collection'
+
+module Hikki
+  module Adapters
+    class MemcacheAdapter < Hikki::Adapters::Adapter
+      attr_reader :connection, :uuid_generator
+
+      def initialize(connection=Dalli::Client.new('localhost:11211', { namespace: 'hikki', compress: true }), uuid_generator=SecureRandom)
+        super()
+        @connection = connection
+        @uuid_generator = uuid_generator
+      end
+
+      def collection_for(collection)
+        collections.fetch(collection, MemcacheCollection.new(collection, connection, uuid_generator))
+      end
+
+    end
+  end
+end

data/adapters/hikki-memcache/lib/hikki/adapters/memcache_collection.rb

@@ -0,0 +1,54 @@
+module Hikki
+  module Adapters
+    class MemcacheCollection < Hikki::Collection
+      attr_reader :connection, :uuid_generator
+
+      def initialize(collection, connection, uuid_generator)
+        super(collection)
+        @connection = connection
+        @uuid_generator = uuid_generator
+      end
+
+      def index(field)
+        false
+      end
+
+      def save(data)
+        data = normalize_data(data)
+        connection.set(key(data['id']), data)
+        data
+      end
+
+      def find(id)
+        connection.get(key(id)) || {}
+      end
+
+      def all(options={})
+        []
+      end
+
+      def find_by(field, value, options={})
+        []
+      end
+
+      def remove(id)
+        connection.delete(key(id))
+        true
+      end
+
+      def remove_all
+        connection.flush
+      end
+
+      def id_for(data)
+        data.fetch('id', uuid_generator.uuid).to_s
+      end
+
+      private
+      def key(id)
+        collection + ':' + id.to_s
+      end
+
+    end
+  end
+end

data/adapters/hikki-memcache/spec/hikki/adapters/memcache_adapter_integration_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Hikki
+  module Adapters
+    describe MemcacheAdapter, :integration do
+      context 'when actually using Memcache' do
+        subject(:adapter) { MemcacheAdapter.new }
+        let(:data) { { id: id, field1: 'test', field2: 123 } }
+        let(:expected) { { '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 []
+          expect(adapter.find_by(collection, :field1, 'test')).to eq []
+          expect(adapter.find_by(collection, :field2, 123)).to eq []
+          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 []
+          expect(adapter.find_by(collection, :field1, 'test-0', {limit: 2})).to eq []
+          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/adapters/hikki-memcache/spec/hikki/adapters/memcache_adapter_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+module Hikki
+  module Adapters
+    describe MemcacheAdapter do
+      subject(:adapter) { MemcacheAdapter.new(connection, uuid_generator) }
+      let(:connection) { double :connection, set: true, get: nil, delete: true, flush: true }
+      let(:uuid_generator) { double :uuid_generator, uuid: '12345' }
+      let(:collection) { 'collection1' }
+
+      describe '#index' do
+        it 'returns false' do
+          expect(adapter.index(collection, :field1)).to be_false
+        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, 'field1' => 'test', 'field2' => 123 } }
+          let(:id) { '1' }
+          let(:key) { collection + ':' + id }
+
+          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(connection).to have_received(:set).with(key, expected)
+          end
+        end
+
+        context 'when an id is not provided in the data' do
+          let(:data) { { field1: 'test', field2: 123 } }
+          let(:expected) { { 'id' => id, 'field1' => 'test', 'field2' => 123 } }
+          let(:id) { '12345' }
+          let(:key) { collection + ':' + id }
+
+          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(connection).to have_received(:set).with(key, expected)
+          end
+        end
+      end
+
+      describe '#find' do
+        let(:id) { '1' }
+        let(:key) { collection + ':' + id }
+
+        context 'when the id exists' do
+          let(:expected) { { 'id' => id, 'field1' => 'test', 'field2' => 123 } }
+          before { connection.stub(:get).with(key).and_return(expected) }
+
+          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 { connection.stub(:get).with(key).and_return(nil) }
+
+          it 'returns an empty hash' do
+            expect(adapter.find(collection, id)).to eq expected
+          end
+        end
+      end
+
+      describe '#all' do
+        it 'returns []' do
+          expect(adapter.all(collection)).to eq []
+          expect(adapter.all(collection, {})).to eq []
+        end
+      end
+
+      describe '#find_by' do
+        it 'returns []' do
+          expect(adapter.find_by(collection, :field1, 'test')).to eq []
+          expect(adapter.find_by(collection, :field1, 'test', {})).to eq []
+        end
+      end
+
+      describe '#remove' do
+        let(:id) { '1' }
+        let(:key) { collection + ':' + id }
+
+        it 'returns true' do
+          expect(adapter.remove(collection, id)).to be_true
+        end
+
+        it 'removes the record from the store' do
+          adapter.remove(collection, id)
+          expect(connection).to have_received(:delete).with(key)
+        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(connection).to have_received(:flush)
+        end
+      end
+
+    end
+  end
+end