zmeygo 0.1

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,120 @@
+= Zmeygo Client
+
+Zmeygo client is a convinient tool to interface with zmeygo.com service. Zmeygo
+service helps you to manage internationalization data of your rails applications.
+
+== Why you need zmeygo client?
+
+To syncronize with server. To manage i18n data, you need to push it on zmeygo.com server. i18n data are all keys you provide to I18n.translate (or its alias I18n.t) method.  You can use client to <i>push keys to</i> the server. Also you can use client to <i>pull keys from</i> the server.
+
+== Install
+
+Install it as you would do for any other ruby gem
+
+ gem install zmeygo
+
+After you do so you will have available zg executable. Check it with command:
+
+ zg help
+
+Besides being available as an executable, zmeygo is available as gem which can
+be included in Rails project. More on this later.
+
+== 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,2 @@
+REFACTORING
+

data/bin/zg

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+require  File.join(File.dirname(__FILE__),'../lib/zmeygo/base')
+
+USAGE = <<USAGE
+Client v#{Zmeygo::VERSION} used for zmeygo.com service.
+----------------------------------------
+Usage: zg COMMAND [options]
+where COMMAND is one of following:
+  ping   - run this command to check server connectivity.
+  config - generates configuration file in ~/zmeygo.yml
+  list [projects|locales|config|cache] - see respective details. See below.
+  pull   - retrieve locales for specified project (and optionaly locale)
+  help - displays this screen
+
+Below follows description of options for list command:
+ projects
+    lists all projects available for given api token
+ locales
+    lists all locales for default project
+ config
+    lists server url and default project's name
+ cache
+    lists all keys that were cached by I18n.t call and are ready to be sent to server
+    (server given by 'list config' option)
+USAGE
+
+# when no arguments are specified, then display help and exist
+if ARGV.size < 1
+  OptparseZmeygo.parse([].push("--help"))
+  exit
+end
+
+
+commands = {}
+case ARGV[0]
+when 'help'
+  puts USAGE
+when 'push'
+  ARGV.shift
+  commands[:push] = true
+when 'ping'
+  ARGV.shift
+  commands[:ping] = true
+when 'pull'
+  ARGV.shift
+  commands[:pull] = true
+when 'init'
+  ARGV.shift
+  commands[:init] = true
+when 'list'
+  ARGV.shift
+  commands[:list] = ARGV.shift || true #need true here to make this at least reach client.list command
+else
+  puts 'Unknown command. Run with --help to see all options or check http://zmeygo.com/help for documentation'
+end
+
+Zmeygo::Command.new(commands)

data/lib/zmeygo/base.rb

@@ -0,0 +1,39 @@
+# 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 Zmeygo
+  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($stdout)
+    end
+
+  end
+end

data/lib/zmeygo/cache.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+
+module Zmeygo
+  # 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']
+  # All keys sent are for project mentioned in Zmeygo.config['default_project']
+  class Cache
+    attr_accessor :config
+    attr_accessor :missing_keys
+
+    def initialize
+      self.config = Zmeygo.config
+      self.missing_keys = {}
+    end
+
+    def get_cache_proj
+      proj = validate_config!
+      proj
+    end
+
+    def get_cache
+      proj = validate_config!
+      self.missing_keys[proj]
+    end
+
+    def add_to_cache(key)
+      proj = validate_config!
+      self.missing_keys[proj] ||= {}
+      self.missing_keys[proj][key] = true
+      File.open(File.expand_path(Constant::CACHE_FILE),'w') do |f|
+        f.write(Marshal.dump(self.missing_keys))
+      end
+    end
+
+    def clear_cache
+      proj = validate_config!
+      self.missing_keys[proj].clear
+      File.truncate(File.expand_path(Constant::CACHE_FILE),0)
+    end
+
+    def validate_config!
+      proj = self.config['default_project']
+      if proj.blank?
+        raise "Please provide default project name in ~/.zmeygo/config.yml file"
+      end
+      self.missing_keys[proj] ||= {}
+      proj
+    end
+
+  end # Cache
+end # Zmeygo
+

data/lib/zmeygo/client.rb

