transfluent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5183e0b9ea8f665f492a6159975ced1985bdae0f
+  data.tar.gz: 07e6914be61014a7b9242eca63aa74f6263043bd
+SHA512:
+  metadata.gz: cb2ab465c0d87c5f8a7856a3c613da0d43b0d4abfeb610bc78cadd37db1dbb8a6982624cd469f46074256a60893c6b6b7710facc68ba15e6d8c3f98e1636648d
+  data.tar.gz: d4bef9a5e6b2e3a66685d349c8ff817501e54db24236a2930d2c3a66cb19fc4a949759a1c6af317c907502663f1488561a9aeb5a23548a4f8ddb5f4abf0d9e75

data/lib/transfluent.rb

@@ -0,0 +1,4 @@
+require 'transfluent/api_error'
+require 'transfluent/api_helper'
+require 'transfluent/language'
+require 'transfluent/api'

data/lib/transfluent/api.rb

@@ -0,0 +1,82 @@
+require 'transfluent/transfluent_text_api'
+require 'transfluent/transfluent_file_api'
+
+module Transfluent
+  class Api
+    include ApiHelper
+    include TransfluentTextApi 
+    include TransfluentFileApi
+
+    # The authentication token associated with this instance
+    #
+    # @return [string]
+    attr_accessor :auth_token
+    
+    # Creates a new instance if Transfluent Api
+    #
+    # @param [Hash] default_settings default settings for some calls
+    # @option default_settings [String] auth_token your auth token
+    # @option default_settings [String] group default text group
+    # @option default_settings [Transfluent::Language] language default text and file source language
+    def initialize default_settings = {}
+      @auth_token = default_settings[:auth_token]
+      @defaults = default_settings
+
+      if @defaults.has_key? :api_root
+        @_ROOT_URL = @defaults.delete :api_root
+      end
+    end
+
+    # Get the default text group
+    #
+    # @return [string]
+    def default_group
+      @defaults[:group]
+    end
+
+    # Set the default text group
+    #
+    # @param [string] value new default group for texts
+    def default_group=(value)
+      @defaults[:group] = value
+    end
+  
+    # Get the default language
+    #
+    # @return [Transfluent::Language]
+    def default_language
+      @defaults[:language]
+    end
+
+    # Set the default language
+    #
+    # @param [Transfluent::Language] value new default language for texts
+    def default_language=(value)
+      @defaults[:language] = value
+    end
+
+    # Echoes back the parameter prepended with Hello
+    #
+    # @param world [string] any text
+    # @return [string] "Hello " + world
+    def hello world
+      response = Net::HTTP.get(api_uri("/hello/" + world))
+  
+      parse_response response
+    end
+  
+    # Authenticate against the backend
+    #
+    # @param [string] email Email address
+    # @param [string] password Your password
+    #
+    # @return [string] authentication token
+    def authenticate email, password
+      uri = api_uri('authenticate')
+      uri.query = URI.encode_www_form({'email' => email, 'password' => password})
+      response = parse_response(Net::HTTP.get(uri))
+  
+      @auth_token = response[:token].to_s 
+    end
+  end
+end

data/lib/transfluent/api_error.rb

@@ -0,0 +1,7 @@
+module Transfluent
+  class ApiError < Exception
+    def initialize type, message
+      super "Backend error: %s -- %s" % [ type, message ]
+    end
+  end
+end

data/lib/transfluent/api_helper.rb

@@ -0,0 +1,61 @@
+require 'net/http'
+require 'json'
+
+module Transfluent
+  module ApiHelper
+    def api_uri method
+      method = '/' + method unless method[0] == '/'
+      url = @_ROOT_URL || 'https://transfluent.com/v2' 
+      URI(url + method)
+    end
+
+    def execute_get uri, query = nil
+      unless query.nil?
+        uri.query = URI.encode_www_form query
+      end
+
+      parse_response(Net::HTTP.get(uri))
+    end
+
+    def execute_post uri, data
+      parse_response(Net::HTTP.post_form(uri, data).body)
+    end
+
+    def parse_response response
+      if response.is_a? String then
+        json = JSON.parse(response)
+      else
+        json = response
+      end
+  
+      if json["status"] == "OK" 
+        response = json['response']
+
+        if response.is_a? Hash
+          symbolize_hash response
+        elsif response.is_a? Array
+          symbolize_array response
+        else
+          response
+        end
+      elsif json["status"] == "ERROR"
+        raise Transfluent::ApiError.new json['error']['type'], json['error']['message']
+      end
+    end
+
+    # Convert string keys in a hash to symbols recursively
+    def symbolize_hash hash
+      hash.inject({}) do |memo,(k,v)| 
+        memo[(k.to_sym rescue k) || k] = if v.is_a? Hash then symbolize_hash v else v end
+        memo
+      end 
+    end
+
+    def symbolize_array array
+      array.inject([]) do |memo, v|
+        memo.push(if v.is_a? Hash then symbolize_hash v else v end)
+        memo
+      end
+    end
+  end
+end

data/lib/transfluent/language.rb

@@ -0,0 +1,52 @@
+
+module Transfluent
+  
+  # Represents a language that can be identified by an IETF language tag
+  # or Transfluent specific id
+  class Language
+
+    attr_reader :id, :code, :name
+
+    # Get an instance of language by code
+    #
+    # @param [string] code code for language, 'en-us', 'en-gb' etc.
+    # 
+    # @return [Language]
+    def self.get code
+      Language.fetch if $languages_by_code.nil?
+
+      $languages_by_code[code]
+    end
+
+    def self.get_by_id id
+      $languages_by_id[id]
+    end
+
+    def initialize id, code, name
+      @id = id.to_i
+      @code = code
+      @name = name
+    end
+
+    private
+
+    def self.fetch
+      api = Object.new
+      api.extend(ApiHelper)
+
+      uri = api.api_uri('languages')
+
+      response = api.execute_get(uri)
+
+      $languages_by_code = {}
+      $languages_by_id = {}
+      response.each do |item|
+        item.each do |id, lang|
+          $languages_by_code[lang[:code]] = Language.new lang[:id], lang[:code], lang[:name]
+          $languages_by_id[lang[:id]] = $languages_by_code[lang[:code]]
+        end
+      end
+    end
+  end
+  
+end

data/lib/transfluent/transfluent_file_api.rb

@@ -0,0 +1,150 @@
+require 'base64'
+
+module Transfluent
+  # File types supported by the backend
+  module FileType
+    IOS_RESOURCE = 'iOS-strings'
+    ANDROID_RESOURCE = 'Android-strings'
+    ANDROID_ARRAYS_RESOURCE = 'Android-arrays'
+    MOOTOOLS_LOCALE_RESOURCE = 'MooTools-locale'
+    JAVASCRIPT_RESOURCE = 'js-file'
+    SYMBIAN_TS_RESOURCE = 'Symbian-TS'
+    WP_RESX_RESOURCE = 'WP-RESX'
+    PROPERTIES_RESOURCE = 'Properties-file'
+    YAML_RESOURCE = 'YAML-file'
+    SIMPLE_XML_RESOURCE = 'XML-file'
+    GETTEXT_PO_RESOURCE = 'po-file'
+    SIMPLE_EXCEL_RESOURCE = 'Excel-file'
+  end
+
+  module TransfluentFileApi
+
+    # Saves a file to Transfluent
+    #
+    # @param [Hash] options
+    # @option options [String] identifier unique identifier for the file
+    # @option options [String] content_base64 base64 encoded content of the file. Has priority over file option.
+    # @option options [File, String] file File instance or file name to read. Used if content_base64 is not defined.
+    # @option options [String] type File type. Must be one of  FileType constants
+    # @option options ['UTF-8', 'UTF-16'] encoding endocing of the file. Defaults to UTF-8 
+    # @option options [Transfluent::Language] language language of the file. Defaults to  default_language
+    # @option options [true, false] save_only_data If you have previously translated content, 
+    #   you may save the translations by specifying this variable as true.
+    #   Remember to use the same file identifier as the source file has. Defaults to false
+    #
+    # @return [Hash] hash that contains count of saved words
+    def file_save options
+      uri = api_uri 'file/save'
+
+      opts = @defaults.merge({
+        :encoding => 'UTF-8'
+      }).merge options
+
+      data = {
+        'format' => opts[:encoding],
+        'identifier' => opts[:identifier],
+        'language' => opts[:language].id,
+        'save_only_data' => opts[:save_only_data],
+        'type' => opts[:type],
+        'token' => auth_token
+      }
+
+      if opts.has_key? :content_base64
+        data['content'] = opts[:content_base64]
+      elsif opts.has_key? :file
+        f = opts[:file]
+        f = File.new(f) unless f.is_a? File
+        
+        data['content'] = Base64.encode64 f.read
+      end
+
+      execute_post uri, data
+    end
+
+    # Read a file from Transfluent
+    #
+    # @param [String] identifier file identifier
+    # @param [Transfluent::Language] language language of the file. Defaults to default_language
+    #
+    # @return [Hash] a hash with keys :name and :contents
+    def file_read identifier, language = nil
+      language = default_language if language.nil?
+      uri = api_uri 'file/read'
+
+      query = {
+        'identifier' => identifier,
+        'language' => language.id,
+        'token' => auth_token
+      }
+
+      uri.query = URI.encode_www_form query
+      response = Net::HTTP.get_response uri
+
+      file = {
+        :name => response['Content-Disposition'].partition('=').last,
+        :contents => response.body
+      }
+    end
+    
+    # Query translation status for a file
+    #
+    # @param [String] identifier file identifier
+    # @param [Transfluent::Language] language language of the file. Defaults to  default_language
+    #
+    # @return [Hash] a hash with progress information
+    def file_status identifier, language = nil
+      language = default_language if language.nil?
+
+      uri = api_uri 'file/status'
+  
+      query = {
+        'identifier' => identifier,
+        'language' => language.id,
+        'token' => auth_token
+      }
+  
+      response = execute_get uri, query
+
+      response[:progress_str] = response[:progress]
+      response[:word_count] = response[:word_count].to_i
+      response[:word_count_translated] = response[:word_count_translated].to_i
+      response[:progress] = (response[:word_count_translated].to_f / response[:word_count]).round(4)
+      response[:word_count] = response[:word_count].to_i
+
+      response
+    end
+
+    # Order translation for a file
+    #
+    # @param [Hash] options
+    # @option options [String] identifier an unique identifier for a file
+    # @option options [Array] target_languages array of  Transfluent::Language to translate file to
+    # @option options [Transfluent::Language] language language of the file. Defaults to  default_language
+    # @option options [String] comment a context comment of the file for the translators
+    # @option options [1, 2, 3] level level of the translation. 1 == native, 2 == professional, 3 == pair of translators. Defaults to 3
+    # @option options [URI] callback_uri optional URI to post the translated file once complete.
+    #
+    # @return [Hash] a hash of word counts
+    def file_translate options
+      opts = @defaults.merge options
+
+      uri = api_uri 'file/translate'
+
+      data = {
+        'identifier' => opts[:identifier],
+        'language' => opts[:language].id,
+        'target_languages' => '[%s]' % opts[:target_languages].map { |lang| lang.id },
+        'token' => auth_token
+      }
+
+      data['comment'] = opts[:comment] if opts.has_key? :comment
+      data['level'] = opts[:level] if opts.has_key? :level
+      data['callback_url'] = opts[:callback_uri].to_s if opts.has_key? :callback_uri
+
+      execute_post(uri, data).inject({}) do |memo, (k, v)|
+        memo[k] = v.to_i
+        memo
+      end
+    end
+  end
+end

data/lib/transfluent/transfluent_text_api.rb

@@ -0,0 +1,166 @@
+module Transfluent
+  module TransfluentTextApi
+
+    # Add a single translatable text to Transfluent
+    #
+    # Any text added to the system can be queued for translation
+    # to any language.
+    #
+    # @param [string] text_id an unique id for the text
+    # @param [string] text the text to add
+    # @param [Hash] options optional options to create text with
+    # @option options [String] :group text group
+    # @option options [Transfluent::Language] :language text language
+    # @option options [true, false] :invalidate_translations invalidate previous translations for the text
+    # @option options [true, false] :is_draft is the text a draft
+    #
+    # @return [true]
+    def add_text text_id, text, options = {} 
+      opts = @defaults.merge({ 
+        :invalidate_translations => true,
+        :is_draft => false
+      }).merge(options)
+
+      group_id = opts[:group]
+      language = opts[:language]
+     
+      
+
+      uri = api_uri('text')
+      data = {
+        'text_id' => text_id,
+        'group_id' => group_id,
+        'language' => language.id,
+        'text' => text,
+        'invalidate_translations' => opts[:invalidate_translations] ? '1' : '0',
+        'is_draft' => opts[:is_draft] ? '1' : '0',
+        'token' => auth_token
+      }
+
+      execute_post(uri, data)
+    end
+
+    # Add multiple translatable texts to Transfluent
+    #
+    # Any text added to the system can be queued for translation
+    # to any language.
+    #
+    # @param [Hash] texts texts to create
+    # @option texts [Hash] :texts a hash of texts, where key is text id and value is the text to translate
+    # @option texts [String] :group text group
+    # @option texts [Transfluent::Language] :language text language
+    # @option texts [true, false] :invalidate_translations invalidate previous translations for the text
+    # @option texts [true, false] :is_draft is the text a draft
+    def add_texts texts
+      opts = @defaults.merge({ 
+        :invalidate_translations => true
+      }).merge(texts)
+
+      texts_to_translate = {}
+      texts[:texts].each do | text_id, text |
+        texts_to_translate['texts[%s]' % text_id] = text
+      end
+
+      group_id = opts[:group]
+      language = opts[:language]
+     
+      uri = api_uri('texts')
+      data = {
+        'group_id' => group_id,
+        'language' => language.id,
+        'invalidate_translations' => opts[:invalidate_translations] ? '1' : '0',
+        'token' => auth_token
+      }
+
+      response = execute_post(uri, data.merge(texts_to_translate))
+
+    end
+
+    # Request translation status for a text
+    #
+    # @param [string] text_id an unique id for the text
+    # @param [Hash] options optional options
+    # @option options [String] :group text group
+    # @option options [Transfluent::Language] :language text language
+    #
+    # @return [true, false]
+    def text_translated? text_id, options = {}
+      opts = @defaults.merge options
+
+      uri = api_uri 'text/status'
+      query = {
+        'text_id' => text_id,
+        'group_id' => opts[:group],
+        'language' => opts[:language].id,
+        'token' => auth_token
+      }
+
+      response = execute_get uri, query
+
+      response[:is_translated]
+    end
+
+    # Query text order status
+    #
+    # @param [Hash] options optional options
+    # @option options [String] :group text group. Using  default_group if not specified
+    # @option options [Fixnum] :limit number items to query. Defaults to 100
+    # @option options [Fixnum] :offset where to start querying. Defaults to 0
+    #
+    # @return [Hash]
+    def text_orders options = {}
+      opts = @defaults.merge({
+        :limit => 100,
+        :offset => 0
+      }).merge options
+
+      uri = api_uri 'texts/orders'
+      query = {
+        'group_id' => opts[:group],
+        'limit' => opts[:limit],
+        'offset' => opts[:offset],
+        'token' => auth_token
+      }
+
+      response = execute_get uri, query
+
+      response.inject([]) do |memo, v|
+        v[:source_language] = Transfluent::Language.get_by_id v[:source_language]
+        v[:target_language] = Transfluent::Language.get_by_id v[:target_language]
+        memo.push(v)
+      end
+    end
+
+    # Request a translation for submitted texts
+    #
+    # @param [Hash] options
+    # @option options [String] group_id the text group id. Defaults to  default_group
+    # @option options [Transfluent::Language] source_language source language of the texts. Defaults to  default_language
+    # @option options [Array] target_languages array of languages to translate the texts to
+    # @option options [1, 2, 3] level translator level. 1 == native, 2 == professional, 3 == pair of translators. Defaults to 2
+    # @option options [Fixnum] max_words maximum words to translate. Defaults to 1000.
+    # @option options [String] comment a comment for translators about these texts
+    # @option options [URI] callback_url a request will be made to this url when the translations are complete
+    # @option options [Array] texts array of text ids to translate
+    #
+    # @return [Hash] count of words ordered to translate
+    def texts_translate options
+      opts = @defaults.merge({}).merge options
+
+      uri = api_uri 'texts/translate'
+      query = {
+        'group_id' => opts[:group],
+        'source_language' => opts[:language].id,
+        'target_languages' => '[%s]' % opts[:target_languages].map { |lang| lang.id },
+        'texts' => '[%s]' % opts[:texts].map { |text_id| '{"id":"%s"}' % text_id }.join(','),
+        'token' => auth_token
+      }
+      query['level'] = opts[:level] unless opts[:level].nil?
+      query['max_words'] = opts[:max_words] unless opts[:max_words].nil?
+      query['comment'] = opts[:comment] unless opts[:comment].nil?
+      query['callback_url'] = opts[:callback_uri].to_s unless opts[:callback_uri].nil?
+
+      execute_get uri, query
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: transfluent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Transfluent Oy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Order human powered translations directly from your Ruby code!
+email: coders@transfluent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/transfluent.rb
+- lib/transfluent/api.rb
+- lib/transfluent/api_error.rb
+- lib/transfluent/api_helper.rb
+- lib/transfluent/transfluent_file_api.rb
+- lib/transfluent/transfluent_text_api.rb
+- lib/transfluent/language.rb
+homepage: https://github.com/Transfluent/Transfluent-Ruby
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Transfluent API client
+test_files: []
+has_rdoc: