cinch-wikipedia 1.0.0 → 1.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c58c81c016cd674a1de487b0d0bf24cfa42bd53753291cf77b718546b6f0ccf4
+  data.tar.gz: e76b020a6db12d71f426cfe67a76d92c5d68a4de9187119a3cc51a0b768fa8cf
+SHA512:
+  metadata.gz: 7e14c045f1ab624d50d1e13530186e241b8e66ad1f4f28f7a96c3134b8dcfef1ed4b26e61954294b495b8e524549eeb6aa2561edc29b0ffa83a2f1ebf98b0a31
+  data.tar.gz: 34ab062343ce99a2ae77ba1ee6344deb78b092bd4ed27f32896be4300e309e14c8d09425442f86f04c54594f458fe21799aae8a0a7e07485f3151741f408ce97

data/.travis.yml

@@ -1,5 +1,34 @@
-nguage: ruby
+addons:
+  code_climate:
+    repo_token: 2be14078568687e04a23810df8b2d8b5f11347f586f720c90b74d79aed27bb6a
+language: ruby
+before_install:
+  - gem update --system
+  - gem update bundler
+env:
+  global:
+    - "JRUBY_OPTS=-Xcext.enabled=true"
 rvm:
-  - ruby-head
+  - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - jruby-18mode
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+  - ree
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: 1.9.2
+    - rvm: 1.9.3
+    - rvm: ree
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+    - rvm: ruby-head
+  fast_finish: true

data/README.md

