i18n-backend-jargon 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23ce2a5f4c297d66c0132207381587951f95399c
+  data.tar.gz: 6262386043b006bebfcbde5cb7dab809ad736b3f
+SHA512:
+  metadata.gz: cc9fbb888f0c66417878cdae746ca71592f45530a3abc63f158075fc91b66da1636515492cde7c3476b910c38f7da8ad9588e5a16ceb806369acfa49b160984a
+  data.tar.gz: e43273ddbd12a2d59aba075473976bde7abaaf610b2698f9312ef8037618ed7eb0006bd24f26eaf75a9d01f57b88c7cf960150240de04f4b3324a2bf0664bad6

data/lib/i18n/backend/jargon.rb

@@ -0,0 +1,202 @@
+require 'i18n'
+require 'i18n/backend/transliterator'
+require 'i18n/backend/base'
+require 'gem_of_thrones'
+require 'i18n/backend/jargon/version'
+require 'i18n/backend/jargon/etag_http_client'
+require 'i18n/backend/jargon/null_cache'
+
+module I18n
+  module Backend
+    class Jargon
+      include ::I18n::Backend::Base
+
+      def initialize(options)
+        @config = {
+          host: 'http://localhost',
+          http_open_timeout: 1,
+          http_read_timeout: 1,
+          polling_interval: 10*60,
+          cache: NullCache.new,
+          poll: true,
+          exception_handler: lambda{|e| $stderr.puts e },
+          memory_cache_size: 10
+          }.merge(options)
+          raise ArgumentError if @config[:uuid].nil?
+        end
+
+        def initialized?
+          @initialized ||= false
+        end
+
+        def stop_polling
+          @stop_polling = true
+        end
+
+        def reload!
+          @initialized  = false
+          @translations = nil
+        end
+
+        def available_locales
+          @available_locales ||= download_available_locales
+        end
+
+        def locale_path(locale)
+          localization_path + "/#{locale}"
+        end
+
+        def localization_path
+          "api/uuid/#{@config[:uuid]}"
+        end
+
+        def translate(locale, key, options = {})
+          raise InvalidLocale.new(locale) unless locale
+          entry = key && lookup(locale, key, options[:scope], options)
+
+          if options.empty?
+            entry = resolve(locale, key, entry, options)
+          else
+            count, default = options.values_at(:count, :default)
+            values         = options.except(*RESERVED_KEYS)
+            entry          = entry.nil? && default ?
+            default(locale, key, default, options) : resolve(locale, key, entry, options)
+          end
+
+          throw(:exception, I18n::MissingTranslation.new(locale, key, options)) if entry.nil?
+          entry = entry.dup if entry.is_a?(String)
+
+          entry = pluralize(locale, entry, count) if count
+          entry = interpolate(locale, entry, values) if values
+          entry
+        end
+
+        protected
+
+        def download_available_locales
+          init_translations unless initialized?
+          download_localization
+        end
+
+        def init_translations
+          @http_client  = EtagHttpClient.new(@config)
+          @translations = {}
+          start_polling if @config[:poll]
+          @initialized = true
+        end
+
+        def start_polling
+          Thread.new do
+            until @stop_polling
+              sleep(@config[:polling_interval])
+              update_caches
+            end
+          end
+        end
+
+        def lookup(locale, key, scope = [], options = {})
+          init_translations unless initialized?
+          key = ::I18n.normalize_keys(locale, key, scope, options[:separator])[1..-1].join('.')
+          lookup_key translations(locale), key
+        end
+
+        def resolve(locale, object, subject, options = {})
+          return subject if options[:resolve] == false
+          result = catch(:exception) do
+            case subject
+            when Symbol
+              I18n.translate(subject, options.merge(:locale => locale, :throw => true))
+            when Proc
+              date_or_time = options.delete(:object) || object
+              resolve(locale, object, subject.call(date_or_time, options))
+            else
+              subject
+            end
+          end
+          result unless result.is_a?(MissingTranslation)
+        end
+
+        def translations(locale)
+          translations_from_cache(locale)
+          @translations[locale]
+        end
+
+        def update_caches
+          @translations.keys.each do |locale|
+            if @config[:cache].is_a?(NullCache)
+              download_and_cache_translations(locale)
+            else
+              locked_update_cache(locale)
+            end
+          end
+        end
+
+        def locked_update_cache(locale)
+          @aspirants ||= {}
+          aspirant   = @aspirants[locale] ||= GemOfThrones.new(
+            :cache     => @config[:cache],
+            :timeout   => (@config[:polling_interval] * 3).ceil,
+            :cache_key => "i18n/backend/http/locked_update_caches/#{locale}"
+            )
+          if aspirant.rise_to_power
+            download_and_cache_translations(locale)
+          else
+            update_memory_cache_from_cache(locale)
+          end
+        end
+
+        def update_memory_cache_from_cache(locale)
+          @translations[locale] = translations_from_cache(locale)
+        end
+
+        def translations_from_cache(locale)
+          translations = @config[:cache].read(cache_key(locale))
+          if translations.nil?
+            download_and_cache_translations(locale)
+          else
+            @translations[locale] = translations
+          end
+        end
+
+        def cache_key(locale)
+          "i18n/backend/http/translations/#{locale}"
+        end
+
+        def download_and_cache_translations(locale)
+          @http_client.download(locale_path(locale)) do |result|
+            translations = parse_locale(result)
+            @config[:cache].write(cache_key(locale), translations)
+            @translations[locale] = translations
+          end
+          rescue => e
+            @config[:exception_handler].call(e)
+            @translations[locale] = {} # do not write distributed cache
+        end
+
+        def download_localization
+          @http_client.download(localization_path) do |result|
+            parse_localization(result)
+          end
+        end
+
+        def parse_locale(body)
+          j = JSON.parse(JSON.parse(body)['locale']['json'])
+          flat_hash(j).map{ |k,v| [k.sub(/\.$/, ''), v] }.to_h
+        end
+
+        def parse_localization(body)
+          JSON.load(body)['localization']['available_locales']
+        end
+
+        def flat_hash(hash, k = '')
+          return {k => hash} unless hash.is_a?(Hash)
+          hash.inject({}){ |h, v| h.merge! flat_hash(v[-1], k +v[0].to_s + '.') }
+        end
+
+        # hook for extension with other resolution method
+        def lookup_key(translations, key)
+          translations[key]
+        end
+      end
+    end
+  end

data/lib/i18n/backend/jargon/etag_http_client.rb

@@ -0,0 +1,33 @@
+require 'faraday'
+
+module I18n
+  module Backend
+    class Jargon
+      class EtagHttpClient
+        def initialize(options)
+          @options = options
+          @etags = {}
+        end
+
+        def download(path)
+          @client ||= Faraday.new(@options[:host])
+          response = @client.get(path) do |request|
+            request.headers["If-None-Match"] = @etags[path] if @etags[path]
+            request.headers["Accept"] = 'application/json'
+            request.options[:timeout] = @options[:http_read_timeout]
+            request.options[:open_timeout] = @options[:http_open_timeout]
+          end
+
+          @etags[path] = response['ETag']
+
+          case response.status
+            when 200 then yield response.body
+            when 304
+            else
+              raise "Failed request: #{response.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/backend/jargon/null_cache.rb

@@ -0,0 +1,19 @@
+module I18n
+  module Backend
+    class Jargon
+      class NullCache
+        def fetch(*args)
+          yield
+        end
+
+        def read(key)
+        end
+
+        def write(key, value)
+          value
+        end
+      end
+
+    end
+  end
+end

data/lib/i18n/backend/jargon/version.rb

@@ -0,0 +1,7 @@
+module I18n
+  module Backend
+    class Jargon
+      VERSION = Version = "0.2.3"
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: i18n-backend-jargon
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem_of_thrones
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/i18n/backend/jargon.rb
+- lib/i18n/backend/jargon/etag_http_client.rb
+- lib/i18n/backend/jargon/null_cache.rb
+- lib/i18n/backend/jargon/version.rb
+homepage: http://github.com/grosser/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rails I18n Backend for Http APIs with etag-aware background polling and memory+[memcache]
+  caching
+test_files: []