cinch-links-logger 0.0.1

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cinch-links-logger.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,57 @@
+# Cinch::Plugins::LinksLogger
+
+Cinch Plugin for logging links and printing titles / stats for linked urls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cinch-links-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cinch-links-logger
+
+## 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,
+                                                           :titles    => true,
+                                                           :filename  => 'yaml/links.yml',
+                                                           :whitelist => nil,
+                                                           :blacklist => nil }
+      end
+    end
+
+The configuration variables are all optional, what's listed are their defaults
+
+:titles (boolean) - Setting this to true will print the URL's title to the channel.
+
+: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 @@
+require "bundler/gem_tasks"

data/cinch-links-logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cinch/plugins/links-logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cinch-links-logger"
+  gem.version       = Cinch::Plugins::LinksLogger::VERSION
+  gem.authors       = ["Brian Haberer"]
+  gem.email         = ["bhaberer@gmail.com"]
+  gem.description   = %q{Cinch Plugin to track links in the channel}
+  gem.summary       = %q{Cinch Plugin for links logging}
+  gem.homepage      = "https://github.com/bhaberer/cinch-links-logger"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('cinch-storage', '>= 0.0.1')
+  gem.add_dependency('cinch-toolbox', '>= 0.0.5')
+  gem.add_dependency('time-lord',     '>= 1.0.1')
+end

data/lib/cinch-links-logger.rb

@@ -0,0 +1,2 @@
+require 'cinch/plugins/links-logger/version'
+require 'cinch/plugins/links-logger/links-logger'

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

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+require 'open-uri'
+require 'cinch-storage'
+require 'cinch-toolbox'
+require 'time-lord'
+
+module Cinch::Plugins
+  class LinksLogger
+    include Cinch::Plugin
+
+    listen_to :channel
+
+    self.help = 'Use .links to see the last links users have posted to the channel.'
+
+    match /links/
+
+    def initialize(*args)
+      super
+      @storage = CinchStorage.new(config[:filename] || 'yaml/links.yaml')
+      @storage.data[:history] ||= Hash.new
+      @post_titles = config[:titles].nil? ? true : config[:titles]
+      @post_stats  = config[:stats].nil?  ? true : config[:stats]
+    end
+
+    def execute(m)
+      if m.channel.nil?
+        m.user.msg "You must use that command in the main channel."
+        return
+      end
+
+      m.user.send "Recent Links in #{m.channel}"
+      last = @storage.data[:history][m.channel.name].values.sort {|a,b| b[:time] <=> a[:time] }
+      last[0,10].each_with_index do |link, i|
+        msg = "#{i + 1} - "
+        if link[:title].nil?
+          msg << Cinch::Toolbox.expand(@link[:short_url])
+        else
+          msg << "#{link[:short_url]} ∴ #{link[:title]}"
+        end
+        m.user.send msg
+      end
+    end
+
+    def listen(m)
+      urls = URI.extract(m.message, ["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
+
+        # Make sure it conforms to white/black lists before bothering.
+        if whitelisted?(url) && !blacklisted?(url)
+          # If the link was posted already, get the old info instead of getting new
+          if @storage.data[:history][m.channel.name].key?(url)
+            @storage.data[:history][m.channel.name][url][:count] += 1
+            @link = @storage.data[:history][m.channel.name][url]
+          else
+            @link = { :nick      => m.user.nick,
+                      :title     => Cinch::Toolbox.get_page_title(url) || nil,
+                      :count     => 1,
+                      :short_url => Cinch::Toolbox.shorten(url),
+                      :time      => Time.now }
+            @storage.data[:history][m.channel.name][url] = @link
+          end
+        else
+          debug "#{blacklisted?(url) ? 'Blacklisted URL was not logged' : 'Domain not Whitelisted'} #{url}"
+          return
+        end
+
+        # Check to see if we should post titles
+        if @post_titles
+          # Only spam the channel if you have a title
+          unless @link[:title].nil?
+            m.reply "#{@link[:short_url] || url} ∴  #{@link[:title]}"
+          end
+        end
+
+        # Check to see if we should post stats and if it'ss been linked more than once.
+        if @post_stats && @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
+
+      # Don't save unless we found some urls to process
+      if urls
+        synchronize(:save_links) do
+          @storage.save
+        end
+      end
+    end
+
+    private
+
+    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-logger/version.rb

@@ -0,0 +1,7 @@
+module Cinch
+  module Plugins
+    class LinksLogger
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: cinch-links-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Haberer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch-storage
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !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 track links in the channel
+email:
+- bhaberer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cinch-links-logger.gemspec
+- lib/cinch-links-logger.rb
+- lib/cinch/plugins/links-logger/links-logger.rb
+- lib/cinch/plugins/links-logger/version.rb
+homepage: https://github.com/bhaberer/cinch-links-logger
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Cinch Plugin for links logging
+test_files: []