i18n-one_sky 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+rdoc/*
+*.gem
+.bundle
+spec/data/*_one_sky.yml
+*.swp

data/CHANGELOG

@@ -0,0 +1,5 @@
+= Change log
+
+== 0.0.1 (03 Jan 2010)
+* Initial release.
+

data/CREDITS

@@ -0,0 +1,6 @@
+= Credits
+
+Junjun Olympia (@beljun), http://rubyredtomatoes.com
+
+* Initial code.
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    i18n-one_sky (0.0.1)
+      i18n (~> 0.5.0)
+      one_sky (~> 0.0.1)
+      thor (~> 0.14.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    json (1.4.6)
+    mime-types (1.16)
+    one_sky (0.0.1)
+      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)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  i18n (~> 0.5.0)
+  i18n-one_sky!
+  one_sky (~> 0.0.1)
+  rspec (~> 2.2.0)
+  thor (~> 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 AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,59 @@
+= I18n 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 I18n. At its most basic, it allows you to take the phrases defined under I18n's default locale and upload them to OneSky[link:http://www.oneskyapp.com] for translation by the community. Afterwards, you can download available translations and save them as Simple backend YAML files.
+
+= Using inside a Rails project
+
+In your Rails root, edit your Gemfile to include this gem:
+
+  # Gemfile
+  gem 'rails', '3.0.3'
+  ...
+  gem 'i18n-one_sky'
+
+Then tell Bundler to install:
+
+  bundle install
+
+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.
+
+So assuming that you already have your phrases defined for your default locale and all your views contain the ubiquitous t() methods, it's time now to submit these phrases to OneSky:
+
+  rake one_sky:upload_phrases
+
+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 config/locales/*_one_sky.yml files. 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
+
+Although I18n is commonly known as the default internationalization module for Rails, it actually is designed to be used outside Rails, too. And so is i18n-one_sky. 
+
+Install it like any regular gem:
+
+  gem install i18n-one_sky
+
+And see I18n::OneSky::SimpleClient for the methods available in Ruby.
+
+= 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/i18n-one_sky.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "i18n-one_sky/version"
+
+Gem::Specification.new do |s|
+  s.name        = "i18n-one_sky"
+  s.version     = I18n::Onesky::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Junjun Olympia"]
+  s.email       = ["romeo.olympia@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/i18n-one_sky"
+  s.summary     = %q{I18n extensions using OneSky -- the community-powered translation service.}
+  s.description = %q{A set of I18n extensions that use OneSky. At its most basic, this allows you to easily submit translation requests to the OneSky service and download available translations as Simple backend YAML files.}
+
+  s.rubyforge_project = "i18n-one_sky"
+
+  s.add_dependency "i18n", "~> 0.5.0"
+  s.add_dependency "one_sky", "~> 0.0.1"
+  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 i18n-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/i18n-one_sky/rails/railtie.rb

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

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

@@ -0,0 +1,17 @@
+namespace :one_sky do
+  desc "Upload phrases for translation to OneSky."
+  task :upload_phrases => :environment do
+    client = I18n::OneSky::SimpleClient.new
+    puts "Default locale for this Rails app is: #{I18n.default_locale}"
+    puts client.load_phrases
+    client.upload_phrases
+    puts "Phrases uploaded to OneSky. Please ask your translators to... well... get translating."
+  end
+
+  desc "Download available translations from OneSky."
+  task :download_translations do
+    client = I18n::OneSky::SimpleClient.new
+    client.download_translations
+    puts "Translations downloaded and saved to config/locales/*_one_sky.yml files."
+  end
+end

data/lib/i18n-one_sky/simple_client.rb

@@ -0,0 +1,133 @@
+module I18n
+  module OneSky
+    # This class is the bridge between the OneSky service and the I18n Simple backend.
+    # It takes the phrases defined in I18n's default locale and uploads them to OneSky for translation.
+    # Then it downloads available translations and saves them as Simple backend's YAML files.
+    # A regular workflow would then look like:
+    #   initialize -> load_phrases -> upload_phrases -> download_translations
+    class SimpleClient
+      include I18n::Backend::Flatten
+
+      attr_reader :phrases_nested, :phrases_flat
+      # The base OneSky project. Gives you low-level access to the API gem.
+      attr_reader :project
+
+      # 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.
+      # 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
+      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["original_lang_code"].to_s
+        check_default_locales_match
+        @one_sky_languages = @project.languages
+      end
+
+      # This will load the phrases defined for I18n's default locale.
+      # If not a Rails project, manually supply the path where the I18n yml or rb files for located.
+      def load_phrases(path=nil)
+        if defined? Rails
+          I18n.backend.load_translations
+        else
+          raise ArgumentError, "Please supply the path where locales are located." unless path
+          path = path.chop if path =~ /\/$/
+          I18n.backend.load_translations(*Dir.glob("#{path}/**/*.{yml,rb}"))
+        end
+
+        @phrases_nested = I18n.backend.instance_variable_get("@translations")[I18n.default_locale]
+
+        # Flatten the nested hash.
+        flat_keys = flatten_translations(I18n.default_locale, @phrases_nested, true, false)
+
+        # Remove those "supporting/generic" i18n entities that we're not sending to OneSky.
+        # Those that are found in the rails-i18n github repository.
+        # Eg. number, datetime, activemodel, etc.
+        # Note: This doesn't handle FLATTEN_SEPARATOR other than '.' yet.
+        patterns = %w{number datetime activemodel support activerecord date time errors helpers}.inject([]) { |o,e| o << Regexp.new("^#{e}(\\..*)?$") }
+        @phrases_flat = flat_keys.reject { |k,v| patterns.find { |e| k.to_s =~ e } }
+      end
+
+      # Once you've loaded the default locale's phrases, call this method to send them to OneSky for translation.
+      def upload_phrases
+        load_phrases unless @phrases_flat
+
+        batch_requests = @phrases_flat.inject([]) do |o,(k,v)| 
+          # ToDo: Materialize ALL CLDR plural tags if at least one is present for a leaf node.
+          o << {:string_key => k, :string => v}
+        end
+
+        @project.input_bulk(batch_requests)
+      end
+
+      # When your translators are done, call this method to download all available translations and save them as Simple backend *.yml files.
+      # Outside of Rails, manually supply the path where downloaded files should be saved.
+      def download_translations(path=nil)
+        if defined? Rails
+          path ||= [Rails.root.to_s, "config", "locales"].join("/")
+        else
+          raise ArgumentError, "Please supply the path where locales are to be downloaded." unless path
+          path = path.chop if path =~ /\/$/
+        end if
+
+        output = @project.output
+
+        # Let's ignore other hash nodes from the API and just rely on the string keys we sent during upload. Prefix with locale.
+        @translations = Hash.new{ |h,k| h[k] = Hash.new(&h.default_proc) }
+        output.map do |k0,v0| # Page level
+          v0.map do |k1, v1| # Locale level
+            v1.map do |k2, v2| # string key level
+              @translations[k1][[k1, k2].join('.')] = v2 
+            end
+          end 
+        end
+
+        # Delete all existing one_sky translation files before downloading a new set.
+        File.delete(*Dir.glob("#{path}/*_one_sky.yml"))
+        
+        # Process each locale and save to file
+        @translations.map { |k,v| save_locale(k, v, "#{path}/#{k}_one_sky.yml") unless k.to_s == @one_sky_locale }
+      end
+
+      protected
+
+      def save_locale(lang_code, phrases, filename)
+        nested = Hash.new{ |h,k| h[k] = Hash.new(&h.default_proc) }
+        phrases.map do |k,v|
+          node = nested
+          parts = k.split('.')
+          parts.each_with_index { |segment,i| node[segment]; i == parts.size - 1 ? node[segment] = v : node = node[segment] }
+        end
+
+        lang = @one_sky_languages.find { |e| e["lang_code"] == lang_code }
+
+        File.open(filename, 'w') do |f| 
+          f.puts "# PLEASE DO NOT EDIT THIS FILE."
+          f.puts "# This was downloaded from OneSky. Log in to your OneSky account to manage translations on their website."
+          f.puts "# Language code: #{lang['lang_code']}"
+          f.puts "# Language name: #{lang['name']}"
+          f.puts "# Language English name: #{lang['eng_name']}"
+          f.print(nested.to_yaml)
+        end 
+        filename
+      end
+
+      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 check_default_locales_match
+        # Special case: i18n "en" is "en-us".
+        i18n_default_locale = I18n.default_locale == :en ? "en-us" : I18n.default_locale.to_s.downcase
+        raise DefaultLocaleMismatchError, "I18n and OneSky have different default locale settings. #{I18n.default_locale.to_s} <> #{@one_sky_locale}" if i18n_default_locale != @one_sky_locale.downcase 
+      end
+    end
+  end
+end
+

data/lib/i18n-one_sky/version.rb

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

data/lib/i18n-one_sky.rb

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

data/spec/data/en.yml

@@ -0,0 +1,15 @@
+"en":
+  number:
+    currency:
+      format:
+        unit:      "$"
+        precision: 2
+        separator: "."
+        delimiter: ","
+        format:    "%u%n"
+  my_pages:
+    page:
+      title: "My Page Title"
+      subtitle: "My Page SubTitle"
+      footer: "A footer"
+

data/spec/helpers.rb

@@ -0,0 +1,22 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'i18n-one_sky'
+
+module I18nOneSkySpecHelpers
+  def create_simple_client
+    raise "Please set environment variables: ONESKY_API_KEY, ONESKY_API_SECRET and ONESKY_SPEC_PROJ (default: i18noneskyspec) before running spec." unless [ENV["ONESKY_API_KEY"], ENV["ONESKY_API_SECRET"]].all?
+    I18n.default_locale = :en
+    client = I18n::OneSky::SimpleClient.new(
+      :api_key => ENV["ONESKY_API_KEY"], 
+      :api_secret => ENV["ONESKY_API_SECRET"], 
+      :project => ENV["ONESKY_SPEC_PROJ"] || "i18noneskyspec"
+    )
+  end
+
+  def create_simple_client_and_load
+    client = create_simple_client
+    client.load_phrases([File.dirname(__FILE__), "data"].join('/'))
+    client 
+  end  
+end

data/spec/simple_client_spec.rb

@@ -0,0 +1,58 @@
+require 'helpers'
+
+describe "SimpleClient" do
+
+  it "raises an error when initialization values are nil." do
+    lambda { @client = I18n::OneSky::SimpleClient.new(:api_key => nil, :api_secret => nil, :project => nil) }.should raise_error ArgumentError
+  end
+
+  it "raises an error when OneSky and I18n default locales do not match." do
+    I18n.default_locale = :th
+    lambda { @client = I18n::OneSky::SimpleClient.new(:project => ENV["ONESKY_SPEC_PROJ"]) }.should raise_error I18n::OneSky::DefaultLocaleMismatchError
+  end
+end
+
+describe "SimpleClient" do
+  include I18nOneSkySpecHelpers
+
+  before do
+    @client = create_simple_client_and_load
+  end
+
+  describe "#load_phrases" do
+    it "should load nested phrases." do
+      @client.phrases_nested[:my_pages][:page][:title].should == "My Page Title"
+    end
+
+    it "should load flattened phrases." do
+      @client.phrases_flat[:'my_pages.page.title'].should == "My Page Title"
+    end
+
+    it "should not load excluded sections." do
+      @client.phrases_flat[:'number.currency.format.unit'].should be_nil
+    end
+  end
+
+  describe "#upload_phrases" do
+    it "returns true." do
+      @client.upload_phrases.should be_true
+    end
+  end
+end
+
+describe "SimpleClient" do
+  include I18nOneSkySpecHelpers
+
+  before do
+    @client = create_simple_client
+  end
+
+  describe "#download_translations" do
+    path = [File.dirname(__FILE__), 'data'].join('/')
+    it "saves translation files." do
+      @client.download_translations(path).should be_a_kind_of Array
+      Dir.glob("#{path}/*_one_sky.yml").size.should >= 1
+    end
+  end
+end
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: i18n-one_sky
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Junjun Olympia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-03 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.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 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  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 
+        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 
+        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 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+description: A set of I18n extensions that use OneSky. At its most basic, this allows you to easily submit translation requests to the OneSky service and download available translations as Simple backend YAML files.
+email: 
+- romeo.olympia@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- CREDITS
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- i18n-one_sky.gemspec
+- lib/generators/one_sky/init/init_generator.rb
+- lib/i18n-one_sky.rb
+- lib/i18n-one_sky/rails/railtie.rb
+- lib/i18n-one_sky/rails/tasks/i18n-one_sky.rake
+- lib/i18n-one_sky/simple_client.rb
+- lib/i18n-one_sky/version.rb
+- spec/data/en.yml
+- spec/helpers.rb
+- spec/simple_client_spec.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/i18n-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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: i18n-one_sky
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: I18n extensions using OneSky -- the community-powered translation service.
+test_files: 
+- spec/data/en.yml
+- spec/helpers.rb
+- spec/simple_client_spec.rb