cinch-wikipedia 0.0.1 → 1.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+nguage: ruby
+rvm:
+  - ruby-head
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -1,5 +1,11 @@
 # Cinch::Plugins::Wikipedia
 
+[![Gem Version](https://badge.fury.io/rb/cinch-wikipedia.png)](http://badge.fury.io/rb/cinch-wikipedia)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-wikipedia.png)](https://gemnasium.com/bhaberer/cinch-wikipedia)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-wikipedia.png?branch=master)](https://travis-ci.org/bhaberer/cinch-wikipedia)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-wikipedia/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-wikipedia?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-wikipedia.png)](https://codeclimate.com/github/bhaberer/cinch-wikipedia)
+
 Cinch plugin to query wikipedia.
 
 ## Installation
@@ -18,9 +24,13 @@ Or install it yourself as:
 
 ## Usage
 
-Just add th plugin to your list:
+Just add the plugin to your list:
 
-    c.plugins.plugins = [Cinch::Plugins::Wikipedia]
+    @bot = Cinch::Bot.new do
+      configure do |c|
+        c.plugins.plugins = [Cinch::Plugins::Wikipedia]
+      end
+    end
 
 Then in channel use .wiki:
 
@@ -33,3 +43,9 @@ Then in channel use .wiki:
 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
+
+## Changelog
+
+* v1.0.0
+    * Added checks for terms that are not found and disambig pages.
+    * Tests!

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

@@ -17,6 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'cinch-toolbox'
-  gem.add_dependency 'cinch-cooldown'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
+
+  gem.add_dependency 'cinch',           '~> 2.0.4'
+  gem.add_dependency 'cinch-toolbox',   '~> 1.0.0'
+  gem.add_dependency 'cinch-cooldown',  '~> 1.0.0'
 end

data/lib/cinch-wikipedia.rb

@@ -1,2 +1,2 @@
-require "cinch/plugins/wikipedia/version.rb"
-require "cinch/plugins/wikipedia/wikipedia.rb"
+require "cinch/plugins/wikipedia/version"
+require "cinch/plugins/wikipedia/wikipedia"

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

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

data/lib/cinch/plugins/wikipedia/wikipedia.rb

@@ -14,6 +14,11 @@ module Cinch::Plugins
     match /wiki (.*)/
     match /wikipedia (.*)/
 
+    def initialize(*args)
+      super
+      @max_length = config[:max_length] || 300
+    end
+
     def execute(m, term)
       m.reply get_def(term)
     end
@@ -25,13 +30,33 @@ module Cinch::Plugins
       term = URI.escape(term, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
       url = "http://en.wikipedia.org/w/index.php?search=#{term}"
 
-      # Grab the text
-      text = Cinch::Toolbox.get_html_element(url, '#mw-content-text p')
+      cats = Cinch::Toolbox.get_html_element(url, '#mw-normal-catlinks')
+      if cats && cats.include?('Disambiguation')
+        wiki_text = "'#{term} is too vague and lead to a disambiguation page."
+      else
+        # Grab the text
+        wiki_text = Cinch::Toolbox.get_html_element(url, '#mw-content-text p')
+
+        # Check for search errors
+        return not_found(wiki_text, url) if wiki_text.include?('Help:Searching')
+      end
 
-      # Truncate if it's super long
-      text = Cinch::Toolbox.truncate(text, 300)
+      # Truncate text and url if they are too long
+      text = Cinch::Toolbox.truncate(wiki_text, @max_length)
+      url  = Cinch::Toolbox.shorten(url)
+
+      return "Wikipedia ∴ #{text} [#{url}]"
+    end
 
-      return "Wikipedia ∴ #{text} [#{Cinch::Toolbox.shorten(url)}]"
+    def not_found(wiki_text, url)
+      msg = "I couldn't find anything for that search"
+      if alt_term_text = Cinch::Toolbox.get_html_element(url, '.searchdidyoumean')
+        alt_term = alt_term_text[/\ADid you mean: (\w+)\z/, 1]
+        msg << ", did you mean '#{alt_term}'?"
+      else
+        msg << ", sorry!"
+      end
+      return msg
     end
   end
 end

data/spec/cinch-wikipedia_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Cinch::Plugins::Wikipedia do
+
+  before(:all) do
+    @plugin = Cinch::Plugins::Wikipedia.new
+  end
+
+  # normal queries
+  it 'should return a definition of a term' do
+    @plugin.send(:get_def, 'computer').
+      should include("A computer is a general purpose device")
+  end
+
+  it 'should not return multiple lined definitions' do
+    @plugin.send(:get_def, 'Teenager').
+      should_not include("\n")
+  end
+
+  it 'should not return definitions that are longer than 250 chars' do
+    @plugin.send(:get_def, 'Teenager').length.
+      should == 334
+  end
+
+  # Not found
+  it 'should return an error message when a term is not found' do
+    @plugin.send(:get_def, 'dasdafasfasfasfasafsdfsdfsadf').
+      should include("I couldn't find anything for that search, sorry!")
+  end
+
+  it 'should provide suggestions if one is listed on the page' do
+    @plugin.send(:get_def, 'smegama').
+      should include("I couldn't find anything for that search, did you mean 'smegma'?")
+  end
+
+  # disambiguation
+  it 'should return helful information when a disambuation page' do
+    @plugin.send(:get_def, 'hipster').
+      should include('is too vague and lead to a disambiguation page')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'coveralls'
+Coveralls.wear!
+require 'cinch-wikipedia'
+
+def fake_bot
+  bot = Cinch::Bot.new
+  bot.loggers.level = :fatal
+  bot
+  return bot
+end
+
+module Cinch
+  module Plugin
+    def initialize(opts = {})
+      @bot = fake_bot
+      @handlers = []
+      @timers   = []
+      # Don't init the bot
+      # __register
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-wikipedia
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,17 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cinch-toolbox
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,14 +28,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cinch-cooldown
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -43,6 +43,70 @@ dependencies:
     - - ! '>='
       - !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
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  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-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
 description: Cinch plugin that fetches a truncated blurb from the head of a wikipedia
   page.
 email:
@@ -52,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -60,6 +125,8 @@ files:
 - lib/cinch-wikipedia.rb
 - lib/cinch/plugins/wikipedia/version.rb
 - lib/cinch/plugins/wikipedia/wikipedia.rb
+- spec/cinch-wikipedia_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-wikipedia
 licenses: []
 post_install_message: 
@@ -84,4 +151,7 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Cinch Wikipedia Plugin
-test_files: []
+test_files:
+- spec/cinch-wikipedia_spec.rb
+- spec/spec_helper.rb
+has_rdoc: