uri-valkey 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6af4f80b4b8f3a5a8d7bc33469965c8a1dcd07d6bc52a71d3cd8627e1315d6c2
+  data.tar.gz: a4e53b636f1dd887d0319d84a1137e0f49e6e4aefa9babe03fe3c9e4e938a4ae
+SHA512:
+  metadata.gz: 2b65e694ad0a2954c02e1fad115f0153647a39314d52f5cf95af8fa19b9e081fe1284bc4969c0d51443348ae4b6c613a721c0117fdcb7989bfc4dbc1e5787c21
+  data.tar.gz: f81126f4e47f6b690217b1f3d408e504853586ac01e0fbbd8d4df50fbf3ce6fdee718a20fa79d5e1f197448fa75a96cae54ffc7c91e40cec9967ee2e76fa1979

data/CHANGES.txt

@@ -0,0 +1,76 @@
+URI-Redis, CHANGES
+
+#### 1.3.0 (2024-06-15) ###############################
+
+* Add support for rediss scheme (thanks @sebastien-coavoux).
+
+#### 1.2.0 (2024-05-20) ###############################
+
+* Fix for Ruby <= 3.0 `register_scheme` error.
+
+
+#### 1.1.2 (2024-05-02) ###############################
+
+* Same functionality as the now yanked 1.1.1 with
+  updated metadata, including:
+    * Remove minimum ruby version from Gemfile
+    * Corrected Gemfile.lock file with latest deps
+    * Improved Github Action workflow.
+    * Fixes for Rubocop complaints.
+
+
+#### 1.1.1 (2024-04-05) ###############################
+
+** Yanked May 2nd **
+
+#### 1.1.0 (2024-04-04) ###############################
+
+* Fix for frozen strings issue.
+* Allow fow updated redis, tryouts releases.
+
+
+#### 1.0.0 (2023-01-17) ###############################
+
+* CHANGE: Just a version bump to 1.0 for a full
+  release. No code changes.
+
+
+#### 1.0.0-RC2 (2023-01-16) ###########################
+
+* FIXED: Harmonized ruby versions across gemspec,
+  code, and github action.
+
+
+#### 1.0.0-RC1 (2023-01-16) ###########################
+
+* CHANGE: Moderized gem
+* ADDED: Only redis-4.1.0+ supported
+* FIXED: Support URI v0.11
+  * See: https://github.com/delano/redis-dump/issues/33
+
+
+#### 0.4.2 (2010-12-23) ###############################
+
+# CHANGE: URI#conf enforces symbols as keys
+* ADDED: URI#conf parses query string
+
+
+#### 0.4.1 (2010-11-16) ###############################
+
+* FIXED: Nil error in URI::Redis#key
+
+#### 0.4.0 (2010-11-15) ###############################
+
+* ADDED: Support for keys in the path
+* CHANGE: Updated tryouts to 2.0
+
+
+#### 0.3.0 (2010-06-03) ###############################
+
+* CHANGE: Redis::Client.uri is now Redis.uri
+* ADDED: Support for redis-2.0.0
+
+
+#### 0.2.0 (2010-05-30) ###############################
+
+* Initial public release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) delano
+
+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,130 @@
+# URI-Valkey
+
+Creates URI objects for Valkey URLs, with support for parsing connection strings and extracting configuration parameters.
+
+## Supported URI Formats
+
+    valkey://host:port/dbindex
+    valkeys://host:port/dbindex   # SSL
+    redis://host:port/dbindex     # Cross-scheme compatibility
+    rediss://host:port/dbindex    # Cross-scheme compatibility (SSL)
+
+## Installation
+
+* `gem install uri-valkey`
+* `git clone git@github.com:delano/uri-valkey.git`
+
+## Usage
+
+```ruby
+require 'uri-valkey'  # or require 'uri_valkey'
+
+conf = URI.parse 'valkey://localhost:6379/0'
+conf.scheme               # => "valkey"
+conf.host                 # => "localhost"
+conf.port                 # => 6379
+conf.db                   # => 0
+conf.to_s                 # => "valkey://localhost:6379/0"
+
+# Access configuration hash
+conf.conf                 # => {:host=>"localhost", :port=>6379, :db=>0, :ssl=>false}
+```
+
+### SSL Support
+
+SSL is supported by using the `valkeys` scheme:
+
+```ruby
+conf = URI.parse 'valkeys://localhost:6379/0'
+conf.scheme               # => "valkeys"
+conf.conf[:ssl]           # => true
+```
+
+### Working with Keys
+
+The URI class supports parsing and manipulating Valkey keys:
+
+```ruby
+uri = URI.parse 'valkey://localhost:6379/2/mykey:namespace'
+uri.db                    # => 2
+uri.key                   # => "mykey:namespace"
+
+# Modify the key
+uri.key = 'newkey:value'
+uri.to_s                  # => "valkey://localhost:6379/2/newkey:value"
+
+# Modify the database
+uri.db = 5
+uri.to_s                  # => "valkey://localhost:6379/5/newkey:value"
+```
+
+### Building URIs
+
+```ruby
+uri = URI::Valkey.build(host: "localhost", port: 6379, db: 2, key: "v1:arbitrary:key")
+uri.to_s                  # => "valkey://localhost:6379/2/v1:arbitrary:key"
+```
+
+### Query Parameters
+
+Query parameters are supported for additional configuration:
+
+```ruby
+uri = URI.parse "valkey://127.0.0.1/6/?timeout=5&retries=3"
+uri.conf                  # => {:db=>6, :timeout=>5, :retries=>"3", :host=>"127.0.0.1", :port=>6379, :ssl=>false}
+```
+
+## Cross-Scheme Compatibility
+
+Both gems support each other's URL schemes for maximum flexibility:
+
+```ruby
+# Valkey gem can parse Redis URLs
+redis_uri = URI.parse 'redis://localhost:6379/0'
+redis_uri.scheme          # => "redis"
+redis_uri.conf            # => {:host=>"localhost", :port=>6379, :db=>0, :ssl=>false}
+
+# SSL schemes work cross-platform
+ssl_uri = URI.parse 'rediss://localhost:6379/0'
+ssl_uri.conf[:ssl]        # => true
+```
+
+## URI-Redis
+
+A `uri-redis` gem is also available with identical functionality for Redis URLs, including support for `valkey://` and `valkeys://` schemes:
+
+```ruby
+require 'uri-redis'
+
+conf = URI.parse 'redis://localhost:6379/0'
+conf.scheme               # => "redis"
+conf.conf                 # => {:host=>"localhost", :port=>6379, :db=>0, :ssl=>false}
+```
+
+### Redis Client Integration
+
+If you have the `redis` gem installed, URI-Redis provides a refinement to add URI support directly to Redis client instances:
+
+```ruby
+require 'uri-redis'
+
+# Enable the refinement in your scope
+using RedisURIRefinement
+
+redis = Redis.new(url: 'redis://localhost:6379/2')
+redis.uri                 # Returns URI object for the Redis client's connection
+
+# Class method for generating URIs from configuration
+Redis.uri(host: 'localhost', port: 6379, db: 2, ssl: true)
+# => URI object for "rediss://localhost:6379/2"
+```
+
+**Note:** The refinement is only available when the `redis` gem is loaded and only works within scopes where `using RedisURIRefinement` has been called.
+
+## About
+
+* [Github](https://github.com/delano/uri-valkey)
+
+## License
+
+See LICENSE.txt

data/lib/uri/perfect_strangers.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'uri/generic'
+
+module URI
+  # Shared module for Valkey-compatible database URI classes (Redis, Valkey, etc.)
+  # Provides common functionality for handling database URIs with database indices and key paths
+  module PerfectStrangers
+    DEFAULT_PORT = 6379
+    DEFAULT_DB = 0
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Class methods for database URI classes
+    module ClassMethods
+      def build(args)
+        tmp = Util.make_components_hash(self, args)
+        super(tmp)
+      end
+    end
+
+    def request_uri
+      path_query
+    end
+
+    def key
+      return if path.nil?
+
+      self.path ||= "/#{DEFAULT_DB}"
+      (self.path.split('/')[2..] || []).join('/')
+    end
+
+    def key=(val)
+      self.path = if val && !val.to_s.empty?
+                    "/#{db}/#{val}"
+                  else
+                    "/#{db}"
+                  end
+    end
+
+    def db
+      self.path ||= "/#{DEFAULT_DB}"
+      (self.path.split('/')[1] || DEFAULT_DB).to_i
+    end
+
+    def db=(val)
+      current_key = key
+      self.path = if current_key && !current_key.empty?
+                    "/#{val}/#{current_key}"
+                  else
+                    "/#{val}"
+                  end
+    end
+
+    def conf
+      hsh = {
+        host: host,
+        port: port,
+        db: db,
+        ssl: ssl_schemes.include?(scheme)
+      }.merge(parse_query(query))
+      hsh[:password] = password if password
+      hsh[:timeout] = hsh[:timeout].to_i if hsh.key?(:timeout)
+      hsh
+    end
+
+    def serverid
+      format('%s://%s:%s/%s', scheme, host, port, db)
+    end
+
+    private
+
+    # Override in including classes to define which schemes use SSL
+    def ssl_schemes
+      raise NotImplementedError, 'ssl_schemes must be implemented in including classes'
+    end
+
+    # Based on: https://github.com/chneukirchen/rack/blob/master/lib/rack/utils.rb
+    # which was originally based on Mongrel
+    def parse_query(query, delim = nil)
+      delim ||= '&;'
+      params = {}
+      (query || '').split(/[#{delim}] */n).each do |p|
+        k, v = p.split('=', 2).map { |str| str } # NOTE: uri_unescape
+        k = k.to_sym
+        if (cur = params[k])
+          if cur.instance_of?(Array)
+            params[k] << v
+          else
+            params[k] = [cur, v]
+          end
+        else
+          params[k] = v
+        end
+      end
+      params
+    end
+  end
+end

data/lib/uri/valkey/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'uri/generic'
+
+module URI
+  class Valkey < URI::Generic
+    VERSION = '1.4.0'
+    SUMMARY = 'A Ruby library for parsing, building and normalizing valkey URLs'
+  end
+end

data/lib/uri/valkey.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'uri/generic'
+
+require_relative 'perfect_strangers'
+
+# URI::Valkey - adds support for Valkey URIs to core.
+module URI
+  # Valkey URI
+  #
+  # This is a subclass of URI::Generic and supports the following URI formats:
+  #
+  #   valkey://host:port/dbindex
+  #
+  # @example
+  #   uri = URI::Valkey.build(host: "localhost", port: 6379, db: 2, key: "v1:arbitrary:key")
+  #   uri.to_s #=> "valkey://localhost:6379/2/v1:arbitrary:key"
+  #
+  #   uri = URI::Valkey.build(host: "localhost", port: 6379, db: 2)
+  #   uri.to_s #=> "valkey://localhost:6379/2"
+  class Valkey < URI::Generic
+    include PerfectStrangers
+
+    private
+
+    def ssl_schemes
+      %w[valkeys rediss]
+    end
+  end
+
+  if URI.respond_to?(:register_scheme)
+    URI.register_scheme 'VALKEY', Valkey unless URI.scheme_list.key?('VALKEY')
+    URI.register_scheme 'VALKEYS', Valkey unless URI.scheme_list.key?('VALKEYS')
+    # Cross-scheme support for Redis URLs
+    URI.register_scheme 'REDIS', Valkey unless URI.scheme_list.key?('REDIS')
+    URI.register_scheme 'REDISS', Valkey unless URI.scheme_list.key?('REDISS')
+  else
+    @@schemes['VALKEY'] = Valkey unless @@schemes.key?('VALKEY')
+    @@schemes['VALKEYS'] = Valkey unless @@schemes.key?('VALKEYS')
+    # Cross-scheme support for Redis URLs
+    @@schemes['REDIS'] = Valkey unless @@schemes.key?('REDIS')
+    @@schemes['REDISS'] = Valkey unless @@schemes.key?('REDISS')
+  end
+end

data/lib/uri-valkey.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Compatibility shim for uri-valkey.rb
+# This file maintains backward compatibility for code that requires 'uri-valkey'
+require_relative 'uri/valkey'

data/lib/uri_valkey.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Compatibility shim for uri_valkey.rb
+# This file maintains backward compatibility for code that requires 'uri_valkey'
+require_relative 'uri/valkey'

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: uri-valkey
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- delano
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 'URI-Valkey: support for parsing Valkey URIs like valkey://host:port/dbindex/key'
+email:
+- gems@solutious.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGES.txt
+- LICENSE.txt
+- README.md
+- lib/uri-valkey.rb
+- lib/uri/perfect_strangers.rb
+- lib/uri/valkey.rb
+- lib/uri/valkey/version.rb
+- lib/uri_valkey.rb
+homepage: https://github.com/delano/uri-valkey
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/delano/uri-valkey
+  source_code_uri: https://github.com/delano/uri-valkey/
+  changelog_uri: https://github.com/delano/uri-valkey/blob/main/CHANGES.txt#L1
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: 'URI-Valkey: support for parsing Valkey URIs'
+test_files: []