popularity 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 626966520a15ec4f37c183a2a380b5010f105f85
+  data.tar.gz: 00cf045aff8dcdfd8883ff3384ecb7bb253979ed
+SHA512:
+  metadata.gz: 437afdbe8bd81499712c32c1df0015a5adea309b8d0f548e8d830505942f855b11dd0ce8208caf0f0acb6066f12f27f8ad849e3a0b40925c7af6dc22c57fe4f1
+  data.tar.gz: 302858361aebd23d0565a593ddf94a9b9fa9e5d260b03f4dd1bbd605e2525af5dc439261ff86f2d49076fa7b8d0216a60c4914e100e34c125b19fbf93076fe28

data/.document

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format d

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gem 'open_uri_redirections', '~> 0'
+gem 'json', '~> 1.8'
+gem 'unirest', '~> 1'
+
+group :development, :test do
+  gem "pry", '~> 0.10'
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0"
+  gem "simplecov", "~> 0"
+  gem 'awesome_print', '~> 1.6'
+end
+
+group :test do
+  gem "rspec", "~> 3.2"
+  gem "vcr", "~> 2.9"
+  gem "webmock", "~> 1.21"
+end

data/Gemfile.lock

@@ -0,0 +1,126 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    awesome_print (1.6.1)
+    builder (3.2.2)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.1)
+    highline (1.7.1)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.4.1)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    open_uri_redirections (0.2.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.8)
+      mime-types (~> 1.16)
+      rdoc (>= 2.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unirest (1.1.2)
+      addressable (~> 2.3.5)
+      json (~> 1.8.1)
+      rest-client (~> 1.6.7)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.6)
+  bundler (~> 1.0)
+  jeweler (~> 2.0)
+  json (~> 1.8)
+  open_uri_redirections (~> 0)
+  pry (~> 0.10)
+  rdoc (~> 3.12)
+  rspec (~> 3.2)
+  shoulda
+  simplecov (~> 0)
+  unirest (~> 1)
+  vcr (~> 2.9)
+  webmock (~> 1.21)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jeff Keen
+
+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.rdoc

@@ -0,0 +1,92 @@
+# Popularity
+
+### Popularity searches social networks for urls and returns the metrics.
+
+Current support includes: 
+
+Network          |  Stats                           | Restriction
+---------        | ------                           | ---------
+Facebook         | `shares`, `comments`                                
+Twitter          | `tweets`                               
+Pinterest        | `pins`                               
+GooglePlus       | `plusones`                                
+Reddit           | `comments`, `score`
+Reddit Comments  | `score`                          | only for reddit comment urls
+Github           | `stars`                          | only for github repo urls     
+Medium           | `recommends`                     | only for medium posts          
+Soundcloud       | `plays`, `likes`, `comments`, `downloads` | only for soundcloud urls
+
+```ruby
+
+> search = Popularity.search("http://google.com")
+> search.facebook.shares    #=> share count
+> search.facebook.comments  #=> comment count
+> search.twitter.tweets     #=> tweet count
+> search.pinterests.pins    #=> pin count
+> search.reddit.posts     #=> post count
+> search.reddit.comments    #=> comment count across all posts
+> search.reddit.score       #=> reddit score total across all posts
+> search.total          #=> All of the above numbers added up
+
+```
+
+#### Combining multiple URLs 
+
+Sometimes multiple URLs refer to the same thing. Maybe your URLs changed, but you don't want to lose out on counting those votes for the new location. Or you tweeted your blog address, but posted a link to soundcloud on reddit.
+
+```ruby
+> search = Popularity.search("http://jeffkeen.me/p/I-know-its-you/", "http://soundcloud.com/jeffkeen/i-know-its-you")
+> search.facebook.shares    #=> share count across all urls
+> search.facebook.comments  #=> comment count across all urls
+> search.twitter.tweets     #=> tweet count across all urls
+> search.pinterests.pins    #=> pin count across all urls
+> search.reddit.posts     #=> post count across all urls
+> search.reddit.comments    #=> comment count across all posts and urls
+> search.reddit.score       #=> reddit score total across all posts and urls
+> search.total          #=> All of the above numbers added up
+```
+
+JSON: 
+
+```ruby
+> search.to_json 
+#=> spits out by network, by url, and total stats
+```
+
+##### Digging into the details
+
+To see which results a url came back with: 
+```ruby
+search = Popularity.search("https://medium.com/@jeffkeen/call-me-sometime-64ed463c02f0")
+search.sources #=> [:facebook, :reddit, :google_plus, :pinterest, :twitter, :medium]
+```
+```ruby
+search.results #=> returns the individual network result classes, i.e. RedditPost, Medium, Soundcloud, Facebook
+```
+
+All of the searches done through Popularity.search are done asynchronously, but you don't need to worry about any of that because the method still blocks, so you can use it just like any other syncrhonous method.
+
+To just query one network, interact with the class directly.
+
+```ruby
+p = Popularity::RedditComment.new("http://www.reddit.com/r/:subreddit/comments/:id/:name/:comment")
+p.score #=> comment score
+```
+
+
+
+### Contributing to Popularity
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2015 Jeff Keen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# 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://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "popularity"
+  gem.homepage = "http://github.com/jkeen/popularity"
+  gem.license = "MIT"
+  gem.summary = %Q{Popularity searches social networks for urls and returns the metrics.L}
+  gem.description = %Q{}
+  gem.email = "jeff@keen.me"
+  gem.authors = ["Jeff Keen"]
+  # 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
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "popularity #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/popularity.rb

@@ -0,0 +1,92 @@
+
+require 'popularity/crawler'
+require 'popularity/search'
+require 'popularity/results_container'
+require 'popularity/facebook'
+require 'popularity/twitter'
+require 'popularity/pinterest'
+require 'popularity/google_plus'
+require 'popularity/medium'
+require 'popularity/reddit_post'
+require 'popularity/reddit_comment'
+require 'popularity/reddit_share'
+require 'popularity/soundcloud'
+require 'popularity/github'
+
+module Popularity
+  TYPES = [Facebook, Twitter, Pinterest, GooglePlus, RedditShare, RedditPost, RedditComment, Medium, Soundcloud, Github]
+
+  def self.search(*urls)
+  	response = {}
+
+    MultiSearch.new(:urls => urls)
+  end
+
+  def self.select_types(url)
+    # github.com stats only valid for github urls, etc
+    selected_types = Popularity::TYPES.collect { |n|
+      network = n.new(@url)
+      network if network.valid?
+    }.compact
+  end
+
+  class MultiSearch
+    attr_accessor :searches
+    attr_accessor :sources
+
+    def initialize(options = {})
+      @searches = options[:urls].collect { |url| Search.new(url) }
+
+      @searches.each do |search|
+        search.results.each do |result|
+          add_search_result(result)
+        end
+      end
+    end 
+
+    def results
+      searches.collect(&:results).reduce(:+)
+    end
+
+    def to_json(options = {})      
+      json = {}
+      self.searches.collect do |search|
+        json[search.url] = search.to_json
+      end
+
+      self.sources.collect do |source|
+        json[source.to_s] = self.send(source.to_sym).to_json
+      end
+
+      json["total"] = total
+
+      json
+    end
+
+    def total
+      total = 0
+      self.searches.each do |a|
+        total += a.total
+      end
+
+      total
+    end
+
+    protected
+
+    def add_search_result(result)
+      container = self.instance_variable_get("@#{result.name}") 
+
+      unless container
+        @sources ||= [] 
+        @sources << result.name.to_sym 
+        container = Popularity::ResultsContainer.new
+        self.instance_variable_set "@#{result.name}", container
+        self.define_singleton_method(result.name.to_sym) { container }
+      end
+
+      container.add_result(result)
+    end
+
+  end
+end

data/lib/popularity/crawler.rb

@@ -0,0 +1,76 @@
+require 'open-uri'
+require 'open_uri_redirections'
+require 'json'
+require 'unirest'
+
+module Popularity
+  class Crawler
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def request_url
+      raise NotImplemented
+    end
+
+    def response
+      @response ||= fetch
+    end
+
+    def has_response?
+      response #fetch it
+
+      return false if response.nil? 
+      return false if response.empty?
+
+      true
+    end
+
+    def valid? 
+      true # to be overridden in subclasses
+    end
+
+    def async_done?
+      @async_done
+    end
+
+    def host
+      URI.parse(@url).host.gsub('www.', '')
+    end
+
+    def response_json
+      @json ||= JSON.parse(response)
+    end
+
+    def name
+      self.class.to_s.split('::').last.gsub(/(.)([A-Z])/,'\1_\2').downcase
+    end
+
+    def to_json(options = {})
+      as_json(options)
+    end
+
+    def fetch_async(&block)
+      return false unless valid?
+
+      Unirest.get(request_url) do |response|
+        @async_done = true
+        @response = response.raw_body
+        block.call(response.code, response.raw_body) if block_given? 
+      end
+    end
+
+    def fetch
+      return false unless valid?
+        
+      begin
+        response = Unirest.get(request_url)
+        @response = response.raw_body
+      rescue OpenURI::HTTPError, Timeout::Error, SocketError
+        nil
+      end
+    end
+  end
+end