c3po 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 af83
+
+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,67 @@
+C3PO
+====
+
+Ruby translator client. Actual provider :
+
+ * Google Translate
+ * Bing Translate
+
+Ruby 1.9.2 is strongly recommanded.
+
+
+Dependency
+----------
+
+`libcurl4-gnutls-dev`
+
+
+Installation
+------------
+
+Install it with rubygems:
+
+``` ruby
+gem install c3po
+```
+
+With bundler, add it to your `Gemfile`:
+
+``` ruby
+gem "c3po", "~>0.1"
+```
+
+
+Usage
+-----
+
+``` ruby
+# Define a provider
+C3po.configure do |config|
+  config.provider = :google
+  config.google_api_key = "MYAPIKEY"
+end
+
+# Define several provider
+C3po.configure do |config|
+  config.provider = [:google, :bing]
+  config.google_api_key = "MYAPIKEY"
+  config.bing_api_key = "MYAPIKEY"
+end
+
+# Let's translate
+translator = C3po.new('I want this droid to be translated')
+translator.translate(:en, :fr) # =>
+translator.is # => :en
+translator.is?(:de) # => false
+```
+
+Todo
+----
+
+* More specs
+* Use it
+
+Copyright
+---------
+
+See LICENSE for further details.

data/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "c3po"

data/lib/c3po.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+class C3po
+
+  class NoGivenString < Exception; end
+  class NoGivenProvider < Exception; end
+
+  autoload :Translator,      'c3po/translator'
+  autoload :Client,          'c3po/client'
+
+  module Translator
+    autoload :Configuration, 'c3po/translator/configuration'
+    autoload :Result,        'c3po/translator/result'
+    autoload :Google,        'c3po/translator/google'
+    autoload :Bing,          'c3po/translator/bing'
+  end
+
+  include Client
+  include C3po::Translator
+
+  attr_reader :base_url, :to_be_translated, :errors, :result, :adaptor
+
+  # Define a translator object.
+  #
+  # @example
+  #   translator = C3po.new('to be translated')
+  #   translator.translate(:fr, :en)
+  #
+  # @param [ String ] string String on witch we will work
+  #
+  # @since 0.0.1
+  #
+  def initialize(to_be_translated = nil)
+    raise NoGivenString if to_be_translated.nil?
+    @to_be_translated = to_be_translated
+    select_provider
+    @base_url = self.class.base_url
+    @result = C3po::Translator::Result.new
+    @errors = []
+  end
+
+  class << self
+
+    attr_accessor :base_url
+
+    # Define a configure block.
+    #
+    # Delegates to C3po::Translator::Configuration
+    #
+    # config.provider can be an Array. In this case,
+    # provider will be randomly choosen from it.
+    #
+    # @example Define the option.
+    #   C3po.configure do |config|
+    #     config.provider = :google
+    #     config.google_api_key = "MYAPIKEY"
+    #   end
+    #
+    # @param [ Proc ] block The block getting called.
+    #
+    # @since 0.0.1
+    #
+    def configure(&block)
+      C3po::Translator::Configuration.configure(&block)
+    end
+
+  end # self
+
+  private
+
+  # Include provider based on configuration
+  #
+  # @since 0.0.1
+  #
+  def select_provider
+    case provider
+    when :google
+      @adaptor = Google.new @to_be_translated
+    when :bing
+      @adaptor = Bing.new @to_be_translated
+    else
+      raise NoGivenProvider
+    end
+  end
+
+  # Choose provider based on configuration
+  #
+  # If Configuration.provider is an Array,
+  # take a random value from as provider
+  #
+  # @since 0.0.1
+  #
+  def provider
+    provider = Configuration.provider
+    @provider ||= provider.is_a?(Array) ? provider.sample : provider
+  end
+
+end # C3po

data/lib/c3po/client.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+require 'typhoeus'
+
+class C3po
+  module Client
+
+    # Query a web service.
+    #
+    # Returns a translated string or an array of errors.
+    #
+    # @example
+    #   fetch {:key => 'MYAPIKEY',
+    #          :q => 'Something to translate'
+    #         }
+    #
+    # @param [Hash] Query containing all the params.
+    #
+    # @return [String] Translated string.
+    #
+    # @since 0.0.1
+    #
+    def fetch(query)
+      request = set_request query
+      request.on_complete {|response| process_reponse response}
+
+      hydra = Typhoeus::Hydra.hydra
+      hydra.queue request
+      hydra.run
+
+      @response if @errors.empty?
+    end
+
+    private
+
+    # Create a Typhoeus request object.
+    #
+    # @example
+    #   set_request {:key => 'MYAPIKEY',
+    #                :q => 'Something to translate'
+    #               }
+    #
+    # @param [Hash] Query containing all the params.
+    #
+    # @return [Typhoeus::Request] Translated string.
+    #
+    # @since 0.0.1
+    #
+    def set_request(query)
+      Typhoeus::Request.new @adaptor.base_url, :params => query
+    end
+
+    # Process response.
+    #
+    # @example
+    #   process_reponse response
+    #
+    # @param [Typhoeus::Response] Typhoeus response object.
+    #
+    # @return [Typhoeus::Request] Translated string.
+    #
+    # @since 0.0.1
+    #
+    def process_reponse(response)
+      if response.success?
+        begin
+          @response = @adaptor.parse response.body
+        rescue
+          @errors << 'Invalid response'
+        end
+      elsif response.timed_out?
+        @errors << 'timeout'
+      else
+        @errors << "HTTP request failed: #{response.code}"
+      end
+    end
+
+  end # Client
+end # C3po

data/lib/c3po/translator.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+class C3po
+  module Translator
+
+    # Translate a string.
+    #
+    # @example
+    #   translator = C3po.new('translate')
+    #   translator.translate(:en, :fr)
+    #
+    # @param [ Symbol ] language to translate from
+    # @param [ Symbol ] language to translate to
+    #
+    # @return [String] the translated string
+    #
+    # @since 0.0.1
+    #
+    def translate(from, to)
+      @result.translation ||= fetch @adaptor.build_query(from, to)
+    end
+
+    # Grab languages list from provider.
+    #
+    # @example
+    #   translator = C3po.new('translate')
+    #   translator.languages
+    #
+    # @return [Array] the languages list
+    #
+    # @since 0.0.1
+    #
+    def languages
+      @result.languages ||= fetch @adaptor.build_languages_query
+    end
+
+    # Identify language.
+    #
+    # @example
+    #   translator = C3po.new('translate')
+    #   translator.is
+    #
+    # @return [String] the identified language
+    #
+    # @since 0.0.1
+    #
+    def is
+      @result.language ||= fetch @adaptor.build_detect_query
+    end
+
+    # Check language.
+    #
+    # @example
+    #   translator = C3po.new('translate')
+    #   translator.is? :fr
+    #
+    # @param [ Symbol ] language to check
+    #
+    # @return [Boolean]
+    #
+    # @since 0.0.1
+    #
+    def is?(language)
+      language.to_s == is
+    end
+
+  end #Translator
+end #C3po

data/lib/c3po/translator/bing.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+require 'nokogiri'
+
+class C3po
+  module Translator
+    class Bing
+      attr_reader :base_url
+
+      def initialize(to_be_translated)
+        @to_be_translated = to_be_translated
+        @default = {
+          :appId => C3po::Translator::Configuration.bing_api_key,
+        }
+      end
+
+      # Build a query for the Bing Translate api.
+      #
+      # @example
+      #   build_query :fr, :en
+      #
+      # @param [Symbol] Language to be translated from.
+      #         [Symbol] Language to be translated to.
+      #
+      # @return [Hash] Hash of param.
+      #
+      # @since 0.0.1
+      #
+      def build_query(from, to)
+        @base_url = 'http://api.microsofttranslator.com/V2/Http.svc/Translate'
+        @default.merge({:text => @to_be_translated,
+                        :from => from.to_s,
+                        :to => to.to_s
+                      })
+      end
+
+      def build_languages_query
+        @base_url = 'http://api.microsofttranslator.com/V1/Http.svc/GetLanguages'
+        @default
+      end
+
+      # Build a query for detect method of Bing Translate api.
+      #
+      # @example
+      #   build_detect_query
+      #
+      # @return [Hash] Hash of param.
+      #
+      # @since 0.0.1
+      #
+      def build_detect_query
+        @base_url = 'http://api.microsofttranslator.com/V2/Http.svc/Detect'
+        @default.merge({:text => @to_be_translated})
+      end
+
+      # Parse xml response from Bing webservice.
+      #
+      # XML is serious business.
+      #
+      # @example
+      #   parse my_xml
+      #
+      # @param [String] response Json representation
+      #
+      # @return [String] Translated string.
+      #
+      # @since 0.0.1
+      #
+      def parse(response)
+        xpath = Nokogiri::XML(response).xpath('/')
+        return xpath.text unless xpath.children.empty?
+        response.to_s.split("\r\n")
+      end
+    end #Bing
+  end # Translator
+end #C3po

data/lib/c3po/translator/configuration.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+class C3po
+  module Translator
+
+    class Configuration
+
+      class << self
+
+        attr_accessor :provider, :google_api_key, :bing_api_key
+
+        # Define a configure block.
+        #
+        # config.provider can be an Array. In this case,
+        # provider will be randomly choosen from it.
+        #
+        # @example Define the option.
+        #   C3po.configure do |config|
+        #     config.provider = :google
+        #     config.google_api_key = "MYAPIKEY"
+        #   end
+        #
+        # @param [ Proc ] block The block getting called.
+        #
+        # @since 0.0.1
+        #
+        def configure(&block)
+          yield self
+        end
+
+      end # self
+    end # Configuration
+  end # Translator
+end #C3po

data/lib/c3po/translator/google.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+require 'yajl'
+
+class C3po
+  module Translator
+    class Google
+      attr_reader :base_url
+
+      def initialize(to_be_translated = nil)
+        @to_be_translated = to_be_translated
+        @default = {
+          :key => C3po::Translator::Configuration.google_api_key
+        }
+      end
+
+      # Build a query for Google Translate api.
+      #
+      # @example
+      #   build_query :fr, :en
+      #
+      # @param [Symbol] Language to be translated from.
+      #         [Symbol] Language to be translated to.
+      #
+      # @return [Hash] Hash of param.
+      #
+      # @since 0.0.1
+      #
+      def build_query(from, to)
+        @base_url = 'https://www.googleapis.com/language/translate/v2'
+        @default.merge({:q => @to_be_translated,
+                        :source => from.to_s,
+                        :target => to.to_s
+                      })
+      end
+
+      # Build a query for languages method of Google Translate api.
+      #
+      # @example
+      #   build_languages_query
+      #
+      # @return [Hash] Hash of param.
+      #
+      # @since 0.0.1
+      #
+      def build_languages_query
+        @base_url = 'https://www.googleapis.com/language/translate/v2/languages'
+        @default
+      end
+
+      # Build a query for detect method of Google Translate api.
+      #
+      # @example
+      #   build_detect_query
+      #
+      # @return [Hash] Hash of param.
+      #
+      # @since 0.0.1
+      #
+      def build_detect_query
+        @base_url = 'https://www.googleapis.com/language/translate/v2/detect'
+        @default.merge({:q => @to_be_translated})
+      end
+
+      # Parse json response from Google webservice.
+      #
+      # @example
+      #   parse my_json
+      #
+      # @param [String] response Json representation
+      #
+      # @return [String] Translated string.
+      # @return [String] Detected language.
+      # @return [Array]  Languages list.
+      #
+      # @since 0.0.1
+      #
+      def parse(response)
+        data = Yajl::Parser.parse(response)['data']
+        if data['translations']
+          data['translations'][0]['translatedText']
+        elsif data['detections']
+          data['detections'][0][0]["language"]
+        else
+          data['languages'].inject([]) {|languages, value| languages << value['language']}
+        end
+      end
+
+    end #Google
+  end # Translator
+end #C3po

data/lib/c3po/translator/result.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+class C3po
+  module Translator
+    class Result < Struct.new(:translation, :language, :languages)
+    end # Result
+  end # Translator
+end # C3po

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: c3po
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- af83
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20830440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *20830440
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &20829960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *20829960
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &20829500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *20829500
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &20829040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *20829040
+description: Ruby translation client
+email: jboyer@af83.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- Gemfile
+- lib/c3po.rb
+- lib/c3po/translator/configuration.rb
+- lib/c3po/translator/bing.rb
+- lib/c3po/translator/google.rb
+- lib/c3po/translator/result.rb
+- lib/c3po/client.rb
+- lib/c3po/translator.rb
+- init.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Ruby translation client
+test_files: []