tr8n_client_sdk 4.1.6 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cb47a8f25f6b27451a1c9e8b45a9d5311f18e79
-  data.tar.gz: 5f16ff10ab8df805d404234b5f8971a9d8bbdaa4
+  metadata.gz: e2c5d0fc6b0b1a8f19a0c1d744e67421eef4c2ba
+  data.tar.gz: c30856b2d4f36db9dfafdfa04cc835519858b4fd
 SHA512:
-  metadata.gz: 7d002ca916300782dccd51275759dd7a6692f099a295f6f3d03518a7a73eda3ff22c00277f5cfb9f598e3dd3950ecd95b03cafad8ec058e255d851379f107bb2
-  data.tar.gz: 0a48178707dcd1ab2608deed5b787645f6133c6502dceff671d43f1bcaa67aef1983a2cb2afa929a512019335633650b2d6d650b7f1893818e826594d92dfaec
+  metadata.gz: eea75b84daa691897516b52147b90f20df8cb5239d7ef58ebe198d09deb4f8d3669f813740232c8b1ad33784f67764213d9a0d3da566bc2bcfec0349177f8c1d
+  data.tar.gz: de278681dbd09b56b8d23f440456996a3c7fb2df4ee776818d1bc70a0587f7d2bdaa9b41edcb4b843749bee5ea3f5cddf6d70611fe2d9efbfb2b07c126c56c94

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Michael Berkovich, tr8nhub.com
+Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 
 MIT License
 

data/README.md

@@ -2,84 +2,75 @@
   <img src="https://raw.github.com/tr8n/tr8n/master/doc/screenshots/tr8nlogo.png">
 </p>
 
