tr8n_client_sdk 4.0.8 → 4.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0431a7e51712613de3712320c6320550e2aac04
-  data.tar.gz: f3e4bf196240bdef5d51ea9ad4cc0068e17272f3
+  metadata.gz: d5f3b0af6635122b50c5d1f5efc4f9e6f344b41f
+  data.tar.gz: 9516613ddc5a415a0a5c73e0cdb6794a441a6bfe
 SHA512:
-  metadata.gz: febd9a1388357c3062dbcdd49fa4bb1406a5a0da86ef69807d77a5b09f25580718ba564125bee747f82cc60d5b34929938493cf29934db9e9bada158548f213a
-  data.tar.gz: 251a679dffc85eefe2f7c7dada4e876dbdeccb68a5ff077f53839525f2775b18562d64c5ee689ac56834135425d4da73cffb5fc6f999dbeea45f1648c7da50fa
+  metadata.gz: cb5c52a2ff2269aade2e04c796bca7b1ff54273c199f10a2bebd33ff4f170caadd38bc5932dbd0f199c816438a55e789bb2d9c2a6abfd64bbfa563b16e1fd122
+  data.tar.gz: 1e7728afbc198909f8326b550a31c9fd2cd1fd8c9872f5ea59c0928c54325beaa09e415d6a53b6f44e06908b94cffd1ffb975e0e8ae39db43d8640991d348733

data/README.md

@@ -10,7 +10,7 @@ Tr8n Client SDK for Ruby on Rails
 [![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 extensions necessary for translating Rails 4.0.X based application using the TranslationExchange.com service.
 
 
 Tr8n Client SDK Sample
@@ -57,7 +57,7 @@ To integrate Tr8n SDK into your own app, all you need to do is:
 Add the following gem to your Gemfile:
 
 ```ruby
-  gem 'tr8n_client_sdk'
+  gem 'tr8n_client_sdk', '~> 4.0'
 ```
 
 Install the gems:

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

@@ -1,5 +1,53 @@
-<a href="#" onClick="Tr8n.UI.LanguageSelector.show(); return false;">
-  <%= image_tag(tr8n_current_language.flag_url, :style => "align:middle") %>
-  &nbsp;
-  <%= tr8n_current_language.name %>
-</a>
+<% if opts[:type] == :dropdown %>
+  <script>
+    function tr8n_change_locale(selector) {
+      var query_parts = window.location.href.split('?');
+      var query = query_parts.length > 1 ? query_parts[1] : null;
+      var params = {};
+      if (query) {
+        var vars = query.split('&');
+        for (var i = 0; i < vars.length; i++) {
+          var pair = vars[i].split('=');
+          params[pair[0]] = pair[1];
+        }
+      }
+      params['locale'] = selector.options[selector.selectedIndex].value;
+
+      query = [];
+      var keys = Object.keys(params);
+      for (var i = 0; i < keys.length; i++) {
+        query.push(encodeURIComponent(keys[i]) + "=" + encodeURIComponent(params[keys[i]]));
+      }
+
+      var destination = query_parts[0] + '?' + query.join("&");
+      window.location = destination;
+    }
+  </script>
+  <select id="tr8n_language_selector" onchange="tr8n_change_locale(this)" style="<%=opts[:style]%>" class="<%=opts[:class]%>">
+    <% tr8n_application.languages.each do |lang| %>
+      <option dir='ltr' value="<%=lang.locale%>" <%="selected" if lang.locale == tr8n_current_locale %>>
+        <% if opts[:language] == :native %>
+          <%= lang.native_name %>
+        <% elsif opts[:language] == :english %>
+           <%= lang.english_name %>
+        <% else %>
+          <%= lang.name %>
+        <% end %>
+      </option>
+    <% end %>
+  </select>
+<% else %>
+  <a href="#" onClick="Tr8n.UI.LanguageSelector.show(); return false;">
+    <% unless opts[:hide_flag] %>
+      <%= image_tag(tr8n_current_language.flag_url, :style => "align:middle") %>
+      &nbsp;
+    <% end %>
+    <% if opts[:language] == :native %>
+      <%= tr8n_current_language.native_name %>
+    <% elsif opts[:language] == :english %>
+      <%= tr8n_current_language.english_name %>
+    <% else %>
+      <%= tr8n_current_language.name %>
+    <% end %>
+  </a>
+<% end %>

data/lib/tr8n/cache_adapters/rails.rb

@@ -0,0 +1,100 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2014 Michael Berkovich, 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 'dalli' if defined?(Dalli)
+
+class Tr8n::CacheAdapters::Rails < Tr8n::Cache
+
+  def initialize
+    Tr8n.logger.info("Initializing Rails cache...")
+    @cache = Rails.cache
+  end
+
+  def cache_name
+    @cache.class.name
+  end
+
+  def read_only?
+    false
+  end
+
+  def fetch(key, opts = {})
+    miss = false
+    data = @cache.fetch(versioned_key(key, opts)) do
+      info("Cache miss: #{key}")
+      miss = true
+      if block_given?
+        yield
+      else
+        nil
+      end
+    end
+    info("Cache hit: #{key}") unless miss
+    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}")
+    @cache.write(versioned_key(key, opts), data)
+    data
+  rescue Exception => ex
+    warn("Failed to store data: #{ex.message}")
+    key
+  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.fetch(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_client_sdk.rb

@@ -32,6 +32,7 @@
 require "tr8n_client_sdk/railtie"
 require "tr8n_client_sdk/engine"
 require "tr8n_core"
+require "tr8n/cache_adapters/rails"
 
 module Tr8nClientSdk
 

data/lib/tr8n_client_sdk/extensions/action_controller_extension.rb

@@ -37,6 +37,13 @@ module Tr8nClientSdk
       base.send(:include, InstanceMethods)
       base.before_filter :tr8n_init_client_sdk
       base.after_filter :tr8n_reset_client_sdk
+      if defined? base.rescue_from
+        base.rescue_from 'Tr8n::Exception' do |e|
+          Tr8n.logger.error(e)
+          Tr8n.logger.error(e.backtrace)
+          raise e
+        end
+      end
     end
 
     module InstanceMethods
@@ -65,20 +72,55 @@ 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"]
+      end
+
       def tr8n_init_current_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]
         session[:locale] = params[:locale] if params[:locale]
-        session[:locale]
+        session[:locale] || Tr8n.config.default_locale
       end
 
       def tr8n_init_current_user
         self.send(Tr8n.config.current_user_method) if Tr8n.config.current_user_method
       rescue
-        Tr8n.config.default_locale
+        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
@@ -88,21 +130,10 @@ module Tr8nClientSdk
 
         Tr8n.session.init
 
-        translator = nil
-
-        cookie_name = "tr8n_#{tr8n_application.key}"
-        if request.cookies[cookie_name]
-          cookie_params = Tr8n::Utils.decode_and_verify_params(request.cookies[cookie_name], tr8n_application.secret)
-          Tr8n.logger.info(cookie_params.inspect)
-          locale = cookie_params["locale"]
-          translator = Tr8n::Translator.new(cookie_params["translator"].merge(:application => tr8n_application)) unless cookie_params["translator"].nil?
-        end
-
-        locale ||= tr8n_init_current_locale || Tr8n.config.default_locale
-
         Tr8n.session.current_user = tr8n_init_current_user
-        Tr8n.session.current_translator = translator
-        Tr8n.session.current_language = tr8n_application.language(locale || tr8n_init_current_locale || Tr8n.config.default_locale)
+        Tr8n.session.current_language = tr8n_application.language(tr8n_init_current_locale)
+        Tr8n.session.current_translator = tr8n_init_current_translator
+
         Tr8n.session.current_source = tr8n_source
         Tr8n.session.current_component = tr8n_component
       end

data/lib/tr8n_client_sdk/version.rb

@@ -23,5 +23,5 @@
 
 
 module Tr8nClientSdk
-  VERSION = '4.0.8'
+  VERSION = '4.0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tr8n_client_sdk
 version: !ruby/object:Gem::Version
-  version: 4.0.8
+  version: 4.0.10
 platform: ruby
 authors:
 - Michael Berkovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -54,6 +54,7 @@ files:
 - app/views/tr8n_client_sdk/tags/_scripts.html.erb
 - config/routes.rb
 - lib/tasks/tr8n_client_sdk.rake
+- lib/tr8n/cache_adapters/rails.rb
 - lib/tr8n_client_sdk.rb
 - lib/tr8n_client_sdk/engine.rb
 - lib/tr8n_client_sdk/extensions/action_common_methods.rb