lita-wtf 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30cc486fa5e52b5ebc5b4a4e05e30618e3ecf9ce
-  data.tar.gz: 29429041986b0a8a0ab276aa75f38149ba56fd9d
+  metadata.gz: 2cc760cdfe9231a5686e102f208d7f5271ce3ded
+  data.tar.gz: dea01bd0bd5b39e2ccd74dc255fa8e6f89f59360
 SHA512:
-  metadata.gz: f979500af98e7709f2cd1e51f3183a203cac95a71a8374f78d27de518207abee44122d68d13c5f18f7d267fa04713e1549aa6fd5a175bf54966f67976ca2823b
-  data.tar.gz: 94c3ba445b829ab2f0d101555e8c7b0bed2fb0d8a97973c6ba01786b5b55053843e0cb08c514f9d6086ad1a4e94043603f7defadd76adf357ee05210710157fe
+  metadata.gz: dd61ba1a8eea0bcd4b4ececeab3aefe8836f03ad9358f9dee2fa21fd2be724d81521c1c2a0178b3de56ef9505661bb8443d5a9b584c063f5a28a55e3e3b048b2
+  data.tar.gz: 7a3aeb2d1cd7f6619e537dfda411c0a52f393ad461e25ad43d822e07c7bbda4aeb2e9b399e891f1bf17e9e285b4ceb5f38bdd7271cde2ba3889aa9dd562a83ce

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.env

data/.rspec

@@ -0,0 +1 @@
+--color --profile 5

data/.rubocop.yml

@@ -5,3 +5,6 @@ Documentation:
 FileName:
   Exclude:
     - lib/lita-wtf.rb
+
+LineLength:
+  Max: 90

data/README.md

@@ -19,7 +19,14 @@ gem "lita-wtf"
 
 ## Configuration
 
-None
+Optionally, you can add 'See Also' handlers
+
+```
+lita.config.wtf.see_also = ['merriam', 'urbandictionary']
+lita.config.wtf.api_keys = {
+  'merriam': 'abc123'
+}
+```
 
 ## Usage
 
@@ -37,6 +44,17 @@ lita wtf is foo
 > foo is something that you want to have defined
 ```
 
-## License
+Optionally, get 'See Also' recommendations:
+
+```
+lita wtf is foo
+> According to Merriam-Webster Collegiate Dictionary,
+> foo is a mythical lion-dog used as a decorative motif
+> in Far Eastern art
+> To replace this with our own definition, type: define foo is <description>.
+```
+
+## Development
 
-[MIT](http://opensource.org/licenses/MIT)
+This project uses dotenv to load sensitive variables for development.  Create
+a .env file in your local copy with "MERRIAM_KEY=<whatever key you use>"

data/lib/lita-wtf.rb

@@ -4,4 +4,6 @@ Lita.load_locales Dir[File.expand_path(
   File.join('..', '..', 'locales', '*.yml'), __FILE__
 )]
 
+require 'nokogiri'
+
 require 'lita/handlers/wtf'

data/lib/lita/handlers/wtf.rb

@@ -1,6 +1,14 @@
 module Lita
   module Handlers
     class Wtf < Handler
+      config :see_also, required: false, type: Array, default: []
+      config :api_keys, required: false, type: Hash, default: {}
+
+      SOURCE_NAMES = {
+        'merriam' => 'Merriam-Webster Collegiate Dictionary',
+        'urbandictionary' => 'UrbanDictionary'
+      }.freeze
+
       route(
         /^wtf(?:\s+is)?\s(?<term>[^\s@#]+)(?:\?)?/,
         :lookup,
@@ -21,8 +29,15 @@ module Lita
 
       def lookup(response)
         term = response.match_data['term']
-        return response.reply(t('wtf.unknown', term: term)) unless known?(term)
-        response.reply(format_definition(term, definition(term)))
+        return response.reply(format_definition(term, definition(term))) if known?(term)
+
+        definition, source_name = alternate_definition(term)
+        return response.reply(t('wtf.seealso',
+                                term: term,
+                                definition: definition,
+                                source: SOURCE_NAMES[source_name])) if definition
+
+        response.reply(t('wtf.unknown', term: term))
       end
 
       def define(response)
@@ -50,6 +65,53 @@ module Lita
         redis.hset(term.downcase, 'definition', definition)
         redis.hset(term.downcase, 'owner', owner)
       end
+
+      def alternate_definition(term)
+        config.see_also.each do |source_name|
+          definition = send("lookup_#{source_name}", term)
+          return definition, source_name if definition
+        end
+
+        nil
+      end
+
+      def lookup_merriam(term)
+        api_key = config.api_keys['merriam']
+        # FIXME: Add timeouts.
+        response = http.get('http://www.dictionaryapi.com/api/v1/'\
+                            "references/collegiate/xml/#{term}",
+                            key: api_key)
+
+        raise unless response.status == 200
+
+        format_merriam_entries(response.body)
+      rescue StandardError
+        nil
+      end
+
+      def format_merriam_entries(content)
+        nokogiri_dom = Nokogiri::XML(content) do |config|
+          config.options = Nokogiri::XML::ParseOptions::STRICT |
+                           Nokogiri::XML::ParseOptions::NONET
+        end
+
+        nokogiri_dom.css('//entry[1]/def/dt/text()').to_s[1..-1]
+      rescue StandardError
+        nil
+      end
+
+      def lookup_urbandictionary(term)
+        # FIXME: Add timeouts.
+        response = http.get('http://api.urbandictionary.com/v0/define',
+                            term: term)
+
+        def_list = JSON.parse(response.body)['list']
+        def_text = def_list[0]['definition'].strip
+        def_text[0] = def_text[0].chr.downcase
+        def_text
+      rescue StandardError
+        nil
+      end
     end
 
     Lita.register_handler(Wtf)

data/lita-wtf.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-wtf'
-  spec.version       = '1.0.1'
-  spec.authors       = ['Eric Sigler', 'Rob Ottaway']
-  spec.email         = ['me@esigler.com', 'rottaway@pagerduty.com']
+  spec.version       = '1.1.0'
+  spec.authors       = ['Eric Sigler', 'Rob Ottaway', 'Max T']
+  spec.email         = ['me@esigler.com', 'rottaway@pagerduty.com', 'github@maxvt.com']
   spec.description   = 'A user-controlled dictionary plugin for Lita'
-  spec.summary       = 'A user-controlled dictionary plugin for Lita'
+  spec.summary       = spec.description
   spec.homepage      = 'http://github.com/esigler/lita-wtf'
   spec.license       = 'MIT'
   spec.metadata      = { 'lita_plugin_type' => 'handler' }
@@ -15,9 +15,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'lita', '>= 4.0'
+  spec.add_runtime_dependency 'nokogiri'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.0'
   spec.add_development_dependency 'rubocop'

data/locales/en.yml

@@ -4,11 +4,12 @@ en:
       wtf:
         help:
           wtf:
-            syntax: wtf is <term>?
+            syntax: wtf is <term>
             desc: Get the description of <term>
           define:
             syntax: define <term> is <defintion>
             desc: Set the description of <term> to <definition>
         wtf:
           is: "%{term} is %{definition}"
+          seealso: "According to %{source}, %{term} is %{definition}\nTo replace this with our own definition, type: define %{term} is <description>."
           unknown: "I don't know what %{term} is, type: define %{term} is <description> to set it."

data/spec/files/merriam

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<entry_list version="1.0">
+	<entry id="foo dog"><ew>foo dog</ew><subj>MY</subj><hw>foo dog</hw><sound><wav>foo_do01.wav</wav><wpr>!fU-!dog</wpr></sound><vr><vl>or</vl> <va>fu dog</va> <pr>ˈfü-</pr></vr><fl>noun</fl><lb>often capitalized F</lb><et>Chinese (Beijing) <it>fó</it> Buddha; from the use of such figures in ceramic or stone as guardians of Buddhist temples</et><def><date>1953</date><dt>:a mythical lion-dog used as a decorative motif in Far Eastern art</dt></def></entry>
+	<entry id="foo-foo[1]"><hw>foo-foo[1]</hw><fl>teaser entry</fl></entry>
+	<entry id="foo-foo[2]"><hw>foo-foo[2]</hw><fl>teaser entry</fl></entry>
+	<entry id="egg foo yong"><ew>egg foo yong</ew><grp>egg foo</grp><grp>egg yong</grp><grp>foo yong</grp><subj>FD</subj><hw>egg foo yong</hw><sound><wav>eggfo01v.wav</wav><wpr>!eg-!fU-!yuN</wpr></sound><vr><vl>or</vl> <va>egg foo young</va> <vl>or</vl> <va>egg foo yung</va> <pr>-ˈfü-ˈyəŋ</pr></vr><fl>noun</fl><et>Chinese (Guangdong) <it>fuùh yuùhng</it> egg white, egg-coated ingredients, literally, a kind of hibiscus</et><def><date>1917</date><dt>:a fried egg patty containing vegetables (as bean sprouts) and sometimes meat</dt></def></entry>
+	<entry id="fu dog"><ew>fu dog</ew><subj>MY#FA</subj><hw>fu dog</hw><lb>often capitalized F</lb><cx><cl>variant of</cl> <ct>foo dog</ct></cx></entry>
+</entry_list>

data/spec/files/urban

@@ -0,0 +1 @@
+{"tags":["fool","foos","bar","dumbass","bitch","dude","foo fighters","fu","homie","foosball"],"result_type":"exact","list":[{"definition":"An term used for unimportant variables in programming when the programmer is too lazy to think of an actual name.  The origin of such word is described in detail in [RFC] 3092.","permalink":"http://foo.urbanup.com/765064","thumbs_up":1384,"author":"Dahhak","word":"foo","defid":765064,"current_vote":"","example":"int foo;\r\nfoo = 2 + 2;\r\ncout << foo;","thumbs_down":470},{"definition":"A contracted version of the word 'fool'.\r\n\r\nThe word origionated with Mr.T. Due to the extended contact with cheap substitute gold, he can no longer tell the difference between anybody he meets. In order to save himself the humiliation of asking who he's talking to, he simply refers to anyone and every one as 'foo' or 'sucka'. ","permalink":"http://foo.urbanup.com/78594","thumbs_up":1303,"author":"CubanB","word":"Foo","defid":78594,"current_vote":"","example":"\"You crazy foo!\"\r\n\"Dial 1-800-COLLECT, foo!\"","thumbs_down":688},{"definition":"One of the default variables in programmer's slang. See [bar].","permalink":"http://foo.urbanup.com/6579","thumbs_up":434,"author":"Anonymous","word":"foo","defid":6579,"current_vote":"","example":"And I incremented foo, but then forgot to check the array boundary and all hell broke loose","thumbs_down":237},{"definition":"foo A sample name for absolutely anything,\r\nespecially programs and files (especially scratch files).\r\nFirst on the standard list of metasyntactic variables used\r\nin syntax examples.","permalink":"http://foo.urbanup.com/5357921","thumbs_up":288,"author":"fooman99","word":"foo","defid":5357921,"current_vote":"","example":"The terms foobar, foo, bar, and baz are sometimes used as placeholder names (also referred to as metasyntactic variables) in computer programming or computer-related documentation. They have been used to name entities such as variables, functions, and commands whose purpose is unimportant and serve only to demonstrate a concept. The words themselves have no meaning in this usage. Foobar is sometimes used alone; foo, bar, and baz are sometimes used in that order, when multiple entities are needed.","thumbs_down":119},{"definition":"1. A word meaning \"fool\", in the case of Mr. T\r\n\r\n2. A commonly used programming variable, used when someone doesn't want to spend the time thinking up a real name for it.\r\n\r\n3. A [metasyntactic variable] commonly used by coders.\r\n\r\nFoo is often used in conjunction with the words [bar] [baz] and [qux]","permalink":"http://foo.urbanup.com/1073697","thumbs_up":464,"author":"\"Niffshack\"","word":"foo","defid":1073697,"current_vote":"","example":"1. \"I pity the foo!\"\r\n\r\n2. foo = 3;\r\n\r\n3. \"Damn! Dont we have any good food? All thats left is this foo!\"\r\n\"The code is full of foo\"","thumbs_down":357},{"definition":"Kung fu means skill from effort.\r\nKung foo means skill from bad-ass programming powers.\r\n\r\n$foo is used extensivly in php as a generic variable.","permalink":"http://foo.urbanup.com/1136221","thumbs_up":268,"author":"Skara","word":"foo","defid":1136221,"current_vote":"","example":"\"This is my kung foo, and it is strong.\"\r\n\r\n$foo += 10;","thumbs_down":177},{"definition":"like [foo] except with proper use of the apostrophe for the omission of the letter l. A contraction of the word fool","permalink":"http://foo.urbanup.com/960374","thumbs_up":105,"author":"Aaron","word":"foo'","defid":960374,"current_vote":"","example":"Fast food will make you fat foo'!","thumbs_down":26},{"definition":"Foo was a nonsense word used by cartoonist Bill Holman in the comic strip \"Smokey Stover\" from the 30's into the 50's. He was reported to have discovered the word in a Chinese fortune cookie and the word appeared in almost every panel in the strip. It predates most of definitions that I have seen so far. The strip appeared in the SF Chronicle or the SF Examiner.","permalink":"http://foo.urbanup.com/5945353","thumbs_up":69,"author":"Pete71","word":"FOO","defid":5945353,"current_vote":"","example":"Foo was on signs along the road, on license plates or anywhere else one could imagine","thumbs_down":29},{"definition":"verb- to put ones finger in anothers ear and quickly wiggle it around.\n\nsubdefinitions:\n\nwet-foos- licking ones fingee before Foosing another person\n\nDouble-Foos: Using two fingers to Foos other(s) it can either be both ears of one person or one ear of two different people\n\nMiddlefinger-Foos: to Foos another using ones middle finger (considered much more disgraceful than a sandard Foos)","permalink":"http://foos.urbanup.com/4237735","thumbs_up":41,"author":"the foos master","word":"Foos","defid":4237735,"current_vote":"","example":"Tony jumped when he was unexpectedly Foosed from behind.\n\nHe felt disgraced after being middlefinger-foosed.","thumbs_down":21},{"definition":"An english student teacher, whos coolness overwhelms all.","permalink":"http://foos.urbanup.com/1192169","thumbs_up":82,"author":"Vorbis Yuckabitobis","word":"foos","defid":1192169,"current_vote":"","example":"What the foos?\r\nGo ask foos.\r\nIts Foos!\r\nSo you know that foos...","thumbs_down":64}],"sounds":["http://media.urbandictionary.com/sound/foo-2487.mp3","http://media.urbandictionary.com/sound/foo-16117.mp3"]}

data/spec/lita/handlers/wtf_spec.rb

@@ -1,35 +1,97 @@
 require 'spec_helper'
 
 describe Lita::Handlers::Wtf, lita_handler: true do
-  it do
-    is_expected.to route_command('wtf is foo').to(:lookup)
-    is_expected.to route_command('wtf foo').to(:lookup)
-    is_expected.to route_command('define foo is bar').to(:define)
-  end
+  it { is_expected.to route_command('wtf is foo').to(:lookup) }
+  it { is_expected.to route_command('wtf foo').to(:lookup) }
+  it { is_expected.to route_command('define foo is bar').to(:define) }
 
   describe '#lookup' do
-    it 'responds with the definition of the service' do
+    before do
+      robot.config.handlers.wtf.see_also = []
       send_command('define web is Rails. Rails. Rails.')
-      send_command('wtf is web')
-      expect(replies.last).to eq('web is Rails. Rails. Rails.')
+      send_command('define &&--88^%!$*() is garbage text')
     end
 
-    it 'allows definitions with lots of weird characters' do
-      send_command('define &&--88^%!$*() is garbage text')
-      send_command('wtf is &&--88^%!$*()')
-      expect(replies.last).to eq('&&--88^%!$*() is garbage text')
+    it 'responds with the definition of the service' do
+      send_command('wtf is web')
+      expect(replies.last).to eq('web is Rails. Rails. Rails.')
     end
 
     it 'responds with the definition of a capitalized service' do
-      send_command('define web is Rails. Rails. Rails.')
       send_command('wtf is WEB')
       expect(replies.last).to eq('WEB is Rails. Rails. Rails.')
     end
 
+    it 'allows definitions with lots of weird characters' do
+      send_command('wtf is &&--88^%!$*()')
+      expect(replies.last).to eq('&&--88^%!$*() is garbage text')
+    end
+
     it 'responds with an error if there is no such service' do
       send_command('wtf is foo')
       expect(replies.last).to eq('I don\'t know what foo is, ' \
                                  'type: define foo is <description> to set it.')
     end
   end
+
+  describe 'with urbandictionary enabled' do
+    before do
+      robot.config.handlers.wtf.see_also = ['urbandictionary']
+    end
+
+    it 'responds with see also text' do
+      grab_request('get', 200, File.read('spec/files/urban'))
+      send_command('wtf is foo')
+      expect(replies).to include('According to UrbanDictionary, foo is an term used ' \
+                                 'for unimportant variables in programming when the ' \
+                                 'programmer is too lazy to think of an actual name.  ' \
+                                 'The origin of such word is described in detail in ' \
+                                 "[RFC] 3092.\nTo replace this with our own " \
+                                 'definition, type: define foo is <description>.')
+    end
+
+    it 'responds with just the define statement if there is nothing to look up' do
+      grab_request('get', 200, '') # Yes, the API returns a 200 on not found. Sigh.
+      send_command('wtf is asdkjfal')
+      expect(replies.last).to eq('I don\'t know what asdkjfal is, ' \
+                                 'type: define asdkjfal is <description> to set it.')
+    end
+  end
+
+  describe 'with merriam enabled' do
+    before do
+      robot.config.handlers.wtf.see_also = ['merriam']
+      robot.config.handlers.wtf.api_keys['merriam'] = ENV['MERRIAM_KEY']
+    end
+
+    it 'responds with see also text' do
+      grab_request('get', 200, File.read('spec/files/merriam'))
+      send_command('wtf is foo')
+      expect(replies).to include('According to Merriam-Webster Collegiate Dictionary, ' \
+                                 'foo is a mythical lion-dog used as a decorative ' \
+                                 "motif in Far Eastern art\nTo replace this with our " \
+                                 'own definition, type: define foo is <description>.')
+    end
+
+    it 'responds with just the define statement if there is nothing to look up' do
+      grab_request('get', 200, '') # Yes, the API returns a 200 on not found. Sigh.
+      send_command('wtf is asdkjfal')
+      expect(replies.last).to eq('I don\'t know what asdkjfal is, ' \
+                                 'type: define asdkjfal is <description> to set it.')
+    end
+
+    it 'responds with just the define statement if there is a fetch error' do
+      grab_request('get', 500, nil)
+      send_command('wtf is asdkjfal')
+      expect(replies.last).to eq('I don\'t know what asdkjfal is, ' \
+                                 'type: define asdkjfal is <description> to set it.')
+    end
+
+    it 'responds with just the define statement if there is a parse error' do
+      grab_request('get', 200, 'wha?')
+      send_command('wtf is asdkjfal')
+      expect(replies.last).to eq('I don\'t know what asdkjfal is, ' \
+                                 'type: define asdkjfal is <description> to set it.')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,39 @@
 require 'simplecov'
 require 'coveralls'
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]
 SimpleCov.start { add_filter '/spec/' }
 
+require 'dotenv'
+Dotenv.load
+
 require 'lita-wtf'
+
 require 'lita/rspec'
 
 Lita.version_3_compatibility_mode = false
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.order = :random
+
+  Kernel.srand config.seed
+end
+
+def grab_request(method, status, body)
+  response = double('Faraday::Response', status: status, body: body)
+  allow_any_instance_of(Faraday::Connection).to receive(method.to_sym)
+    .and_return(response)
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lita-wtf
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Eric Sigler
 - Rob Ottaway
+- Max T
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -25,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +68,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,11 +142,13 @@ description: A user-controlled dictionary plugin for Lita
 email:
 - me@esigler.com
 - rottaway@pagerduty.com
+- github@maxvt.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CONTRIBUTING.md
@@ -129,6 +160,8 @@ files:
 - lib/lita/handlers/wtf.rb
 - lita-wtf.gemspec
 - locales/en.yml
+- spec/files/merriam
+- spec/files/urban
 - spec/lita/handlers/wtf_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/esigler/lita-wtf
@@ -152,10 +185,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A user-controlled dictionary plugin for Lita
 test_files:
+- spec/files/merriam
+- spec/files/urban
 - spec/lita/handlers/wtf_spec.rb
 - spec/spec_helper.rb