weeter 0.9.0

data/lib/weeter/version.rb

@@ -0,0 +1,3 @@
+module Weeter
+  VERSION = "0.9.0"
+end

data/lib/weeter.rb

@@ -0,0 +1,29 @@
+require 'eventmachine'
+require 'json'
+require 'logger'
+
+require 'weeter/configuration'
+require 'weeter/cli'
+require 'weeter/plugins'
+require 'weeter/runner'
+require 'weeter/twitter'
+
+
+module Weeter
+  
+  def self.configure
+    yield Configuration.instance
+  end
+  
+  def self.logger
+    @logger ||= begin
+      if Configuration.instance.log_path == false
+        nil
+      elsif Configuration.instance.log_path
+        Logger.new(Configuration.instance.log_path)
+      else
+        Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'multi_json'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+require 'weeter'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Weeter::Configuration.instance.log_path = 'log/test.log'
+  end
+end

data/spec/weeter/configuration/client_app_config_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Weeter::Configuration::ClientAppConfig do
+  %w{delete_url subscriptions_url oauth}.each do |setting|
+    it "should accept setting for #{setting}" do
+      Weeter.configure do |conf|
+        conf.client_app do |app|
+          app.send("#{setting}=", "testvalue")
+        end
+      end
+      Weeter::Configuration.instance.client_app.send(setting).should == "testvalue"
+    end
+  end
+  
+  it "should default subscription_updates_port" do
+    Weeter::Configuration.instance.client_app.subscription_updates_port.should == 7337
+  end
+end

data/spec/weeter/configuration/twitter_config_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Weeter::Configuration::TwitterConfig do
+  %w{basic_auth oauth}.each do |setting|
+    it "should accept setting for #{setting}" do
+      Weeter.configure do |conf|
+        conf.twitter do |app|
+          app.send("#{setting}=", "testvalue")
+        end
+      end
+      Weeter::Configuration::TwitterConfig.instance.send(setting).should == "testvalue"
+    end
+  end
+  
+  describe "auth_options" do
+    
+    before do
+      Weeter::Configuration::TwitterConfig.instance.oauth = nil
+      Weeter::Configuration::TwitterConfig.instance.basic_auth = nil
+    end
+    
+    it "should return the oauth settings with a oauth credentials" do
+      Weeter::Configuration::TwitterConfig.instance.oauth = {:consumer_key => 'consumer_key', :consumer_secret => 'consumer_secret', :access_key => 'acces_key', :access_secret => 'access_secret'}
+      Weeter::Configuration::TwitterConfig.instance.auth_options.should == {:oauth => {:consumer_key => 'consumer_key', :consumer_secret => 'consumer_secret', :access_key => 'acces_key', :access_secret => 'access_secret'}}
+    end
+    
+    it "should return the basic auth settings separated by a colon" do
+      Weeter::Configuration::TwitterConfig.instance.basic_auth = {:username => "bob", :password => "s3cr3t"}
+      Weeter::Configuration::TwitterConfig.instance.auth_options.should == {:auth => "bob:s3cr3t"}
+    end
+  
+    it "should prefer oauth over basic auth" do
+      Weeter::Configuration::TwitterConfig.instance.basic_auth = {:username => "bob", :password => "s3cr3t"}
+      Weeter::Configuration::TwitterConfig.instance.oauth = {:consumer_key => 'consumer_key', :consumer_secret => 'consumer_secret', :access_key => 'acces_key', :access_secret => 'access_secret'}
+      Weeter::Configuration::TwitterConfig.instance.auth_options.should == {:oauth => {:consumer_key => 'consumer_key', :consumer_secret => 'consumer_secret', :access_key => 'acces_key', :access_secret => 'access_secret'}}
+    end
+  end
+  
+end

data/spec/weeter/configuration_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Weeter::Configuration do
+  describe "#twitter" do
+    it "should return the instance" do
+      Weeter::Configuration.instance.twitter.should == Weeter::Configuration::TwitterConfig.instance
+    end
+
+    it "should yield the instance when a block is provided" do
+      Weeter::Configuration.instance.twitter do |twitter_config|
+        twitter_config.should == Weeter::Configuration::TwitterConfig.instance
+      end
+    end
+  end
+end

data/spec/weeter/plugins/notification_plugin_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Weeter
+  module Plugins
+    describe NotificationPlugin do
+      describe "#publish_tweet" do
+        it "should delegate to the configured plugin" do
+          client_app_config = Hashie::Mash.new(:notification_plugin => :http)
+          tweet_item = TweetItem.new({})
+          
+          mock_plugin = mock(Notification::Http)
+          Notification::Http.should_receive(:new).and_return(mock_plugin)
+          
+          mock_plugin.should_receive(:publish_tweet).with(tweet_item)
+
+          plugin = NotificationPlugin.new(client_app_config)
+          plugin.publish_tweet(tweet_item)
+        end
+      end
+    end
+  end
+end

data/spec/weeter/plugins/subscription/update_server_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+module Weeter
+  module Plugins
+    module Subscription
+      describe Http::UpdateServer do
+        before(:each) do
+          @new_ids = [1,2,3]
+          @tweet_consumer = mock('TweetConsumer', :reconnect => nil)
+          @tweet_server = Http::UpdateServer.new(nil)
+          @tweet_server.instance_variable_set('@http_post_content', MultiJson.encode(@new_ids))
+          @tweet_server.tweet_consumer = @tweet_consumer
+          @response = mock('DelegatedHttpResponse', :send_response => nil)
+          EM::DelegatedHttpResponse.stub!(:new).and_return(@response)
+        end
+  
+        after(:each) do
+          @tweet_server.process_http_request
+        end
+  
+        it "should process http request" do
+          @tweet_consumer.should_receive(:reconnect).with(@new_ids)
+        end
+  
+        it "should send response" do
+          @response.should_receive(:send_response)
+        end
+      end
+    end
+  end
+end

data/spec/weeter/plugins/subscription_plugin_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Weeter
+  module Plugins
+    describe SubscriptionPlugin do
+      describe "#get_initial_filters" do
+        it "should delegate to the configured plugin" do
+          client_app_config = Hashie::Mash.new(:subscription_plugin => :http)
+          
+          mock_plugin = mock(Subscription::Http)
+          Subscription::Http.should_receive(:new).and_return(mock_plugin)
+          
+          mock_plugin.should_receive(:get_initial_filters).and_yield([{'foo' => 'bar'}])
+
+          plugin = SubscriptionPlugin.new(client_app_config)
+          plugin.get_initial_filters do |filter_params|
+            filter_params.should == [{'foo' => 'bar'}]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/weeter/runner_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Weeter::Runner do
+  describe 'start' do
+
+  end
+end

data/spec/weeter/twitter/tweet_consumer_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Weeter::Twitter::TweetConsumer do
+
+
+  describe "auth" do
+    it 'should use connect to JSON stream with auth options for the configuration' do
+      @mock_stream = mock('JSONStream', :each_item => nil, :on_error => nil, :on_max_reconnects => nil)
+      Twitter::JSONStream.stub!(:connect).and_return(@mock_stream)
+
+      Weeter::Configuration::TwitterConfig.instance.stub!(:auth_options).and_return(:foo => :bar)
+      consumer = Weeter::Twitter::TweetConsumer.new(Weeter::Configuration::TwitterConfig.instance, mock('NotificationPlugin'))
+      Twitter::JSONStream.should_receive(:connect).with(hash_including(:foo => :bar))
+      consumer.connect({'follow' => ['1','2']})
+    end
+  end
+
+  describe "connecting to twitter" do
+
+    before(:each) do
+      @filter_params = {'follow' => ['1','2','3']}
+      Weeter::Configuration::TwitterConfig.instance.stub!(:auth_options).and_return(:foo => :bar)
+      @tweet_values = {'text' => "Hey", 'id_str' => "123", 'user' => {'id_str' => "1"}}
+      @mock_stream = mock('JSONStream', :on_error => nil, :on_max_reconnects => nil)
+      @mock_stream.stub!(:each_item).and_yield(MultiJson.encode(@tweet_values))
+      Twitter::JSONStream.stub!(:connect).and_return(@mock_stream)
+      @client_proxy = mock('NotificationPlugin', :publish_tweet => nil)
+      @consumer = Weeter::Twitter::TweetConsumer.new(Weeter::Configuration::TwitterConfig.instance, @client_proxy)
+    end
+    
+    after(:each) do
+      @consumer.connect(@filter_params)
+    end
+
+    it "should instantiate a TweetItem" do
+      tweet_item = Weeter::TweetItem.new(@tweet_values)
+      Weeter::TweetItem.should_receive(:new).with({'text' => "Hey", 'id_str' => "123", 'user' => {'id_str' => "1"}}).and_return(tweet_item)
+    end
+
+    it "should connect to a Twitter JSON stream" do
+      Twitter::JSONStream.should_receive(:connect).
+        with(:ssl => true, :foo => :bar, :params => @filter_params, :method => 'POST')
+    end
+  
+    it "should publish new tweet if publishable" do
+      mock_tweet = mock('tweet', :deletion? => false, :publishable? => true)
+      tweet_item = Weeter::TweetItem.stub!(:new).and_return mock_tweet
+      @client_proxy.should_receive(:publish_tweet).with(mock_tweet)
+    end
+    
+    it "should not publish unpublishable tweets" do
+      mock_tweet = mock('tweet', :deletion? => false, :publishable? => false, :[] => '')
+      tweet_item = Weeter::TweetItem.stub!(:new).and_return mock_tweet
+      @client_proxy.should_not_receive(:publish_tweet).with(mock_tweet)
+    end
+    
+    it "should delete deletion tweets" do
+      mock_tweet = mock('tweet', :deletion? => true, :publishable? => false)
+      tweet_item = Weeter::TweetItem.stub!(:new).and_return mock_tweet
+      @client_proxy.should_receive(:delete_tweet).with(mock_tweet)
+    end
+  end
+
+end

data/spec/weeter/twitter/tweet_item_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Weeter::TweetItem do
+
+  describe "deletion?" do
+    it "should be true if it is a deletion request" do
+      item = Weeter::TweetItem.new({"delete"=>{"status"=>{"id"=>234, "user_id"=>34555}}})
+      item.should be_deletion
+    end
+
+    it "should be false if it is not a deletion request" do
+      item = Weeter::TweetItem.new({'text' => "Hey", 'id_str' => "123", 'user' => {'id_str' => "1"}})
+      item.should_not be_deletion
+    end
+  end
+
+  describe "publishable" do
+
+    before do
+      @tweet_json = {'text' => "Hey", 'id_str' => "123", 'user' => {'id_str' => '1'}}
+    end
+
+    it "should be publishable if not a reply or a retweet" do
+      item = Weeter::TweetItem.new(@tweet_json)
+      item.should be_publishable
+    end
+
+    it "should not be publishable if implicitly retweeted" do
+      item = Weeter::TweetItem.new(@tweet_json.merge({'text' => 'RT @joe Hey'}))
+      item.should_not be_publishable
+    end
+
+    it "should not be publishable if explicitly retweeted" do
+      item = Weeter::TweetItem.new(@tweet_json.merge('retweeted_status' => {'id_str' => '111', 'text' => 'Hey', 'user' => {'id_str' => "1"}}))
+      item.should_not be_publishable
+    end
+
+    it "should not be publishable if implicit reply" do
+      item = Weeter::TweetItem.new(@tweet_json.merge('text' => '@joe Hey'))
+      item.should_not be_publishable
+    end
+
+    it "should not be publishable if explicit reply" do
+      item = Weeter::TweetItem.new(@tweet_json.merge('text' => '@joe Hey', 'in_reply_to_user_id_str' => '1'))
+      item.should_not be_publishable
+    end
+
+  end
+
+  describe "json attributes" do
+
+    it "should delegate hash calls to its json" do
+      item = Weeter::TweetItem.new({'text' => "Hey"})
+      item['text'].should == "Hey"
+    end
+
+    it "should retrieve nested attributes" do
+      item = Weeter::TweetItem.new({'text' => "Hey", 'id_str' => "123", 'user' => {'id_str' => '1'}})
+      item['user']['id_str'].should == "1"
+    end
+
+  end
+
+
+
+end

data/weeter.conf.example

@@ -0,0 +1,51 @@
+#
+# Customize this configuration file according to your environment.
+#
+Weeter.configure do |conf|
+
+  # To log to STDOUT, don't specify anything.
+  # To log to a specific path:
+  # conf.log_path = '/tmp/weeter.log'
+  # To disable logging:
+  # conf.log_path = false
+
+  conf.twitter do |twitter|
+    # For basic auth
+    # twitter.basic_auth = {:username => 'johnny', :password => 'secret'}
+    
+    # Or, for oauth
+    twitter.oauth = {:consumer_key => ENV['WEETER_TWITTER_CONSUMER_KEY'],
+                     :consumer_secret => ENV['WEETER_TWITTER_CONSUMER_SECRET'],
+                     :access_key => ENV['WEETER_TWITTER_ACCESS_KEY'],
+                     :access_secret => ENV['WEETER_TWITTER_ACCESS_SECRET']
+                    }
+  end
+
+  conf.client_app do |client_app|
+    client_app.notification_plugin = :http
+    client_app.oauth = {
+        :consumer_key => ENV['WEETER_CLIENT_CONSUMER_KEY'],
+        :consumer_secret => ENV['WEETER_CLIENT_CONSUMER_SECRET'],
+        :access_key => ENV['WEETER_CLIENT_ACCESS_KEY'],
+        :access_secret => ENV['WEETER_CLIENT_ACCESS_SECRET']
+    }
+    client_app.publish_url = ENV['WEETER_CLIENT_PUBLISH_URL']
+    client_app.delete_url = ENV['WEETER_CLIENT_DELETE_URL']
+    
+    client_app.subscription_plugin = :http
+    client_app.subscriptions_url = ENV['WEETER_CLIENT_SUBSCRIPTIONS_URL']
+    client_app.subscription_updates_port = 7337 # only effective if running as a daemon
+  end
+  
+  # Alternately...
+
+  # conf.client_app do |client_app|
+  #   client_app.notification_plugin = :resque
+  #   client_app.queue = 'weeter'
+  #   client_app.redis_uri = 'redis://redistogo:abcdef0123456789abcdef0123456789@somehost.redistogo.com:9052/'
+  #   
+  #   client_app.subscription_plugin = :redis
+  #   client_app.subscriptions_key = 'weeter:subscriptions'
+  #   client_app.subscriptions_changed_channel = 'weeter:subscriptions_changed'
+  # end
+end

data/weeter.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "weeter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "weeter"
+  s.version     = Weeter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Luke Melia", "Noah Davis", "Joey Aghion"]
+  s.email       = ["luke@lukemelia.com"]
+  s.homepage    = "http://github.com/lukemelia/weeter"
+  s.summary     = %q{Consume the Twitter stream and notify your app}
+  s.description = %q{Weeter subscribes to a set of twitter users or search terms using Twitter's streaming API, and notifies your app with each new tweet.}
+
+  s.rubyforge_project = "weeter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('eventmachine')
+  s.add_dependency('eventmachine_httpserver', '>= 0.2.1')
+  s.add_dependency('em-hiredis', '>= 0.1.0')
+  s.add_dependency('multi_json', '>= 1.0.2')
+  s.add_dependency('hashie', '>= 1.1.0')
+  s.add_dependency('em-http-request', '>= 1.0.0')
+  s.add_dependency('i18n', "~> 0.6.0")
+  s.add_dependency('activesupport', ">= 3.1.1")
+  s.add_dependency("simple_oauth", '~> 0.1.5')
+  s.add_dependency('twitter-stream', '~> 0.1.14')
+
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification 
+name: weeter
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Luke Melia
+- Noah Davis
+- Joey Aghion
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventmachine_httpserver
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: em-hiredis
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.1.1
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: simple_oauth
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.5
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: twitter-stream
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.14
+  type: :runtime
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id011
+description: Weeter subscribes to a set of twitter users or search terms using Twitter's streaming API, and notifies your app with each new tweet.
+email: 
+- luke@lukemelia.com
+executables: 
+- weeter
+- weeter_control
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/weeter
+- bin/weeter_control
+- lib/weeter.rb
+- lib/weeter/.DS_Store
+- lib/weeter/cli.rb
+- lib/weeter/configuration.rb
+- lib/weeter/configuration/client_app_config.rb
+- lib/weeter/configuration/twitter_config.rb
+- lib/weeter/plugins.rb
+- lib/weeter/plugins/lib/oauth_http.rb
+- lib/weeter/plugins/lib/redis.rb
+- lib/weeter/plugins/notification/http.rb
+- lib/weeter/plugins/notification/resque.rb
+- lib/weeter/plugins/notification_plugin.rb
+- lib/weeter/plugins/subscription/http.rb
+- lib/weeter/plugins/subscription/redis.rb
+- lib/weeter/plugins/subscription_plugin.rb
+- lib/weeter/runner.rb
+- lib/weeter/tasks.rb
+- lib/weeter/twitter.rb
+- lib/weeter/twitter/tweet_consumer.rb
+- lib/weeter/twitter/tweet_item.rb
+- lib/weeter/version.rb
+- log/.gitignore
+- spec/.DS_Store
+- spec/spec_helper.rb
+- spec/weeter/configuration/client_app_config_spec.rb
+- spec/weeter/configuration/twitter_config_spec.rb
+- spec/weeter/configuration_spec.rb
+- spec/weeter/plugins/notification_plugin_spec.rb
+- spec/weeter/plugins/subscription/update_server_spec.rb
+- spec/weeter/plugins/subscription_plugin_spec.rb
+- spec/weeter/runner_spec.rb
+- spec/weeter/twitter/tweet_consumer_spec.rb
+- spec/weeter/twitter/tweet_item_spec.rb
+- weeter.conf.example
+- weeter.gemspec
+homepage: http://github.com/lukemelia/weeter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- 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: "0"
+requirements: []
+
+rubyforge_project: weeter
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Consume the Twitter stream and notify your app
+test_files: 
+- spec/spec_helper.rb
+- spec/weeter/configuration/client_app_config_spec.rb
+- spec/weeter/configuration/twitter_config_spec.rb
+- spec/weeter/configuration_spec.rb
+- spec/weeter/plugins/notification_plugin_spec.rb
+- spec/weeter/plugins/subscription/update_server_spec.rb
+- spec/weeter/plugins/subscription_plugin_spec.rb
+- spec/weeter/runner_spec.rb
+- spec/weeter/twitter/tweet_consumer_spec.rb
+- spec/weeter/twitter/tweet_item_spec.rb