uri-redis 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fa796076bf7ed89fabf28ff901ecce357f10d1a93b09dada70b8ba2185f8bff
-  data.tar.gz: 16b72d3fd5d6a4e41e95e8195a0633d7784245a6eb3d272da476a27845473e36
+  metadata.gz: a7c320d796599dbe819c6f6f42ab5655fd476c6c4c14fbb5e2e06b96d406ed0b
+  data.tar.gz: 82a9de5b109832c565cbded9aa9311020bf4937b27959086941582caa5c3403c
 SHA512:
-  metadata.gz: 38b55796fce214f4093f75284e2216a673794c383a9068c79bb6bda833352e9d97d4396b54e06a27fd29c9114fda246923979bc255b4d263e44340ad6a9431d5
-  data.tar.gz: b7d135ac66b84e03759185c42022cc01106d71cee2ac72b3c07f57caf306db7f367a9eb53c76fb1f53c3f54eb9a61f7c6759009106722a7dd826be5389dfc8b2
+  metadata.gz: b7a975c5b9aadd178da1f52d25910dc4b9bfd33b065cfbd876dfd4b622de860a2a31e0a99e2e30b541ed72571a1713a00981f0774f7ce932c41ac221077589b4
+  data.tar.gz: ae0da4815dddaa945093437f9ec2df218ec0e29be9b4f73cef0460d9046038d0933e4eb4e28f01b60b84d1550ae7c1e28ecb344026c4fae1dd27c01aebb89dbe

data/CHANGES.txt

@@ -1,5 +1,9 @@
 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.

data/Gemfile

@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rake", "~> 13.0"
 gem "redis", ">= 4.8", "< 7"
-gem "rubocop", "~> 1.21"
 
 group :development do
+  gem "rake", "~> 13.0"
+  gem "rubocop", "~> 1.21"
   gem "tryouts", "~>2.2.0"
 end

data/README.md

@@ -1,4 +1,4 @@
-# URI-Redis v1.2 (2024-05-20)
+# URI-Redis v1.3 (2024-06-15)
 
 Creates a URI object for Redis URLs.
 
@@ -12,11 +12,23 @@ e.g.
     require 'uri/redis'
 
     conf = URI.parse 'redis://localhost:4380/2'
+    conf.scheme               # => "redis"
     conf.host                 # => localhost
     conf.port                 # => 4380
     conf.db                   # => 2
     conf.to_s                 # => redis://localhost:4380/2
-    conf
+```
+
+### SSL Support
+
+SSL is supported by using the `rediss` scheme. Note: SSL support is only available in Redis (Server) 6.0 and later and via redis-rb 4.7 and later.
+
+```ruby
+    require 'uri/redis'
+
+    conf = URI.parse 'rediss://localhost:4380/2'
+    conf.scheme               # => "rediss"
+    conf.to_s                 # => rediss://localhost:4380/2
 ```
 
 
@@ -25,7 +37,7 @@ e.g.
 Get it in one of the following ways:
 
 * `gem install uri-redis`
-* `git clone git+ssh://github.com/delano/uri-redis.git`
+* `git clone git@github.com:delano/uri-redis.git`
 
 
 ## About

data/lib/uri/redis/version.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "uri/generic"
+
 module URI
-  module Redis
-    VERSION = "1.2.0"
+  class Redis < URI::Generic
+    VERSION = "1.3.0"
     SUMMARY = "A Ruby library for parsing, building and normalizing redis URLs"
   end
 end

data/lib/uri/redis.rb

@@ -66,14 +66,16 @@ module URI
       hsh = {
         host: host,
         port: port,
-        db: db
+        db: db,
+        ssl: scheme == 'rediss'
       }.merge(parse_query(query))
       hsh[:password] = password if password
+      hsh[:timeout] = hsh[:timeout].to_i if hsh.key?(:timeout)
       hsh
     end
 
     def serverid
-      format("redis://%s:%s/%s", host, port, db)
+      format('%s://%s:%s/%s', scheme, host, port, db)
     end
 
     private
@@ -102,26 +104,20 @@ module URI
 
   if URI.respond_to?(:register_scheme)
     URI.register_scheme "REDIS", Redis
+    URI.register_scheme "REDISS", Redis
   else
     @@schemes['REDIS'] = Redis
+    @@schemes['REDISS'] = Redis
   end
 end
 
 # Adds a URI method to Redis
 class Redis
   def self.uri(conf = {})
-    URI.parse format("redis://%s:%s/%s", conf[:host], conf[:port], conf[:db])
+    URI.parse format("%s://%s:%s/%s", conf[:ssl] ? 'rediss' : 'redis', conf[:host], conf[:port], conf[:db])
   end
-  if defined?(Redis::VERSION) && Redis::VERSION >= "2.0.0"
-    def uri
-      URI.parse format("redis://%s:%s/%s", @client.host, @client.port, @client.db)
-    end
-  else
-    # Redis < 2.0.0
-    class Client
-      def uri
-        URI.parse format("redis://%s:%s/%s", @host, @port, @db)
-      end
-    end
+
+  def uri
+    URI.parse @client.id
   end
 end

data/try/10_uri_redis_try.rb

@@ -10,6 +10,11 @@ uri = URI.parse "redis://localhost/2"
 [uri.db, uri.host, uri.port]
 #=> [2, 'localhost', 6379]
 
+## Parsed URI can be accessed via conf hash
+uri = URI.parse "redis://localhost:16739/2"
+[uri.scheme, uri.conf]
+#=> ['redis', {:host=>"localhost", :port=>16739, :db=>2, :ssl=>false}]
+
 ## Can parse a key name
 uri = URI.parse "redis://localhost/2/v1:arbitrary:key"
 [uri.key, uri.db, uri.host, uri.port]
@@ -26,3 +31,8 @@ uri = URI.parse "redis://localhost/2/v1:arbitrary:key"
 uri.key = "v2:arbitrary:key"
 uri.to_s
 #=> 'redis://localhost/2/v2:arbitrary:key'
+
+## Support rediss
+uri = URI.parse "rediss://localhost"
+[uri.scheme, uri.conf]
+#=> ["rediss", {:host=>"localhost", :port=>6379, :db=>0, :ssl=>true}]

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: uri-redis
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - delano
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-06-15 00:00:00.000000000 Z
 dependencies: []
-description: 'URI-Redis: support for parsing Redis URIs like redis://host:port/dbindex'
+description: 'URI-Redis: support for parsing Redis URIs like redis://host:port/dbindex/key'
 email:
 - gems@solutious.com
 executables: []