tr8n_client_sdk 1.1.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8d0103283b05a19ab6981ce073537294d3dd176
-  data.tar.gz: 0bfdf3265f60d79eb255b6ceb3d150fec606cf1b
+  metadata.gz: 9802bfd002589491b5e71c353cad0372d5d251c1
+  data.tar.gz: c073f2d7078cc2183cf7178c46f1b113d33d9e29
 SHA512:
-  metadata.gz: 38a034b6a92ba6ede6e13c9b6e8bdb3735ac589cbfd37cc1ed20c1639644e6a82df939acd90187b21b44b167999794ed12ca7b9794e74988314284528f09787e
-  data.tar.gz: 0173898286496b8be08f43195094ceed4082fd69820dbdac692e1e1bb4d112da0b762566c7a460688c16f60eebbd0d41040671a08d0e8a140c01d914f219570b
+  metadata.gz: 21979fba2779078034813c6ebf2a0ff746c97a497bffc53962e0ac9a4ecf6ad697e28cbe9d53d4f996b584a145dec53a60a5371fe7534c0c09dbe78ff930e5f5
+  data.tar.gz: 62eb86e095c80117194b1b54990d014262892b77fdaf54e9a99af5a1fd72397c452f82c28d1b1386ae99b4e1a0004b3c7a3cdf057cf73e1af7d38de43d7ce353

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -7,6 +7,12 @@ Tr8n Client SDK for Ruby on Rails
 
 This Client SDK provides tools and extensions necessary for translating any Rails application using the Tr8n service.
 
+[![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/52e4bc4cec1375b57600000f/badge.png)](https://www.versioneye.com/user/projects/52e4bc4cec1375b57600000f)
+[![Project status](http://stillmaintained.com/tr8n/tr8n_ruby_core.png)](http://stillmaintained.com/tr8n/tr8n_ruby_core.png)
+
 
 Runing the Client SDK Sample
 ===================================
@@ -21,13 +27,16 @@ Make sure you edit the config/tr8n/config.yml file and provide the correct appli
   $ cd tr8n_rails_clientsdk/test/dummy
   $ bundle install
   $ rake db:migrate
-  $ rails s -p 3001
+  $ rails s
 ```
 
 Alternatively, you can see the same sample application as a stand alone app:
 
 https://github.com/tr8n/tr8n_rails_clientsdk_sample
 
+This application is running at:
+
+http://rails.tr8nhub.com
 
 # Integration Instructions
 

data/Rakefile

@@ -21,22 +21,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-#APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-#load 'rails/tasks/engine.rake'
-#
-#Dir["#{File.dirname(__FILE__)}/lib/tasks/**/*.rake"].sort.each { |ext| load ext }
-#
-#Bundler::GemHelper.install_tasks
-#
-#require 'rake/testtask'
-#
-#Rake::TestTask.new(:test) do |t|
-#  t.libs << 'lib'
-#  t.libs << 'test'
-#  t.pattern = 'test/**/*_test.rb'
-#  t.verbose = false
-#end
-
 Dir["#{File.dirname(__FILE__)}/lib/tasks/**/*.rake"].sort.each { |ext| load ext }
 
 require 'rspec/core/rake_task'

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

@@ -0,0 +1,5 @@
+<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>

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

@@ -1,20 +1,20 @@
 <% if Tr8n.config.enabled? %>
-  <% featured_languages = Tr8n.config.application.featured_languages %>
-  <% if featured_languages.any? %> 
+  <% featured_languages = tr8n_application.featured_languages %>
+  <% if featured_languages.any? %>
     <style>
-    .tr8n_language_strip                            {text-align:center; color:#777;}
-    .tr8n_language_strip a                          {text-decoration:none; color:#777; outline:none; border:0px; font-size:10px;}
-    .tr8n_language_strip a img                      {border:0px;}
-    .tr8n_language_strip a:hover                    {text-decoration:underline}  
+      .tr8n_language_strip                            {text-align:center; color:#777;}
+      .tr8n_language_strip a                          {text-decoration:none; color:#777; outline:none; border:0px; font-size:10px;}
+      .tr8n_language_strip a img                      {border:0px;}
+      .tr8n_language_strip a:hover                    {text-decoration:underline}
     </style>
     <div class="tr8n_language_strip" style="font-size:12px;">
       <% featured_languages.each do |lang| %>
-          <%= tr8n_language_name_tag(lang, opts) %> &nbsp;
+        <%= tr8n_language_name_tag(lang, opts) %> &nbsp;
       <% end %>
-      
+
       <% if featured_languages.size > 0 %>
-          <%=link_to_function("&raquo;".html_safe, "Tr8n.UI.LanguageSelector.show(true)") %>
-      <% end %> 
+        <%=link_to_function("&raquo;".html_safe, "Tr8n.UI.LanguageSelector.show()") %>
+      <% end %>
     </div>
   <% end %>
 <% end %>

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

@@ -1,6 +1,6 @@
 <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("tr8n/tr8n_logo.png", :style=>"width:50px;"), "http://wiki.tr8nhub.com") %>
+    <%=link_to(image_tag("http://wiki.tr8nhub.com/images/e/e9/Tr8n_logo.png", :style=>"width:50px;"), "http://wiki.tr8nhub.com") %>
   </div>
 </div>

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

@@ -1,35 +1,90 @@
 <% if Tr8n.config.enabled? %>
 
   <style type="text/css">
-  .tr8n_fltr {
+    .tr8n_fltr {
     <%=tr8n_style_attribute_tag('float', 'right')%> !important;
-  }
-  .tr8n_fltl {
+    }
+    .tr8n_fltl {
     <%=tr8n_style_attribute_tag('float', 'left')%> !important;
-  }
-  .tr8n_txtr {
+    }
+    .tr8n_txtr {
     <%=tr8n_style_attribute_tag('text-align', 'right')%> !important;
-  }
-  .tr8n_txtl {
+    }
+    .tr8n_txtl {
     <%=tr8n_style_attribute_tag('text-align', 'left')%> !important;
-  }
+    }
   </style>
 
-  <script type="text/javascript">
+  <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 tr8n_add_script(doc, id, src, onload) {
+      var script = doc.createElement('script');
+      script.setAttribute('id', id);
+      script.setAttribute('type', 'application/javascript');
+      if (src.indexOf('//') != -1) script.setAttribute('src', src);
+      else script.setAttribute('src', '<%= tr8n_application.host %>' + src);
+      script.setAttribute('charset', 'UTF-8');
+      if (onload) script.onload = onload;
+      doc.getElementsByTagName('head')[0].appendChild(script);
+      return script;
+    }
+
     (function() {
-      function async_load(){
-        var s = document.createElement('script');
-        s.type = 'text/javascript';
-        s.async = true;
-        s.src = '<%= Tr8n.config.application.js_boot_url %>';
-        var x = document.getElementsByTagName('script')[0];
-        x.parentNode.insertBefore(s, x);
+      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();
+          }
+        });
       }
-      if (window.attachEvent)
-        window.attachEvent('onload', async_load);
-      else
-        window.addEventListener('load', async_load, false);
     })();
   </script>
 
+
 <% end %>

data/lib/tasks/tr8n_client_sdk.rake

@@ -1,6 +1,14 @@
 #--
-# Copyright (c) 2010-2013 Michael Berkovich, tr8nhub.com
+# 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
@@ -24,7 +32,7 @@
 namespace :tr8n_client_sdk do
 
   task :init => :environment do
-    
+
   end
 
   task :cache do

data/lib/tr8n_client_sdk/engine.rb

@@ -1,6 +1,14 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# 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

data/lib/tr8n_client_sdk/extensions/action_common_methods.rb

@@ -1,6 +1,14 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# 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
@@ -32,8 +40,8 @@ module Tr8nClientSdk
     # or
     # tr(:label => label, :description => "", :tokens => {}, :options => {})
     ############################################################
-    def tr(label, description = "", tokens = {}, options = {})
-      return label if label.tr8n_translated?
+    def tr(label, description = '', tokens = {}, options = {})
+      return label.html_safe if label.tr8n_translated?
 
       params = Tr8n::Utils.normalize_tr_params(label, description, tokens, options)
       params[:options][:caller] = caller
@@ -44,7 +52,7 @@ module Tr8nClientSdk
       end
 
       if Tr8n.config.disabled?
-        return Tr8n::TranslationKey.substitute_tokens(params[:label], params[:tokens], params[:options]).tr8n_translated.html_safe
+        return Tr8n.config.default_language.translate(params[:label], params[:tokens], params[:options]).tr8n_translated.html_safe
       end
 
       # Translate individual sentences
@@ -52,15 +60,16 @@ module Tr8nClientSdk
         text = params[:label]
         sentences = Tr8n::Utils.split_by_sentence(text)
         sentences.each do |sentence|
-          text = text.gsub(sentence, Tr8n.config.current_language.translate(sentence, params[:description], params[:tokens], params[:options]))
+          text = text.gsub(sentence, tr8n_current_language.translate(sentence, params[:description], params[:tokens], params[:options]))
         end
         return text.tr8n_translated.html_safe
       end
 
-      Tr8n.config.current_language.translate(params).tr8n_translated.html_safe
+      tr8n_current_language.translate(params).tr8n_translated.html_safe
     rescue Tr8n::Exception => ex
-      Tr8n::Logger.error("ERROR: #{label}")
-      Tr8n::Logger.error(ex.message + "\n=> " + ex.backtrace.join("\n=> "))
+      #pp ex, ex.backtrace
+      Tr8n.logger.error(ex.message)
+      #Tr8n.logger.error(ex.message + "\n=> " + ex.backtrace.join("\n=> "))
       label
     end
 
@@ -90,32 +99,32 @@ module Tr8nClientSdk
     ## Common methods - wrappers
     ######################################################################
 
-    def tr8n_application
-      Tr8n.config.application
+    def tr8n_session
+      Tr8n.session
     end
 
-    def tr8n_current_user
-      Tr8n.config.current_user
+    def tr8n_application
+      tr8n_session.application
     end
 
-    def tr8n_current_language
-      Tr8n.config.current_language
+    def tr8n_current_user
+      tr8n_session.current_user
     end
 
-    def tr8n_default_language
-      Tr8n.config.default_language
+    def tr8n_current_translator
+      tr8n_session.current_translator
     end
 
-    def tr8n_current_translator
-      Tr8n.config.current_translator
+    def tr8n_current_locale
+      tr8n_session.current_language.locale
     end
 
-    def tr8n_current_user_is_guest?
-      Tr8n.config.current_user_is_guest?
+    def tr8n_current_language
+      tr8n_session.current_language
     end
 
-    def tr8n_current_user_is_translator?
-      not Tr8n.config.current_translator.nil?
+    def tr8n_language_dir
+      tr8n_current_language.dir
     end
 
   end

data/lib/tr8n_client_sdk/extensions/action_controller_extension.rb

@@ -1,6 +1,14 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# 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
@@ -25,8 +33,8 @@ module Tr8nClientSdk
   module ActionControllerExtension
 
     def self.included(base)
-      base.send(:include, Tr8nClientSdk::ActionCommonMethods) 
-      base.send(:include, InstanceMethods) 
+      base.send(:include, Tr8nClientSdk::ActionCommonMethods)
+      base.send(:include, InstanceMethods)
       base.before_filter :tr8n_init_client_sdk
       base.after_filter :tr8n_reset_client_sdk
     end
@@ -39,12 +47,12 @@ module Tr8nClientSdk
 
       def tr8n_user_preferred_locale
         tr8n_browser_accepted_locales.each do |locale|
-          next unless Tr8n.config.application.locales.include?(locale)
+          next unless Tr8n.session.application.locales.include?(locale)
           return locale
         end
         Tr8n.config.default_locale
       end
-      
+
       # Overwrite this method in a controller to assign a custom source for all views
       def tr8n_source
         "/#{controller_name}/#{action_name}"
@@ -55,10 +63,10 @@ module Tr8nClientSdk
       # Overwrite this method in a controller to assign a custom component for all views
       def tr8n_component
         nil
-      end  
+      end
 
       def tr8n_init_current_locale
-        self.send(Tr8n.config.current_locale_method)
+        self.send(Tr8n.config.current_locale_method) if Tr8n.config.current_locale_method
       rescue
         # fallback to the default session based locale implementation
         # choose the first language from the accepted languages header
@@ -68,53 +76,43 @@ module Tr8nClientSdk
       end
 
       def tr8n_init_current_user
-        self.send(Tr8n.config.current_user_method)
+        self.send(Tr8n.config.current_user_method) if Tr8n.config.current_user_method
+      rescue
+        Tr8n.config.default_locale
       end
 
       def tr8n_init_client_sdk
-        return unless Tr8n.config.enabled?
+        return if Tr8n.config.disabled?
 
-        Tr8n.logger.info("Initializing request...")
         @tr8n_started_at = Time.now
 
-        Tr8n.config.init_application
+        return unless Tr8n.session.init
 
         translator = nil
 
         cookie_name = "tr8n_#{tr8n_application.key}"
         if request.cookies[cookie_name]
-          Tr8n.logger.info("Cookie exists:")
-          cookie_params = Tr8n::Utils.decode_and_verify_params(request.cookies[cookie_name], Tr8n.config.app_secret)
+          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?
-        else
-          Tr8n.logger.info("Cookie does not exist")
         end
 
-        locale ||= tr8n_init_current_locale
-        user = tr8n_init_current_user
+        locale ||= tr8n_init_current_locale || Tr8n.config.default_locale
 
-        Tr8n.config.init_request(user, translator, locale, tr8n_source, tr8n_component)
-
-        # register component and verify that the current user is authorized to view it
-        #unless Tr8n.config.current_user_is_authorized_to_view_component?
-        #   trfe("You are not authorized to view this component")
-        #   return redirect_to(Tr8n.config.default_url)
-        #end
-        #unless Tr8n.config.current_user_is_authorized_to_view_language?
-        #   Tr8n.config.set_language(Tr8n.config.default_language)
-        #end
+        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_source = tr8n_source
+        Tr8n.session.current_component = tr8n_component
       end
 
       def tr8n_reset_client_sdk
+        return if Tr8n.config.disabled?
         @tr8n_finished_at = Time.now
-
-        Tr8n.logger.info("Resetting request...")
         tr8n_application.submit_missing_keys
-        Tr8n.config.reset_request
-
-        Tr8n.logger.info("Request took #{@tr8n_finished_at - @tr8n_started_at} mls")
+        Tr8n.session.reset
+        Tr8n.logger.info("Request took #{@tr8n_finished_at - @tr8n_started_at} mls") if @tr8n_started_at
       end
 
     end