cinch-links-logger 0.0.1 → 1.0.0

data/.travis.yml

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

data/README.md

@@ -1,5 +1,11 @@
 # Cinch::Plugins::LinksLogger
 
+[![Gem Version](https://badge.fury.io/rb/cinch-links-logger.png)](http://badge.fury.io/rb/cinch-links-logger)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-links-logger.png)](https://gemnasium.com/bhaberer/cinch-links-logger)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-links-logger.png?branch=master)](https://travis-ci.org/bhaberer/cinch-links-logger)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-links-logger/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-links-logger?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-links-logger.png)](https://codeclimate.com/github/bhaberer/cinch-links-logger)
+
 Cinch Plugin for logging links and printing titles / stats for linked urls.
 
 ## Installation

data/Rakefile

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

data/cinch-links-logger.gemspec

@@ -17,7 +17,14 @@ Gem::Specification.new do |gem|
   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')
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'cinch-test'
+
+  gem.add_dependency 'cinch',           '~> 2.0.5'
+  gem.add_dependency 'cinch-cooldown',  '~> 1.0.0'
+  gem.add_dependency 'cinch-storage',   '~> 1.0.1'
+  gem.add_dependency 'cinch-toolbox',   '~> 1.0.3'
+  gem.add_dependency 'time-lord',       '~> 1.0.1'
 end

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

@@ -1,12 +1,20 @@
 # -*- coding: utf-8 -*-
 require 'open-uri'
+require 'cinch'
+require 'cinch/toolbox'
 require 'cinch-storage'
-require 'cinch-toolbox'
 require 'time-lord'
 
+class Link < Struct.new(:nick, :title, :count, :short_url, :time)
+  def to_yaml
+    {nick: nick, title: title, count: count, short_url: short_url, time: time }
+  end
+end
+
 module Cinch::Plugins
   class LinksLogger
     include Cinch::Plugin
+    attr_reader :storage
 
     listen_to :channel
 
@@ -17,94 +25,55 @@ module Cinch::Plugins
     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]
+      @storage.data ||= Hash.new
     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
+      return if Cinch::Toolbox.sent_via_private_message?(m)
+      get_recent_links(m.channel.name).each { |line| m.user.send line }
     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
+        @storage.data[m.channel.name] ||= Hash.new
+        @link = get_or_create_link(m, url)
       end
+      # Save if we matched urls.
+      @storage.synced_save(@bot) if urls
     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
+    def get_or_create_link(m, url)
+      channel = m.channel.name
+      # If the link was posted already, get the old info instead of getting new
+      if @storage.data[channel].key?(url)
+        @storage.data[channel][url][:count] += 1
+        link = @storage.data[channel][url]
+      else
+        link = Link.new(m.user.nick,
+                        Cinch::Toolbox.get_page_title(url),
+                        1, Cinch::Toolbox.shorten(url), Time.now)
+        @storage.data[channel][url] = link
+      end
+      return link
     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
+    def get_recent_links(channel)
+      message = ["Recent Links in #{channel}"]
+      links = @storage.data[channel].values.reverse[0..9]
+      puts links.to_s
+      puts message
+      links.each_with_index do |link|
+        message << if link.title.nil?
+                     Cinch::Toolbox.expand(link.short_url)
+                   else
+                     "#{link.short_url} - #{link.title}"
+                   end
+      end
+      return message
     end
   end
 end

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

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

data/spec/cinch-links-logger_spec.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Cinch::Plugins::LinksLogger do
+  include Cinch::Test
+
+  before(:each) do
+    @bot = make_bot(Cinch::Plugins::LinksLogger, { :filename => '/dev/null' })
+  end
+
+  it 'should capture links' do
+    get_replies(make_message(@bot, 'http://github.com', { channel: '#foo', nick: 'bar' }))
+    @bot.plugins.first.storage.data['#foo'].keys.first.
+      should == 'http://github.com'
+  end
+
+  it 'should not capture malformed URLS' do
+    get_replies(make_message(@bot, 'htp://github.com', { channel: '#foo', nick: 'bar' }))
+    get_replies(make_message(@bot, 'http/github.com', { channel: '#foo', nick: 'bar' }))
+    @bot.plugins.first.storage.data['#foo'].
+      should be_nil
+  end
+
+  it 'should allow users to get a list of recently linked URLS' do
+    get_replies(make_message(@bot, 'http://github.com', { channel: '#foo', nick: 'bar' }))
+    replies = get_replies(make_message(@bot, '!links', { channel: '#foo', nick: 'test' }))
+    replies.first.text.should == 'Recent Links in #foo'
+    replies.last.text.should == 'http://github.com - GitHub · Build software better, together.'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+require 'cinch-links-logger'
+require 'cinch/test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-links-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,46 +9,110 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cinch-storage
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: cinch-toolbox
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: time-lord
+  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
@@ -56,7 +120,39 @@ dependencies:
   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 track links in the channel
@@ -67,6 +163,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -75,6 +172,8 @@ files:
 - lib/cinch-links-logger.rb
 - lib/cinch/plugins/links-logger/links-logger.rb
 - lib/cinch/plugins/links-logger/version.rb
+- spec/cinch-links-logger_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-links-logger
 licenses: []
 post_install_message: 
@@ -95,8 +194,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Cinch Plugin for links logging
-test_files: []
+test_files:
+- spec/cinch-links-logger_spec.rb
+- spec/spec_helper.rb