Virility calls upon the API's of many popular social services such as Facebook, Reddit and Pinterest to collect the number of likes, tweets, pins etc. of a particular URL. Written with a modular construction, Virility makes it easy to drop new data collection strategies into the framework so that you can collect all of your statistics in one easy location.
View a demo online: http://virility.herokuapp.com/
Add this line to your application's Gemfile:
gem 'virility'
And then execute:
$ bundle
Or install it yourself as:
$ gem install virility
If all you need is the raw shares numbers for a URL, Virility has some very simple methods you can use right out of the box:
Virility.poll("http://rubygems.org") # => Returns a hash with the collected results from all of the social network strategies
Virility.counts("http://rubygems.org") # => {:facebook=>72, :pinterest=>0, :plus_one=>138, :stumble_upon=>1488, :reddit=>2322, :linkedin => 7}
Virility.total("http://rubygems.org") # => 4020
Virility.url("http://rubygems.org") # => Returns a Virility::Excitation object that you can manipulate
The Virility::Excitation object does the heavy lifting of collecting the data from all of the available strategies.
virility = Virility::Excitation.new("http://rubygems.org")
virility.poll # returns a hash with the collected output of all data sources
virility.counts # returns a hash of just the virility counts => {:facebook=>5116303, :linkedin => 17, :pinterest=>1, :plus_one=>8, reddit:35, :stumble_upon=>4731 }
virility.total # returns the sum of all virility counts
Currently there is support for the following social resources:
- Google Plus One
- Stumble Upon
Each social resource is implemented as a Virility::Strategy and contains at least three methods: poll, results and count. poll does the work of querying the API to get the data and returns the same hash as the results method, results returns the hashed values that were provided by the social network and count pulls out the individual number of shares for that social network.
There are several ways you can access the object for an individual strategy.
The Virility object has a factory method that will return the strategy object:
reddit = Virility.factory(:reddit, "http://rubygems.org") # => returns a Virility::Reddit object with the rubygems url
You can also instate the Virility::Reddit object directly:
reddit = Virility::Reddit.new("http://rubygems.org")
Thanks to (Storyful)[https://github.com/storyful/virility], it is now possible to specify which strategies you want to use when initializing the Excitation object. Simply pass in an array of identifiers when creating the object and only those strategies will be implemented. The default is to use all available strategies.
Virility.poll("http://rubygems.org",strategies: [:facebook,:linkedin,:pinterest])
It is now possible to specify the ip address of a proxy server to utilise whilst performing the call
Virility.poll("http://rubygems.org", proxy: { http_proxyaddr: '192.168.0.23', http_proxyport: 8888 } )
Let's say you only need to get the number of tweets for a URL, you could use the Virility::Reddit class by itself:
tweets = Virility::Reddit.new("http://rubygems.org")
tweets.poll # returns a hash with the collected output from Reddit => {"url"=>"http://rubygems.org/", "count"=>2319}
tweets.results # returns a hash with the collected output from Reddit => {"url"=>"http://rubygems.org/", "count"=>2319}
tweets.count # returns the number of tweets for that URL => 2319
fb = Virility::Facebook.new("http://rubygems.org")
fb.poll # returns a hash with the collected output from Facebook
fb.count # returns the engagement_count for that URL
The Facebook strategy leverages the Graph api call. Because of this, the following data fields are available:
- comment_count
- share_count
- engagement_count
- social_sentence
However, the share_count and engagement_count return the same value for un-authenticated api calls.
If you have a Virility::Excitation object, there are dynamic finders that will return the individual Virility::Strategy object for a social network. Simply call the name of the strategy against the Virility::Excitation object and that strategy will be returned:
virility = Virility::Excitation.new("http://rubygems.org")
facebook = virility.facebook
linkedin = virility.linkedin
reddit = virility.reddit
pinterest = virility.pinterest
plus_one = virility.plus_one
stumble_upon = virility.stumble_upon
If you have a Strategy object, any of the attributes that are commonly returned through the API call will be available as a dynamic finder. This is particularly useful with the Facebook strategy:
fb = Virility::Facebook.new("http://rubygems.org/")
fb.comment_count # => 0
fb.share_count # => 673
fb.engagement_count # => 673
fb.social_sentence # => "673 people like this."
Leveraging both sets of dynamic finders allows you to build an Excitation object and get all the way through to an attribute for a specific strategy:
Virility.url("http://google.com/").facebook.share_count # => 39790003
Virility.url("http://google.com/").stumble_upon.info_link # => "http://www.stumbleupon.com/url/www.google.com/"
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.
Compare the total count results for http://ruby-lang.org/en. One has the trailing slash and one does not.
Virility::Excitation.new("http://www.ruby-lang.org/en").total # => 247695
Virility::Excitation.new("http://www.ruby-lang.org/en/").total # => 253190
On this particular day, there was a 5,495 count difference between the two values. Inspecting the actual results shows you which of the social networks takes the varying forms of the urls into account:
Virility::Excitation.new("http://www.ruby-lang.org/en").counts
# => {:delicious=>37, :facebook=>3, :pinterest=>0, :plusone=>20, :stumbleupon=>246937}
Virility::Excitation.new("http://www.ruby-lang.org/en/").counts
# => {:delicious=>4314, :facebook=>813, :pinterest=>22, :plusone=>406, :stumbleupon=>246937}
Stumbleupon is consistent while Facebook, Pinterest and Google Plus One return different results. Depending on your needs, you could craft an algorithm that takes all of this into account and attempts to deliver an accurate number by combining the data sets that are different and trusting the ones that are the same.
Based on this logic, it is possible to consider that the true total share count is closer to 253,250. Not only is this an opinionated number, it's accuracy is questionable based on assumptions, however if you are just trying to get a ballpark feeling of the virility of your content, this number should suffice.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Copyright (c) 2016 Jay Sanders. See LICENSE.txt for further details.