gettext-one_sky 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+rdoc/*
+*.gem
+.bundle
+spec/po/**/simple_client.po_from_one_sky

data/CHANGELOG

@@ -0,0 +1,5 @@
+= Change log
+
+== 0.0.1 (31 July 2011)
+* Initial release.
+

data/CREDITS

@@ -0,0 +1,6 @@
+= Credits
+
+Eddie Lau, http://3dd13.me http://github.com/3dd13
+
+* Initial code.
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gettext-one_sky.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    gettext-one_sky (0.0.1)
+      gettext (~> 0.5.0)
+      one_sky (~> 0.0.2)
+      module GetText (~> 0.14.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    gettext (0.5.0)
+    json (1.4.6)
+    mime-types (1.16)
+    one_sky (0.0.2)
+      json (~> 1.4.6)
+      rest-client (~> 1.6.1)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    module GetText (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  gettext (~> 0.5.0)
+  gettext-one_sky!
+  one_sky (~> 0.0.2)
+  rspec (~> 2.2.0)
+  module GetText (~> 0.14.4)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 {OneSky, Inc.}[link:http://www.oneskyapp.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 AUmodule GetTextS 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,131 @@
+= Gettext OneSky
+
+
+OneSky[link:http://www.oneskyapp.com] is a new service that lets developers reach a global audience by easily enabling them to translate their websites and applications to different languages through the help of the community.
+
+This gem integrates OneSky and gettext. At its most basic, it allows you to take the phrases defined under gettext .pot file and upload it to OneSky[link:http://www.oneskyapp.com] for translation by the community. Afterwards, you can download available translations and save them as .po files.
+
+This gem is supporting Ruby projects using gettext gem to handle localization. If you are using i18n, checkout i18n-one_sky gem
+
+
+= PO file support
+
+1. One layer of Context
+2. Text Domain as page
+3. Reserved Context: Singular, Plural and General
+
+
+--- One layer of Context
+
+Onesky currently only support 1 layer of context. That means only either "msgctxt" / "msgstr[0]" / "msgstr[1]" will be supported but not both.
+
+
+--- Text Domain as page
+
+Regarding the text domain, please use the file name as the page parameter. That means if the po file is abc.po, just add the string with parameter page=abc.po.
+
+
+--- Reserved Context: Singular, Plural and General
+
+"Singular" / "Plural" / "General" are reserved context words.
+
+Onesky only support "Singular" and "Plural" for po files. That means only [0] and [1] are used.
+Which will return in result:
+
+  {"key": { "Singular": "Word", "Plural": "Words"}}
+
+For the stuff without context, you may use "General" if there are other strings with same string key but different context:
+
+  {"key_of_book": { "General": "book", "verb": "book", "noun": "book"}}
+
+
+= Using inside a Rails project
+
+1. Generate OneSky API key
+2. Generate .pot
+3. Upload .pot to OneSky
+4. Upload translated .po to OneSky
+5. Download latest translated files .po from OneSky
+6. Overwrite old .po files
+7. Generate .mo files
+
+
+--- Generate OneSky API key 
+
+If you haven't done so yet, log in to your account at OneSky[link:http://www.oneskyapp.com] and create a new project for this Rails app. Also, find the API key and secret which you will supply here:
+
+  rails generate one_sky:init my_api_key my_api_secret my_project
+
+This will create the configuration file config/one_sky.yml.
+
+
+--- Generate .pot
+
+Use the gettext rake task
+
+  rake updatepo
+
+
+--- Upload .pot to OneSky
+
+So assuming that you already have your .pot file generated, it's time now to submit these phrases to OneSky:
+
+  rake one_sky:upload_phrases
+
+
+--- Upload translated .po to OneSky
+
+You may have some translated .po files in your repository. Upload them to Onesky:
+
+  rake one_sky:upload_translated_phrases
+
+
+--- Download latest translated files .po from OneSky
+
+Then ask your translators to provide the translations using the OneSky[link:http://www.oneskyapp.com] website. When they're done and a few new languages are available, download them by:
+
+  rake one_sky:download_translations
+
+This will save the translations inside po/**/from_one_sky.po files. 
+
+
+--- Overwrite old .po files
+
+Overwrite your own .po files by the downloaded from_one_sky.po file.
+
+
+You now have more languages supported and it's just a matter of pushing again to production. You can call upload and download over and over as you incrementally internationalize your site.
+
+
+= Using outside Rails
+
+The steps are similar. Install it like any regular gem:
+
+  gem install gettext-one_sky
+
+And see the gettext-one_sky.rake and GetText::OneSky::SimpleClient for the methods available in Ruby.
+
+
+= TODO
+
+* merge downloaded translation with .pot to generate the .po files
+* upload existing .po files to onesky service
+* handle textdomain.po
+
+
+= History
+
+See CHANGELOG[link:CHANGELOG.html]
+
+
+= Credits
+
+See CREDITS[link:CREDITS.html]
+
+
+= License
+
+Copyright 2010-2011 {OneSky, Inc.}[link:http://www.oneskyapp.com]
+
+Licensed under the {MIT License}[link:MIT-LICENSE.html].
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# = RDoc 
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |t|
+  t.rdoc_dir = 'rdoc'
+  t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  t.options << '--charset' << 'utf-8'
+  t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'CHANGELOG', 'CREDITS', 'lib/**/*.rb')
+end
+

data/gettext-one_sky.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gettext-one_sky/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gettext-one_sky"
+  s.version     = GetText::Onesky::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Eddie Lau"]
+  s.email       = ["tatonlto@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/gettext-one_sky"
+  s.summary     = %q{gettext extensions using OneSky -- the community-powered translation service.}
+  s.description = %q{This is a backport of i18n-one_sky-ruby to support gettext. i18n is not included in Rails before Rails 2.2. This gem handles the downloading and uploading translation files (.po) to Onesky server by calling Onesky API.}
+
+  s.rubyforge_project = "gettext-one_sky"
+
+  s.add_dependency "gettext", "~> 2.0.0"
+  s.add_dependency "one_sky", "~> 0.0.2"
+  s.add_dependency "thor", "~> 0.14.4"
+
+  s.add_development_dependency "rspec", "~> 2.2.0"
+  s.add_development_dependency "bundler", "~> 1.0.0"
+
+  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"]
+end

data/lib/generators/one_sky/init/init_generator.rb

@@ -0,0 +1,30 @@
+module OneSky
+  module Generators
+    class InitGenerator < ::Rails::Generators::Base
+      desc "This generator configures gettext-one_sky for use on this Rails project."
+      argument :api_key, :type => :string, :desc => "The API key you got from OneSky"
+      argument :api_secret, :type => :string, :desc => "The API secret you got from OneSky"
+      argument :project, :type => :string, :desc => "The name of the OneSky project"
+      class_option :force, :type => :boolean, :default => false, :desc => "Overwrite if config file already exists"
+      @@config_file = [Rails.root.to_s, 'config', 'one_sky.yml'].join('/')
+
+      def remove_config_file
+        if File.exists? @@config_file
+          if options.force?
+            say_status("warning", "config file already exists and is being overwritten.", :yellow)
+            remove_file @@config_file
+          else
+            say_status("error", "config file already exists. Use --force to overwrite.", :red)
+            raise "Error: OneSky config file exists."
+          end
+        end
+      end
+
+      def create_config_file
+        config_hash = {"api_key" => api_key, "api_secret" => api_secret, "project" => project}
+        create_file(@@config_file, config_hash.to_yaml)
+        say_status("info", "config file #{@@config_file} created.", :green)
+      end
+    end
+  end
+end

data/lib/gettext-one_sky.rb

@@ -0,0 +1,10 @@
+require 'gettext'
+require 'one_sky'
+require 'gettext-one_sky/rails/railtie.rb' if defined? Rails
+
+module GetText
+  module OneSky
+    autoload :SimpleClient, 'gettext-one_sky/simple_client'
+    class DefaultLocaleMismatchError < StandardError; end
+  end
+end

data/lib/gettext-one_sky/my_po_data.rb

@@ -0,0 +1,44 @@
+module GetText
+  module OneSky
+    class MyPoData < GetText::RMsgMerge::PoData
+      
+      def generate_po_entry(msgid)
+        str = ""
+        str << @msgid2comment[msgid]
+        if str[-1] != "\n"[0]
+          str << "\n"
+        end
+
+        id = msgid.gsub(/"/, '\"').gsub(/\r/, '')
+        msgstr = @msgid2msgstr[msgid].gsub(/"/, '\"').gsub(/\r/, '')
+
+# MONKEY PATCHING START
+        if id.include?("\004")
+          ids = id.split(/\004/)
+          context = ids[0]
+          id      = ids[1]
+          str << "msgctxt "  << __conv(context) << "\n"
+        end
+# MONKEY PATCHING END
+
+        if id.include?("\000")
+          ids = id.split(/\000/)
+          str << "msgid " << __conv(ids[0]) << "\n"
+          ids[1..-1].each do |single_id|
+            str << "msgid_plural " << __conv(single_id) << "\n"
+          end
+
+          msgstr.split("\000").each_with_index do |m, n|
+            str << "msgstr[#{n}] " << __conv(m) << "\n"
+          end
+        else
+          str << "msgid "  << __conv(id) << "\n"
+          str << "msgstr " << __conv(msgstr) << "\n"
+        end
+
+        str << "\n"
+        str
+      end
+    end
+  end
+end

data/lib/gettext-one_sky/my_po_parser.rb

@@ -0,0 +1,103 @@
+require 'gettext/tools/poparser'
+require 'gettext/tools/rmsgmerge'
+require 'gettext-one_sky/my_po_data'
+
+module GetText
+  module OneSky
+    class MyPoParser < GetText::PoParser
+      
+# MONKEY PATCHING START
+# override to include blank trsanslation messages
+      def on_message(msgid, msgstr)
+        @data[msgid] = msgstr
+        @data.set_comment(msgid, @comments.join("\n"))
+
+        @comments.clear
+        @msgctxt = ""
+      end
+# MONKEY PATCHING END
+      
+      def parse_po_file(path, lang_code=nil)
+        gettext_formatted_messages = self.parse_file(path, GetText::RMsgMerge::PoData.new, false)
+        
+        page_name = File.basename(path).gsub(/.pot$/, '.po')
+        to_onesky_format(gettext_formatted_messages, page_name, lang_code)
+      end
+      
+      def from_onesky_format(pot_file_path, new_phrases)
+        original_phrases = self.parse_file(pot_file_path, GetText::OneSky::MyPoData.new, false)
+        
+        original_phrases.each_msgid do |full_msg_id|
+          msg_str = original_phrases.msgstr(full_msg_id)
+          
+          if full_msg_id.include? "\004"
+            msg_context, msg_id = full_msg_id.split(/\004/)
+            
+            if new_phrases.has_key?(msg_id) && new_phrases[msg_id].has_key?(msg_context)
+              value = new_phrases[msg_id][msg_context]
+            elsif msg_id.include? "\000"
+              msg_singular, msg_plural = msg_id.split(/\000/)
+              value = new_phrases[msg_singular]["Singular"] + "\000" + new_phrases[msg_plural]["Plural"]
+            else
+              value = ""
+            end
+          elsif full_msg_id.include? "\000"
+            msg_singular, msg_plural = full_msg_id.split(/\000/)
+            value = new_phrases[msg_singular]["Singular"] + "\000" + new_phrases[msg_plural]["Plural"]
+          else
+            if new_phrases[full_msg_id].is_a?(Hash)
+              value = new_phrases[full_msg_id]["General"]
+            else
+              value = new_phrases[full_msg_id]
+            end
+          end
+
+          original_phrases[full_msg_id] = value
+          original_phrases.set_comment(full_msg_id, "")
+        end
+        
+        original_phrases
+      end
+
+      def to_onesky_format(messages, file_name, lang_code=nil)
+        slices = []
+        lang_options = Hash.new
+        lang_options[:language] = lang_code if lang_code
+        
+        messages.each_msgid do |full_msg_id|
+          msg_id = full_msg_id
+          msg_str = messages.msgstr(msg_id)
+          
+          components = Hash.new
+          if msg_id.include? "\004"
+            msg_context, msg_id = msg_id.split(/\004/)
+            components[:context] = msg_context
+          end
+          
+          if msg_id.include? "\000"
+            msg_singular, msg_plural = msg_id.split(/\000/)
+            trans_singular, trans_plural = msg_str.split(/\000/)
+
+            slices << {:context => "Singular", :string => msg_singular, :"string-key" => msg_singular, :page => file_name, :translation => trans_singular || ""}.merge(lang_options)
+            slices << {:context => "Plural",   :string => msg_plural,   :"string-key" => msg_plural,   :page => file_name, :translation => trans_plural || ""}.merge(lang_options)
+          else
+            slices << components.merge(:string => msg_id, :"string-key" => msg_id, :translation => msg_str, :page => file_name).merge(lang_options)
+          end
+        end
+        
+        assign_general_context(slices)
+        
+        slices
+      end
+      
+      def assign_general_context(slices)
+        general_slices = slices.select{|slice| !slice.has_key?(:context)}
+        general_slices.each do |general_slice|
+          if slices.select{|slice| slice[:string] == general_slice[:string] && slice.has_key?(:context)}.any?
+            general_slice[:context] = "General"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gettext-one_sky/rails/railtie.rb

@@ -0,0 +1,9 @@
+module GetText
+  module Onesky
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load "gettext-one_sky/rails/tasks/gettext-one_sky.rake"
+      end      
+    end
+  end
+end

data/lib/gettext-one_sky/rails/tasks/gettext-one_sky.rake

@@ -0,0 +1,31 @@
+namespace :one_sky do
+  desc "Upload phrases (.pot files) for translation to OneSky."
+  task :upload_phrases => :environment do
+    client = GetText::OneSky::SimpleClient.new
+    
+    client.load_phrases
+    client.upload_phrases
+    
+    puts "Phrases in .pot file uploaded to OneSky. Please ask your translators to... well... get translating."
+  end
+
+  desc "Upload translated phrases (.po files) to OneSky."
+  task :upload_translated_phrases => :environment do
+    client = GetText::OneSky::SimpleClient.new
+    
+    client.load_translations
+    client.upload_translations
+    
+    puts "Translated phrases in .po files uploaded to OneSky."
+  end
+
+  desc "Download available translations from OneSky and save as .po_from_one_sky."
+  task :download_translations do
+    client = GetText::OneSky::SimpleClient.new
+    
+    client.download_translations
+    client.save_translations
+    
+    puts "Latest translations downloaded and saved to po/**/*.po_from_one_sky files."
+  end
+end

data/lib/gettext-one_sky/simple_client.rb

@@ -0,0 +1,175 @@
+require 'gettext-one_sky/my_po_parser'
+
+module GetText
+  module OneSky
+
+=begin
+  This class is the bridge between the OneSky service and the gettext file storgage.
+  It takes the phrases defined in gettext's default locale and uploads them to OneSky for translation.
+  Then it downloads available translations and saves them as .po files.
+  
+  A regular workflow would then look like:
+    initialize -> load_phrases -> upload_phrases -> download_translations
+
+  
+  * Initilaize *
+  
+  When you initialize a client inside a Rails project, 
+  it will take the OneSky configuration variables supplied when you called rails generate one_sky:init.
+  
+  When you use this client outside of Rails,
+  credentials are expected to come from environment variables: ONESKY_API_KEY, ONESKY_API_SECRET, ONESKY_PROJECT.
+  You can override these defaults by providing a hash of options:
+    {:api_key => ..., :api_secret => ..., :project => ...}
+    
+=end
+    class SimpleClient
+      attr_reader :phrases_nested, :phrases_flat, :translations_flat, :translations_from_onesky
+      # The base OneSky project. Gives you low-level access to the API gem.
+      attr_reader :project
+
+      def initialize(options = {})
+        options = default_options.merge!(options)
+        @project = ::OneSky::Project.new(options[:api_key], options[:api_secret], options[:project])
+        @one_sky_locale = @project.details["base_locale"]
+        @one_sky_languages = @project.languages
+      end
+
+      # Parse and load phrases from .pot file.
+      # If not a Rails project, manually supply the path where the .pot file located.
+      def load_phrases(path=nil)
+        @phrases_flat = []
+        
+        Dir.glob("#{po_dir_path(path)}/**/*.pot").each do |file_path|
+          @phrases_flat += parse_phrase_file(file_path)
+        end
+      end
+      
+      # Upload phrases to Onesky server
+      def upload_phrases(path = nil)
+        load_phrases(path) unless @phrases_flat
+
+        @project.input_bulk(@phrases_flat, :page => @phrases_flat.first[:page])
+      end
+      
+      # Parse and load translated phrases from .po files
+      # If not a Rails project, manually supply the path where the .po file path located.
+      def load_translations(path=nil)
+        @translations_flat = []
+        
+        Dir.glob("#{po_dir_path(path)}/**/*.po").each do |file_path|
+          lang_code = File.dirname(file_path).split("/").last
+          
+          @translations_flat += parse_phrase_file(file_path, lang_code)
+        end
+      end
+
+      # Upload translated phrases to Onesky server
+      def upload_translations(path=nil)
+        load_translations(path) unless @translations_flat
+
+        @translations_flat.each do |values|
+          @project.send(:post, "/string/translate", values)
+        end
+      end
+
+      # Download all available translations from Onesky server
+      def download_translations
+        @translations_from_onesky = @project.output
+      end
+      
+      # Download all available translations from Onesky server and save them as *.po files.
+      def save_translations(path=nil)
+        download_translations unless @translations_from_onesky
+        
+        update_translation_files_from_onesky(po_dir_path(path), @translations_from_onesky)
+      end
+
+
+
+      protected
+      
+      def default_options
+        if defined? Rails
+          YAML.load_file([Rails.root.to_s, 'config', 'one_sky.yml'].join('/')).symbolize_keys
+        else
+          {:api_key => ENV["ONESKY_API_KEY"], :api_secret => ENV["ONESKY_API_SECRET"], :project => ENV["ONESKY_PROJECT"]}
+        end
+      end
+      
+      def po_dir_path(path)
+        if defined? Rails
+          path ||= [Rails.root.to_s, "po"].join("/")
+        else
+          raise ArgumentError, "Please supply the po directory path where locale files are to be downloaded." unless path && File.directory?(path)
+          path = path.chop if path =~ /\/$/
+        end
+        
+        path
+      end
+      
+      def update_translation_files_from_onesky(po_dir_path, translations)
+        # Delete all existing one_sky translation files before downloading a new set.
+        File.delete(*Dir.glob("#{po_dir_path}/**/*.po_from_one_sky"))
+        
+        # Process each locale and save to file
+        translations.each_pair do |text_domain, values|
+          file_name = text_domain.gsub(/\.po$/, '')
+          pot_file_path = [po_dir_path, file_name + ".pot"].join('/')
+          
+          values.each_pair do |lang_code, translated_phrases|
+            language_dir = "#{po_dir_path}/#{lang_code}"
+            Dir.mkdir(language_dir) unless File.exists?(language_dir)
+            po_from_one_sky_file = "#{language_dir}/#{file_name}.po_from_one_sky"
+            
+            save_locale(pot_file_path, po_from_one_sky_file, lang_code, translated_phrases)
+          end
+        end
+      end
+
+      def save_locale(pot_file_path, po_file_name, lang_code, new_phrases)
+        my_po_parser = GetText::OneSky::MyPoParser.new
+        updated_phrases = my_po_parser.from_onesky_format(pot_file_path, new_phrases)
+        updated_phrases.set_comment(:last, "# END")
+        
+        lang = @one_sky_languages.find { |e| e["locale"] == lang_code }
+
+        File.open(po_file_name, 'w') do |f|
+          f.print onesky_header(lang)
+          f.print updated_phrases.generate_po
+        end
+        po_file_name
+      end
+      
+      def onesky_header(lang)
+        "# PLEASE DO NOT EDIT THIS FILE.\n" +
+        "# This was downloaded from OneSky. Log in to your OneSky account to manage translations on their website.\n" +
+        "# Language code: #{lang['locale']}\n" +
+        "# Language name: #{lang['locale_name']}\n" +
+        "# Language English name: #{lang['eng_name']}\n" +
+        "#\n"
+        "#\n"
+      end
+      
+      def parse_translated_file(path=nil)
+        if defined? Rails
+          path ||= File.join(RAILS_ROOT, '/po', "**/*.po")
+        else
+          raise ArgumentError, "Please supply the path where the .po file is located." unless path
+          path = path.chop if path =~ /\/$/
+        end
+
+        parser = GetText::OneSky::MyPoParser.new
+        parser.parse_po_file(path)
+      end
+      
+      def parse_phrase_file(path=nil, lang_code=nil)
+        raise ArgumentError, "Please supply the path where the .pot file is located." unless path
+        
+        parser = GetText::OneSky::MyPoParser.new
+        parser.parse_po_file(path, lang_code)
+      end
+    end
+  end
+end
+

data/lib/gettext-one_sky/version.rb

@@ -0,0 +1,5 @@
+module GetText
+  module Onesky
+    VERSION = "0.0.1"
+  end
+end

data/spec/end_to_end_spec.rb

@@ -0,0 +1,27 @@
+require 'helpers'
+
+describe "SimpleClient End 2 End workflow" do
+  include GetTextOneSkySpecHelpers
+
+  before do
+    delete_onesky_project
+    create_onesky_project
+    
+    @client = create_simple_client_and_load
+  end
+
+  describe "#upload_phrases" do
+    it "" do
+      @client.upload_phrases
+      @client.upload_transalcations
+    
+      po_dir_path = [File.dirname(__FILE__), 'po'].join('/')
+      pot_file_path = [File.dirname(__FILE__), "po", "simple_client.pot"].join('/')
+    
+      @client.download_translations(po_dir_path, pot_file_path).should be_a_kind_of Array
+      Dir.glob("#{po_dir_path}/**/from_one_sky.po").size.should >= 1
+      
+      @client.translations["Hello"].should == "Too"
+    end
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,64 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'gettext-one_sky'
+
+module GetTextOneSkySpecHelpers
+  def create_simple_client
+    raise "Please set environment variables: ONESKY_API_KEY, ONESKY_API_SECRET and ONESKY_SPEC_PROJ (default: gettextoneskyspec) before running spec." unless [ENV["ONESKY_API_KEY"], ENV["ONESKY_API_SECRET"]].all?
+    GetText.locale = "en_US"
+    client = GetText::OneSky::SimpleClient.new(options)
+  end
+  
+  def create_simple_project
+    OneSky::Project.new(options[:api_key], options[:api_secret], options[:project])
+  end
+
+  def create_simple_client_and_load
+    client = create_simple_client
+    
+    load_phrases(client)
+    
+    client
+  end
+  
+  def delete_onesky_project(project)
+    begin
+      project.send(:post, "/project/delete", {:project => test_project_code})
+    rescue RestClient::BadRequest
+      retry
+    rescue OneSky::ApiError
+    end
+  end
+  
+  def create_onesky_project(project)
+    project.send(:post, "/project/add", {:project => test_project_code, :type => "ruby", :"base-language-code" => "en_US"})
+  end
+
+  protected
+  
+  def load_phrases(client)
+    client.load_phrases(po_dir_path)
+  end
+  
+  def load_translations(client)
+    client.load_translations(po_dir_path)
+  end
+  
+  def po_dir_path
+    [File.dirname(__FILE__), "po"].join("/")
+  end
+  
+  # hopefully not accidentally delete other real translation project
+  def test_project_code
+    "ONESKY_TEST_#{ENV["ONESKY_SPEC_PROJ"]}"
+  end
+  
+  def options
+    {
+      :api_key => ENV["ONESKY_API_KEY"], 
+      :api_secret => ENV["ONESKY_API_SECRET"], 
+      :project => test_project_code || "gettextoneskyspec"
+    }
+  end
+end

data/spec/po/en_US/simple_client.po

@@ -0,0 +1,53 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: sample_client 1.0.0\n"
+"POT-Creation-Date: 2011-07-30 23:34+0800\n"
+"PO-Revision-Date: 2011-07-30 22:48+0800\n"
+"Last-Translator: \n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+
+#: general msg
+msgid "Hello"
+msgstr "Updated Hello Plain"
+
+
+#: single and plural msg
+msgid "Stock"
+msgid_plural "Stocks"
+msgstr[0] "Updated Singular Stock"
+msgstr[1] "Updated Plural Stocks"
+
+
+#: msg with same name as context-ed msg
+msgid "Good to Enter"
+msgstr "Updated Time to enter order"
+
+
+#: msg with context
+msgctxt "Long"
+msgid "Good to Enter"
+msgstr "Updated Expect it to raise. Time to enter order"
+
+
+#: msg with context
+msgctxt "Short"
+msgid "Good to Enter"
+msgstr "Updated Expect it to drop. Time to enter order"
+
+
+#: app/views/demo/index.rhtml:5
+msgctxt "Not Supporting multi level of context and plural"
+msgid "Should upload this singular phrase without context"
+msgid_plural "Should upload this plural phrase without context"
+msgstr[0] "Updated CONTEXT AND SING"
+msgstr[1] "Updated CONTEXT AND PLURAL"

data/spec/po/simple_client.pot

@@ -0,0 +1,54 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: sample_client 1.0.0\n"
+"POT-Creation-Date: 2011-07-30 23:34+0800\n"
+"PO-Revision-Date: 2011-07-30 22:48+0800\n"
+"Last-Translator: \n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+
+#: general msg
+msgid "Hello"
+msgstr ""
+
+
+#: single and plural msg
+msgid "Stock"
+msgid_plural "Stocks"
+msgstr[0] ""
+msgstr[1] ""
+
+
+#: msg with same name as context-ed msg
+msgid "Good to Enter"
+msgstr ""
+
+
+#: msg with context
+msgctxt "Long"
+msgid "Good to Enter"
+msgstr ""
+
+
+#: msg with context
+msgctxt "Short"
+msgid "Good to Enter"
+msgstr ""
+
+
+#: app/views/demo/index.rhtml:5
+msgctxt "Not Supporting multi level of context and plural"
+msgid "Should upload this singular phrase without context"
+msgid_plural "Should upload this plural phrase without context"
+msgstr[0] ""
+msgstr[1] ""
+

data/spec/simple_client_spec.rb

@@ -0,0 +1,142 @@
+require 'helpers'
+
+describe "SimpleClient" do
+  it "raises an error when initialization values are nil." do
+    lambda { @client = GetText::OneSky::SimpleClient.new(:api_key => nil, :api_secret => nil, :project => nil) }.should raise_error ArgumentError
+  end
+end
+
+describe "SimpleClient" do
+  include GetTextOneSkySpecHelpers
+
+  before(:all) do
+    @project = create_simple_project
+    delete_onesky_project(@project)
+    create_onesky_project(@project)
+    
+    @pot_file_path = [File.dirname(__FILE__), "po"].join('/')
+  end
+  
+  before do
+    @client = create_simple_client_and_load
+  end
+   
+  describe "project with phrases inside .pot file" do
+    describe "#load_phrases" do
+      it "should load flattened phrases." do
+        expected = [{:"string-key"=>"Hello", :page=>"simple_client.po", :string=>"Hello", :translation=>""},
+         {:"string-key"=>"Stock", :page=>"simple_client.po", :string=>"Stock", :context=>"Singular", :translation=>""},
+         {:"string-key"=>"Stocks", :page=>"simple_client.po", :string=>"Stocks", :context=>"Plural", :translation=>""},
+         {:"string-key"=>"Good to Enter", :page=>"simple_client.po", :string=>"Good to Enter", :context=>"General", :translation=>""},
+         {:"string-key"=>"Good to Enter", :page=>"simple_client.po", :string=>"Good to Enter", :context=>"Long", :translation=>""},
+         {:"string-key"=>"Good to Enter", :page=>"simple_client.po", :string=>"Good to Enter", :context=>"Short", :translation=>""},
+         {:"string-key"=>"Should upload this singular phrase without context", :page=>"simple_client.po", :string=>"Should upload this singular phrase without context", :context=>"Singular", :translation=>""},
+         {:"string-key"=>"Should upload this plural phrase without context", :page=>"simple_client.po", :string=>"Should upload this plural phrase without context", :context=>"Plural", :translation=>""}]
+       
+        @client.phrases_flat.should == expected
+      end
+    end
+    
+    describe "Translation output from Onesky" do
+      before do
+        @client.upload_phrases.should be_true
+        @client.download_translations
+      end
+  
+      describe "#download_translations" do      
+        it "transforms translation result from Onesky" do
+          expected = { "simple_client.po" =>        
+            {"en_US"=>
+              {"Good to Enter"=>
+                 {"General" => "Good to Enter", "Short"=>"Good to Enter", "Long"=>"Good to Enter"}, 
+               "Stock"=>
+                 {"Singular"=>"Stock"},
+               "Should upload this singular phrase without context"=>
+                 {"Singular"=>"Should upload this singular phrase without context"},
+               "Should upload this plural phrase without context"=>
+                 {"Plural"=>"Should upload this plural phrase without context"}, 
+               "Hello"=>"Hello",
+               "Stocks"=>
+                 {"Plural"=>"Stocks"}
+              }
+            }
+          }
+        
+          @client.translations_from_onesky.should == expected
+        end
+      end
+      
+      describe "#save_translations" do
+        it "saves the translation into .po files of all available languages." do
+          @client.save_translations(@pot_file_path)
+  
+          Dir.glob("#{po_dir_path}/**/simple_client.po_from_one_sky").size.should >= 1
+        end
+      end
+    end
+  end
+  
+  describe "with translated .po files" do
+    before do
+      load_translations(@client)
+    end
+    
+    describe "#load_translations" do
+      it "should load flattened translations." do
+        expected = 
+          [{:"string-key"=>"Hello", :page=>"simple_client.po", :string=>"Hello", :translation=>"Updated Hello Plain", :language => "en_US"},
+           {:"string-key"=>"Stock", :page=>"simple_client.po", :string=>"Stock", :context=>"Singular", :translation=>"Updated Singular Stock", :language => "en_US"},
+           {:"string-key"=>"Stocks", :page=>"simple_client.po", :string=>"Stocks", :context=>"Plural", :translation=>"Updated Plural Stocks", :language => "en_US"},
+           {:"string-key"=>"Good to Enter", :page=>"simple_client.po", :string=>"Good to Enter", :context=>"General", :translation=>"Updated Time to enter order", :language => "en_US"},
+           {:"string-key"=>"Good to Enter", :page=>"simple_client.po", :string=>"Good to Enter", :context=>"Long", :translation=>"Updated Expect it to raise. Time to enter order", :language => "en_US"},
+           {:"string-key"=>"Good to Enter", :page=>"simple_client.po", :string=>"Good to Enter", :context=>"Short", :translation=>"Updated Expect it to drop. Time to enter order", :language => "en_US"},
+           {:"string-key"=>"Should upload this singular phrase without context", :page=>"simple_client.po", :string=>"Should upload this singular phrase without context", :context=>"Singular", :translation=>"Updated CONTEXT AND SING", :language => "en_US"},
+           {:"string-key"=>"Should upload this plural phrase without context", :page=>"simple_client.po", :string=>"Should upload this plural phrase without context", :context=>"Plural", :translation=>"Updated CONTEXT AND PLURAL", :language => "en_US"}]
+  
+        @client.translations_flat.should == expected
+      end
+    end
+    
+    describe "retrieving updated translation output from Onesky" do
+      before do
+        @client.upload_translations.should be_true
+        @client.download_translations
+      end
+
+      ########
+      #   this test case does not work, because the original translation is always the default values returned
+      ########
+            
+      # describe "#download_translations" do      
+      #   it "transforms updated translation result from Onesky" do
+      #     expected = { "simple_client.po" =>        
+      #       {"en_US"=>
+      #         {"Good to Enter"=>
+      #            {"General" => "Updated Time to enter order", "Short"=>"Updated Expect it to drop. Time to enter order", "Long"=>"Updated Expect it to raise. Time to enter order"}, 
+      #          "Stock"=>
+      #            {"Singular"=>"Updated Singular Stock"},
+      #          "Should upload this singular phrase without context"=>
+      #            {"Singular"=>"Updated CONTEXT AND SING"},
+      #          "Should upload this plural phrase without context"=>
+      #            {"Plural"=>"Updated CONTEXT AND PLURAL"}, 
+      #          "Hello"=>"Updated Hello Plain",
+      #          "Stocks"=>
+      #            {"Plural"=>"Updated Plural Stocks"}
+      #         }
+      #       }
+      #     }
+      # 
+      #     @client.translations_from_onesky.should == expected
+      #   end
+      # end
+      #       
+      # describe "#save_translations" do
+      #   it "saves the updated translation into .po files of all available languages." do
+      #     @client.save_translations(@pot_file_path)
+      #   
+      #     Dir.glob("#{po_dir_path}/**/simple_client.po_from_one_sky").size.should >= 1
+      #   end
+      # end
+    end
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification 
+name: gettext-one_sky
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eddie Lau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-09 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gettext
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: one_sky
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 0
+        - 2
+        version: 0.0.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 0
+        - 14
+        - 4
+        version: 0.14.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+description: This is a backport of i18n-one_sky-ruby to support gettext. i18n is not included in Rails before Rails 2.2. This gem handles the downloading and uploading translation files (.po) to Onesky server by calling Onesky API.
+email: 
+- tatonlto@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- CREDITS
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- gettext-one_sky.gemspec
+- lib/generators/one_sky/init/init_generator.rb
+- lib/gettext-one_sky.rb
+- lib/gettext-one_sky/my_po_data.rb
+- lib/gettext-one_sky/my_po_parser.rb
+- lib/gettext-one_sky/rails/railtie.rb
+- lib/gettext-one_sky/rails/tasks/gettext-one_sky.rake
+- lib/gettext-one_sky/simple_client.rb
+- lib/gettext-one_sky/version.rb
+- spec/end_to_end_spec.rb
+- spec/helpers.rb
+- spec/po/en_US/simple_client.po
+- spec/po/simple_client.pot
+- spec/simple_client_spec.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/gettext-one_sky
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: gettext-one_sky
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: gettext extensions using OneSky -- the community-powered translation service.
+test_files: 
+- spec/end_to_end_spec.rb
+- spec/helpers.rb
+- spec/po/en_US/simple_client.po
+- spec/po/simple_client.pot
+- spec/simple_client_spec.rb