tr8n_core 4.0.4 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 176e098158a14899141b0806820928ab5a5dca78
-  data.tar.gz: ec746b4fb3729d02b5689ba15aa6639403977b99
+  metadata.gz: 371fea5f20b7e2f8cfb06f4bda1515060fbb3ab6
+  data.tar.gz: cf0ae840daf16a690b35243f5cb500b2f4c23548
 SHA512:
-  metadata.gz: bbec300dd025ef1981175efb9b245115c320080bacd001efb8ed2cd5ee0aff0d0ae66a9fd4f6c1a84b40f583a4cb0324bbdfb04e89437e17a79e2bf48033c22d
-  data.tar.gz: 3a80ed12cccb3ebe9d34ff032fafc59d8b7d8ce5db78f11abe15d23236c2cc33d409718ff03ac12a017b477fbfb5d140d4b5ea89d1a8fb2ec2138165143ab59b
+  metadata.gz: 1235999df54ca3cdcd5e959f1a4c71b6aeb92bae769da08bd3100f2654e81ce59cdbbf329000650edcf2e6dd78675e7e260e26f666048b26c3383f0720c3beb9
+  data.tar.gz: af88480f1e4d56fbd6dad45503d33c99768581a0be32acb19e34abc08d49814c6e6ae5c62f2156859c2afbb12ead7c2ff9c4534393381a8d7ddceef7b84e177c

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Michael Berkovich, tr8nhub.com
+Copyright (c) 2014 Michael Berkovich, TranslationExchange.com
 
 MIT License
 

data/README.md

@@ -17,6 +17,14 @@ The library works in conjunctions with tr8nhub.com service that provides machine
 In order to use the library, you should sign up at tr8nhub.com, create a new application and copy the application key and secret.
 
 
+Rails Integration
+==================
+
+If you are planning on using Tr8n in a Rails application, you should use tr8n_rails_client_sdk gem instead.
+
+https://github.com/tr8n/tr8n_rails_clientsdk
+
+
 Installation
 ==================
 
@@ -34,7 +42,7 @@ The library can be invoked from the IRB. To use tr8n client you must require it,
 
 ```ruby
 irb(main)> require 'tr8n_core'
-irb(main)> app = Tr8n::Application.init(KEY, SECRET)
+irb(main)> app = Tr8n.session.init(KEY, SECRET)
 ```
 
 Now you can use the application to get any language registered with your app:
@@ -154,7 +162,6 @@ Or in a simpler form:
 [bold: {user}] {user| получил, получила} [link: [bold: {count}] {count| сообщение, сообщения, сообщений}]
 ```
 
-
 One of the advantages of using TML is the ability to easily switch token values. The above example in a text based email can reuse translations:
 
 ```ruby
