engagement 1.0.0

data/spec/engagement/comment_counter/disqus_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Engagement::CommentCounter::Disqus do
+
+  if disqus_forum_api_key
+    let(:counter) { Engagement::CommentCounter::Disqus.new(disqus_forum_api_key) }
+
+    context "when we own the url", :vcr do
+      let(:url) { 'http://diminishing.org/searching-for-a-hero-ruby' }
+
+      it 'returns the number of comments for the given url' do
+        counter.comments_count(url).should == 4
+      end
+    end
+
+    context "when we don't own the url", :vcr do
+      let(:url) { 'http://google.com' }
+
+      it "returns zero when we don't own the url" do
+        counter.comments_count(url).should == 0
+      end
+    end
+  else
+    puts 'Skipping Disqus test, please set the DISQUS_FORUM_API_KEY environment variable.'
+  end
+
+end

data/spec/engagement/comment_counter/hacker_news_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Engagement::CommentCounter::HackerNews, :vcr do
+
+  it 'returns the number of comments for the given url' do
+    url = 'http://www.90percentofeverything.com/2013/07/23/the-slippery-slope/'
+    counter = Engagement::CommentCounter::HackerNews.new
+    counter.comments_count(url).should == 18
+  end
+
+end

data/spec/engagement/comment_counter/reddit_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Engagement::CommentCounter::Reddit do
+
+  subject { counter.comments_count(url) }
+  let(:counter) { Engagement::CommentCounter::Reddit.new }
+
+  context 'with a single listing returned', :vcr do
+    let(:url) { 'http://i.imgur.com/VzFTsGg.png' }
+    it { should == 929 }
+  end
+
+  context 'with multiple listings returned', :vcr do
+    let(:url) { 'http://gaslight.co/blog/why-we-wrote-a-blog' }
+    it { should == 8 }
+  end
+
+  context 'with no results', :vcr do
+    let(:url) { 'http://blog.gaslight.co/blog/why-i-chose-angularjs' }
+    it { should == 0 }
+  end
+
+end

data/spec/engagement/comment_counter_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Engagement::CommentCounter do
+
+  class TestCommentCounter
+    def initialize
+      @counts_by_url = Hash.new(0)
+    end
+
+    def add_count_for_url(url, count)
+      @counts_by_url[url] = count
+    end
+
+    def comments_count(url)
+      @counts_by_url[url]
+    end
+  end
+
+  it 'aggregates the results from multiple counters' do
+    url = 'http://google.com'
+
+    counter_1 = TestCommentCounter.new
+    counter_1.add_count_for_url(url, 2)
+
+    counter_2 = TestCommentCounter.new
+    counter_2.add_count_for_url(url, 1)
+
+    counter = Engagement::CommentCounter.new([counter_1, counter_2])
+
+    counter.comments_count(url).should == 3
+  end
+
+end

data/spec/engagement/threaded_comment_counter_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'benchmark'
+
+describe Engagement::CommentCounter::Threaded do
+  
+  class TimedCounter
+    def initialize(seconds, value)
+      @seconds = seconds
+      @value = value
+    end
+
+    def comments_count(url)
+      sleep @seconds
+      @value
+    end
+  end
+
+  it 'fetches results concurrently' do
+    timed_counter_1 = TimedCounter.new(0.3, 1)
+    timed_counter_2 = TimedCounter.new(0.1, 2)
+    counter = Engagement::CommentCounter::Threaded.new([timed_counter_1, timed_counter_2])
+
+    time = Benchmark.realtime {
+      counter.comments_count('http://google.com').should == 3
+    }
+
+    time.should be_within(0.05).of(0.3)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'engagement'
+require 'debugger'
+require 'vcr'
+
+def disqus_forum_api_key
+  ENV['DISQUS_FORUM_API_KEY']
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.filter_sensitive_data('<FILTERED>') { disqus_forum_api_key }
+end
+
+RSpec.configure do |c|
+  # so we can use :vcr rather than :vcr => true;
+  # in RSpec 3 this will no longer be necessary.
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: engagement
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Guterl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hacker_news_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: snoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: disqus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby gem for measuring the engagement of URLs on various social sites.
+email:
+- michael@diminishing.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- engagement.gemspec
+- lib/engagement.rb
+- lib/engagement/comment_counter.rb
+- lib/engagement/comment_counter/disqus.rb
+- lib/engagement/comment_counter/hacker_news.rb
+- lib/engagement/comment_counter/reddit.rb
+- lib/engagement/comment_counter/threaded.rb
+- lib/engagement/version.rb
+- spec/cassettes/Engagement_CommentCounter_Disqus/when_we_don_t_own_the_url/returns_zero_when_we_don_t_own_the_url.yml
+- spec/cassettes/Engagement_CommentCounter_Disqus/when_we_own_the_url/returns_the_number_of_comments_for_the_given_url.yml
+- spec/cassettes/Engagement_CommentCounter_HackerNews/returns_the_number_of_comments_for_the_given_url.yml
+- spec/cassettes/Engagement_CommentCounter_Reddit/with_a_single_listing_returned/.yml
+- spec/cassettes/Engagement_CommentCounter_Reddit/with_multiple_listings_returned/.yml
+- spec/cassettes/Engagement_CommentCounter_Reddit/with_no_results/.yml
+- spec/engagement/comment_counter/disqus_spec.rb
+- spec/engagement/comment_counter/hacker_news_spec.rb
+- spec/engagement/comment_counter/reddit_spec.rb
+- spec/engagement/comment_counter_spec.rb
+- spec/engagement/threaded_comment_counter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gaslight/engagement
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Get comment counts from Reddit, HackerNews, and Disqus.
+test_files:
+- spec/cassettes/Engagement_CommentCounter_Disqus/when_we_don_t_own_the_url/returns_zero_when_we_don_t_own_the_url.yml
+- spec/cassettes/Engagement_CommentCounter_Disqus/when_we_own_the_url/returns_the_number_of_comments_for_the_given_url.yml
+- spec/cassettes/Engagement_CommentCounter_HackerNews/returns_the_number_of_comments_for_the_given_url.yml
+- spec/cassettes/Engagement_CommentCounter_Reddit/with_a_single_listing_returned/.yml
+- spec/cassettes/Engagement_CommentCounter_Reddit/with_multiple_listings_returned/.yml
+- spec/cassettes/Engagement_CommentCounter_Reddit/with_no_results/.yml
+- spec/engagement/comment_counter/disqus_spec.rb
+- spec/engagement/comment_counter/hacker_news_spec.rb
+- spec/engagement/comment_counter/reddit_spec.rb
+- spec/engagement/comment_counter_spec.rb
+- spec/engagement/threaded_comment_counter_spec.rb
+- spec/spec_helper.rb