zmeygo_sync 0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in trclient.gemspec
+gem 'rest-client', :git => 'git://github.com/archiloque/rest-client.git'

data/README.rdoc

@@ -0,0 +1,115 @@
+= Zmeygo Syncronizer
+
+Zmeygo syncronizer is a convinient tool to interface with zmeygo.com service. Zmeygo
+service helps you to manage internationalization data of your rails applications.
+
+== Install
+
+Add to Gemfile of your rails project
+
+ gem 'zmeygo'
+
+After that run
+
+ bundle install
+
+This will generate ./script/zmeygo_sync and ./config/zmeygo_sync.yml
+
+== Usage
+
+=== Configuration
+
+Every time you will run zg command it will check for configutation file
+.zmeygo/config.yml in your home folder. To generate a template for config file
+run command
+
+ zg init
+
+Then go and edit ~/.zmeygo/config.yml. In config file add correct values for
+
+* api_token - you can see your api_token in your user profile in zmeygo.com
+
+* default_project - One user will have associated more the one project. Zmeygo client right now can work only with one of them - default project. When you will run zg command to push keys on the server, they will be pushed automatically to default project. Right now there is no other way to specify other project.
+
+* locale_dir - this is place where zg client will download all pulled locale files from the server
+Below is an example of ~/.zmego/config.yml file:
+
+   → cat ~/.zmeygo/config.yml
+  # Configuration file for zmeygo
+  #
+
+  defaults: &defaults
+    server: http://zmeygo.com
+    api_token: 4e02abc123ef7e3528001231
+    default_project: my_proj
+    locale_dir: /home/john/rails_projects/my_proj/config/locales
+
+  development:
+    <<: *defaults
+
+  production:
+    <<: *defaults
+
+=== Check server connection
+
+In order to check server connectivity run command
+
+  zg ping
+
+If you don't have connection to the server, then most probably you are behind
+proxy (like me in the office). Setup environment variable $http_proxy or/and
+$https_proxy and smart zg will detect and use it. If that didn't work like ISP
+support says **check if you have plugged internet cable** :D
+
+It will display OK if you can connect to server. Now you are ready for real
+action!
+
+=== Pull data from server
+
+One of two greatest thing that zmeygo client was designed for is to pull data from
+server. Command:
+
+ zg pull
+
+This command will download locales files of default project (specified in config
+file) to location locale_dir also specified in configuration file. This command
+is a shortcut for downloading manually locale files. There will be downloaded
+one file per locale. Existing locale files will be overriden.
+
+=== Push data to server
+
+Second of the greatest thing that zmeygo client was designed for is to push data
+to the server. The command:
+
+ zg push
+
+Will push all locally cached i18n key to the server. To list locally cached keys
+use command:
+
+ zg list cache
+
+I18n keys are stored in cached by zmeygo gem included in Rails application. Next
+section describes this in detail.
+
+=== Use zmeygo gem from Rails application
+
+To make possible pushing of i18n keys to the zmeygo server, include zmeygo gem
+into your rails project with gem 'zmeygo' in Gemfile. Then in your development
+environment put
+
+  Zmeygo.configure
+
+which will load configurations from ~/.zmeygo/config.yml file. Zmeygo gem adds
+custom exception handler to I18n gem, thus every missing translation exeption
+thrown by I18n will insert missing key into zmeygo local cache. This means that
+you just add as usual I18n.t call to the view, then while you are browsing your
+application views, missing keys will be collected by zmeygo locally. Here and
+there, run somewhere in command line:
+
+ zg push
+
+This will push all cached key to zmeygo server. And voila, you can translate
+your keys to whatever locale you choose on the server.
+
+Send all your questions to: eugen@zmeygo.com
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/TODO

@@ -0,0 +1,6 @@
+Write tests to test 3 basic things this gem will do
+1. Hook into I18n.translate
+2. Gather cache
+3. Send cache (push method)
+4. Receive locale data (pull method)
+

data/lib/generators/zmeygo_sync/templates/config.yml

@@ -0,0 +1,13 @@
+# Configuration file for zmeygo
+#
+
+defaults: &defaults
+  api_token: <your account api_token here>
+  project: my_project_name
+
+development:
+  <<: *defaults
+
+production:
+  <<: *defaults
+

data/lib/generators/zmeygo_sync/templates/script

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'environment'))
+require 'zmeygo/command'
+Zmeygo::Command.new(ARGV).daemonize

data/lib/generators/zmeygo_sync/zmeygo_sync_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+class ZmeygoSyncGenerator < Rails::Generators::Base
+
+  self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+  def create_script_file
+    template 'script', 'script/zmeygo_sync'
+    template 'config.yml', 'config/zmeygo_sync.yml'
+    chmod 'script/zmeygo_sync', 0755
+    chmod 'config/zmeygo_sync.yml', 0755
+  end
+end

data/lib/zmeygo_sync/base.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'fileutils'
+require 'rest_client'
+require 'json'
+require 'i18n'
+require 'active_support'
+require 'active_support/core_ext/hash'
+require 'yaml'
+require 'logger'
+
+require File.join(File.dirname(__FILE__),'/version')
+require File.join(File.dirname(__FILE__),'/constant')
+require File.join(File.dirname(__FILE__),'/configuration')
+require File.join(File.dirname(__FILE__),'/client')
+require File.join(File.dirname(__FILE__),'/command')
+require File.join(File.dirname(__FILE__),'/cache')
+
+module ZmeygoSync
+  class << self
+    attr_accessor :client
+    attr_accessor :config
+    attr_accessor :cache
+    attr_accessor :logger
+
+    def method_missing(method, *args)
+      self.cache.respond_to?(method)? cache.send(method, *args) : super
+    end
+
+    def configure
+      self.config ||= Configuration.new
+      if block_given?
+        yield(config)
+      end
+      self.cache = Cache.new
+      self.logger = Logger.new(File.join(Rails.root, 'log', 'zmeygo_sync.log'))
+    end
+  end
+end

data/lib/zmeygo_sync/cache.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+
+module ZmeygoSync
+  # Cache is responsable to gather missing keys from I18n.t/I18n.translate
+  # calls and once in a while send them to server.
+  # Server where keys will be sent is configured in config file Zmeygo.config['server']
+  class Cache
+    def initialize
+      @config = Zmeygo.config
+      @missing_keys = {}
+      @cache_file_path = "#{Rails.root}/tmp/zmeygo_sync_cache"
+    end
+
+    def get_cache_proj
+      proj = validate_config!
+      proj
+    end
+
+    def get_cache
+      proj = validate_config!
+      @missing_keys[proj]
+    end
+
+    def empty?
+      File.zero?(@cache_file_path)
+    end
+
+    def add_to_cache(key)
+      proj = validate_config!
+      @missing_keys[proj] ||= {}
+      @missing_keys[proj][key] = true
+      File.open(@cache_file_path,'w') do |f|
+        f.write(Marshal.dump(@missing_keys))
+      end
+    end
+
+    def load_cache
+      hash = {}
+      File.open(@cache_file_path,'r') do |f|
+        data = f.read
+        begin
+          hash = Marshal.load(data)
+        rescue => e
+          puts e
+          return
+        end
+      end
+      hash
+    end
+
+    def clear_cache
+      proj = validate_config!
+      @missing_keys[proj].clear
+      File.truncate(@cache_file_path,0)
+    end
+
+    def validate_config!
+      proj = @config['project']
+      if proj.blank?
+        raise "Please provide default project name in"
+      end
+      @missing_keys[proj] ||= {}
+      proj
+    end
+
+  end # Cache
+end # Zmeygo
+

data/lib/zmeygo_sync/client.rb

