engagement 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c480010424c0c5e4a459b29f5f1c0ef442033ee
+  data.tar.gz: 4e8048b988f5934eacf5d3f906ec9749845ea743
+SHA512:
+  metadata.gz: e21ae66354f2a68e596782770c9ee077144fa9eb0e49abbb8b44104c19208bd35940f097ca050591f8056895972272ddb3b8a5a5e1db9e2fb68acec965f550b1
+  data.tar.gz: 65842d46f26d7a566a3d12d14dcdb483aa7dcea8f6464f4dc741cff3aa73ef809b4803ca776e55eab5ab8f3953444e05335099dd3aaec56b36e5a719a05d29cb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in engagement.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Guterl
+
+MIT License
+
+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.md

@@ -0,0 +1,71 @@
+# Engagement
+
+A ruby gem for measuring the engagement of URLs on various social sites.
+
+Right now this project is just useful for counting comments for URLs
+on a variety of social sites. It may grow into something more useful
+in the future.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'engagement'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install engagement
+
+## Usage
+
+```ruby
+hacker_news = Engagement::CommentCounter::HackerNews.new
+reddit      = Engagement::CommentCounter::Reddit.new
+counter     = Engagement::CommentCounter.new([hacker_news, reddit])
+
+counter.comments_count('http://gaslight.co/blog/why-we-wrote-a-blog') # => 17
+```
+
+or to use the threaded version which fetches the counts from each
+service in a separate thread.
+
+```ruby
+counter = Engagement::CommentCounter::Threaded.new([hacker_news, reddit])
+counter.comments_count('http://gaslight.co/blog/why-we-wrote-a-blog') # => 17
+```
+
+### HackerNews
+
+```ruby
+hacker_news = Engagement::CommentCounter::HackerNews.new
+hacker_news.comments_count('http://gaslight.co/blog/why-we-wrote-a-blog') # => 9
+```
+
+### Reddit
+
+```ruby
+reddit = Engagement::CommentCounter::Reddit.new
+reddit.comments_count('http://gaslight.co/blog/why-we-wrote-a-blog') # => 8
+```
+
+### Disqus
+
+In order to fetch this data from Disqus you need to own the forum (in
+Disqus's terminology) where the URL is owned.
+
+```ruby
+disqus = Engagement::CommentCounter::Disqus.new(forum_api_key)
+disqus.comments_count('http://gaslight.co/blog/why-we-wrote-a-blog') # => 2
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/engagement.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'engagement/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "engagement"
+  spec.version       = Engagement::VERSION
+  spec.authors       = ["Michael Guterl"]
+  spec.email         = ["michael@diminishing.org"]
+  spec.description   = %q{A ruby gem for measuring the engagement of URLs on various social sites.}
+  spec.summary       = %q{Get comment counts from Reddit, HackerNews, and Disqus.}
+  spec.homepage      = "https://github.com/gaslight/engagement"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'debugger'
+
+  spec.add_dependency 'hacker_news_search', '~> 0.0.6'
+  spec.add_dependency 'snoo'
+  spec.add_dependency 'disqus'
+end

data/lib/engagement.rb

@@ -0,0 +1,5 @@
+require 'engagement/version'
+
+module Engagement
+  autoload :CommentCounter, 'engagement/comment_counter'
+end

data/lib/engagement/comment_counter.rb

@@ -0,0 +1,20 @@
+module Engagement
+  class CommentCounter
+
+    autoload :Threaded, 'engagement/comment_counter/threaded'
+    autoload :HackerNews, 'engagement/comment_counter/hacker_news'
+    autoload :Reddit, 'engagement/comment_counter/reddit'
+    autoload :Disqus, 'engagement/comment_counter/disqus'
+
+    def initialize(places)
+      @places = places
+    end
+
+    def comments_count(url)
+      @places.inject(0) do |comments_count, place|
+        comments_count + place.comments_count(url)
+      end
+    end
+
+  end
+end

data/lib/engagement/comment_counter/disqus.rb

@@ -0,0 +1,36 @@
+require 'disqus'
+
+module Engagement
+  class CommentCounter
+    class Disqus
+
+      def initialize(forum_api_key)
+        @forum_api_key = forum_api_key
+      end
+
+      # When we don't own the thread we currently return 0 to prevent an 
+      # exception from being raised. We're not sure that this is the best 
+      # long-term solution.
+      def comments_count(url)
+        if (thread_id = thread_id_for(url))
+          comments_count_for_thread_id thread_id
+        else
+          0
+        end
+      end
+
+      private
+
+      def comments_count_for_thread_id(thread_id)
+        counts = ::Disqus::Api.get_num_posts(thread_ids:[thread_id], forum_api_key: @forum_api_key)["message"]
+        counts[thread_id].last
+      end
+
+      def thread_id_for(url)
+        thread = ::Disqus::Api.get_thread_by_url(forum_api_key: @forum_api_key, url: url)
+        thread['message'] && thread['message']['id']
+      end
+
+    end
+  end
+end

data/lib/engagement/comment_counter/hacker_news.rb

@@ -0,0 +1,13 @@
+require 'hacker_news_search'
+
+class Engagement::CommentCounter::HackerNews
+  def initialize
+    @client = HackerNewsSearch.new
+  end
+
+  def comments_count(url)
+    @client.search("items", url)['results'].inject(0) { |comments_count, result|
+      comments_count + result['item']['num_comments']
+    }
+  end
+end

data/lib/engagement/comment_counter/reddit.rb

@@ -0,0 +1,32 @@
+require 'snoo'
+
+class Engagement::CommentCounter::Reddit
+  def initialize
+    @client = Snoo::Client.new
+  end
+
+  def comments_count(url)
+    response = @client.search(url).parsed_response
+
+    # Sometimes the Reddit API returns an Array, sometimes it returns a Hash.
+    unless response.is_a?(Array)
+      response = [response]
+    end
+
+    response.inject(0) do |count, listing|
+      count + extract_count_from(listing)
+    end
+  end
+
+  private
+
+  def extract_count_from(response)
+    return 0 unless response && response['data']
+
+    children = response['data']['children']
+    children.inject(0) { |count, entry|
+      data = entry['data']
+      count + (data['num_comments'] || 0)
+    }
+  end
+end

data/lib/engagement/comment_counter/threaded.rb

@@ -0,0 +1,28 @@
+require 'thread'
+
+class Engagement::CommentCounter::Threaded
+
+  def initialize(places)
+    @places = places
+    @mutex = Mutex.new
+  end
+
+  def comments_count(url)
+    comments_count = 0
+    threads = []
+
+    @places.each do |place|
+      threads << Thread.new do
+        count = place.comments_count(url)
+        
+        @mutex.synchronize do
+          comments_count += count
+        end
+      end
+    end
+
+    threads.each(&:join)
+    comments_count
+  end
+
+end

data/lib/engagement/version.rb

@@ -0,0 +1,3 @@
+module Engagement
+  VERSION = "1.0.0"
+end

data/spec/cassettes/Engagement_CommentCounter_Disqus/when_we_don_t_own_the_url/returns_zero_when_we_don_t_own_the_url.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://disqus.com/api/get_thread_by_url/?forum_api_key=<FILTERED>&url=http://google.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Content-Type:
+      - application/json
+      P3p:
+      - CP="DSP IDC CUR ADM DELi STP NAV COM UNI INT PHY DEM"
+      Vary:
+      - Accept-Encoding, X-Forwarded-Proto
+      Content-Length:
+      - '63'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 25 Jul 2013 14:15:07 GMT
+      X-Varnish:
+      - '1970155121'
+      Age:
+      - '0'
+      Via:
+      - 1.1 varnish
+      Connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"message":null,"code":"ok","succeeded":true}'
+    http_version: 
+  recorded_at: Thu, 25 Jul 2013 14:15:09 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/Engagement_CommentCounter_Disqus/when_we_own_the_url/returns_the_number_of_comments_for_the_given_url.yml

@@ -0,0 +1,89 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://disqus.com/api/get_thread_by_url/?forum_api_key=<FILTERED>&url=http://diminishing.org/searching-for-a-hero-ruby
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Content-Type:
+      - application/json
+      P3p:
+      - CP="DSP IDC CUR ADM DELi STP NAV COM UNI INT PHY DEM"
+      Vary:
+      - Accept-Encoding, X-Forwarded-Proto
+      Content-Length:
+      - '299'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 25 Jul 2013 14:14:47 GMT
+      X-Varnish:
+      - '1970018194'
+      Age:
+      - '0'
+      Via:
+      - 1.1 varnish
+      Connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"message":{"allow_comments":true,"forum":"79677","title":"Searching
+        fora HeroGood Examples","url":"http://diminishing.org/searching-for-a-hero-ruby","num_comments":4,"created_at":"2013-01-27T15:37:02","forum_obj":{"created_at":"2009-01-24
+        21:36:26.853147","shortname":"diminishing","id":"79677","name":"diminishing
+        blog"},"slug":"httpdiminishingorgsearching_for_a_hero_ruby","hidden":false,"identifier":null,"id":"1049620432"},"code":"ok","succeeded":true}'
+    http_version: 
+  recorded_at: Thu, 25 Jul 2013 14:14:49 GMT
+- request:
+    method: get
+    uri: http://disqus.com/api/get_num_posts/?forum_api_key=<FILTERED>&thread_ids=1049620432
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 25 Jul 2013 14:14:47 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Vary:
+      - Accept-Encoding
+      - Cookie
+      P3p:
+      - CP="DSP IDC CUR ADM DELi STP NAV COM UNI INT PHY DEM"
+    body:
+      encoding: UTF-8
+      string: '{"message":{"1049620432":[5,4]},"code":"ok","succeeded":true}'
+    http_version: 
+  recorded_at: Thu, 25 Jul 2013 14:14:49 GMT
+recorded_with: VCR 2.5.0