redis-datapump 0.1.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bc5542d412bc18d7e6513203a11ad778f9b0f5b
+  data.tar.gz: f45e34c40c43c28aec4dc916758766c8915ed08b
+SHA512:
+  metadata.gz: e9af5cfec5614cb2f2c3897d10b030843163a04ea750dc8d0bbd650b871c63bb5ee1dc5a3def07fe8674d74b1a04db3539ced248939c483e3c37b55a28ee1b1d
+  data.tar.gz: cae3669f23483794f82c5f52b4c6e7692bb240bfd40ce069ca458694c131a7016bb58812bb3b4918d3073c0152bd2df0d1809f0045c97892de1bd14c610756ec

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'coveralls', require: false
+  gem 'guard'
+  gem 'guard-rspec'
+
+  gem 'rb-inotify', require: false
+  gem 'rb-fsevent', require: false
+  gem 'rb-fchange', require: false
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Leif Gensert
+
+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,55 @@
+# Redis::Datapump
+
+This tool let's you export and import redis database into a json format.
+
+It is loosely based on [redis-dump](http://github.com/delano/redis-dump).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-datapump'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-datapump
+
+## Usage
+
+There are 2 tools that are shipped with this gem:
+
+    redis-export -d 0
+
+will ouput the keys to the console.
+
+You can output it to a file or pipe it to another process.
+
+With
+
+  cat backup.json | redis-import -d 0
+
+you'll import the database again
+
+
+## Format
+
+The format of the dump looks as following:
+
+    {
+      "ttl": -1,
+      "value": "b",
+      "type": "string",
+      "key": "a"
+    }
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/bin/redis-export

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'redis-datapump'
+require 'multi_json'
+
+options = {
+  redis_url: 'redis://localhost:6379',
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: redis-export [options]"
+
+  opts.on('-u', '--uri=URI', 'Redis URI in format redis://hostname[:port]') do |u|
+    options[:redis_url] = u
+  end
+
+  opts.on('-d', '--database=DB', 'Redis database to export') do |d|
+    options[:redis_database] = d
+  end
+end.parse!
+
+json_engine = RUBY_PLATFORM == 'java' ? :jr_jackson : :yajl
+
+MultiJson.use json_engine
+
+RedisDatapump::Exporter.new(options).export do |value|
+  $stdout.puts MultiJson.dump(value, pretty: false)
+end

data/bin/redis-import

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'redis-datapump'
+require 'multi_json'
+
+options = {
+  redis_url: 'redis://localhost:6379',
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: redis-export [options]"
+
+  opts.on('-u', '--uri=URI', 'Redis URI in format redis://hostname[:port]') do |u|
+    options[:redis_url] = u
+  end
+
+  opts.on('-d', '--database=DB', 'Redis database to export') do |d|
+    options[:redis_database] = d
+  end
+end.parse!
+
+json_engine = RUBY_PLATFORM == 'java' ? :jr_jackson : :yajl
+
+MultiJson.use json_engine
+
+importer = RedisDatapump::Importer.new(options)
+ARGF.each do |line|
+  importer.import(MultiJson.load(line))
+end

data/lib/redis-datapump.rb

@@ -0,0 +1,9 @@
+require 'redis'
+require 'redis-datapump/version'
+require 'redis-datapump/exporter'
+require 'redis-datapump/importer'
+require 'redis-datapump/validator'
+require 'redis-datapump/value_extractor'
+
+module RedisDatapump
+end

data/lib/redis-datapump/exporter.rb

@@ -0,0 +1,25 @@
+module RedisDatapump
+  class Exporter
+    def initialize opts
+      @options = opts
+    end
+
+    def export &blk
+      Validator.new(@options).validate!
+      keys('*').each do |key|
+        blk.call(ValueExtractor.new(redis_client, key).content)
+      end
+    end
+
+    private
+    def keys glob
+      redis_client.keys(glob)
+    end
+
+    def redis_client
+      return @redis_client if @redis_client
+      url = "#{@options[:redis_url]}/#{@options[:redis_database]}"
+      @redis_client = Redis.connect(url: url)
+    end
+  end
+end

data/lib/redis-datapump/importer.rb

@@ -0,0 +1,26 @@
+module RedisDatapump
+  class Importer
+    IMPORTER_MAP = {
+      'string' => proc {|client, key, value| client.set(key, value)},
+      'hash' => proc {|client, key, values| client.hmset(key, values)},
+      'set' => proc {|client, key, members| client.sadd(key, members)},
+      'list' => proc {|client, key, values| client.rpush key, values },
+      'zset' => proc {|client, key| client.zrange(key, 0, -1, :with_scores => true) },
+    }
+    def initialize opts
+      @options = opts
+      Validator.new(@options).validate!
+    end
+
+    def import content
+      IMPORTER_MAP[content['type']].call(redis_client, content['key'], content['value'])
+      @redis_client.pexpire(content['key'], content['ttl']) if content['ttl'] != -1
+    end
+
+    def redis_client
+      return @redis_client if @redis_client
+      url = "#{@options[:redis_url]}/#{@options[:redis_database]}"
+      @redis_client = Redis.connect(url: url)
+    end
+  end
+end

data/lib/redis-datapump/redis_datapump.rb

@@ -0,0 +1,8 @@
+require 'redis'
+require 'redis_datapump/version'
+require 'redis_datapump/exporter'
+require 'redis_datapump/validator'
+require 'redis_datapump/type_dispatcher'
+
+module RedisDatapump
+end

data/lib/redis-datapump/validator.rb

@@ -0,0 +1,13 @@
+module RedisDatapump
+  class Validator
+    def initialize opts
+      @options = opts
+    end
+
+    def validate!
+      if @options[:redis_database].nil?
+        raise ArgumentError, 'Please specify a database'
+      end
+    end
+  end
+end

data/lib/redis-datapump/value_extractor.rb

@@ -0,0 +1,28 @@
+module RedisDatapump
+  class ValueExtractor
+    VALUE_MAP = {
+      'string' => proc {|client, key| client.get(key)},
+      'hash' => proc {|client, key| client.hgetall(key)},
+      'set' => proc {|client, key| client.smembers(key)},
+      'list' => proc {|client, key| client.lrange key, 0, -1 },
+      'zset' => proc {|client, key| client.zrange(key, 0, -1, :with_scores => true) },
+    }
+
+    def initialize redis_client, key
+      @redis_client = redis_client
+      @key = key
+    end
+
+    def content
+      return @content if @content
+
+      type = @redis_client.type(@key)
+      @content = {
+        key: @key,
+        type: type,
+        value: VALUE_MAP[type].call(@redis_client, @key),
+        ttl: @redis_client.pttl(@key),
+      }
+    end
+  end
+end

data/lib/redis-datapump/version.rb

@@ -0,0 +1,3 @@
+module RedisDatapump
+  VERSION = '0.1.0.alpha1'
+end

data/redis-datapump.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis-datapump/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis-datapump'
+  spec.version       = RedisDatapump::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Leif Gensert']
+  spec.email         = ['leif@propertybase.com']
+  spec.description   = %q{Tool for Importing and Exporting data from/to redis}
+  spec.summary       = %q{This tool is similar to `redis-dump` but is also working with JRuby}
+  spec.homepage      = 'http://www.github.com/leifg/redis-datapump'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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 'redis', '~> 3.0'
+  spec.add_dependency 'multi_json', '~> 1.7'
+  spec.add_dependency 'json'
+
+  if RUBY_PLATFORM == 'java'
+    spec.add_dependency 'jrjackson'
+  else
+    spec.add_dependency 'yajl-ruby'
+  end
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'mock_redis', '~> 0.8'
+
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/spec/lib/redis-datapump/exporter_spec.rb

@@ -0,0 +1,32 @@
+#encoding: utf-8
+require 'spec_helper'
+
+describe RedisDatapump::Exporter do
+  subject do 
+    exporter = described_class.new({
+      redis_url: 'redis://localhost:6379',
+      redis_database: '0',
+    })
+    exporter.stub(:redis_client).and_return(mock_redis)
+    exporter
+  end
+
+  let(:mock_redis) do
+    mr = MockRedis.new
+    mr.stub(:pttl).and_return(-1)
+    mr
+  end
+
+  describe 'export' do
+    it 'calls keys' do
+      expect(subject)
+        .to receive(:keys).and_return([])
+      subject.export
+    end
+
+    it 'yields the content' do
+      mock_redis.set('string_key', 'string_value')
+      expect{|b| subject.export(&b)}.to yield_control.once
+    end
+  end
+end

data/spec/lib/redis-datapump/validator_spec.rb

@@ -0,0 +1,18 @@
+#encoding: utf-8
+require 'spec_helper'
+
+describe RedisDatapump::Validator do
+  describe '#validate!' do
+    it 'raises no exception for valid input' do
+      expect do
+        described_class.new(redis_database: '0').validate!
+      end.to_not raise_error
+    end
+
+    it 'raises a RuntimeError for missing redis_database' do
+      expect do
+        described_class.new({}).validate!
+      end.to raise_error(ArgumentError, 'Please specify a database')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'redis-datapump'
+require 'mock_redis'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = 'random'
+  config.filter_run_excluding skip: true
+  config.before(:each) do
+     Redis.stub(:new) { raise 'Call to real redis in tests' }
+   end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: redis-datapump
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha1
+platform: ruby
+authors:
+- Leif Gensert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: yajl-ruby
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Tool for Importing and Exporting data from/to redis
+email:
+- leif@propertybase.com
+executables:
+- redis-export
+- redis-import
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/redis-export
+- bin/redis-import
+- lib/redis-datapump.rb
+- lib/redis-datapump/exporter.rb
+- lib/redis-datapump/importer.rb
+- lib/redis-datapump/redis_datapump.rb
+- lib/redis-datapump/validator.rb
+- lib/redis-datapump/value_extractor.rb
+- lib/redis-datapump/version.rb
+- redis-datapump.gemspec
+- spec/lib/redis-datapump/exporter_spec.rb
+- spec/lib/redis-datapump/validator_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/leifg/redis-datapump
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: This tool is similar to `redis-dump` but is also working with JRuby
+test_files:
+- spec/lib/redis-datapump/exporter_spec.rb
+- spec/lib/redis-datapump/validator_spec.rb
+- spec/spec_helper.rb