redic 0.0.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bbf2e9c0a04c38c2fedc078ec27d1f92f5c6d4d
-  data.tar.gz: 9e58dc7004c43eceee2d4207551bd48aad7ecebb
+  metadata.gz: 982edbdc6b3b3ca417621ca43967117805d0faa9
+  data.tar.gz: 2f4b5a8ee99890f5e432cf5606984a3f683303de
 SHA512:
-  metadata.gz: 89892ba684ac2c9ca56d433feadf3871d3dd89a541e850fe717bf9c067e6e0d84730f73f7e9d7dfde5b3ca950ef173a22c461356eedf7e4a5c09abab101bd1d7
-  data.tar.gz: 268b97ee191a5092dc63ca8658cc5af6eaf66ebf75413119e7255643300934c0554ca18bcf592c2f64d15927264b7813c70d98a8a81031866bf37c21b51779a5
+  metadata.gz: b4e520979e52233b4137c02463ea4fd6d1a7a222e3ec6665999fce604ed534a99ef36d05253bcce0255f7fec16a557dfc6b81f78e340c2dceb8a70b6ed9694e5
+  data.tar.gz: 080f253def0a1a5d0c7357a81b989a523a557e40de9b1d254fa0ef96c993b2738ed9e81be8656e27a031ff2ae7c3e1648a18f83c133c8a84c07e52a423965541

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Michel Martens, Cyril David
+Copyright (c) 2013-2014 Michel Martens, Cyril David
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -21,13 +21,46 @@ redis.call("SET", "foo", "bar")
 assert_equal "bar", redis.call("GET", "foo")
 
 # Pipelining is implemented by buffering commands,
-# then calling Redic#run
+# then calling Redic#commit
 redis.queue("SET", "foo", "bar")
 redis.queue("GET", "foo")
 
 assert_equal ["OK", "bar"], redis.commit
 ```
 
+You can provide the password and the database to be selected. The
+format for Redis URLs is `redis://user:pass@host:port/db`. As
+Redis only needs a password for authentication, the user can be
+omitted:
+
+```ruby
+# Connect to localhost:6380 using "bar" as password and use the
+# database 2. Both AUTH and SELECT commands are issued after
+# connecting. The user part of the URL is not provided.
+redis = Redic.new("redis://:bar@localhost:6380/2")
+```
+
+It is also possible to configure a timeout for the connection. The
+default timeout is 10 seconds.
+
+```ruby
+# Timeout expressed in microseconds.
+redis = Redic.new(timeout: 2_000_000)
+redis.timeout == 2_000_000 #=> true
+```
+
+Here's one final example using both a Redis URL and a timeout:
+
+```ruby
+# It's recommended to store the REDIS_URL as an environment
+# variable. Use `fetch` to retrieve values that must be present,
+# as it raises an error if the value is not found.
+REDIS_URL = ENV.fetch("REDIS_URL")
+REDIS_TIMEOUT = ENV.fetch("REDIS_TIMEOUT")
+
+redis = Redic.new(REDIS_URL, timeout: REDIS_TIMEOUT)
+```
+
 ## Differences with redis-rb
 
 Redic uses [hiredis][hiredis] for the connection and for parsing

data/lib/redic.rb

@@ -1,12 +1,12 @@
-require "redic/client"
+require_relative "redic/client"
 
 class Redic
   attr :url
   attr :client
 
-  def initialize(url = "redis://127.0.0.1:6379")
+  def initialize(url = "redis://127.0.0.1:6379", timeout: 10_000_000)
     @url = url
-    @client = Redic::Client.new(url)
+    @client = Redic::Client.new(url, timeout)
     @queue = []
   end
 
@@ -34,4 +34,8 @@ class Redic
   ensure
     @queue.clear
   end
+
+  def timeout
+    @client.timeout
+  end
 end

data/lib/redic/client.rb

@@ -1,10 +1,13 @@
-require "redic/connection"
+require_relative "connection"
 require "uri"
 
 class Redic
   class Client
-    def initialize(url)
+    attr :timeout
+
+    def initialize(url, timeout)
       @uri = URI.parse(url)
+      @timeout = timeout
       @connection = nil
       @semaphore = Mutex.new
     end
@@ -31,18 +34,28 @@ class Redic
   private
     def establish_connection
       begin
-        @connection = Redic::Connection.new(@uri)
+        @connection = Redic::Connection.new(@uri, @timeout)
       rescue StandardError => err
         raise err, "Can't connect to: %s" % @uri
       end
 
       authenticate
+      select
     end
 
     def authenticate
       if @uri.password
         @semaphore.synchronize do
-          write [:auth, @uri.password]
+          write ["AUTH", @uri.password]
+          read
+        end
+      end
+    end
+
+    def select
+      if @uri.path
+        @semaphore.synchronize do
+          write ["SELECT", @uri.path[1..-1]]
           read
         end
       end

data/lib/redic/connection.rb

@@ -2,15 +2,13 @@ require "hiredis/connection"
 
 class Redic
   module Connection
-    TIMEOUT = 10_000_000
-
-    def self.new(uri)
+    def self.new(uri, timeout)
       connection = Hiredis::Connection.new
 
       if uri.scheme == "unix"
-        connection.connect_unix(uri.path, TIMEOUT)
+        connection.connect_unix(uri.path, timeout)
       else
-        connection.connect(uri.host, uri.port, TIMEOUT)
+        connection.connect(uri.host, uri.port, timeout)
       end
 
       connection

data/redic.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "redic"
-  s.version           = "0.0.8"
+  s.version           = "1.0.0"
   s.summary           = "Lightweight Redis Client"
   s.description       = "Lightweight Redis Client"
   s.authors           = ["Michel Martens", "Cyril David"]

data/tests/redic_test.rb

@@ -1,6 +1,7 @@
-require File.expand_path("../lib/redic", File.dirname(__FILE__))
+require "cutest"
+require_relative "../lib/redic"
 
-REDIS_URL = "redis://localhost:6379/3"
+REDIS_URL = "redis://localhost:6379/"
 
 prepare do
   Redic.new(REDIS_URL).call("FLUSHDB")
@@ -11,7 +12,17 @@ setup do
 end
 
 test "url" do |c|
-  assert_equal "redis://localhost:6379/3", c.url
+  assert_equal "redis://localhost:6379/", c.url
+end
+
+test "timeout" do |c1|
+  # Default timeout is 10 seconds
+  assert_equal 10_000_000, c1.timeout
+
+  # Timeout configured to 200_000 microseconds
+  c2 = Redic.new(timeout: 200_000)
+
+  assert_equal 200_000, c2.timeout
 end
 
 test "normal commands" do |c|

data/tests/unix_test.rb

@@ -1,4 +1,5 @@
-require File.expand_path("../lib/redic", File.dirname(__FILE__))
+require "cutest"
+require_relative "../lib/redic"
 
 setup do
   Redic.new("unix:///tmp/redis.sock")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redic
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Michel Martens
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis