virility 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac683947bf3549a1496d9053715f9029040a37aa
-  data.tar.gz: 25bd85930830e5d7a5941b2c42d2b3ed53569d68
+  metadata.gz: 0c8799af103e961664e0393019343a6f252d4979
+  data.tar.gz: 2037f8bfc2e346a761811d17187e886a79d14766
 SHA512:
-  metadata.gz: c498ea3542fb97e31ab776eb242c12707c50157f3cbf6576170a6cc2bb135a68a061e37bbb748af986e9d07cad9600f83d5c8e82d2d3907e75126bba32659cfd
-  data.tar.gz: 7c2911cc70fb54bdc4c9e0efb6e783f8c2317e85faad2e008c1dea9eadbf7199c481af3b92c2a69fc70bd734ff3245800a923a15a3641452690dc4d8ec5261ad
+  metadata.gz: 31b0b31c579607b0bb3002320e9e2968dbd335e2f4236619f7838158d9449c4ed27ccbf08031d652a3aaf8da26e26ddd53cd3154e77cad313590d61468717d8f
+  data.tar.gz: a2c111329aaa518ef6ee97c15d0c129cdd72825327a42a5aefb133097dfae98f813a99d54a84b8fcd69ab267a9b6341c2f2f26331fa40c42e99bfa760d6ce4d5

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.byebug_history

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.1
+ruby-2.3

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 gem 'rake'
 
 # Specify your gem's dependencies in virility.gemspec
-gemspec
+gemspec

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 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") # => {:delicious=>0, :facebook=>72, :pinterest=>0, :plus_one=>138, :stumble_upon=>1488, :reddit=>2322}
+    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
 
@@ -54,17 +54,23 @@ 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:
 
-    tweets = Virility.factory(:reddit, "http://rubygems.org") # => returns a Virility::Reddit object with the rubygems url
+    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:
 
-    tweets = Virility::Reddit.new("http://rubygems.org")
+    reddit = Virility::Reddit.new("http://rubygems.org")
 
 #### Ignoring Strategies
 
 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",[:facebook,:linkedin,:pinterest])
+    Virility.poll("http://rubygems.org",strategies: [:facebook,:linkedin,:pinterest])
+
+#### Using Proxy Server
+
+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 } )
 
 #### Individual Usage Example
 
@@ -79,15 +85,15 @@ Let's say you only need to get the number of tweets for a URL, you could use the
 
     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
+    fb.count # returns the engagement_count for that URL
 
-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
+The Facebook strategy leverages the Graph api call. Because of this, the following data fields are available:
 * comment_count
-* commentsbox_count
-* total_count (used as the default count for all Facebook activity)
+* share_count
+* engagement_count
+* social_sentence
+
+However, the share_count and engagement_count return the same value for un-authenticated api calls.
 
 #### Virility::Excitation
 
@@ -106,16 +112,16 @@ If you have a Virility::Excitation object, there are dynamic finders that will r
 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.like_count    # => 12
-    fb.share_count   # => 40
-    fb.comment_count # => 20
-    fb.total_count   # => 72
+    fb.comment_count     # => 0
+    fb.share_count       # => 673
+    fb.engagement_count  # => 673
+    fb.social_sentence   # => "673 people like this."
 
 #### Combined Finders
 
 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.like_count # => 979662
+    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/"
 
 ## Important Notes

data/lib/virility.rb

@@ -8,7 +8,7 @@ require 'virility/excitation'
 require 'virility/strategy'
 require 'virility/exceptions'
 
-Dir["#{File.dirname(__FILE__)}/virility/strategies/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/virility/strategies/**/*.rb"].each { |f| require f }
 
 module Virility
 
@@ -16,20 +16,20 @@ module Virility
   # Public API
   #
 
-  def self.counts(url, strategies = [])
-    Virility::Excitation.new(url, strategies).counts
+  def self.counts(url, strategies: [], proxy: {})
+    Virility::Excitation.new(url, strategies, proxy: proxy).counts
   end
 
-  def self.total(url, strategies = [])
-    Virility::Excitation.new(url, strategies).total
+  def self.total(url, strategies: [], proxy: {})
+    Virility::Excitation.new(url, strategies, proxy: proxy).total
   end
 
-  def self.poll(url, strategies = [])
-    Virility::Excitation.new(url, strategies).poll
+  def self.poll(url, strategies: [], proxy: {})
+    Virility::Excitation.new(url, strategies, proxy: proxy).poll
   end
 
-  def self.url(url, strategies = [])
-    virility = Virility::Excitation.new(url, strategies)
+  def self.url(url, strategies: [], proxy: {})
+    virility = Virility::Excitation.new(url, strategies, proxy: proxy)
     virility.poll
     virility
   end
@@ -38,7 +38,7 @@ module Virility
   # Factory
   #
 
-  def self.factory(strategy, url)
-    Virility::Excitation.new(url).send(strategy)
+  def self.factory(strategy, url, proxy = {})
+    Virility::Excitation.new(url).send(strategy, proxy)
   end
 end

data/lib/virility/excitation.rb

@@ -2,17 +2,18 @@ module Virility
   class Excitation
     include Virility::Supporter
 
-    attr_accessor :url, :results, :strategies, :counts
+    attr_accessor :url, :results, :strategies, :counts, :proxy
 
     #
     # Initialization
     #
-    def initialize(url, strategies = [])
+    def initialize(url, strategies = [], proxy: {})
       @url = url
       @strategies = {}
       @results = {}
       @counts = {}
       @filter_strategies = strategies || []
+      @proxy = proxy
       collect_strategies
       filter_strategies
     end
@@ -66,7 +67,12 @@ module Virility
     #
 
     def collect_strategies
-      Dir["#{File.dirname(__FILE__)}/strategies/**/*.rb"].each { |klass| @strategies[get_class_string(klass).to_sym] = Virility.const_get(camelize(get_class_string(klass))).new(@url) }
+      Dir["#{File.dirname(__FILE__)}/strategies/**/*.rb"].each { |klass| @strategies[get_class_string(klass).to_sym] = Virility.const_get(camelize(get_class_string(klass))).new(@url, proxy: @proxy) }
+    end
+
+    def filter_strategies
+      return if @filter_strategies.empty?
+      @strategies.select! { |k, _v| @filter_strategies.include?(k) }
     end
 
     def filter_strategies

data/lib/virility/strategies/facebook.rb

@@ -1,23 +1,27 @@
 module Virility
   class Facebook < Strategy
-    BASE_URL = "https://api.facebook.com/method/links.getStats?urls="
+    BASE_URL = 'https://graph.facebook.com/?fields=share,og_object{engagement,title}&id='.freeze
+
     def census
-      self.class.get("#{BASE_URL}#{@url}")
+      self.class.get("#{BASE_URL}#{@url}", http_proxyaddr: @http_proxyaddr, http_proxyport: @http_proxyport)
     end
 
     def outcome
-      @response.parsed_response["links_getStats_response"]["link_stat"]
+      response = @response.parsed_response.dig('share')
+      engagement = @response.parsed_response.dig('og_object', 'engagement')
+      response['engagement_count'] = engagement.dig('count')
+      response['social_sentence'] = engagement.dig('social_sentence')
+      response
     end
 
     def count
-      results["total_count"] || 0
+      results.dig('engagement_count') || 0
     end
 
   private
 
     def valid_response_test
-      @response.respond_to?(:parsed_response) and @response.parsed_response.is_a?(Hash) and !@response.parsed_response["links_getStats_response"].nil? and !@response.parsed_response["links_getStats_response"]["link_stat"].nil?
+      @response.respond_to?(:parsed_response) && @response.parsed_response.is_a?(Hash) && !@response.parsed_response['share'].nil?
     end
-
   end
 end

data/lib/virility/strategies/reddit.rb

@@ -6,7 +6,7 @@ module Virility
     end
 
     def census
-      self.class.get("http://www.reddit.com/api/info.json?&url=#{@url}")
+      self.class.get("http://www.reddit.com/api/info.json?&url=#{@url}", http_proxyaddr: @http_proxyaddr, http_proxyport: @http_proxyport)
     end
 
     def count

data/lib/virility/strategy.rb

@@ -3,12 +3,14 @@ module Virility
     include HTTParty
     include Virility::Supporter
 
-    attr_accessor :url, :response, :results, :original_url
+    attr_accessor :url, :response, :results, :original_url, :http_proxyaddr, :http_proxyport
 
-    def initialize url
+    def initialize(url, proxy: {})
       @original_url = url
       @url = encode(url)
       @results = {}
+      @http_proxyaddr = proxy.dig(:http_proxyaddr)
+      @http_proxyport = proxy.dig(:http_proxyport)
     end
 
     #
@@ -96,4 +98,4 @@ module Virility
     end
 
   end
-end
+end

data/lib/virility/version.rb

@@ -1,3 +1,3 @@
 module Virility
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/spec_helper.rb

@@ -28,8 +28,7 @@ module Virility
     :reddit => Virility::Reddit
   }
   FAKE_TESTING_STRATEGIES = [:digg, :instagram, :tumblr]
-
-  FB_RESULTS = {"like_count"=>"19", "click_count"=>"0", "share_count"=>"3", "comment_count"=>"0", "commentsbox_count"=>"0", "total_count"=>"22"}
+  FB_RESULTS  = { 'comment_count' => '4', 'share_count' => '97173', 'engagement_count' => '97384', 'social_sentence' => "97K people like this."}
   FAKE_FB_RESULTS = [:face_count, :pages, :friends]
 end
 

data/spec/strategies/facebook_spec.rb

@@ -10,7 +10,7 @@ describe "Virility::Facebook" do
       expect{ @virility.poll }.not_to raise_error
     end
 
-    ["like_count", "click_count", "share_count", "comment_count", "commentsbox_count", "total_count"].each do |attribute|
+    ["share_count", "comment_count", "engagement"].each do |attribute|
       it "should return 0 for #{attribute}" do
         expect(@virility.send(attribute.to_sym)).to eq(0)
       end
@@ -38,7 +38,7 @@ describe "Virility::Facebook" do
       it_should_behave_like "no facebook results"
     end
 
-    context "when there is a result but no links_getStats_response" do
+    context "when there is a result but no response" do
       before(:each) do
         response = double("HTTParty::Response", :parsed_response => {})
         allow(Virility::Facebook).to receive(:get) { response }
@@ -59,8 +59,11 @@ describe "Virility::Facebook" do
     end
 
     context "when there is a valid result" do
+      let(:fb_response) { { 'share' => { 'comment_count' => '4', 'share_count' => '97173'},
+      'og_object' => { 'engagement' => { 'count' => '97384', 'social_sentence' => "97K people like this."},
+      title: "Guardians of the Galaxy (2014)", id: "10150298925420108"}, id: "http://www.imdb.com/title/tt2015381/"} }
       before(:each) do
-        response = double("HTTParty::Response", :parsed_response => {"links_getStats_response"=>{"list"=>"true", "link_stat"=>{"like_count"=>"977662", "click_count"=>"265614", "share_count"=>"3020040", "comment_count"=>"1118601", "commentsbox_count"=>"0", "total_count"=>"5116303"}}})
+        response = double("HTTParty::Response", parsed_response: fb_response)
         allow(Virility::Facebook).to receive(:get) { response }
         @virility = Virility::Facebook.new(@url)
       end
@@ -69,7 +72,7 @@ describe "Virility::Facebook" do
         expect{ @virility.poll }.not_to raise_error
       end
 
-      {"like_count"=>"977662", "click_count"=>"265614", "share_count"=>"3020040", "comment_count"=>"1118601", "commentsbox_count"=>"0", "total_count"=>"5116303"}.each do |key, value|
+      {"share_count"=>"97173", "engagement_count"=>'97384', "comment_count"=>"4", 'social_sentence' => "97K people like this."}.each do |key, value|
         it "should return #{value} for #{key}" do
           expect(@virility.send(key.to_sym)).to eq(value)
         end
@@ -77,22 +80,22 @@ describe "Virility::Facebook" do
     end
 
     context "when there is a valid result, but not all fields are present" do
+      let(:fb_response) { { 'share' => { 'comment_count' => '4', 'share_count' => '97173'},
+      'og_object' => { 'engagement' => { 'count' => '97384', 'social_sentence' => "97K people like this."},
+      title: "Guardians of the Galaxy (2014)", id: "10150298925420108"}, id: "http://www.imdb.com/title/tt2015381/"} }
       before(:each) do
-        response = double("HTTParty::Response", :parsed_response => {"links_getStats_response"=>{"list"=>"true", "link_stat"=>{"like_count"=>"977662", "comment_count"=>"1118601", "commentsbox_count"=>"0", "total_count"=>"5116303"}}})
+        response = double('HTTParty::Response', parsed_response: fb_response)
         allow(Virility::Facebook).to receive(:get) { response }
         @virility = Virility::Facebook.new(@url)
       end
-
       it "should not raise an error" do
         expect{ @virility.poll }.not_to raise_error
       end
-
-      {"like_count"=>"977662", "click_count"=>0, "share_count"=>0, "comment_count"=>"1118601", "commentsbox_count"=>"0", "total_count"=>"5116303"}.each do |key, value|
+      {"share_count"=>"97173", "engagement_count"=>'97384', "comment_count"=>"4", 'social_sentence' => "97K people like this."}.each do |key, value|
         it "should return #{value} for #{key}" do
           expect(@virility.send(key.to_sym)).to eq(value)
         end
       end
     end
   end
-
 end

data/spec/virility_spec.rb

@@ -31,7 +31,7 @@ describe "Virility" do
   describe "Public API testing" do
     before(:each) do
       @url = "http://creativeallies.com"
-      allow(Virility::Facebook).to receive(:get) { double("HTTParty::Response", :parsed_response => {"links_getStats_response"=>{"list"=>"true", "link_stat"=>{"like_count"=>"977662", "click_count"=>"265614", "share_count"=>"3020040", "comment_count"=>"1118601", "commentsbox_count"=>"0", "total_count"=>"5116303"}}}) }
+      allow(Virility::Facebook).to receive(:get) { double("HTTParty::Response", :parsed_response => { 'share' => { 'comment_count' => '4', 'share_count' => '97173'}, 'og_object' => { 'engagement' => { 'count' => '97384', 'social_sentence' => "97K people like this."}, title: "Guardians of the Galaxy (2014)", id: "10150298925420108"}, id: "http://www.imdb.com/title/tt2015381/"}) }
       allow(Virility::Pinterest).to receive(:get) { double("HTTParty::Response", :parsed_response => {"count"=>1, "url"=>"http://creativeallies.com"}) }
       allow(Virility::PlusOne).to receive(:get) { double("HTTParty::Response", :parsed_response => {"shares"=>"8"}) }
       allow(Virility::StumbleUpon).to receive(:get) { double("HTTParty::Response", :parsed_response => {"url"=>"http://creativeallies.com/", "in_index"=>true, "publicid"=>"2UhTwK", "views"=>4731, "title"=>"Creative Allies | Create Art For Rockstars | Upload For A Chance To Win", "thumbnail"=>"http://cdn.stumble-upon.com/mthumb/388/49348388.jpg", "thumbnail_b"=>"http://cdn.stumble-upon.com/images/nobthumb.png", "submit_link"=>"http://www.stumbleupon.com/submit/?url=http://creativeallies.com/", "badge_link"=>"http://www.stumbleupon.com/badge/?url=http://creativeallies.com/", "info_link"=>"http://www.stumbleupon.com/url/creativeallies.com/"}) }
@@ -40,16 +40,16 @@ describe "Virility" do
     end
 
     it "Virility.counts should return a hash of counts" do
