lita-wordnik 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45d6698e12741ea0909d4ac63e004e7afefee110
-  data.tar.gz: 5749ff7a995ab1d6ea1ade5e0ff6e5c0c394f010
+  metadata.gz: ce8bb942f982996203a905a3212e4ee5d162c39c
+  data.tar.gz: 20134edd81a00fde12234f006d47bb7568972a4f
 SHA512:
-  metadata.gz: 386209f4b9fcf978aa6bb0b8333dd5a0c5a40e42760558defe33dc64e44731a449bd0ec157f0d0cd54340493f39e747a555bc32d08a5fbf1ae12f65834cb57a8
-  data.tar.gz: 342f7d61a13339f3659051a5a258e9d95d1d28830e4e89fa2f9c34b73a89ab6d6d18a225a33d9232e346f441868af651f79bbfc06b6229a228a27459912d20ae
+  metadata.gz: 7df229ffa08cc6fd6eca44c445896614d20f68d466f9bd31c5ec323e4e2807e97086122f806ac890cef6a0ea043a8cf4c9e6e2f83241f8dd8cd17d409b98c8f9
+  data.tar.gz: dee4b9ebd3ce0a0567480d153d18dcbd2f73aa112dfb6d8512da9ceaffddf652a6badf3c0a7f58d1f33401645f95a3ed6f77621bc0fe7ef4a7486bb84fa1bb79

data/README.md

@@ -35,6 +35,29 @@ To get the definition for a word:
 ```
 Lita: define WORD
 ```
+To get synonyms for a word:
+
+```
+Lita: synonyms WORD
+```
+
+or
+
+```
+Lita: words like WORD
+```
+
+To get antonyms for a word:
+
+```
+Lita: antonyms WORD
+```
+
+or
+
+```
+Lita: words unlike WORD
+```
 
 ## License
 

data/lib/lita/handlers/wordnik.rb

@@ -3,7 +3,7 @@ require "lita"
 module Lita
   module Handlers
     class Wordnik < Handler
-      NO_DEFINITIONS = "Wordnik doesn't have any definitions for that."
+      NO_RESULTS = "Wordnik doesn't have any results for that."
 
       def self.default_config(config)
         config.api_key = nil
@@ -12,18 +12,37 @@ module Lita
       route(/define\s+(.+)/i, :define, command: true, help: {
         "define WORD" => "Get the definition for WORD."
       })
+      route(/^syn(?:onyms)?\s+(.*)$/i, :synonyms, command: true, help: {
+        "synonyms WORD" => "Get synonyms for WORD."
+      })
+      route(/^words\s*like\s+(.*)$/i, :synonyms, command: true, help: {
+        "words like WORD" => "Get synonyms for WORD."
+      })
+      route(/^ant(?:onyms)?\s+(.*)$/i, :antonyms, command: true, help: {
+        "antonyms WORD" => "Get antonyms for WORD."
+      })
+      route(/^words\s*unlike\s+(.*)$/i, :antonyms, command: true, help: {
+        "words unlike WORD" => "Get antonyms for WORD."
+      })
 
-      def define(response)
-        return unless validate(response)
-        word = response.matches[0][0]
-        definition = get_definition(word)
-        response.reply(definition)
+      class << self
+        def define_wordnik_method(name, getter_name)
+          define_method(name) do |response|
+            return unless validate(response)
+            word = encode_word(response.matches[0][0])
+            result = send(getter_name, word)
+            response.reply(result)
+          end
+        end
       end
 
+      define_wordnik_method :define, :definition_for
+      define_wordnik_method :synonyms, :synonyms_for
+      define_wordnik_method :antonyms, :antonyms_for
+
       private
 
-      def get_definition(word)
-        word = encode_word(word)
+      def definition_for(word)
         url = "http://api.wordnik.com/v4/word.json/#{word}/definitions"
         Lita.logger.debug("Making Wordnik API request to #{url}.")
         process_response http.get(
@@ -36,6 +55,30 @@ module Lita
         )
       end
 
+      def synonyms_for(word)
+        url = "http://api.wordnik.com/v4/word.json/#{word}/relatedWords"
+        Lita.logger.debug("Making Wordnik API request to #{url}.")
+        process_response http.get(
+          url,
+          api_key: Lita.config.handlers.wordnik.api_key,
+          useCanonical: true,
+          relationshipTypes: "synonym",
+          limitPerRelationshipType: 5
+        )
+      end
+
+      def antonyms_for(word)
+        url = "http://api.wordnik.com/v4/word.json/#{word}/relatedWords"
+        Lita.logger.debug("Making Wordnik API request to #{url}.")
+        process_response http.get(
+          url,
+          api_key: Lita.config.handlers.wordnik.api_key,
+          useCanonical: true,
+          relationshipTypes: "antonym",
+          limitPerRelationshipType: 5
+        )
+      end
+
       def encode_word(word)
         begin
           URI.parse(word)
@@ -50,14 +93,21 @@ module Lita
         when 400
           "Wordnik didn't understand that word."
         when 404
-          NO_DEFINITIONS
+          NO_RESULTS
         when 200
           data = MultiJson.load(response.body).first
 
           if data
-            "#{data["word"]} (#{data["partOfSpeech"]}): #{data["text"]}"
+            case data["relationshipType"]
+            when "synonym"
+              "(synonyms): #{data["words"].join(', ')}"
+            when "antonym"
+              "(antonyms): #{data["words"].join(', ')}"
+            else
+              "#{data["word"]} (#{data["partOfSpeech"]}): #{data["text"]}"
+            end
           else
-            NO_DEFINITIONS
+            NO_RESULTS
           end
         else
           Lita.logger.error("Wordnik request failed: #{response.inspect}")

data/lita-wordnik.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-wordnik"
-  spec.version       = "0.0.3"
+  spec.version       = "0.1.0"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{A Lita handler for dictionary functionality backed by Wordnik.}
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
 end

data/spec/lita/handlers/wordnik_spec.rb

@@ -1,8 +1,28 @@
 require "spec_helper"
 
 describe Lita::Handlers::Wordnik, lita_handler: true do
-  let(:body) do
-    <<-BODY.chomp
+  let(:response) { double("Faraday::Response", status: 200, body: body) }
+
+  it { routes_command("define computer").to(:define) }
+  it { routes_command("synonyms cold").to(:synonyms) }
+  it { routes_command("syn cold").to(:synonyms) }
+  it { routes_command("words like cold").to(:synonyms) }
+  it { routes_command("antonyms cold").to(:antonyms) }
+  it { routes_command("ant cold").to(:antonyms) }
+  it { routes_command("words unlike cold").to(:antonyms) }
+
+  it "sets the API key to nil by default" do
+    expect(Lita.config.handlers.wordnik.api_key).to be_nil
+  end
+
+  context "with Faraday stubbing" do
+    before do
+      allow_any_instance_of( Faraday::Connection).to receive(:get).and_return(response)
+    end
+
+    describe "#define" do
+      let(:body) do
+        <<-BODY.chomp
 [
   {
     "word": "computer",
@@ -13,67 +33,101 @@ assembles, stores, correlates, or otherwise processes information.",
   }
 ]
 BODY
-  end
+      end
 
-  let(:response) { double("Faraday::Response", status: 200, body: body) }
+      it "replies that the API key is required" do
+        send_command("define computer")
+        expect(replies.last).to include("API key required")
+      end
 
-  before do
-    allow_any_instance_of(
-      Faraday::Connection
-    ).to receive(:get).and_return(response)
-  end
+      context "when the API key is set" do
+        before { Lita.config.handlers.wordnik.api_key = "abc123" }
 
-  it { routes_command("define computer").to(:define) }
+        it "replies with the definition" do
+          send_command("define computer")
+          expect(replies.last).to include("computer (noun): A device that")
+        end
 
-  it "sets the API key to nil by default" do
-    expect(Lita.config.handlers.wordnik.api_key).to be_nil
-  end
+        it "URL encodes words" do
+          word = "a phrase with a % sign in it"
+          expect(URI).to receive(:encode).with(word)
+          send_command("define #{word}")
+        end
 
-  describe "#define" do
-    it "replies that the API key is required" do
-      send_command("define computer")
-      expect(replies.last).to include("API key required")
-    end
+        it "replies that Wordnik didn't understand the word on 400 status" do
+          allow(response).to receive(:status).and_return(400)
+          send_command("define computer")
+          expect(replies.last).to include("didn't understand")
+        end
 
-    context "when the API key is set" do
-      before { Lita.config.handlers.wordnik.api_key = "abc123" }
+        it "replies that Wordnik has no definitions on 404 status" do
+          allow(response).to receive(:status).and_return(404)
+          send_command("define computer")
+          expect(replies.last).to include("doesn't have any results")
+        end
 
-      it "replies with the definition" do
-        send_command("define computer")
-        expect(replies.last).to include("computer (noun): A device that")
-      end
+        it "logs an error and replies that the request completely failed" do
+          allow(response).to receive(:status).and_return(500)
+          send_command("define computer")
+          expect(replies.last).to include("request failed")
+        end
 
-      it "URL encodes words" do
-        word = "a phrase with a % sign in it"
-        expect(URI).to receive(:encode).with(word)
-        send_command("define #{word}")
+        context "when the response has no definitions" do
+          let(:body) { "[]" }
+
+          it "replies that Wordnik has no definitions" do
+            send_command("define whiskey stone")
+            expect(replies.last).to include("doesn't have any results")
+          end
+        end
       end
+    end
 
-      it "replies that Wordnik didn't understand the word on 400 status" do
-        allow(response).to receive(:status).and_return(400)
-        send_command("define computer")
-        expect(replies.last).to include("didn't understand")
+    describe "#synonyms" do
+      let(:body) do
+        <<-BODY.chomp
+[
+  {
+    "words": [
+      "stoical",
+      "frigid",
+      "unconcerned",
+      "bleak",
+      "indifferent"
+    ],
+    "relationshipType": "synonym"
+  }
+]
+BODY
       end
 
-      it "replies that Wordnik has no definitions on 404 status" do
-        allow(response).to receive(:status).and_return(404)
-        send_command("define computer")
-        expect(replies.last).to include("doesn't have any definitions")
+      before { Lita.config.handlers.wordnik.api_key = "abc123" }
+
+      it "replies with synonyms" do
+        send_command("synonyms cold")
+        expect(replies.last).to include("(synonyms): stoical, frigid, unconcerned, bleak, indifferent")
       end
+    end
 
-      it "logs an error and replies that the request completely failed" do
-        allow(response).to receive(:status).and_return(500)
-        send_command("define computer")
-        expect(replies.last).to include("request failed")
+    describe "#antonyms" do
+      let(:body) do
+    <<-BODY.chomp
+[
+  {
+    "words": [
+      "hot"
+    ],
+    "relationshipType": "antonym"
+  }
+]
+BODY
       end
 
-      context "when the response has no definitions" do
-        let(:body) { "[]" }
+      before { Lita.config.handlers.wordnik.api_key = "abc123" }
 
-        it "replies that Wordnik has no definitions" do
-          send_command("define whiskey stone")
-          expect(replies.last).to include("doesn't have any definitions")
-        end
+      it "replies with antonyms" do
+        send_command("antonyms cold")
+        expect(replies.last).to include("(antonyms): hot")
       end
     end
   end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: lita-wordnik
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2014-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: coveralls
   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'
 description: A Lita handler for dictionary functionality backed by Wordnik.
@@ -101,8 +101,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -123,17 +123,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Lita handler for dictionary functionality backed by Wordnik.