cinch-links-logger 1.0.0 → 1.0.1

data/README.md

@@ -29,30 +29,13 @@ 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 }
+        # If you need to specify an alternate path
+        c.plugins.options[Cinch::Plugins::LinksTumblr] = { :filename  => 'yaml/links.yml' }
       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.
+Links in the channel will be captured and users who type `!links` in channel will receive a
+list of the last 10 links (this will be configurable in the future).
 
 ## Contributing
 

data/cinch-links-logger.gemspec

@@ -4,18 +4,19 @@ $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.name          = 'cinch-links-logger'
   gem.version       = Cinch::Plugins::LinksLogger::VERSION
-  gem.authors       = ["Brian Haberer"]
-  gem.email         = ["bhaberer@gmail.com"]
+  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.homepage      = 'https://github.com/bhaberer/cinch-links-logger'
+  gem.license       = 'MIT'
 
   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.require_paths = ['lib']
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

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

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+# Class to track Link data
+class Link
+  attr_accessor :nick, :title, :count, :short_url, :time
+
+  def initialize(nick, url, time = Time.now)
+    @nick = nick
+    @title = Cinch::Toolbox.get_page_title(url)
+    @count = 0
+    @short_url = Cinch::Toolbox.shorten(url)
+    @time = time
+  end
+
+  def inc_count(count = 1)
+    @count += count
+  end
+end

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

@@ -1,7 +1,9 @@
+# -*- encoding: utf-8 -*-
 module Cinch
   module Plugins
+    # Versioning info
     class LinksLogger
-      VERSION = "1.0.0"
+      VERSION = '1.0.1'
     end
   end
 end

data/lib/cinch/plugins/{links-logger/links-logger.rb → links-logger.rb}

@@ -3,29 +3,23 @@ require 'open-uri'
 require 'cinch'
 require 'cinch/toolbox'
 require 'cinch-storage'
-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
+  # Cinch Plugin to track links
   class LinksLogger
     include Cinch::Plugin
     attr_reader :storage
 
     listen_to :channel
 
-    self.help = 'Use .links to see the last links users have posted to the channel.'
+    self.help = 'Use .links to see the last links posted to the channel.'
 
     match /links/
 
     def initialize(*args)
       super
       @storage = CinchStorage.new(config[:filename] || 'yaml/links.yaml')
-      @storage.data ||= Hash.new
+      @storage.data ||= {}
     end
 
     def execute(m)
@@ -34,14 +28,12 @@ module Cinch::Plugins
     end
 
     def listen(m)
-      urls = URI.extract(m.message, ["http", "https"])
+      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[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
@@ -49,23 +41,15 @@ module Cinch::Plugins
     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
+      @storage.data[channel][url] ||= Link.new(m.user.nick, url)
+      @storage.data[channel][url].inc_count
+      @storage.synced_save(@bot)
+      @storage.data[channel][url]
     end
 
     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)
@@ -73,7 +57,7 @@ module Cinch::Plugins
                      "#{link.short_url} - #{link.title}"
                    end
       end
-      return message
+      message
     end
   end
 end

data/lib/cinch-links-logger.rb

@@ -1,2 +1,4 @@
+# -*- encoding: utf-8 -*-
 require 'cinch/plugins/links-logger/version'
-require 'cinch/plugins/links-logger/links-logger'
+require 'cinch/plugins/links-logger/link'
+require 'cinch/plugins/links-logger'

data/spec/cinch-links-logger_spec.rb

@@ -14,6 +14,14 @@ describe Cinch::Plugins::LinksLogger do
       should == 'http://github.com'
   end
 
+  it 'should capture links count' do
+    15.times { get_replies(make_message(@bot, 'http://github.com', { channel: '#foo' })) }
+    links = @bot.plugins.first.storage.data['#foo']
+    puts "\n\n#{links}\n\n"
+    links.length.should == 1
+    links.values.first.count.should == 15
+  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' }))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-links-logger
 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-07-09 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -170,12 +170,14 @@ files:
 - Rakefile
 - cinch-links-logger.gemspec
 - lib/cinch-links-logger.rb
-- lib/cinch/plugins/links-logger/links-logger.rb
+- lib/cinch/plugins/links-logger.rb
+- lib/cinch/plugins/links-logger/link.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: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -201,3 +203,4 @@ summary: Cinch Plugin for links logging
 test_files:
 - spec/cinch-links-logger_spec.rb
 - spec/spec_helper.rb
+has_rdoc: