redis_notifier 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8304b168f4328e2341feb1ae5d8e6e7257255d1e
-  data.tar.gz: 59f00c3991471a5db839342c9e1521f136ad33b7
+  metadata.gz: 093e0b8a04f3212d26e302cc28fd457654894d1c
+  data.tar.gz: d490247df436cfd0a4177a08db021203cb62299c
 SHA512:
-  metadata.gz: b0879c3b7f5efe0b8d7d1be8284b50af42fecf7fc59dd981f7f83012a7be1949762f630b27931b8d95296a20b8c5a7c0cd7c671656b892f38d359d405799623e
-  data.tar.gz: 35d482d305040376ca2a6d04f5f60f20f9ee7c1642ab8bcd1969e97344da133576bef303d5e20d07f2bbee6e92e3b85ea8cb269550b6172fa06274c7ffb3a73a
+  metadata.gz: 127750efc33ff3bbdd3e75b8b38fbd1e7180aa477013f9b91c47c40b1dc55eb42b4716376ffa8874a02c35dd800f6b0cab982aad68397fcf9922490dad598f16
+  data.tar.gz: dcdf619849ab03fe545b2e6ffb042ffd7a8f5f96d66fca9c3be0c464fb370652f54790c3c6f6b03912040538baa26a2ec09660ee8feb2865f6aa2c960b763d32

data/README.md

@@ -1,6 +1,6 @@
 # RedisNotifier
 
-TODO: Write a gem description
+Observe redis keyevent/keyspace and notify
 
 ## Installation
 
@@ -20,7 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'redis'
+require 'redis_notifier'
+
+redis_notifier = RedisNotifier::Base.new(Redis.new)
+
+redis_notifier.on_event(:expired) do |key|
+  puts "** #{key} as expired"
+end
+
+redis_notifier.observe_key('keys:my_key') do |event|
+  puts ">> event '#{event}' on 'keys:my_key"
+end
+
+redis_notifier.listen
+```
 
 ## Contributing
 

data/examples/simple.rb

@@ -0,0 +1,16 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'redis'
+require 'redis_notifier'
+
+redis_notifier = RedisNotifier::Base.new(Redis.new)
+
+redis_notifier.on_event(:expired) do |key|
+  puts "** #{key} as expired"
+end
+
+redis_notifier.observe_key('keys:my_key') do |event|
+  puts ">> event '#{event}' on 'keys:my_key"
+end
+
+redis_notifier.listen

data/lib/redis_notifier/version.rb

@@ -1,3 +1,3 @@
 module RedisNotifier
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/redis_notifier.rb

@@ -23,16 +23,16 @@ module RedisNotifier
       @db = db.to_s
       @redis = redis
       redis.config(:set, NOTIFY_KEYSPACE_EVENTS, keyspace_config)
-      @callbacks = { keys: {}, events: {} }
+      @callbacks = { key: {}, event: {} }
       @listened_channels = []
     end
 
     def on_event(event_name, &block)
-      on :events, event_name, &block
+      on :event, event_name, &block
     end
 
     def observe_key(key, &block)
-      on :keys, key, &block
+      on :key, key, &block
     end
 
     def on(type, prefix, &block)
@@ -44,19 +44,20 @@ module RedisNotifier
     end
 
     def build_channel_for(type, prefix)
-      case type
-      when :events
-        "__keyevent@#{db}__:#{prefix}"
-      when :keys
-        "__keyspace@#{db}__:#{prefix}"
+      namespace = case type
+      when :event
+        'keyevent'
+      when :key
+        'keyspace'
       end
+      "__#{namespace}@#{db}__:#{prefix}"
     end
 
     def find_type_from(channel)
       if channel.include?('__keyevent@')
-        :events
+        :event
       elsif channel.include?('__keyspace@')
-        :keys
+        :key
       else
         nil
       end

data/redis_notifier.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1.7"
+  spec.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.7'
 end

data/spec/redis_notifier/base_spec.rb

@@ -0,0 +1,35 @@
+describe RedisNotifier::Base do
+
+  let(:redis) do
+    redis = double(:redis)
+    allow(redis).to receive(:config)
+    redis
+  end
+  let(:db) { '0' }
+  subject { RedisNotifier::Base.new(redis, db) }
+
+  describe '#initialize' do
+    let(:keyspace_config) { 'foo' }
+    it 'calls redis config.' do
+      expect(redis).to receive(:config).with(:set, 'notify-keyspace-events', keyspace_config)
+      RedisNotifier::Base.new(redis, db, keyspace_config)
+    end
+  end
+
+  describe '#build_channel_for' do
+    let(:prefix) { 'foo' }
+    context 'type is "event"' do
+      it { expect(subject.build_channel_for(:event, prefix) ).to eq("__keyevent@#{db}__:#{prefix}") }
+    end
+    context 'type is "key"' do
+      it { expect(subject.build_channel_for(:key, prefix) ).to eq("__keyspace@#{db}__:#{prefix}") }
+    end
+  end
+
+  describe '#find_type_from' do
+    it { expect(subject.find_type_from('__keyevent@0__:foo')).to eq(:event) }
+    it { expect(subject.find_type_from('__keyspace@0__:foo')).to eq(:key) }
+    it { expect(subject.find_type_from('foobar')).to be(nil) }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require_relative '../lib/redis_notifier'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_notifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.7
   type: :development
@@ -50,6 +53,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.7
 description: ''
@@ -64,9 +70,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/simple.rb
 - lib/redis_notifier.rb
 - lib/redis_notifier/version.rb
 - redis_notifier.gemspec
+- spec/redis_notifier/base_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - Copyright Samuel
@@ -91,4 +100,6 @@ rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Observe redis keyevent/keyspace and notify
-test_files: []
+test_files:
+- spec/redis_notifier/base_spec.rb
+- spec/spec_helper.rb