@@ -0,0 +1,217 @@
+# encoding: utf-8
+require 'ya2yaml'
+
+module Zmeygo
+	class Client
+
+		attr_accessor :config, :options
+
+		def  initialize(options={})
+  		 self.options = options
+			 self.config = Zmeygo.config
+		end
+
+		def push
+			url = "#{config['server']}/api/pushmissing?api_token=#{config['api_token']}"
+      hash = {}
+      keys = []
+      File.open(File.expand_path(Constant::CACHE_FILE,'r')) do |f|
+        data = f.read
+        begin
+          hash = Marshal.load(data)
+        rescue
+          puts "No cache"
+          return
+        end
+      end
+      Zmeygo.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.open(File.expand_path(Constant::CACHE_FILE,'r')) do |f|
+        data = f.read
+        begin
+          hash = Marshal.load(data)
+        rescue
+          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 = options[:project]
+			project ||= config['default_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, locale = options[:project],options[:locale]
+			project ||= config['default_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
+			puts "Will save locales to #{config[:locale_dir]}"
+			if locale.nil?
+				# pull all available locales
+				locales = list_locales
+				# for each available locale requst i18n data
+				locales.split(',').each do |loc|
+					pull_translations(project,loc)
+				end
+			else
+				pull_translations(project,locale)
+			end
+			"Done."
+		end
+
+		def http_connect(path)
+		  url = "#{config['server']}/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']
+						config['locale_dir'] ||= File.join(FileUtils.pwd,'locales')
+						folder = config['locale_dir']
+						unless File.exists?(folder)
+							FileUtils.mkdir_p(folder)
+						end
+						File.open(folder + "/#{locale_code}.yml", 'w') do |f|
+							puts "saving file #{locale_code}.yml..."
+							f.write(hash_result.ya2yaml)
+						end
+					else
+						puts "Message: #{reply['message']}"
+					end
+				end
+			end
+	end
+end
+
+

data/lib/zmeygo/command.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+module Zmeygo
+	class Command
+
+		attr_accessor :options, :client
+
+		def initialize(options)
+			if options[:init]
+				src_file = File.join(File.dirname(__FILE__),'../..','templates','zmeygo.yml.template')
+				dest_dir = File.expand_path(
+          File.dirname(Constant::DEFAULT_CONFIG_FILE)
+        )
+				dest_file = File.expand_path(Constant::DEFAULT_CONFIG_FILE)
+				unless File.exists?(dest_dir)
+					FileUtils.mkdir_p dest_dir
+				end
+        unless File.exists?(dest_file)
+          puts "Creating config file #{dest_file}..."
+          system "cp #{src_file} #{dest_file}"
+          puts "Done."
+          exit
+        else
+          puts "config file #{Constant::DEFAULT_CONFIG_FILE} already exists. Nothing to do."
+        end
+			end
+
+		  Zmeygo.configure
+
+			self.options = options
+			self.client = Zmeygo::Client.new(options)
+
+			[:push,:pull,:list, :ping].each do |command|
+			 	ret = client.send(command) if options[command]
+        if ret.present?
+          puts ret
+        end
+			end
+		end
+	end
+end

data/lib/zmeygo/configuration.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+module Zmeygo
+	require 'yaml'
+	require 'fileutils'
+
+	class Configuration
+		attr_accessor :server, :api_token, :locale_dir, :default_project
+
+		def initialize
+      src_file = File.join(File.dirname(__FILE__),'../..','templates','zmeygo.yml.template')
+      dest_dir = File.dirname(File.expand_path(Constant::DEFAULT_CONFIG_FILE))
+      dest_file = File.expand_path(Constant::DEFAULT_CONFIG_FILE)
+
+      unless File.exists?(dest_file)
+        puts "making folder #{dest_dir}"
+        FileUtils.mkdir dest_dir
+        system "cp #{src_file} #{dest_file}"
+      end
+
+      conf_all = YAML.load_file(File.expand_path(dest_file))
+
+			#TODO: change env to vailue of either RAILS_ENV, RACK_ENV or ZMEYGO_ENV
+			env = 'development'
+			conf = conf_all[env]
+
+			self.server = conf['server']
+			self.api_token = conf['api_token']
+			self.locale_dir = conf['locale_dir']
+			self.default_project = conf['default_project']
+		end
+
+		def [](key)
+			if self.respond_to?(key)
+				send(key)
+			end
+		end
+	end
+end

data/lib/zmeygo/constant.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+#
+module Zmeygo
+	class Constant
+		DEFAULT_CONFIG_FILE = "~/.zmeygo/config.yml"
+	  CACHE_FILE = "~/.zmeygo/cache"
+	end
+end

data/lib/zmeygo/i18n_backend.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Zmeygo
+	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/version.rb

@@ -0,0 +1,3 @@
+module Zmeygo
+  VERSION = "0.1"
+end

data/lib/zmeygo.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__),'/zmeygo/base')
+
+module I18n
+  class << self
+    def custom_exception_handler(*args)
+      args.shift
+      locale = args.shift
+      key = args.shift
+      Zmeygo.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/templates/zmeygo.yml.template

@@ -0,0 +1,15 @@
+# Configuration file for zmeygo
+#
+
+defaults: &defaults
+  server: http://zmeygo.com
+  api_token: <your account api_token here>
+  locale_dir: <full path to where locales files should be stored>
+  default_project: my_project_name
+
+development:
+  <<: *defaults
+
+production:
+  <<: *defaults
+

data/test/ext_i18n_test.rb

@@ -0,0 +1,31 @@
+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 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.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'zmeygo/version'
+
+Gem::Specification.new do |s|
+  s.name        = "zmeygo"
+  s.version     =  Zmeygo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Eugen Ciur"]
+  s.email       = ["ciur.eugen@gmail.com"]
+  s.homepage    = "http://zmeygo.com"
+  s.summary     = "Zmeygo - smart and friendly drago that helps you localize any ruby application"
+  s.description = "Syncs local i18n data with Zmeygo server"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.has_rdoc         = true
+  s.require_path       = 'lib'
+  s.bindir             = 'bin'
+  s.executables        = ["zg"]
+  s.default_executable = "zg"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: zmeygo
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- Eugen Ciur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-02 00:00:00 +03:00
+default_executable: zg
+dependencies: []
+
+description: Syncs local i18n data with Zmeygo server
+email: 
+- ciur.eugen@gmail.com
+executables: 
+- zg
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- README.ro.rdoc
+- README.ru.rdoc
+- Rakefile
+- TODO
+- bin/zg
+- lib/zmeygo.rb
+- lib/zmeygo/base.rb
+- lib/zmeygo/cache.rb
+- lib/zmeygo/client.rb
+- lib/zmeygo/command.rb
+- lib/zmeygo/configuration.rb
+- lib/zmeygo/constant.rb
+- lib/zmeygo/i18n_backend.rb
+- lib/zmeygo/version.rb
+- templates/zmeygo.yml.template
+- test/ext_i18n_test.rb
+- test/test_helper.rb
+- zmeygo.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 - smart and friendly drago that helps you localize any ruby application
+test_files: []
+