better_call_redis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f2d5235623cd3e5b4a9aea2ea826051a872d7c6
+  data.tar.gz: 672e0a5ec38c20baaf3da23d6607fc6ebf3bee04
+SHA512:
+  metadata.gz: 331068f68c982d6da558c51f59763e497373217f12bdd9d9f3df05d1a4a0dd694b0f61157cb24b072d4a57f4ff98e6fe67853f70976a7ac54d27989bacc1e9a0
+  data.tar.gz: dde38aea1166dea7b975e59f5ce394c752189eb43f65d9e5c851438c07261666118ddf2a93de28f1ef0ca8f7781638b640b467ca5dd919dd13b52a2c25002c94

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,42 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.2.1
+
+gemfile:
+  - gemfiles/rails_3.0.gemfile
+  - gemfiles/rails_3.1.gemfile
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: rbx-2.2.1
+    - rvm: jruby-19mode
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: rbx-2.2.1
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: rbx-2.2.1
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: rbx-2.2.1
+      gemfile: gemfiles/rails_4.1.gemfile
+
+before_script:
+  - bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in better_call_redis.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+MIT License
+
+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,55 @@
+# BetterCallRedis
+
+[![Build Status](https://api.travis-ci.org/clod81/better_call_redis.svg)](http://travis-ci.org/clod81/better_call_redis)
+
+Active Record Callback that pushes notification of creation or deletion to a Redis channel.
+Redis pushes a message (notification) to a channel with a configurable namespace when an active record entry is created or deleted.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'better_call_redis'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install better_call_redis
+
+## Usage
+
+### Initializer
+
+All those initialize options are optional.
+"Redis.new" will be used with default connection options if not specified.
+"bettercallredis:notification" is the default namespace.
+"deleted_attributes" for logically deleted active record models (ex: table column deleted or cancelled). Default is an empty array.
+
+```ruby
+BetterCallRedis::configure do |bcr|
+  bcr.redis              = Redis.new
+  bcr.namespace          = "bettercallredis:notification"
+  bcr.deleted_attributes = %w(deleted cancelled)
+end
+```
+
+Include the following in your active record model class to enable redis channel notification messages.
+
+```ruby
+include BetterCallRedis::ActiveRecord
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/better_call_redis/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Thanks

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/better_call_redis.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'better_call_redis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "better_call_redis"
+  spec.version       = BetterCallRedis::VERSION
+  spec.authors       = ["Claudio Contin"]
+  spec.email         = ["contin@gmail.com"]
+  spec.summary       = %q{Active Record Callback that pushes notification of creation or deletion to a Redis channel}
+  spec.description   = %q{Redis pushes a message (notification) to a channel when an active record entry is created or deleted}
+  spec.homepage      = "https://github.com/clod81/better_call_redis"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord",  ">= 3.0"
+  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "redis",         ">= 3.0.0"
+
+  spec.add_development_dependency "bundler",                 "~> 1.7"
+  spec.add_development_dependency "rake",                    "~> 10.0"
+  spec.add_development_dependency "rspec",                   "~> 3.2.0"
+  spec.add_development_dependency "fakeredis",               "~> 0.5.0"
+end

data/lib/better_call_redis.rb

@@ -0,0 +1,17 @@
+require "better_call_redis/version"
+require "better_call_redis/configuration"
+require "better_call_redis/active_record"
+
+module BetterCallRedis
+
+  class << self
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+end

data/lib/better_call_redis/active_record.rb

@@ -0,0 +1,57 @@
+module BetterCallRedis
+  module ActiveRecord
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+  private
+
+    def better_call_redis_notify_redis_created
+      better_call_redis_notify(1)
+    end
+
+    def better_call_redis_notify_redis_removed
+      better_call_redis_notify(-1)
+    end
+
+    def better_call_redis_logically_delete
+      return if self.new_record?
+      return unless common_deleted_attribute = self.class.better_call_redis_common_deleted_attribute
+      return unless self.send("#{common_deleted_attribute}_changed?")
+      self.send("#{common_deleted_attribute}") ? better_call_redis_notify_redis_removed : better_call_redis_notify_redis_created
+    end
+
+    def better_call_redis_notify(action)
+      self.class.better_call_redis_configuration.redis.publish(self.class.better_call_redis_configuration.namespace, {class_name: self.class.name, message: action}.to_json)
+    end
+
+    module ClassMethods
+
+      def self.extended(base)
+        base.class_eval do
+          before_save   :better_call_redis_logically_delete
+          after_create  :better_call_redis_notify_redis_created
+          after_destroy :better_call_redis_notify_redis_removed
+        end
+
+        def better_call_redis_configuration
+          BetterCallRedis.configuration
+        end
+
+        def better_call_redis_common_deleted_attribute
+          (new.attributes.keys & better_call_redis_configuration.deleted_attributes).first
+        end
+
+        def better_call_redis_count
+          common_deleted_attribute = better_call_redis_common_deleted_attribute
+          return where("#{common_deleted_attribute} != true").count if common_deleted_attribute
+          count
+        end
+
+      end # end extended
+
+    end # end ClassMethods
+
+  end
+end

data/lib/better_call_redis/configuration.rb

@@ -0,0 +1,21 @@
+module BetterCallRedis
+  class Configuration
+
+    attr_writer :redis
+    attr_writer :namespace
+    attr_writer :deleted_attributes
+
+    def redis
+      @redis ||= Redis.new
+    end
+
+    def namespace
+      @namespace ||= "bettercallredis:notification"
+    end
+
+    def deleted_attributes
+      @deleted_attributes ||= []
+    end
+
+  end
+end

data/lib/better_call_redis/version.rb

@@ -0,0 +1,3 @@
+module BetterCallRedis
+  VERSION = "0.0.1"
+end

data/spec/lib/better_call_redis/active_record_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe "BetterCallRedis::ActiveRecord" do
+
+  before(:each) do
+    BetterCallRedis.configure do |bcr|
+      bcr.namespace          = "test"
+      bcr.deleted_attributes = %w(deleted)
+    end
+    allow(BetterCallRedis.configuration.redis).to receive(:to_str) { "" }
+  end
+
+  describe "for a new record" do
+    before(:each) do
+      @model = Person.new
+      allow(@model).to receive(:new_record?) { true }
+      allow(@model).to receive(:save) { @model.run_callbacks(:create) }
+    end
+    it "should call redis with correct params" do
+      expect(BetterCallRedis.configuration.redis).to receive(:publish).with("test", "{\"class_name\":\"Person\",\"message\":1}") { true }
+      @model.save
+    end
+  end
+
+  describe "for an existing record" do
+    before(:each) do
+      @model = Person.new
+      allow(@model).to receive(:new_record?) { false }
+      allow(@model).to receive(:save) { @model.run_callbacks(:save) }
+    end
+    it "should call redis with correct params" do
+      expect(BetterCallRedis.configuration.redis).not_to receive(:publish)
+      @model.save
+    end
+  end
+
+  describe "deleting an existing record" do
+    before(:each) do
+      @model = Person.new
+      allow(@model).to receive(:new_record?) { false }
+      allow(@model).to receive(:destroy) { @model.run_callbacks(:destroy) }
+    end
+    it "should call redis with correct params" do
+      expect(BetterCallRedis.configuration.redis).to receive(:publish).with("test", "{\"class_name\":\"Person\",\"message\":-1}") { true }
+      @model.destroy
+    end
+  end
+
+  describe "logically delete an existing record" do
+    before(:each) do
+      @model = PersonLogicallyDeletable.new
+      allow(@model).to receive(:new_record?) { false }
+      allow(@model).to receive(:save) { @model.run_callbacks(:save) }
+    end
+    it "should call redis with correct params" do
+      expect(BetterCallRedis.configuration.redis).to receive(:publish).with("test", "{\"class_name\":\"PersonLogicallyDeletable\",\"message\":-1}") { true }
+      @model.deleted = true
+      @model.save
+    end
+  end
+
+  describe "logically undelete an existing record" do
+    before(:each) do
+      @model = PersonLogicallyDelated.new
+      allow(@model).to receive(:new_record?) { false }
+      allow(@model).to receive(:save) { @model.run_callbacks(:save) }
+    end
+    it "should call redis with correct params" do
+      expect(BetterCallRedis.configuration.redis).to receive(:publish).with("test", "{\"class_name\":\"PersonLogicallyDelated\",\"message\":1}") { true }
+      @model.deleted = false
+      @model.save
+    end
+  end
+
+  describe "changind a delete attribute not specified in the configuration deleted_attributes" do
+    before(:each) do
+      @model = PersonLogicallyDelatedNotChanged.new
+      allow(@model).to receive(:new_record?) { false }
+      allow(@model).to receive(:save) { @model.run_callbacks(:save) }
+    end
+    it "should call redis with correct params" do
+      expect(BetterCallRedis.configuration.redis).not_to receive(:publish)
+      @model.cancelled = false
+      @model.save
+    end
+  end
+
+end

data/spec/lib/better_call_redis_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "BetterCallRedis Initializer" do
+
+  describe "with default options" do
+    let(:conf) { BetterCallRedis.configuration }
+    it "should have all default options" do
+      expect(conf.redis).to be_kind_of Redis
+      expect(conf.namespace). equal? "bettercallredis:notification"
+      expect(conf.deleted_attributes).equal? []
+    end
+  end
+
+  describe "with non default options" do
+    let(:conf) do
+      BetterCallRedis.configuration do |bcr|
+        bcr.redis              = "Invalid Redis"
+        bcr.namespace          = "different"
+        bcr.deleted_attributes = %w(deleted cancelled)
+      end
+    end
+    it "should have all default options" do
+      expect(conf.redis).equal? "Invalid Redis"
+      expect(conf.namespace). equal? "different"
+      expect(conf.deleted_attributes).equal? %w(deleted cancelled)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'better_call_redis'
+require 'active_record'
+require 'active_record/serialization'
+require 'fakeredis'
+
+class Person
+  include ActiveRecord::Callbacks
+  include BetterCallRedis::ActiveRecord
+
+  def attributes
+    {"id" => 1, "name" => "name_person"}
+  end
+end
+
+
+class PersonLogicallyDeletable < Person
+  attr_accessor :deleted
+  attr_accessor :cancelled
+
+  def attributes
+    {"id" => 1, "name" => "name_person", "deleted" => false, "cancelled" => false}
+  end
+
+  def deleted_changed?
+    true
+  end
+end
+
+class PersonLogicallyDelated < PersonLogicallyDeletable
+  def attributes
+    {"id" => 1, "name" => "name_person", "deleted" => true, "cancelled" => true}
+  end
+
+  def deleted_changed?
+    true
+  end
+end
+
+class PersonLogicallyDelatedNotChanged < PersonLogicallyDeletable
+  def attributes
+    {"id" => 1, "name" => "name_person", "deleted" => true, "cancelled" => true}
+  end
+
+  def deleted_changed?
+    false
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: better_call_redis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Claudio Contin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Redis pushes a message (notification) to a channel when an active record
+  entry is created or deleted
+email:
+- contin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- better_call_redis.gemspec
+- lib/better_call_redis.rb
+- lib/better_call_redis/active_record.rb
+- lib/better_call_redis/configuration.rb
+- lib/better_call_redis/version.rb
+- spec/lib/better_call_redis/active_record_spec.rb
+- spec/lib/better_call_redis_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/clod81/better_call_redis
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Active Record Callback that pushes notification of creation or deletion to
+  a Redis channel
+test_files:
+- spec/lib/better_call_redis/active_record_spec.rb
+- spec/lib/better_call_redis_spec.rb
+- spec/spec_helper.rb