streama 0.3.4 → 0.3.5

data/README.md

@@ -4,8 +4,14 @@
 
 Streama is a simple Ruby activity stream gem for use with the Mongoid ODM framework.
 
+It works by posting to and querying from a firehose of individual activity items.
+
 [![travis](https://secure.travis-ci.org/christospappas/streama.png)](http://travis-ci.org/christospappas/streama)
 
+## Project Tracking
+
+* [Streama Google Group](http://groups.google.com/group/streama)
+
 ## Install
 
     gem install streama
@@ -88,17 +94,30 @@ current_user.publish_activity(:new_photo, :object => @photo, :target_object => @
 
 ## Retrieving Activity
 
-To retrieve all activity for an actor
+To retrieve the activity stream for an actor
 
 ``` ruby
 current_user.activity_stream
 ```
   
-To retrieve and filter to a particular activity type
+To retrieve the activity stream and filter by activity type
 
 ``` ruby
 current_user.activity_stream(:type => :activity_verb)
 ```
+
+To retrieve all activities published by an actor
+
+``` ruby
+current_user.published_activities
+```
+
+To retrieve all activities published by an actor and filtered by activity type
+
+``` ruby
+current_user.published_activities(:type => :activity_verb)
+```
+
 If you need to return the instance of an :actor, :object or :target_object from an activity call the Activity#load_instance method
 
 ``` ruby

data/lib/streama/activity.rb

@@ -60,6 +60,12 @@ module Streama
         query.merge!({:verb => options[:type]}) if options[:type]
         self.where(query).without(:receivers).desc(:created_at)
       end
+
+      def stream_of(actor, options={})
+         query = {'actor.id' => actor.id, 'actor.type' => actor.class.to_s}
+         query.merge!({:verb => options[:type]}) if options[:type]
+         self.where(query).without(:receivers).desc(:created_at)
+      end
       
     end
 
@@ -98,13 +104,13 @@ module Streama
 
         class_sym = object.class.name.underscore.to_sym
 
-        raise Streama::InvalidData.new(class_sym) unless definition.send(type).has_key?(class_sym)
+        raise Errors::InvalidData.new(class_sym) unless definition.send(type).has_key?(class_sym)
     
         hash = {'id' => object.id, 'type' => object.class.name}
               
         if fields = definition.send(type)[class_sym].try(:[],:cache)
           fields.each do |field|
-            raise Streama::InvalidField.new(field) unless object.respond_to?(field)
+            raise Errors::InvalidField.new(field) unless object.respond_to?(field)
             hash[field.to_s] = object.send(field)
           end
         end

data/lib/streama/actor.rb

@@ -4,6 +4,8 @@ module Streama
     extend ActiveSupport::Concern
 
     included do
+      raise Errors::NotMongoid, "Must be included in a Mongoid::Document" unless self.ancestors.include? Mongoid::Document
+      
       cattr_accessor :activity_klass
     end
 
@@ -31,6 +33,10 @@ module Streama
       activity_class.stream_for(self, options)
     end
     
+    def published_activities(options = {})
+      activity_class.stream_of(self, options)
+    end
+    
     def activity_class
       @activity_klass ||= activity_klass ? activity_klass.classify.constantize : ::Activity
     end

data/lib/streama/definition.rb

@@ -32,7 +32,7 @@ module Streama
     
     def self.find(name)
       unless definition = registered.find{|definition| definition.name == name.to_sym}
-        raise Streama::InvalidActivity, "Could not find a definition for `#{name}`"
+        raise Streama::Errors::InvalidActivity, "Could not find a definition for `#{name}`"
       else
         definition
       end

data/lib/streama/errors.rb

@@ -1,44 +1,51 @@
 module Streama
   
-  class StreamaError < StandardError
-  end
+  module Errors
   
-  class InvalidActivity < StreamaError
-  end
+    class StreamaError < StandardError
+    end
   
-  # This error is raised when an object isn't defined
-  # as an actor, object or target
-  #
-  # Example:
-  #
-  # <tt>InvalidField.new('field_name')</tt>
-  class InvalidData < StreamaError
-    attr_reader :message
-
-    def initialize message
-      @message = "Invalid Data: #{message}"
+    class InvalidActivity < StreamaError
     end
-
-  end
   
-  # This error is raised when trying to store a field that doesn't exist
-  #
-  # Example:
-  #
-  # <tt>InvalidField.new('field_name')</tt>
-  class InvalidField < StreamaError
-    attr_reader :message
+    # This error is raised when an object isn't defined
+    # as an actor, object or target
+    #
+    # Example:
+    #
+    # <tt>InvalidField.new('field_name')</tt>
+    class InvalidData < StreamaError
+      attr_reader :message
+
+      def initialize message
+        @message = "Invalid Data: #{message}"
+      end
 
-    def initialize message
-      @message = "Invalid Field: #{message}"
     end
+  
+    # This error is raised when trying to store a field that doesn't exist
+    #
+    # Example:
+    #
+    # <tt>InvalidField.new('field_name')</tt>
+    class InvalidField < StreamaError
+      attr_reader :message
 
-  end
+      def initialize message
+        @message = "Invalid Field: #{message}"
+      end
+
+    end
   
-  class ActivityNotSaved < StreamaError
-  end
+    class ActivityNotSaved < StreamaError
+    end
+  
+    class NoFollowersDefined < StreamaError
+    end
   
-  class NoFollowersDefined < StreamaError
+    class NotMongoid < StreamaError
+    end
+    
   end
   
 end

data/lib/streama/version.rb

@@ -1,3 +1,3 @@
 module Streama
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/spec/app/models/no_mongoid.rb

@@ -0,0 +1,10 @@
+class NoMongoid
+  include Streama::Actor
+  
+  field :full_name
+  
+  def followers
+    self.class.all
+  end
+  
+end

data/spec/app/models/user.rb

@@ -9,7 +9,7 @@ class User
   end
   
   def followers
-    User.all
+    self.class.all
   end
   
 end

data/spec/lib/actor_spec.rb

@@ -5,6 +5,10 @@ describe "Actor" do
   let(:photo) { Photo.create(:comment => "I'm interested") }
   let(:album) { Album.create(:title => "A test album") }
   let(:user) { User.create(:full_name => "Christos") }
+  
+  it "raises an exception if the class is not a mongoid document" do
+    lambda { NoMongoid.new }.should raise_error Streama::Errors::NotMongoid
+  end
 
   describe "#publish_activity" do
     before :each do
@@ -26,20 +30,43 @@ describe "Actor" do
   describe "#activity_stream" do
     
     before :each do
-      2.times { |n| User.create(:full_name => "Receiver #{n}") }
       user.publish_activity(:new_photo, :object => photo, :target_object => album)
       user.publish_activity(:new_comment, :object => photo)
+
+      u = User.create(:full_name => "Other User")
+      u.publish_activity(:new_photo, :object => photo, :target_object => album)
+
     end
 
     it "retrieves the stream for an actor" do
-      user.activity_stream.size.should eq 2
+      user.activity_stream.size.should eq 3
     end
 
     it "retrieves the stream and filters to a particular activity type" do
-      user.activity_stream(:type => :new_photo).size.should eq 1
+      user.activity_stream(:type => :new_photo).size.should eq 2
     end
 
   end
+  
+  describe "#published_activities" do
+    before :each do
+      user.publish_activity(:new_photo, :object => photo, :target_object => album)      
+      user.publish_activity(:new_comment, :object => photo)
+      
+      u = User.create(:full_name => "Other User")
+      u.publish_activity(:new_photo, :object => photo, :target_object => album)
+
+    end
+    
+    it "retrieves published activities for the actor" do
+      user.published_activities.size.should eq 2
+    end
+    
+    it "retrieves and filters published activities by type for the actor" do
+      user.published_activities(:type => :new_photo).size.should eq 1
+    end
+    
+  end
 
 
 end

data/spec/lib/definition_spec.rb

@@ -57,7 +57,7 @@ describe "Definition" do
     end
     
     it "raises an exception if invalid activity" do
-      lambda { Streama::Definition.find(:unknown_activity) }.should raise_error Streama::InvalidActivity
+      lambda { Streama::Definition.find(:unknown_activity) }.should raise_error Streama::Errors::InvalidActivity
     end
     
   end

data/spec/spec_helper.rb

@@ -9,13 +9,16 @@ $LOAD_PATH.unshift(SUPPORT)
 require 'streama'
 require 'mongoid'
 require 'rspec'
-
+require 'database_cleaner'
+ 
 LOGGER = Logger.new($stdout)
 DATABASE_ID = Process.pid
 
+DatabaseCleaner.strategy = :truncation
+
 Mongoid.configure do |config|
-  database = Mongo::Connection.new.db("mongoid_#{DATABASE_ID}")
-  database.add_user("mongoid", "test")
+  database = Mongo::Connection.new.db("streama_#{DATABASE_ID}")
+  database.add_user("streama", "test")
   config.master = database
   config.logger = nil
 end
@@ -35,11 +38,16 @@ RSpec.configure do |config|
   config.mock_with :rspec
   
   config.before(:each) do
+    DatabaseCleaner.start
     Mongoid::IdentityMap.clear
   end
   
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+  
   config.after :suite do
-    Mongoid.master.connection.drop_database("mongoid_#{DATABASE_ID}")
+    Mongoid.master.connection.drop_database("streama_#{DATABASE_ID}")
   end
   
 end

data/streama.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec", "~> 2.5"
+  s.add_development_dependency "database_cleaner", "~> 0.8"
   s.add_development_dependency "mongoid", "~> 2.4"
   s.add_development_dependency "bson_ext", "~> 1.5"
   s.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streama
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000 Z
+date: 2012-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70213468334740 !ruby/object:Gem::Requirement
+  requirement: &70201716311720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *70213468334740
+  version_requirements: *70201716311720
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70201716311220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70201716311220
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70213468333820 !ruby/object:Gem::Requirement
+  requirement: &70201716310740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70213468333820
+  version_requirements: *70201716310740
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70213468332900 !ruby/object:Gem::Requirement
+  requirement: &70201716310280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '1.5'
   type: :development
   prerelease: false
-  version_requirements: *70213468332900
+  version_requirements: *70201716310280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70213468332440 !ruby/object:Gem::Requirement
+  requirement: &70201716309880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70213468332440
+  version_requirements: *70201716309880
 description: Streama is a simple activity stream gem for use with the Mongoid ODM
   framework
 email:
@@ -81,6 +92,7 @@ files:
 - lib/streama/version.rb
 - spec/app/models/activity.rb
 - spec/app/models/album.rb
+- spec/app/models/no_mongoid.rb
 - spec/app/models/photo.rb
 - spec/app/models/user.rb
 - spec/lib/activity_spec.rb
@@ -109,13 +121,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: streama
-rubygems_version: 1.8.16
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Activity Streams for Mongoid
 test_files:
 - spec/app/models/activity.rb
 - spec/app/models/album.rb
+- spec/app/models/no_mongoid.rb
 - spec/app/models/photo.rb
 - spec/app/models/user.rb
 - spec/lib/activity_spec.rb