cinch-translate 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cinch-translate.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (C) 2011 by Arthur Chiu
+
+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,76 @@
+Cinch-Translate
+===========
+
+The Cinch Translate Plugin. Translate your messages via the Google
+Translate API! 
+
+Installation
+---------------------
+
+if you haven't already...
+
+    $ gem install cinch
+    
+then install this gem.
+
+    $ gem install cinch-translate
+
+Installation and Setup
+----------
+
+#### Configuration ####
+
+  * :api_key - Your Google Translate API Key
+  * :to      - The language you want to translate to(using codemap key, this is for auto translate). default is 'en'
+  * :from    - The language you want to tranlsate from(using codemap key, or can be set to auto to auto-discover). default is 'auto'
+  * :auto    - turn auto translate on or off. default is off
+
+#### Commands ####
+
+  * !translate [codemap] [message]         - translate the given message to the language codemap 
+  * !translate-from [from] [to] [message]      - translate from the given codemape to the to codemap
+  * !languages?                    - List all the available languages
+  * !codemap [language]            - return the codemap for the given language
+  * !auto_translate                - toggle auto translate on or off
+  * !auto_translate to [codemap]   - set the to language for auto translate 
+  * !auto_translate from [codemap] - set the from language for auto translate
+  
+## Integration with Cinch ##
+
+It's simple. follow the guide on cinch or do something like:
+    
+    # mybot.rb
+    require 'cinch'
+    require 'cinch/plugins/translate'
+
+    bot = Cinch::Bot.new do
+      configure do |c|
+        c.server           = "irc.freenode.net"
+        c.nick             = "cinch"
+        c.channels         = ["#padrino"]
+        c.plugins.plugins  = [Cinch::Plugins::Memo::Base]
+        c.plugins.options[Cinch::Plugins::Translate][:api_key] = 'your_api_key"
+        c.plugins.options[Cinch::Plugins::Translate][:to]      = 'fr'
+        c.plugins.options[Cinch::Plugins::Translate][:from]    = 'en'
+        c.plugins.options[Cinch::Plugins::Translate][:auto]    = true
+      end
+
+    end
+
+    bot.start
+
+Finally, run your bot.
+
+    ruby -rubygems mybot.rb
+
+And there you go!
+
+
+TODO
+-----
+
+  * Maybe add bot as middleman in conversation
+  * Come up with more cool ideas.
+
+
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/cinch-translate.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cinch/plugins/translate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cinch-translate"
+  s.version     = Cinch::Translate::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Arthur Chiu"]
+  s.email       = ["mr.arthur.chiu@gmail.com"]
+  s.homepage    = "http://arthurchiu.tumblr.com"
+  s.summary     = %q{Cinch Bot translation plugin}
+  s.description = %q{Cinch Bot translation plugin powered by Google Translate}
+
+  s.rubyforge_project = "cinch-translate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency 'cinch', '~>1.1.1'
+  s.add_dependency 'to_lang'
+  s.add_development_dependency 'riot',  '~>0.12.0'
+  s.add_development_dependency 'mocha', '~>0.9.10'
+end

data/lib/cinch/plugins/translate.rb

@@ -0,0 +1,73 @@
+require 'cinch'
+require 'to_lang'
+
+module Cinch
+  module Plugins
+    class Translate
+      include Cinch::Plugin
+
+      match %r{translate (.+?) (.+)},              :method => :translate
+      match %r{translate\-from (.+?) (.+?) (.+)},   :method => :translate_from
+      match "languages?",                          :method => :languages
+      match %r{codemap (.+)},                      :method => :codemap
+      match "auto_translate",                      :method => :auto_translate
+      match %r{auto\_translate to (.+)},           :method => :auto_to
+      match %r{auto\_translate from (.+)},         :method => :auto_from
+
+      listen_to :channel
+
+      def initialize(*args)
+        super
+        @auto = config[:auto] || false
+        @from = config[:from] || nil
+        @to   = config[:to]   || 'en'
+        ::ToLang.start config[:api_key]
+      end
+
+      def listen(m)
+        return if m.message =~ /^!/ # ignore any commands
+        if @auto
+          if @from
+            translation = m.message.translate(@to, :from => @from) rescue "That's not a valid language."
+          else
+            translation = m.message.translate(@to) rescue "That's not a valid language."
+          end
+          m.reply "#{m.user.nick}: #{translation}"
+        end
+      end
+
+      def auto_translate(m)
+        msg = (@auto = !@auto ? "on" : "off")
+        m.reply "Auto Translate is #{msg}"
+      end
+
+      def auto_to(m, lang)
+        m.reply "To Language set to #{@to = lang}"
+      end
+
+      def auto_from(m, lang)
+        @from = (lang == 'auto' ? nil : lang)
+        m.reply "From Language set to #{lang}"
+      end
+
+      def translate(m, lang, message)
+        translation = message.translate(lang) rescue "That's not a valid language."
+        m.reply translation
+      end
+
+      def translate_from(m, from, to, message)
+        translation = message.translate(to, :from => from) rescue "That's not a valid language."
+        m.reply translation
+      end
+
+      def languages(m)
+        m.reply ::ToLang::CODEMAP.keys.join(',')
+      end
+
+      def codemap(m, lang)
+        code = ::ToLang::CODEMAP[lang] || 'No code exists for that language.'
+        m.reply code
+      end
+    end
+  end
+end

data/lib/cinch/plugins/translate/version.rb

@@ -0,0 +1,5 @@
+module Cinch
+  module Translate
+    VERSION = "0.0.1"
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'riot'
+require 'mocha'
+require File.expand_path('../../lib/cinch/plugins/translate',__FILE__)
+
+class Riot::Situation
+  include Mocha::API
+end
+
+class Riot::Context
+  # Turn off bot register hook
+  def dont_register!
+    setup { Cinch::Plugins::Translate.stubs(:__register_with_bot).with(any_parameters).returns(true) }
+  end
+end
+
+class Object
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+end
+

data/test/translate_test.rb

@@ -0,0 +1,102 @@
+require File.expand_path('../teststrap',__FILE__)
+
+context "Translate" do
+  dont_register!
+  setup { @bot = mock() }
+
+  helper :base do
+    Cinch::Plugins::Translate.any_instance.stubs(:config).returns({:api_key => '12345'})
+    ToLang.expects(:start).with('12345').returns(true)
+    Cinch::Plugins::Translate
+  end
+
+  context "#initialize" do
+    setup { base.new(@bot) }
+    asserts_topic.assigns :auto
+    asserts_topic.assigns :to
+  end
+
+  context "#translate" do
+    context "with language" do
+      asserts 'that it translates' do
+        @text.expects(:translate).with('en').returns('hello')
+        @m.expects(:reply).with('hello').returns(true)
+        base.new(@bot).translate(@m,'en',@text)
+      end
+    end
+
+    context "with invalid language" do
+      asserts 'that it returns a message' do
+        @text.expects(:translate).with("baka").raises(RuntimeError)
+        @m.expects(:reply).with("That's not a valid language.").returns(true)
+        base.new(@bot).translate(@m, 'baka', @text)
+      end
+    end
+  end
+
+  context "#translate_from" do
+    context "with language" do
+      asserts 'that its translates' do
+        @text.expects(:translate).with('fr',:from=>'en').returns('hello')
+        @m.expects(:reply).with('hello').returns(true)
+        base.new(@bot).translate_from @m, 'en', 'fr', @text
+      end
+    end
+
+    context "with invalid langauge" do
+      asserts 'that it returns a message' do
+        @text.expects(:translate).with('baka').raises(RuntimeError)
+        @m.expects(:reply).with("That's not a valid language.").returns(true)
+      end
+    end
+  end
+
+  context "#languages" do
+  
+    context "with no options" do
+      asserts "that it shows list" do
+        @m.expects(:reply).with(regexp_matches(/english/)).returns(true)
+        base.new(@bot).languages @m
+      end
+    end
+  end
+
+  context "#codemap" do
+
+    context "with language" do
+      asserts "that it shows code" do
+        @m.expects(:reply).with('en').returns(true)
+        base.new(@bot).codemap @m, 'english'
+      end
+    end
+
+    context "with no language" do
+      asserts "that it shows message" do
+        @m.expects(:reply).with('No code exists for that language.').returns(true)
+        base.new(@bot).codemap @m, 'bakaaa'
+      end
+    end
+  end
+
+  context "#auto_translate" do
+    
+    asserts "that it gets switched" do
+      @m.expects(:reply).with("Auto Translate is on").returns(true)
+      base.new(@bot).auto_translate @m
+    end
+  end
+
+  context "#auto_to" do
+    asserts 'that it assigns to language' do
+      @m.expects(:reply).with("To Language set to en").returns(true)
+      base.new(@bot).auto_to @m, 'en'
+    end
+  end
+
+  context "#auto_from" do
+    asserts 'that it assigns from language' do
+      @m.expects(:reply).with('From Language set to auto').returns(true)
+      base.new(@bot).auto_from @m, 'auto'
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: cinch-translate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cinch
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: to_lang
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: riot
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 0
+        version: 0.12.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 10
+        version: 0.9.10
+  type: :development
+  version_requirements: *id004
+description: Cinch Bot translation plugin powered by Google Translate
+email: 
+- mr.arthur.chiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cinch-translate.gemspec
+- lib/cinch/plugins/translate.rb
+- lib/cinch/plugins/translate/version.rb
+- test/teststrap.rb
+- test/translate_test.rb
+has_rdoc: true
+homepage: http://arthurchiu.tumblr.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cinch-translate
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Cinch Bot translation plugin
+test_files: 
+- test/teststrap.rb
+- test/translate_test.rb