-Tr8n Client SDK for Ruby on Rails
+Tr8n SDK for Ruby on Rails
 ===================================
 [![Build Status](https://travis-ci.org/tr8n/tr8n_rails_clientsdk.png?branch=master)](https://travis-ci.org/tr8n/tr8n_rails_clientsdk)
 [![Coverage Status](https://coveralls.io/repos/tr8n/tr8n_rails_clientsdk/badge.png)](https://coveralls.io/r/tr8n/tr8n_rails_clientsdk)
 [![Gem Version](https://badge.fury.io/rb/tr8n_client_sdk.png)](http://badge.fury.io/rb/tr8n_client_sdk)
 [![Dependency Status](https://www.versioneye.com/user/projects/53cda6a5225426f1e8000165/badge.svg?style=flat)](https://www.versioneye.com/user/projects/53cda6a5225426f1e8000165)
-[![Project status](http://stillmaintained.com/tr8n/tr8n_ruby_core.png)](http://stillmaintained.com/tr8n/tr8n_ruby_core.png)
 
-This Client SDK provides extensions necessary for translating Rails 3.2.X based application using the TranslationExchange.com service.
+This Client SDK provides tools for translating Rails applications into any language using the TranslationExchange.com service.
 
 
-Tr8n Client SDK Sample
+Installation
 ===================================
 
-The best way to start using the SDK is to run a sample application that comes bundled with this SDK.
-
-```sh
-  $ git clone https://github.com/tr8n/tr8n_rails_clientsdk.git
-  $ cd tr8n_rails_clientsdk/spec/dummy
-  $ bundle
-```
-
-Before you running the application, visit TranslationExchange.com, register as a new user and create a new application.
+To integrate Tr8n SDK into your own application, all you need to do is:
 
-Update your key and secret in the following file:  config/initializers/tr8n.rb
+Add the following gem to your Gemfile:
 
 ```ruby
-  config.application = {
-      :key => YOUR_KEY,
-      :secret => YOUR_SECRET
-  }
+  gem 'tr8n_client_sdk'
 ```
 
-Now you can start the application by running:
+Install the gems:
 
 ```sh
-  $ bundle exec rails s
+  $ bundle
 ```
 
 
-This will start the dummy application on port 3000. Open your browser and point to:
-
-http://localhost:3000
+Configuration
+===================================
 
+Create a tr8n initializer file with the following configuration:
 
+config/initializers/tr8n.rb
 
+```ruby
+    Tr8n.configure do |config|
+      config.application = {
+          :key => YOUR_APP_KEY,
+          :secret => YOUR_APP_SECRET
+      }
+    end
+```
 
-Integration
-===================================
+Tr8n should be run with caching enabled. You can specify the cache you want to use by providing it in the initializer.
 
-To integrate Tr8n SDK into your own app, all you need to do is:
+If you are already using Rails caching, you can use it for Tr8n as well:
 
-Add the following gem to your Gemfile:
+config/environments/production.rb
 
 ```ruby
-  gem 'tr8n_client_sdk', '~> 3.2'
-```
-
-Install the gems:
+    config.cache_store = :mem_cache_store, Dalli::Client.new('localhost:11211', {:namespace => 'myapplication'})
+    config.identity_cache_store = :mem_cache_store, Dalli::Client.new('localhost:11211', {:namespace => 'myapplication'})
 
-```sh
-  $ bundle
 ```
 
-Create an initializer file under config/initializers/tr8n.rb and add the following configuration:
+config/initializers/tr8n.rb
 
 ```ruby
     Tr8n.configure do |config|
-      config.application = {
-          :key => YOUR_APP_KEY,
-          :secret => YOUR_APP_SECRET
+      config.cache = {
+        :enabled    => true,
+        :adapter    => 'rails',
+        :version    => 1
       }
     end
 ```
 
-Tr8n is best run with caching enabled. You can specify your caching adapter using the following settings:
-
-Memcache example:
+Alternatively, you can provide a separate memcache server specifically for translations:
 
 ```ruby
     Tr8n.configure do |config|
@@ -93,7 +84,7 @@ Memcache example:
     end
 ```
 
-Redis example:
+You can also use Redis to persist your translations cache:
 
 ```ruby
     Tr8n.configure do |config|
@@ -107,8 +98,51 @@ Redis example:
     end
 ```
 
-To see a full list of supported cache adapters or to create your own cache adapter, visit TranslationExchange.com/docs
+The above examples use shared caching model - all your Rails processes on all your servers share the same translation cache. This approach
+will save you memory space, as well as allow you to invalidate/redeploy your translations cache without having to redeploy your application.
 
+To update the cache, run the following line of code from any application instance (for example, an admin tool):
+
+```ruby
+  Tr8n.cache.upgrade_version
+```
+
+Or you can run the rake command:
+
+```sh
+ $ bundle exec rake tr8n:cache:upgrade
+```
+
+This will effectively invalidate your current cache and rebuilt it with the latest translations from Translation Exchange's CDN.
+
+An alternative approach is to pre-generate all your cache files when you deploy your application. The translation cache will be loaded and stored in every process on every server,
+but it will be faster at serving translations and this approach does not require cache warmup.
+
+If you prefer to use in-memory caching, you can specify the file based cache using:
+
+```ruby
+    Tr8n.configure do |config|
+      config.cache = {
+          :enabled    => true,
+          :adapter    => 'file',
+          :path       => 'config/tr8n',
+          :version    => 'current',
+          :segmented  => false
+        }
+    end
+```
+
+If you set ':segmented' to 'true' it will generate cache files per language per source, instead of one file per language for the entire application.
+
+The file based cache must be generated before you deploy your application using the following command:
+
+```sh
+  $ bundle exec rake tr8n:cache:generate
+```
+
+
+Integration
+===================================
 
 In the HEAD section of your layout, add:
 
@@ -129,7 +163,7 @@ server, but it may not be ideal on production. There are a number of alternative
 
 To use a dropdown language selector that uses locale in the url parameter, use:
 
-```rails
+```ruby
 <%= tr8n_language_selector_tag(
         :type => :dropdown,
         :style => "margin-top:15px",
@@ -137,16 +171,13 @@ To use a dropdown language selector that uses locale in the url parameter, use:
     ) %>
 ```
 
-As you see, you can provide custom values to how you want to make it look and whether you want to use the english version
-of the language name or have the language be printed in a native language.
-
-
-Now you can use TML (Translation Markup Language) in your application to translate your strings:
+Now you can use Tr8n's helper methods and TML (Translation Markup Language) to translate your strings:
 
-```rails
+```ruby
   <%= tr("Hello World") %>
-  <%= tr("You have {count||message}", :count => 5) %>
-  <%= tr("{actor} sent {target} [bold: {count||gift}]", :actor => actor_user, :target => target_user, :count => 5) %>
+  <%= tr("You have {count || message}", count: 5) %>
+  <%= tr("{actor} sent {target} [bold: {count || gift}]", actor: actor_user, target: target_user, count: 5) %>
+  <%= tr("{actor} uploaded [bold: {count || photo}] to {actor | his, her} photo album.", actor: current_user, count: 5) %>
   ...
 ```
 
@@ -159,29 +190,48 @@ you can simply use:
 
 ```
 
-
-Learn more about TML at: https://TranslationExchange.com/docs
+Learn more about TML at: http://TranslationExchange.com/docs
 
 
-Caching
+I18n fallback
 ===================================
 
-To reset/upgrade your cache, you can simply call
+If your application is already using the standard i18n framework, you can mix in the Tr8n framework on top of it. To do so, 
+you need to set the i18n backend to Tr8n. Add the following line to your tr8n initializer:
+
+config/initializers/tr8n.rb
 
 ```ruby
-  Tr8n.cache.upgrade_version
+  I18n.backend = I18n::Backend::Tr8n.new
 ```
 
-All the keys stored in memory based cache are versioned. By upgrading the version you will effectively invalidate the old keys and the new keys will be loaded from the translation service.
+Now the "t" function will automatically fallback onto "tr" function. If you have the following in your base language file:
 
+config/locales/en.yml
 
-File adapters require pre-generation. You can pre-generate your cache by running:
+```ruby
+  en:
+    hello: "Hello world"
+    my:
+      nested:
+        key: "This is a nested key"
+```
 
-```sh
-  $ rake tr8n:generate_cache:cdb
+Then you can call:
+
+```ruby
+  <%= t(:hello) %>
+  <%= t("my.nested.key") %>
 ```
 
-You can also do a combination of file-based adapters (for persistent cache) and memory-based adapters for serving the translations.
+And the i18n will use Translation Exchange as the backend for your translations. On top of it, you can continue using Tr8n's extensions:
+
+```ruby
+  <%= tr("Hello World") %>
+  <%= tr("This is a nested key") %>
+```
+
+The above calls are equivalent. 
 
 
 Logging
@@ -232,20 +282,52 @@ If you need to adjust those method names, you can set them in the config:
 ```
 
 
+Tr8n Client SDK Sample
+===================================
+
+The best way to start using the SDK is to run a sample application that comes bundled with this SDK.
+
+```sh
+  $ git clone https://github.com/tr8n/tr8n_rails_clientsdk.git
+  $ cd tr8n_rails_clientsdk/spec/dummy
+  $ bundle
+```
+
+Before you running the application, visit TranslationExchange.com, register as a new user and create a new application.
+
+Update your key and secret in the following file:  config/initializers/tr8n.rb
+
+```ruby
+  config.application = {
+      :key => YOUR_KEY,
+      :secret => YOUR_SECRET
+  }
+```
+
+Now you can start the application by running:
+
+```sh
+  $ bundle exec rails s
+```
+
+
+This will start the dummy application on port 3000. Open your browser and point to:
+
+http://localhost:3000
+
+
 Links
 ==================
 
 * Register on TranslationExchange.com: https://translationexchange.com
 
-* Read TranslationExchange's documentation: http://wiki.translationexchange.com
-
-* Visit TranslationExchange's blog: http://blog.translationexchange.com
+* Read TranslationExchange's documentation: https://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: info@translationexchange.com
+* If you have any questions or suggestions, contact us: feedback@translationexchange.com
 
 
 Copyright and license

data/Rakefile

@@ -1,3 +1,34 @@
+#--
+# 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.
+#++
+
 #!/usr/bin/env rake
 #begin
 #  require 'bundler/setup'

data/{lib/tasks/tr8n_client_sdk.rake → app/controllers/tr8n_client_sdk/cache_controller.rb}

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |
@@ -29,19 +29,11 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-namespace :tr8n_client_sdk do
-
-  task :init => :environment do
-    
+module Tr8nClientSdk
+  class CacheController < ApplicationController
+    def upgrade
+      Tr8n.cache.upgrade_version
+      redirect_to(request.env['HTTP_REFERER'] || '/')
+    end
   end
-
-  task :cache do
-    require "tr8n_client_sdk/config"
-    Tr8n.config = Tr8nClientSdk::Config.new
-
-    Tr8n.config.init_application
-    g = Tr8nCore::Generators::Cache::File.new
-    g.run
-  end
-
 end

data/app/views/tr8n_client_sdk/tags/_language_selector.html.erb

@@ -31,7 +31,7 @@
         <% elsif opts[:language] == :english %>
            <%= lang.english_name %>
         <% else %>
-          <%= lang.name %>
+          <%= lang.english_name %>
         <% end %>
       </option>
     <% end %>
@@ -47,7 +47,7 @@
     <% elsif opts[:language] == :english %>
       <%= tr8n_current_language.english_name %>
     <% else %>
-      <%= tr8n_current_language.name %>
+      <%= tr8n_current_language.english_name %>
     <% end %>
   </a>
 <% end %>

data/app/views/tr8n_client_sdk/tags/_powered_by_tr8n.html.erb

@@ -1,6 +1,18 @@
 <div style="padding-top:40px; color: #ccc; text-align:center; width:100%">
-  <%= tr("Powered by {tr8n}", :tr8n => link_to("Tr8n", "http://wiki.tr8nhub.com", :style=>"color:#ccc;")) %>
-  <div style="padding-top:5px;">
-    <%=link_to(image_tag("http://wiki.tr8nhub.com/images/e/e9/Tr8n_logo.png", :style=>"width:50px;"), "http://wiki.tr8nhub.com") %>
+  <%= tr("Powered by {trex}", :trex => link_to("TranslationExchange.com", "http://translationexchange.com", :style=>"color:#ccc;")) %>
+
+  <style>
+    .trex_logo {
+      margin-top:10px;
+      padding: 40px;
+      background-repeat: no-repeat;
+      background-image:url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAEMAAABQCAYAAABCiMhGAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNS4xIE1hY2ludG9zaCIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpCQTg4MTEyOEU0NkIxMUUzODhCMEJEOUNDRDQ0QkU0MiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpCQTg4MTEyOUU0NkIxMUUzODhCMEJEOUNDRDQ0QkU0MiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkJBODgxMTI2RTQ2QjExRTM4OEIwQkQ5Q0NENDRCRTQyIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkJBODgxMTI3RTQ2QjExRTM4OEIwQkQ5Q0NENDRCRTQyIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+mszKSAAAAqFJREFUeNrsnE1IFVEYhr+53QiKEIkgpCBwJSH9SITkqkVELXJZ0iYIqRaBCZWgoWKikRBI1KVNmyg3gVKQ0CZE+9kHQYukaGP2I6iEP1ffc+dc7iwK5s5Mx3PPvC88zGxm5s4zc85853JmvNardwTxwC1wGuyWdGQGvARduaH23wUJkJHFcgoclnTmKzgIIT8yWOlNsQiVPeB+8c74hmWNMNXqzqimh0JqlIxVeigkr2Tk6aGQtQwdlEIZlEEZlEEZEZONuf0YmASLYNNGPRI1e8FFsHUjZNwAg5Zd3GHwHuw02Uw+WShCZRr0m+4zPljc9D+alpG1WMYW0zJsfgplxMGTYp1BGZRBGZRBGZRBGZRBGZRBGZRBGQxlUAZlUAZlUAZlUAZlUAZlUAZlUIbDMmyeYr3KO6OUJdMyGiyWcdS0DPV+ykMLRRwD16JuHGc60gV9Fd6KP/Vxs/hTEDvBbIT9nQLNEdp8XkpTH0/GMRl3bladJpi7EWQcB89dfLSW24EdAeOsM0T2gQkWXX4bf6P7mlTL2KFFbE97Ob4NvAO70j42UcdTbyHU2jo28Qwe7zXYb2nl6mXE3DzwF6DJ5kGrkjFv4EBP4laHBjKjZDz7zwfJgTOWi3iVG2qfVTKui//ZhMTaXmD9Hmi1XMSf4m9UMubAIfAY/Epg58t62QcuWyxhQfx37A7grvgcHKipgdU5UPWX538LuBlh8Deu+4oVS2X8BN8h4p+j1jlNMOW+5lQ8+QmpsIQpusr5vsYV8EUqNElWoKojHpYKTlIyusFtqfAkIWMA9IgDiStD/cXXIY4kjowHoE0cSlQZj8AlcSxRZDwF58XBhJGxFlgfBWfF0YSR4QXK62ZxOGFk1OtR7QlxPGFkjIBGSUHWBRgAlJNpO4bVinwAAAAASUVORK5CYII=);
+    }
+  </style>
+
+  <div style="text-align: center">
+    <%=link_to('http://translationexchange.com') do %>
+      <img class="trex_logo" src="" alt="" />
+    <% end %>
   </div>
 </div>

data/app/views/tr8n_client_sdk/tags/_scripts.html.erb

@@ -1,90 +1,45 @@
 <% if Tr8n.config.enabled? %>
-
   <style type="text/css">
-  .tr8n_fltr {
-    <%=tr8n_style_attribute_tag('float', 'right')%> !important;
-  }
-  .tr8n_fltl {
-    <%=tr8n_style_attribute_tag('float', 'left')%> !important;
-  }
-  .tr8n_txtr {
-    <%=tr8n_style_attribute_tag('text-align', 'right')%> !important;
-  }
-  .tr8n_txtl {
-    <%=tr8n_style_attribute_tag('text-align', 'left')%> !important;
-  }
+    .tr8n_fltr {<%=tr8n_style_attribute_tag('float', 'right')%> !important;}
+    .tr8n_fltl {<%=tr8n_style_attribute_tag('float', 'left')%> !important;}
+    .tr8n_txtr {<%=tr8n_style_attribute_tag('text-align', 'right')%> !important;}
+    .tr8n_txtl {<%=tr8n_style_attribute_tag('text-align', 'left')%> !important;}
   </style>
 
   <script>
-    function tr8n_add_css(doc, value, inline) {
-      var css = null;
-      if (inline) {
-        css = doc.createElement('style'); css.type = 'text/css';
-        if (css.styleSheet) css.styleSheet.cssText = value;
-        else css.appendChild(document.createTextNode(value));
-      } else {
-        css = doc.createElement('link'); css.setAttribute('type', 'text/css');
-        css.setAttribute('rel', 'stylesheet'); css.setAttribute('media', 'screen');
-        if (value.indexOf('//') != -1) css.setAttribute('href', value);
-        else css.setAttribute('href', '<%= tr8n_application.host %>' + value);
-      }
-      doc.getElementsByTagName('head')[0].appendChild(css);
-      return css;
-    }
+    (function() {
+      if (window.tr8n_already_initialized) return;
+      window.tr8n_already_initialized = true;
 
-    function tr8n_add_script(doc, id, src, onload) {
-      var script = doc.createElement('script');
-      script.setAttribute('id', id);
+      var script = window.document.createElement('script');
+      script.setAttribute('id', 'tr8n-tools');
       script.setAttribute('type', 'application/javascript');
-      if (src.indexOf('//') != -1) script.setAttribute('src', src);
-      else script.setAttribute('src', '<%= tr8n_application.host %>' + src);
+      script.setAttribute('src', '<%= tr8n_application.tools['javascript'] %>');
       script.setAttribute('charset', 'UTF-8');
-      if (onload) script.onload = onload;
-      doc.getElementsByTagName('head')[0].appendChild(script);
-      return script;
-    }
-
-    (function() {
-      if (window.addEventListener) window.addEventListener('load', tr8n_init, false); // Standard
-      else if (window.attachEvent) window.attachEvent('onload', tr8n_init); // Microsoft
-      window.setTimeout(function() {  // just in case, hit it one more time a second later
-        tr8n_init();
-      }, 1000);
-
-      function tr8n_init() {
-        if (window.tr8n_already_initialized) return;
-        window.tr8n_already_initialized = true;
-
-        tr8n_add_css(window.document, '/assets/tr8n/tools.css', false);
-        tr8n_add_css(window.document, "<%= tr8n_application.css %>", true);
-
-        tr8n_add_script(window.document, 'tr8n-jssdk', '/assets/tools.js?t=<%=Time.now%>', function() {
-          Tr8n.app_key = '<%= tr8n_application.key %>';
-          Tr8n.host = '<%= tr8n_application.host %>';
-          Tr8n.sources = [];
-          Tr8n.default_locale = '<%= tr8n_application.default_locale %>';
-          Tr8n.page_locale = '<%= tr8n_current_language.locale %>';
-          Tr8n.locale = '<%= tr8n_current_language.locale %>';
-
-          <%
-            if tr8n_application.feature_enabled?(:shortcuts)
-               tr8n_application.shortcuts.each do |key, script|
-          %>
-          shortcut.add('<%=key.html_safe%>', function() {
-            <%= script.html_safe %>
-          });
-          <%
-               end
-            end
-          %>
-
-          if (typeof(tr8n_on_ready) === 'function') {
-            tr8n_on_ready();
-          }
+      script.onload = function() {
+        Tr8n.Utils.insertCSS(window.document, "<%= tr8n_application.tools['stylesheet'] %>", false);
+        Tr8n.Utils.insertCSS(window.document, "<%= tr8n_application.css %>", true);
+        Tr8n.app_key = '<%= tr8n_application.key %>';
+        Tr8n.host = '<%= tr8n_application.tools['host'] %>';
+        Tr8n.locale = '<%= tr8n_current_language.locale %>';
+        Tr8n.sources = [];
+        <%
+          if tr8n_application.feature_enabled?(:shortcuts)
+             tr8n_application.shortcuts.each do |key, script|
+        %>
+        shortcut.add('<%=key.html_safe%>', function() {
+          <%= script.html_safe %>
         });
-      }
+        <%
+             end
+          end
+        %>
+        if (typeof(tr8n_on_ready) === 'function') {
+          tr8n_on_ready();
+        }
+      };
+
+      window.document.getElementsByTagName('head')[0].appendChild(script);
     })();
   </script>
-
-
 <% end %>

data/config/routes.rb

@@ -1,2 +1,34 @@
-Tr8nClientSdk::Engine.routes.draw do
+#--
+# 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.
+#++
+
+Rails.application.routes.draw do
+  get '/tr8n/upgrade' => 'tr8n_client_sdk/cache#upgrade'
 end

data/lib/i18n/backend/tr8n.rb

@@ -0,0 +1,62 @@
+#--
+# 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.
+#++
+
+require 'i18n/backend/base'
+require 'tr8n_core'
+
+module I18n
+  module Backend
+    class Tr8n < I18n::Backend::Simple
+
+      module Implementation
+        include Base, Flatten
+
+        def application
+          ::Tr8n.session.application
+        end
+
+        def available_locales
+          application.locales
+        end
+
+        def lookup(locale, key, scope = [], options = {})
+          default_key = super(application.default_locale, key, scope, options)
+          default_key ||= key
+          application.language(locale.to_s).translate(default_key)
+        end
+
+      end
+
+      include Implementation
+    end
+  end
+end
+

data/lib/tasks/tr8n.rake

@@ -0,0 +1,60 @@
+#--
+# 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.
+#++
+
+require 'tr8n_core'
+
+namespace :tr8n do
+
+  namespace :cache do
+
+    desc 'upgrades shared translation cache'
+    task :upgrade => :environment do
+      Tr8n.cache.upgrade_version
+    end
+
+    desc 'generates local file cache'
+    task :generate => :environment do
+      Tr8nCore::Generators::Cache::File.new.run
+    end
+
+    desc 'rolls back to the previous version'
+    task :rollback => :environment do
+      Tr8nCore::Generators::Cache::File.new.rollback
+    end
+
+    desc 'rolls up to the next version'
+    task :rollup => :environment do
+      Tr8nCore::Generators::Cache::File.new.rollup
+    end
+
+  end
+
+end

data/lib/tr8n/cache_adapters/rails.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |
@@ -30,12 +30,10 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'dalli' if defined?(Dalli)
-
 class Tr8n::CacheAdapters::Rails < Tr8n::Cache
 
   def initialize
-    Tr8n.logger.info("Initializing Rails cache...")
+    Tr8n.logger.info('Initializing Rails cache...')
     @cache = Rails.cache
   end
 

data/lib/tr8n_client_sdk/core/string.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |

data/lib/tr8n_client_sdk/engine.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |

data/lib/tr8n_client_sdk/extensions/action_common_methods.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |
@@ -34,11 +34,11 @@ module Tr8nClientSdk
     ############################################################
     # There are three ways to call the tr method
     #
-    # tr(label, desc = "", tokens = {}, options = {})
+    # tr(label, desc = '', tokens = {}, options = {})
     # or
     # tr(label, tokens = {}, options = {})
     # or
-    # tr(:label => label, :description => "", :tokens => {}, :options => {})
+    # tr(:label => label, :description => '', :tokens => {}, :options => {})
     ############################################################
     def tr(label, description = '', tokens = {}, options = {})
       params = Tr8n::Utils.normalize_tr_params(label, description, tokens, options)
@@ -65,7 +65,7 @@ module Tr8nClientSdk
         return text.tr8n_translated.html_safe
       end
 
-      tr8n_current_language.translate(params).tr8n_translated.html_safe
+      Tr8n.session.target_language.translate(params).tr8n_translated.html_safe
     rescue Tr8n::Exception => ex
       #pp ex, ex.backtrace
       Tr8n.logger.error(ex.message)
@@ -74,24 +74,24 @@ module Tr8nClientSdk
     end
 
     # for translating labels
-    def trl(label, description = "", tokens = {}, options = {})
+    def trl(label, description = '', tokens = {}, options = {})
       params = Tr8n::Utils.normalize_tr_params(label, description, tokens, options)
       params[:options][:skip_decorations] = true
       tr(params)
     end
 
     # flash notice
-    def trfn(label, desc = "", tokens = {}, options = {})
+    def trfn(label, desc = '', tokens = {}, options = {})
       flash[:trfn] = tr(Tr8n::Utils.normalize_tr_params(label, desc, tokens, options))
     end
 
     # flash error
-    def trfe(label, desc = "", tokens = {}, options = {})
+    def trfe(label, desc = '', tokens = {}, options = {})
       flash[:trfe] = tr(Tr8n::Utils.normalize_tr_params(label, desc, tokens, options))
     end
 
     # flash warning
-    def trfw(label, desc = "", tokens = {}, options = {})
+    def trfw(label, desc = '', tokens = {}, options = {})
       flash[:trfw] = tr(Tr8n::Utils.normalize_tr_params(label, desc, tokens, options))
     end
 

data/lib/tr8n_client_sdk/extensions/action_controller_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |
@@ -73,36 +73,13 @@ module Tr8nClientSdk
         nil
       end  
 
-      def tr8n_cookie_name
-        "tr8n_#{tr8n_application.key}"
-      end
-
-      def tr8n_cookie
-        request.cookies[tr8n_cookie_name]
-      end
-
-      def tr8n_cookie_params
-        @tr8n_cookie_params ||= begin
-          if tr8n_cookie
-            cookie_params = Tr8n::Utils.decode_and_verify_params(tr8n_cookie, tr8n_application.secret)
-            Tr8n.logger.info(cookie_params.inspect)
-            cookie_params
-          else
-            {}
-          end
-        end
-      end
-
       def tr8n_translator_locale
-        tr8n_cookie_params["locale"]
+        tr8n_cookie_params['locale']
       end
 
-      def tr8n_init_current_locale
+      def tr8n_locale
         self.send(Tr8n.config.current_locale_method) if Tr8n.config.current_locale_method
       rescue
-        # fallback onto the cookie params from the service
-        return tr8n_translator_locale if tr8n_translator_locale
-
         # fallback to the default session based locale implementation
         # choose the first language from the accepted languages header
         session[:locale] = tr8n_user_preferred_locale unless session[:locale]
@@ -110,33 +87,27 @@ module Tr8nClientSdk
         session[:locale] || Tr8n.config.default_locale
       end
 
-      def tr8n_init_current_user
+      def tr8n_user
         self.send(Tr8n.config.current_user_method) if Tr8n.config.current_user_method
       rescue
         nil
       end
 
-      def tr8n_init_current_translator
-        if tr8n_cookie_params["translator"]
-          Tr8n::Translator.new(tr8n_cookie_params["translator"].merge(:application => tr8n_application))
-        else
-          nil
-        end
-      end
-
       def tr8n_init_client_sdk
         return if Tr8n.config.disabled?
 
         @tr8n_started_at = Time.now
 
-        Tr8n.session.init
-
-        Tr8n.session.current_user = tr8n_init_current_user
-        Tr8n.session.current_language = tr8n_application.language(tr8n_init_current_locale)
-        Tr8n.session.current_translator = tr8n_init_current_translator
+        Tr8n.session.init(
+          :cookies => request.cookies,
+          :locale => tr8n_locale,
+          :user => tr8n_user,
+          :source => tr8n_source,
+          :component => tr8n_component
+        )
 
-        Tr8n.session.current_source = tr8n_source
-        Tr8n.session.current_component = tr8n_component
+        I18n.enforce_available_locales = false
+        I18n.locale = Tr8n.session.current_language.locale
       end
 
       def tr8n_reset_client_sdk

data/lib/tr8n_client_sdk/extensions/action_view_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |
@@ -118,14 +118,13 @@ module Tr8nClientSdk
         return ""
       end
 
-      Thread.current[:block_options] ||= []
-      Thread.current[:block_options].push(opts)
+      Tr8n.session.push_block_options(opts)
 
       if block_given?
         ret = capture(&block)
       end
 
-      Thread.current[:block_options].pop
+      Tr8n.session.pop_block_options
       ret
     end
     alias_method :tr8n_block, :tr8n_with_options_tag

data/lib/tr8n_client_sdk/railtie.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |

data/lib/tr8n_client_sdk/version.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |
@@ -30,5 +30,5 @@
 #++
 
 module Tr8nClientSdk
-  VERSION = '4.1.6'
+  VERSION = '4.2.1'
 end

data/lib/tr8n_client_sdk.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.com
 #
 #  _______                  _       _   _             ______          _
 # |__   __|                | |     | | (_)           |  ____|        | |
@@ -34,6 +34,7 @@ require "tr8n_client_sdk/core/string"
 require "tr8n_client_sdk/railtie"
 require "tr8n_client_sdk/engine"
 require "tr8n/cache_adapters/rails"
+require "i18n/backend/tr8n"
 
 module Tr8nClientSdk
 

metadata

@@ -1,46 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: tr8n_client_sdk
 version: !ruby/object:Gem::Version
-  version: 4.1.6
+  version: 4.2.1
 platform: ruby
 authors:
 - Michael Berkovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tr8n_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 description: Client SDK for Tr8n translation engine.
 email:
-- michael@tr8nhub.com
+- michael@translationexchange.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -48,12 +48,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/tr8n_client_sdk/cache_controller.rb
 - app/views/tr8n_client_sdk/tags/_language_selector.html.erb
 - app/views/tr8n_client_sdk/tags/_language_strip.html.erb
 - app/views/tr8n_client_sdk/tags/_powered_by_tr8n.html.erb
 - app/views/tr8n_client_sdk/tags/_scripts.html.erb
 - config/routes.rb
-- lib/tasks/tr8n_client_sdk.rake
+- lib/i18n/backend/tr8n.rb
+- lib/tasks/tr8n.rake
 - lib/tr8n/cache_adapters/rails.rb
 - lib/tr8n_client_sdk.rb
 - lib/tr8n_client_sdk/core/string.rb