allow filter aliases (groups)

app/models/agents/twitter_stream_agent.rb

@@ -9,6 +9,8 @@ module Agents
       You must provide an oAuth `consumer_key`, `consumer_secret`, `oauth_token`, and `oauth_token_secret`, as well as an array of `filters`.  Multiple words in a filter
       must all show up in a tweet, but are independent of order.
 
+      If you provide an array instead of a filter, the first entry will be considered primary and any additional values will be treated as aliases.
+
       To get oAuth credentials for Twitter, [follow these instructions](https://github.com/cantino/huginn/wiki/Getting-a-twitter-oauth-token).
 
       Set `expected_update_period_in_days` to the maximum amount of time that you'd expect to pass between Events being created by this Agent.
@@ -76,16 +78,20 @@ module Agents
     end
 
     def process_tweet(filter, status)
-      if options[:generate] == "counts"
-        # Avoid memory pollution by reloading the Agent.
-        agent = Agent.find(id)
-        agent.memory[:filter_counts] ||= {}
-        agent.memory[:filter_counts][filter.to_sym] ||= 0
-        agent.memory[:filter_counts][filter.to_sym] += 1
-        remove_unused_keys!(agent, :filter_counts)
-        agent.save!
-      else
-        create_event :payload => status.merge(:filter => filter.to_s)
+      filter = lookup_filter(filter)
+
+      if filter
+        if options[:generate] == "counts"
+          # Avoid memory pollution by reloading the Agent.
+          agent = Agent.find(id)
+          agent.memory[:filter_counts] ||= {}
+          agent.memory[:filter_counts][filter.to_sym] ||= 0
+          agent.memory[:filter_counts][filter.to_sym] += 1
+          remove_unused_keys!(agent, :filter_counts)
+          agent.save!
+        else
+          create_event :payload => status.merge(:filter => filter.to_s)
+        end
       end
     end
 
@@ -100,9 +106,21 @@ module Agents
 
     protected
 
+    def lookup_filter(filter)
+      options[:filters].each do |known_filter|
+        if known_filter == filter
+          return filter
+        elsif known_filter.is_a?(Array)
+          if known_filter.include?(filter)
+            return known_filter.first
+          end
+        end
+      end
+    end
+
     def remove_unused_keys!(agent, base)
       if agent.memory[base]
-        (agent.memory[base].keys - agent.options[:filters].map(&:to_sym)).each do |removed_key|
+        (agent.memory[base].keys - agent.options[:filters].map {|f| f.is_a?(Array) ? f.first.to_sym : f.to_sym }).each do |removed_key|
           agent.memory[base].delete(removed_key)
         end
       end

spec/models/agents/twitter_stream_agent_spec.rb

@@ -24,19 +24,35 @@ describe Agents::TwitterStreamAgent do
       end
 
       it 'records counts' do
-        @agent.process_tweet(:keyword1, {:text => "something", :user => {:name => "Mr. Someone"}})
-        @agent.process_tweet(:keyword2, {:text => "something", :user => {:name => "Mr. Someone"}})
-        @agent.process_tweet(:keyword1, {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword2', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1', {:text => "something", :user => {:name => "Mr. Someone"}})
 
         @agent.reload
         @agent.memory[:filter_counts][:keyword1].should == 2
         @agent.memory[:filter_counts][:keyword2].should == 1
       end
 
+      it 'records counts for keyword sets as well' do
+        @agent.options[:filters][0] = %w[keyword1-1 keyword1-2 keyword1-3]
+        @agent.save!
+
+        @agent.process_tweet('keyword2', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword2', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1-1', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1-2', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1-3', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1-1', {:text => "something", :user => {:name => "Mr. Someone"}})
+
+        @agent.reload
+        @agent.memory[:filter_counts][:'keyword1-1'].should == 4 # it stores on the first keyword
+        @agent.memory[:filter_counts][:keyword2].should == 2
+      end
+
       it 'removes unused keys' do
         @agent.memory[:filter_counts] = {:keyword1 => 2, :keyword2 => 3, :keyword3 => 4}
         @agent.save!
-        @agent.process_tweet(:keyword1, {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1', {:text => "something", :user => {:name => "Mr. Someone"}})
         @agent.reload.memory[:filter_counts].should == {:keyword1 => 3, :keyword2 => 3}
       end
     end
@@ -53,6 +69,21 @@ describe Agents::TwitterStreamAgent do
           :user => {:name => "Mr. Someone"}
         }
       end
+
+      it 'handles keyword sets too' do
+        @agent.options[:filters][0] = %w[keyword1-1 keyword1-2 keyword1-3]
+        @agent.save!
+
+        lambda {
+          @agent.process_tweet('keyword1-2', {:text => "something", :user => {:name => "Mr. Someone"}})
+        }.should change { @agent.events.count }.by(1)
+
+        @agent.events.last.payload.should == {
+          :filter => 'keyword1-1',
+          :text => "something",
+          :user => {:name => "Mr. Someone"}
+        }
+      end
     end
   end
 
@@ -64,9 +95,9 @@ describe Agents::TwitterStreamAgent do
       end
 
       it 'emits events' do
-        @agent.process_tweet(:keyword1, {:text => "something", :user => {:name => "Mr. Someone"}})
-        @agent.process_tweet(:keyword2, {:text => "something", :user => {:name => "Mr. Someone"}})
-        @agent.process_tweet(:keyword1, {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword2', {:text => "something", :user => {:name => "Mr. Someone"}})
+        @agent.process_tweet('keyword1', {:text => "something", :user => {:name => "Mr. Someone"}})
 
         lambda {
           @agent.reload.check