redis-dump 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: abca1efe649fb8dc2fa0da791d9dba9e57035e8d
-  data.tar.gz: 03443fc968e02ba47f5a829a2bd0ec00df6cc239
+SHA256:
+  metadata.gz: bd6bb93f7ba8bf8297d3c1726ac91eda76d0f230a36cedf730d90bbdf815ab5f
+  data.tar.gz: 31993502c019c5723073dcf1e3c0b0d2dbf187a1657d396261e0506a1870506f
 SHA512:
-  metadata.gz: 4a2e15b302f3532f3a6a245dc6f7074ca703bbf08c374c6fd9c5eaee9636bea10833f63f5a55487d45aec2a16a5bdb17a3ec612fd053211a670ec982360a1c87
-  data.tar.gz: 4da09294ae6d1fe5d9fc0d27e4f2fe56bd5f6a259ee87080ba246f7d344217b98e17ce714ab17135e515a6b4fde18913b2dbc533d1390aa6571ebba7a9f77385
+  metadata.gz: e448efa86667cd48563fd1e50df277c686c963156db5465e17e333b542a04267b730c640ec96ed1323a1bd9378c252383890359bda11f89c6b973cafc84267d2
+  data.tar.gz: 0ce386d440465041cc33f5a52a079272ad2c11080e757690887e46a3e3e944fa405065d0ab73063fe9666386be52a7ecf27e0835e277b2f0451387ae31aa8381

data/.pre-commit-config.yaml

@@ -0,0 +1,69 @@
+##
+# Pre-Commit Configuration
+#
+# Initial setup:
+#
+#   0. Install the pre-commit framework (if it isn't already on your system):
+
+#         $ pip install pre-commit
+#
+#   1. Install the git hook:
+#
+#         $ pre-commit install
+#
+#
+# Other commands:
+#
+#   Run it on all the files in this repo:
+#     $ pre-commit run --all-files
+#
+#   Updating plugin repositories:
+#     $ pre-commit autoupdate
+#
+#   Automatically enable pre-commit on repositories
+#     $ git config --global init.templateDir ~/.git-template
+#     $ pre-commit init-templatedir ~/.git-template
+#
+# See also:
+#   - https://pre-commit.com for more information
+#   - https://pre-commit.com/hooks.html for more hooks
+#
+
+default_install_hook_types:
+  - pre-commit
+  - prepare-commit-msg
+
+fail_fast: true
+
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+      - id: identity
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: detect-private-key
+      - id: mixed-line-ending
+      - id: check-added-large-files
+        args: ["--maxkb=1000"]
+      - id: no-commit-to-branch
+        args: ["--branch", "develop", "--branch", "rel/.*"]
+      - id: check-merge-conflict
+      - id: forbid-submodules
+
+  - repo: https://github.com/avilaton/add-msg-issue-prefix-hook
+    rev: v0.0.11
+    hooks:
+      - id: add-msg-issue-prefix
+        stages: [prepare-commit-msg]
+        name: Link commit to Github issue
+        args:
+          - "--default=[NOJIRA]"
+          - "--pattern=[a-zA-Z0-9]{0,10}-?[0-9]{1,5}"
+          - "--template=[#{}]"

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGES.txt

@@ -1,5 +1,19 @@
 REDIS-DUMP, CHANGES
 
+#### 0.6.0 (2024-06-17) ###############################
+
+* ADDED: Supports redis-rb 5.0
+* ADDED: Supports SSL via rediss://
+* CHANGED: Updated dependencies (see https://github.com/delano/redis-dump/pull/37)
+* FIXED: Resolved `sadd` warnings in redis 4.0 #35
+
+
+#### 0.5.0 (2023-01-17) ###############################
+
+* ADDED: Timeout support for redis connections
+* CHANGED: uri-redis dependency to 1.0.0
+
+
 #### 0.4.0 (2017-11-23) ###############################
 
 * ADDED: support for redis >= 4.0

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "drydock", ">= 0.6.9"
+gem "oj", ">= 3.16.4"
+gem "redis", ">= 4.0", "< 6.0"
+gem "uri-redis", ">= 1.3.0"
+gem "yajl-ruby", ">= 1.4.3"
+
+gem "pry-byebug", "~> 3.10.1", require: false, group: :development
+gem "rake", "~> 13.0", require: false, group: :development
+gem "rubocop", "~> 1.64.1", require: false, group: :development
+gem "tryouts", "~> 2.2.0", require: false, group: :development

data/Gemfile.lock

@@ -0,0 +1,76 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bigdecimal (3.1.8)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    connection_pool (2.4.1)
+    drydock (0.6.9)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    oj (3.16.4)
+      bigdecimal (>= 3.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    redis (5.2.0)
+      redis-client (>= 0.22.0)
+    redis-client (0.22.2)
+      connection_pool
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    storable (0.10.0)
+    strscan (3.1.0)
+    sysinfo (0.10.0)
+      drydock (< 1.0)
+      storable (~> 0.10)
+    tryouts (2.2.0)
+      sysinfo (~> 0.10)
+    unicode-display_width (2.5.0)
+    uri-redis (1.3.0)
+    yajl-ruby (1.4.3)
+
+PLATFORMS
+  arm64-darwin-22
+  ruby
+
+DEPENDENCIES
+  drydock (>= 0.6.9)
+  oj (>= 3.16.4)
+  pry-byebug (~> 3.10.1)
+  rake (~> 13.0)
+  redis (>= 4.0, < 6.0)
+  rubocop (~> 1.64.1)
+  tryouts (~> 2.2.0)
+  uri-redis (>= 1.3.0)
+  yajl-ruby (>= 1.4.3)
+
+BUNDLED WITH
+   2.5.9

data/LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2010-2017 Solutious Inc, Delano Mandelbaum
+MIT License
+
+Copyright (c) 2010-2024 Delano Mandelbaum
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -7,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Redis::Dump - v0.6
+
+*Redis to JSON and back again. Dump and load Redis databases to/from JSON files.*
+
+
+## Installation
+
+One of:
+1. Gemfile: `gem 'redis-dump', '~> 0.4.0'`
+2. Install manually: `gem install redis-dump`
+3. Clone with git: `git clone git@github.com:delano/redis-dump.git`
+
+
+
+## Usage
+
+There are two executables: `redis-dump` and `redis-load`.
+
+```bash
+  $ redis-dump
+  $ redis-dump -u 127.0.0.1:6379 > db_full.json
+  $ redis-dump -u 127.0.0.1:6379 -d 15 > db_db15.json
+
+  $ < db_full.json redis-load
+  $ < db_db15.json redis-load -d 15
+  # OR
+  $ cat db_full | redis-load
+  $ cat db_db15.json | redis-load -d 15
+
+  # You can specify the redis URI via an environment variable
+  $ export REDIS_URI=127.0.0.1:6379
+  $ redis-dump
+
+  # If your instance uses a password (such as on RedisToGo), you
+  # can specify the Redis URL as such:
+  # :<password>@<domain>:<port>
+  # Note the leading colon is important for specifying no username.
+  $ redis-dump -u :234288a830f009980e08@example.redistogo.com:9055
+```
+
+### Output format
+
+All redis datatypes are output to a simple JSON object. All objects have the following 5 fields:
+
+* db (Integer)
+* key (String)
+* ttl (Integer): The amount of time in seconds that the key will live. If no expire is set, it's -1.
+* type (String), one of: string, list, set, zset, hash, none.
+* value (String): A JSON-encoded string. For keys of type list, set, zset, and hash, the data is given a specific structure (see below).
+
+Here are examples of each datatype:
+
+```json
+{"db":0,"key":"hashkey","ttl":-1,"type":"hash","value":{"field_a":"value_a","field_b":"value_b","field_c":"value_c"},"size":42}
+{"db":0,"key":"listkey","ttl":-1,"type":"list","value":["value_0","value_1","value_2","value_0","value_1","value_2"],"size":42}
+{"db":0,"key":"setkey","ttl":-1,"type":"set","value":["value_2","value_0","value_1","value_3"],"size":28}
+{"db":0,"key":"zsetkey","ttl":-1,"type":"zset","value":[["value_0","100"],["value_1","100"],["value_2","200"],["value_3","300"],["value_4","400"]],"size":50}
+{"db":0,"key":"stringkey","ttl":79,"type":"string","value":"stringvalue","size":11}
+```
+
+## Important notes
+
+### About TTLs
+
+One of the purposes of redis-dump is the ability to restore the database to a known state. When you restore a redis database from a redis-dump file, *the expires are reset to their values at the time the dump was created*. This is different from restoring from Redis' native .rdb or .aof files (expires are stored relative to the actual time they were set).
+
+### Output directly to an encrypted file
+
+For most sensitive data, you should consider encrypting the data directly without writing first to a temp file. You can do this using the power of [gpg](http://www.gnupg.org/) and file descriptors. Here are a couple examples:
+
+```bash
+  # Encrypt the data (interactive)
+  $ redis-dump -u 127.0.0.1:6379 -d 15 | gpg --force-mdc -v -c > path/2/backup-db1
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/delano/redis-dump.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,59 +1,8 @@
-require "rubygems"
-require "rake"
-require "rake/clean"
-require "rdoc/task"
+# frozen_string_literal: true
 
-task :default => ["build"]
-CLEAN.include [ 'pkg', 'rdoc' ]
-name = "redis-dump"
-
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
-require "redis/dump"
-version = Redis::Dump::VERSION.to_s
-
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |s|
-    s.version = version
-    s.name = name
-    s.summary = "Backup and restore your Redis data to and from JSON."
-    s.description = s.summary
-    s.email = "delano@solutious.com"
-    s.homepage = "http://github.com/delano/redis-dump"
-    s.authors = ["Delano Mandelbaum"]
-
-    s.add_dependency("yajl-ruby",    ">= 0.1")
-    s.add_dependency("redis",        ">= 4.0")
-    s.add_dependency("uri-redis",    ">= 0.4.0")
-    s.add_dependency("drydock",      ">= 0.6.9")
-
-    s.license = "MIT"
-
-    s.signing_key = File.join('/mnt/gem/', 'gem-private_key.pem')
-    s.cert_chain  = ['gem-public_cert.pem']
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.libs = ["lib", "test"]
-end
-
-extra_files = %w[LICENSE.txt THANKS.txt CHANGES.txt ]
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "#{name} #{version}"
-  rdoc.generator = 'hanna' # gem install hanna-nouveau
-  rdoc.main = 'README.rdoc'
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("bin/*.rb")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-  extra_files.each { |file|
-    rdoc.rdoc_files.include(file) if File.exists?(file)
-  }
-end
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
 
+RuboCop::RakeTask.new
 
+task default: :rubocop

data/{bin → exe}/redis-dump

@@ -30,6 +30,9 @@ class Redis::Dump::CLI
   global :a, :password, String, "Redis password (e.g. -a 'my@pass/word')" do |v|
     Redis::Dump.password = v
   end
+  global :t, :timeout, Integer, "Configure connect, read, and write timeouts (ruby redis client)" do |t|
+    Redis::Dump.timeout = t
+  end
   global :s, :sleep, Integer, "Sleep for S seconds after dumping (for debugging)"
   global :c, :count, Integer, "Chunk size (default: #{Redis::Dump.chunk_size})"
   global :f, :filter, String, "Filter selected keys (passed directly to redis' KEYS command)"

data/lib/redis/dump/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Redis
+  class Dump
+    VERSION = "0.6.0"
+  end
+end

data/lib/redis/dump.rb

@@ -1,12 +1,17 @@
+
+
 unless defined?(RD_HOME)
   RD_HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..') )
 end
 
 require 'redis'
-require 'uri/redis'
 require 'yajl'
 require 'base64'
 
+require 'uri/redis'
+
+require_relative "dump/version"
+
 class Redis
   class Dump
     unless defined?(Redis::Dump::VALID_TYPES)
@@ -21,7 +26,7 @@ class Redis
     @with_optimizations = true
     @with_base64 = false
     class << self
-      attr_accessor :debug, :encoder, :parser, :safe, :host, :port, :password, :chunk_size, :with_optimizations, :with_base64
+      attr_accessor :debug, :encoder, :parser, :safe, :host, :port, :password, :timeout, :chunk_size, :with_optimizations, :with_base64
       def le(msg)
         STDERR.puts "#%.4f: %s" % [Time.now.utc.to_f, msg]
       end
@@ -57,6 +62,7 @@ class Redis
         :url => this_uri
       }
       opts[:password] = Redis::Dump.password if Redis::Dump.password
+      opts[:timeout] = Redis::Dump.timeout if Redis::Dump.timeout
       Redis.new **opts
     end
 
@@ -71,9 +77,10 @@ class Redis
       entries = []
       each_database do |redis|
         chunk_entries = []
+        Redis::Dump.ld "[db#{redis.connection[:db]}] Memory before: #{Redis::Dump.memory_usage}kb"
         dump_keys = redis.keys(filter)
         dump_keys_size = dump_keys.size
-        Redis::Dump.ld "Memory after loading keys: #{Redis::Dump.memory_usage}kb"
+        Redis::Dump.ld "[db#{redis.connection[:db]}] Dumping #{dump_keys_size} keys: #{dump_keys.join(', ')}"
         dump_keys.each_with_index do |key,idx|
           entry, idxplus = key, idx+1
           if block_given?
@@ -103,6 +110,8 @@ class Redis
             entries << self.class.encoder.encode(Redis::Dump.dump(redis, entry))
           end
         end
+
+        Redis::Dump.ld "[db#{redis.connection[:db]}] Memory after: #{Redis::Dump.memory_usage}kb"
       end
       entries
     end
@@ -157,7 +166,9 @@ class Redis
           end
           begin
             val, type = obj['value'], obj['type']
+            Redis::Dump.ld " > load `#{val}`"
             if Redis::Dump.with_base64 && type === 'string'
+              Redis::Dump.ld " > load+decode64 for `#{val}`"
               val = Base64.decode64 val
             end
             ret = Redis::Dump.set_value this_redis, obj['key'], type, val, obj['ttl']
@@ -233,7 +244,7 @@ class Redis
         list.each { |value|  this_redis.rpush key, value }
       end
       def set_value_set(this_redis, key, set)
-        set.each { |value|  this_redis.sadd key, value }
+        set.each { |value|  this_redis.sadd? key, value }
       end
       def set_value_zset(this_redis, key, zset)
         zset.each { |pair|  this_redis.zadd key, pair[1].to_f, pair[0] }
@@ -260,24 +271,6 @@ class Redis
     end
     extend Redis::Dump::ClassMethods
 
-    module VERSION
-      @path = File.join(RD_HOME, 'VERSION')
-      class << self
-        attr_reader :version, :path
-        def version
-          @version || read_version
-        end
-        def read_version
-          return if @version
-          @version = File.read(path).strip!
-        end
-        def prerelease?() false end
-        def to_a()     version.split('.')   end
-        def to_s()     version              end
-        def inspect()  version              end
-      end
-    end
-
     class Problem < RuntimeError
       def initialize(*args)
         @args = args.flatten.compact

data/redis-dump.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "lib/redis/dump/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "redis-dump"
+  spec.version     = Redis::Dump::VERSION
+  spec.authors     = ["delano"]
+  spec.email       = "gems@solutious.com"
+
+  spec.summary     = "Backup and restore your Redis data to and from JSON."
+  spec.description = "Backup and restore your Redis data to and from JSON by database, key, or key pattern."
+  spec.homepage    = "https://rubygems.org/gems/redis-dump"
+  spec.license     = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.8")
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{\A(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/sig/redis/dump.rbs

@@ -0,0 +1,6 @@
+module Redis
+  module Dump
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/try/10_redis_dump_try.rb

@@ -1,9 +1,11 @@
-require 'redis/dump'
+# frozen_string_literal: true
+
+require_relative '../lib/redis/dump'
 
 # The test instance of redis must be running:
 # $ redis-server try/redis.conf
 
-@uri_base = "redis://127.0.0.1:6371"
+@uri_base = "redis://127.0.0.1:6379"
 
 Redis::Dump.debug = false
 Redis::Dump.safe = true
@@ -21,7 +23,7 @@ Redis::Dump.safe = true
 @rdump.redis(0).hset 'hashkey', 'field_b', 'value_b'
 @rdump.redis(0).hset 'hashkey', 'field_c', 'value_c'
 3.times { |idx| @rdump.redis(0).rpush 'listkey', "value_#{idx}" }
-4.times { |idx| @rdump.redis(0).sadd 'setkey', "value_#{idx}" }
+4.times { |idx| @rdump.redis(0).sadd? 'setkey', "value_#{idx}" }
 5.times { |idx| @rdump.redis(0).zadd 'zsetkey', idx.zero? ? 100 : 100*idx, "value_#{idx}" }
 @rdump.redis(0).keys.size
 #=> 5
@@ -31,12 +33,6 @@ Redis::Dump.safe = true
 @values.size
 #=> 5
 
-# Clear DB 0
-db0 = Redis::Dump.new 0, @uri_base
-db0.redis(0).flushdb
-db0.redis(0).keys.size
-#=> 0
-
 ## Can load data
 @rdump.load @values.join
 @rdump.redis(0).keys.size
@@ -56,7 +52,14 @@ Redis::Dump.safe = false
 @rdump.load @values.join
 #=> 5
 
-Redis::Dump.safe = true
+## Clear DB 0
 db0 = Redis::Dump.new 0, @uri_base
 db0.redis(0).flushdb
+db0.redis(0).keys.size
+#=> 0
 
+## Clear DB 0 in safe mode
+Redis::Dump.safe = true
+db0 = Redis::Dump.new 0, @uri_base
+db0.redis(0).flushdb
+#=> "OK"

data/try/20_dump_specific_keys_try.rb

@@ -1,9 +1,11 @@
-require 'redis/dump'
+# frozen_string_literal: true
+
+require_relative '../lib/redis/dump'
 
 # The test instance of redis must be running:
 # $ redis-server try/redis.conf
 
-@uri_base = "redis://127.0.0.1:6371"
+@uri_base = "redis://127.0.0.1:6379"
 
 Redis::Dump.debug = false
 Redis::Dump.safe = true
@@ -31,13 +33,6 @@ Redis::Dump.safe = true
 @rdump.dump('*gloria*').sort
 #=> ['{"db":0,"key":"gloria:0","ttl":-1,"type":"string","value":"gloria_value[0]","size":15}','{"db":0,"key":"gloria:1","ttl":-1,"type":"string","value":"gloria_value[1]","size":15}','{"db":0,"key":"gloria:2","ttl":-1,"type":"string","value":"gloria_value[2]","size":15}']
 
-
-## Dump none existent keys (NOT SUPPORTED AS OF 0.3.0)
-unknown_keys = [URI.parse("#{@uri_base}/0/unknownkey1"), URI.parse("#{@uri_base}/1/unknownkey2")]
-@rdump.dump(unknown_keys).sort
-##=> ['{"db":0,"key":"unknownkey1","ttl":-1,"type":"none","value":"","size":0}', '{"db":1,"key":"unknownkey2","ttl":-1,"type":"none","value":"","size":0}']
-
-
 Redis::Dump.safe = true
 db0 = Redis::Dump.new 0..1, @uri_base
 db0.redis(0).flushdb

data/try/30_dump_base64_try.rb

@@ -1,12 +1,14 @@
-require 'redis/dump'
-require 'pry'
+# frozen_string_literal: true
+
+require_relative '../lib/redis/dump'
+# require 'pry-byebug'
 
 # The test instance of redis must be running:
 # $ redis-server try/redis.conf
 
-@uri_base = "redis://127.0.0.1:6371"
+@uri_base = "redis://127.0.0.1:6379"
 
-Redis::Dump.debug = false
+Redis::Dump.debug = true  # leave enabled for CI workflow
 Redis::Dump.safe = true
 Redis::Dump.with_base64 = true
 
@@ -21,38 +23,30 @@ Redis::Dump.with_base64 = true
 @rdump.redis(0).keys.size
 #=> 2
 
-## Is base64 encoded
+## Values are base64 encoded when with_base64=true
 @values = @rdump.dump
-@values[0]
-#=> "{\"db\":0,\"key\":\"stringkey1\",\"ttl\":-1,\"type\":\"string\",\"value\":\"c3RyaW5ndmFsdWUx\\n\",\"size\":12}"
+# Check for values without relying on the order the keys were returned in
+encoded_str = "{\"db\":0,\"key\":\"stringkey1\",\"ttl\":-1,\"type\":\"string\",\"value\":\"c3RyaW5ndmFsdWUx\\n\",\"size\":12}"
+encoded_str2 = "{\"db\":0,\"key\":\"stringkey2\",\"ttl\":-1,\"type\":\"string\",\"value\":\"c3RyaW5ndmFsdWUy\\n\",\"size\":12}"
+[@values.include?(encoded_str), @values.include?(encoded_str2)]
+#=> [true, true]
 
 ## Can dump
 @values = @rdump.dump
 @values.size
 #=> 2
 
-# Clear DB 0
-db0 = Redis::Dump.new 0, @uri_base
-db0.redis(0).flushdb
-db0.redis(0).keys.size
-#=> 0
-
 ## Can load data
 @rdump.load @values.join
 @rdump.redis(0).keys.size
 #=> 2
 
-## Is base64 decoded
-stringkey = @rdump.redis(0).get('stringkey1')
-#=> 'stringvalue1'
-
 # Clear DB 0
 db0 = Redis::Dump.new 0, @uri_base
 db0.redis(0).flushdb
 db0.redis(0).keys.size
-#=> 0
+##=> 0
 
 Redis::Dump.safe = true
 db0 = Redis::Dump.new 0, @uri_base
 db0.redis(0).flushdb
-

data/try/redis.conf

@@ -9,7 +9,7 @@ dbfilename redisdump-test.rdb
 # requirepass @/
 
 bind 127.0.0.1
-port 6371
+port 6379
 databases 16
 
 timeout 30

metadata

@@ -1,125 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: redis-dump
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
-- Delano Mandelbaum
-autorequire: 
+- delano
+autorequire:
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZuZXRz
-  c2gxGTAXBgoJkiaJk/IsZAEZFglzb2x1dGlvdXMxEzARBgoJkiaJk/IsZAEZFgNj
-  b20wHhcNMTYxMjE1MTgwNTIyWhcNMTcxMjE1MTgwNTIyWjBBMQ8wDQYDVQQDDAZu
-  ZXRzc2gxGTAXBgoJkiaJk/IsZAEZFglzb2x1dGlvdXMxEzARBgoJkiaJk/IsZAEZ
-  FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDGJ4TbZ9H+qZ08
-  pQfJhPJTHaDCyQvCsKTFrL5O9z3tllQ7B/zksMMM+qFBpNYu9HCcg4yBATacE/PB
-  qVVyUrpr6lbH/XwoN5ljXm+bdCfmnjZvTCL2FTE6o+bcnaF0IsJyC0Q2B1fbWdXN
-  6Off1ZWoUk6We2BIM1bn6QJLxBpGyYhvOPXsYoqSuzDf2SJDDsWFZ8kV5ON13Ohm
-  JbBzn0oD8HF8FuYOewwsC0C1q4w7E5GtvHcQ5juweS7+RKsyDcVcVrLuNzoGRttS
-  KP4yMn+TzaXijyjRg7gECfJr3TGASaA4bQsILFGG5dAWcwO4OMrZedR7SHj/o0Kf
-  3gL7P0axAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBQF8qLA7Z4zg0SJGtUbv3eoQ8tjIzAfBgNVHREEGDAWgRRuZXRzc2hAc29sdXRp
-  b3VzLmNvbTAfBgNVHRIEGDAWgRRuZXRzc2hAc29sdXRpb3VzLmNvbTANBgkqhkiG
-  9w0BAQUFAAOCAQEATd8If+Ytmhf5lELy24j76ahGv64m518WTCdV2nIViGXB2BnV
-  uLQylGRb1rcgUS3Eh9TE28hqrfhotKS6a96qF9kN0mY2H6UwPWswJ+tj3gA1vLW8
-  wlZNlYGJ91Ig9zULPSbATyOOprUZyggy5p1260BaaI3LQYDeGJOSqpHCVu+TuMcy
-  k00ofiLT1crDSUl2WE/OIFK8AXpmd798AMsef8okHeoo+Dj7zCXn0VSimN+MO1mE
-  L4d54WIy4HkZCqQXoTSiK5HZMIdXkPk3F1bZdJ8Dy1sMRru0rUkkM5mW7TQ75mfW
-  Zp0QrZyNZhtitrXFbZneGRrIA/8G2Krft5Ly/A==
-  -----END CERTIFICATE-----
-date: 2017-11-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: uri-redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: drydock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.9
-description: Backup and restore your Redis data to and from JSON.
-email: delano@solutious.com
-executables:
-- redis-dump
-- redis-load
-- redis-report
+cert_chain: []
+date: 2024-06-17 00:00:00.000000000 Z
+dependencies: []
+description: Backup and restore your Redis data to and from JSON by database, key,
+  or key pattern.
+email: gems@solutious.com
+executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
 files:
+- ".pre-commit-config.yaml"
+- ".rubocop.yml"
 - CHANGES.txt
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
-- bin/redis-dump
-- bin/redis-load
-- bin/redis-report
+- exe/redis-dump
+- exe/redis-load
+- exe/redis-report
 - gem-public_cert.pem
 - lib/redis/dump.rb
+- lib/redis/dump/version.rb
 - redis-dump.gemspec
+- sig/redis/dump.rbs
 - try/10_redis_dump_try.rb
 - try/20_dump_specific_keys_try.rb
 - try/30_dump_base64_try.rb
 - try/db0.json
 - try/redis.conf
-homepage: http://github.com/delano/redis-dump
+homepage: https://rubygems.org/gems/redis-dump
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,16 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.7
+signing_key:
 specification_version: 4
 summary: Backup and restore your Redis data to and from JSON.
 test_files: []

checksums.yaml.gz.sig

@@ -1 +0,0 @@
-�hY��Y��Ů]t
�ۯ�x�r��%&&��y���U�4���ѵ���"��0	���Y����#��y�~ab��{���I�v%~^�m/�E��Zyz�
y&y�
��� �R�N�x��R"`�K@z�{%M3�c(sh�I��TD����'´Nv}k�s>�=C�A��9�kf�^pD�_�l���$�1�C�:�l��K|��ꛥ�1�	��u��܍�ˆ���8�:�����5�y`-c^�},~P�T��T�.�G�A��

data/README.rdoc

@@ -1,107 +0,0 @@
-= Redis-Dump v0.4 BETA
-
-<i>Backup and restore your Redis data to and from JSON.</i>
-
-<b>NOTE: This is beta software. TEST IT BEFORE RELYING ON IT.</b>
-
-
-== Usage
-
-There are two executables: <tt>redis-dump</tt> and <tt>redis-load</tt>.
-
-    $ redis-dump
-    $ redis-dump -u 127.0.0.1:6371 > db_full.json
-    $ redis-dump -u 127.0.0.1:6371 -d 15 > db_db15.json
-
-    $ < db_full.json redis-load
-    $ < db_db15.json redis-load -d 15
-    # OR
-    $ cat db_full | redis-load
-    $ cat db_db15.json | redis-load -d 15
-
-    # You can specify the redis URI via an environment variable
-    $ export REDIS_URI=127.0.0.1:6371
-    $ redis-dump
-
-    # If your instance uses a password (such as on RedisToGo), you
-    # can specify the Redis URL as such:
-    # :<password>@<domain>:<port>
-    # Note the leading colon is important for specifying no username.
-    $ redis-dump -u :234288a830f009980e08@example.redistogo.com:9055
-
-== Output format
-
-All redis datatypes are output to a simple JSON object. All objects have the following 5 fields:
-
-* db (Integer)
-* key (String)
-* ttl (Integer): The amount of time in seconds that the key will live. If no expire is set, it's -1.
-* type (String), one of: string, list, set, zset, hash, none.
-* value (String): A JSON-encoded string. For keys of type list, set, zset, and hash, the data is given a specific structure (see below).
-
-Here are examples of each datatype:
-
-    {"db":0,"key":"hashkey","ttl":-1,"type":"hash","value":{"field_a":"value_a","field_b":"value_b","field_c":"value_c"},"size":42}
-    {"db":0,"key":"listkey","ttl":-1,"type":"list","value":["value_0","value_1","value_2","value_0","value_1","value_2"],"size":42}
-    {"db":0,"key":"setkey","ttl":-1,"type":"set","value":["value_2","value_0","value_1","value_3"],"size":28}
-    {"db":0,"key":"zsetkey","ttl":-1,"type":"zset","value":[["value_0","100"],["value_1","100"],["value_2","200"],["value_3","300"],["value_4","400"]],"size":50}
-    {"db":0,"key":"stringkey","ttl":79,"type":"string","value":"stringvalue","size":11}
-
-=== Important note about TTLs
-
-One of the purposes of redis-dump is the ability to restore the database to a known state. When you restore a redis database from a redis-dump file, <em>the expires are reset to their values at the time the dump was created</em>. This is different from restoring from Redis' native .rdb or .aof files (expires are stored relative to the actual time they were set).
-
-
-== Output directly to an encrypted file
-
-For most sensitive data, you should consider encrypting the data directly without writing first to a temp file. You can do this using the power of [gpg](http://www.gnupg.org/) and file descriptors. Here are a couple examples:
-
-    # Encrypt the data (interactive)
-    $ redis-dump -u 127.0.0.1:6371 -d 15 | gpg --force-mdc -v -c > path/2/backup-db15.json.gpg
-
-    # Encrypt the data (automated)
-    $ redis-dump -u 127.0.0.1:6371 -d 15 | 3</path/2/passphrase.txt gpg --force-mdc -v -c --passphrase-fd 3 > path/2/backup-db15.json.gpg
-
-    # Decrypt the file (interactive)
-    $ gpg path/2/backup-db15.json.gpg
-    Enter passphrase: *******
-
-    # Decrypt the file (automated)
-    $  3</path/2/passphrase.txt gpg --passphrase-fd 3 path/2/backup-db15.json.gpg
-
-
-== Loading data with binary strings
-
-If you have binary or serialized data in your Redis database, the YAJL parser may not load your dump file because it sees some of the binary data as 'invalid bytes in UTF8 string'.  If you are certain that your data is binary and not malformed UTF8, you can use the -n flag to redis-load to tell YAJL to not check the input for UTF8 validity.  Use with caution!
-
-== Installation
-
-    $ gem install redis-dump
-
-Or of you want to run it directly:
-
-    $ git clone https://github.com/delano/redis-dump.git
-    $ cd redis-dump
-    $ gem install redis
-    $ gem install uri-redis
-    $ gem install yajl-ruby
-    $ gem install drydock
-    $ ruby -rubygems bin/redis-dump
-
-
-== More Info
-
-* Codes[http://github.com/delano/redis-dump]
-* Docs[http://goldensword.ca/redis-dump/]
-
-
-== Credits
-
-* delano[http://github.com/delano]
-
-
-== Thanks
-
-* antirez and the funky redis bunch!
-
-

data/VERSION

@@ -1 +0,0 @@
-0.4.0

data.tar.gz.sig

@@ -1,3 +0,0 @@
-_���;F���NDC��Q$�=��$[s��Uz��oٻ�
-"�Ȁ�.o��V
-%���$