lita-translation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92de845747ee164159ffba572f90f692d6d42ea6
+  data.tar.gz: 2681a8075c783578e9d115ca7975083401c59b77
+SHA512:
+  metadata.gz: 4408c35c04ec73dd30b1de26772be8ce47dc16aa7e227dd3151fa9e9c5c284e186f77c7150eaf8dfd8ce09e369adbed8b8659d39c1024a3afc3123da3b9a40ac
+  data.tar.gz: 8eeb31021dbb354d75886894b7835540c6597afffb6d311d36859367075b57865f2603ab1bba7e184255a02ee67ecde83dd58d24e46fa65704a22f2bdec3631a

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
+dump.rdb

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Chua
+
+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,47 @@
+# lita-translation
+
+Language translation plugin that uses Microsoft's Translator API.
+
+## Installation
+
+Add lita-translation to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-translation"
+```
+
+## Configuration
+
+This plugin requires you to obtain a client id and secret for [Microsoft's Translation API](http://www.microsoft.com/translator/api.aspx). Register an account at the [Microsoft Azure Marketplace](https://azure.microsoft.com), and then register an application that uses the translation API service.
+
+### Required attributes
+
+* `client_id` (String) - A human readable identifier for your client that you provide on registration.
+* `client_secret` (String) - A key generated by Microsoft for your client.
+
+### Example
+
+```
+Lita.configure do |config|
+  config.handlers.translation.client_id = "my-translation-id"
+  config.handlers.translation.client_secret = "some key"
+end
+```
+
+## Usage
+
+An OAuth token is automatically requested by the plugin whenever a fresh one is unavailable.
+
+Microsoft uses ISO-639 codes to identify languages. Klingon is available.
+
+* languages - List language codes supported by Microsoft's Translator API
+* determine '[text]' - Determine language of the given text
+* translate '[text]' to [code] (from [code]) - Translate the given text from one language to another
+* translate me to [code] (from [code]) - Begin auto-translating all user's speech to the given language
+* stop translating me - End any auto-translation
+
+Source language is optional during translation. Microsoft will attempt to detect the source language if none is supplied.
+
+## 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-translation.rb

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

data/lib/lita/handlers/msTranslator.rb

@@ -0,0 +1,101 @@
+require 'json'
+
+class MSTranslator
+  OAUTH_URI = "https://datamarket.accesscontrol.windows.net/v2/OAuth2-13"
+  API_URI = "https://api.microsofttranslator.com/V2/Ajax.svc/"
+
+  REST_LANGUAGES = "GetLanguagesForTranslate"
+  REST_DETECTION = "Detect"
+  REST_TRANSLATE = "Translate"
+
+  def initialize(clientId, clientSecret, http, redis)
+    @clientId = clientId
+    @clientSecret = clientSecret
+    @http = http
+    @redis = redis
+  end
+
+  def grabAccessToken()
+    result = @http.post(
+      OAUTH_URI,
+      client_id: @clientId,
+      client_secret: @clientSecret,
+      scope: "http://api.microsofttranslator.com",
+      grant_type: "client_credentials"
+    )
+    if result.status == 200
+      raw = JSON.parse(result.body)
+      @redis.set("token", raw["access_token"])
+      @redis.set("start", Time.now)
+      @redis.set("expiry", raw["expires_in"])
+      true
+    else
+      false
+    end
+  end
+
+  def staleToken?()
+    start = @redis.get("start")
+    expiry = @redis.get("expiry")
+    if start.nil? || (Time.parse(start) + expiry.to_i) < Time.now
+      return true
+    end
+    false
+  end
+
+  def apiSuccess?(result)
+    if result.status != 200
+      false
+    else
+      /ID=\d{4}\.V2_Json\.(\w+)\.\w{8}/.match(result.body).nil?
+    end
+  end
+
+  def languages()
+    result = @http.get do |req|
+      req.url API_URI+REST_LANGUAGES
+      req.headers['Authorization'] = "Bearer "+@redis.get("token")
+    end
+    if apiSuccess?(result)
+      TranslationResult.new(
+        true,
+        JSON.parse(result.body.slice(3..result.body.length)).join(",")
+      )
+    else
+      TranslationResult.new(
+        false,
+        result.body.slice(3..result.body.length)
+      )
+    end
+  end
+
+  def detect(text)
+    result = @http.get do |req|
+      req.url API_URI+REST_DETECTION, :text => text
+      req.headers['Authorization'] = "Bearer "+@redis.get("token")
+    end
+    TranslationResult.new(apiSuccess?(result), result.body.slice(3..result.body.length))
+  end
+
+  def translate(text, to, from=nil)
+    result = @http.get do |req|
+      req.url API_URI+REST_TRANSLATE, :text => text, :from => from, :to => to, :contentType => "text/plain"
+      req.headers['Authorization'] = "Bearer "+@redis.get("token")
+    end
+    TranslationResult.new(apiSuccess?(result), result.body.slice(3..result.body.length))
+  end
+
+end
+
+class TranslationResult
+  def initialize(success, message)
+    @success = success
+    @message = message
+  end
+  def success
+    @success
+  end
+  def message
+    @message
+  end
+end

data/lib/lita/handlers/translation.rb

@@ -0,0 +1,116 @@
+require "lita/handlers/msTranslator"
+
+module Lita
+  module Handlers
+    class Translation < Handler
+      config :client_id, type: String, required: true
+      config :client_secret, type: String, required: true
+
+      def tokenAvailable?(response, translator)
+        if translator.staleToken?
+          response.reply(t("replies.access_token.attempt"))
+          if translator.grabAccessToken
+            response.reply(t("replies.access_token.success"))
+            return true
+          else
+            response.reply(t("replies.access_token.fail"))
+            return false
+          end
+        else
+          return true
+        end
+      end
+
+      route /^languages$/, :languages, help: {
+        t("help.languages.usage") => t("help.languages.description")
+      }
+      def languages(response)
+        translator = MSTranslator.new(config.client_id, config.client_secret, http, redis)
+        if tokenAvailable?(response, translator)
+          result = translator.languages
+          if result.success
+            response.reply(t("replies.languages"))
+          else
+            response.reply(t("replies.failure"))
+          end
+          response.reply(result.message)
+        end
+      end
+
+      route /^determine '(.+)'$/, :determine, help: {
+        t("help.determine.usage") => t("help.determine.description")
+      }
+      def determine(response)
+        translator = MSTranslator.new(config.client_id, config.client_secret, http, redis)
+        if tokenAvailable?(response, translator)
+          result = translator.detect(response.matches.pop[0])
+          if result.success
+            code = result.message
+            response.reply(t("replies.determine", code: code))
+          else
+            response.reply(t("replies.failure"))
+            response.reply(result.message)
+          end
+        end
+      end
+
+      route /^translate me to (\w+)( from (\w+))?$/, :auto_start, help: {
+        t("help.auto_start.usage") => t("help.auto_start.description")
+      }
+      def auto_start(response)
+        translator = MSTranslator.new(config.client_id, config.client_secret, http, redis)
+        if tokenAvailable?(response, translator)
+          to = response.matches.flatten[0]
+          from = response.matches.flatten[2]
+          redis.set(response.user.id+":to", to)
+          redis.set(response.user.id+":from", from)
+          response.reply(t("replies.auto_start", code: to, user: response.user.name))
+        end
+      end
+
+      route /^stop translating me$/, :auto_end, help: {
+        t("help.auto_end.usage") => t("help.auto_end.description")
+      }
+      def auto_end(response)
+        redis.del(response.user.id+":to")
+        redis.del(response.user.id+":from")
+        response.reply(t("replies.auto_end", user: response.user.name))
+      end
+
+      route /^translate '(.+)' to (\w+)( from (\w+))?$/, :tran_lang, help: {
+        t("help.translate.usage") => t("help.translate.description")
+      }
+      def tran_lang(response)
+        translator = MSTranslator.new(config.client_id, config.client_secret, http, redis)
+        if tokenAvailable?(response, translator)
+          text = response.matches.flatten[0]
+          to = response.matches.flatten[1]
+          from = response.matches.flatten[3]
+          result = translator.translate(text, to, from)
+          if result.success
+            response.reply(t("replies.translate", translated: result.message))
+          else
+            response.reply(t("replies.failure"))
+            response.reply(result.message)
+          end
+        end
+      end
+
+      route /./, :monitor
+      def monitor(response)
+        if(!redis.get(response.user.id+":to").nil?)
+          translator = MSTranslator.new(config.client_id, config.client_secret, http, redis)
+          to = redis.get(response.user.id+":to")
+          from = redis.get(response.user.id+":from")
+          result = translator.translate(response.message.body, to, from)
+          if result.success
+            response.reply(t("replies.auto", user: response.user.name, translated: result.message))
+          end
+        end
+      end
+
+    end
+
+    Lita.register_handler(Translation)
+  end
+end

data/lita-translation.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-translation"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Michael Chua"]
+  spec.email         = ["chua.mbt@gmail.com"]
+  spec.description   = %q{Language translation plugin that uses Microsoft's Translator API. }
+  spec.summary       = %q{Language translation plugin that uses Microsoft's Translator API. }
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+  spec.homepage      = "https://github.com/chua-mbt/lita-translation"
+
+  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.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,32 @@
+en:
+  lita:
+    handlers:
+      translation:
+        help:
+          languages:
+            usage: "languages"
+            description: "List language codes supported by Microsoft's Translator API"
+          determine:
+            usage: "determine '[text]'"
+            description: "Determine language of the given text"
+          translate:
+            usage: "translate '[text]' to [code] (from [code])"
+            description: "Translate the given text from one language to another"
+          auto_start:
+            usage: "translate me to [code] (from [code])"
+            description: "Begin auto-translating all user's speech to the given language"
+          auto_end:
+            usage: "stop translating me"
+            description: "End any auto-translation"
+        replies:
+          access_token:
+            attempt: "Requesting an access token..."
+            success: "Got an access token for Microsoft's Translator API!"
+            fail: "Could not get an access token!"
+          languages: "The following language codes are supported: "
+          determine: "Language code: %{code}"
+          translate: "Translation: %{translated}"
+          failure: "API Failure: "
+          auto_start: "Beginning translation to %{code} for %{user}."
+          auto: "%{user}: %{translated}."
+          auto_end: "Ceasing translation for %{user}."

data/spec/lita/handlers/translation_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::Handlers::Translation, lita_handler: true do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-translation"
+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,130 @@
+--- !ruby/object:Gem::Specification
+name: lita-translation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Chua
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: 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
+description: 'Language translation plugin that uses Microsoft''s Translator API. '
+email:
+- chua.mbt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-translation.rb
+- lib/lita/handlers/msTranslator.rb
+- lib/lita/handlers/translation.rb
+- lita-translation.gemspec
+- locales/en.yml
+- spec/lita/handlers/translation_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/chua-mbt/lita-translation
+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.6
+signing_key: 
+specification_version: 4
+summary: Language translation plugin that uses Microsoft's Translator API.
+test_files:
+- spec/lita/handlers/translation_spec.rb
+- spec/spec_helper.rb