-      expect(Virility.counts(@url)).to eq({:facebook=>5116303, :linkedin => 17, :pinterest=>1, :plus_one=>8, reddit:35, :stumble_upon=>4731 })
+      expect(Virility.counts(@url)).to eq({:facebook=>97384, :linkedin => 17, :pinterest=>1, :plus_one=>8, reddit:35, :stumble_upon=>4731})
     end
 
     it "Virility.total should return the total count" do
-      expect(Virility.total(@url)).to eq(5121095)
+      expect(Virility.total(@url)).to eq(102176)
     end
 
     it "Virility.poll should return all of the hashed responses" do
       expect(Virility.poll(@url)).to eq({
-        :facebook=>{"like_count"=>"977662", "click_count"=>"265614", "share_count"=>"3020040", "comment_count"=>"1118601", "commentsbox_count"=>"0", "total_count"=>"5116303"},
+        :facebook=>{"comment_count"=>"4", "share_count"=>"97173", "engagement_count"=>"97384", "social_sentence"=>"97K people like this."},
         :linkedin=>{ "count":17, "fCnt":"17", "fCntPlusOne":"18", "url":"http:\/\/creativeallies.com" },
         :pinterest=>{"count"=>1, "url"=>"http://creativeallies.com"},
         :plus_one=>{"shares"=>"8"},
@@ -59,7 +59,16 @@ describe "Virility" do
     end
     it "Virility.poll should return all of the hashed responses with filtered strategies only" do
       expect(Virility.poll(@url,[:facebook,:linkedin,:pinterest,:plus_one,:stumble_upon])).to eq({
-        :facebook=>{"like_count"=>"977662", "click_count"=>"265614", "share_count"=>"3020040", "comment_count"=>"1118601", "commentsbox_count"=>"0", "total_count"=>"5116303"},
+        :facebook=>{"share_count"=>"97173", "engagement_count"=>'97384', "comment_count"=>"4", 'social_sentence' => "97K people like this."},
+        :linkedin=>{ "count":17, "fCnt":"17", "fCntPlusOne":"18", "url":"http:\/\/creativeallies.com" },
+        :pinterest=>{"count"=>1, "url"=>"http://creativeallies.com"},
+        :plus_one=>{"shares"=>"8"},
+        :stumble_upon=>{"url"=>"http://creativeallies.com/", "in_index"=>true, "publicid"=>"2UhTwK", "views"=>4731, "title"=>"Creative Allies | Create Art For Rockstars | Upload For A Chance To Win", "thumbnail"=>"http://cdn.stumble-upon.com/mthumb/388/49348388.jpg", "thumbnail_b"=>"http://cdn.stumble-upon.com/images/nobthumb.png", "submit_link"=>"http://www.stumbleupon.com/submit/?url=http://creativeallies.com/", "badge_link"=>"http://www.stumbleupon.com/badge/?url=http://creativeallies.com/", "info_link"=>"http://www.stumbleupon.com/url/creativeallies.com/"}
+      })
+    end
+    it "Virility.poll should return all of the hashed responses with filtered strategies only" do
+      expect(Virility.poll(@url,[:facebook,:linkedin,:pinterest,:plus_one,:stumble_upon])).to eq({
+        :facebook=>{"share_count"=>"97173", "engagement_count"=>'97384', "comment_count"=>"4", 'social_sentence' => "97K people like this."},
         :linkedin=>{ "count":17, "fCnt":"17", "fCntPlusOne":"18", "url":"http:\/\/creativeallies.com" },
         :pinterest=>{"count"=>1, "url"=>"http://creativeallies.com"},
         :plus_one=>{"shares"=>"8"},

data/virility.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   # Development
   gem.add_development_dependency "rspec", "~> 3.4"
   gem.add_development_dependency "pry", "~> 0.10"
+
   # Dependencies
   gem.add_dependency "httparty", "~> 0.11"
   gem.add_dependency "multi_json", "~> 1.11"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virility
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jay Sanders
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Virility calls upon the API's of many popular social services such as Facebook,