tml 4.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c925403dfc55ba7c108ece9aa49eb9dd15fd6de3
+  data.tar.gz: 71be83bb7940f664062fc0a451fa37f6d03761e3
+SHA512:
+  metadata.gz: 71c46bc90a27f119d54e47ea4dd6b3b27380aea20b22862068d2a953da385152a635ac353b5656b25706e8dd531ceae691909fca95ca586fac5ed636d84db0e4
+  data.tar.gz: ab349cec99f87ac79a831d9d1e51318ccb0a213735949f8d0e99ab9d989daad01d46abd355f591a71232dc5480189894b9708da52f056a52c3cf9b79ed77cd15

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Translation Exchange, Inc
+
+MIT License
+
+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,243 @@
+<p align="center">
+  <img src="https://avatars0.githubusercontent.com/u/1316274?v=3&s=200">
+</p>
+
+TML Library For Ruby
+==================
+[![Build Status](https://travis-ci.org/translationexchange/tml-ruby.png?branch=master)](https://travis-ci.org/translationexchange/tml-ruby)
+[![Coverage Status](https://coveralls.io/repos/translationexchange/tml-ruby/badge.png?branch=master)](https://coveralls.io/r/translationexchange/tml-ruby?branch=master)
+[![Gem Version](https://badge.fury.io/rb/tml-ruby.png)](http://badge.fury.io/rb/tml)
+[![Dependency Status](https://www.versioneye.com/user/projects/54c1457a6c00352081000416/badge.svg?style=flat)](https://www.versioneye.com/user/projects/54c1457a6c00352081000416)
+
+TML library for Ruby is a set of classes that provide translation functionality for any Ruby based application.
+The library uses Translation Markup Language that allows you to encode complex language structures in simple, yet powerful forms.
+
+The library works in conjunctions with TranslationExchange.com service that provides machine and human translations for your application.
+In order to use the library, you should sign up at TranslationExchange.com, create a new application and copy the application key and secret.
+
+
+Rails Integration
+==================
+
+If you are planning on using TML in a Rails application, you should use tml-rails gem instead.
+
+https://github.com/translationexchange/tml-rails
+
+
+Installation
+==================
+
+To install the gem, use:
+
+```ssh
+gem install tml
+```
+
+
+Registering Your App
+===================================
+
+Before you can proceed with the integration, please register with http://translationexchange.com and create a new application.
+
+At the end of the registration process you will be given a key and a secret. You will need to enter them in the initialization function of the TML SDK.
+
+
+
+Usage
+==================
+
+The library can be invoked from the IRB. To use TML client you must require it, and instantiate the application with the key and secret of your app from translationexchange.com:
+
+```ruby
+irb(main)> require 'tml'
+irb(main)> app = Tml.session.init(KEY, SECRET)
+```
+
+Now you can use the application to get any language registered with your app:
+
+```ruby
+irb(main)> english = app.language('en-US')
+irb(main)> russian = app.language('ru')
+irb(main)> spanish = app.language('es')
+irb(main)> chinese = app.language('zh')
+```
+
+Simple example:
+
+```ruby
+irb(main)> english.translate('Hello World')
+=> "Hello World"
+irb(main)> russian.translate('Hello World')
+=> "Привет Мир"
+irb(main)> spanish.translate('Hello World')
+=> "Hola Mundo"
+irb(main)> chinese.translate('Hello World')
+=> "你好世界"
+```
+
+Using description context:
+
+```ruby
+irb(main)> russian.translate('Invite', 'An invitation')
+=> "Приглашение"
+irb(main)> russian.translate('Invite', 'An action to invite')
+=> "Пригласить"
+```
+
+Numeric rules with piped tokens:
+
+```ruby
+irb(main)> english.translate('You have {count||message}.', :count => 1)
+=> "You have 1 message."
+irb(main)> english.translate('You have {count||message}.', :count => 2)
+=> "You have 2 messages."
+
+irb(main)> russian.translate('You have {count||message}.', :count => 1)
+=> "У вас есть 1 сообщение."
+irb(main)> russian.translate('You have {count||message}.', :count => 2)
+=> "У вас есть 2 сообщения."
+irb(main)> russian.translate('You have {count||message}.', :count => 5)
+=> "У вас есть 5 сообщений."
+```
+
+Gender rules:
+
+```ruby
+irb(main)> user = {:gender => :female, :name => "Anna"}
+irb(main)> english.translate('{user} updated {user| his, her} profile.', :user => {:object => user, :attribute => :name})
+=> "Anna updated her profile."
+
+irb(main)> russian.translate('{user} updated {user| his, her} profile.', :user => {:object => user, :attribute => :name})
+=> "Anna обновила свой профиль."
+
+irb(main)> user = {:gender => :male, :name => "Michael"}
+irb(main)> english.translate('{user} updated {user| his, her} profile.', :user => {:object => user, :attribute => :name})
+=> "Michael updated his profile."
+
+irb(main)> russian.translate('{user} updated {user| his, her} profile.', :user => {:object => user, :attribute => :name})
+=> "Michael обновил свой профиль."
+```
+
+Gender rules with language cases:
+
+```ruby
+irb(main)> actor = {:gender => :female, :name => "Анна"}
+irb(main)> target = {:gender => :male, :name => "Михаил"}
+irb(main)> russian.translate('{actor} sent {target} a gift.', :actor => {:object => actor, :attribute => :name}, :target => {:object => target, :attribute => :name})
+=> "Анна послала подарок Михаилу."
+irb(main)> russian.translate('{actor} sent {target} a gift.', :actor => {:object => target, :attribute => :name}, :target => {:object => actor, :attribute => :name})
+=> "Михаил послал подарок Анне."
+```
+
+Decoration tokens:
+
+```ruby
+irb(main)> english.translate("[bold: This text] should be bold", :bold => lambda{|text| "<strong>#{text}</strong>"})
+=> "<strong>This text</strong> should be bold"
+irb(main)> russian.translate("[bold: This text] should be bold", :bold => lambda{|text| "<strong>#{text}</strong>"})
+=> "<strong>Этот текст</strong> должны быть жирным"
+```
+
+Nested decoration tokens:
+
+```ruby
+irb(main)> english.translate("[bold: Bold text [italic: with italic text]] together", :bold => "<b>{$0}</b>", :italic => "<i>{$0}</i>")
+=> "<b>Bold text <i>with italic text</i></b> together"
+irb(main)> russian.translate("[bold: Bold text [italic: with italic text]] together", :bold => "<b>{$0}</b>", :italic => "<i>{$0}</i>")
+=> "<b>Жирный текст <i>с курсив</i></b> вместе"
+```
+
+Data tokens with decoration tokens together:
+
+```ruby
+irb(main)> user = {:gender => :male, :name => "Michael"}
+irb(main)> english.translate("[bold: {user}] received [link: [bold: {count}] {count|message}]", :user => {:object => user, :attribute => :name}, :bold => "<b>{$0}</b>", :count => 5, :link => "<a href='url'>{$0}</a>")
+=> "<b>Michael</b> received <a href='url'><b>5</b> messages</a>"
+irb(main)> russian.translate("[bold: {user}] received [link: [bold: {count}] {count|message}]", :user => {:object => user, :attribute => :name}, :bold => "<b>{$0}</b>", :count => 5, :link => "<a href='url'>{$0}</a>")
+=> "<b>Michael</b> получил <a href='url'><b>5</b> сообщений</a>"
+```
+
+PS. The Russian translation on translationexchange.com could either be provided by a set of 6-9 simple translations for {genders}(male, female, unknown) * count{one, few, many} or by a single advanced translation
+in the form of:
+
+```ruby
+[bold: {user}] {user| male: получил, female: получила} [link: [bold: {count}] {count| one: сообщение, few: сообщения, other: сообщений}]
+```
+
+Or in a simpler form:
+
+```ruby
+[bold: {user}] {user| получил, получила} [link: [bold: {count}] {count| сообщение, сообщения, сообщений}]
+```
+
+One of the advantages of using TML is the ability to easily switch token values. The above example in a text based email can reuse translations:
+
+```ruby
+irb(main)> english.translate("[bold: {user}] received [link: [bold: {count}] {count|message}]", :user => {:object => user, :attribute => :name}, :count => 1, :bold => "{$0}", :link => "{$0}")
+=> "Michael received 1 message"
+
+irb(main)> russian.translate("[bold: {user}] received [link: [bold: {count}] {count|message}]", :user => {:object => user, :attribute => :name}, :count => 1, :bold => "{$0}", :link => "{$0}")
+=> "Michael получил 1 сообщение"
+```
+
+You should also notice that all of the translation keys you've been using in your experiments will be registered under your application by the translationexchange.com service. You can view them all at:
+
+https://dashboard.translationexchange.com/
+
+If any translation key you've tried to translate was missing a translation, you can manually translate it using the service (with the help of a machine translation suggestion).
+
+```ruby
+irb(main)> russian.translate('This is a new phrase without translations')
+=> "This is a new phrase without translations"
+```
+
+Then without leaving your IRB session, you can call the following method to reset your application cache:
+
+```ruby
+irb(main)> app.reset_translation_cache
+```
+
+Then you can just rerun the translation method with the missing translation and you should get back the translated value.
+
+```ruby
+irb(main)> russian.translate('This is a new phrase without translations')
+=> "Это новая фраза без перевода"
+```
+
+Links
+==================
+
+* Register on TranslationExchange.com: http://translationexchange.com
+
+* Read TranslationExchange's documentation: http://translationexchange.com/docs
+
+* Follow TranslationExchange on Twitter: https://twitter.com/translationx
+
+* Connect with TranslationExchange on Facebook: https://www.facebook.com/translationexchange
+
+* If you have any questions or suggestions, contact us: feedback@translationexchange.com
+
+
+Copyright and license
+==================
+
+Copyright (c) 2015 Translation Exchange, Inc
+
+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/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Dir["#{File.dirname(__FILE__)}/tasks/**/*.rake"].sort.each { |ext| load ext }
+
+task :default => :spec

data/lib/tml.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+module Tml
+  module Api end
+  module Tokens end
+  module Tokenizers end
+  module Rules end
+  module Decorators end
+  module CacheAdapters end
+  module Generators
+    module Cache
+    end
+  end
+end
+
+%w(tml/base.rb tml tml/api tml/rules_engine tml/tokens tml/tokenizers tml/decorators tml/cache_adapters tml/cache tml/cache/generators tml/ext tml/modules tml/generators/cache).each do |f|
+  if f.index('.rb')
+    require(File.expand_path(File.join(File.dirname(__FILE__), f)))
+    next
+  end
+
+  Dir[File.expand_path("#{File.dirname(__FILE__)}/#{f}/*.rb")].sort.each do |file|
+    require(file)
+  end
+end
+

data/lib/tml/api/client.rb

@@ -0,0 +1,206 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2015 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+require 'faraday'
+
+class Tml::Api::Client < Tml::Base
+  API_HOST = 'https://api.translationexchange.com'
+  API_PATH = '/v1'
+
+  attributes :application
+
+  def access_token
+    return Tml::Session.access_token if Tml::Session.access_token
+
+    application.access_token ||= begin
+      token = Tml.cache.fetch("#{application.key}/access_token") do
+        api('oauth/token', {
+          :client_id      => application.key,
+          :client_secret  => application.secret,
+          :grant_type     => :client_credentials
+        }, {:method => :post})
+      end
+      Tml::Session.access_token = token['access_token']
+      Tml::Session.access_token
+    end
+  end
+
+  def results(path, params = {}, opts = {})
+    get(path, params, opts)['results']
+  end
+
+  def get(path, params = {}, opts = {})
+    api(path, params, opts.merge(:method => :get))
+  end
+
+  def post(path, params = {}, opts = {})
+    api(path, params, opts.merge(:method => :post))
+  end
+
+  def put(path, params = {}, opts = {})
+    api(path, params, opts.merge(:method => :put))
+  end
+
+  def delete(path, params = {}, opts = {})
+    api(path, params, opts.merge(:method => :delete))
+  end
+
+  def self.error?(data)
+    not data['error'].nil?
+  end
+
+  def host
+    application.host || API_HOST
+  end
+
+  def connection
+    @connection ||= Faraday.new(:url => host) do |faraday|
+      faraday.request(:url_encoded)               # form-encode POST params
+      # faraday.response :logger                  # log requests to STDOUT
+      faraday.adapter(Faraday.default_adapter)    # make requests with Net::HTTP
+    end
+  end
+
+  def api(path, params = {}, opts = {})
+    if Tml.session.inline_mode?
+      return process_response(execute_request(path, params, opts), opts)
+    end
+
+    if opts[:method] == :get and opts[:cache_key]
+      data = Tml.cache.fetch(opts[:cache_key]) do
+        Tml.cache.read_only? ? {} : execute_request(path, params, opts)
+      end
+      process_response(data, opts)
+    else
+      process_response(execute_request(path, params, opts), opts)
+    end
+  end
+
+  def paginate(path, params = {}, opts = {})
+    data = get(path, params, opts.merge({'raw' => true}))
+
+    while data
+      if data['results'].is_a?(Array)
+        data['results'].each do |result|
+          yield(result)
+        end
+      else
+        yield(data['results'])
+      end
+
+      if data['pagination'] and data['pagination']['links']['next']
+        data = get(data['pagination']['links']['next'], {}, opts.merge({'raw' => true}))
+      else
+        data = nil
+      end
+    end
+  end
+
+  def prepare_api_path(path)
+    return path if path.index('oauth')
+    return path if path.match(/^https?:\/\//)
+    "#{API_PATH}#{path[0] == '/' ? '' : '/'}#{path}"
+  end
+
+  def execute_request(path, params = {}, opts = {})
+    response = nil
+    error = nil
+
+    # oauth path is separate from versioned APIs
+    path = prepare_api_path(path)
+    params = params.merge(:access_token => access_token) unless path.index('oauth')
+
+    if opts[:method] == :post
+      params = params.merge(:api_key => application.key)
+    end
+
+    Tml.logger.trace_api_call(path, params, opts) do
+      begin
+        if opts[:method] == :post
+          response = connection.post(path, params)
+        elsif opts[:method] == :put
+          response = connection.put(path, params)
+        elsif opts[:method] == :delete
+          response = connection.delete(path, params)
+        else
+          response = connection.get(path, params)
+        end
+      rescue Exception => ex
+        Tml.logger.error("Failed to execute request: #{ex.message[0..255]}")
+        error = ex
+        nil
+      end
+    end
+    raise Tml::Exception.new("Error: #{error}") if error
+
+    if response.status >= 500 and response.status < 600
+      raise Tml::Exception.new("Error: #{response.body}")
+    end
+
+    return if response.body.nil? or response.body == ''
+
+    begin
+      data = JSON.parse(response.body)
+    rescue Exception => ex
+      raise Tml::Exception.new("Failed to parse response: #{ex.message[0..255]}")
+    end
+
+    if data.is_a?(Hash) and not data['error'].nil?
+      raise Tml::Exception.new("Error: #{data['error']}")
+    end
+
+    data
+  end
+
+  def object_class(opts)
+    return unless opts[:class]
+    opts[:class].is_a?(String) ? opts[:class].constantize : opts[:class]
+  end
+
+  def process_response(data, opts)
+    return data if opts['raw']
+
+    if data.is_a?(Hash) and data['results']
+      #Tml.logger.debug("received #{data['results'].size} result(s)")
+      return data['results'] unless object_class(opts)
+      objects = []
+      data['results'].each do |data|
+        objects << object_class(opts).new(data.merge(opts[:attributes] || {}))
+      end
+      return objects
+    end
+
+    return data unless object_class(opts)
+    object_class(opts).new(data.merge(opts[:attributes] || {}))
+  end
+
+end