streama 0.3.2 → 0.3.4

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.2

data/Gemfile

@@ -1,10 +1,4 @@
 source "http://rubygems.org"
 
-gem "activesupport", "~> 3.0"
-gem "mongoid", "~> 2.0"
-
-group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.1"
-end
+# Specify your gem's dependencies in streama.gemspec
+gemspec

data/Gemfile.lock

@@ -1,43 +1,47 @@
+PATH
+  remote: .
+  specs:
+    streama (0.3.3)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activesupport (3.0.7)
-    bson (1.3.1)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    i18n (0.5.0)
-    jeweler (1.6.1)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    mongo (1.3.1)
-      bson (>= 1.3.1)
-    mongoid (2.0.2)
-      activemodel (~> 3.0)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.5.2)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    mongo (1.5.2)
+      bson (= 1.5.2)
+    mongoid (2.4.3)
+      activemodel (~> 3.1)
       mongo (~> 1.3)
       tzinfo (~> 0.3.22)
-    rake (0.9.0)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    tzinfo (0.3.27)
+    rspec-mocks (2.6.0)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 3.0)
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.1)
-  mongoid (~> 2.0)
-  rspec (~> 2.3.0)
+  bson_ext (~> 1.5)
+  mongoid (~> 2.4)
+  rake
+  rspec (~> 2.5)
+  streama!

data/README.md

@@ -0,0 +1,134 @@
+# Streama
+
+**ALPHA**
+
+Streama is a simple Ruby activity stream gem for use with the Mongoid ODM framework.
+
+[![travis](https://secure.travis-ci.org/christospappas/streama.png)](http://travis-ci.org/christospappas/streama)
+
+## Install
+
+    gem install streama
+
+## Usage
+
+### Define Activities
+
+Create an Activity model and define the activities and the fields you would like to cache within the activity.
+
+An activity consists of an actor, a verb, an object, and a target. 
+
+``` ruby
+class Activity
+  include Streama::Activity
+
+  activity :new_photo do
+    actor :user, :cache => [:full_name]
+    object :photo, :cache => [:subject, :comment]
+    target_object :album, :cache => [:title]
+  end
+
+end
+```
+
+The activity verb is implied from the activity name, in the above example the verb is :new_photo
+
+The object may be the entity performing the activity, or the entity on which the activity was performed.
+e.g John(actor) shared a video(object)
+
+The target is the object that the verb is enacted on.
+e.g. Geraldine(actor) posted a photo(object) to her album(target)
+
+This is based on the Activity Streams 1.0 specification (http://activitystrea.ms)
+
+### Setup Actors
+
+Include the Actor module in a class and override the default followers method.
+
+``` ruby
+class User
+	include Mongoid::Document
+	include Streama::Actor
+
+	field :full_name, :type => String
+
+	def followers
+		User.excludes(:id => self.id).all
+	end
+end
+```
+
+### Setup Indexes
+
+Create the indexes for the Activities collection. You can do so by calling the create_indexes method.
+
+``` ruby
+Activity.create_indexes
+```
+
+### Publishing Activity
+
+In your controller or background worker:
+
+``` ruby
+current_user.publish_activity(:new_photo, :object => @photo, :target_object => @album)
+```
+  
+This will publish the activity to the mongoid objects returned by the #followers method in the Actor.
+
+To send your activity to different receievers, pass in an additional :receivers parameter.
+
+``` ruby
+current_user.publish_activity(:new_photo, :object => @photo, :target_object => @album, :receivers => :friends) # calls friends method
+```
+
+``` ruby
+current_user.publish_activity(:new_photo, :object => @photo, :target_object => @album, :receivers => current_user.find(:all, :conditions => {:group_id => mygroup}))
+```
+
+## Retrieving Activity
+
+To retrieve all activity for an actor
+
+``` ruby
+current_user.activity_stream
+```
+  
+To retrieve and filter to a particular activity type
+
+``` ruby
+current_user.activity_stream(: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
+activity.load_instance(:actor)
+```
+  
+You can also refresh the cached activity data by calling the Activity#refresh_data method
+
+``` ruby  
+activity.refresh_data
+```
+
+## Upgrading
+
+### 0.3.3
+
+The Activity "target" field was renamed to "target_object". If you are upgrading from a previous version of Streama you will need to rename the field in existing documents.
+
+http://www.mongodb.org/display/DOCS/Updating#Updating-%24rename
+
+## Contributing
+
+Once you've made your great commits
+
+1. Fork
+1. Create a topic branch - git checkout -b my_branch
+1. Push to your branch - git push origin my_branch
+1. Create a Pull Request from your branch
+1. That's it!
+
+## Contributors
+
+* Christos Pappas		(@christospappas)

data/Rakefile

@@ -1,46 +1,6 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "streama"
-  gem.homepage = "http://github.com/christospappas/streama"
-  gem.license = "MIT"
-  gem.summary = %Q{Streama is a simple activity stream gem for use with the Mongoid ODM framework.}
-  gem.description = %Q{Streama is a simple activity stream gem for use with the Mongoid ODM framework.}
-  gem.email = "christos.pappas@gmail.com"
-  gem.authors = ["Christos Pappas"]
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
+require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RSpec::Core::RakeTask.new(:spec)
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "streama #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: :spec

data/lib/streama.rb

@@ -1,7 +1,7 @@
-require 'mongoid'
-require 'streama/actor'
-require 'streama/activity'
-require 'streama/definition'
-require 'streama/definition_dsl'
-require 'streama/errors'
-
+require "mongoid"
+require "streama/version"
+require "streama/actor"
+require "streama/activity"
+require "streama/definition"
+require "streama/definition_dsl"
+require "streama/errors"

data/lib/streama/activity.rb

@@ -7,16 +7,16 @@ module Streama
       include Mongoid::Document
       include Mongoid::Timestamps
     
-      field :verb,        :type => Symbol
-      field :actor,       :type => Hash
-      field :object,      :type => Hash
-      field :target,      :type => Hash
-      field :receivers,   :type => Array
+      field :verb,          :type => Symbol
+      field :actor,         :type => Hash
+      field :object,        :type => Hash
+      field :target_object, :type => Hash
+      field :receivers,     :type => Array
           
       index :name
       index [['actor._id', Mongo::ASCENDING], ['actor._type', Mongo::ASCENDING]]
       index [['object._id', Mongo::ASCENDING], ['object._type', Mongo::ASCENDING]]
-      index [['target._id', Mongo::ASCENDING], ['target._type', Mongo::ASCENDING]]
+      index [['target_object._id', Mongo::ASCENDING], ['target_object._type', Mongo::ASCENDING]]
       index [['receivers.id', Mongo::ASCENDING], ['receivers.type', Mongo::ASCENDING]]
           
       validates_presence_of :actor, :verb
@@ -34,7 +34,7 @@ module Streama
       #   activity(:enquiry) do
       #     actor :user, :cache => [:full_name]
       #     object :enquiry, :cache => [:subject]
-      #     target :listing, :cache => [:title]
+      #     target_object :listing, :cache => [:title]
       #   end
       #
       # @return [Definition] Returns the registered definition
@@ -63,62 +63,58 @@ module Streama
       
     end
 
-
-    module InstanceMethods
-      
-      # Publishes the activity to the receivers
-      #
-      # @param [ Hash ] options The options to publish with.
-      #
-      def publish(options = {})
-        actor = load_instance(:actor)        
-        self.receivers = (options[:receivers] || actor.followers).map { |r| { :id => r.id, :type => r.class.to_s } }
-        self.save
-        self
-      end
-      
-      # Returns an instance of an actor, object or target
-      #
-      # @param [ Symbol ] type The data type (actor, object, target) to return an instance for.
-      #
-      # @return [Mongoid::Document] document A mongoid document instance
-      def load_instance(type)
-        (data = self.send(type)).is_a?(Hash) ? data['type'].to_s.camelcase.constantize.find(data['id']) : data
-      end
     
-      def refresh_data
-        assign_data
-        save(:validate => false)
-      end
+    # Publishes the activity to the receivers
+    #
+    # @param [ Hash ] options The options to publish with.
+    #
+    def publish(options = {})
+      actor = load_instance(:actor)        
+      self.receivers = (options[:receivers] || actor.followers).map { |r| { :id => r.id, :type => r.class.to_s } }
+      self.save
+      self
+    end
     
-      protected
-        
-      def assign_data
+    # Returns an instance of an actor, object or target
+    #
+    # @param [ Symbol ] type The data type (actor, object, target) to return an instance for.
+    #
+    # @return [Mongoid::Document] document A mongoid document instance
+    def load_instance(type)
+      (data = self.send(type)).is_a?(Hash) ? data['type'].to_s.camelcase.constantize.find(data['id']) : data
+    end
+  
+    def refresh_data
+      assign_data
+      save(:validate => false)
+    end
+  
+    protected
       
-        [:actor, :object, :target].each do |type|
-          next unless object = load_instance(type)
+    def assign_data
+    
+      [:actor, :object, :target_object].each do |type|
+        next unless object = load_instance(type)
 
-          class_sym = object.class.name.underscore.to_sym
+        class_sym = object.class.name.underscore.to_sym
 
-          raise Streama::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][:cache]
-            fields.each do |field|
-              raise Streama::InvalidField.new(field) unless object.respond_to?(field)
-              hash[field.to_s] = object.send(field)
-            end
+        raise Streama::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)
+            hash[field.to_s] = object.send(field)
           end
-          write_attribute(type, hash)      
         end
+        write_attribute(type, hash)      
       end
-    
-      def definition
-        @definition ||= Streama::Definition.find(verb)
-      end
-      
+    end
+  
+    def definition
+      @definition ||= Streama::Definition.find(verb)
     end
     
   end
-end
+end

data/lib/streama/actor.rb

@@ -15,29 +15,25 @@ module Streama
       
     end
 
-    module InstanceMethods
-      
-      # Publishes the activity to the receivers
-      #
-      # @param [ Hash ] options The options to publish with.
-      #
-      # @example publish an activity with a object and target
-      #   current_user.publish_activity(:enquiry, :object => @enquiry, :target => @listing)
-      #
-      def publish_activity(name, options={})
-        options[:receivers] = self.send(options[:receivers]) if options[:receivers].is_a?(Symbol)
-        activity = activity_class.publish(name, {:actor => self}.merge(options))
-      end
-    
-      def activity_stream(options = {})
-        activity_class.stream_for(self, options)
-      end
-      
-      def activity_class
-        @activity_klass ||= activity_klass ? activity_klass.classify.constantize : ::Activity
-      end
+    # Publishes the activity to the receivers
+    #
+    # @param [ Hash ] options The options to publish with.
+    #
+    # @example publish an activity with a object and target
+    #   current_user.publish_activity(:enquiry, :object => @enquiry, :target => @listing)
+    #
+    def publish_activity(name, options={})
+      options[:receivers] = self.send(options[:receivers]) if options[:receivers].is_a?(Symbol)
+      activity = activity_class.publish(name, {:actor => self}.merge(options))
+    end
+  
+    def activity_stream(options = {})
+      activity_class.stream_for(self, options)
     end
     
-  end
+    def activity_class
+      @activity_klass ||= activity_klass ? activity_klass.classify.constantize : ::Activity
+    end
+  end 
   
 end