redis_timeline 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9aaa7d0f9b35e188af7a9ea8b270dd0350d90b64
+  data.tar.gz: 561aaaca0aa1a37a7f6532c1cc4aebd3cd741a35
+SHA512:
+  metadata.gz: 1b2b9ecb0d0684fb36ebf820aee7123c5520230999fa5e26103b640253d783b36cffae0cafe07be25c5b8ac5dfd5bd53aa5285a94e56448a9b7a1ad3d4d1ac21
+  data.tar.gz: 425ca83ad5c6c877b17040331627050ffba8a2f2c02cfd993c3ec5f38785662866833fb6b04c11903c51507f24b8b7803e0272aecd51eccf713df389bd35f336

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Felix Clack
+
+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,148 @@
+redis-timeline
+===========
+
+[![Build Status](https://travis-ci.org/felixclack/redis-timeline.png?branch=master)](https://travis-ci.org/felixclack/redis-timeline)
+
+Redis backed timelines in your app.
+
+<a href="mailto:felixclack+pairwithme@gmail.com" title="Pair program with me!">
+  <img src="http://pairprogramwith.me/badge.png"
+        alt="Pair program with me!" />
+</a>
+
+Features
+--------
+
+* store your timeline in Redis.
+
+Examples
+--------
+
+The simple way...
+
+    class Post < ActiveRecord::Base
+      include Timeline::Track
+
+      track :new_post
+    end
+
+By default, track fires in the `after_create` callback of your model and uses `self` as the object and `creator` as the actor.
+
+You can specify these options explicity...
+
+    class Comment < ActiveRecord::Base
+      include Timeline::Track
+      belongs_to :author, class_name: "User"
+      belongs_to :post
+
+      track :new_comment,
+        actor: :author,
+        followers: :post_participants,
+        object: [:body],
+        on: :update,
+        target: :post
+
+      delegate :participants, to: :post, prefix: true
+    end
+
+Parameters
+----------
+
+`track` accepts the following parameters...
+
+the first param is the verb name.
+
+The rest all fit neatly in an options hash.
+
+* `on:` [ActiveModel callback]
+  You use it to specify whether you want the timeline activity created after a create, update or destroy.
+  Default: :create
+
+* `actor:` [the method that specifies the object that took this action]
+  In the above example, comment.author is this object.
+  Default: :creator, so make sure this exists if you don't specify a method here
+
+* `object:` defaults to self, which is good most of the time.
+  You can override it if you need to
+
+* `target:` [related to the `:object` method above. In the example this is the post related to the comment]
+  default: nil
+
+* `followers:` [who should see this story in their timeline. This references a method on the actor]
+  Defaults to the method `followers` defined by Timeline::Actor.
+
+* `extra_fields:` [accepts an array of method names that you would like to cache the value of in your timeline]
+  Defaults to nil.
+
+* `if:` symbol or proc/lambda lets you put conditions on when to track.
+
+Display a timeline
+------------------
+
+To retrieve a timeline for a user...
+
+    class User < ActiveRecord::Base
+      include Timeline::Actor
+    end
+
+The timeline objects are just hashes that are extended by [Hashie](http://github.com/intridea/hashie) to provide method access to the keys.
+
+    user = User.find(1)
+    user.timeline # => [<Timeline::Activity verb='new_comment' ...>]
+
+Requirements
+------------
+
+* redis
+* active_support
+* hashie
+
+Install
+-------
+
+Install redis.
+
+Add to your Gemfile:
+
+    gem 'redis-timeline'
+
+Or install it by hand:
+
+    gem install redis-timeline
+
+Setup your redis instance. For a Rails app, something like this...
+
+    # in config/initializers/redis.rb
+
+    Timeline.redis = "localhost:6379/timeline"
+
+Author
+------
+
+Original author: Felix Clack
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2012 Felix Clack
+
+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/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Timeline'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/redis_timeline.rb

@@ -0,0 +1,14 @@
+require 'active_support/concern'
+require 'multi_json'
+require 'hashie'
+require 'timeline/config'
+require 'timeline/helpers'
+require 'timeline/track'
+require 'timeline/actor'
+require 'timeline/activity'
+
+module Timeline
+  extend Config
+  extend Helpers
+end
+

data/lib/tasks/timeline_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :timeline do
+#   # Task goes here
+# end

data/lib/timeline/activity.rb

@@ -0,0 +1,11 @@
+require 'active_model'
+
+module Timeline
+  class Activity < Hashie::Mash
+    extend ActiveModel::Naming
+
+    def to_partial_path
+      "timelines/#{verb}"
+    end
+  end
+end

data/lib/timeline/actor.rb

@@ -0,0 +1,34 @@
+module Timeline
+  module Actor
+    extend ActiveSupport::Concern
+
+    included do
+      def timeline(options={})
+        ::Timeline.get_list(timeline_options(options)).map do |item|
+          ::Timeline::Activity.new ::Timeline.decode(item)
+        end
+      end
+
+      def followers
+        []
+      end
+
+      private
+        def timeline_options(options)
+          defaults = { list_name: "user:id:#{self.id}:activity", start: 0, end: 19 }
+          if options.is_a? Hash
+            defaults.merge!(options)
+          elsif options.is_a? Symbol
+            case options
+            when :global
+              defaults.merge!(list_name: "global:activity")
+            when :posts
+              defaults.merge!(list_name: "user:id:#{self.id}:posts")
+            when :mentions
+              defaults.merge!(list_name: "user:id:#{self.id}:mentions")
+            end
+          end
+        end
+    end
+  end
+end

data/lib/timeline/config.rb

@@ -0,0 +1,42 @@
+require 'redis/namespace'
+
+module Timeline
+  module Config
+
+    # Accepts:
+    #   1. A 'hostname:port' String
+    #   2. A 'hostname:port:db' String (to select the Redis db)
+    #   3. A 'hostname:port/namespace' String (to set the Redis namespace)
+    #   4. A Redis URL String 'redis://host:port'
+    #   5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
+    #      or `Redis::Namespace`.
+    def redis=(server)
+      case server
+      when String
+        if server =~ /redis\:\/\//
+          redis = Redis.connect(:url => server, :thread_safe => true)
+        else
+          server, namespace = server.split('/', 2)
+          host, port, db = server.split(':')
+          redis = Redis.new(:host => host, :port => port,
+            :thread_safe => true, :db => db)
+        end
+        namespace ||= :timeline
+
+        @redis = Redis::Namespace.new(namespace, :redis => redis)
+      when Redis::Namespace
+        @redis = server
+      else
+        @redis = Redis::Namespace.new(:timeline, :redis => server)
+      end
+    end
+
+    # Returns the current Redis connection. If none has been created, will
+    # create a new one.
+    def redis
+      return @redis if @redis
+      self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379"
+      self.redis
+    end
+  end
+end

data/lib/timeline/helpers.rb

@@ -0,0 +1,23 @@
+module Timeline
+  module Helpers
+    class DecodeException < StandardError; end
+
+    def encode(object)
+      ::MultiJson.encode(object)
+    end
+
+    def decode(object)
+      return unless object
+
+      begin
+        ::MultiJson.decode(object)
+      rescue ::MultiJson::DecodeError => e
+        raise DecodeException, e
+      end
+    end
+
+    def get_list(options={})
+      Timeline.redis.lrange options[:list_name], options[:start], options[:end]
+    end
+  end
+end

data/lib/timeline/track.rb

@@ -0,0 +1,118 @@
+module Timeline::Track
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def track(name, options={})
+      @name = name
+      @callback = options.delete :on
+      @callback ||= :create
+      @actor = options.delete :actor
+      @actor ||= :creator
+      @object = options.delete :object
+      @target = options.delete :target
+      @followers = options.delete :followers
+      @followers ||= :followers
+      @mentionable = options.delete :mentionable
+
+      method_name = "track_#{@name}_after_#{@callback}".to_sym
+      define_activity_method method_name, actor: @actor, object: @object, target: @target, followers: @followers, verb: name, mentionable: @mentionable
+
+      send "after_#{@callback}".to_sym, method_name, if: options.delete(:if)
+    end
+
+    private
+      def define_activity_method(method_name, options={})
+        define_method method_name do
+          @actor = send(options[:actor])
+          @fields_for = {}
+          @object = set_object(options[:object])
+          @target = !options[:target].nil? ? send(options[:target].to_sym) : nil
+          @extra_fields ||= nil
+          @followers = @actor.send(options[:followers].to_sym)
+          @mentionable = options[:mentionable]
+          add_activity activity(verb: options[:verb])
+        end
+      end
+  end
+
+  protected
+    def activity(options={})
+      {
+        verb: options[:verb],
+        actor: options_for(@actor),
+        object: options_for(@object),
+        target: options_for(@target),
+        created_at: Time.now
+      }
+    end
+
+    def add_activity(activity_item)
+      redis_add "global:activity", activity_item
+      add_activity_to_user(activity_item[:actor][:id], activity_item)
+      add_activity_by_user(activity_item[:actor][:id], activity_item)
+      add_mentions(activity_item)
+      add_activity_to_followers(activity_item) if @followers.any?
+    end
+
+    def add_activity_by_user(user_id, activity_item)
+      redis_add "user:id:#{user_id}:posts", activity_item
+    end
+
+    def add_activity_to_user(user_id, activity_item)
+      redis_add "user:id:#{user_id}:activity", activity_item
+    end
+
+    def add_activity_to_followers(activity_item)
+      @followers.each { |follower| add_activity_to_user(follower.id, activity_item) }
+    end
+
+    def add_mentions(activity_item)
+      return unless @mentionable and @object.send(@mentionable)
+      @object.send(@mentionable).scan(/@\w+/).each do |mention|
+        if user = @actor.class.find_by_username(mention[1..-1])
+          add_mention_to_user(user.id, activity_item)
+        end
+      end
+    end
+
+    def add_mention_to_user(user_id, activity_item)
+      redis_add "user:id:#{user_id}:mentions", activity_item
+    end
+
+    def extra_fields_for(object)
+      return {} unless @fields_for.has_key?(object.class.to_s.downcase.to_sym)
+      @fields_for[object.class.to_s.downcase.to_sym].inject({}) do |sum, method|
+        sum[method.to_sym] = @object.send(method.to_sym)
+        sum
+      end
+    end
+
+    def options_for(target)
+      if !target.nil?
+        {
+          id: target.id,
+          class: target.class.to_s,
+          display_name: target.to_s
+        }.merge(extra_fields_for(target))
+      else
+        nil
+      end
+    end
+
+    def redis_add(list, activity_item)
+      Timeline.redis.lpush list, Timeline.encode(activity_item)
+    end
+
+    def set_object(object)
+      case
+      when object.is_a?(Symbol)
+        send(object)
+      when object.is_a?(Array)
+        @fields_for[self.class.to_s.downcase.to_sym] = object
+        self
+      else
+        self
+      end
+    end
+
+end