tml 4.3.1

data/lib/tml/api/post_office.rb

@@ -0,0 +1,71 @@
+# 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.
+#++
+
+class Tml::Api::PostOffice < Tml::Api::Client
+  POST_OFFICE_HOST = 'https://postoffice.translationexchange.com'
+  POST_OFFICE_API_VERSION = 'v1'
+
+  attributes :application
+
+  def templates
+    api('templates', {
+      :access_token => access_token
+    })
+  end
+
+  def channels
+    api('channels', {
+      :access_token => access_token
+    })
+  end
+
+  def deliver(template, to, tokens = {}, options = {})
+    api("templates/#{template}/deliver", {
+      :access_token => access_token,
+      :tokens => tokens,
+      :to => to,
+      :via => options[:via],
+      :from => options[:from],
+      :locale => options[:locale],
+      :realtime => options[:realtime]
+    }, options.merge(:method => :post))
+  end
+
+  def host
+    application.tools['postoffice'] || POST_OFFICE_HOST
+  end
+
+  def prepare_api_path(path)
+    "/api/#{POST_OFFICE_API_VERSION}#{path.first == '/' ? '' : '/'}#{path}"
+  end
+
+end

data/lib/tml/application.rb

@@ -0,0 +1,254 @@
+# 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::Application < Tml::Base
+  attributes :host, :id, :key, :secret, :access_token, :name, :description, :threshold, :default_locale, :default_level, :tools
+  has_many :features, :languages, :featured_locales, :sources, :components, :tokens, :css, :shortcuts, :translations
+
+  def self.cache_key
+    'application'
+  end
+
+  def self.translations_cache_key(locale)
+    "#{locale}/translations"
+  end
+
+  def fetch
+    update_attributes(api_client.get('applications/current', {:definition => true}, {:cache_key => self.class.cache_key}))
+  rescue Tml::Exception => ex
+    Tml.logger.error("Failed to load application: #{ex}")
+    self
+  end
+
+  def update_attributes(attrs)
+    super
+
+    self.attributes[:languages] = []
+    if hash_value(attrs, :languages)
+      self.attributes[:languages] = hash_value(attrs, :languages).collect{ |l| Tml::Language.new(l.merge(:application => self)) }
+    end
+
+    self
+  end
+
+  def language(locale = nil)
+    locale = nil if locale.strip == ''
+    locale ||= default_locale || Tml.config.default_locale
+    @languages_by_locale ||= {}
+    @languages_by_locale[locale] ||= api_client.get(
+      "languages/#{locale}",
+      {:definition => true},
+      {
+        :class => Tml::Language,
+        :attributes => {:locale => locale, :application => self},
+        :cache_key => Tml::Language.cache_key(locale)
+      }
+    )
+  rescue Tml::Exception => e
+    Tml.logger.error(e)
+    Tml.logger.error(e.backtrace)
+    @languages_by_locale[locale] = Tml.config.default_language
+  end
+
+  # Mostly used for testing
+  def add_language(new_language)
+    @languages_by_locale ||= {}
+    return @languages_by_locale[new_language.locale] if @languages_by_locale[new_language.locale]
+    new_language.application = self
+    self.languages << new_language
+    @languages_by_locale[new_language.locale] = new_language
+    new_language
+  end
+
+  def locales
+    @locales ||= languages.collect{|lang| lang.locale}
+  end
+
+  def tools
+    @attributes[:tools] || {}
+  end
+
+  def url_for(path)
+    "#{tools['assets']}#{path}"
+  end
+
+  def source(source, locale)
+    self.sources ||= {}
+    self.sources[source] ||= Tml::Source.new(
+      :application => self,
+      :source => source
+    ).fetch_translations(locale)
+  end
+
+  def component(key, register = true)
+    key = key.key if key.is_a?(Tml::Component)
+
+    return self.components[key] if self.components[key]
+    return nil unless register
+
+    self.components[key] ||= api_client.post('components/register', {:component => key}, {:class => Tml::Component, :attributes => {:application => self}})
+  end
+
+  def register_missing_key(source_key, tkey)
+    return if Tml.cache.read_only? and not Tml.session.inline_mode?
+
+    @missing_keys_by_sources ||= {}
+    @missing_keys_by_sources[source_key] ||= {}
+    @missing_keys_by_sources[source_key][tkey.key] ||= tkey
+    submit_missing_keys if Tml.config.submit_missing_keys_realtime
+  end
+
+  def register_keys(keys)
+    params = []
+    keys.each do |source_key, keys|
+      next unless keys.values.any?
+      source = Tml::Source.new(:source => source_key, :application => self)
+      params << {:source => source_key, :keys => keys.values.collect{|tkey| tkey.to_hash(:label, :description, :locale, :level)}}
+      source.reset_cache
+    end
+
+    api_client.post('sources/register_keys', {:source_keys => params.to_json})
+  rescue Tml::Exception => e
+    Tml.logger.error('Failed to register missing translation keys...')
+    Tml.logger.error(e)
+    Tml.logger.error(e.backtrace)
+  end
+
+  def submit_missing_keys
+    return if @missing_keys_by_sources.nil? or @missing_keys_by_sources.empty?
+    register_keys(@missing_keys_by_sources)
+    @missing_keys_by_sources = nil
+  end
+
+  def featured_languages
+    @featured_languages ||= begin
+      locales = api_client.get('applications/current/featured_locales', {}, {:cache_key => 'featured_locales'})
+      (locales.nil? or locales.empty?) ? [] : languages.select{|l| locales.include?(l.locale)}
+    end
+  rescue
+    []
+  end
+ 
+  def translators
+    @translators ||= api_client.get('applications/current/translators', {}, {:class => Tml::Translator, :attributes => {:application => self}})
+  rescue
+    []
+  end
+
+  def reset_translation_cache
+    self.sources = {}
+    self.translations = {}
+    @languages_by_locale      = nil
+    @missing_keys_by_sources  = nil
+  end
+
+  def fetch_translations(locale)
+    self.translations ||= {}
+    self.translations[locale] ||= begin
+      results = Tml.cache.fetch(Tml::Application.translations_cache_key(locale)) do
+        data = {}
+        unless Tml.cache.read_only?
+          api_client.paginate('applications/current/translations', :per_page => 1000) do |translations|
+            data.merge!(translations)
+          end
+        end
+        data
+      end
+
+      translations_by_key = {}
+      results.each do |key, data|
+        translations_data = data.is_a?(Hash) ? data['translations'] : data
+        translations_by_key[key] = translations_data.collect do |t|
+          Tml::Translation.new(
+            :locale => t['locale'] || locale,
+            :label => t['label'],
+            :context => t['context']
+          )
+        end
+      end
+      translations_by_key
+    end
+  rescue Tml::Exception => ex
+    {}
+  end
+
+  def cache_translations(locale, key, new_translations)
+    self.translations ||= {}
+    self.translations[locale] ||= {}
+    self.translations[locale][key] = new_translations.collect do |t|
+      Tml::Translation.new(
+        :locale => t['locale'] || locale,
+        :label => t['label'],
+        :context => t['context']
+      )
+    end
+  end
+
+  def cached_translations(locale, key)
+    return unless self.translations and self.translations[locale]
+    self.translations[locale][key]
+  end
+
+  def debug_translations
+    return 'no translations' unless self.translations
+    self.translations.each do |locale, keys|
+      pp [locale, keys.collect{|key, translations|
+        [key, translations.collect{|t|
+          [t.label, t.context]
+        }]
+      }]
+    end
+  end
+
+  def default_decoration_token(token)
+    hash_value(tokens, "decoration.#{token.to_s}")
+  end
+
+  def default_data_token(token)
+    hash_value(tokens, "data.#{token.to_s}")
+  end
+
+  def feature_enabled?(key)
+    hash_value(features, key.to_s)
+  end
+
+  def api_client
+    @api_client ||= Tml::Api::Client.new(:application => self)
+  end
+
+  def postoffice
+    @postoffice ||= Tml::Api::PostOffice.new(:application => self)
+  end
+
+end

data/lib/tml/base.rb

@@ -0,0 +1,116 @@
+# 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.
+#++
+
+class Tml::Base
+  attr_reader :attributes
+
+  def initialize(attrs = {})
+    @attributes = {}
+    update_attributes(attrs)
+  end
+
+  def update_attributes(attrs = {})
+    attrs.each do |key, value|
+      #pp [self.class.name, key, self.class.attributes, self.class.attributes.include?(key.to_sym)]
+      next unless self.class.attributes.include?(key.to_sym)
+      @attributes[key.to_sym] = value
+    end
+  end
+
+  def self.attributes(*attrs)
+    @attribute_names ||= []
+    @attribute_names += attrs.collect{|a| a.to_sym} unless attrs.nil?
+    @attribute_names
+  end
+  def self.belongs_to(*attrs) self.attributes(*attrs); end
+  def self.has_many(*attrs) self.attributes(*attrs); end
+
+  def method_missing(meth, *args, &block)
+    method_name = meth.to_s
+    method_suffix = method_name[-1, 1]
+    method_key = method_name.to_sym
+    if %w(= ?).include?(method_suffix)
+      method_key = method_name[0..-2].to_sym 
+    end
+
+    if self.class.attributes.index(method_key)
+      if method_suffix == '='
+        attributes[method_key] = args.first
+        return attributes[method_key]
+      end
+      return attributes[method_key]
+    end
+
+    super
+  end      
+
+  def self.hash_value(hash, key, opts = {})
+    return nil unless hash.is_a?(Hash)
+    return hash[key.to_s] || hash[key.to_sym] if opts[:whole]
+
+    value = hash
+    key.to_s.split('.').each do |part|
+      return nil unless value.is_a?(Hash)
+      value = value[part.to_sym] || value[part.to_s]
+    end
+    value
+  end
+
+  def hash_value(hash, key, opts = {})
+    self.class.hash_value(hash, key, opts)
+  end
+
+  def to_hash(*attrs)
+    if attrs.nil? or attrs.empty?
+      # default hashing only includes basic types
+      keys = []
+      self.class.attributes.each do |key|
+        value = attributes[key]
+        next if value.kind_of?(Tml::Base) or value.kind_of?(Hash) or value.kind_of?(Array)
+        keys << key
+      end
+    else
+      keys = attrs
+    end
+
+    hash = {}
+    keys.each do |key|
+      hash[key] = attributes[key]
+    end
+
+    proc = Proc.new { |k, v| v.kind_of?(Hash) ? (v.delete_if(&proc); nil) : v.nil? }
+    hash.delete_if(&proc)
+
+    hash    
+  end
+
+end

data/lib/tml/cache.rb

@@ -0,0 +1,143 @@
+# 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.
+#++
+
+module Tml
+
+  CACHE_VERSION_KEY = '__tml_version__'
+
+  def self.memory
+    @memory ||= Tml::CacheAdapters::Memory.new
+  end
+
+  def self.cache
+    @cache ||= begin
+      if Tml.config.cache_enabled?
+        klass = Tml::CacheAdapters.const_get(Tml.config.cache[:adapter].camelcase)
+        klass.new
+      else
+        # blank implementation
+        Tml::Cache.new
+      end
+    end
+  end
+
+  class Cache
+
+    def version
+      Tml.config.cache[:version] ||= 1
+
+      @version ||= begin
+        v = fetch(CACHE_VERSION_KEY) do
+          {'version' => Tml.config.cache[:version]}
+        end
+        v['version']
+      end
+
+      @version ||= Tml.config.cache[:version]
+
+      if Tml.config.cache[:version] > @version
+        update_version(Tml.config.cache[:version])
+        @version = Tml.config.cache[:version]
+      end
+
+      @version
+    end
+
+    def update_version(new_version)
+      store(CACHE_VERSION_KEY, {'version' => new_version}, :ttl => 0)
+    end
+
+    def upgrade_version
+      update_version(version + 1)
+      @version = nil
+    end
+
+    def reset_version
+      @version = nil
+    end
+
+    def enabled?
+      Tml.config.cache[:enabled]
+    end
+
+    def cached_by_source?
+      true
+    end
+
+    def read_only?
+      false
+    end
+
+    def segmented?
+      true
+    end
+
+    def cache_name
+      self.class.name.split('::').last
+    end
+
+    def info(msg)
+      Tml.logger.info("#{cache_name} - #{msg}")
+    end
+
+    def warn(msg)
+      Tml.logger.warn("#{cache_name} - #{msg}")
+    end
+
+    def versioned_key(key, opts = {})
+      return key if CACHE_VERSION_KEY == key
+      "tml_rc_v#{version}_#{key}"
+    end
+
+    def fetch(key, opts = {})
+      return nil unless block_given?
+      yield
+    end
+
+    def store(key, data, opts = {})
+      # do nothing
+    end
+
+    def delete(key, opts = {})
+      # do nothing
+    end
+
+    def exist?(key, opts = {})
+      false
+    end
+
+    def clear(opts = {})
+      # do nothing
+    end
+
+  end
+end