timberline 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f2df22b2ea8867378c5b0256c18d5014b75d218
-  data.tar.gz: cebaa4450c46540581d082b0aa137b9c478272a2
+  metadata.gz: 5dcba7d76edc4b00c7060cfa2c01e7df38700912
+  data.tar.gz: f3dad3c3080a4c35db3f91f2b8b599f008039bf7
 SHA512:
-  metadata.gz: c0fed6eec0f3f8c4240e8227331b896180d33b47f02e3a28d48f1dd78abfdca51f93ffa3272edb444e113d2b6b856b72d6764a1638e5788689c16fa5ec713d4b
-  data.tar.gz: 626722046cd800dcf5683c775523a3e41ce0e39a77b161374e1a2d4b80196bde4cc8873fbb5d66050e0636e0ffb82b79939ce041437b97612a8410697edc85df
+  metadata.gz: 03b760d6e84c72d91884ee18f87fa797577839f16e495148c144144780adfeab120e8bb2ffb4661eec4d51d1e4dbc06e14a0faab6cef95400712a3c3a6fbb2d0
+  data.tar.gz: 3cbb508700948108bbabd33e1e24e0f98189ae06545047dec89479cb9e3266aeb7b9116bae2fd6c931434722b77cd5e81b91c21df54c869412174ca1f3f20d7f

data/CHANGELOG

@@ -1,3 +1,6 @@
+0.8.3
+  - Add support for configuring via env var
+  - Add support for Redis sentinels
 0.7.0
   - Add Worker objects
   - Add YARD documentation, publish docs to rubydoc.info

data/README.markdown

@@ -83,7 +83,7 @@ queue (more on that later). There are 3 ways to configure Timberline:
           c.port = 12345
           c.password = "foobar"
         end
-   
+
    ...As long as you run this block before you attempt to access your queues,
    your settings will all take effect. Redis defaults will be used if you omit
    anything.
@@ -99,6 +99,10 @@ queue (more on that later). There are 3 ways to configure Timberline:
 
           TIMBERLINE_YAML = 'path/to/your/yaml/file.yaml'
 
+3. Running on Heroku? Define an environment variable for the URL:
+
+        export TIMBERLINE_URL="redis://:foobar@192.168.1.105:12345/1?timeout=99&namespace=my_namespace"
+
 ### Pushing jobs onto a queue
 
 To push a job onto the queue you'll want to make use of the `Timberline#push`
@@ -151,7 +155,7 @@ you could write a queue processor that reads off of that queue.
 ### Using the binary
 
 In order to make reading off of the queue easier, there's a binary named
-`Timberline` included with this gem. 
+`timberline` included with this gem.
 
 Example:
 
@@ -168,13 +172,44 @@ block until either the process is killed, or until something is added to the
 queue.
 
 There are some options to the Timberline binary that you may find helpful -
-`timberline --help` for more. 
+`timberline --help` for more.
 
 ### Rails
 
 If you're using Timberline in conjunction with a Rails environment, check out
 the [timberline-rails](https://github.com/treehouse/timberline-rails) gem.
 
+### Redis Failover
+
+The Redis client (>= v3.2) is able to [perform automatic Redis
+connection](https://github.com/redis/redis-rb#sentinel-support) failovers by
+using [Redis Sentinel](http://redis.io/topics/sentinel). In cases where this is
+enabled, pass sentinel configuration on to the Redis client using the
+"sentinels" key a configuration:
+
+Via timberline.yml:
+
+```yaml
+host: 127.0.0.1
+sentinels:
+  - host: 127.0.0.1
+    port: 26379
+```
+
+Via the Timberline.configure:
+
+```ruby
+Timberline.configure do |c|
+  # ...
+  c.sentinels = [{ host: 127.0.0.1, port: 26379 }]
+end
+```
+
+Via the ENV VAR
+```bash
+export TIMBERLINE_URL="redis://:foobar@192.168.1.105:12345/1?sentinel=host1:1111&sentinel=host2:2222"
+```
+
 ## TODO
 
 Still to be done:

data/lib/timberline/config.rb

@@ -1,11 +1,13 @@
+require "cgi"
+
 class Timberline
   # Object that manages Timberline configuration. Responsible for Redis configs
   # as well as Timberline-specific configuration values, like how many times an
   # item should be retried in a queue.
   #
-  # @attr [Integer] database part of the redis configuration - index of the 
+  # @attr [Integer] database part of the redis configuration - index of the
   #   redis database to use
-  # @attr [String] host part of the redis configuration - the hostname of the 
+  # @attr [String] host part of the redis configuration - the hostname of the
   #   redis server
   # @attr [Integer] port part of the redis configuration - the port of the
   #   redis server
@@ -21,22 +23,18 @@ class Timberline
   #   should be allowed to retry itself before it is placed on the error queue
   # @attr [Integer] stat_timeout the number of minutes that stats will stay live
   #   in redis before they are expired
+  # @attr [Array] sentinels a list of sentinel hosts that can be connected to
+  #   for failover protection.
   #
   class Config
-    attr_accessor :database, :host, :port, :timeout, :password, 
-                  :logger, :namespace, :max_retries, :stat_timeout
+    attr_accessor :database, :host, :port, :timeout, :password,
+                  :logger, :namespace, :max_retries, :stat_timeout, :sentinels
 
     # Attemps to load configuration from TIMBERLINE_YAML, if it exists.
     # Otherwise creates a default Config object.
-    def initialize 
-      if defined? TIMBERLINE_YAML
-        if File.exists?(TIMBERLINE_YAML)
-          yaml = YAML.load_file(TIMBERLINE_YAML)
-          load_from_yaml(yaml)
-        else
-          raise "Specified Timberline config file #{TIMBERLINE_YAML} is not present."
-        end
-      end
+    def initialize
+      configure_via_yaml
+      configure_via_env
     end
 
     # @return [String] the configured redis namespace, with a default of 'timberline'
@@ -49,27 +47,80 @@ class Timberline
       @max_retries ||= 5
     end
 
-    # @return [Integer] the configured lifetime of stats (in minutes), with a default of 60 
+    # @return [Integer] the configured lifetime of stats (in minutes), with a default of 60
     def stat_timeout
       @stat_timeout ||= 60
     end
 
+    # @return [{host: "x", port: 1}] list of sentinel server
+    def sentinels
+      @sentinels ||= []
+    end
+
     # @return [Hash] a Redis-ready hash for use in instantiating a new redis object.
     def redis_config
       config = {}
 
-      { db: database, host: host, port: port, timeout: timeout, password: password, logger: logger }.each do |name, value|
+      {
+        db: database,
+        host: host,
+        port: port,
+        timeout: timeout,
+        password: password,
+        logger: logger,
+        sentinels: sentinels.empty? ? nil : sentinels
+      }.each do |name, value|
         config[name] = value unless value.nil?
       end
 
       config
     end
 
-  private
+    private
+
+    def configure_via_yaml
+      return unless defined? TIMBERLINE_YAML
+      if File.exist?(TIMBERLINE_YAML)
+        yaml = YAML.load_file(TIMBERLINE_YAML)
+        load_from_yaml(yaml)
+      else
+        fail "Specified Timberline config file #{TIMBERLINE_YAML} is not present."
+      end
+    end
+
+    def convert_if_int(val)
+      # convert strings that only have integers in them to ints
+      val.match(/\A[+-]?\d+\Z/) ? val.to_i : val
+    end
+
+    def configure_via_env
+      return unless ENV.key?("TIMBERLINE_URL")
+
+      uri = URI::Parser.new.parse(ENV["TIMBERLINE_URL"])
+      fail "Must be a redis url, not #{uri.scheme.inspect}" unless uri.scheme == "redis"
+
+      @host = uri.host
+      @port = uri.port
+      @database = convert_if_int(uri.path[1..-1])
+      @password = uri.password
+
+      params = uri.query.nil? ? {} : CGI.parse(uri.query)
+      %w(timeout namespace).each do |setting|
+        next unless params.key?(setting)
+        instance_variable_set("@#{setting}", convert_if_int(params[setting][0]))
+      end
+      if params.key?("sentinel")
+        params["sentinel"].each do |val|
+          host, port = val.split(":")
+          self.sentinels += [{ "host" => host, "port" => convert_if_int(port) }]
+        end
+      end
+    end
+
     def load_from_yaml(yaml_config)
-      raise "Missing yaml configs!" if yaml_config.nil?
-      ["database","host","port","timeout","password","logger","namespace"].each do |setting|
-        self.instance_variable_set("@#{setting}", yaml_config[setting])
+      fail "Missing yaml configs!" if yaml_config.nil?
+      %w(database host port timeout password namespace sentinels).each do |setting|
+        instance_variable_set("@#{setting}", yaml_config[setting])
       end
     end
   end

data/lib/timberline/version.rb

@@ -1,4 +1,4 @@
 class Timberline
   # The current canonical version for Timberline.
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/spec/config/test_config.yaml

@@ -4,3 +4,7 @@ timeout: 10
 password: foo
 database: 3
 namespace: treecurve
+sentinels:
+  -
+    host: localhost
+    port: 111111

data/spec/lib/timberline/config_spec.rb

@@ -2,6 +2,47 @@ require 'spec_helper'
 
 describe Timberline::Config do
   describe "newly created" do
+    context "when the TIMBERLINE_URL env var is defined" do
+      before do
+        ENV["TIMBERLINE_URL"] = "redis://:apassword@ahostname:9000/3?timeout=666&namespace=foobar&sentinel=sentinel1:1&sentinel=sentinel2:2"
+      end
+
+      after do
+        ENV.delete("TIMBERLINE_URL")
+      end
+
+      it "loads the host variable from the env var" do
+        expect(subject.host).to eq("ahostname")
+      end
+
+      it "loads the port variable from the env var" do
+        expect(subject.port).to eq(9000)
+      end
+
+      it "loads the timeout variable from the env var" do
+        expect(subject.timeout).to eq(666)
+      end
+
+      it "loads the password from the env var" do
+        expect(subject.password).to eq("apassword")
+      end
+
+      it "loads the database from the env var" do
+        expect(subject.database).to eq(3)
+      end
+
+      it "loads the namespace from the env var" do
+        expect(subject.namespace).to eq("foobar")
+      end
+
+      it "loads the sentinel servers" do
+        expect(subject.sentinels).to eq([
+          { "host" => "sentinel1", "port" => 1 },
+          { "host" => "sentinel2", "port" => 2 }
+        ])
+      end
+    end
+
     context "when the TIMBERLINE_YAML constant is defined" do
       context "and the specified file exists" do
         before do
@@ -35,6 +76,11 @@ describe Timberline::Config do
         it "loads the namespace from the config file" do
           expect(subject.namespace).to eq("treecurve")
         end
+
+        it "loads the sentinels from the config file" do
+          sentinels = [{"host" => "localhost", "port" => 111111}]
+          expect(subject.sentinels).to eq sentinels
+        end
       end
 
       context "and the specified file doesn't exist" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timberline
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Tommy Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -202,4 +202,14 @@ signing_key:
 specification_version: 4
 summary: Timberline is a simple and extensible queuing system built in Ruby and backed
   by Redis.
-test_files: []
+test_files:
+- spec/config/test_config.yaml
+- spec/lib/timberline/anonymous_worker_spec.rb
+- spec/lib/timberline/config_spec.rb
+- spec/lib/timberline/envelope_spec.rb
+- spec/lib/timberline/queue_spec.rb
+- spec/lib/timberline_spec.rb
+- spec/spec_helper.rb
+- spec/support/timberline_reset.rb
+- spec/support/timberline_yaml.rb
+has_rdoc: