rubykiq 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 949a8300a8a43c43d1105663f865d8cae2616743
-  data.tar.gz: e85504b5f5d8927a3a4ce4dbb9ffd467d95f5fdf
+  metadata.gz: fe8a63e0620e49a3abee5a4b793f6a47de9d2134
+  data.tar.gz: 538763a88753b76a2d0647b0a66efba79da5db4f
 SHA512:
-  metadata.gz: 67ecd131870891c2c92cd955e576506c45784c99caf22e93bed4ce771addacafa80de9a45535defa281c4a0570760e99fba03c16f516382a9ba15843b4d68342
-  data.tar.gz: e980fc1dc5d22d6572a33b05787369664bc2eb3f32899992896c100e0803254aee1d514d6bef542ae3d1d184d245093823d7c5be1fd4a429f54a62df07a810dc
+  metadata.gz: 61192efb893a6bbe6d0d094e3c672a56ae4cea8e1e6d65dbcdc7c21762423f49fcfd6f6e54d311c7852844af4bafeee5a069342a2e9fe4188bae1109a72bedfd
+  data.tar.gz: 000c33af26dfd8edb0342f35265f2e85284affbd2e49338af480af75fee90db40b38abb08618981510d761136443da1d25513cb0ce8e559ec2fb391b56b9f79e

data/README.md

@@ -16,9 +16,9 @@ require 'rubykiq'
 ## Features / Usage Examples
 
 * [Redis](http://redis.io) has support for [alternative drivers](https://github.com/redis/redis-rb#alternate-drivers), Rubykiq is tested with these in mind. (eg `:synchrony`)
-* the `:class` parameter can be the Class or a String of the Class (eg push jobs to Sidekiq from anywhere, not just where Sidekiq has the classes loaded)
+* the `:class` parameter can be a `Class` or a `String` of a Class (eg push jobs to Sidekiq from anywhere, not just where you have Sidekiq classes loaded)
 * The `:at` parameter supports `Time`, `Date` and any `Time.parse`-able strings.
-* Pushing multiple and singular jobs has the same interface (simply nest args)
+* Pushing multiple and singular jobs have the same interface (simply nest args)
 * Slightly less gem dependecies, and by that I mean `Sidekiq::Client` without `Celluloid` (which is already very light!)
 * Easier configuration (IMO)
 
@@ -33,30 +33,30 @@ Rubykiq.driver = :synchrony
 Rubykiq.namespace = 'background'
 
 # uses 'default' queue unless specified
-Rubykiq.push(:class => 'Worker', :args => ['foo', 1, :bat => 'bar'])
+Rubykiq.push(class: 'Worker', args: ['foo', 1, bat: 'bar'])
 
 # args are optionally set to empty
-Rubykiq.push(:class => 'Scheduler', :queue => 'scheduler')
+Rubykiq.push(class: 'Scheduler', queue: 'scheduler')
 
 # will batch up multiple jobs
-Rubykiq.push(:class => 'Worker', :args => [['foo'], ['bar']]) 
+Rubykiq.push(class: 'Worker', args: [['foo'], ['bar']]) 
 
 # at param can be a 'Time', 'Date' or any 'Time.parse'-able strings
-Rubykiq.push(:class => 'DelayedHourMailer', :at => Time.now + 3600)
-Rubykiq.push(:class => 'DelayedDayMailer', :at => DateTime.now.next_day)
-Rubykiq.push(:class => 'DelayedMailer', :at => '2013-01-01T09:00:00Z')
+Rubykiq.push(class: 'DelayedHourMailer', at: Time.now + 3600)
+Rubykiq.push(class: 'DelayedDayMailer', at: DateTime.now.next_day)
+Rubykiq.push(class: 'DelayedMailer', at: '2013-01-01T09:00:00Z')
 
 # alias based sugar
-job = { :class => 'Worker' }
+job = { class: 'Worker' }
 Rubykiq << job
 
 # create multiple Rubykiq clients with their own drivers
 ruby_client = Rubykiq::Client.new
-hiredis_client = Rubykiq::Client.new(:driver => :hiredis)
+hiredis_client = Rubykiq::Client.new(driver: :hiredis)
 
 # create multiple Rubykiq clients with their own namespaces
-foo_client = Rubykiq::Client.new(:namespace => 'foo')
-bar_client = Rubykiq::Client.new(:namespace => 'bar')
+foo_client = Rubykiq::Client.new(namespace: 'foo')
+bar_client = Rubykiq::Client.new(namespace: 'bar')
 ```
 
 ## Caveats

data/lib/rubykiq.rb

@@ -1,3 +1,4 @@
+require 'thread'
 require 'forwardable'
 require 'rubykiq/client'
 require 'rubykiq/connection'
@@ -17,6 +18,15 @@ module Rubykiq
   #
   # @return [Rubykiq::Client]
   def self.client(options = {})
-    @client ||= Rubykiq::Client.new(options)
+    initialize_client(options) unless defined?(@client)
+    @client
+  end
+
+  private
+
+  def self.initialize_client(options = {})
+    Thread.exclusive do
+      @client = Rubykiq::Client.new(options)
+    end
   end
 end

data/lib/rubykiq/client.rb

@@ -1,4 +1,5 @@
 require 'time'
+require 'thread'
 require 'multi_json'
 require 'securerandom'
 require 'connection_pool'
@@ -48,15 +49,12 @@ module Rubykiq
     # @return [::ConnectionPool]
     def connection_pool(options = {}, &block)
       options = valid_options.merge(options)
-
-      @connection_pool ||= ::ConnectionPool.new(timeout: redis_pool_timeout, size: redis_pool_size) do
-        Rubykiq::Connection.new(options)
-      end
+      initialize_connection_pool(options) unless defined?(@connection_pool)
 
       if block_given?
         @connection_pool.with(&block)
       else
-        return @connection_pool
+        @connection_pool
       end
     end
 
@@ -197,5 +195,15 @@ module Rubykiq
 
       normalized_time
     end
+
+    private
+
+    def initialize_connection_pool(options = {})
+      Thread.exclusive do
+        @connection_pool = ::ConnectionPool.new(timeout: redis_pool_timeout, size: redis_pool_size) do
+          Rubykiq::Connection.new(options)
+        end
+      end
+    end
   end
 end

data/lib/rubykiq/connection.rb

@@ -14,20 +14,19 @@ module Rubykiq
       url = options.delete(:url) { determine_redis_provider }
       namespace = options.delete(:namespace)
       driver = options.delete(:driver)
-      @redis_connection ||= build_conection(url, namespace, driver)
-      @redis_client ||= @redis_connection.client
+      @redis_connection = initialize_conection(url, namespace, driver)
+      @redis_client = @redis_connection.client
       @redis_connection
     end
 
     private
 
-    # lets try and fallback to another redis url
     def determine_redis_provider
+      # lets try and fallback to another redis url
       ENV['REDISTOGO_URL'] || ENV['REDIS_PROVIDER'] || ENV['REDIS_URL'] || 'redis://localhost:6379/0'
     end
 
-    # construct a namespaced redis connection
-    def build_conection(url, namespace, driver)
+    def initialize_conection(url, namespace, driver)
       client = ::Redis.new(url: url, driver: driver)
       ::Redis::Namespace.new(namespace, redis: client)
     end

data/lib/rubykiq/version.rb

@@ -1,3 +1,3 @@
 module Rubykiq
-  VERSION = '1.0.0' unless defined?(Rubykiq::VERSION)
+  VERSION = '1.0.1' unless defined?(Rubykiq::VERSION)
 end

data/spec/unit/client_spec.rb

@@ -3,7 +3,6 @@ require 'hiredis'
 require 'em-synchrony'
 
 describe Rubykiq::Client do
-
   before(:all) { Timecop.freeze }
   after(:all) { Timecop.return }
   let(:ruby_client) { Rubykiq::Client.new(driver: :ruby, namespace: :ruby) }
@@ -12,15 +11,11 @@ describe Rubykiq::Client do
 
   # eg with a variety of drivers
   [:ruby, :hiredis, :synchrony].each do |driver|
-
     # skip incompatible drivers when running in JRuby
     next if jruby? && (driver == :hiredis || :synchrony)
-
     context "using driver '#{driver}'" do
-
       # make sure the let is the current client being tested
       let(:client) { send("#{driver}_client") }
-
       describe :defaults do
         subject { client }
         its(:namespace) { should eq driver }
@@ -30,9 +25,7 @@ describe Rubykiq::Client do
       end
 
       describe :push do
-
         context :validations do
-
           context 'with an incorrect message type' do
             it 'raises an ArgumentError' do
               expect { client.push([]) }.to raise_error(ArgumentError, /Message must be a Hash/)
@@ -58,19 +51,14 @@ describe Rubykiq::Client do
               expect { client.push(class: Class, args: ['foo', 1, { bat: 'bar' }]) }.to raise_error(ArgumentError, /Message class must be a String representation of the class name/)
             end
           end
-
         end
 
         # eg singular and batch
         arguments = [[{ bat: 'bar' }], [[{ bat: 'bar' }], [{ bat: 'foo' }]]]
         arguments.each do |args|
-
           context "with args #{args}" do
-
             it "should create #{args.length} job(s)" do
-
               wrap_in_synchrony?(driver) do
-
                 client.connection_pool do |connection|
                   connection.flushdb
                 end
@@ -84,21 +72,15 @@ describe Rubykiq::Client do
                   job = MultiJson.decode(job, symbolize_keys: true)
                   expect(job).to have_key(:jid)
                 end
-
               end
-
             end
 
             # eg with a variety of different time types
             times = [Time.now, DateTime.now, Time.now.utc.iso8601, Time.now.to_f]
             times.each do |time|
-
               context "with time #{time} (#{time.class})" do
-
                 it "should create #{args.length} job(s)" do
-
                   wrap_in_synchrony?(driver) do
-
                     client.connection_pool do |connection|
                       connection.flushdb
                     end
@@ -113,23 +95,13 @@ describe Rubykiq::Client do
                       expect(job).to have_key(:at)
                       expect(job[:at]).to be_within(1).of(Time.now.to_f)
                     end
-
                   end
-
                 end
-
               end
-
             end
-
           end
-
         end
-
       end
-
     end
-
   end
-
 end

data/spec/unit/connection_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Rubykiq::Connection do
-
   describe :defaults do
     subject { Rubykiq::Connection.new }
     its(:namespace) { should be_nil }
@@ -12,7 +11,6 @@ describe Rubykiq::Connection do
   end
 
   describe :options do
-
     context :custom do
       subject { Rubykiq::Connection.new(namespace: 'yyy') }
       its(:namespace) { should eq 'yyy' }
@@ -26,12 +24,10 @@ describe Rubykiq::Connection do
         end
       end
     end
-
   end
 
   describe :env do
     subject { Rubykiq::Connection.new }
-
     [{ name: 'REDISTOGO_URL', value: 'redistogo' }, { name: 'REDIS_PROVIDER', value: 'redisprovider' }, { name: 'REDIS_URL', value: 'redisurl' }].each do | test_case |
       context "with ENV[#{test_case[:name]}]" do
         before do
@@ -43,7 +39,5 @@ describe Rubykiq::Connection do
         its(:host) { should eq test_case[:value] }
       end
     end
-
   end
-
 end

data/spec/unit/rubykiq_spec.rb

@@ -2,30 +2,37 @@ require 'spec_helper'
 
 describe Rubykiq do
 
-  describe :version do
-    subject { Rubykiq::VERSION }
-    it { should be_kind_of(String) }
-  end
 
   describe :client do
-    subject { Rubykiq.client }
-    it { should be_kind_of(Rubykiq::Client) }
+    it 'should return a Client' do
+      expect(Rubykiq.client).to be_kind_of(Rubykiq::Client)
+    end
+
+    it 'should be thread safe' do
+      t1 = Thread.new { client = Rubykiq.client; sleep 0.1; client }
+      t2 = Thread.new { Rubykiq.client }
+      expect(t1.value).to eql t2.value
+    end
   end
 
   describe :connection_pool do
-    subject { Rubykiq.connection_pool }
-    it { should be_kind_of(::ConnectionPool) }
+    it 'should return a ConnectionPool' do
+      expect(Rubykiq.connection_pool).to be_kind_of(::ConnectionPool)
+    end
+    it 'should be thread safe' do
+      t1 = Thread.new { connection_pool = Rubykiq.connection_pool; sleep 0.1; connection_pool }
+      t2 = Thread.new { Rubykiq.connection_pool }
+      expect(t1.value).to eql t2.value
+    end
   end
 
   # for every valid option
   Rubykiq::Client::VALID_OPTIONS_KEYS.each do |key|
-
     describe key do
       subject { Rubykiq }
       it { should respond_to key }
       it { should respond_to "#{key}=".to_sym }
     end
-
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubykiq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Karl Freeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis