pfeed 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Naveed Ahmad
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Er Abhishek Parolkar ( abhishek [at] parolkar.com)
+
+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.markdown

@@ -0,0 +1,115 @@
+Pfeed
+======
+
+You need Pfeed when you want to automagically create fancy logs / activity updates in your rails app, asynchronously. 
+
+
+### What's so magical here?
+Lets assume you have a model that looks like
+
+<pre>
+<code>
+ class User < ActiveRecord::Base
+   has_many :friends
+   has_one  :company
+   def buy(x)
+    ...
+   end
+
+   def sell(x)
+    ...
+   end
+  
+   def find_friends
+    ...
+   end  
+ end
+</code>
+</pre>
+
+Now lets add two lines at bottom of model definition 
+
+<pre>
+<code>
+ emits_pfeeds :on => [:buy,:sell,:find_friends,:update_attribute] , :for => [:itself , :friends]   # Note: if feed needs to be received by all users , you could use :for => [:all_in_its_class]
+ receives_pfeed
+</code>
+</pre>
+          
+
+And you perform regular operations, like this
+
+<pre>
+<code>
+ u1 = User.first
+ u1.buy(10)
+ u1.sell(5)
+ u2 = User.last
+ list = u2.find_friends
+ u2.update_attribute(:nick_name, "alice")
+ u2.buy (1)
+</code>
+</pre>
+your application now emits feed without any other additional piece of code, and feed will look like this in view. 
+<pre><code>
+ parolkar sold item about 6 minutes ago
+ parolkar bought item about 4 minutes ago
+ foo found friends about 2 minutes ago
+ foo updated attribute nick name about 2 minutes ago
+ alice bought item about 2 minutes ago
+</code></pre>
+
+Isn't it magical? that it guesses the identity of model object (parolkar or foo in this case) and methods being called are treated as verbs to form a simple past tense.  
+
+Even more, each feed can be customized and skinned the way you want. You can easily extend the functionality to suit your requirements.  
+
+If all this excites you, check out the tutorials [here](http://wiki.github.com/parolkar/pfeed "pfeed's Wiki") or explore some more advanced techniques [here](http://wiki.github.com/parolkar/pfeed/customizing-the-pfeed-item "pfeed customisation techniques")            
+
+
+## Performance
+
+*How efficient is feed generation and delivery?* 
+
+  If your app has mechanisms for asynchronous processing, like delayed_job , pfeed plugin will automatically figure out  how to schedule the delivery in the queue so that your request loop remains efficient and workers can perform deliveries. [Find out more](http://wiki.github.com/parolkar/pfeed/pfeed-delivery-as-background-job "pfeed delivery as background job")  
+
+## More Details
+
+*What is feed?*
+Feed is the collection of activity logs which is generated while you perform actions on model objects.
+
+*Whats so special?, Why should I bother about it?*  
+
+Imagine you want to create admin console for your app to monitor functional activities in your web apps ,i.e how users are using different parts of application. You will need to think of mechanism to capture the logs and then display in some logical manner.  
+
+OR  
+
+Imagine you are building an app like facebook and you want to capture all activity user is performing and display it to her friends/group member/admin , Its a whole new feature whose implementation will force you to dig into design of your app and see where all the logs get generated and then to whom all the logs are going to be published.  
+
+What if I give you a generalized information model which will allow you to create such feature by keeping it completely isolated from your existing logic? and What if it is really scalable enough?  
+
+(more content to come here...)  
+
+
+## Installation
+
+<pre>
+<code>	
+ $ rails plugin install git://github.com/parolkar/pfeed.git # or use script/plugin for older version of rails
+ $ rake pfeed:setup 
+</code>
+</pre> 
+
+## Custom pfeed model and view
+if you wants to customize your views generate custom model and model with pfeed_customization, Generator and update model to collect and persist data, 
+And update view accoring to your requirements 
+<pre>
+<code>	
+ $ rails g pfeed_customization user create
+</code>
+will create your custom pfeed model and view
+ app/model/pfeeds/user_created.rb
+ app/views/pfeeds/_user_created.html.erb
+</pre> 
+
+
+Copyright (c) 2009 [Abhishek Parolkar] abhishek[at]parolkar.com , released under the MIT license

data/README.rdoc

@@ -0,0 +1,231 @@
+Pfeed
+======
+
+You need Pfeed when you want to automagically create fancy logs / activity updates in your rails app, asynchronously. 
+
+
+### What's so magical here?
+Lets assume you have a model that looks like
+
+<pre>
+<code>
+ class User < ActiveRecord::Base
+   has_many :friends
+   has_one  :company
+   def buy(x)
+    ...
+   end
+
+   def sell(x)
+    ...
+   end
+  
+   def find_friends
+    ...
+   end  
+ end
+</code>
+</pre>
+
+Now lets add two lines at bottom of model definition 
+
+<pre>
+<code>
+ emits_pfeeds :on => [:buy,:sell,:find_friends,:update_attribute] , :for => [:itself , :friends]   # Note: if feed needs to be received by all users , you could use :for => [:all_in_its_class]
+ receives_pfeed
+</code>
+</pre>
+          
+
+And you perform regular operations, like this
+
+<pre>
+<code>
+ u1 = User.first
+ u1.buy(10)
+ u1.sell(5)
+ u2 = User.last
+ list = u2.find_friends
+ u2.update_attribute(:nick_name, "alice")
+ u2.buy (1)
+</code>
+</pre>
+your application now emits feed without any other additional piece of code, and feed will look like this in view. 
+<pre><code>
+ parolkar sold item about 6 minutes ago
+ parolkar bought item about 4 minutes ago
+ foo found friends about 2 minutes ago
+ foo updated attribute nick name about 2 minutes ago
+ alice bought item about 2 minutes ago
+</code></pre>
+
+Isn't it magical? that it guesses the identity of model object (parolkar or foo in this case) and methods being called are treated as verbs to form a simple past tense.  
+
+Even more, each feed can be customized and skinned the way you want. You can easily extend the functionality to suit your requirements.  
+
+If all this excites you, check out the tutorials [here](http://wiki.github.com/parolkar/pfeed "pfeed's Wiki") or explore some more advanced techniques [here](http://wiki.github.com/parolkar/pfeed/customizing-the-pfeed-item "pfeed customisation techniques")            
+
+
+## Performance
+
+*How efficient is feed generation and delivery?* 
+
+  If your app has mechanisms for asynchronous processing, like delayed_job , pfeed plugin will automatically figure out  how to schedule the delivery in the queue so that your request loop remains efficient and workers can perform deliveries. [Find out more](http://wiki.github.com/parolkar/pfeed/pfeed-delivery-as-background-job "pfeed delivery as background job")  
+
+## More Details
+
+*What is feed?*
+Feed is the collection of activity logs which is generated while you perform actions on model objects.
+
+*Whats so special?, Why should I bother about it?*  
+
+Imagine you want to create admin console for your app to monitor functional activities in your web apps ,i.e how users are using different parts of application. You will need to think of mechanism to capture the logs and then display in some logical manner.  
+
+OR  
+
+Imagine you are building an app like facebook and you want to capture all activity user is performing and display it to her friends/group member/admin , Its a whole new feature whose implementation will force you to dig into design of your app and see where all the logs get generated and then to whom all the logs are going to be published.  
+
+What if I give you a generalized information model which will allow you to create such feature by keeping it completely isolated from your existing logic? and What if it is really scalable enough?  
+
+(more content to come here...)  
+
+
+## Installation
+
+<pre>
+<code>	
+ $ rails plugin install git://github.com/parolkar/pfeed.git # or use script/plugin for older version of rails
+ $ rake pfeed:setup 
+</code>
+</pre> 
+
+## Custom pfeed model and view
+if you wants to customize your views generate custom model and model with pfeed_customization generator, update model to collect and persist data, 
+And update view accoring to your requirements 
+<pre>
+<code>	
+ $ rails g pfeed_customization user create
+</code>
+will create your custom pfeed model and view
+ app/model/pfeeds/user_created.rb
+ app/views/pfeeds/_user_created.html.erb
+</pre> 
+
+Thanks to
+Pfeed
+======
+
+You need Pfeed when you want to automagically create fancy logs / activity updates in your rails app, asynchronously. 
+
+
+### What's so magical here?
+Lets assume you have a model that looks like
+
+<pre>
+<code>
+ class User < ActiveRecord::Base
+   has_many :friends
+   has_one  :company
+   def buy(x)
+    ...
+   end
+
+   def sell(x)
+    ...
+   end
+  
+   def find_friends
+    ...
+   end  
+ end
+</code>
+</pre>
+
+Now lets add two lines at bottom of model definition 
+
+<pre>
+<code>
+ emits_pfeeds :on => [:buy,:sell,:find_friends,:update_attribute] , :for => [:itself , :friends]   # Note: if feed needs to be received by all users , you could use :for => [:all_in_its_class]
+ receives_pfeed
+</code>
+</pre>
+          
+
+And you perform regular operations, like this
+
+<pre>
+<code>
+ u1 = User.first
+ u1.buy(10)
+ u1.sell(5)
+ u2 = User.last
+ list = u2.find_friends
+ u2.update_attribute(:nick_name, "alice")
+ u2.buy (1)
+</code>
+</pre>
+your application now emits feed without any other additional piece of code, and feed will look like this in view. 
+<pre><code>
+ parolkar sold item about 6 minutes ago
+ parolkar bought item about 4 minutes ago
+ foo found friends about 2 minutes ago
+ foo updated attribute nick name about 2 minutes ago
+ alice bought item about 2 minutes ago
+</code></pre>
+
+Isn't it magical? that it guesses the identity of model object (parolkar or foo in this case) and methods being called are treated as verbs to form a simple past tense.  
+
+Even more, each feed can be customized and skinned the way you want. You can easily extend the functionality to suit your requirements.  
+
+If all this excites you, check out the tutorials [here](http://wiki.github.com/parolkar/pfeed "pfeed's Wiki") or explore some more advanced techniques [here](http://wiki.github.com/parolkar/pfeed/customizing-the-pfeed-item "pfeed customisation techniques")            
+
+
+## Performance
+
+*How efficient is feed generation and delivery?* 
+
+  If your app has mechanisms for asynchronous processing, like delayed_job , pfeed plugin will automatically figure out  how to schedule the delivery in the queue so that your request loop remains efficient and workers can perform deliveries. [Find out more](http://wiki.github.com/parolkar/pfeed/pfeed-delivery-as-background-job "pfeed delivery as background job")  
+
+## More Details
+
+*What is feed?*
+Feed is the collection of activity logs which is generated while you perform actions on model objects.
+
+*Whats so special?, Why should I bother about it?*  
+
+Imagine you want to create admin console for your app to monitor functional activities in your web apps ,i.e how users are using different parts of application. You will need to think of mechanism to capture the logs and then display in some logical manner.  
+
+OR  
+
+Imagine you are building an app like facebook and you want to capture all activity user is performing and display it to her friends/group member/admin , Its a whole new feature whose implementation will force you to dig into design of your app and see where all the logs get generated and then to whom all the logs are going to be published.  
+
+What if I give you a generalized information model which will allow you to create such feature by keeping it completely isolated from your existing logic? and What if it is really scalable enough?  
+
+(more content to come here...)  
+
+
+## Installation
+
+<pre>
+<code>	
+ $ rails plugin install git://github.com/parolkar/pfeed.git # or use script/plugin for older version of rails
+ $ rake pfeed:setup 
+</code>
+</pre> 
+
+## Custom pfeed model and view
+if you wants to customize your views generate custom model and model with pfeed_customization generator, update model to collect and persist data, 
+And update view accoring to your requirements 
+<pre>
+<code>	
+ $ rails g pfeed_customization user create
+</code>
+will create your custom pfeed model and view
+ app/model/pfeeds/user_created.rb
+ app/views/pfeeds/_user_created.html.erb
+</pre> 
+
+
+Copyright (c) 2009 [Abhishek Parolkar] abhishek[at]parolkar.com , released under the MIT license
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+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 = "pfeed"
+  gem.homepage = "http://github.com/naveed-ahmad/pfeed"
+  gem.license = "MIT"
+  gem.summary = 'Automagically create fancy logs / activity updates in your rails app, asynchronously'
+  gem.description = ''
+  gem.email = "naveed.ahmad@7vals.com"
+  gem.authors = ["Naveed Ahmad"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test