tml 5.4.8 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66299fedc0ad670424b3c099d816feca815f25cc
-  data.tar.gz: a3511b6492de5957d70cf7abdc70f44b7b87491e
+  metadata.gz: b7bc2c8b32d5455a156eebf41a65c19b6a7cbfd9
+  data.tar.gz: f9ee0897ad9781e22a18dc2ba9aaf3386808e9ce
 SHA512:
-  metadata.gz: 31bad9591d26cdeb58bf2ecb8c0720ba728f966c6f29b743665476e3ce807163bbe875262dcf9647145d9fc74b7e182099accdc1b658d67073e28592431583ad
-  data.tar.gz: 521afb4459fa5d718f957a94f3839634f6894e00b754248b8c09592388e2fd04c0d25fc5e8738072e4fc600c81163776e00020215f5d85ce1043fb14db7511a9
+  metadata.gz: 47764416ebb9968bd83076755164c8189c803f9bc88d3b491ba27363b954cf1186d7b0a608e9c62b63a89d4510a9d0cd579d65d50bafef2bdf8a6df614f0e502
+  data.tar.gz: 334d36b8e44bde4865cf36a0eb10e7b58a2f2850990ef0ba090ac215329413d19c1369bf6efeb42f04121278f797f695ea65faeb5022f280153aba649900dde4

data/lib/tml/api/client.rb

@@ -69,9 +69,14 @@ class Tml::Api::Client < Tml::Base
     not data['error'].nil?
   end
 
+  # API Host
+  def host
+    application.host
+  end
+
   # API connection
   def connection
-    @connection ||= Faraday.new(:url => application.host) do |faraday|
+    @connection ||= 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
@@ -187,6 +192,7 @@ class Tml::Api::Client < Tml::Base
   def api(path, params = {}, opts = {})
     # inline mode should always use API calls
     if live_api_request?
+      params = params.merge(:access_token => access_token, :app_id => application.key)
       return process_response(execute_request(path, params, opts), opts)
     end
 
@@ -249,10 +255,8 @@ class Tml::Api::Client < Tml::Base
 
     path = prepare_api_path(path)
 
-    params = params.merge(:access_token => access_token, :app_id => application.key)
-
     @compressed = false
-    trace_api_call(path, params, opts.merge(:host => application.host)) do
+    trace_api_call(path, params, opts.merge(:host => host)) do
       begin
         if opts[:method] == :post
           response = connection.post(path, params)

data/lib/tml/application.rb

@@ -38,7 +38,7 @@ class Tml::Application < Tml::Base
   CDN_HOST = 'https://cdn.translationexchange.com'
   # CDN_HOST = 'https://trex-snapshots.s3-us-west-1.amazonaws.com'
 
-  attributes :host, :cdn_host, :id, :key, :access_token,  :name, :description, :threshold, :default_locale, :default_level
+  attributes :host, :cdn_host, :id, :key, :access_token, :name, :description, :threshold, :default_locale, :default_level
   has_many :features, :languages, :languages_by_locale, :sources, :tokens, :css, :shortcuts, :translations, :extensions
   has_many :ignored_keys
 
@@ -56,10 +56,12 @@ class Tml::Application < Tml::Base
     access_token
   end
 
+  # API host
   def host
     super || API_HOST
   end
 
+  # CDN host
   def cdn_host
     super || CDN_HOST
   end

data/lib/tml/config.rb

@@ -75,7 +75,7 @@ module Tml
   # The class can be extended with a different implementation, as long as the interface is supported
   class Config
     # Configuration Attributes
-    attr_accessor :enabled, :locale, :default_level, :format, :application, :context_rules, :logger, :cache, :default_tokens, :localization
+    attr_accessor :enabled, :locale, :default_level, :format, :application, :postoffice, :context_rules, :logger, :cache, :default_tokens, :localization
     attr_accessor :auto_init, :source_separator
 
     # Used by Rails and Sinatra extensions
@@ -119,6 +119,7 @@ module Tml
       @current_user_method = :current_user
 
       @application = nil
+      @postoffice = nil
 
       @translator_options = {
         debug: false,

data/lib/tml/postoffice.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2016 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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 Tml
+
+  class << self
+    attr_accessor :postoffice
+  end
+
+  def self.postoffice
+    @postoffice ||= begin
+      po_config = Tml.config.postoffice || {}
+      Tml::Postoffice.new(
+        key:    po_config[:key],
+        token:  po_config[:token],
+        host:   po_config[:host]
+      )
+    end
+  end
+
+  class Postoffice < Tml::Base
+
+    PO_HOST = 'https://postoffice.translationexchange.com'
+    API_VERSION = 'v1'
+
+    attributes :host, :key, :access_token
+
+    # API host
+    def host
+      super || PO_HOST
+    end
+
+    # API token
+    def token
+      access_token
+    end
+
+    # Postoffice API client
+    def deliver(to, template, tokens = {}, options = {})
+      if key.blank?
+        Tml.logger.error("Failed to deliver #{template} to #{to} - PostOffice has not been configured")
+        return
+      end
+
+      Tml.logger.debug("Delivering #{template} to #{to}")
+      params = {
+        client_id: key,
+        template: template,
+        tokens: tokens,
+        to: to,
+        via: options[:via],
+        from: options[:from],
+        locale: options[:locale],
+        first_name: options[:first_name],
+        last_name: options[:last_name],
+        name: options[:name]
+      }
+      params = Tml::Utils.remove_nils(params)
+      api_client.execute_request("#{host}/api/#{API_VERSION}/deliver", params, {:method => :post})
+    end
+
+    private
+
+    # Create API client
+    def api_client
+      @api_client ||= Tml.config.api_client[:class].new(application: self)
+    end
+
+  end
+end

data/lib/tml/session.rb

@@ -43,22 +43,29 @@ module Tml
     def init(opts = {})
       return if Tml.config.disabled?
 
-      key       = opts[:key]          || Tml.config.application[:key]
-      host      = opts[:host]         || Tml.config.application[:host]
-      cdn_host  = opts[:cdn_host]     || Tml.config.application[:cdn_host]
-      token     = opts[:access_token] || opts[:token] || Tml.config.application[:token]
+      # Tml.logger.debug(opts.inspect)
 
       Tml.cache.reset_version
       Tml.cache.namespace = opts[:namespace]
 
+      init_application(opts)
+
+      self
+    end
+
+    def init_application(opts = {})
       self.current_user = opts[:user]
       self.current_source = opts[:source] || 'index'
       self.current_locale = opts[:locale]
       self.current_translator = opts[:translator]
 
-      # Tml.logger.debug(opts.inspect)
-
-      self.application = Tml::Application.new(:key => key, :access_token => token, :host => host, :cdn_host => cdn_host).fetch
+      app_config = Tml.config.application || {}
+      self.application = Tml::Application.new(
+          :key => opts[:key] || app_config[:key],
+          :access_token => opts[:access_token] || opts[:token] || app_config[:token],
+          :host => opts[:host] || app_config[:host],
+          :cdn_host => opts[:cdn_host] || app_config[:cdn_host]
+      ).fetch
 
       if self.current_translator
         self.current_translator.application = self.application
@@ -66,8 +73,6 @@ module Tml
 
       self.current_locale = preferred_locale(opts[:locale])
       self.current_language = self.application.current_language(self.current_locale)
-
-      self
     end
 
     def preferred_locale(locales)

data/lib/tml/utils.rb

@@ -75,6 +75,12 @@ module Tml
       hash[key.to_s] || hash[key.to_sym]
     end
 
+    def self.remove_nils(hash)
+      return unless hash
+      proc = Proc.new { |k, v| v.kind_of?(Hash) ? (v.delete_if(&proc); nil) : v.blank? }
+      hash.delete_if(&proc)
+    end
+
     def self.load_json(file_path, env = nil)
       json = JSON.parse(File.read(file_path))
       return json if env.nil?

data/lib/tml/version.rb

@@ -31,7 +31,7 @@
 #++
 
 module Tml
-  VERSION = '5.4.8'
+  VERSION = '5.5.0'
 
   def self.full_version
     "tml-ruby v#{Tml::VERSION} (Faraday v#{Faraday::VERSION})"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tml
 version: !ruby/object:Gem::Version
-  version: 5.4.8
+  version: 5.5.0
 platform: ruby
 authors:
 - Michael Berkovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,6 +76,7 @@ files:
 - lib/tml/language_context_rule.rb
 - lib/tml/languages/en.json
 - lib/tml/logger.rb
+- lib/tml/postoffice.rb
 - lib/tml/rules_engine/evaluator.rb
 - lib/tml/rules_engine/parser.rb
 - lib/tml/session.rb