virility 0.0.5 → 0.0.6

data/README.md

@@ -18,11 +18,19 @@ Or install it yourself as:
 
 ## Usage
 
+The Excitation object will collect the data from all of the available strategies. 
+
     stats = Virility::Excitation.new("http://rubygems.org")
     stats.poll # returns a hash with the collected output of all data sources
     stats.counts # returns a hash of just the virility counts => {:delicious=>943, :facebook=>72, :pinterest=>0, :plusone=>137, :stumbleupon=>1488, :twitter=>2319} 
     stats.total # returns the sum of all virility counts
 
+One common implementation would be to collect the total count of all social shares for a given URL
+
+    Virility::Excitation.new("http://rubygems.org").total # => 4959
+
+## Individual Strategies
+
 Currently there is support for the following social resources:
 * Facebook
 * Twitter
@@ -31,7 +39,35 @@ Currently there is support for the following social resources:
 * Google Plus One
 * Stumble Upon
 
-More detailed information coming soon.
+Each social resources is implemented as a strategy and contains at least two methods: poll and count.  
+
+_poll_ does the work of querying the API to get the data 
+_count_ pulls out the individual number of shares for that social
+
+Let's say you only need to get the number of tweets for a URL, you could use the Virility::Twitter class by itself:
+
+    tweets = Virility::Twitter.new("http://rubygems.org")
+    tweets.poll # returns a hash with the collected output from Twitter => {"url"=>"http://rubygems.org/", "count"=>2319} 
+    tweets.count # returns the number of tweets for that URL => 2319 
+
+## Facebook Usage
+
+The Facebook strategy leverages the FQL query against the link_stat table. Because of this, the following data fields are available:
+* like_count
+* click_count
+* share_count
+* comment_count
+* commentsbox_count
+* total_count (used as the default count for all Facebook activity)
+* comments_fbid
+
+    fb = Virility::Facebook.new("http://rubygems.org")
+    fb.poll # returns a hash with the collected output from Facebook 
+    fb.count # returns the total_count for that URL => 72 
+
+## Important Notes
+
+URL's are very specific in the context of a social media.  For example, http://rubygems.org will return different results than http://rubygems.org/ with a trailing slash.  Also, http vs https will give you different numbers. This actually has a lot to do with why we created this gem.  When testing be sure to investigate all of the URL variations in order to get the most complete picture of your data.
 
 ## Contributing
 
@@ -41,7 +77,7 @@ More detailed information coming soon.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-== Copyright
+## Copyright
 
 Copyright (c) 2012 Jay Sanders. See LICENSE.txt for
 further details.

data/lib/virility/context.rb

@@ -10,5 +10,9 @@ module Virility
 		def poll
 			raise "Abstract Method poll called on #{self.class} - Please define this method"
 		end
+
+		def count
+			raise "Abstract Method count called on #{self.class} - Please define this method"
+		end
 	end
 end

data/lib/virility/version.rb

@@ -1,3 +1,3 @@
 module Virility
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virility
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4477623610621642756
+      hash: -1645874918326288132
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4477623610621642756
+      hash: -1645874918326288132
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24