snifter 0.1.0.pre

data/credentials-template.yml

@@ -0,0 +1,10 @@
+# Get the following tokens by registering an app at https://dev.twitter.com
+# twitter lets you generate access tokens for immediate development
+# in the application settings section
+
+consumer_key: ck
+consumer_secret: cs
+access_token: at
+access_token_secret: ats
+
+# Then duplicate/rename this file to ~/.snifter for the command line utility

data/lib/snifter.rb

@@ -0,0 +1,7 @@
+require 'twitter'
+
+require 'snifter/app'
+require 'snifter/cli'
+require 'snifter/readable_time'
+require 'snifter/sniffer'
+require 'snifter/version'

data/lib/snifter/app.rb

@@ -0,0 +1,13 @@
+module Snifter
+  def self.store_consumer(credentials, service=Twitter)
+    service.configure do |config|
+      config.consumer_key = credentials['consumer_key']
+      config.consumer_secret = credentials['consumer_secret']
+    end
+  end
+
+  def self.make_client(credentials)
+    Twitter::Client.new(:oauth_token => credentials['access_token'],
+                        :oauth_token_secret => credentials['access_token_secret'])
+  end
+end

data/lib/snifter/cli.rb

@@ -0,0 +1,45 @@
+module Snifter
+  class CLI
+    def echo tweets
+      problem_rgx = /(unwatchable|slow|poor|(problem|error|issue)(s)?|fail(ed|ing|s)?|buffer(ing|ed)?|fuck(e(d|r)|ing|s)?)/i
+
+      tweets.reverse!
+      tweets.each { |t|
+        text = t.text.gsub(/\n/, ' ')
+        highlight text, problem_rgx
+
+        user = sprintf "%-17s", t.from_user
+        time = sprintf "%-12s", ReadableTime.relative(t.created_at)
+        rtweet = sprintf "%-3s", t.retweet_count
+
+        puts "#{yellow user} #{white time} #{green rtweet} #{cyan text}\n"
+       }
+    end
+
+    private
+
+    def highlight str, rgx
+      str.gsub!(rgx) {|s| "\033[33m#{s}\033[36m" }
+    end
+
+    #red 31
+    #blue 34
+    #magenta 35
+
+    def green txt
+      "\033[32m#{txt}\033[0m"
+    end
+
+    def yellow txt
+      "\033[33m#{txt}\033[0m"
+    end
+
+    def cyan txt
+      "\033[36m#{txt}\033[0m"
+    end
+
+    def white txt
+      "\033[37m#{txt}\033[0m"
+    end
+  end
+end

data/lib/snifter/readable_time.rb

@@ -0,0 +1,19 @@
+module ReadableTime
+  def self.relative to
+    a = (Time.now-to).to_i
+
+    case a
+      when 0 then 'Just now'
+      when 1 then 'A sec ago'
+      when 2..59 then a.to_s+' secs ago'
+      when 60..119 then 'A min ago' #120 = 2 minutes
+      when 120..3540 then (a/60).to_i.to_s+' mins ago'
+      when 3541..7100 then 'An hour ago' # 3600 = 1 hour
+      when 7101..82800 then ((a+99)/3600).to_i.to_s+' hours ago'
+      when 82801..172000 then 'A day ago' # 86400 = 1 day
+      when 172001..518400 then ((a+800)/(60*60*24)).to_i.to_s+' days ago'
+      when 518400..1036800 then 'A week ago'
+      else ((a+180000)/(60*60*24*7)).to_i.to_s+' weeks ago'
+    end
+  end
+end

data/lib/snifter/sniffer.rb

@@ -0,0 +1,25 @@
+module Snifter
+  class Sniffer
+    attr_reader :topic, :topic_fails
+
+    def initialize(client, topic)
+      @client = client
+
+      @topic = topic
+      @topic_fails = '### fail OR problem OR issue OR error OR slow OR buffer -"no problem"'.sub('###', topic)
+    end
+
+    def mentions
+      @client.search(@topic, :count => 100).results
+    end
+
+    def fails
+      @client.search(@topic_fails, :count => 100).results
+    end
+
+    def fails_in_last_hour
+      hour_ago = Time.new - 360
+      fails.reject { |tweet| tweet.created_at < hour_ago }
+    end
+  end
+end

data/lib/snifter/version.rb

@@ -0,0 +1,4 @@
+module Snifter
+    NAME    = 'snifter'
+    VERSION = '0.1.0.pre'
+end

data/test/unit/app_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class AppTest < Test::Unit::TestCase
+  context "A Snifter setup" do
+
+    should "configure the Application with a consumer key and secret" do
+      credentials = {'consumer_key' => 'skeleton', 'consumer_secret' => 'closet'}
+
+      config = mock()
+      config.expects(:consumer_key=).with('skeleton').once
+      config.expects(:consumer_secret=).with('closet').once
+
+      service = mock()
+      service.stubs(:configure).yields(config)
+
+      Snifter.store_consumer(credentials, service)
+    end
+
+    should "create clients with user account credentials" do
+      credentials = {'access_token' => '', 'access_token_secret' => '', }
+
+      assert_not_nil(Snifter.make_client(credentials))
+    end
+  end
+end

data/test/unit/cli_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class SnifferTest < Test::Unit::TestCase
+
+  context "A sniffer" do
+
+    setup do
+      @cli = Snifter::CLI.new
+      @real_out = $stdout
+      $stdout = StringIO.new
+    end
+
+    teardown do
+      @cli = nil
+      $stdout = @real_out
+    end
+
+    should "output a list of tweets" do
+      tweet = mock()
+      tweet.expects(:from_user).returns('AdaLovelace').once
+      tweet.expects(:created_at).returns(Time.new).once
+      tweet.expects(:retweet_count).returns(0).once
+      tweet.expects(:text).returns('Whipped up Twitter on the old analytical engine').once
+
+      @cli.echo [tweet]
+
+      assert_match(/AdaLovelace/, $stdout.string)
+      assert_match(/Just now/, $stdout.string)
+      assert_match(/0/, $stdout.string)
+      assert_match(/Whipped up/, $stdout.string)
+    end
+  end
+end

data/test/unit/readable_time_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class ReadableTimeTest < Test::Unit::TestCase
+
+  context "Describing how long ago an event was" do
+
+    should "be just now" do
+      assert_equal('Just now', ReadableTime.relative(Time.new))
+    end
+
+    should "be a second ago" do
+      assert_equal('A sec ago', ReadableTime.relative(Time.new-1))
+    end
+
+    should "be seconds ago" do
+      assert_equal('2 secs ago', ReadableTime.relative(Time.new-2))
+      assert_equal('59 secs ago', ReadableTime.relative(Time.new-59))
+    end
+
+    should "be a minute ago" do
+      assert_equal("A min ago", ReadableTime.relative(Time.new-60))
+      assert_equal("A min ago", ReadableTime.relative(Time.new-119))
+    end
+
+    should "be minutes ago" do
+     assert_equal("2 mins ago", ReadableTime.relative(Time.new-120))
+     assert_equal("59 mins ago", ReadableTime.relative(Time.new-3540))
+    end
+
+    should "be an hour ago" do
+     assert_equal("An hour ago", ReadableTime.relative(Time.new-3541))
+     assert_equal("An hour ago", ReadableTime.relative(Time.new-7100))
+    end
+
+    should "be hours ago" do
+      assert_equal("2 hours ago", ReadableTime.relative(Time.new-7101))
+      assert_equal("23 hours ago", ReadableTime.relative(Time.new-82800))
+    end
+
+    should "be a day ago" do
+      assert_equal("A day ago", ReadableTime.relative(Time.new-82801))
+      assert_equal("A day ago", ReadableTime.relative(Time.new-172000))
+    end
+
+    should "be days ago" do
+      assert_equal("2 days ago", ReadableTime.relative(Time.new-172001))
+      assert_equal("6 days ago", ReadableTime.relative(Time.new-518400))
+    end
+
+    should "be a week ago" do
+      assert_equal("A week ago", ReadableTime.relative(Time.new-518401))
+      assert_equal("A week ago", ReadableTime.relative(Time.new-1036800))
+    end
+
+    should "be weeks ago" do
+      assert_equal("2 weeks ago", ReadableTime.relative(Time.new-1036801))
+    end
+
+  end
+
+end

data/test/unit/sniffer_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class SnifferTest < Test::Unit::TestCase
+
+  context "A sniffer" do
+
+    setup do
+      @client = mock()
+      @sniffer = Snifter::Sniffer.new(@client, 'lovelace')
+    end
+
+    teardown do
+      @sniffer = nil
+    end
+
+    should "have a product name to search for" do
+      assert_equal('lovelace', @sniffer.topic)
+    end
+
+    should "have a failure topic to search for" do
+      assert_equal('lovelace fail OR problem OR issue OR error OR slow OR buffer -"no problem"',
+                   @sniffer.topic_fails)
+    end
+
+    should "Discover tweets mentioning the product" do
+      @client.expects(:search).with('lovelace', {:count => 100}).returns(stub(:results => [])).once
+      @sniffer.mentions
+    end
+
+    should "Discover tweets mentioning the product and terms of failure" do
+      @client.expects(:search).returns(stub(:results => [])).once
+      @sniffer.fails
+    end
+
+    should "Discover how many tweets in the last hour have mentioned issues" do
+      @client.expects(:search).returns(stub(:results => [])).once
+      @sniffer.fails_in_last_hour
+    end
+  end
+end

data/test/unit/test_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'test'
+end
+
+require "rubygems"
+require "bundler"
+Bundler.require :development, :default

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: snifter
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Simon Gregory
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Keeping an eye on twitter to monitor user feedback for your product
+email: simon.gregory@bbc.co.uk
+executables:
+- snifter
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/snifter
+- coverage/assets/0.5.3/app.js
+- coverage/assets/0.5.3/fancybox/blank.gif
+- coverage/assets/0.5.3/fancybox/fancy_close.png
+- coverage/assets/0.5.3/fancybox/fancy_loading.png
+- coverage/assets/0.5.3/fancybox/fancy_nav_left.png
+- coverage/assets/0.5.3/fancybox/fancy_nav_right.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_e.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_n.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_ne.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_nw.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_s.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_se.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_sw.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_w.png
+- coverage/assets/0.5.3/fancybox/fancy_title_left.png
+- coverage/assets/0.5.3/fancybox/fancy_title_main.png
+- coverage/assets/0.5.3/fancybox/fancy_title_over.png
+- coverage/assets/0.5.3/fancybox/fancy_title_right.png
+- coverage/assets/0.5.3/fancybox/fancybox-x.png
+- coverage/assets/0.5.3/fancybox/fancybox-y.png
+- coverage/assets/0.5.3/fancybox/fancybox.png
+- coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css
+- coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.pack.js
+- coverage/assets/0.5.3/favicon_green.png
+- coverage/assets/0.5.3/favicon_red.png
+- coverage/assets/0.5.3/favicon_yellow.png
+- coverage/assets/0.5.3/highlight.css
+- coverage/assets/0.5.3/highlight.pack.js
+- coverage/assets/0.5.3/jquery-1.6.2.min.js
+- coverage/assets/0.5.3/jquery.dataTables.min.js
+- coverage/assets/0.5.3/jquery.timeago.js
+- coverage/assets/0.5.3/jquery.url.js
+- coverage/assets/0.5.3/loading.gif
+- coverage/assets/0.5.3/magnify.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_222222_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_454545_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_888888_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_cd0a0a_256x240.png
+- coverage/assets/0.5.3/smoothness/jquery-ui-1.8.4.custom.css
+- coverage/assets/0.5.3/stylesheet.css
+- coverage/index.html
+- credentials-template.yml
+- Gemfile
+- Gemfile.lock
+- lib/snifter/app.rb
+- lib/snifter/cli.rb
+- lib/snifter/readable_time.rb
+- lib/snifter/sniffer.rb
+- lib/snifter/version.rb
+- lib/snifter.rb
+- LICENSE
+- Rakefile
+- README.md
+- test/unit/app_test.rb
+- test/unit/cli_test.rb
+- test/unit/readable_time_test.rb
+- test/unit/sniffer_test.rb
+- test/unit/test_helper.rb
+homepage: http://github.com/simongregory/snifter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- - lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Robotic Twitter Monitor
+test_files: []
+has_rdoc: