lita-wordnik 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04e7612f43af97a846b2a720e130cdcdd25475a0
+  data.tar.gz: fbeeeb8f1d1b2838327bfcab5227ebf5d7fbcdd9
+SHA512:
+  metadata.gz: 4acd1c210978f0042a4a0ae61e0a6305729ce433e3de9641a9da6ea79a2bdbd9dd23e853b8a85b7329a469c4ab17f9a76c5965bc32f443ae85abcad819b350fa
+  data.tar.gz: dfe0590571736facf54dfc64585b5ee220d64fc9c1be928c898140e62ed42ece62bec2d9187ecca0895b290372d23c91971cd0b17402d268d208d3cc7ba9c5b8

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+lita_config.rb

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec
+before_install:
+  - gem update --system

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lita-wordnik.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# lita-wordnik
+
+[![Build Status](https://travis-ci.org/jimmycuadra/lita-wordnik.png)](https://travis-ci.org/jimmycuadra/lita-wordnik)
+[![Code Climate](https://codeclimate.com/github/jimmycuadra/lita-wordnik.png)](https://codeclimate.com/github/jimmycuadra/lita-wordnik)
+[![Coverage Status](https://coveralls.io/repos/jimmycuadra/lita-wordnik/badge.png)](https://coveralls.io/r/jimmycuadra/lita-wordnik)
+
+**lita-wordnik** is a handler for [Lita](https://github.com/jimmycuadra/lita) that adds dictionary functionality backed by [Wordnik](http://www.wordnik.com/).
+
+## Installation
+
+Add lita-wordnik to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-wordnik"
+```
+
+## Configuration
+
+### Required attributes
+
+* `api_key` - Your API key for Wordnik. Register for one at the [Wordnik Developer](http://developer.wordnik.com/) page.
+
+### Example
+
+```
+Lita.configure do |config|
+  config.handlers.wordnik.api_key = "abc123"
+end
+```
+
+## Usage
+
+To get the definition for a word:
+
+```
+Lita: define WORD
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lita/handlers/wordnik.rb

@@ -0,0 +1,73 @@
+require "lita"
+
+module Lita
+  module Handlers
+    class Wordnik < Handler
+      def self.default_config(config)
+        config.api_key = nil
+      end
+
+      route(/define\s+(.+)/i, :define, command: true, help: {
+        "define WORD" => "Get the definition for WORD."
+      })
+
+      def define(response)
+        return unless validate(response)
+        word = response.matches[0][0]
+        definition = get_definition(word)
+        response.reply(definition)
+      end
+
+      private
+
+      def get_definition(word)
+        word = encode_word(word)
+        url = "http://api.wordnik.com/v4/word.json/#{word}/definitions"
+        Lita.logger.debug("Making Wordnik API request to #{url}.")
+        process_response http.get(
+          url,
+          api_key: Lita.config.handlers.wordnik.api_key,
+          limit: 1,
+          includeRelated: false,
+          useCanonical: true,
+          includeTags: false
+        )
+      end
+
+      def encode_word(word)
+        begin
+          URI.parse(word)
+          return word
+        rescue URI::InvalidURIError
+          return URI.encode(word)
+        end
+      end
+
+      def process_response(response)
+        case response.status
+        when 400
+          "Wordnik didn't understand that word."
+        when 404
+          "Wordnik doesn't have any definitions for that."
+        when 200
+          data = MultiJson.load(response.body).first
+          "#{data["word"]} (#{data["partOfSpeech"]}): #{data["text"]}"
+        else
+          Lita.logger.error("Wordnik request failed: #{response.inspect}")
+          "Wordnik request failed. See the Lita logs."
+        end
+      end
+
+      def validate(response)
+        if Lita.config.handlers.wordnik.api_key.nil?
+          response.reply "Wordnik API key required."
+          return
+        end
+
+        true
+      end
+
+      Lita.register_handler(Wordnik)
+    end
+  end
+end

data/lib/lita-wordnik.rb

@@ -0,0 +1 @@
+require "lita/handlers/wordnik"

data/lita-wordnik.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-wordnik"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jimmy Cuadra"]
+  spec.email         = ["jimmy@jimmycuadra.com"]
+  spec.description   = %q{A Lita handler for dictionary functionality backed by Wordnik.}
+  spec.summary       = %q{A Lita handler for dictionary functionality backed by Wordnik.}
+  spec.homepage      = "https://github.com/jimmycuadra/lita-wordnik"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", "~> 2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/spec/lita/handlers/wordnik_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe Lita::Handlers::Wordnik, lita_handler: true do
+  it { routes_command("define computer").to(:define) }
+
+  it "sets the API key to nil by default" do
+    expect(Lita.config.handlers.wordnik.api_key).to be_nil
+  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
+
+    context "when the API key is set" do
+      let(:body) do
+        <<-BODY.chomp
+[
+  {
+    "word": "computer",
+    "text": "A device that computes, especially a programmable electronic \
+machine that performs high-speed mathematical or logical operations or that \
+assembles, stores, correlates, or otherwise processes information.",
+    "partOfSpeech": "noun"
+  }
+]
+BODY
+      end
+      let(:response) { double("Faraday::Response", status: 200, body: body) }
+
+      before do
+        Lita.config.handlers.wordnik.api_key = "abc123"
+        allow_any_instance_of(
+          Faraday::Connection
+        ).to receive(:get).and_return(response)
+      end
+
+      it "replies with the definition" do
+        send_command("define computer")
+        expect(replies.last).to include("computer (noun): A device that")
+      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
+
+      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
+
+      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")
+      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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-wordnik"
+require "lita/rspec"

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: lita-wordnik
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jimmy Cuadra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !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.
+email:
+- jimmy@jimmycuadra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-wordnik.rb
+- lib/lita/handlers/wordnik.rb
+- lita-wordnik.gemspec
+- spec/lita/handlers/wordnik_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jimmycuadra/lita-wordnik
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A Lita handler for dictionary functionality backed by Wordnik.
+test_files:
+- spec/lita/handlers/wordnik_spec.rb
+- spec/spec_helper.rb
+has_rdoc: