hikki-redis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54541993c901f1077ce9f3f1e679da5e3e6266aa
+  data.tar.gz: bb7df13fdb257d939843f56927c864d6009020e4
+SHA512:
+  metadata.gz: 322f97c3154c812d9f16c5a09ddc949b4be10b758e49fa172b7841bd63525d7291acec02e96596c40bc90c7607a295a7b8fe2113c021eab805064a0a47aaa929
+  data.tar.gz: 31b501644b28b6952ae5318d9199111e296d07ca840b7549f927b031f923195a6d7df992e6be4bd83f66911c69c1ce48b4a4cd90bd074507ea814e76d32a6a1d

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-redis.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::RedisAdapter
+
+A Redis adapter for Hikki.
+It uses the `redis` gem to communicate with Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hikki-redis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hikki-redis
+
+## Usage
+
+By default, the adapter will use `Redis.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::RedisAdapter.new
+
+# Use a specific connection
+redis = Redis.new(:url => "redis://:p4ssw0rd@10.0.1.1:6380/15")
+adapter = Hikki::Adapters::RedisAdapter.new(redis)
+```
+
+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/Rakefile

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

data/hikki-redis.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-redis'
+  spec.version       = Hikki::VERSION
+  spec.authors       = ['alexpeachey']
+  spec.email         = ['alex.peachey@originate.com']
+  spec.summary       = 'A Redis adapter for Hikki.'
+  spec.description   = 'A Redis 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 'redis'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/hikki/adapters/redis_adapter.rb

@@ -0,0 +1,21 @@
+require 'redis'
+require 'hikki'
+require_relative './redis_collection'
+
+module Hikki
+  module Adapters
+    class RedisAdapter < Hikki::Adapters::Adapter
+      attr_reader :connection, :uuid_generator
+
+      def initialize(connection=Redis.new, uuid_generator=SecureRandom)
+        super()
+        @connection = connection
+        @uuid_generator = uuid_generator
+      end
+
+      def collection_for(collection)
+        collections.fetch(collection, RedisCollection.new(collection, connection, uuid_generator))
+      end
+    end
+  end
+end

data/lib/hikki/adapters/redis_collection.rb

@@ -0,0 +1,105 @@
+module Hikki
+  module Adapters
+    class RedisCollection < 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)
+        connection.sadd collection_indexes_key, field.to_s
+        true
+      end
+
+      def save(data)
+        data = normalize_data(data)
+        connection.hset collection_key, data['id'], data.to_json
+        add_to_index(data)
+        data
+      end
+
+      def find(id)
+        JSON.parse(connection.hget(collection_key, id.to_s) || '{}')
+      end
+
+      def all(options={})
+        options = normalize_options(options)
+        connection.hvals(collection_key)[page_range(options)].map { |j| JSON.parse(j) }
+      end
+
+      def find_by(field, value, options={})
+        options = normalize_options(options)
+        return find_by_index(field, value, options) if has_index?(field)
+        all.select { |o| o.fetch(field.to_s) == value }[page_range(options)]
+      end
+
+      def remove(id)
+        remove_from_index(find(id))
+        connection.hdel collection_key, id.to_s
+        true
+      end
+
+      def remove_all
+        indexes.each { |field| connection.del collection_index_key(field) }
+        connection.del collection_indexes_key
+        connection.del collection_key
+      end
+
+      def has_index?(field)
+        connection.sismember collection_indexes_key, field.to_s
+      end
+
+      def indexes
+        connection.smembers collection_indexes_key
+      end
+
+      def id_for(data)
+        data.fetch('id', uuid_generator.uuid).to_s
+      end
+
+      private
+      def collection_indexes_key
+        "hikki:#{collection}:indexes"
+      end
+
+      def collection_index_key(field)
+        "hikki:#{collection}:#{field.to_s}"
+      end
+
+      def collection_key
+        "hikki:#{collection}"
+      end
+
+      def add_to_index(data)
+        indexes.each do |field|
+          existing = indexed_ids(field, data[field])
+          existing << data['id'] unless existing.include? data['id']
+          connection.hset collection_index_key(field), data[field], existing.to_json
+        end
+      end
+
+      def remove_from_index(data)
+        return if data == {}
+        indexes.each do |field|
+          ids = indexed_ids(field, data[field])
+          ids.delete(data['id'])
+          connection.hset collection_index_key(field), data[field].to_s, ids.to_json
+        end
+      end
+
+      def indexed_ids(field, value)
+        JSON.parse(connection.hget(collection_index_key(field), value.to_s) || '[]')
+      end
+
+      def find_by_index(field, value, options)
+        ids = indexed_ids(field, value)
+        results = connection.pipelined { ids.each { |id| connection.hget collection_key, id } }
+        results.map { |j| JSON.parse(j) }.reject { |v| v == {} }[page_range(options)]
+      end
+
+    end
+  end
+end

data/spec/hikki/adapters/redis_adapter_integration_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Hikki
+  module Adapters
+    describe RedisAdapter, :integration do
+      context 'when actually using Redis' do
+        subject(:adapter) { RedisAdapter.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 [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', 'field1' => 'test-0'}, {'id' => '7', 'field1' => 'test-1'}]
+          expect(adapter.find_by(collection, :field1, 'test-0', {limit: 2})).to eq [{'id' => '0', 'field1' => 'test-0'}, {'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/redis_adapter_spec.rb

@@ -0,0 +1,258 @@
+require 'spec_helper'
+
+module Hikki
+  module Adapters
+    describe RedisAdapter do
+      subject(:adapter) { RedisAdapter.new(connection, uuid_generator) }
+      let(:connection) { double :connection, sadd: true, smembers: [], hset: true, hget: true, hdel: true, del: true }
+      let(:uuid_generator) { double :uuid_generator, uuid: '12345' }
+      let(:collection) { 'collection1' }
+
+      describe '#index' do
+        it 'returns true' do
+          expect(adapter.index(collection, :field1)).to be_true
+        end
+
+        it 'adds the field to the index list' do
+          adapter.index(collection, :field1)
+          expect(connection).to have_received(:sadd).with('hikki:collection1:indexes', '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, 'field1' => 'test', 'field2' => 123 } }
+          let(:json) { '{"id":"1","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(connection).to have_received(:hset).with('hikki:collection1', id, json)
+          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(:json) { '{"field1":"test","field2":123,"id":"12345"}' }
+          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(connection).to have_received(:hset).with('hikki:collection1', id, json)
+          end
+        end
+
+        context 'when an index exists on a field in the data' do
+          let(:data) { { id: id, field1: 'test', field2: 123 } }
+          let(:json) { '{"id":"1","field1":"test","field2":123}' }
+          let(:id) { '1' }
+          before do
+            connection.stub(:smembers).with('hikki:collection1:indexes').and_return(['field1'])
+            connection.stub(:hget).with('hikki:collection1:field1', 'test').and_return('[]')
+          end
+
+          it 'adds an entry in the index' do
+            expect(connection).to receive(:hset).with('hikki:collection1', id, json)
+            expect(connection).to receive(:hset).with('hikki:collection1:field1', 'test', '["1"]')
+            adapter.save(collection, data)
+          end
+        end
+      end
+
+      describe '#find' do
+          let(:id) { '1' }
+
+        context 'when the id exists' do
+          let(:data) { { id: id, field1: 'test', field2: 123 } }
+          let(:json) { '{"id":"1","field1":"test","field2":123}' }
+          let(:expected) { { 'id' => id, 'field1' => 'test', 'field2' => 123 } }
+          before { connection.stub(:hget).with('hikki:collection1', id).and_return(json) }
+
+          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(:hget).with('hikki:collection1', id).and_return(nil) }
+
+          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(:json) { '{"id":"1","field1":"test","field2":123}' }
+          let(:expected) { { 'id' => '1', 'field1' => 'test', 'field2' => 123 } }
+          before { connection.stub(:hvals).with('hikki:collection1').and_return([json]) }
+
+          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
+          before { connection.stub(:hvals).with('hikki:collection1').and_return([]) }
+
+          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
+          before do
+            results = (1..10).map {|i| "{\"id\":\"#{i}\",\"a\":1}" }
+            connection.stub(:hvals).with('hikki:collection1').and_return(results)
+          end
+
+          context 'with limit 2' do
+            let(:limit) { 2 }
+
+            it 'returns only 2 records' do
+              expect(adapter.all(collection, {limit: 2}).count).to eq 2
+            end
+
+            context 'with an offset of 4' do
+              it 'returns the 2 records starting with the offset' do
+                expect(adapter.all(collection, {limit: 2, offset: 4})).to eq [{'id' => '5', 'a' => 1}, {'id' => '6', 'a' => 1}]
+              end
+            end
+          end
+        end
+      end
+
+      describe '#find_by' do
+        context 'with a record in the collection matching' do
+          let(:data) { { id: id, field1: 'test', field2: 123 } }
+          let(:json) { '{"id":"1","field1":"test","field2":123}' }
+          let(:expected) { { 'id' => id, 'field1' => 'test', 'field2' => 123 } }
+          let(:id) { '1' }
+
+          context 'without an index' do
+            before do
+              connection.stub(:sismember).with('hikki:collection1:indexes', 'field2').and_return(false)
+              connection.stub(:hvals).with('hikki:collection1').and_return([json])
+            end
+
+            it 'returns an array containing the record' do
+              expect(adapter.find_by(collection, :field2, 123)).to eq [expected]
+            end
+          end
+
+          context 'with an index' do
+            before do
+              connection.stub(:sismember).with('hikki:collection1:indexes', 'field1').and_return(true)
+              connection.stub(:hget).with('hikki:collection1:field1', 'test').and_return('[1]')
+              connection.stub(:hget).with('hikki:collection1', id).and_return(json)
+              connection.stub(:pipelined).and_yield.and_return([json])
+            end
+
+            it 'returns an array containing the record' do
+              expect(adapter.find_by(collection, :field1, 'test')).to eq [expected]
+            end
+          end
+        end
+
+        context 'with no matching records in the collection' do
+          before do
+            connection.stub(:sismember).with('hikki:collection1:indexes', 'field1').and_return(false)
+            connection.stub(:hvals).with('hikki:collection1').and_return([])
+          end
+
+          it 'returns an empty array' do
+            expect(adapter.find_by(collection, :field1, 'foo')).to eq []
+          end
+        end
+
+        context 'with multiple matching records and paging options specified' do
+          before do
+            results = (1..10).map {|i| "{\"id\":\"#{i}\",\"a\":1}" }
+            connection.stub(:sismember).with('hikki:collection1:indexes', 'a').and_return(false)
+            connection.stub(:hvals).with('hikki:collection1').and_return(results)
+          end
+
+          context 'with limit 2' do
+            let(:limit) { 2 }
+
+            it 'returns only 2 records' do
+              expect(adapter.find_by(collection, :a, 1, {limit: 2}).count).to eq 2
+            end
+
+            context 'with an offset of 4' do
+              it 'returns the 2 records starting with the offset' do
+                expect(adapter.find_by(collection, :a, 1, {limit: 2, offset: 4})).to eq [{'id' => '5', 'a' => 1}, {'id' => '6', 'a' => 1}]
+              end
+            end
+          end
+        end
+      end
+
+      describe '#remove' do
+        context 'with a record for the id in the collection' do
+          let(:id) { '1' }
+          let(:json) { '{"id":"1","field1":"test","field2":123}' }
+          before { connection.stub(:hget).with('hikki:collection1', id).and_return(json) }
+
+          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(:hdel).with('hikki:collection1', id)
+          end
+
+          context 'when there is an index' do
+            before do
+              connection.stub(:smembers).with('hikki:collection1:indexes').and_return(['field1'])
+              connection.stub(:hget).with('hikki:collection1:field1', 'test').and_return('["1"]')
+            end
+
+            it 'removes the id from the index' do
+              adapter.remove(collection, id)
+              expect(connection).to have_received(:hset).with('hikki:collection1:field1', 'test', '[]')
+            end
+          end
+        end
+      end
+
+      describe '#remove_all' do
+        context 'with a record in the collection' do
+          it 'returns true' do
+            expect(adapter.remove_all(collection)).to be_true
+          end
+
+          it 'removes all records from the store' do
+            expect(connection).to receive(:del).with('hikki:collection1:indexes')
+            expect(connection).to receive(:del).with('hikki:collection1')
+            adapter.remove_all(collection)
+          end
+
+          context 'when there is an index' do
+            before { connection.stub(:smembers).with('hikki:collection1:indexes').and_return(['field1']) }
+
+            it 'removes the indexes' do
+              adapter.remove_all(collection)
+              expect(connection).to have_received(:del).with('hikki:collection1:field1')
+              expect(connection).to have_received(:del).with('hikki:collection1:indexes')
+            end
+          end
+        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/redis_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,129 @@
+--- !ruby/object:Gem::Specification
+name: hikki-redis
+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: redis
+  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 Redis adapter for Hikki.
+email:
+- alex.peachey@originate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hikki-redis.gemspec
+- lib/hikki/adapters/redis_adapter.rb
+- lib/hikki/adapters/redis_collection.rb
+- spec/hikki/adapters/redis_adapter_integration_spec.rb
+- spec/hikki/adapters/redis_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 Redis adapter for Hikki.
+test_files:
+- spec/hikki/adapters/redis_adapter_integration_spec.rb
+- spec/hikki/adapters/redis_adapter_spec.rb
+- spec/spec_helper.rb