acts_as_stream 0.0.2.alpha.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 John Metta
+
+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,90 @@
+# ActsAsStream
+A highly configurable activity stream system built on top of Redis
+
+## Warnings
+
+ * I've just written this today (3/11/12)
+ * The test suite is complete, but I haven't used it in production.
+ * I'm building it into a production app now
+ * It's probably going to be updated frequently
+ * You're welcome to use it, and I'd love feedback
+ * Caveat Downloader
+
+## Installation
+
+Install
+
+```ruby
+gem install acts_as_stream
+```
+
+or in your ```Gemfile```
+
+```ruby
+gem 'acts_as_stream'
+```
+
+Make sure your redis server is running! Redis configuration is outside the scope of this README, but
+check out the [Redis documentation](http://redis.io/documentation).
+
+## Basic Usage
+```ruby
+ActsAsStream.configure do |config|
+  redis = Redis.new(:db => 15)
+  config.redis = redis
+  config.namespace = :redis_stream_test
+  config.activity_scope = :activity
+  config.activity_key = :activity
+  config.activity_attr = :id
+  config.activity_incr = :activity_counter
+  config.page_size = 25
+end
+
+class User < ActiveRecord::Base
+  acts_as_stream
+  acts_as_amico # <- not necessary, any follower system will do
+
+  # Define an all_followers method which will return a list of Redis keys, one per follower
+  def all_followers
+    get_all(:followers).map{|id| User.find(id.to_i)}.map{|u| u.following_key}
+  end
+
+end
+
+actor = User.create
+follower = User.create
+
+follower.follow! actor # <- acts_as_amico syntax, follow whatever your follow system is
+
+user.register_activity! 'some smart, perhaps parsable, string package– say, perhaps, JSON'
+(1..5).each{|i| user.register_activity! "activity #{i}"}
+
+follower.activity_count
+ => 6
+
+follower.get_activity.first
+ => 'some smart, perhaps parsable, string package– say, perhaps, JSON'
+```
+
+## Advanced Usage
+
+## Configuration
+
+## Future Plans
+
+ * Clean up the ActiveResource integration and figure out why :name is so dangerous.
+ * Put activity creation/update into a background worker queue
+
+## Contributing to acts_as_stream
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) John Metta. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/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    = 'ActsAsStream'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/acts_as_stream.rb

@@ -0,0 +1,14 @@
+require 'redis'
+require 'acts_as_stream'
+require "acts_as_stream/configuration"
+require "acts_as_stream/connector"
+require "acts_as_stream/version"
+require 'acts_as_stream/streamable_object'
+
+module ActsAsStream
+  extend Configuration
+  extend Connector
+end
+
+ActiveRecord::Base.send :include, ActsAsStream::StreamableObject
+ActiveResource::Base.send :include, ActsAsStream::StreamableObject

data/lib/acts_as_stream/configuration.rb

@@ -0,0 +1,49 @@
+module ActsAsStream
+  # Configuration settings for ActsAsStream.
+  module Configuration
+    # Redis instance.
+    attr_accessor :redis
+
+    attr_writer :namespace,
+                :activity_key,
+                :activity_scope,
+                :activity_attr,
+                :page_size,
+                :activity_incr
+
+    def configure
+      yield self
+      if activity_incr.nil?
+        warn "You should really define :activity_incr in ActsAsStream Configuration. Using '#{ActsAsStream.namespace}:activity_counter', but that's pretty unsafe!"
+        @activity_incr = "#{ActsAsStream.namespace}:activity_counter"
+        ActsAsStream.redis.set @activity_incr, 0
+      end
+      ActsAsStream.redis.setnx(@activity_incr, 0)
+    end
+
+    def namespace
+      @namespace ||= :activity_stream
+    end
+
+    def activity_key
+      @activity_key ||= :activity
+    end
+
+    def activity_scope
+      @activity_scope ||= :activity
+    end
+
+    def activity_attr
+      @activity_attr ||= :id
+    end
+
+    def page_size
+      @page_size ||= 25
+    end
+
+    def activity_incr
+      @activity_incr
+    end
+
+  end
+end

data/lib/acts_as_stream/connector.rb

@@ -0,0 +1,98 @@
+module ActsAsStream
+  module Connector
+
+    def register_new_activity! package = nil
+      return if package.nil?
+      id = increment!
+      this_time = time
+      ActsAsStream.redis.multi do
+        #Add the key and package to the system
+        ActsAsStream.redis.set "#{base_key}:#{id}", package
+        #Add a timed key, scored by id, and an id-based key
+        ActsAsStream.redis.zadd "#{base_key}:time:#{this_time}", id, id
+        ActsAsStream.redis.set "#{base_key}:id:#{id}", this_time
+      end
+      raise "### Unable to set Time keys!" if ActsAsStream.redis.get("#{base_key}:id:#{id}") != this_time.to_s
+      #return the current activity ID
+      id
+    end
+
+    def deregister_activity! ident
+      return if ident.nil?
+      score = ActsAsStream.redis.get "#{base_key}:id:#{ident}"
+      ActsAsStream.redis.multi do
+        ActsAsStream.redis.del "#{base_key}:#{ident}"
+        ActsAsStream.redis.zrem "#{base_key}:time:#{score}", ident
+        ActsAsStream.redis.del "#{base_key}:id:#{ident}"
+      end
+      deregister_followers! ident
+    end
+
+    def register_followers! options = {}
+      options.assert_valid_keys(:following_keys, :activity_id)
+      return if options[:following_keys].nil? or options[:activity_id].nil?
+      raise ":following_keys must be an array of keys" if not options[:following_keys].is_a? Array
+      time = Time.now.to_i
+
+      ActsAsStream.redis.multi do
+        options[:following_keys].each do |key|
+          ActsAsStream.redis.zadd key, time, options[:activity_id]
+          ActsAsStream.redis.lpush "#{base_key}:followers:#{options[:activity_id]}", key
+        end
+      end
+    end
+
+    def deregister_followers! activity_id = nil
+      return if activity_id.nil?
+      followers_key = "#{base_key}:followers:#{activity_id}"
+      len = ActsAsStream.redis.llen followers_key
+      followers = ActsAsStream.redis.lrange followers_key, 0, len
+      return if followers.nil?
+      ActsAsStream.redis.multi do
+        followers.each do |f|
+          ActsAsStream.redis.zrem f, activity_id
+        end
+        ActsAsStream.redis.del "#{base_key}:followers:#{activity_id}"
+      end
+    end
+
+    def get_activity_for follower_key, options = {}
+      options = {:page => 1, :page_size => ActsAsStream.page_size}.merge options
+      options[:page] = 1 if options[:page] < 1
+
+      if options[:page] > total_pages(follower_key, options[:page_size])
+        options[:page] = total_pages(follower_key, options[:page_size])
+      end
+
+      starting_offset = ((options[:page] - 1) * options[:page_size])
+      starting_offset = 0 if starting_offset < 0
+      ending_offset = (starting_offset + options[:page_size]) - 1
+
+      ActsAsStream.redis.zrevrange(follower_key, starting_offset, ending_offset, :with_scores => false).map{|i| get_activity i}
+    end
+
+    def get_activity id
+      ActsAsStream.redis.get "#{base_key}:#{id}"
+    end
+
+    def total_pages key, page_size = ActsAsStream.page_size
+      (ActsAsStream.redis.zcard(key) / page_size.to_f).ceil
+    end
+
+    def count
+      ActsAsStream.redis.get(ActsAsStream.activity_incr).to_i
+    end
+
+    def base_key
+      "#{ActsAsStream.namespace}:#{ActsAsStream.activity_scope}"
+    end
+    private
+
+    def increment!
+      ActsAsStream.redis.incr(ActsAsStream.activity_incr)
+    end
+    def time
+      Time.now.to_i
+    end
+  end
+end

data/lib/acts_as_stream/streamable_object.rb

@@ -0,0 +1,66 @@
+module ActsAsStream
+  module StreamableObject
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def acts_as_stream options = {}
+        cattr_accessor :activity_scope, :activity_attr, :activity_key_base, :followers_attr
+        self.activity_scope = options[:activity_scope] || ActsAsStream.activity_scope
+        self.activity_attr = options[:activity_attr] || ActsAsStream.activity_attr
+        self.activity_key_base = "#{ActsAsStream.namespace}:#{self.activity_scope}"
+        self.followers_attr = options[:followers_attr] || :all_followers
+        send :include, ActsAsStream::StreamableObject::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      def activity_id
+        self.send(self.class.activity_attr)
+      end
+      def activity_key
+        "#{self.class.activity_key_base}:#{activity_id}"
+      end
+      def following_key
+        "#{ActsAsStream.namespace}:#{self.class.name.tableize.singularize}:#{activity_id}:#{activity_scope}"
+      end
+
+      def register_activity! package
+        act_id = ActsAsStream.register_new_activity! package
+        self.register_followers! act_id
+      end
+
+      def delete_activity act_id
+        ActsAsStream.deregister_activity! act_id
+      end
+
+      def register_followers! act_id
+        ActsAsStream.register_followers! :following_keys => get_follower_keys, :activity_id => act_id
+      end
+
+      def get_follower_keys
+        send(followers_attr)
+      end
+
+      def get_activity options = {}
+        if options == :all
+          ActsAsStream.get_activity_for following_key,
+                                        :page_size => activity_count,
+                                        :page => 1
+        else
+          options = {:page_size => ActsAsStream.page_size, :page => 1}.merge options
+          ActsAsStream.get_activity_for following_key, :page_size => options[:page_size], :page => options[:page]
+        end
+      end
+
+      def activity_count
+        ActsAsStream.redis.zcard following_key
+      end
+
+    end
+  end
+end

data/lib/acts_as_stream/version.rb

@@ -0,0 +1,3 @@
+module ActsAsStream
+  VERSION = "0.0.2.alpha.1"
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_stream
+version: !ruby/object:Gem::Version
+  version: 0.0.2.alpha.1
+  prerelease: 6
+platform: ruby
+authors:
+- John Metta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70248699332900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70248699332900
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70248699332100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70248699332100
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70248699331420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699331420
+- !ruby/object:Gem::Dependency
+  name: acts_as_amico
+  requirement: &70248699330520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699330520
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70248699329720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699329720
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: &70248699328140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0.rc
+  type: :development
+  prerelease: false
+  version_requirements: *70248699328140
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70248699343560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699343560
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: &70248699342760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699342760
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: &70248699342180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699342180
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70248699340840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699340840
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70248699339860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699339860
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: &70248699338500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248699338500
+description: Rails injectable Redis-backed activity stream system. This is an alpha
+  release of code that I just wrote and put into production on 3/11/12. Send feedback
+  and post bugs to the Github page, but use at your own risk!
+email:
+- mail@johnmetta.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_stream/configuration.rb
+- lib/acts_as_stream/connector.rb
+- lib/acts_as_stream/streamable_object.rb
+- lib/acts_as_stream/version.rb
+- lib/acts_as_stream.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/mettadore/acts_as_stream.git
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Rails injectable Redis-backed activity stream system
+test_files: []