has_redis_feed 0.0.1

data/lib/has_redis_feed.rb

@@ -0,0 +1,39 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+require "active_record"
+require "redis"
+
+module HasRedisFeed
+  FEED_COUNT = 4
+
+  def feed(count=FEED_COUNT)
+    encoded_result = $redis.zrevrange feed_key, 0, count
+    if encoded_result and encoded_result.size > 0
+      encoded_result.map { |r| self.decode(r) }
+    else
+      encoded_result
+    end
+  end
+
+  def push_to_feed(h)
+    encoded_h = self.encode(h)
+    $redis.zadd feed_key, feed_timestamp, encoded_h
+  end
+
+  def feed_timestamp
+    "#{DateTime.now.to_i}"
+  end  
+
+  def feed_key
+    "feed:#{self.class.to_s}:#{self.id}"
+  end
+
+  def encode(obj)
+    obj.to_json
+  end
+
+  def decode(json)
+    ActiveSupport::JSON.decode(json)
+  end
+end
+
+ActiveRecord::Base.class_eval { include HasRedisFeed }

data/spec/has_redis_feed_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'active_record'
+require 'support/active_record'
+require 'support/redis'
+require 'support/dummy_model'
+
+describe DummyModel do
+  before(:each) do
+    @dummy_model = DummyModel.create
+  end
+
+  it 'should have a key namespaced by the class name' do
+    @dummy_model.feed_key.should == "feed:DummyModel:#{@dummy_model.id}"
+  end
+
+  it 'should be able to push to its feed and retrieve the feed' do
+    @dummy_model.push_to_feed({'alphonso' => 'quigley'})
+    @dummy_model.feed.should == [{'alphonso' => 'quigley'}]
+  end
+
+  it 'should return the feed in descending created_at order' do
+    @dummy_model.stub(:feed_timestamp).and_return(1)
+    @dummy_model.push_to_feed({'alphonso' => 'old'})
+    @dummy_model.stub(:feed_timestamp).and_return(2)
+    @dummy_model.push_to_feed({'alphonso' => 'new'})
+    @dummy_model.feed.should == [{'alphonso' => 'new'}, {'alphonso' => 'old'}]
+  end
+
+  it 'should return the default of 5 items in the feed' do
+    (1..10).each {|i| 
+      @dummy_model.stub(:feed_timestamp).and_return(i)
+      @dummy_model.push_to_feed({'a' => 'q' + i.to_s})
+    }
+    @dummy_model.feed.should == [{"a"=>"q10"}, {"a"=>"q9"}, {"a"=>"q8"}, {"a"=>"q7"}, {"a"=>"q6"}]
+  end
+
+  it 'should return the correct count' do
+    (1..10).each {|i| 
+      @dummy_model.stub(:feed_timestamp).and_return(i)
+      @dummy_model.push_to_feed({'a' => 'q' + i.to_s})
+    }
+    @dummy_model.feed(1).should == [{"a"=>"q10"}, {"a"=>"q9"}]
+  end
+
+  it 'should encode hash' do @dummy_model.encode({alphonso: 'quigley'}).should == "{\"alphonso\":\"quigley\"}" end
+
+  it 'should decode hash' do 
+    original_h = {'alphonso' => 'quigley'}
+    h = @dummy_model.encode(original_h)
+    @dummy_model.decode(h).should == original_h
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require_relative '../lib/has_redis_feed.rb'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/spec/support/active_record.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migration.create_table :dummy_models do |t|
+  t.timestamps
+end

data/spec/support/dummy_model.rb

@@ -0,0 +1,2 @@
+class DummyModel < ActiveRecord::Base
+end

data/spec/support/redis.rb

@@ -0,0 +1,9 @@
+port = 10000
+$redis = Redis.new(:host => 'localhost', :port => port)
+begin
+  $redis.flushall
+rescue Errno::ECONNREFUSED
+  puts "Redis is not listening in port #{port}. Run:" 
+  puts "  redis-server ./spec/support/redis.conf" 
+  exit
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: has_redis_feed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Golov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152757760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152757760
+description: A simple gem for adding an activity feed to an ActiveRecord object
+email: peter@golov.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/has_redis_feed.rb
+- spec/has_redis_feed_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/dummy_model.rb
+- spec/support/redis.rb
+homepage: https://github.com/golov/has_redis_feed
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Redis Activity Feed
+test_files:
+- spec/has_redis_feed_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/dummy_model.rb
+- spec/support/redis.rb