cinch-logsearch 0.0.1 → 1.0.0

data/.travis.yml

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

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-logsearch.gemspec

@@ -16,4 +16,11 @@ Gem::Specification.new do |gem|
   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_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.0'
 end

data/lib/cinch/plugins/logsearch/logsearch.rb

@@ -1,44 +1,57 @@
+require 'cinch'
+
 module Cinch::Plugins
   class LogSearch
     include Cinch::Plugin
 
     self.help = "Use .search <text> to search the logs. *Only works via private message*, limited to 5 results for now."
 
-    match /search (.*)/
-
-    def execute(m, search)
-      # Don't listen to searches in channels. Reduce SPAM.
-      return if m.channel?
+    match /search (.*)/, react_on: :private
 
-      # However, make sure the user is in a channel with the bot
-      chans = @bot.channels
-      chans.delete_if { |chan| !chan.has_user?(m.user) }
-      return if chans.empty?
-
-      @max_results = config[:max_results] || 5
-      @matches = []
+    def initialize(*args)
+      super
+      @max_results   = config[:max_results] || 5
+      @log_directory = config[:logs_directory] || File.join('.', 'logs', '*.log')
+    end
 
-      # Search the logs for the phrase, this is pretty simple.
-      Dir[config[:log_path] || File.join('.', 'logs', '*.log')].sort.reverse.each do |file|
-        @matches += File.open(file, 'r').grep(Regexp.new(search))
-        # For the sake of sanity, stop looking once we find @max_results
-        break if @matches.length > @max_results
-      end
+    def execute(m, search)
+      return unless log_files_exist?
 
-      # I hate new lines.
-      @matches.map! { |msg| msg.chomp }
+      matches = search_for(search)
 
-      if @matches.empty?
+      if matches.empty?
         m.user.msg "No matches found!"
       else
-        msg = "Found #{@matches.count} matches"
-        msg << "before giving up" if @matches.length > @max_results
-        msg << ". Here's the last #{@max_results}:"
-        m.user.msg msg
-        @matches[-@max_results..-1].each do |match|
+        msg = ['Found', matches.count, 'matches before giving up,',
+               'here\'s the most recent', @max_results]
+        m.user.msg msg.join(' ')
+        matches.reverse[0..(@max_results - 1)].reverse.each do |match|
           m.user.msg match
         end
       end
     end
+
+    private
+
+    def log_files_exist?
+      return true if File.exist?(@log_directory)
+      debug 'Log files not found!'
+      false
+    end
+
+    def search_for(search_term)
+      matches = []
+
+      # Search the logs for the phrase, this is pretty simple and kind of dumb.
+      # Probably make this smarter by using a real search algo at some point if people care.
+      Dir[@log_directory].sort.reverse.each do |file|
+        matches += File.open(file, 'r').grep(Regexp.new(search_term))
+        # For the sake of sanity, stop looking once we find @max_results
+        break if matches.length > @max_results
+      end
+
+      # I hate new lines.
+      matches.map(&:chomp)
+    end
   end
 end

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

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

data/spec/cinch-logsearch_spec.rb

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+LOG = File.join('/tmp', 'cinch-testing.log') 
+
+describe Cinch::Plugins::LogSearch do
+  include Cinch::Test
+
+  before(:all) do
+    @bot = make_bot(Cinch::Plugins::LogSearch, { logs_directory: LOG })
+    build_logs
+  end
+
+  it 'should not find anything if no logs are present' do
+    get_replies(make_message(@bot, '!search foo'), :private).
+      first.text.should == "No matches found!"
+  end
+
+  it 'should not return any response when users search in channel' do
+    get_replies(make_message(@bot, '!search foo'), :channel).
+      should be_empty
+  end
+
+  it 'should let users search log files' do
+    get_replies(make_message(@bot, '!search movie'), :private).
+      first.text.should == "Found 1 matches before giving up, here's the most recent 5"
+  end
+
+  it 'should allow users to do complex searches' do 
+    get_replies(make_message(@bot, '!search \sw.+\s'), :private).
+      first.text.should == "Found 3 matches before giving up, here's the most recent 5"
+  end
+end
+
+def build_logs 
+  log = <<"  EOF" 
+  [2012-07-24 23:09:15] <Carnivor> Oh. Good. You timed out.
+  [2012-07-24 23:09:20] <feen> no
+  [2012-07-24 23:09:22] <feen> i got back home
+  [2012-07-24 23:09:31] <Carnivor> Oh. So you got that.
+  [2012-07-24 23:09:37] <Carnivor> Yay not having to resend.
+  [2012-07-24 23:10:05] <silveridea> oh god, i cant know this
+  [2012-07-24 23:10:12] <feen> sorry
+  [2012-07-24 23:10:12] <feen> ill stop
+  [2012-07-24 23:10:16] <silveridea> heh
+  [2012-07-24 23:10:20] <silveridea> i just wanted to quote mal
+  [2012-07-24 23:10:24] <feen> hahahahaha
+  [2012-07-24 23:10:30] <feen> i need to watch a good movie
+  [2012-07-24 23:10:35] <feen> OH SHIT I STILL HAVENT WATCHED TINKER TAILOR
+  [2012-07-24 23:10:37] <silveridea> heat
+  [2012-07-24 23:10:44] <silveridea> actually tinker tailor is pretty good
+  [2012-07-24 23:10:49] <silveridea> be prepared to pay attention
+  [2012-07-24 23:10:49] <feen> i've seen heat like
+  [2012-07-24 23:10:51] <feen> ten thousand times
+  [2012-07-24 23:11:27] <silveridea> well im going to attempt sleep
+  EOF
+  File.open(LOG, 'w') do |file| 
+    file.write(log)
+  end
+end

data/spec/secret.rb

@@ -0,0 +1,4 @@
+ENV['CONSUMER_KEY']    = 'JX9aDzSNnzK2eZnUBVe5OQ'
+ENV['CONSUMER_SECRET'] = 'H6J1yHlWbScTE0qCPnOQcatFFypHSYYy6oC6B5ogflU'
+ENV['OAUTH_TOKEN']     = '1028981-26j3aDmrJKWUmfNjUHiF5tfaC64go551zk9fVHxtuk'
+ENV['OAUTH_SECRET']    = 'fBooPZxuJHBLulw5IXAudIn61NFAD5sgCYxfOKnfI'

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'json'
+require 'cinch-logsearch'
+require 'cinch/test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-logsearch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
-dependencies: []
+date: 2013-08-21 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: Cinch Plugin to search log files for users.
 email:
 - bhaberer@gmail.com
@@ -19,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -27,6 +108,9 @@ files:
 - lib/cinch-logsearch.rb
 - lib/cinch/plugins/logsearch/logsearch.rb
 - lib/cinch/plugins/logsearch/version.rb
+- spec/cinch-logsearch_spec.rb
+- spec/secret.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-logsearch
 licenses: []
 post_install_message: 
@@ -47,8 +131,12 @@ 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 searching irc logs.
-test_files: []
+test_files:
+- spec/cinch-logsearch_spec.rb
+- spec/secret.rb
+- spec/spec_helper.rb
+has_rdoc: