i18n-one_sky 1.0.0 → 2.0.0

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile.lock

@@ -1,40 +1,42 @@
 PATH
   remote: .
   specs:
-    i18n-one_sky (0.0.4)
-      i18n (~> 0.5.0)
-      i18n-active_record (~> 0.0.2)
-      one_sky (~> 0.0.2)
-      thor (~> 0.14.4)
+    i18n-one_sky (2.0.0)
+      activesupport (>= 2.2.2)
+      i18n (>= 0.5.0)
+      i18n-active_record (>= 0.0.2)
+      one_sky (= 2.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    i18n (0.5.0)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
     i18n-active_record (0.0.2)
       i18n (>= 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)
+    json (1.6.3)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    one_sky (2.0.0)
+      json (>= 1.4.0)
+      rest-client (>= 1.4.0)
     rest-client (1.6.7)
       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)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.2.0)
-    thor (0.14.6)
+    rspec-mocks (2.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (>= 1.0.0)
   i18n-one_sky!
   rspec (~> 2.2.0)

data/README.rdoc

@@ -22,17 +22,17 @@ Then tell Bundler to 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
+  rails generate one_sky:init my_api_key my_api_secret my_project my_platform_id
 
 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
+  rake one_sky:upload
 
 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
+  rake one_sky:download
 
 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.
 
@@ -48,21 +48,21 @@ And see I18n::OneSky::SimpleClient for the methods available in Ruby.
 
 = Using Database as translation storage, YAML as fallback (since version 0.0.3, Rails only)
 
-assuming that you have either run one_sky:init or configured "ONESKY_API_KEY", "ONESKY_API_SECRET" and "ONESKY_PROJECT" environment variables. The following command generates rails initializers and run db migration:
+The following command generates rails initializers and run db migration:
 
   rails generate one_sky:init_active_record_backend
 
 use the upload_phrases rake command to upload your default locale to one sky server: 
 
-  rake one_sky:upload_phrases
+  rake one_sky:active_record:upload
 
-Then, instead of running one_sky:download_translations, run the following command to download and store the translations into translations database table:
+Then, instead of running one_sky:download, run the following command to download and store the translations into translations database table:
 
-  rake one_sky:update_active_record_translations
+  rake one_sky:active_record:download
 
 = Using i18n-one_sky gem in Heroku
 
-Because Heroku is read-only file system, you have to use database storage as storage backend. Either configure the "ONESKY_API_KEY", "ONESKY_API_SECRET" and "ONESKY_PROJECT" environment variables manually or use the OneSky Heroku addon.
+Because Heroku is read-only file system, you have to use database storage as storage backend. Either configure the "ONESKY_API_KEY", "ONESKY_API_SECRET", "ONESKY_PROJECT", "ONESKY_PLATFORM_ID" environment variables manually or use the OneSky Heroku addon.
 
 Read "Using Database as translation storage" sections for details to upload and download phrases.
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 # = RDoc 
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 Rake::RDocTask.new do |t|
   t.rdoc_dir = 'rdoc'
@@ -11,3 +11,13 @@ Rake::RDocTask.new do |t|
   t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'CHANGELOG', 'CREDITS', 'lib/**/*.rb')
 end
 
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/i18n-one_sky.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "i18n-one_sky/version"
+require "i18n/one_sky/version"
 
 Gem::Specification.new do |s|
   s.name        = "i18n-one_sky"
@@ -15,12 +15,12 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "i18n-one_sky"
 
   s.add_dependency "i18n", ">= 0.5.0"
-  s.add_dependency "one_sky", "1.0.0"
-  s.add_dependency 'i18n-active_record', "~> 0.0.2"
-  s.add_dependency "thor", "~> 0.14.4"
+  s.add_dependency "one_sky", "2.0.0"
+  s.add_dependency 'i18n-active_record', ">= 0.0.2"
+  s.add_dependency "activesupport", ">= 2.2.2"
 
   s.add_development_dependency "rspec", "~> 2.2.0"
-  s.add_development_dependency "bundler", "~> 1.0.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")

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

@@ -2,28 +2,45 @@ 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('/')
+
+      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"
+      argument :platform_id, :type => :string, :desc => "The id of the OneSky platform"
+
+      class_option :force,   :type => :boolean, :default => false, :desc => "Overwrite if config file already exists"
+
+      CONFIG_PATH = File.join(Rails.root.to_s, 'config', 'one_sky.yml')
 
       def remove_config_file
-        if File.exists? @@config_file
+        if File.exists? CONFIG_PATH
           if options.force?
             say_status("warning", "config file already exists and is being overwritten.", :yellow)
-            remove_file @@config_file
+            remove_file CONFIG_PATH
           else
             say_status("error", "config file already exists. Use --force to overwrite.", :red)
-            raise "Error: OneSky config file exists."
           end
         end
       end
 
+      YAML_COMMENT = <<-YAML
+#
+# To load your OneSky details from the environment
+# just add some erb tags like this.
+#
+#   api_key:     <%= ENV["ONESKY_API_KEY"] %>
+#   api_secret:  <%= ENV["ONESKY_API_SECRET"] %>
+#   project:     <%= ENV["ONESKY_PROJECT"] %>
+#   platform_id: <%= ENV["ONESKY_PLATFORM_ID"] %>
+#
+      YAML
+
+      def config_hash
+        {"api_key" => api_key, "api_secret" => api_secret, "project" => project, "platform_id" => platform_id.to_i}
+      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)
+        create_file(CONFIG_PATH, YAML_COMMENT+config_hash.to_yaml)
       end
     end
   end

data/lib/generators/one_sky/init_active_record_backend/init_active_record_backend_generator.rb

@@ -10,8 +10,11 @@ module OneSky
       source_root File.expand_path("../templates", __FILE__)
       
       def install_onesky_active_record
-        generate_initializers
+        # generate the migration first
         generate_db_migration
+        
+        # then create the initializer (else we cant migrate)
+        generate_initializers
       end
       
       def self.next_migration_number(dirname)
@@ -25,11 +28,11 @@ module OneSky
       protected
 
       def generate_initializers
-        copy_file "onesky.rb", "config/initializers/onesky.rb"
+        copy_file "active_record_backend.rb", "config/initializers/active_record_backend.rb"
       end
       
       def generate_db_migration
-        migration_template 'migration.rb', 'db/migrate/create_translations_table.rb'        
+        migration_template 'migration.rb', 'db/migrate/create_translations_table.rb'
         rake("db:migrate")
       end
     end

data/lib/generators/one_sky/init_active_record_backend/templates/active_record_backend.rb

@@ -0,0 +1,13 @@
+require 'i18n/backend/active_record'
+
+# flatten and memoize the active record backend
+I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
+I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Flatten)
+
+# ensure we have migrated before we try and use the backend.
+if I18n::Backend::ActiveRecord::Translation.table_exists?
+  # chain it into the existing backend
+  I18n.backend = I18n::Backend::Chain.new(I18n.backend, I18n::Backend::ActiveRecord.new)
+else
+  warn "There is currently no translations table. You may need to migrate."
+end

data/lib/generators/one_sky/init_active_record_backend/templates/migration.rb

@@ -9,6 +9,7 @@ class CreateTranslationsTable < ActiveRecord::Migration
 
       t.timestamps
     end
+    add_index :translations, [:locale, :key]
   end
 
   def self.down

data/lib/i18n-one_sky.rb

@@ -1,19 +1 @@
-require 'i18n'
-require 'one_sky'
-require 'i18n-one_sky/rails/railtie.rb' if defined? Rails
-require 'i18n/backend/active_record' if defined? ActiveRecord
-
-module I18n
-  module OneSky
-    autoload :SimpleClient, 'i18n-one_sky/simple_client'
-    class DefaultLocaleMismatchError < StandardError; end
-
-    if defined?(ActiveRecord)
-      module Translator
-        class Backend < I18n::Backend::ActiveRecord
-          include I18n::Backend::Memoize
-        end
-      end
-    end
-  end
-end
+require 'i18n/one_sky'

data/lib/i18n/one_sky.rb

@@ -0,0 +1,15 @@
+require 'i18n'
+require 'one_sky'
+require 'i18n/one_sky/rails/railtie.rb' if defined? Rails
+
+module I18n
+  module OneSky
+    # we only want to load this when i18n-active_record is in use.
+    autoload :ActiveRecordClient, 'i18n/one_sky/active_record_client'
+
+    class DefaultLocaleMismatchError < StandardError; end
+  end
+end
+
+require 'i18n/one_sky/simple_client'
+require 'i18n/one_sky/version'

data/lib/i18n/one_sky/active_record_client.rb

@@ -0,0 +1,53 @@
+require 'i18n/backend/active_record'
+require 'i18n/one_sky/client_base'
+
+module I18n
+  module OneSky
+    # A class to deal with the OneSky apis
+    # it encapsulates the logic of I18n::Backend::ActiveRecord
+    class ActiveRecordClient < ClientBase
+
+      Translation = I18n::Backend::ActiveRecord::Translation
+
+      def download
+        platform_locales.each do |locale|
+          locale_code  = locale["locale"]
+          local_name   = locale["name"]["local"]
+          english_name = locale["name"]["eng"]
+
+          i18n_locale_code = locale_os_to_i18n(locale_code)
+
+          if locale_code == platform_base_locale
+            # we skip the base
+            next
+          else
+            yaml = platform.translation.download_yaml(locale_code)
+            YAML.load(yaml).each do |code, translations|
+              puts "Inserting translations:"
+              puts translations.inspect.to_yaml
+              translations.each do |key, value|
+                Translation.locale(i18n_locale_code).delete_all(["key=?", key])
+                Translation.create!(:locale => i18n_locale_code, :key => key.to_s, :value => value)
+              end
+            end
+          end
+        end
+      end
+
+      def upload
+        upload_phrases(all_phrases)
+      end
+
+      # Grab all the keys from the active record store.
+      def all_phrases
+        phrases = Hash.new
+        I18n::Backend::ActiveRecord::Translation.locale(I18n.default_locale).find_each() do |translation|
+          phrases[translation.key] = translation.value
+        end
+        phrases
+      end
+      memoize :all_phrases
+
+    end
+  end
+end

data/lib/i18n/one_sky/client_base.rb

@@ -0,0 +1,153 @@
+require 'active_support/memoizable'
+
+module I18n
+  module OneSky
+    # A base class to deal with the OneSky apis
+    #
+    # Its subclasses;
+    #   SimpleClient
+    #   ActiveRecordClient
+    #
+    # encapsulate specifics of uploading/downloading for the I18n backends;
+    #   I18n::Backend::Simple
+    #   I18n::Backend::ActiveRecord
+    class ClientBase
+      extend ActiveSupport::Memoizable
+
+      # The base OneSky project. Gives you low-level access to the API gem.
+      attr_reader :client, :project, :platform
+
+      # Load the client from the one_sky.yml file (installed by `rails generate one_sky:init_generator`)
+      def self.from_config(config_path)
+        if self.config_exists?(config_path)
+          self.new(load_config(config_path))
+        else
+          self.from_env
+        end
+      end
+
+      # Load the client from environment variables.
+      def self.from_env
+        self.new(
+          :api_key     => ENV["ONESKY_API_KEY"],
+          :api_secret  => ENV["ONESKY_API_SECRET"],
+          :project     => ENV["ONESKY_PROJECT"],
+          :platform_id => ENV["ONESKY_PLATFORM_ID"])
+      end
+
+      # Load the one_sky.yml file.
+      # first parsing it as ERB
+      # to enable dynamic config;
+      #
+      #   api_key:     <%= ENV["ONESKY_API_KEY"] %>
+      #   api_secret:  <%= ENV["ONESKY_API_SECRET"] %>
+      #   project:     <%= ENV["ONESKY_PROJECT"] %>
+      #   platform_id: <%= ENV["ONESKY_PLATFORM_ID"] %>
+      #
+      def self.load_config(config_path)
+        require 'erb'
+        YAML::load(ERB.new(File.read(config_path)).result).symbolize_keys
+      end
+
+      # check if the path exists
+      def self.config_exists?(config_path)
+        File.exist?(config_path)
+      end
+
+      # 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 = {})
+        @client   = ::OneSky::Client.new(options[:api_key], options[:api_secret])
+        @project  = @client.project(options[:project])
+        @platform = @project.platform(options[:platform_id])
+      end
+
+      # Check the configuration of our client.
+      def verify!
+        verify_platform!
+        verify_default_locale!
+      end
+
+      # The default locale for the platform.
+      def platform_base_locale
+        platform_details["base_locale"]
+      end
+
+      # An array of codes. eg. ["en_US", "zh_CN"]
+      def platform_locale_codes
+        platform_locales.map do |hash|
+          hash["locale"]
+        end
+      end
+
+      # Cached call to load the locales for a platform.
+      def platform_locales
+        @platform.locales
+      end
+      memoize :platform_locales
+
+      # Cached call to load the details for the platform.
+      def platform_details
+        @platform_details ||= @platform.details
+      end
+      memoize :platform_details
+
+      # Remove all Rails i18n keys as of December 2nd 2011.
+      #  https://github.com/svenfuchs/rails-i18n/blob/a4fb3d3dbb1a05a2adc82355c934e81eea67e3a1/rails/locale/en-GB.yml
+      SKIP_KEYS_REGEXP = /^(date|time|support|number|datetime|helpers|errors|activerecord)#{Regexp.escape(I18n.default_separator)}/
+
+      protected
+
+      def skip_key?(key)
+        key =~ SKIP_KEYS_REGEXP
+      end
+
+      def upload_phrases(phrases)
+        skip, upload = phrases.partition{ |string_key, string| skip_key?(string_key) }
+
+        puts "Uploading phrases:"
+        puts upload.to_yaml
+        platform.translation.input_phrases(upload)
+
+        puts "Skipped phrases:"
+        puts skip.to_yaml
+      end
+
+      def verify_platform!
+        # call the api for the platform
+        # this'll raise if there's an authentication problem
+        platform_details
+      end
+
+      def verify_default_locale!
+        if I18n.default_locale.to_s.downcase != locale_os_to_i18n(platform_base_locale).to_s.downcase
+          raise DefaultLocaleMismatchError, "I18n and OneSky have different default locale settings. #{I18n.default_locale} <> #{platform_base_locale}"
+        end
+      end
+
+      # i18n has a default locale of :en
+      # while OneSky uses "en_US"
+      def locale_os_to_i18n(locale)
+        case locale
+        when "en_US"
+          "en"
+        else
+          locale
+        end
+      end
+
+      def locale_i18n_to_os(locale)
+        case locale.to_s
+        when "en"
+          "en_US"
+        else
+          locale.to_s
+        end
+      end
+    end
+  end
+end

data/lib/{i18n-one_sky → i18n/one_sky}/rails/railtie.rb

@@ -2,8 +2,8 @@ module I18n
   module Onesky
     class Railtie < ::Rails::Railtie
       rake_tasks do
-        load "i18n-one_sky/rails/tasks/i18n-one_sky.rake"
-      end      
+        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,45 @@
+namespace :one_sky do
+
+  desc "Upload phrases for translation to OneSky."
+  task :upload => :environment do
+    simple_client.upload(locales_path)
+    puts "Phrases uploaded to OneSky. Please ask your translators to... well... get translating."
+  end
+
+  desc "Download available translations from OneSky and store as yml files."
+  task :download => :environment do
+    simple_client.download(locales_path)
+    puts "Translations downloaded and saved to config/locales/*_one_sky.yml files."
+  end
+
+  namespace :active_record do
+
+    desc "Upload."
+    task :upload => :environment do
+      active_record_client.upload
+    end
+
+    desc "Download available translations from OneSky and stores into Active Record database"
+    task :download => :environment do
+      active_record_client.download
+    end
+
+  end
+
+  def active_record_client
+    I18n::OneSky::ActiveRecordClient.from_config(one_sky_config)
+  end
+
+  def simple_client
+    I18n::OneSky::SimpleClient.from_config(one_sky_config)
+  end
+
+  def locales_path
+    Rails.root.join("config/locales")
+  end
+
+  def one_sky_config
+    Rails.root.join('config', 'one_sky.yml')
+  end
+
+end

data/lib/i18n/one_sky/simple_client.rb

@@ -0,0 +1,65 @@
+require 'i18n/one_sky/client_base'
+require 'yaml'
+
+module I18n
+  module OneSky
+    # A class to deal with the OneSky apis
+    # it encapsulates the logic of I18n::Backend::ActiveRecord
+    class SimpleClient < ClientBase
+      include I18n::Backend::Flatten
+
+      # Store all translations from OneSky in YAMl files.
+      def download(yaml_path)
+        platform_locales.each do |locale|
+          locale_code  = locale["locale"]
+          local_name   = locale["name"]["local"]
+          english_name = locale["name"]["eng"]
+
+          if locale_code == platform_base_locale
+            # We skip the base locale.
+            next
+          else
+            yaml = platform.translation.download_yaml(locale_code)
+
+            File.open(File.join(yaml_path, "#{locale_code}_one_sky.yml"), "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: #{locale_code}"
+              f.puts "# Language name: #{local_name}"
+              f.puts "# Language English name: #{english_name}"
+              f.write yaml
+
+              puts "Writing: #{f.path}"
+            end
+          end
+        end
+      end
+
+      # Scan all yaml files for keys in the default locale, and push them to OneSky.
+      def upload(yaml_path)
+        upload_phrases(all_phrases(yaml_path))
+      end
+
+      def all_phrases(yaml_path)
+        phrases = {}
+        Dir.glob("#{yaml_path}/**/*.yml").each do |path|
+          hash = YAML::load(File.read(path))
+          phrases.merge!(hash[I18n.default_locale.to_s]) if hash.has_key?(I18n.default_locale.to_s)
+        end
+        flatten_phrases(phrases)
+      end
+      memoize :all_phrases
+
+      protected
+
+      def flatten_phrases(phrases)
+        hash = {}
+        flatten_keys(phrases, true) do |key, value|
+          hash[key.to_s] = value unless value.is_a?(Hash)
+        end
+        hash
+      end
+    end
+  end
+end
+

data/lib/{i18n-one_sky → i18n/one_sky}/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Onesky
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/spec/active_record_client_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+# this spec runs through live api calls
+# and requires a real api key for the account
+#
+#   http://ruby-gem-tests.oneskyapp.com/
+#
+# before running this test we need to do
+#
+#   export ONESKY_API_KEY="the key"
+#   export ONESKY_API_SECRET="the secret"
+#
+# the rake spec task skips these test
+# you need to run
+#
+#   rake spec:live
+#
+require 'spec_helper'
+
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => (RUBY_PLATFORM=="java" ? "jdbcsqlite3" : "sqlite3"),
+  :database => ":memory:"
+)
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :translations, :force => true do |t|
+    t.string  :locale
+    t.string  :key
+    t.text    :value
+    t.text    :interpolations
+    t.boolean :is_proc, :default => false
+
+    t.timestamps
+  end
+end
+
+describe I18n::OneSky::ActiveRecordClient, "LIVE", :live => true do
+  
+  let(:onesky_api_key)    { ENV["ONESKY_API_KEY"] }
+  let(:onesky_api_secret) { ENV["ONESKY_API_SECRET"] }
+  let(:project_name)      { "api-test" }
+  let(:platform_id)       { 840 }
+  let(:platform_code)     { "website" }
+  
+  let(:english_locale) { "en_US" }
+  let(:chinese_locale) { "zh_CN" }
+  
+  let(:client) do
+    I18n::OneSky::ActiveRecordClient.new(
+      :api_key     => onesky_api_key,
+      :api_secret  => onesky_api_secret,
+      :project     => project_name,
+      :platform_id => platform_id)
+  end
+  
+  before(:each) do
+    I18n.backend = I18n::Backend::ActiveRecord.new
+  end
+  
+  context "download" do
+
+    it "works" do
+      client.download
+    end
+    
+    context "with a chained backend" do
+      before(:each) do
+        I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n::Backend::ActiveRecord.new)
+      end
+      
+      it "works" do
+        client.upload
+      end
+    end
+
+  end
+  
+  context "upload" do
+    
+    before(:each) do
+      I18n::Backend::ActiveRecord::Translation.delete_all
+      I18n::Backend::ActiveRecord::Translation.create!(:locale => "en", :key => "test1", :value => "Test 1")
+      I18n::Backend::ActiveRecord::Translation.create!(:locale => "en", :key => "test2", :value => "Test 2")
+      I18n::Backend::ActiveRecord::Translation.create!(:locale => "en", :key => "number.something", :value => "skip this")
+    end
+    
+    it "works" do
+      client.upload
+    end
+    
+    context "with a chained backend" do
+      before(:each) do
+        I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n::Backend::ActiveRecord.new)
+      end
+      
+      it "works" do
+        client.upload
+      end
+    end
+    
+  end
+end

