redis-sentinel-url 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77833f0fe1cdc51c0485f73319d020d67ee97898d6435c106bf8be9054d369ac
+  data.tar.gz: a8a3daed412f42ac2cc4a2ef1258bae27d7b42dac96afa5d539806a2bdfee080
+SHA512:
+  metadata.gz: 6af25f1d0aca66c772c999c8a3b7780b8ff334d3cc50935f950d146b90c5602648cc80922fdd8e52d9ba036eef7c6be121660aea158ff09426896419a76d196c
+  data.tar.gz: 6d2f06c0cab5c926d6773a25eeebfafe8e1261726b0d161cca59292574e2ab56642634f582cc356e26d3d492392319c85d8aa7a55da17823b9f5c979f8d3d564

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/Gemfile.lock
+/pkg/
+/tmp/
+/vendor/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redis-sentinel-url.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rob Holland
+
+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,43 @@
+# Redis Sentinel URL
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-sentinel-url'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-sentinel-url
+
+## Usage
+
+Once the code is `require`d (which happens automatically if you are using bundler) you can use the following URL syntax in the `REDIS_URL` environment variable, or passed to `Redis.new(url: ...)`:
+
+`redis+sentinel://host[:port][/service_name[/db]][?param1=value1[&param2=value=2&...]]`
+
+This syntax is based on the syntax from https://github.com/exponea/redis-sentinel-url but does not support multiple sentinel hosts or passing passwords.
+
+The service name defaults to 'mymaster' and the sentinel port defaults to 26379. There is no default database number set by this library, the parameter is only passed to redis if it set.
+
+Note: You don't need to manually call any of the library code, Redis is patched to handle the sentinel URL syntax automatically when the library is required.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/clearbit/redis-sentinel-url.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis/sentinel/url"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis/sentinel/url.rb

@@ -0,0 +1,68 @@
+require "redis"
+require "redis/sentinel/url/version"
+
+class Redis
+  module Sentinel
+    class URL
+      DEFAULT_SENTINEL_PORT    = 26379
+      DEFAULT_SENTINEL_SERVICE = 'mymaster'
+
+      attr_reader :uri
+
+      def self.parse(url)
+        new(url).parse
+      end
+
+      def initialize(url)
+        @uri = URI(url)
+      end
+
+      # [/service_name[/db]]
+      def path_options
+        path_parts = uri.path.split('/')
+        case path_parts.length
+        when 3
+          { service_name: path_parts[1], db: path_parts[2] }
+        when 2
+          { service_name: path_parts[1] }
+        else
+          {}
+        end
+      end
+
+      def query_options
+        CGI::parse(uri.query.to_s).transform_keys(&:to_sym)
+      end
+
+      def parse
+        uri_options  = path_options.merge(query_options)
+        service_name = uri_options.delete(:service_name) || DEFAULT_SENTINEL_SERVICE
+
+        uri_options[:url]       = "redis://#{service_name}"
+        uri_options[:sentinels] = [{ host: uri.host, port: uri.port || DEFAULT_SENTINEL_PORT }]
+
+        uri_options
+      end
+    end
+
+    module OptionParser
+      def _parse_options(options)
+        return options if options[:_parsed]
+
+        default_url = ::Redis::Client::DEFAULTS[:url]
+        default_url = default_url.call if default_url.respond_to?(:call)
+
+        url = options[:url] || default_url
+        if url.to_s.start_with?('redis+sentinel://')
+          options = options.merge(Redis::Sentinel::URL.parse(url))
+        end
+
+        super(options)
+      end
+    end
+  end
+end
+
+class ::Redis::Client
+  prepend Redis::Sentinel::OptionParser
+end

data/lib/redis/sentinel/url/version.rb

@@ -0,0 +1,7 @@
+class Redis
+  module Sentinel
+    class Url
+      VERSION = "0.1.0"
+    end
+  end
+end

data/redis-sentinel-url.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis/sentinel/url/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-sentinel-url"
+  spec.version       = Redis::Sentinel::Url::VERSION
+  spec.authors       = ["Rob Holland"]
+  spec.email         = ["rob@clearbit.com"]
+
+  spec.summary       = %q{Adds support for configuring sentinel mode via REDIS_URL to redis-rb}
+  spec.description   = %q{Adds support for configuring sentinel mode via REDIS_URL to redis-rb}
+  spec.homepage      = "http://github.com/clearbit/redis-sentinel-url"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "redis", "~> 4.0.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: redis-sentinel-url
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Holland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Adds support for configuring sentinel mode via REDIS_URL to redis-rb
+email:
+- rob@clearbit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis/sentinel/url.rb
+- lib/redis/sentinel/url/version.rb
+- redis-sentinel-url.gemspec
+homepage: http://github.com/clearbit/redis-sentinel-url
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Adds support for configuring sentinel mode via REDIS_URL to redis-rb
+test_files: []