cinch-twitterwatch 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 4b745d127c6fe8c403ac4f105f995a116acb04b7
+  data.tar.gz: 63a71efaf6719ac11311116ee6ab2cdac89ade80
+SHA512:
+  metadata.gz: 0496c061f9c544579d5d809e2886006dd8175f0346501d73c272192a6c521b04d6f24f169371c666c3f0a5ec65d3b3aabb1779505d384dd8928cf7f44b6401a3
+  data.tar.gz: 688ad1a73518af042410df7251947c97e6dca431c114d3874cd83102eea33121c0081058cac4c8ee419dced156339accabcefed2e42fcafbc9ddeaa21465e6bf

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+spec/secret.rb
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,45 @@
+---
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3
+- 1.9.2
+- 1.8.7
+- jruby-18mode
+- jruby-19mode
+- rbx
+- ruby-head
+- jruby-head
+- ree
+matrix:
+  allow_failures:
+  - rvm: 1.8.7
+  - rvm: ree
+  - rvm: jruby-18mode
+  - rvm: jruby-19mode
+  - rvm: jruby-head
+  fast_finish: true
+env:
+  global:
+  - JRUBY_OPTS=-Xcext.enabled=true
+  - secure: ! 'AuTqK4GVSvHxsUdgDXivtFuCQjB7EX19zM5C2b2omp1BLAQsnAyDse/6x2Oe
+
+      kB7SzCwH/PIeSJ8xNzcKF/c32lJZBdQAU7Cz210XoXCevefpWa4Y/4u/nNi2
+
+      eltSdGuJWwAiFMjBGz4IHa2Q7UnS9FcyB4FZXfaPCVZdkmffSzg='
+  - secure: ! 'Ajl+5EjsPtpEh25qfyk0RF2i/oM6g29AWqRHmC+I/TuWhMaFawdTESiqbvJk
+
+      Pir0ogqE+GufgueOYHKmIoYUHfs+dwS82/zBt3bmd8hpSsIGYGMcKVT8Zswe
+
+      QKT3JOOv7Igf96sgHhDk9T/n8ZlyUhtAJmau2MGdYw6Un0gTnZQ='
+  - secure: ! '1GFCEhzcB7bPhWQA2BJTerMvTa0tZjyrnozP5jgz5ejX5pKp8Q6OQogrrPk9
+
+      HZ1KuobWBKF2mnT8S0Kmjia5oR7XQGwanV12Xpe2e+NnqrbWsf7ZZ9OcUK6D
+
+      MjxAZ2zKo0l6zGyor8Alf5ejcAzTJky+/I855tn8zA8jNPG9fD4='
+  - secure: ! 'xUpzXMelLHrVpjT64uuWi8TbDAElda+gBPXLctHwrL+IgxHekAz6cDIgyukT
+
+      bGlWHFpl0lpedv9/eZbv7OchQOcWg45TccbxMcMjHfxYSDNr73RI1L0epn6j
+
+      UsvChSvlzCmUoYeXqygr/1t1ujABLqoaT+YThn957hlVIoUMOUA='

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cinch-twitterwatch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Haberer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Cinch::Plugins::TwitterWatch
+
+[![Gem Version](https://badge.fury.io/rb/cinch-twitterwatch.png)](http://badge.fury.io/rb/cinch-twitterwatch)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-twitterwatch.png)](https://gemnasium.com/bhaberer/cinch-twitterwatch)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-twitterwatch.png?branch=master)](https://travis-ci.org/bhaberer/cinch-twitterwatch)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-twitterwatch/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-twitterwatch?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-twitterwatch.png)](https://codeclimate.com/github/bhaberer/cinch-twitterwatch)
+
+Posts the content of a linked Tweet to the channel, can also follow users and
+post their tweets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cinch-twitterwatch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cinch-twitterwatch
+
+## Usage
+
+For the gem to work all you will need to is require the gem and add
+it to your plugins:
+
+    require 'cinch-twitterwatch'
+
+    @bot = Cinch::Bot.new do
+      configure do |c|
+        c.plugins.plugins = [ Cinch::Plugins::TwitterWatch]
+      end
+    end
+
+And, acquire Twitter credentials. They are simple to acquire,
+see https://dev.twitter.com/apps/new
+
+Once you have said credentials you will need to pass them to the Plugin's
+config like so:
+
+    c.plugins.options[Cinch::Plugins::TwitterWatch] = { consumer_key:    'consumer_key',
+                                                        consumer_secret: 'consumer_secret',
+                                                        access_token:    'access_token',
+                                                        access_secret:   'access_secret',
+                                                        watchers: {
+                                                          '#CHANNEL' => ['TWITTER_USERNAME']
+                                                        }
+                                                      }
+
+Then post a link to a specific tweet and the bot should post the content of said tweet to the channel.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/cinch-twitterwatch.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cinch/plugins/twitterwatch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cinch-twitterwatch'
+  spec.version       = Cinch::Plugins::TwitterWatch::VERSION
+  spec.authors       = ['Brian Haberer']
+  spec.email         = ['bhaberer@gmail.com']
+  spec.description   = %q{Cinch plugin that watches for new tweets from users.}
+  spec.summary       = %q{Cinch Plugin to follow twitter.}
+  spec.homepage      = 'https://github.com/bhaberer/cinch-twitterwatch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler',          '~> 1.3'
+  spec.add_development_dependency 'rake',             '~> 10.1'
+  spec.add_development_dependency 'rspec',            '~> 2.14'
+  spec.add_development_dependency 'coveralls',        '~> 0.7'
+  spec.add_development_dependency 'cinch-test',       '~> 0.0', '>= 0.0.4'
+
+  spec.add_dependency             'twitter',          '~> 5.7', '>= 5.7.1'
+  spec.add_dependency             'cinch',            '~> 2.0',   '>= 2.0.12'
+  spec.add_dependency             'cinch-toolbox',    '~> 1.1', '>= 1.1.2'
+end

data/lib/cinch/plugins/twitterwatch/cache.rb

@@ -0,0 +1,35 @@
+module Cinch::Plugins
+  class TwitterWatch
+    class Cache
+      attr_accessor :nick, :channel, :tweet_cache, :client
+
+      def initialize(nick, channel, client)
+        @nick = nick
+        @client = client
+        @channel = channel
+        @tweet_cache = {}
+      end
+
+      def init_cache
+        @client.user_timeline(@nick).each do |tweet|
+          cache_tweet(tweet.id)
+        end
+        "Cache: [#{@nick}]: #{@tweet_cache.count} tweets cached."
+      rescue Twitter::Error::NotFound
+        debug "You have set an invalid or protected user (#{@nick}) to " +
+              ' watch, please correct this error'
+      end
+
+      def tweet_unless_cached(tweet_id)
+        return if @tweet_cache.key?(tweet_id)
+        cache_tweet(tweet_id)
+        @client.status(tweet_id).text
+      end
+
+      def cache_tweet(tweet_id)
+        @tweet_cache[tweet_id.to_i] = true
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# -*- encoding: utf-8 -*-
+module Cinch
+  module Plugins
+    # Versioning info
+    class TwitterWatch
+      VERSION = '1.0.2'
+    end
+  end
+end

data/lib/cinch/plugins/twitterwatch.rb

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+require 'cinch'
+require 'cinch/toolbox'
+require 'twitter'
+
+module Cinch::Plugins
+  # Cinch Plugin to post twitter statuses
+  class TwitterWatch
+    include Cinch::Plugin
+
+    timer 15, method: :check_watched
+
+    def initialize(*args)
+      super
+      @client = twitter_client
+      @watched = build_watchers
+    end
+
+    def check_watched
+      return unless @watched
+      @watched.each { |w| check_for_tweet(w) }
+    rescue Twitter::Error::NotFound
+      debug 'You have set an invalid or protected user ' +
+            'to watch, please correct this error'
+    rescue Twitter::Error::TooManyRequests
+      debug 'Trottled checking user; sleeping 60 seconds.'
+      sleep 60
+    end
+
+    def check_for_tweet(w)
+      # Just check the last tweet, if they are posting more than once
+      # every timer tick we don't want to spam the channel.
+      debug "Checking Tweets for #{w.nick} (#{w.tweet_cache.count} cached)"
+      tweet = @client.user(w.nick).status
+      status = w.tweet_unless_cached(tweet.id)
+      Channel(w.channel).msg(tweet_text(w.nick, status)) unless status.nil?
+    end
+
+    def format_tweet(url)
+      # Parse the url and get the relevant data
+      user, status = parse_twitter_url(url)
+
+      # Return blank if we didn't get a good user and status
+      return if user.nil? || status.nil?
+
+      tweet(user, status)
+    end
+
+    def tweet_text(user, status)
+      # Scrub the tweet for returns so we don't have multilined responses.
+      status.gsub!(/[\n]+/, ' ') if status.match(/\n/)
+      "@#{user} tweeted \"#{status}\""
+    end
+
+    private
+
+    def parse_twitter_url(url)
+      tweet_id = url[%r(statuse?s?/(\d+)/?), 1]
+      user     = url[%r(/?#?!?/([^\/]+)/statuse?s?), 1]
+      [user, Twitter.status(tweet_id).text]
+    end
+
+    def build_watchers
+      watched = []
+      config[:watchers].each_pair do |chan, users|
+        users.each do |user|
+          watcher = Cache.new(user, chan, @client)
+          debug "#{watcher.init_cache}"
+          watched << watcher
+        end
+      end
+      watched
+    end
+
+    def twitter_client
+      Twitter::REST::Client.new do |c|
+        c.consumer_key =        config[:consumer_key]
+        c.consumer_secret =     config[:consumer_secret]
+        c.access_token =        config[:access_token]
+        c.access_token_secret = config[:access_secret]
+      end
+    end
+  end
+end

data/lib/cinch-twitterwatch.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+require 'cinch/plugins/twitterwatch/version'
+require 'cinch/plugins/twitterwatch'
+require 'cinch/plugins/twitterwatch/cache'

data/spec/cinch-twitterwatch_spec.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+require 'cinch'
+require 'spec_helper'
+describe Cinch::Plugins::TwitterWatch do
+  include Cinch::Test
+
+  before(:all) do
+    @bot = make_bot(Cinch::Plugins::TwitterWatch,
+                    { filename:        '/dev/null',
+                      watchers:        { '#foo' => ['weirdo513'] },
+                      consumer_key:    ENV['CONSUMER_KEY'],
+                      consumer_secret: ENV['CONSUMER_SECRET'],
+                      oauth_token:     ENV['OAUTH_TOKEN'],
+                      oauth_secret:    ENV['OAUTH_SECRET'] })
+  end
+
+  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
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+if File::exist? File.join(File.dirname(__FILE__), "secret.rb")
+  require 'secret'
+end
+
+require 'json'
+require 'cinch-twitterwatch'
+require 'cinch/test'

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: cinch-twitterwatch
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Brian Haberer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: cinch-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.7'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.7'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.7.1
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Cinch plugin that watches for new tweets from users.
+email:
+- bhaberer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cinch-twitterwatch.gemspec
+- lib/cinch-twitterwatch.rb
+- lib/cinch/plugins/twitterwatch.rb
+- lib/cinch/plugins/twitterwatch/cache.rb
+- lib/cinch/plugins/twitterwatch/version.rb
+- spec/cinch-twitterwatch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bhaberer/cinch-twitterwatch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Cinch Plugin to follow twitter.
+test_files:
+- spec/cinch-twitterwatch_spec.rb
+- spec/spec_helper.rb