@@ -189,11 +196,42 @@ irb(main)> russian.translate('This is a new phrase without translations')
 => "Это новая фраза без перевода"
 ```
 
-More Information
+Links
 ==================
 
-If you are planning to use Tr8n in Rails application, you should use tr8n_rails_client_sdk gem instead.
+* Register on TranslationExchange.com: https://translationexchange.com
 
-https://github.com/tr8n/tr8n_rails_clientsdk
+* Read TranslationExchange's documentation: http://wiki.translationexchange.com
+
+* Visit TranslationExchange's blog: http://blog.translationexchange.com
+
+* 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
+
+
+Copyright and license
+==================
 
-To read more about TML (Translation Markup Language) syntax, please visit http://wiki.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
+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/lib/tr8n/api_client.rb

@@ -0,0 +1,109 @@
+# 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 'faraday'
+
+class Tr8n::ApiClient < Tr8n::Base
+  API_HOST = 'https://translationexchange.com'
+  API_PATH = '/tr8n/api/'
+
+  attributes :application
+
+  def access_token
+    application.access_token ||= begin
+      api("oauth/request_token",
+        {
+            :client_id => application.key,
+            :client_secret => application.secret,
+            :grant_type => :client_credentials
+        },
+        {
+            :host => application.host
+        }
+      )
+    end
+    application.access_token["access_token"]
+  end
+
+  def get(path, params = {}, opts = {})
+    api(path, params.merge(:access_token => access_token, :t => Time.now.to_i), opts)
+  end
+
+  def post(path, params = {}, opts = {})
+    api(path, params.merge(:access_token => access_token, :t => Time.now.to_i), opts.merge(:method => :post))
+  end
+
+  def self.error?(data)
+    not data["error"].nil?
+  end
+
+  def host
+    application.host || API_HOST
+  end
+
+  def api(path, params = {}, opts = {})
+    Tr8n.logger.trace_api_call(path, params) do
+      conn = Faraday.new(:url => host) do |faraday|
+        faraday.request(:url_encoded)               # form-encode POST params
+                                                    # faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter(Faraday.default_adapter)    # make requests with Net::HTTP
+      end
+
+      if opts[:method] == :post
+        response = conn.post("#{API_PATH}#{path}", params)
+      else
+        response = conn.get("#{API_PATH}#{path}", params)
+      end
+
+      data = JSON.parse(response.body)
+
+      unless data["error"].nil?
+        raise Tr8n::Exception.new("Error: #{data["error"]}")
+      end
+
+      process_response(data, opts)
+    end
+  end
+
+  def object_class(opts)
+    return unless opts[:class]
+    opts[:class].is_a?(String) ? opts[:class].constantize : opts[:class]
+  end
+
+  def process_response(data, opts)
+    if data["results"]
+      Tr8n.logger.debug("recieved #{data["results"].size} result(s)")
+      return data["results"] unless object_class(opts)
+      objects = []
+      data["results"].each do |data|
+        objects << object_class(opts).new(data.merge(opts[:attributes] || {}))
+      end
+      return objects
+    end
+
+    return data unless object_class(opts)
+    Tr8n.logger.debug("constructing #{object_class(opts).name}")
+    object_class(opts).new(data.merge(opts[:attributes] || {}))
+  end
+end

data/lib/tr8n/application.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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
@@ -23,40 +24,16 @@
 
 require 'faraday'
 
-API_HOST = 'https://tr8nhub.com'
-API_PATH = '/tr8n/api/'
-
 class Tr8n::Application < Tr8n::Base
   attributes :host, :key, :secret, :access_token, :name, :description, :threshold, :default_locale, :default_level
   has_many :features, :languages, :featured_locales, :sources, :components, :tokens, :css, :shortcuts
 
-  # Application Initialization
-  # If host can be provided to point to sandbox or other instance of the service
-  def self.init(key, secret, host = nil, options = {})
-    options[:definition] = true if options[:definition].nil?
-
-    host ||= API_HOST
-
-    Tr8n.cache.reset_version
-
-    Tr8n.logger.info("Initializing application...")
-
-    Tr8n.session.application = Tr8n.cache.fetch(cache_key(key)) do
-      # get access token and store it in the application
-      access_token = api("oauth/request_token", {:client_id => key, :client_secret => secret, :grant_type => :client_credentials}, {:host => host})
-
-      # get application details
-      api("application", {:client_id => key, :definition => options[:definition]}, {:host => host, :access_token => access_token["access_token"], :class => Tr8n::Application, :attributes => {
-          :host => host,
-          :key => key,
-          :secret => secret,
-          :access_token => access_token["access_token"]
-      }})
-    end
+  def fetch
+    update_attributes(api_client.get("application", {:definition => true}))
+    self
   end
 
-  # Initializes the application from a set of attributes received from the API
-  def initialize(attrs = {})
+  def update_attributes(attrs)
     super
 
     self.attributes[:languages] = []
@@ -99,8 +76,7 @@ class Tr8n::Application < Tr8n::Base
 
     return nil unless fetch
 
-    # for translator languages will continue to build application cache
-    @languages_by_locale[locale] = get("language", {:locale => locale}, {:class => Tr8n::Language, :attributes => {:application => self}})
+    @languages_by_locale[locale] = Tr8n::Language.new(:locale => locale, :application => self).fetch
 
     if Tr8n.config.cache[:enabled] and not Tr8n.cache.read_only?
       Tr8n.cache.store(Tr8n::Language.cache_key(locale), @languages_by_locale[locale])
@@ -134,7 +110,7 @@ class Tr8n::Application < Tr8n::Base
     return @sources_by_key[key] if @sources_by_key[key]
     return nil unless register
 
-    @sources_by_key[key] ||= post("source/register", {:source => key}, {:class => Tr8n::Source, :attributes => {:application => self}})
+    @sources_by_key[key] ||= api_client.post("source/register", {:source => key}, {:class => Tr8n::Source, :attributes => {:application => self}})
   end
 
   def component(key, register = true)
@@ -143,7 +119,7 @@ class Tr8n::Application < Tr8n::Base
     return @components_by_key[key] if @components_by_key[key]
     return nil unless register
 
-    @components_by_key[key] ||= post("component/register", {:component => key}, {:class => Tr8n::Component, :attributes => {:application => self}})
+    @components_by_key[key] ||= api_client.post("component/register", {:component => key}, {:class => Tr8n::Component, :attributes => {:application => self}})
   end
 
   def translation_keys
@@ -195,14 +171,14 @@ class Tr8n::Application < Tr8n::Base
       next unless keys.values.any?
       params << {:source => source, :keys => keys.values.collect{|tkey| tkey.to_hash(:label, :description, :locale, :level)}}
     end
-    post('source/register_keys', {:source_keys => params.to_json}, :method => :post)
+    api_client.post('source/register_keys', {:source_keys => params.to_json})
     @missing_keys_by_sources = nil
   end
 
   def featured_languages
     @featured_languages ||= begin
       locales = Tr8n.cache.fetch("featured_locales") do
-        get("application/featured_locales")
+        api_client.get("application/featured_locales")
       end
       # use app languages, there is no need for rules for this call
       (locales.nil? or locales.empty?) ? [] : languages.select{|l| locales.include?(l.locale)}
@@ -210,7 +186,7 @@ class Tr8n::Application < Tr8n::Base
   end
  
   def translators
-    get("application/translators", {}, {:class => Tr8n::Translator, :attributes => {:application => self}})
+    api_client.get("application/translators", {}, {:class => Tr8n::Translator, :attributes => {:application => self}})
   end
 
   def default_decoration_token(token)
@@ -257,66 +233,8 @@ class Tr8n::Application < Tr8n::Base
   ##  API Methods
   #######################################################################################################
 
-  def get(path, params = {}, opts = {})
-    api(path, params, opts)
-  end
-
-  def post(path, params = {}, opts = {})
-    api(path, params, opts.merge(:method => :post))
-  end
-
-  def self.error?(data)
-    not data["error"].nil?
-  end
-
-  def api(path, params = {}, opts = {})
-    #:access_token => access_token,
-    params = params.merge(:client_id => key,  :t => Time.now.to_i)
-    self.class.api(path, params, opts.merge(:host => self.host))
-  end
-
-  def self.api(path, params = {}, opts = {})
-    Tr8n.logger.trace_api_call(path, params) do
-      conn = Faraday.new(:url => opts[:host]) do |faraday|
-        faraday.request(:url_encoded)               # form-encode POST params
-        # faraday.response :logger                  # log requests to STDOUT
-        faraday.adapter(Faraday.default_adapter)    # make requests with Net::HTTP
-      end
-      
-      if opts[:method] == :post
-        response = conn.post("#{API_PATH}#{path}", params)
-      else
-        response = conn.get("#{API_PATH}#{path}", params)
-      end
-
-      data = JSON.parse(response.body)
-
-      unless data["error"].nil?
-        raise Tr8n::Exception.new("Error: #{data["error"]}")
-      end
-
-      process_response(data, opts)
-    end
-  end
-
-  def self.object_class(opts)
-    return unless opts[:class]
-    opts[:class].is_a?(String) ? opts[:class].constantize : opts[:class]
+  def api_client
+    @api_client ||= Tr8n::ApiClient.new(:application => self)
   end
 
-  def self.process_response(data, opts)
-    if data["results"]
-      Tr8n.logger.debug("recieved #{data["results"].size} result(s)")
-      return data["results"] unless object_class(opts)
-      objects = []
-      data["results"].each do |data|
-        objects << object_class(opts).new(data.merge(opts[:attributes] || {}))
-      end
-      return objects
-    end
-
-    return data unless object_class(opts)
-    Tr8n.logger.debug("constructing #{object_class(opts).name}")
-    object_class(opts).new(data.merge(opts[:attributes] || {}))
-  end
 end

data/lib/tr8n/base.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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
@@ -26,8 +27,12 @@ class Tr8n::Base
 
   def initialize(attrs = {})
     @attributes = {}
+    update_attributes(attrs)
+  end
+
+  def update_attributes(attrs = {})
     attrs.each do |key, value|
-      # pp [self.class.name, key, self.class.attributes, self.class.attributes.include?(key.to_sym)]
+      #pp [self.class.name, key, self.class.attributes, self.class.attributes.include?(key.to_sym)]
       next unless self.class.attributes.include?(key.to_sym)
       @attributes[key.to_sym] = value
     end

data/lib/tr8n/cache.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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

data/lib/tr8n/cache_adapters/cdb.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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

data/lib/tr8n/cache_adapters/file.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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

data/lib/tr8n/cache_adapters/memcache.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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

data/lib/tr8n/cache_adapters/redis.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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

data/lib/tr8n/component.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 #--
-# Copyright (c) 2014 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