tr8n_core 4.0.1

data/lib/tr8n/cache.rb

@@ -0,0 +1,144 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.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 Tr8n
+
+  def self.cache
+    @cache ||= begin
+      if Tr8n.config.cache_enabled?
+        klass = Tr8n::CacheAdapters.const_get(Tr8n.config.cache_adapter.camelcase)
+        klass.new
+      else
+        # blank implementation
+        Tr8n::Cache.new
+      end
+    end
+  end
+
+  class Cache
+
+    def version
+      @version ||= begin
+        v = fetch('tr8n_cache_version', :skip_version => true)
+        v ? v['version'] : Tr8n.config.cache_version
+      end
+    end
+
+    def upgrade_version
+      store('tr8n_cache_version', {'version' => version + 1}, :ttl => 0, :skip_version => true)
+      @version = nil
+    end
+
+    def reset_version
+      @version = nil
+    end
+
+    def enabled?
+      Tr8n.config.cache_enabled?
+    end
+
+    def cached_by_source?
+      true
+    end
+
+    def read_only?
+      true
+    end
+
+    def cache_name
+      self.class.name.underscore.split('_').last
+    end
+
+    def info(msg)
+      Tr8n.logger.info("#{cache_name} - #{msg}")
+    end
+
+    def warn(msg)
+      Tr8n.logger.warn("#{cache_name} - #{msg}")
+    end
+
+    def versioned_key(key, opts = {})
+      return key if opts[:skip_version]
+      "tr8n_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
+
+    def serialize_object(key, data)
+      if [Tr8n::Application.cache_prefix,
+              Tr8n::Language.cache_prefix,
+              Tr8n::Source.cache_prefix,
+              Tr8n::Component.cache_prefix,
+              Tr8n::TranslationKey.cache_prefix].include?(key[0..1])
+        json_data = data.to_cache_hash.to_json
+      else
+        # the data must be in cacheable form - usually API responses
+        json_data = data.to_json
+      end
+
+      #info(json_data)
+      json_data
+    end
+
+    def deserialize_object(key, data)
+      #info(data.inspect)
+
+      case key[0..1]
+        when Tr8n::Application.cache_prefix
+          return Tr8n::Application.new(JSON.parse(data))
+        when Tr8n::Language.cache_prefix
+          return Tr8n::Language.new(JSON.parse(data).merge(:application => Tr8n.config.application))
+        when Tr8n::Source.cache_prefix
+          return Tr8n::Source.new(JSON.parse(data).merge(:application => Tr8n.config.application))
+        when Tr8n::Component.cache_prefix
+          return Tr8n::Component.new(JSON.parse(data).merge(:application => Tr8n.config.application))
+        when Tr8n::TranslationKey.cache_prefix
+          return Tr8n::TranslationKey.new(JSON.parse(data).merge(:application => Tr8n.config.application))
+      end
+
+      # API response form will be here
+      JSON.parse(data)
+    end
+
+
+  end
+end

data/lib/tr8n/cache_adapters/cdb.rb

@@ -0,0 +1,74 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.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.
+#++
+
+require 'libcdb' if defined?(LibCDB)
+
+class Tr8n::CacheAdapters::Cdb < Tr8n::Cache
+
+  def initialize
+    @cache = LibCDB::CDB.open(cache_path)
+  end
+
+  def self.cache_path
+    "#{Tr8n.config.cache_path}/cdb/current.cdb"
+  end
+
+  def cached_by_source?
+    false
+  end
+
+  def fetch(key, opts = {})
+    data = @cache[key]
+    if data
+      info("Cache hit: #{key}")
+      return deserialize_object(key, data)
+    end
+
+    info("Cache miss: #{key}")
+
+    return nil unless block_given?
+
+    yield
+  rescue Exception => ex
+    warn("Failed to retrieve data: #{ex.message}")
+    return nil unless block_given?
+    yield
+  end
+
+  def store(key, data, opts = {})
+    warn("This is a readonly cache")
+  end
+
+  def delete(key, opts = {})
+    warn("This is a readonly cache")
+  end
+
+  def exist?(key, opts = {})
+    @cache[key]
+  end
+
+  def clear(opts = {})
+    warn("This is a readonly cache")
+  end
+
+end

data/lib/tr8n/cache_adapters/file.rb

@@ -0,0 +1,70 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.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.
+#++
+
+class Tr8n::CacheAdapters::File < Tr8n::Cache
+
+  def self.cache_path
+    "#{Tr8n.config.cache_path}/files/current"
+  end
+
+  def self.file_name(key)
+    "#{key.gsub(/[\.\/]/, '-')}.json"
+  end
+
+  def self.file_path(key)
+    "#{cache_path}/#{file_name(key)}"
+  end
+
+  def fetch(key, opts = {})
+    path = self.class.file_path(key)
+
+    if File.exists?(path)
+      info("Cache hit: #{key}")
+      data = File.read(path)
+      return deserialize_object(key, data)
+    end
+
+    info("Cache miss: #{key}")
+
+    return nil unless block_given?
+
+    yield
+  end
+
+  def store(key, data, opts = {})
+    warn("This is a readonly cache")
+  end
+
+  def delete(key, opts = {})
+    warn("This is a readonly cache")
+  end
+
+  def exist?(key, opts = {})
+    File.exists(file_path(key))
+  end
+
+  def clear(opts = {})
+    warn("This is a readonly cache")
+  end
+
+end

data/lib/tr8n/cache_adapters/memcache.rb

@@ -0,0 +1,91 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.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.
+#++
+
+require 'dalli' if defined?(Dalli)
+
+class Tr8n::CacheAdapters::Memcache < Tr8n::Cache
+
+  def initialize
+    options = { :namespace => "tr8n", :compress => true }
+    @cache = Dalli::Client.new(Tr8n.config.cache_host, options)
+  end
+
+  def read_only?
+    false
+  end
+
+  def fetch(key, opts = {})
+    data = @cache.get(versioned_key(key, opts))
+    if data
+      info("Cache hit: #{key}")
+      return deserialize_object(key, data)
+    end
+
+    info("Cache miss: #{key}")
+
+    return nil unless block_given?
+
+    data = yield
+
+    store(key, data)
+
+    data
+  rescue Exception => ex
+    warn("Failed to retrieve data: #{ex.message}")
+    return nil unless block_given?
+    yield
+  end
+
+  def store(key, data, opts = {})
+    info("Cache store: #{key}")
+    ttl = opts[:ttl] || Tr8n.config.cache_timeout
+    @cache.set(versioned_key(key, opts), serialize_object(key, data), ttl)
+    data
+  rescue Exception => ex
+    warn("Failed to store data: #{ex.message}")
+    data
+  end
+
+  def delete(key, opts = {})
+    info("Cache delete: #{key}")
+    @cache.delete(versioned_key(key, opts))
+    key
+  rescue Exception => ex
+    warn("Failed to delete data: #{ex.message}")
+    key
+  end
+
+  def exist?(key, opts = {})
+    data = @cache.get(versioned_key(key, opts))
+    not data.nil?
+  rescue Exception => ex
+    warn("Failed to check if key exists: #{ex.message}")
+    false
+  end
+
+  def clear(opts = {})
+    info("Cache clear")
+  rescue Exception => ex
+    warn("Failed to clear cache: #{ex.message}")
+  end
+end

data/lib/tr8n/cache_adapters/redis.rb

@@ -0,0 +1,94 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.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.
+#++
+
+require 'redis' if defined?(::Redis)
+
+class Tr8n::CacheAdapters::Redis < Tr8n::Cache
+
+  def initialize
+    cache_host, cache_port = Tr8n.config.cache_host.split(':') if Tr8n.config.cache_host
+    cache_host ||= 'localhost'
+    cache_port ||= 6379
+
+    @cache = ::Redis.new(host: cache_host, port: cache_port)
+  end
+
+  def read_only?
+    false
+  end
+
+  def fetch(key, opts = {})
+    data = @cache.get(versioned_key(key, opts))
+    if data
+      info("Cache hit: #{key}")
+      return deserialize_object(key, data)
+    end
+
+    info("Cache miss: #{key}")
+
+    return nil unless block_given?
+
+    data = yield
+
+    store(key, data)
+
+    data
+  rescue Exception => ex
+    warn("Failed to retrieve data: #{ex.message}")
+    return nil unless block_given?
+    yield
+  end
+
+  def store(key, data, opts = {})
+    info("Cache store: #{key}")
+    ttl = opts[:ttl] || Tr8n.config.cache_timeout
+    versioned_key = versioned_key(key, opts)
+
+    @cache.set(versioned_key, serialize_object(key, data))
+    @cache.expire(versioned_key, ttl) if ttl and ttl > 0
+  rescue Exception => ex
+    warn("Failed to store data: #{ex.message}")
+    data
+  end
+
+  def delete(key, opts = {})
+    info("Cache delete: #{key}")
+    @cache.del(versioned_key(key, opts))
+  rescue Exception => ex
+    warn("Failed to delete data: #{ex.message}")
+    key
+  end
+
+  def exist?(key, opts = {})
+    data = @cache.exist(versioned_key(key, opts))
+    not data.nil?
+  rescue Exception => ex
+    warn("Failed to check if key exists: #{ex.message}")
+    false
+  end
+
+  def clear(opts = {})
+    info("Cache clear has no effect")
+  end
+
+end

data/lib/tr8n/component.rb

@@ -0,0 +1,68 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.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.
+#++
+
+class Tr8n::Component < Tr8n::Base
+  belongs_to :application
+  attributes :key, :name, :description, :state
+
+  def sources
+    application.get("component/sources", {:key => key}, {:class => Tr8n::Source, :application => application})
+  end
+
+  def translators
+    application.get("component/translators", {:key => key}, {:class => Tr8n::Translator, :application => application})
+  end
+
+  def languages
+    application.get("component/languages", {:key => key}, {:class => Tr8n::Language, :application => application})
+  end
+
+  def register_source(source)
+    application.post("component/register_source", {:key => key, :source => source.source})
+  end
+
+  def restricted?
+    state == 'restricted'
+  end
+
+  def live?
+    state == 'live'
+  end
+
+  def translator_authorized?(translator)
+    return true unless restricted?
+    translators.include?(translator)
+  end
+
+  #######################################################################################################
+  ##  Cache Methods
+  #######################################################################################################
+
+  def self.cache_prefix
+    'c@'
+  end
+
+  def self.cache_key(key)
+    "#{cache_prefix}_[#{key}]"
+  end
+end