@@ -0,0 +1,208 @@
+# encoding: utf-8
+require 'ya2yaml'
+
+module ZmeygoSyncSync
+  class Client
+
+    attr_accessor :config, :options
+
+    def  initialize(options={})
+       self.options = options
+       self.config = ZmeygoSyncSync.config
+    end
+
+    def push
+      if ZmeygoSync.cache.empty?
+        puts "No cache" if options[:verbose]
+        return
+      end
+      url = "http://ZmeygoSync.com/api/pushmissing?api_token=#{config['api_token']}"
+      keys = []
+      hash = ZmeygoSync.load_cache
+      puts "cache=#{hash}" if options[:verbose]
+      ZmeygoSync.clear_cache
+      begin
+        puts "POST #{url}" if options[:verbose]
+        response = RestClient.post(url,:data => hash)
+      rescue
+        puts "Direct http request #{url} failed!" if options[:verbose]
+        if RestClient.proxy.nil?
+          puts "Now retrying through proxy..." if options[:verbose]
+          if ENV['http_proxy']
+            puts "Environment variable http_proxy found." if options[:verbose]
+            RestClient.proxy = ENV['http_proxy']
+            retry
+          end
+        end
+        puts "http request #{url} failed!"
+        exit
+      end
+      if response.code == 200
+        reply = JSON.parse(response.body)
+      elsif response.code == 401
+        puts "Invalid api_token given."
+      elsif response.code == 500
+        puts "Ooops! Internal server error."
+      end
+    end
+
+    def ping
+      puts "pinging server #{config[:server]} ..." if options[:verbose]
+      http_connect('ping') do |reply|
+        reply['message']
+      end
+    end
+
+    def list_config
+      puts "Server: #{config[:server]}"
+      puts "Default project: #{config[:default_project]}"
+    end
+
+    def list
+      case options[:list]
+      when "projects"
+        return list_projects
+      when "locales"
+        return list_locales
+      when "config"
+        return list_config
+      when 'cache'
+        return list_cache
+      else
+        return "list what? projects or locales or cache?"
+      end
+    end
+
+    def list_cache
+      hash = {}
+      total = 0
+      file = "#{Rails.root}/tmp/ZmeygoSync_sync_cache"
+      if File.zero?(file)
+        puts "No cache" if options[:verbose]
+        return
+      end
+      File.open(file,'r') do |f|
+        begin
+          data = f.read
+          hash = Marshal.load(data)
+        rescue  => e
+          puts e
+          puts "No cache"
+          return
+        end
+      end
+      if hash.empty?
+        puts "No cache"
+      else
+        hash.each_pair do |proj,v|
+          puts "===== #{proj} ====="
+          v.each_pair do |key,options|
+              puts "#{key} => #{options}"
+              total += 1
+          end
+        end
+      end
+      "==== Total #{total} keys ===="
+    end
+
+    def list_projects
+      http_connect('available_projects') do |reply|
+        if reply['message'] == 'OK'
+          return reply['data']
+        else
+          return reply['message']
+        end
+      end
+    end
+
+    def list_locales
+      project = config['project']
+
+      if project.nil?
+        return "Please provide project name for which I should list locales. Use -p option."
+      end
+      http_connect("available_locales/#{project}") do |reply|
+        if reply['message'] == 'OK'
+          return reply['data']
+        else
+          puts "#{reply['message']}"
+          return reply['message']
+        end
+      end
+    end
+
+    def translate
+      project,locale,key = options[:project],options[:locale],options[:key]
+      project ||= config.default_project
+
+      http_connect("tr/#{project}/#{locale}/#{key}") do |reply|
+        if reply['message'] == 'OK'
+          return reply['data']
+        else
+          return reply['message']
+        end
+      end
+    end
+
+    def pull
+      project = config['project']
+      if project.nil?
+        puts "Please provide project name from where to pull i18n keys from. Either use -p option or specify default project in config file."
+        return
+      end
+      # pull all available locales
+      locales = list_locales
+      # for each available locale requst i18n data
+      locales.split(',').each do |loc|
+        pull_translations(project,loc)
+      end
+    end
+
+    def http_connect(path)
+      url = "#{config['server'] || 'http://ZmeygoSync.com'}/api/#{path}?api_token=#{config['api_token']}"
+      begin
+        puts "GET #{url}" if options[:verbose]
+        response = RestClient.get(url)
+      rescue
+        puts "Direct http request #{url} failed!" if options[:verbose]
+        if RestClient.proxy.nil?
+          puts "Now retrying through proxy..." if options[:verbose]
+          if ENV['http_proxy']
+            puts "Environment variable http_proxy found." if options[:verbose]
+            RestClient.proxy = ENV['http_proxy']
+            retry
+          end
+        end
+        puts "http request #{url} failed!"
+        exit
+      end
+      if response.code == 200
+        reply = JSON.parse(response.body)
+        yield(reply)
+      elsif response.code == 401
+        puts "Invalid api_token given."
+      elsif response.code == 500
+        puts "Ooops! Internal server error."
+      end
+    end
+    private
+      def pull_translations(project,locale_code)
+        request_line = "tr/#{project}/#{locale_code}"
+        http_connect(request_line) do |reply|
+          if reply['message'] == 'OK'
+            hash_result = reply['data']
+            folder = File.expand_path(File.join(Rails.root,'config','locales'))
+            unless File.exists?(folder)
+              FileUtils.mkdir_p(folder)
+            end
+            File.open(folder + "/#{locale_code}.yml", 'w') do |f|
+              ZmeygoSync.logger.info "saving file #{locale_code}.yml..."
+              f.write(hash_result.ya2yaml)
+            end
+          else
+            puts "Message: #{reply['message']}"
+          end
+        end
+      end
+  end
+end

data/lib/zmeygo_sync/command.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'daemons'
+require 'optparse'
+
+module ZmeygoSyncSync
+  class Command
+
+    attr_accessor :options, :client
+
+    def initialize(args ={})
+       @options = {
+        :verbose => false,
+        :pid_dir => "#{Rails.root}/tmp/pids",
+        :sleep_delay => 10,
+        :debug => false # when debug is false - it will daomonize, otherwise - it won't
+      }
+
+      @monitor = false
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [options] start|stop|restart|run"
+
+        opts.on('-h', '--help', 'Show this message') do
+          puts opts
+          exit 1
+        end
+        opts.on('-s','--sleep-delay N', "Amount of time to sleep when no jobs are found") do |n|
+          @options[:sleep_delay] = n.to_i
+        end
+        opts.on('-v','--verbose', "verbosity") do
+          @options[:verbose] = true
+        end
+        opts.on('-d','--debug', "debug mode, don't daemonize") do
+          @options[:debug] = true
+        end
+      end
+      @args = opts.parse!(args)
+
+      ZmeygoSync.configure
+
+      self.options = @options
+      self.client = ZmeygoSync::Client.new(@options)
+
+    end
+
+    def run
+      unless defined?(Rails)
+        raise "This is not rails app???"
+      end
+      loop do
+        self.client.push
+        self.client.pull
+        sleep(@options[:sleep_delay])
+      end
+    rescue => e
+      Rails.logger.fatal e
+      STDERR.puts e.message
+      exit 1
+    end
+
+    def daemonize
+      if @options[:debug]
+        run
+      else
+        Daemons.run_proc('zmeygo_sync') { run }
+      end
+    end
+  end
+end

data/lib/zmeygo_sync/configuration.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+module ZmeygoSync
+  require 'yaml'
+  require 'fileutils'
+
+  class Configuration
+    attr_accessor :server, :api_token, :locale_dir, :project
+
+    def initialize
+      conf_file = File.join(Rails.root,'config','zmeygo.yml')
+      conf_all = YAML.load_file(File.expand_path(conf_file))
+      conf = conf_all[Rails.env]
+      conf['server'] = 'http://zmeygo.com'
+      self.api_token = conf['api_token']
+      self.project = conf['project']
+    end
+
+    def [](key)
+      if self.respond_to?(key)
+        send(key)
+      end
+    end
+  end
+end

data/lib/zmeygo_sync/constant.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+#
+module ZmeygoSync
+  class Constant
+    DEFAULT_CONFIG_FILE = "#{Rails.root}/config/zmeygo.yml"
+    CACHE_FILE = "#{Rails.root}/tmp/zmeygo_sync_cache"
+  end
+end

data/lib/zmeygo_sync/i18n_backend.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module ZmeygoSync
+  class I18nBackend
+
+    attr_accessor :client
+
+    def  initialize(options={})
+      @collection = {}
+      @options = options
+      Zmeygo.configure
+      self.client = Zmeygo::Client.new(options)
+    end
+
+    def translate(locale, key, options = {})
+      client.translate(nil,locale,key)
+    end
+  end
+end
+

data/lib/zmeygo_sync/version.rb

@@ -0,0 +1,3 @@
+module ZmeygoSync
+  VERSION = "0.2"
+end

data/lib/zmeygo_sync.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__),'/zmeygo_sync/base')
+
+module I18n
+  class << self
+    def custom_exception_handler(*args)
+      args.shift
+      locale = args.shift
+      key = args.shift
+      ZmeygoSync.add_to_cache(key)
+      # return an aproximation of translation
+      # This is last part of dot separated key, with _ replaced with space,
+      # capitalized and inserted between square brakets. I found this to be best
+      # aproximation of future translation.
+      arr = key.to_s.split('.')
+      last = if arr.respond_to?(:last)
+        arr.last
+      else
+        arr
+      end
+      "["+last.tr('_',' ').capitalize+"]"
+    end
+  end
+  I18n.exception_handler = :custom_exception_handler
+end
+
+

data/test/ext_i18n_test.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__),'/test_helper')
+require File.join(File.dirname(__FILE__),'../lib/zmeygo')
+
+class ExtI18nTest < Test::Unit::TestCase
+  # check if i18n.t method indeed populates Zmeygo.missing_keys
+  def setup
+
+  end
+  def test_assert_i18n_translate
+    Zmeygo.clear_cache
+    assert_equal 0, Zmeygo.get_cache.size
+    I18n.t :key1
+    I18n.t :key2
+    assert_equal 2, Zmeygo.get_cache.size
+    assert Zmeygo.get_cache.include?(:key1)
+    assert Zmeygo.get_cache.include?(:key2)
+  end
+
+  # c
+  def test_if_i18n_correctly_populates_cache
+    Zmeygo.clear_cache
+    assert_equal 0, Zmeygo.get_cache.size
+    I18n.t :some_key
+    I18n.t :other_key
+    I18n.t 'text.signin'
+    cache =  Zmeygo.get_cache.clone
+    proj = Zmeygo.get_cache_proj
+    assert_equal Zmeygo.config['default_project'],proj
+    assert cache.include?(:some_key)
+    assert cache.include?(:other_key)
+    assert cache.include?('text.signin')
+    assert cache.size == 3
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require 'test/unit'

data/zmeygo_sync.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'zmeygo_sync/version'
+
+Gem::Specification.new do |s|
+  s.name        = "zmeygo_sync"
+  s.version     =  ZmeygoSync::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Eugen Ciur"]
+  s.email       = ["eugen@zmeygo.com"]
+  s.homepage    = "http://zmeygo.com"
+  s.summary     = "Zmeygo service syncronizer"
+  s.description = "Syncs local i18n data with Zmeygo service"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.has_rdoc         = true
+  s.require_path       = 'lib'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: zmeygo_sync
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.2"
+platform: ruby
+authors: 
+- Eugen Ciur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-17 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Syncs local i18n data with Zmeygo service
+email: 
+- eugen@zmeygo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- README.ro.rdoc
+- README.ru.rdoc
+- Rakefile
+- TODO
+- lib/generators/zmeygo_sync/templates/config.yml
+- lib/generators/zmeygo_sync/templates/script
+- lib/generators/zmeygo_sync/zmeygo_sync_generator.rb
+- lib/zmeygo_sync.rb
+- lib/zmeygo_sync/base.rb
+- lib/zmeygo_sync/cache.rb
+- lib/zmeygo_sync/client.rb
+- lib/zmeygo_sync/command.rb
+- lib/zmeygo_sync/configuration.rb
+- lib/zmeygo_sync/constant.rb
+- lib/zmeygo_sync/i18n_backend.rb
+- lib/zmeygo_sync/version.rb
+- test/ext_i18n_test.rb
+- test/test_helper.rb
+- zmeygo_sync.gemspec
+has_rdoc: true
+homepage: http://zmeygo.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Zmeygo service syncronizer
+test_files: []
+