@@ -3,7 +3,7 @@
 [![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)
+[![Test Coverage](https://codeclimate.com/github/bhaberer/cinch-wikipedia/badges/coverage.svg)](https://codeclimate.com/github/bhaberer/cinch-wikipedia/coverage)
 [![Code Climate](https://codeclimate.com/github/bhaberer/cinch-wikipedia.png)](https://codeclimate.com/github/bhaberer/cinch-wikipedia)
 
 Cinch plugin to query wikipedia.

data/Rakefile

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

data/cinch-wikipedia.gemspec

@@ -4,24 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cinch/plugins/wikipedia/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "cinch-wikipedia"
+  gem.name          = 'cinch-wikipedia'
   gem.version       = Cinch::Plugins::Wikipedia::VERSION
-  gem.authors       = ["Brian Haberer"]
-  gem.email         = ["bhaberer@gmail.com"]
-  gem.description   = %q{Cinch plugin that fetches a truncated blurb from the head of a wikipedia page.}
-  gem.summary       = %q{Cinch Wikipedia Plugin}
-  gem.homepage      = "https://github.com/bhaberer/cinch-wikipedia"
+  gem.authors       = ['Brian Haberer']
+  gem.email         = ['bhaberer@gmail.com']
+  gem.description   = 'Cinch plugin that fetches a truncated blurb from the '\
+                      'head of a wikipedia page.'
+  gem.summary       = 'Cinch Wikipedia Plugin'
+  gem.homepage      = 'https://github.com/bhaberer/cinch-wikipedia'
+  gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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'
-  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'rake', '~> 12.3.3'
+  gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'cinch-test', '~> 0.1', '>= 0.1.1'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
 
-  gem.add_dependency 'cinch',           '~> 2.0.4'
-  gem.add_dependency 'cinch-toolbox',   '~> 1.0.0'
-  gem.add_dependency 'cinch-cooldown',  '~> 1.0.0'
+  gem.add_dependency 'cinch', '~> 2'
+  gem.add_dependency 'cinch-cooldown', '~> 1.1', '>= 1.1.7'
+  gem.add_dependency 'cinch-toolbox', '~> 1.1', '>= 1.1.6'
 end

data/lib/cinch-wikipedia.rb

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

data/lib/cinch/plugins/wikipedia.rb

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+require 'cinch'
+require 'cinch/toolbox'
+require 'cinch/cooldown'
+
+module Cinch
+  module Plugins
+    # Plugin to allow users to search wikipedia.
+    class Wikipedia
+      include Cinch::Plugin
+
+      enforce_cooldown
+
+      self.help = 'Use .wiki <term> to see the Wikipedia info for that term.'
+
+      match(/wiki(?:pedia)? (.*)/)
+
+      def initialize(*args)
+        super
+        @max_length = config[:max_length] || 300
+      end
+
+      def execute(m, term)
+        m.reply wiki(term)
+      end
+
+      private
+
+      def wiki(term)
+        # URI Encode
+        term = URI.escape(term, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        url = "http://en.wikipedia.org/w/index.php?search=#{term}"
+
+        # Truncate text and url if they are too long
+        text = Cinch::Toolbox.truncate(get_def(term, url), @max_length)
+        url  = Cinch::Toolbox.shorten(url)
+
+        "Wikipedia ∴ #{text} [#{url}]"
+      end
+
+      def get_def(term, url)
+        cats = Cinch::Toolbox.get_html_element(url, '#mw-normal-catlinks')
+        if cats && cats.include?('Disambiguation')
+          return "'#{term} is too vague and lead to a disambiguation page."
+        else
+          wiki_text = Cinch::Toolbox.get_html_element(url, '#mw-content-text/p')
+          if wiki_text.nil?
+            return not_found(url)
+          end
+          return wiki_text
+        end
+      end
+
+      def not_found(url)
+        msg = "I couldn't find anything for that search, "
+        alt_term = Cinch::Toolbox.get_html_element(url, '.searchdidyoumean')
+        if alt_term
+          alt_term = alt_term[/\ADid you mean: (\w+)\z/, 1]
+          msg << "did you mean '#{alt_term}'?"
+        else
+          msg << 'sorry!'
+        end
+        msg
+      end
+    end
+  end
+end

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

@@ -1,7 +1,9 @@
+# -*- coding: utf-8 -*-
 module Cinch
   module Plugins
+    # Versioning information
     class Wikipedia
-      VERSION = "1.0.0"
+      VERSION = '1.0.6'
     end
   end
 end

data/spec/cinch-wikipedia_spec.rb

@@ -1,41 +1,49 @@
 require 'spec_helper'
 
 describe Cinch::Plugins::Wikipedia do
+  include Cinch::Test
 
   before(:all) do
-    @plugin = Cinch::Plugins::Wikipedia.new
+    @bot = make_bot(Cinch::Plugins::Wikipedia)
   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")
+    expect(get_replies(make_message(@bot, '!wiki computer')).first.text)
+      .to include('A computer is a general purpose device')
+  end
+
+  it 'should return a definition of a term for each version of cmd' do
+    msg1 = get_replies(make_message(@bot, '!wiki computer')).first.text
+    msg2 = get_replies(make_message(@bot, '!wikipedia computer')).first.text
+    expect(msg1).to eq(msg2)
   end
 
   it 'should not return multiple lined definitions' do
-    @plugin.send(:get_def, 'Teenager').
-      should_not include("\n")
+    expect(get_replies(make_message(@bot, '!wiki Teenager')).first.text)
+      .to_not include("\n")
   end
 
   it 'should not return definitions that are longer than 250 chars' do
-    @plugin.send(:get_def, 'Teenager').length.
-      should == 334
+    expect(get_replies(make_message(@bot, '!wiki Teenager')).first.text.length)
+      .to eq 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!")
+    msg = make_message(@bot, '!wiki dasdafasfasfasfasafsdfsdfsadf')
+    expect(get_replies(msg).first.text)
+      .to 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'?")
+    expect(get_replies(make_message(@bot, '!wiki cliinton')).first.text)
+      .to include("I couldn't find anything for that search, did you mean 'clinton'?")
   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')
+    expect(get_replies(make_message(@bot, '!wiki hacker')).first.text)
+      .to include('is too vague and lead to a disambiguation page')
   end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,112 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: cinch-wikipedia
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.0.6
 platform: ruby
 authors:
 - Brian Haberer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2021-01-27 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'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: cinch-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: cinch
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: cinch-toolbox
+  name: cinch-cooldown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.7
 - !ruby/object:Gem::Dependency
-  name: cinch-cooldown
+  name: cinch-toolbox
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.6
 description: Cinch plugin that fetches a truncated blurb from the head of a wikipedia
   page.
 email:
@@ -115,43 +134,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cinch-wikipedia.gemspec
 - lib/cinch-wikipedia.rb
+- lib/cinch/plugins/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: 
+licenses:
+- MIT
+metadata: {}
+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
+rubygems_version: 3.2.6
+signing_key:
+specification_version: 4
 summary: Cinch Wikipedia Plugin
 test_files:
 - spec/cinch-wikipedia_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

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

@@ -1,62 +0,0 @@
-# -*- coding: utf-8 -*-
-require 'cinch'
-require 'cinch-toolbox'
-require 'cinch-cooldown'
-
-module Cinch::Plugins
-  class Wikipedia
-    include Cinch::Plugin
-
-    enforce_cooldown
-
-    self.help = "Use .wiki <term> to see the Wikipedia info for that term."
-
-    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
-
-    private
-
-    def get_def(term)
-      # URI Encode
-      term = URI.escape(term, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-      url = "http://en.wikipedia.org/w/index.php?search=#{term}"
-
-      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 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
-
-    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