cinch-twitterstatus 1.0.0 → 1.0.1

data/README.md

@@ -6,7 +6,7 @@
 [![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-twitterstatus/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-twitterstatus?branch=master)
 [![Code Climate](https://codeclimate.com/github/bhaberer/cinch-twitterstatus.png)](https://codeclimate.com/github/bhaberer/cinch-twitterstatus)
 
-Posts the content of a linked Tweet to the channel.
+Posts the content of a linked Tweet to the channel, can also follow users and post their tweets.
 
 ## Installation
 
@@ -43,6 +43,18 @@ Once you have said credentials you will need to pass them to the Plugin's config
 
 Then post a link to a specific tweet and the bot should post the content of said tweet to the channel.
 
+### Watching Twitter Users ###
+
+If you have a twitter account that the bot should watch for new tweets, you can
+define it in the config as well:
+    
+    c.plugins.options[Cinch::Plugins::TwitterStatus] = { consumer_key:    'consumer_key',
+                                                         consumer_secret: 'consumer_secret',
+                                                         oauth_token:     'oauth_token',
+                                                         oauth_secret:    'oauth_secret',
+                                                         watchers:        { '#channel': ['twitteruser'] } }
+
+
 ## Contributing
 
 1. Fork it

data/cinch-twitterstatus.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Cinch IRC bot Plugin that access the Twitter API to post the content of linked twitter statuses to the channel.}
   gem.summary       = %q{Cinch Plugin to post tweets to channel.}
   gem.homepage      = "https://github.com/bhaberer/cinch-twitterstatus"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -22,5 +23,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'coveralls'
   gem.add_development_dependency 'cinch-test'
 
-  gem.add_dependency 'twitter', '~> 4.8.1'
+  gem.add_dependency 'twitter',   '~> 4.8.1'
+  gem.add_dependency 'cinch',     '~> 2.0.0'
 end

data/lib/cinch/plugins/twitterstatus/twitterstatus.rb

@@ -9,6 +9,7 @@ module Cinch::Plugins
     self.help = 'Just link to a specific twitter status and I will post the content of that tweet.'
 
     listen_to :channel
+    timer 15, method: :check_watched
 
     def initialize(*args)
       super
@@ -19,6 +20,37 @@ module Cinch::Plugins
           c.oauth_token =         config[:oauth_token]
           c.oauth_token_secret =  config[:oauth_secret]
         end
+
+        if config[:watchers]
+          @watched = Hash.new
+          config[:watchers].each_pair do |chan, users|
+            @watched[chan] = Hash.new
+            users.each { |user| refresh_cache(chan, user) }
+          end
+        end
+      end
+    end
+
+    def check_watched
+      return unless @watched
+
+      @watched.keys.each do |chan|
+        @watched[chan].keys.each do |user|
+          begin 
+            # Just check the last tweet, if they are posting more than once
+            # every timer tick I don't want to spam the channel. 
+            tweet = Twitter::Client.new.user_timeline(user).first
+            unless @watched[chan][user].include?(tweet.id)
+              @watched[chan][user] << tweet.id
+              
+              msg = format_tweet(user, Twitter.status(tweet.id).text)
+              Channel(chan).send msg unless msg.nil?
+            end
+            refresh_cache(chan, user)
+          rescue Twitter::Error::NotFound
+            debug "You have set an invalid or protected user (#{user}) to watch, please correct this error"
+          end
+        end
       end
     end
 
@@ -27,12 +59,8 @@ module Cinch::Plugins
       urls.each do |url|
         if url.match(/^https?:\/\/mobile|w{3}?\.?twitter\.com/)
           if tweet = url.match(/https?:\/\/mobile|w{3}?\.?twitter\.com\/?#?!?\/([^\/]+)\/statuse?s?\/(\d+)\/?/)
-            status = Twitter.status(tweet[2]).text
-            status.gsub!(/[\n]+/, " ") if status.match(/\n/)
-            user = tweet[1]
-            unless user.nil? || status.nil?
-              m.reply "@#{user} tweeted \"#{status}\""
-            end
+            msg = format_tweet(tweet[1], Twitter.status(tweet[2]).text)
+            m.reply msg unless msg.nil?
           end
         end
       end
@@ -41,5 +69,26 @@ module Cinch::Plugins
     rescue Twitter::Error::Forbidden
       debug "User attempted to post a Protected Tweet or you have not set valid Twitter credentials."
     end
+
+    private
+
+    def format_tweet(user, status)
+      # Return blank if we didn't get a good user and status
+      return if user.nil? || status.nil?
+
+      # Scrub the tweet for returns so we don't have multilined responses.
+      status.gsub!(/[\n]+/, " ") if status.match(/\n/)
+
+      return "@#{user} tweeted \"#{status}\""
+    end
+
+    def refresh_cache(chan, user)
+      @watched[chan][user] = []
+      Twitter::Client.new.user_timeline(user).each do |tweet|
+        @watched[chan][user] << tweet.id
+      end
+    rescue Twitter::Error::NotFound
+      debug "You have set an invalid or protected user (#{user}) to watch, please correct this error"
+    end
   end
 end

data/lib/cinch/plugins/twitterstatus/version.rb

@@ -1,5 +1,5 @@
 module Cinch
   module Twitterstatus
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/spec/cinch-twitterstatus_spec.rb

@@ -5,37 +5,48 @@ describe Cinch::Plugins::TwitterStatus do
   include Cinch::Test
 
   before(:all) do
-    @bot = make_bot(Cinch::Plugins::TwitterStatus, 
+    @bot = make_bot(Cinch::Plugins::TwitterStatus,
                     { filename:        '/dev/null',
-                      hostname:        'marvintesting.tumblr.com',
+                      watchers:        { '#foo' => ['weirdo513'] },
                       consumer_key:    ENV['CONSUMER_KEY'],
                       consumer_secret: ENV['CONSUMER_SECRET'],
                       oauth_token:     ENV['OAUTH_TOKEN'],
                       oauth_secret:    ENV['OAUTH_SECRET'] })
   end
 
-  it 'should return the texof e when linked in the channel' do
-    get_replies(make_message(@bot, 'https://twitter.com/weirdo513/status/344186643609174016', 
-                             { channel: '#foo', nick: 'bar' })).
-      first.text.should == "@weirdo513 tweeted \"HOW IS THAT MIC STILL ON JESUS\""
-  end
+  describe "Twitter Link Parsing" do
+    it 'should return the text of the tweet when linked in the channel' do
+      get_replies(make_message(@bot, 'https://twitter.com/weirdo513/status/344186643609174016', 
+                               { channel: '#foo', nick: 'bar' })).
+        first.text.should == "@weirdo513 tweeted \"HOW IS THAT MIC STILL ON JESUS\""
+    end
 
-  it 'should not return any text if the status is invalid' do
-    get_replies(make_message(@bot, 'https://twitter.com/weirdo513/status/3INVALI643609174016', 
-                             { channel: '#foo', nick: 'bar' })).
-      should be_empty
-  end
+    it 'should not return any text if the status is invalid' do
+      get_replies(make_message(@bot, 'https://twitter.com/weirdo513/status/3INVALI643609174016', 
+                               { channel: '#foo', nick: 'bar' })).
+        should be_empty
+    end
+
+    it 'should not return any text if the status is protected' do
+      get_replies(make_message(@bot, 'https://twitter.com/brewtopian/status/68071618055901184', 
+                               { channel: '#foo', nick: 'bar' })).
+        should be_empty
+    end
 
-  it 'should not return any text if the status is protected' do
-    get_replies(make_message(@bot, 'https://twitter.com/brewtopian/status/68071618055901184', 
-                             { channel: '#foo', nick: 'bar' })).
-      should be_empty
+    it 'should not run without credentials set' do
+      bot = make_bot(Cinch::Plugins::TwitterStatus)
+      get_replies(make_message(bot, 'https://twitter.com/weirdo513/status/344186643609174016',
+                               { channel: '#foo', nick: 'bar' }))
+    end
   end
 
-  it 'should not run without credentials set' do
-    bot = make_bot(Cinch::Plugins::TwitterStatus)
-    get_replies(make_message(bot, 'https://twitter.com/weirdo513/status/344186643609174016',
-                             { channel: '#foo', nick: 'bar' }))
+  describe "Watchers" do
+    # FIXME: cinch-test does not allow timers to function
+    it 'should not post tweets that already existed when the bot was started' do
+      sleep 20
+      get_replies(make_message(@bot, 'https://twitter.com/weirdo513/status/344186643609174016',
+                               { channel: '#foo', nick: 'bar' }))
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-twitterstatus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2013-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.8.1
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: Cinch IRC bot Plugin that access the Twitter API to post the content
   of linked twitter statuses to the channel.
 email:
@@ -112,7 +128,8 @@ files:
 - spec/cinch-twitterstatus_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-twitterstatus
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: