redikey 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1669a8286c4332c77e88855c63d9b2f6d2c328bc
+  data.tar.gz: e3fa7013b47fcac467fe908d4d8498dee616411d
+SHA512:
+  metadata.gz: 3f44fae1a34958cc3a04606c031dff64c3b4007172c8796e66cce13bd19725c6aaaf55e84924480045c925abf4ee6d7d854a5d3c713015d0e7dbed54581066d2
+  data.tar.gz: ca63fe1a5855fdc953d6ea14c5250127068f2d4c7dda9fd0ae55e7140199d96611e82e00c3aab085979fea20cd41460995fb84f4c75cfd19e8ae676d3cd42ed7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Carl Furrow
+
+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,91 @@
+# Redikey
+
+Redikey encapsulates the Redis hash key pattern [defined here](http://instagram-engineering.tumblr.com/post/12202313862/storing-hundreds-of-millions-of-simple-key-value).
+
+The most common usage was to group values into common key prefixes ('milestones' or 'str_report', etc) and then taking the user_id of the user we want to store or retrieve data in redis for (e.g. 5000000) and then making the hash key by taking the user_id and dividing by 512, which would become: `milestones:9765`.
+
+Inside that hash key, we'd create a field based again on the user's user_id, but this time, instead of dividing, we mod: `320`
+
+So the redis operation to set a value for user 5000000 would be:
+
+```
+redis.hset('milestones:9765', '320', some_value)
+```
+
+If the user's user_id was 5000001, the redis operation would look like this:
+
+```
+redis.hset('milestones:9765', '321', some_other_value)
+```
+
+Redikey simplifies this math, and creates a simple api to retrieve those keys for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redikey'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redikey
+
+## Usage
+
+To initialize the Redikey KeyHelper:
+
+`Redikey::KeyHelper.new(resource_id, separator: ':', prefixes: [])`
+
+- **Required** The resource_id (e.g. a user_id)
+- *Optional* separator: A separator to use between prefixes or parts of the key (defaults to ':')
+- *Optional* prefixes: An array of strings that will become prefixes for your key. (defaults to [])
+
+
+```
+redikey = Redikey::KeyHelper.new(1, separator: '/', prefixes: [:prefix1, :prefix2, :prefixn])
+
+redikey.key #=> 'prefix1/prefix2/prefixn/0'
+redikey.field_key => '1'
+```
+
+Without any prefixes
+```
+redikey = Redikey::KeyHelper.new(1)
+redikey.key #=> '0'
+redikey.field_key #=> '1'
+```
+
+You can also add an additional prefix that will be added to the end of any existing prefixes:
+```
+redikey.key(:foo) #=> 'foo:0'
+
+redikey = Redikey::KeyHelper.new(1, prefixes: [:prefix1, :prefix2, :prefixn])
+redikey.key(:foo) #=> 'prefix1:prefix2:prefixn:foo:0'
+```
+
+Now that you have the keys you need for the hash, and the field, you can use Redis' `hset` command:
+
+```
+redis.hset(redikey.key, redikey.field_key, some_value)
+```
+
+And to read from the hash:
+
+```
+redis.hget(redikey.key, redikey.field_key)
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redikey/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/redikey.rb

@@ -0,0 +1,5 @@
+require "redikey/version"
+require 'redikey/key_helper'
+
+module Redikey
+end

data/lib/redikey/key_helper.rb

@@ -0,0 +1,26 @@
+module Redikey
+  class KeyHelper
+    DEFAULT_HASH_SIZE = 512
+    attr_reader :resource_id, :prefixes, :separator
+
+    def initialize(resource_id, separator: ':', prefixes: [])
+      @resource_id = resource_id
+      @prefixes = prefixes
+      @separator = separator
+    end
+
+    def key(appended_prefix = nil)
+      (prefixes + [appended_prefix, sharded_key]).compact.join(separator)
+    end
+
+    def field_key
+      resource_id % DEFAULT_HASH_SIZE
+    end
+
+    private
+
+    def sharded_key
+      (resource_id / DEFAULT_HASH_SIZE).to_i
+    end
+  end
+end

data/lib/redikey/version.rb

@@ -0,0 +1,3 @@
+module Redikey
+  VERSION = "0.0.1"
+end

data/redikey.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redikey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redikey"
+  spec.version       = Redikey::VERSION
+  spec.authors       = ["Carl Furrow"]
+  spec.email         = ["carl.furrow@gmail.com"]
+  spec.summary       = %q{Simplify creation of storage-efficient redis hash keys}
+  spec.description   = %q{}
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/redikey/key_helper_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module Redikey
+  describe KeyHelper do
+    let(:user_id) { 999 }
+    let(:prefixes) { [] }
+    let(:redikey) { described_class.new(user_id, prefixes: prefixes) }
+
+    describe '#key' do
+
+      subject { redikey.key }
+
+      context 'without a prefix' do
+        it 'returns the sharded key' do
+          expect(subject).to eq( sharded_key )
+        end
+      end
+
+      context 'with a prefix' do
+        let(:prefixes) { [:foo, :bar] }
+
+        it 'returns the sharded key with a prefix' do
+          expect(subject).to eq( "foo:bar:#{sharded_key}"  )
+        end
+
+        context 'with additional prefix' do
+          subject { redikey.key('baz') }
+
+          it 'appends the additional prefix to the key' do
+            expect(subject).to eq("foo:bar:baz:#{sharded_key}")
+          end
+        end
+      end
+
+      context 'with additional prefix' do
+        subject { redikey.key('baz') }
+
+        it 'appends the additional prefix to the key' do
+          expect(subject).to eq("baz:#{sharded_key}")
+        end
+      end
+
+      context 'when separator is /' do
+        let(:redikey) { described_class.new(user_id, separator: '/', prefixes: prefixes) }
+        let(:prefixes) { [:foo, :bar] }
+
+        it 'uses the given separator' do
+          expect(subject).to eq("foo/bar/#{sharded_key}")
+        end
+      end
+    end
+
+    describe '#field_key' do
+      subject { redikey.field_key }
+
+      it 'returns the resource key, mod the default hash size' do
+        expect(subject).to eq( sharded_field_key )
+      end
+    end
+
+    def sharded_key
+      (user_id / described_class::DEFAULT_HASH_SIZE).to_s
+    end
+
+    def sharded_field_key
+      user_id % described_class::DEFAULT_HASH_SIZE
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'redikey'
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: redikey
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carl Furrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- carl.furrow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redikey.rb
+- lib/redikey/key_helper.rb
+- lib/redikey/version.rb
+- redikey.gemspec
+- spec/redikey/key_helper_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.4.1
+signing_key: 
+specification_version: 4
+summary: Simplify creation of storage-efficient redis hash keys
+test_files:
+- spec/redikey/key_helper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: