tr8n_client_sdk 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+
+MIT License
+
+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.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Tr8n Client SDK for Ruby on Rails
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tr8n Client SDK for Ruby on Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+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
+
+
+task :default => :test

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

@@ -0,0 +1,20 @@
+<% if Tr8n.config.enabled? %>
+  <% featured_languages = Tr8n.config.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}  
+    </style>
+    <div class="tr8n_language_strip" style="font-size:12px;">
+      <% featured_languages.each do |lang| %>
+          <%= 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 %> 
+    </div>
+  <% end %>
+<% end %>

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

@@ -0,0 +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") %>
+  </div>
+</div>

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

@@ -0,0 +1,20 @@
+<% 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;
+  }
+  </style>
+
+  <script src="<%=Tr8n.config.application.js_boot_url%>"></script>
+
+<% end %>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Tr8nClientSdk::Engine.routes.draw do
+end

data/lib/generators/tr8n_client_sdk/templates/config/tr8n/config.yml

@@ -0,0 +1,53 @@
+defaults:
+  enabled:        true
+  default_locale: en-US
+  default_level:  0
+  application:
+    host:         http://localhost:3000
+    key:          6b714be8673fcc4a3
+    secret:       5c873790ebdc7d7b8
+  logger:
+    enabled:      false
+    path:         /log/tr8n.log
+  cache:
+    enabled:      false
+    adapter:      memcache
+    host:         localhost:11211
+    path:         /cache
+    version:      1
+    timeout:      3600
+  localization:
+    default_day_names:        [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]
+    default_abbr_day_names:   [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
+    default_month_names:      [January, February, March, April, May, June, July, August, September, October, November, December]
+    default_abbr_month_names: [Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
+    custom_date_formats:
+      default:                '%m/%d/%Y'            # 07/4/2008
+      short_numeric:          '%m/%d'               # 07/4
+      short_numeric_year:     '%m/%d/%y'            # 07/4/08
+      long_numeric:           '%m/%d/%Y'            # 07/4/2008
+      verbose:                '%A, %B %d, %Y'       # Friday, July  4, 2008
+      monthname:              '%B %d'               # July 4
+      monthname_year:         '%B %d, %Y'           # July 4, 2008
+      monthname_abbr:         '%b %d'               # Jul 4
+      monthname_abbr_year:    '%b %d, %Y'           # Jul 4, 2008
+      date_time:              '%m/%d/%Y at %H:%M'   # 01/03/1010 at 5:30
+  site_info:                  # used by the embedded mode
+    title:                    "Tr8n Sample Application"           # site title
+    contact_email:            "admin@tr8nhub.com"                 # default contact email
+    base_url:                 "http://localhost:3001"             # base site url
+    default_url:              "/home"
+    default_locale:           "en-US"                             # locale of the site default language
+    current_locale_method:    "current_locale"                    # application controller method that sets and returns current locale
+    user_info:                                                    # used by integrated and embedded modes
+      class_name:               User                              # class name for the User object type
+      current_user_method:      current_user                      # returns current user object
+      methods:                                                    # User object methods mapping
+        id:                     "id"
+        name:                   "name"
+        gender:                 "gender"
+        admin:                  "admin?"
+        guest:                  "guest?"                          # if current_user is nil, the user is automatically a guest
+        mugshot:                "mugshot"
+        link:                   "link"
+        locale:                 "locale"

data/lib/generators/tr8n_client_sdk/templates/config/tr8n/tokens/data.yml

@@ -0,0 +1,45 @@
+#############################################################################
+#
+# Tr8n Default Data Tokens
+#
+#############################################################################
+
+html:
+  ndash:    "–"       # –
+  mdash:    "—"       # —
+  iexcl:    "¡"       # ¡
+  iquest:   "¿"      # ¿
+  quot:     """        # "
+  ldquo:    "“"       # “
+  rdquo:    "”"       # ”
+  lsquo:    "‘"       # ‘
+  rsquo:    "’"       # ’
+  laquo:    "«"       # «
+  raquo:    "»"       # »
+  nbsp:     " "        # space
+  lsaquo:   "‹"      # ‹
+  rsaquo:   "›"      # ›
+  br:       "<br/>"         # line break
+  lbrace:   "{"
+  rbrace:   "}"
+  trade:    "&trade;"       # TM
+
+plain:
+  ndash:        "–"         # –
+  mdash:        "—"         # —
+  iexcl:        "¡"         # ¡
+  iquest:       "¿"         # ¿
+  quot:         '"'         # "
+  ldquo:        "“"         # “
+  rdquo:        "”"         # ”
+  lsquo:        "‘"         # ‘
+  rsquo:        "’"         # ’
+  laquo:        "«"         # «
+  raquo:        "»"         # »
+  nbsp:         " "         # space
+  lsaquo:       "‹"         # ‹
+  rsaquo:       "›"         # ›
+  br:           "\n"        # line break
+  lbrace:       "{"
+  rbrace:       "}"
+  trade:        "™"         # TM

data/lib/generators/tr8n_client_sdk/templates/config/tr8n/tokens/decorations.yml

@@ -0,0 +1,37 @@
+#############################################################################
+#
+# Tr8n Default Decoration Tokens
+#
+#############################################################################
+
+html:
+  strong:     "<strong>{$0}</strong>"
+  bold:       "<strong>{$0}</strong>"
+  b:          "<strong>{$0}</strong>"
+  em:         "<em>{$0}</em>"
+  italic:     "<i>{$0}</i>"
+  i:          "<i>{$0}</i>"
+  link:       "<a href='{$href}'>{$0}</a>"
+  br:         "<br>{$0}"
+  strike:     "<strike>{$0}</strike>"
+  div:        "<div id='{$id}' class='{$class}' style='{$style}'>{$0}</div>"
+  span:       "<span id='{$id}' class='{$class}' style='{$style}'>{$0}</span>"
+  h1:         "<h1>{$0}</h1>"
+  h2:         "<h2>{$0}</h2>"
+  h3:         "<h3>{$0}</h3>"
+
+plain:
+  strong:     "{$0}"
+  bold:       "{$0}"
+  b:          "{$0}"
+  em:         "{$0}"
+  italic:     "{$0}"
+  i:          "{$0}"
+  link:       "{$0}:{$1}"
+  br:         "\n{$0}"
+  strike:     "{$0}"
+  div:        "{$0}"
+  span:       "{$0}"
+  h1:         "{$0}"
+  h2:         "{$0}"
+  h3:         "{$0}"

data/lib/generators/tr8n_client_sdk/tr8n_client_sdk_generator.rb

@@ -0,0 +1,37 @@
+#--
+# Copyright (c) 2010-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 'rails/generators'
+
+class Tr8nClientSdkGenerator < Rails::Generators::Base
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def copy_configuration
+    config_source = File.expand_path("#{self.class.source_root}/config/tr8n", __FILE__)
+    system "rsync -ruv #{config_source} #{Rails.root}/config"
+  end
+  
+end

data/lib/tasks/tr8n_client_sdk_tasks.rake

@@ -0,0 +1,30 @@
+#--
+# Copyright (c) 2010-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.
+#++
+
+namespace :tr8n_client_sdk do
+
+  task :init => :environment do
+    
+  end
+
+end

data/lib/tr8n_client_sdk.rb

@@ -0,0 +1,28 @@
+#--
+# Copyright (c) 2010-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 "tr8n_client_sdk/railtie"
+require "tr8n_client_sdk/engine"
+
+module Tr8nClientSdk
+end

data/lib/tr8n_client_sdk/config.rb

@@ -0,0 +1,197 @@
+#--
+# 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 Tr8nClientSdk
+  class Config < ::Tr8n::Config
+    thread_safe_attributes :application, :current_user, :current_language, :current_translator, :current_source, :current_component
+    thread_safe_attributes :block_options
+
+    def root
+      Rails.root
+    end
+
+    def env
+      Rails.env
+    end
+
+    def defaults
+      @defaults ||= HashWithIndifferentAccess.new(Tr8n::Utils.load_yaml("#{root}/config/tr8n/config.yml", env))
+    end
+
+    def default_data_tokens
+      @default_data_tokens ||= Tr8n::Utils.load_yaml("#{root}/config/tr8n/tokens/data.yml")
+    end
+
+    def default_decoration_tokens
+      @default_decoration_tokens ||= Tr8n::Utils.load_yaml("#{root}/config/tr8n/tokens/decorations.yml")
+    end
+
+    def init_request(user, translator, locale, source = nil, component = nil)
+      self.current_user = user
+      self.current_translator = translator
+      self.current_language = (application.language(locale) || default_language)
+      self.current_source = source
+      self.current_component = component
+
+      # # register source with component
+      # unless component.nil?
+      #   set_component(application.component_by_key(component))
+      #   current_component.register_source(current_source)
+      # else
+      #   set_component(nil)
+      # end
+    end
+
+    #def current_user_is_authorized_to_view_component?(component = current_component)
+    #  return true if component.nil? # no component present, so be it
+    #  component = application.component_by_key(component.to_s) if component.is_a?(Symbol)
+    #
+    #  return true unless component.restricted?
+    #  return false unless Tr8n.config.current_translator
+    #  return true if component.translator_authorized?
+    #
+    #  false
+    #end
+    #
+    #def current_user_is_authorized_to_view_language?(component = current_component, language = current_language)
+    #  return true if component.nil? # no component present, so be it
+    #  component = application.component_by_key(component.to_s) if component.is_a?(Symbol)
+    #
+    #  # if Tr8n.config.current_translator
+    #  #   return true if component.translator_authorized?
+    #  # end
+    #
+    #  # component.component_languages.each do |cl|
+    #  #   return cl.live? if cl.language_id == language.id
+    #  # end
+    #
+    #  true
+    #end
+
+    def decorator_class
+      Tr8n::Decorators::Html
+    end
+
+    def reset_request
+      reset
+    end
+
+    def url_for(path)
+      "#{defaults["host"]}#{path}"
+    end
+
+    #########################################################
+    # Site Info
+    #########################################################
+    def site_info
+      defaults[:site_info]
+    end
+
+    def site_title
+      site_info[:title]
+    end
+
+    def base_url
+      site_info[:base_url]
+    end
+
+    def default_url
+      site_info[:default_url]
+    end
+
+    def contact_email
+      site_info[:contact_email]
+    end
+
+    def default_locale
+      return block_options[:default_locale] if block_options[:default_locale]
+      site_info[:default_locale]
+    end
+
+    def default_admin_locale
+      return block_options[:default_admin_locale] if block_options[:default_admin_locale]
+      site_info[:default_admin_locale]
+    end
+
+    def current_locale_method
+      site_info[:current_locale_method]
+    end
+
+    #########################################################
+    # site user info
+    # The following methods could be overloaded in the initializer
+    #########################################################
+    def site_user_info
+      site_info[:user_info]
+    end
+
+    def current_user_method
+      site_user_info[:current_user_method]
+    end
+
+    def user_class_name
+      site_user_info[:class_name]
+    end
+
+    def user_class
+      user_class_name.constantize
+    end
+
+    def user_id(user)
+      return 0 unless user
+      user.send(site_user_info[:methods][:id])
+    rescue Exception => ex
+      Tr8n::Logger.error("Failed to fetch user id: #{ex.to_s}")
+      0
+    end
+
+    def user_name(user)
+      return "Unknown user" unless user
+      user.send(site_user_info[:methods][:name])
+    rescue Exception => ex
+      Tr8n::Logger.error("Failed to fetch #{user_class_name} name: #{ex.to_s}")
+      "Invalid user"
+    end
+
+    def user_gender(user)
+      return "unknown" unless user
+      user.send(site_user_info[:methods][:gender])
+    rescue Exception => ex
+      Tr8n::Logger.error("Failed to fetch #{user_class_name} name: #{ex.to_s}")
+      "unknown"
+    end
+
+    def guest_user?(user = Tr8n.config.current_user)
+      return true unless user
+      user.send(site_user_info[:methods][:guest])
+    rescue Exception => ex
+      Tr8n::Logger.error("Failed to fetch #{user_class_name} guest flag: #{ex.to_s}")
+      true
+    end
+
+    def current_user_is_guest?
+      guest_user?
+    end
+
+  end
+end