weeter 0.10.0 → 0.11.0

data/lib/weeter/configuration.rb

@@ -4,7 +4,7 @@ module Weeter
 
   class Configuration
     include Singleton
-    attr_accessor :log_path
+    attr_accessor :log_path, :subscriptions_limit
 
     autoload :ClientAppConfig, 'weeter/configuration/client_app_config'
     autoload :TwitterConfig,   'weeter/configuration/twitter_config'

data/lib/weeter/plugins/subscription_plugin.rb

@@ -9,11 +9,11 @@ module Weeter
     class SubscriptionPlugin
       delegate :get_initial_filters, :to => :configured_plugin
       delegate :listen_for_filter_update, :to => :configured_plugin
-      
+
       def initialize(client_app_config)
         @config = client_app_config
       end
-    
+
     protected
       def configured_plugin
         @configured_plugin ||= begin
@@ -23,4 +23,4 @@ module Weeter
       end
     end
   end
-end
+end

data/lib/weeter/runner.rb

@@ -45,7 +45,7 @@ module Weeter
     end
 
     def tweet_consumer
-      @tweet_consumer ||= Weeter::Twitter::TweetConsumer.new(@config.twitter, notification_plugin, limiter)
+      @tweet_consumer ||= Weeter::Twitter::TweetConsumer.new(@config.twitter, notification_plugin, limiter, @config.subscriptions_limit)
     end
   end
 end

data/lib/weeter/twitter/tweet_consumer.rb

@@ -7,27 +7,37 @@ module Weeter
 
       attr_reader :limiter
 
-      def initialize(twitter_config, notifier, limiter)
+      def initialize(twitter_config, notifier, limiter, subscriptions_limit = nil)
         @config = twitter_config
         @notifier = notifier
         @limiter = limiter
+        @subscriptions_limit = subscriptions_limit
       end
 
       def connect(filter_params)
+        filter_params = limit_filter_params(filter_params) if @subscriptions_limit
         filter_params = clean_filter_params(filter_params)
-        connect_options = {:ssl => true, :params => filter_params, :method => 'POST'}.merge(@config.auth_options)
+
+        connect_options = {
+          ssl:    true,
+          params: filter_params,
+          method: 'POST'
+        }.merge(@config.auth_options)
+
         @stream = ::Twitter::JSONStream.connect(connect_options)
 
         @stream.each_item do |item|
           begin
             tweet_item = TweetItem.new(MultiJson.decode(item))
 
-            if limiter.limit?(*tweet_item.limiting_facets)
-              rate_limit_tweet(tweet_item)
-            elsif tweet_item.deletion?
+            if tweet_item.deletion?
               @notifier.delete_tweet(tweet_item)
             elsif tweet_item.publishable?
-              @notifier.publish_tweet(tweet_item)
+              if limiter.limit?(*tweet_item.limiting_facets)
+                rate_limit_tweet(tweet_item)
+              else
+                @notifier.publish_tweet(tweet_item)
+              end
             else
               ignore_tweet(tweet_item)
             end
@@ -52,6 +62,37 @@ module Weeter
 
     protected
 
+      def limit_filter_params(params)
+        result = params.clone
+        result.default = []
+
+        follow_count = result['follow'].length
+        track_count = result['track'].length
+
+        total = follow_count + track_count
+
+        if total > @subscriptions_limit
+          Weeter.logger.error("Twitter Subscriptions are #{total}, but limited to #{@subscriptions_limit} subscriptions")
+        end
+
+        while total > 1000
+          if follow_count > track_count
+            follow_count -= 1
+          elsif track_count > follow_count
+            track_count -= 1
+          else
+            track_count -= 1
+          end
+
+          total = follow_count + track_count
+        end
+
+        result['track']  = result['track'][0...track_count]
+        result['follow'] = result['follow'][0...follow_count]
+
+        result
+      end
+
       def clean_filter_params(p)
         return {} if p.nil?
         cleaned_params = {}

data/lib/weeter/version.rb

@@ -1,3 +1,3 @@
 module Weeter
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/spec/weeter/twitter/tweet_consumer_spec.rb

@@ -20,6 +20,75 @@ describe Weeter::Twitter::TweetConsumer do
     end
   end
 
+  describe '#limit_filter_params' do
+
+    let(:client_proxy) { mock('NotificationPlugin', :publish_tweet => nil) }
+    let(:consumer) do
+      Weeter::Twitter::TweetConsumer.new(Weeter::Configuration::TwitterConfig.instance, client_proxy, limiter, 1000)
+    end
+
+    let(:track) {[]}
+    let(:follow) {[]}
+
+    let(:params) do
+      {
+        'follow' => follow,
+        'track'  => track
+      }
+    end
+
+    context 'limit not reached' do
+      it 'leaves the values alone' do
+        result = consumer.send(:limit_filter_params, params)
+        result.fetch('track').length.should == 0
+        result.fetch('follow').length.should == 0
+      end
+    end
+
+    context 'follow above' do
+      let(:follow) { (1..1001).to_a }
+
+      it 'it limits follows, but not tracks' do
+        result = consumer.send(:limit_filter_params, params)
+        result.fetch('follow').length.should == 1000
+        result.fetch('track').length.should == 0
+      end
+    end
+
+    context 'track above' do
+      let(:track) { (1..1001).to_a }
+
+      it 'limits tracks, but not follows' do
+        result = consumer.send(:limit_filter_params, params)
+        result.fetch('track').length.should == 1000
+        result.fetch('follow').length.should == 0
+      end
+    end
+
+    context 'they are equally over' do
+      let(:track)  { (1..600).to_a }
+      let(:follow) { (1..600).to_a }
+
+      it 'limits tracks, but not follows' do
+
+        result = consumer.send(:limit_filter_params, params)
+        result.fetch('track').length.should == 500
+        result.fetch('follow').length.should == 500
+      end
+    end
+
+    context 'track is more over' do
+      let(:track)  { (1..800).to_a }
+      let(:follow) { (1..300).to_a }
+
+      it 'limits tracks, but not follows' do
+        result = consumer.send(:limit_filter_params, params)
+        result.fetch('track').length.should == 700
+        result.fetch('follow').length.should == 300
+      end
+    end
+  end
+
   describe "connecting to twitter" do
 
     before(:each) do

data/weeter.conf.example

@@ -9,6 +9,18 @@ Weeter.configure do |conf|
   # To disable logging:
   # conf.log_path = false
 
+  # To hard limits number of subscriptions.
+  # If the limit has been reached it will log and error, and fairly truncate
+  # subscriptions.
+  #
+  #   default: nolimit = nil
+  #
+  # ** Please Note **
+  #   -  by default, twitter will reject connection attempts
+  #      with greater then 1000 subscriptions
+  #
+  # conf.subscriptions_limit = 1000
+
   conf.twitter do |twitter|
     # For basic auth
     # twitter.basic_auth = {:username => 'johnny', :password => 'secret'}

metadata

@@ -1,151 +1,149 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: weeter
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.11.0
   prerelease: 
-  version: 0.10.0
 platform: ruby
-authors: 
+authors:
 - Luke Melia
 - Noah Davis
 - Joey Aghion
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2154031740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *2154031740
+- !ruby/object:Gem::Dependency
+  name: eventmachine_httpserver
+  requirement: &2154030760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    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 
+  version_requirements: *2154030760
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: &2154030240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    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 
+  version_requirements: *2154030240
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &2154029760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    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 
+  version_requirements: *2154029760
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2154029080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    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 
+  version_requirements: *2154029080
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &2154028360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    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 
+  version_requirements: *2154028360
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2154027700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !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 
+  version_requirements: *2154027700
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2154027240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    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 
+  version_requirements: *2154027240
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: &2154026740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.1.5
   type: :runtime
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: lukemelia-twitter-stream
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *2154026740
+- !ruby/object:Gem::Dependency
+  name: lukemelia-twitter-stream
+  requirement: &2154026240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.1.15
   type: :runtime
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: *2154026240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154025660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !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: 
+  prerelease: false
+  version_requirements: *2154025660
+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: 
+executables:
 - weeter
 - weeter_control
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -194,32 +192,29 @@ files:
 - weeter.gemspec
 homepage: http://github.com/lukemelia/weeter
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  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: 
+test_files:
 - spec/spec_helper.rb
 - spec/weeter/configuration/client_app_config_spec.rb
 - spec/weeter/configuration/twitter_config_spec.rb