acts_as_stream 0.0.2.alpha.4 → 0.0.3.alpha.1

data/README.md

@@ -10,6 +10,9 @@ A highly configurable activity stream system built on top of Redis
  * You're welcome to use it, and I'd love feedback
  * Caveat Downloader
 
+### Extra special notes
+The move to 0.0.3.alpha.1 involves a change to the key structure. See below.
+
 ## Installation
 
 Install
@@ -68,6 +71,51 @@ follower.get_activity.first
 
 ## Advanced Usage
 
+## Key structure
+
+### Activity Keys
+Keys for Redis activity packages are created using the format
+
+```
+<namespace>:<activity_scope>:<id>
+```
+
+where ```namespace``` and ```activity_scope``` are set in the ActsAsStream configuration and default to
+a base key of ```acts_as_stream:activity``` and id is the value of ```activity_incr``` which defaults to
+```acts_as_stream:activity:activity_counter```
+
+The Activity ID is also added to a sorted set with the key
+
+```
+<namespace>:<activity_scope>:sorted <time> <id>
+```
+
+where <time> is floating point seconds since the epoch and <id> is as above. This allows for time-based
+sorting of activities.
+
+### Followers
+
+Followers are notified by an arbitrary string key that can literally be whatever you want, but which defaults
+to
+
+```
+<namespace>:<activity_scope>:<streamable_object_id> <time> <activity_id>
+```
+
+where ```streamable_object_id``` is the value of ```activity_attr```, both of which are set in the configuration options.
+```activity_attr``` defaults to ```id``` and can be set on a per model basis. ```activity_id``` is the id of the activity
+given above.
+
+Activities are also stored as a list keyed by id
+
+```
+<namespace>:<activity_scope>:followers:<activity_id> <follower_key>
+```
+
+where ```follower_key``` is the key used above, and activity_id is the id of the activity.
+
+The following system allows for time sorted organization of activities, and ability to see all "viewers" of an activity.
+
 ## Configuration
 
 ## Future Plans

data/lib/acts_as_stream/configuration.rb

@@ -22,7 +22,7 @@ module ActsAsStream
     end
 
     def namespace
-      @namespace ||= :activity_stream
+      @namespace ||= :acts_as_stream
     end
 
     def activity_key

data/lib/acts_as_stream/connector.rb

@@ -4,26 +4,20 @@ module ActsAsStream
     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
+        #Add the id to a sorted set scored by time
+        ActsAsStream.redis.zadd "#{base_key}:sorted", Time.now.to_f, id
       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}"
+        ActsAsStream.redis.zrem "#{base_key}:sorted", ident
       end
       deregister_followers! ident
     end
@@ -32,11 +26,9 @@ module ActsAsStream
       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.zadd key, Time.now.to_f, options[:activity_id]
           ActsAsStream.redis.lpush "#{base_key}:followers:#{options[:activity_id]}", key
         end
       end
@@ -71,6 +63,10 @@ module ActsAsStream
       ActsAsStream.redis.zrevrange(follower_key, starting_offset, ending_offset, :with_scores => false).map{|i| get_activity i}
     end
 
+    def get_activity_since follower_key, since = 2.days.ago
+
+    end
+
     def get_activity id
       ActsAsStream.redis.get "#{base_key}:#{id}"
     end

data/lib/acts_as_stream/stream_activity.rb

@@ -17,7 +17,11 @@ module ActsAsStream
       [:who, :object].each do |opt|
         #unless we are ignoring the stream hash for this object, use StreamableObject.stream_hash
         unless opts[:ignore_stream_hash_on].include?(opt) or not opts[opt].respond_to?(:to_stream_hash)
-          opts[opt] = opts[opt].to_stream_hash
+          begin
+            opts[opt] = opts[opt].to_stream_hash
+          rescue NoMethodError
+            raise "The class #{opts[opt].class.name} does not have a method called #{opts[opt].activity_attr}. Perhaps you should look at your ActsAsStream configuration, or set :activity_attr"
+          end
         end
       end
 

data/lib/acts_as_stream/streamable_object.rb

@@ -22,14 +22,14 @@ module ActsAsStream
       def to_stream_hash
         {self.class.name.tableize.singularize => {'id' => self.id, activity_attr.to_s => self.send(activity_attr)}}
       end
-      def activity_id
+      def streamable_object_id
         self.send(self.class.activity_attr)
       end
       def activity_key
-        "#{self.class.activity_key_base}:#{activity_id}"
+        "#{self.class.activity_key_base}:#{streamable_object_id}"
       end
       def following_key
-        "#{ActsAsStream.namespace}:#{self.class.name.tableize.singularize}:#{activity_id}:#{activity_scope}"
+        "#{ActsAsStream.namespace}:#{self.class.name.tableize.singularize}:#{streamable_object_id}:#{activity_scope}"
       end
 
       def register_activity! package
@@ -61,6 +61,9 @@ module ActsAsStream
           ActsAsStream.get_activity_for following_key,
                                         :page_size => activity_count,
                                         :page => 1
+        elsif options[:since]
+          time = options[:since]
+
         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]

data/lib/acts_as_stream/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_stream
 version: !ruby/object:Gem::Version
-  version: 0.0.2.alpha.4
+  version: 0.0.3.alpha.1
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-12 00:00:00.000000000 Z
+date: 2012-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70105178638780 !ruby/object:Gem::Requirement
+  requirement: &70294530388220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70105178638780
+  version_requirements: *70294530388220
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70105178637860 !ruby/object:Gem::Requirement
+  requirement: &70294530387540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70105178637860
+  version_requirements: *70294530387540
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70105178637260 !ruby/object:Gem::Requirement
+  requirement: &70294530386780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178637260
+  version_requirements: *70294530386780
 - !ruby/object:Gem::Dependency
   name: acts_as_amico
-  requirement: &70105178636420 !ruby/object:Gem::Requirement
+  requirement: &70294530385860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178636420
+  version_requirements: *70294530385860
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70105178635460 !ruby/object:Gem::Requirement
+  requirement: &70294530385100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178635460
+  version_requirements: *70294530385100
 - !ruby/object:Gem::Dependency
   name: spork
-  requirement: &70105178649900 !ruby/object:Gem::Requirement
+  requirement: &70294530400080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.9.0.rc
   type: :development
   prerelease: false
-  version_requirements: *70105178649900
+  version_requirements: *70294530400080
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70105178649040 !ruby/object:Gem::Requirement
+  requirement: &70294530399320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178649040
+  version_requirements: *70294530399320
 - !ruby/object:Gem::Dependency
   name: guard-spork
-  requirement: &70105178648320 !ruby/object:Gem::Requirement
+  requirement: &70294530398540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178648320
+  version_requirements: *70294530398540
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
-  requirement: &70105178647300 !ruby/object:Gem::Requirement
+  requirement: &70294530397940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178647300
+  version_requirements: *70294530397940
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70105178646380 !ruby/object:Gem::Requirement
+  requirement: &70294530396580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178646380
+  version_requirements: *70294530396580
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70105178645340 !ruby/object:Gem::Requirement
+  requirement: &70294530395540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178645340
+  version_requirements: *70294530395540
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70105178644000 !ruby/object:Gem::Requirement
+  requirement: &70294530394620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105178644000
+  version_requirements: *70294530394620
 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!