data/spec/simple_client_spec.rb

@@ -1,58 +1,82 @@
-require 'helpers'
+# encoding: utf-8
 
-describe "SimpleClient" do
+# this spec runs through live api calls
+# and requires a real api key for the account
+#
+#   http://ruby-gem-tests.oneskyapp.com/
+#
+# before running this test we need to do
+#
+#   export ONESKY_API_KEY="the key"
+#   export ONESKY_API_SECRET="the secret"
+#
+# the rake spec task skips these test
+# you need to run
+#
+#   rake spec:live
+#
+require 'spec_helper'
+require 'tmpdir'
+require 'yaml'
 
-  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
+describe I18n::OneSky::SimpleClient, "LIVE", :live => true do
+  
+  let(:onesky_api_key)    { ENV["ONESKY_API_KEY"] }
+  let(:onesky_api_secret) { ENV["ONESKY_API_SECRET"] }
+  let(:project_name)      { "api-test" }
+  let(:platform_id)       { 840 }
+  let(:platform_code)     { "website" }
+  
+  let(:english_locale) { "en_US" }
+  let(:chinese_locale) { "zh_CN" }
+  
+  let(:client) do
+    I18n::OneSky::SimpleClient.new(
+      :api_key     => onesky_api_key,
+      :api_secret  => onesky_api_secret,
+      :project     => project_name,
+      :platform_id => platform_id)
   end
+  
+  context "download" do
 
-  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"
+    let(:yaml_path) { Dir.tmpdir }
+    
+    def yaml_files
+      Dir.glob(yaml_path+"/*.yml")
     end
 
-    it "should load flattened phrases." do
-      @client.phrases_flat[:'my_pages.page.title'].should == "My Page Title"
+    before(:each) do
+      # delete any pre-existing yml files.
+      File.delete(*yaml_files)
     end
 
-    it "should not load excluded sections." do
-      @client.phrases_flat[:'number.currency.format.unit'].should be_nil
+    it "creates yaml files" do
+      yaml_files.should be_empty
+      
+      client.download(yaml_path)
+      
+      yaml_files.should_not be_empty
     end
-  end
-
-  describe "#upload_phrases" do
-    it "returns true." do
-      @client.upload_phrases.should be_true
+    
+    it "creates a yaml file for the chinese locale." do
+      client.download(yaml_path)
+      
+      chinese_file = yaml_files.detect{|f| f.end_with?("#{chinese_locale}_one_sky.yml") }
+      yaml = YAML.load(File.read(chinese_file))
+      yaml.keys.should == [chinese_locale]
     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, true).should be_a_kind_of Array
-      Dir.glob("#{path}/*_one_sky.yml").size.should >= 1
+  
+  context "upload" do
+    
+    let(:yaml_path) { File.expand_path("../fixtures/files", __FILE__) }
+    
+    it "uploads any yaml files in the path" do
+      client.upload(yaml_path)
     end
   end
-end
-
+  
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'i18n-one_sky'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-one_sky
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2011-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70214363141080 !ruby/object:Gem::Requirement
+  requirement: &70239195965320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,43 +23,43 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70214363141080
+  version_requirements: *70239195965320
 - !ruby/object:Gem::Dependency
   name: one_sky
-  requirement: &70214363538480 !ruby/object:Gem::Requirement
+  requirement: &70239195960480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70214363538480
+  version_requirements: *70239195960480
 - !ruby/object:Gem::Dependency
   name: i18n-active_record
-  requirement: &70214363480460 !ruby/object:Gem::Requirement
+  requirement: &70239203730000 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70214363480460
+  version_requirements: *70239203730000
 - !ruby/object:Gem::Dependency
-  name: thor
-  requirement: &70214363428020 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &70239203729540 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.14.4
+        version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70214363428020
+  version_requirements: *70239203729540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70214362944740 !ruby/object:Gem::Requirement
+  requirement: &70239203729080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,18 +67,18 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70214362944740
+  version_requirements: *70239203729080
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70214363684400 !ruby/object:Gem::Requirement
+  requirement: &70239203728620 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70214363684400
+  version_requirements: *70239203728620
 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.
@@ -91,6 +91,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - CHANGELOG
 - CREDITS
 - Gemfile
@@ -101,16 +102,20 @@ files:
 - i18n-one_sky.gemspec
 - lib/generators/one_sky/init/init_generator.rb
 - lib/generators/one_sky/init_active_record_backend/init_active_record_backend_generator.rb
+- lib/generators/one_sky/init_active_record_backend/templates/active_record_backend.rb
 - lib/generators/one_sky/init_active_record_backend/templates/migration.rb
-- lib/generators/one_sky/init_active_record_backend/templates/onesky.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
+- lib/i18n/one_sky.rb
+- lib/i18n/one_sky/active_record_client.rb
+- lib/i18n/one_sky/client_base.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/active_record_client_spec.rb
+- spec/fixtures/files/en.yml
 - spec/simple_client_spec.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/i18n-one_sky
 licenses: []
 post_install_message: 
@@ -136,7 +141,8 @@ 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/active_record_client_spec.rb
+- spec/fixtures/files/en.yml
 - spec/simple_client_spec.rb
+- spec/spec_helper.rb
 has_rdoc: 

data/lib/generators/one_sky/init_active_record_backend/templates/onesky.rb

@@ -1,4 +0,0 @@
-YAML_BACKEND = I18n.backend
-ACTIVE_RECORD_BACKEND = I18n::OneSky::Translator::Backend.new
-
-I18n.backend = I18n::Backend::Chain.new(ACTIVE_RECORD_BACKEND, YAML_BACKEND)

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

@@ -1,24 +0,0 @@
-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 and store as yml files."
-  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
-  
-  desc "Download available translations from OneSky and stores into Active Record database"
-  task :update_activerecord_translations do
-    client = I18n::OneSky::SimpleClient.new
-    client.download_translations(nil, true, true)
-    puts "Translations downloaded and saved to database."
-  end
-end

data/lib/i18n-one_sky/simple_client.rb

@@ -1,162 +0,0 @@
-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["base_locale"].gsub('_', '-')
-        @one_sky_locale = @project.details["base_locale"]
-        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)
-        backend = I18n.backend.is_a?(I18n::Backend::Chain) ? I18n.backend.backends.last : I18n.backend
-
-        if defined?(Rails)
-          backend.load_translations
-        else
-          raise ArgumentError, "Please supply the path where locales are located." unless path
-          path = path.chop if path =~ /\/$/
-          backend.load_translations(*Dir.glob("#{path}/**/*.{yml,rb}"))
-        end
-        
-        @phrases_nested = 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, download_base_locale=false, use_active_record=false)
-        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
-
-        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
-
-        if use_active_record
-          @translations.map { |k,v| save_locale(k, v) unless (k.to_s == @one_sky_locale and !download_base_locale)}
-        else 
-          # 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, :filename => "#{path}/#{k}_one_sky.yml") unless (k.to_s == @one_sky_locale and !download_base_locale)}
-        end
-      end
-
-      protected
-
-      def save_locale(lang_code, phrases, options={})
-        nested = to_nested_nodes(phrases)
-
-        lang = @one_sky_languages.find { |e| e["locale"] == lang_code }
-
-        if options[:filename]
-          filename = options[:filename]
-          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['locale']}"
-            f.puts "# Language name: #{lang['local_name']}"
-            f.puts "# Language English name: #{lang['eng_name']}"
-            f.print(nested.to_yaml)
-          end 
-          filename
-        else
-          
-          lang = @one_sky_languages.find { |e| e["locale"] == lang_code }
-          
-          nested.each do |k, values|            
-            values.each do |value|
-              I18n.backend.store_translations(k, value[0] => value[1])
-            end
-          end
-        end
-      end
-      
-      def to_nested_nodes(phrases)
-        nested = Hash.new{ |h,k| h[k] = Hash.new(&h.default_proc) }
-        phrases.each 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
-        
-        nested
-      end
-
-      def default_options
-        options = {:api_key => ENV["ONESKY_API_KEY"], :api_secret => ENV["ONESKY_API_SECRET"], :project => ENV["ONESKY_PROJECT"]}
-        
-        if defined?(Rails)
-          config_file = [Rails.root.to_s, 'config', 'one_sky.yml'].join('/')
-
-          options = YAML.load_file(config_file).symbolize_keys if File.exists?(config_file)
-        end
-        
-        options
-      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/spec/helpers.rb

@@ -1,22 +0,0 @@
-$:.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