lita-google-translate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 567a014c803d00fd5a603583857f1dabf2b1b653
+  data.tar.gz: d33263924120684d39abc087d0db637bfd9852bb
+SHA512:
+  metadata.gz: 87e1538498018ea39114124b7d6213247a1d04c1c76c855b61d644ac9ea28b7707f9b71779e58e483ce7655d3156c94e019d55d7927185603395885b6664d646
+  data.tar.gz: 48cb21369098c30e77e036b3511e3f59dadd6393bbc08a4ce3dda311548f1bc4f277115c36283dd970df3d05646c9a91b1b1e1f33be0b0eaa519083bce0f5d28

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

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
+*.swp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Tristan Chong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# lita-google-translate
+
+[![Build Status](https://travis-ci.org/tristaneuan/lita-google-translate.png?branch=master)](https://travis-ci.org/tristaneuan/lita-google-translate)
+[![Coverage Status](https://coveralls.io/repos/tristaneuan/lita-google-translate/badge.png)](https://coveralls.io/r/tristaneuan/lita-google-translate)
+
+**lita-google-translate** is a handler for [Lita](https://github.com/jimmycuadra/lita) that performs translation and live interpretation with Google Translate.
+
+## Installation
+
+Add lita-google-translate to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-google-translate"
+```
+
+## Configuration
+
+In order to use this plugin, you must obtain a [Google Translate API key](https://cloud.google.com/translate/v2/pricing).
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.google_translate.api_key = "YOUR API KEY GOES HERE"
+end
+```
+
+### Optional attributes
+* `default_language` (String) - The code corresponding to the desired target language for translation and interpretation when none is explicitly given. Default: `en`
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.google_translate.default_language = "ja"
+end
+```
+
+## Usage
+
+Using the `translate` (or `t`) command will translate a given phrase. Source and/or target languages may be optionally specified using the syntax `translate(FROM:TO)`
+
+```
+<me>   lita: translate hola
+<lita> Hello
+<me>   lita: t(es) hello
+<lita> Hola
+<me>   lita: translate(zh-cn:fr) 你好
+<lita> Bonjour
+<me>   lita: translate(zh-cn:) 你好
+<lita> Hello
+<me>   lita: translate(:es) hello
+<lita> Hola
+```
+
+Using the `interpret` command will interpret your messages on the fly until you type `!interpret`. Again, source and/or target languages may be optionally specified using the syntax `interpret(FROM:TO)`
+
+```
+<me>   lita: interpret(fr)
+<me>   i don't want to talk to you anymore, you empty-headed animal food trough wiper
+<lita> je ne veux plus parler de vous, vous animaux tête vide mangeoire glace
+<me>   i fart in your general direction!
+<lita> Je pète dans votre direction générale!
+<me>   your mother was a hamster and your father smelled of elderberries
+<lita> votre mère était un hamster et votre père avait une odeur de baies de sureau
+<me>   !interpret
+```
+
+## Supported languages
+
+This list can be accessed within your chat client by sending Lita the command: `languages`
+
+Language | Code
+--- | ---
+Afrikaans | `af`
+Albanian | `sq`
+Arabic | `ar`
+Belarusian | `be`
+Bulgarian | `bg`
+Catalan | `ca`
+Simplified Chinese | `zh-CN`
+Traditional Chinese | `zh-TW`
+Croatian | `hr`
+Czech | `cs`
+Danish | `da`
+Dutch | `nl`
+English | `en`
+Estonian | `et`
+Filipino (Tagalog) | `tl`
+Finnish | `fi`
+French | `fr`
+Galician | `gl`
+German | `de`
+Greek | `el`
+Haitian Creole | `ht`
+Hebrew | `iw`
+Hindi | `hi`
+Hungarian | `hu`
+Icelandic | `is`
+Indonesian | `id`
+Irish | `ga`
+Italian | `it`
+Japanese | `ja`
+Latvian | `lv`
+Lithuanian | `lt`
+Macedonian | `mk`
+Malay | `ms`
+Maltese | `mt`
+Norwegian | `no`
+Persian | `fa`
+Polish | `pl`
+Portuguese | `pt`
+Romanian | `ro`
+Russian | `ru`
+Serbian | `sr`
+Slovak | `sk`
+Slovenian | `sl`
+Spanish | `es`
+Swahili | `sw`
+Swedish | `sv`
+Thai | `th`
+Turkish | `tr`
+Ukrainian | `uk`
+Vietnamese | `vi`
+Welsh | `cy`
+Yiddish | `yi`
+
+## Credits
+
+lita-google-translate's live interpretation feature was inspired by and adapted from [lita-translation](https://github.com/chua-mbt/lita-translation).
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-google-translate.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/google_translate"
+
+Lita::Handlers::GoogleTranslate.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/lita/handlers/google_translate.rb

@@ -0,0 +1,102 @@
+require "to_lang"
+
+module Lita
+  module Handlers
+    class GoogleTranslate < Handler
+
+      config :api_key, type: String, required: true
+      config :default_language, type: String, default: "en"
+
+      route(
+        /^t(?:ranslate)?(?:[\[\(](?:(?<from>[\-[[:alpha:]]]*)[\:\>,]\s*)?(?<to>[\-[[:alpha:]]]*)[\]\)])?\s+(?<text>.+)/i,
+        :translate, command: true, help: {
+          t("help.translate_key") => t("help.translate_value"),
+          t("help.translate_params_key") => t("help.translate_params_value")
+        }
+      )
+      route(
+        /^interpret(?:[\[\(](?:(?<from>[\-[[:alpha:]]]*)[\:\>,]\s*)?(?<to>[\-[[:alpha:]]]*)[\]\)])?(?:\s+(?<text>.+))?/i,
+        :interpret_start, command: true,
+        help: {t("help.interpret_key") => t("help.interpret_value")}
+      )
+      route(/./, :interpret_monitor, command: false)
+      route(/!interpret/i, :interpret_stop, command: false)
+      route(
+        /^languages/i, :languages, command: true,
+        help: {t("help.languages_key") => t("help.languages_value")}
+      )
+
+      def initialize(robot)
+        super
+        @@codes = ToLang::CODEMAP.each_value.map {|v| v.downcase}.to_set
+      end
+
+      def translate(response)
+        begin
+          response.reply get_translation(*parse_command(response.match_data))
+        rescue InvalidLanguage => e
+          response.reply format_error(e.message)
+        end
+      end
+
+      def interpret_start(response)
+        begin
+          from, to, text = parse_command(response.match_data)
+          redis.set("#{response.user.id}:from", from)
+          redis.set("#{response.user.id}:to", to)
+          response.reply get_translation(from, to, text) unless text.nil?
+        rescue InvalidLanguage => e
+          response.reply format_error(e.message)
+        end
+      end
+
+      def interpret_monitor(response)
+        return if response.message.body.include?("!interpret")
+        to = redis.get("#{response.user.id}:to")
+        unless to.nil? || response.message.command?
+          from = redis.get("#{response.user.id}:from")
+          response.reply get_translation(from, to, response.message.body)
+        end
+      end
+
+      def interpret_stop(response)
+        redis.del("#{response.user.id}:to")
+        redis.del("#{response.user.id}:from")
+      end
+
+      def languages(response)
+        response.reply_privately ToLang::CODEMAP.each.map {|k,v| "#{k}: #{v}"}.join("\n")
+      end
+
+      private
+
+      def parse_command(md)
+        from = falsy(md[:from]) ? nil : md[:from]
+        raise InvalidLanguage, from unless from.nil? || @@codes.include?(from.downcase)
+        to = falsy(md[:to]) ? config.default_language : md[:to]
+        raise InvalidLanguage, to unless @@codes.include?(to.downcase)
+        text = md[:text]
+        [from, to, text]
+      end
+
+      def get_translation(from, to, text)
+        ToLang.start(config.api_key)
+        falsy(from) ? text.translate(to) : text.translate(to, :from => from)
+      end
+
+      def format_error(code)
+        "'#{code}' is not a valid language code. For available languages, send me the command: languages"
+      end
+
+      def falsy(code)
+        code.nil? || code.empty?
+      end
+
+    end
+
+    class InvalidLanguage < Exception
+    end
+
+    Lita.register_handler(GoogleTranslate)
+  end
+end

data/lita-google-translate.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-google-translate"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Tristan Chong"]
+  spec.email         = ["ong@tristaneuan.ch"]
+  spec.description   = "A Lita handler that performs translation and live interpretation with Google Translate."
+  spec.summary       = "A Lita handler that performs translation and live interpretation with Google Translate."
+  spec.homepage      = "https://github.com/tristaneuan/lita-google-translate"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  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", ">= 4.4"
+  spec.add_runtime_dependency "to_lang", "1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  lita:
+    handlers:
+      google_translate:
+        help:
+          translate_key: "translate TEXT"
+          translate_value: "Translates TEXT to the default language."
+          translate_params_key: "translate(FROM:TO) TEXT"
+          translate_params_value: "Translates TEXT from FROM to TO. (FROM and TO are optional language codes)"
+          interpret_key: "interpret(FROM:TO) [TEXT]"
+          interpret_value: "Interprets your messages on the fly until you type !interpret. (FROM and TO are optional language codes)"
+          languages_key: "languages"
+          languages_value: "Sends a list of language codes supported by lita-google-translate."

data/spec/lita/handlers/google_translate_spec.rb

@@ -0,0 +1,137 @@
+require "spec_helper"
+
+describe Lita::Handlers::GoogleTranslate, lita_handler: true do
+
+  before do
+    registry.config.handlers.google_translate.api_key = ENV["GOOGLE_TRANSLATE_API_KEY"]
+  end
+
+  it { is_expected.to route_command("translate hola").to(:translate) }
+  it { is_expected.to route_command("translate(en) hola").to(:translate) }
+  it { is_expected.to route_command("translate(es:en) hola").to(:translate) }
+  it { is_expected.to route_command("translate(es:) hola").to(:translate) }
+  it { is_expected.to route_command("translate[en] hola").to(:translate) }
+  it { is_expected.to route_command("translate(es, en) hola").to(:translate) }
+  it { is_expected.to route_command("translate(es>en) hola").to(:translate) }
+  it { is_expected.to route_command("t() hola").to(:translate) }
+  it { is_expected.to route_command("interpret(es:en)").to(:interpret_start) }
+  it { is_expected.to route_command("interpret(es:en) hola").to(:interpret_start) }
+  it { is_expected.to route("hola").to(:interpret_monitor) }
+  it { is_expected.to route("!interpret").to(:interpret_stop) }
+  it { is_expected.to route_command("languages").to(:languages) }
+
+  context "with the default config" do
+
+    describe "#translate" do
+
+      it "translates with no parameters" do
+        send_command "translate hola"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^hello$/i
+      end
+
+      it "translates with TO parameter" do
+        send_command "translate(EL) hello"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match "Γεια σας"
+      end
+
+      it "translates with TO and FROM parameters" do
+        send_command "translate(zh-cn:de) 你好"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^hallo$/i
+      end
+
+      it "translates with FROM parameter" do
+        send_command "translate(el:) Γεια σας"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^hello$/i
+      end
+
+      it "responds with an error message when an invalid source language is given" do
+        send_command "translate(asdf:en) hej"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^'asdf' is not a valid language code\. For available languages, send me the command: languages$/
+      end
+
+      it "responds with an error message when an invalid target language is given" do
+        send_command "translate(es:hjkl) hola"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^'hjkl' is not a valid language code\. For available languages, send me the command: languages$/
+      end
+
+    end
+
+    describe "#interpret" do
+
+      before(:each) do
+        send_command "interpret"
+      end
+
+      it "interprets with no parameters" do
+        send_message "hola"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^hello$/i
+      end
+
+      it "responds with an error message when an invalid language is given" do
+        send_command "interpret(asdf)"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^'asdf' is not a valid language code\. For available languages, send me the command: languages$/
+      end
+
+      after(:each) do
+        send_message "!interpret"
+      end
+
+    end
+
+  end
+
+  context "with a user-configured default language" do
+
+    before(:each) do
+      registry.config.handlers.google_translate.default_language = "es"
+    end
+
+    describe "#translate" do
+
+      it "translates with no parameters" do
+        send_command "translate hello"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^hola$/i
+      end
+
+    end
+
+    describe "#interpret" do
+
+      before(:each) do
+        send_command "interpret"
+      end
+
+      it "interprets with no parameters" do
+        send_message "hello"
+        expect(replies.count).to eq 1
+        expect(replies.first).to match /^hola$/i
+      end
+
+      after(:each) do
+        send_message "!interpret"
+      end
+
+    end
+
+  end
+
+  describe "#languages" do
+
+    it "responds with a list of languages and their codes" do
+      send_command "languages"
+      expect(replies.count).to eq 1
+      expect(replies.first).to match /^afrikaans: af\nalbanian: sq\n/
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-google-translate"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: lita-google-translate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tristan Chong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: to_lang
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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: pry-byebug
+  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
+    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: rack-test
+  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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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 that performs translation and live interpretation with
+  Google Translate.
+email:
+- ong@tristaneuan.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-google-translate.rb
+- lib/lita/handlers/google_translate.rb
+- lita-google-translate.gemspec
+- locales/en.yml
+- spec/lita/handlers/google_translate_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/tristaneuan/lita-google-translate
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Lita handler that performs translation and live interpretation with Google
+  Translate.
+test_files:
+- spec/lita/handlers/google_translate_spec.rb
+- spec/spec_helper.rb