cinch-links-titles 1.0.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 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,60 @@
+# Cinch::Plugins::LinksTitles
+
+[![Gem Version](https://badge.fury.io/rb/cinch-links-titles.png)](http://badge.fury.io/rb/cinch-links-titles)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-links-titles.png)](https://gemnasium.com/bhaberer/cinch-links-titles)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-links-titles.png?branch=master)](https://travis-ci.org/bhaberer/cinch-links-titles)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-links-titles/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-links-titles?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-links-titles.png)](https://codeclimate.com/github/bhaberer/cinch-links-titles)
+
+Cinch Plugin for logging links and printing titles / stats for linked urls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cinch-links-titles'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cinch-links-titles
+
+## Usage
+
+You will need to add the Plugin and config to your list first;
+
+    @bot = Cinch::Bot.new do
+      configure do |c|
+        c.plugins.plugins = [Cinch::Plugins::LinksLogger]
+        c.plugins.options[Cinch::Plugins::LinksTumblr] = { :stats     => true,
+                                                           :filename  => 'yaml/links.yml',
+                                                           :whitelist => nil,
+                                                           :blacklist => nil }
+      end
+    end
+
+The configuration variables are all optional, what's listed are their defaults
+
+:stats (boolean) - Setting this to true will print the name of the user who first linked
+                   the URL, if applicable.
+
+:blacklist - An array of domains that you want to ignore, e.g.
+
+    :blackist => ['twitter', 'reddit']
+
+:whitelist - An array of domains that you want limit title printing and logging to, e.g.
+
+    :whitelist => ['youtube']
+
+:filename - the file to store previously linked urls.
+
+## 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-links-titles.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cinch/plugins/links-titles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cinch-links-titles"
+  spec.version       = Cinch::Plugins::LinksTitles::VERSION
+  spec.authors       = ['Brian Haberer']
+  spec.email         = ['bhaberer@gmail.com']
+  spec.description   = %q{Cinch Plugin to print link titles to the channel}
+  spec.summary       = %q{Link Titles}
+  spec.homepage      = 'https://github.com/bhaberer/cinch-links-titles'
+  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 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'cinch-test'
+
+  spec.add_dependency 'cinch',           '~> 2.0.5'
+  spec.add_dependency 'cinch-cooldown',  '~> 1.0.0'
+  spec.add_dependency 'cinch-storage',   '~> 1.0.1'
+  spec.add_dependency 'cinch-toolbox',   '~> 1.0.3'
+  spec.add_dependency 'time-lord',       '~> 1.0.1'
+end

data/lib/cinch-links-titles.rb

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+require 'cinch/plugins/links-titles/version'
+require 'cinch/plugins/links-titles'

data/lib/cinch/plugins/links-titles.rb

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+require 'open-uri'
+require 'cinch'
+require 'cinch/toolbox'
+require 'cinch-storage'
+require 'time-lord'
+
+module Cinch::Plugins
+  # Plugin to print URL titles in the channel.
+  class LinksTitles
+    include Cinch::Plugin
+    attr_accessor :storage
+
+    # Simple struct object for tracking Links.
+    class Link < Struct.new(:nick, :title, :count, :short_url, :url, :time)
+      def to_yaml
+        { nick: nick, title: title, count: count, short_url:  short_url,
+          url: url, time: time }
+      end
+    end
+
+    listen_to :channel
+
+    def initialize(*args)
+      super
+      @storage = CinchStorage.new(config[:filename] ||
+                                  'yaml/links-titles.yaml')
+      @storage.data[:history] ||= {}
+      @post_stats  = config[:stats].nil?  ? false : config[:stats]
+    end
+
+    def listen(m)
+      urls = URI.extract(m.message, %w(http https))
+      urls.each do |url|
+        # Ensure we have a Channel Object in the History to dump links into.
+        @storage.data[:history][m.channel.name] ||= Hash.new
+
+        # Process link
+        link = process_link(url, m.channel.name, m.user.nick)
+
+        # Send link title to channel
+        post_title(m, link)
+
+        # Send link stats to channel
+        post_stats(m, link)
+      end
+
+      # Don't save unless we found some urls to process
+      @storage.synced_save(@bot) if urls
+    end
+
+    private
+
+    def process_link(url, channel, nick)
+      # Make sure it conforms to white/black lists before bothering.
+      if whitelisted?(url) && !blacklisted?(url)
+        return get_or_query_link(url, channel, nick)
+      else
+        if blacklisted?(url)
+          debug "Blacklisted URL was not logged #{url}"
+        else
+          debug "Domain not Whitelisted #{url}"
+        end
+        return nil
+      end
+    end
+
+    def get_or_query_link(url, channel, nick)
+      # If the link was posted already, get the old info
+      if @storage.data[:history][channel].key?(url)
+        @storage.data[:history][channel][url][:count] += 1
+        link = @storage.data[:history][channel][url]
+      else
+        link = Link.new(nick, Cinch::Toolbox.get_page_title(url) || nil,
+                        1, Cinch::Toolbox.shorten(url), url, Time.now)
+        @storage.data[:history][channel][url] = link
+      end
+      link
+    end
+
+    def post_title(m, link)
+      # Only spam the channel if you have a title
+      unless link.nil? || link.title.nil?
+        m.reply "#{link.short_url || link.url} ∴  #{link.title}"
+      end
+    end
+
+    def post_stats(m, link)
+      # Check to see if we should post stats and if it's been linked
+      # more than once.
+      if config[:stats]
+        if link.count > 1
+          # No stats if this person was the first one to link it
+          unless link.nick == m.user.nick
+            m.reply "That was already linked by #{link.nick} " +
+                    "#{link.time.ago.to_words}.", true
+          end
+        end
+      end
+    end
+
+    def whitelisted?(url)
+      return true unless config[:whitelist]
+      debug "Checking Whitelist! #{config[:whitelist]} url: #{url}"
+      return true if url.match(
+        Regexp.new("https?:\/\/.*\.?#{config[:whitelist].join('|')}\."))
+      false
+    end
+
+    def blacklisted?(url)
+      return false unless config[:blacklist]
+      debug "Checking Blacklist! #{config[:blacklist]} url: #{url}"
+      return true if url.match(
+        Regexp.new("https?:\/\/.*\.?#{config[:blacklist].join('|')}\."))
+      false
+    end
+  end
+end

data/lib/cinch/plugins/links-titles/version.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+module Cinch
+  module Plugins
+    # Versioning info
+    class LinksTitles
+      VERSION = '1.0.0'
+    end
+  end
+end

data/spec/cinch-links-titles_spec.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Cinch::Plugins::LinksTitles do
+  include Cinch::Test
+
+  before(:each) do
+    @bot = make_bot(Cinch::Plugins::LinksTitles, { filename: '/dev/null' })
+  end
+
+  it 'should print titles' do
+    get_replies(make_message(@bot, 'http://github.com',
+                             { channel: '#foo', nick: 'bar' })).first.text
+      .should include('GitHub · Build software better, together.')
+  end
+
+  it 'should obey blacklist and not title blacklisted links' do
+    bot = make_bot(Cinch::Plugins::LinksTitles,
+                   { filename: '/dev/null',
+                     blacklist: ['twitter'] })
+    get_replies(make_message(bot, 'http://twitter.com',
+                             { channel: '#foo', nick: 'bar' })).first
+      .should be_nil
+  end
+
+  it 'should obey blacklist and title unblacklisted links' do
+    bot = make_bot(Cinch::Plugins::LinksTitles,
+                   { filename: '/dev/null',
+                     blacklist: ['twitter'] })
+    get_replies(make_message(bot, 'http://facebook.com',
+                             { channel: '#foo', nick: 'bar' })).first
+      .should_not be_nil
+  end
+
+  it 'should obey whitelist and title whitelisted links' do
+    bot = make_bot(Cinch::Plugins::LinksTitles,
+                   { filename: '/dev/null',
+                     whitelist: ['twitter'] })
+    get_replies(make_message(bot, 'http://twitter.com',
+                             { channel: '#foo', nick: 'bar' })).first
+      .should_not be_nil
+  end
+
+  it 'should obey whitelist and not title unwhitelisted links' do
+    bot = make_bot(Cinch::Plugins::LinksTitles,
+                   { filename: '/dev/null',
+                     whitelist: ['twitter'] })
+    get_replies(make_message(bot, 'http://facebook.com',
+                             { channel: '#foo', nick: 'bar' })).first
+      .should be_nil
+  end
+
+  it 'should not display stats if they are not enabled' do
+    get_replies(make_message(@bot, 'http://facebook.com',
+                             { channel: '#foo', nick: 'bar1' }))
+    get_replies(make_message(@bot, 'http://facebook.com',
+                             { channel: '#foo', nick: 'bar2' })).last
+      .should_not include('That was already linked by')
+  end
+
+  it 'should display stats if they are enabled' do
+    bot = make_bot(Cinch::Plugins::LinksTitles,
+                   { filename: '/dev/null', stats: true })
+    get_replies(make_message(bot, 'http://facebook.com',
+                             { channel: '#foo', nick: 'bar1' }))
+    get_replies(make_message(bot, 'http://facebook.com',
+                             { channel: '#foo', nick: 'bar2' })).last.text
+      .should include('That was already linked by')
+  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-links-titles'
+require 'cinch/test'

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: cinch-links-titles
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Haberer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cinch-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: cinch-cooldown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: cinch-storage
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: time-lord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: Cinch Plugin to print link titles to the channel
+email:
+- bhaberer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cinch-links-titles.gemspec
+- lib/cinch-links-titles.rb
+- lib/cinch/plugins/links-titles.rb
+- lib/cinch/plugins/links-titles/version.rb
+- spec/cinch-links-titles_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bhaberer/cinch-links-titles
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Link Titles
+test_files:
+- spec/cinch-links-titles_spec.rb
+- spec/spec_helper.rb
+has_rdoc: