i18n-one_sky 2.0.0 → 2.0.1

data/Rakefile

@@ -16,8 +16,16 @@ 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
+desc "Run all specs"
+RSpec::Core::RakeTask.new() do |t|
+end
+
+desc "Run offline specs"
+RSpec::Core::RakeTask.new("spec:offline") do |t|
+  t.rspec_opts = %w{--tag ~live}
+end
+
+desc "Run live specs"
+RSpec::Core::RakeTask.new("spec:live") do |t|
+  t.rspec_opts = %w{--tag live}
 end

data/lib/i18n/one_sky/active_record_client.rb

@@ -10,6 +10,8 @@ module I18n
       Translation = I18n::Backend::ActiveRecord::Translation
 
       def download
+        puts "Downloading translations for I18n Active Record Backend:"
+
         platform_locales.each do |locale|
           locale_code  = locale["locale"]
           local_name   = locale["name"]["local"]
@@ -23,8 +25,7 @@ module I18n
           else
             yaml = platform.translation.download_yaml(locale_code)
             YAML.load(yaml).each do |code, translations|
-              puts "Inserting translations:"
-              puts translations.inspect.to_yaml
+              puts "  locale: #{locale_code}, count: #{translations.length}"
               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)

data/lib/i18n/one_sky/client_base.rb

@@ -61,6 +61,8 @@ module I18n
       # * api_secret
       # * project
       def initialize(options = {})
+        verify_options!(options)
+
         @client   = ::OneSky::Client.new(options[:api_key], options[:api_secret])
         @project  = @client.project(options[:project])
         @platform = @project.platform(options[:platform_id])
@@ -109,12 +111,37 @@ module I18n
       def upload_phrases(phrases)
         skip, upload = phrases.partition{ |string_key, string| skip_key?(string_key) }
 
-        puts "Uploading phrases:"
-        puts upload.to_yaml
+        puts "Uploading strings:"
+        puts "  count: #{upload.length}"
         platform.translation.input_phrases(upload)
+      end
+
+      REQUIRED_KEYS = [:api_key, :api_secret, :project, :platform_id]
+
+      REQUIRED_KEYS_MESSAGE = <<-MESSAGE
+One Sky API Version 2 works differently to Version 1.
+
+Translations are now attached to a "platform", as well as a project.
+Eg. there may be one for Android, one for IOS, and one for Web.
 
-        puts "Skipped phrases:"
-        puts skip.to_yaml
+In order to authenticate for this gem, you must now specify the following;
+
+* ONE_SKY_API_KEY
+* ONE_SKY_API_SECRET
+* ONE_SKY_PROJECT      -- the name of the project
+* ONE_SKY_PLATFORM_ID  -- the numeric id of the platform
+
+Try running
+  rails generate one_sky:init
+
+again to regenerate your config.
+      MESSAGE
+
+      def verify_options!(options)
+        missing_keys = REQUIRED_KEYS - options.keys
+        unless missing_keys.empty?
+          raise ::ArgumentError, REQUIRED_KEYS_MESSAGE
+        end
       end
 
       def verify_platform!

data/lib/i18n/one_sky/simple_client.rb

@@ -10,6 +10,8 @@ module I18n
 
       # Store all translations from OneSky in YAMl files.
       def download(yaml_path)
+        puts "Downloading translations for I18n Simple Backend:"
+
         platform_locales.each do |locale|
           locale_code  = locale["locale"]
           local_name   = locale["name"]["local"]
@@ -21,15 +23,16 @@ module I18n
           else
             yaml = platform.translation.download_yaml(locale_code)
 
-            File.open(File.join(yaml_path, "#{locale_code}_one_sky.yml"), "w") do |f|
+            yaml_file_name = "#{locale_code}_one_sky.yml"
+            puts "  locale: #{locale_code}, file: #{yaml_file_name}"
+
+            File.open(File.join(yaml_path, yaml_file_name), "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

data/lib/i18n/one_sky/version.rb

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

data/spec/fixtures/files/config-incomplete.yml

@@ -0,0 +1,13 @@
+#
+# 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"] %>
+#
+---
+api_key: abc123
+api_secret: def456
+project: some-project

data/spec/fixtures/files/config.yml

@@ -0,0 +1,14 @@
+#
+# 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"] %>
+#
+---
+api_key: abc123
+api_secret: def456
+project: some-project
+platform_id: 888

data/spec/simple_client_spec.rb

@@ -19,7 +19,7 @@ require 'spec_helper'
 require 'tmpdir'
 require 'yaml'
 
-describe I18n::OneSky::SimpleClient, "LIVE", :live => true do
+describe I18n::OneSky::SimpleClient do
   
   let(:onesky_api_key)    { ENV["ONESKY_API_KEY"] }
   let(:onesky_api_secret) { ENV["ONESKY_API_SECRET"] }
@@ -38,43 +38,60 @@ describe I18n::OneSky::SimpleClient, "LIVE", :live => true do
       :platform_id => platform_id)
   end
   
-  context "download" do
+  
+  context "initialization" do
+    context "from file" do
+      it "works" do
+        I18n::OneSky::SimpleClient.from_config(fixture_path("config.yml"))
+      end
 
-    let(:yaml_path) { Dir.tmpdir }
-    
-    def yaml_files
-      Dir.glob(yaml_path+"/*.yml")
+      it "raises if a key is missing" do
+        expect{
+          I18n::OneSky::SimpleClient.from_config(fixture_path("config-incomplete.yml"))
+        }.to raise_error(ArgumentError)
+      end
     end
+  end
+  
+  context "LIVE", :live => true do
+    context "download" do
 
-    before(:each) do
-      # delete any pre-existing yml files.
-      File.delete(*yaml_files)
-    end
+      let(:yaml_path) { Dir.tmpdir }
+    
+      def yaml_files
+        Dir.glob(yaml_path+"/*.yml")
+      end
 
-    it "creates yaml files" do
-      yaml_files.should be_empty
+      before(:each) do
+        # delete any pre-existing yml files.
+        File.delete(*yaml_files)
+      end
+
+      it "creates yaml files" do
+        yaml_files.should be_empty
       
-      client.download(yaml_path)
+        client.download(yaml_path)
       
-      yaml_files.should_not be_empty
-    end
+        yaml_files.should_not be_empty
+      end
     
-    it "creates a yaml file for the chinese locale." do
-      client.download(yaml_path)
+      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
+        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
   
-  context "upload" do
+    context "upload" do
     
-    let(:yaml_path) { File.expand_path("../fixtures/files", __FILE__) }
+      let(:yaml_path) { File.expand_path("../fixtures/files", __FILE__) }
     
-    it "uploads any yaml files in the path" do
-      client.upload(yaml_path)
+      it "uploads any yaml files in the path" do
+        client.upload(yaml_path)
+      end
     end
   end
   

data/spec/spec_helper.rb

@@ -1,2 +1,10 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 require 'i18n-one_sky'
+
+def spec_root_path
+  File.expand_path(File.dirname(__FILE__))
+end
+
+def fixture_path(file_name)
+  File.join(spec_root_path, "fixtures", "files", file_name)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-one_sky
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   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: &70239195965320 !ruby/object:Gem::Requirement
+  requirement: &70126500654480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70239195965320
+  version_requirements: *70126500654480
 - !ruby/object:Gem::Dependency
   name: one_sky
-  requirement: &70239195960480 !ruby/object:Gem::Requirement
+  requirement: &70126500489080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -34,10 +34,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70239195960480
+  version_requirements: *70126500489080
 - !ruby/object:Gem::Dependency
   name: i18n-active_record
-  requirement: &70239203730000 !ruby/object:Gem::Requirement
+  requirement: &70126500556960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70239203730000
+  version_requirements: *70126500556960
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70239203729540 !ruby/object:Gem::Requirement
+  requirement: &70126500919300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70239203729540
+  version_requirements: *70126500919300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70239203729080 !ruby/object:Gem::Requirement
+  requirement: &70126500878320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +67,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70239203729080
+  version_requirements: *70126500878320
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70239203728620 !ruby/object:Gem::Requirement
+  requirement: &70126500833440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,7 +78,7 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70239203728620
+  version_requirements: *70126500833440
 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.
@@ -113,6 +113,8 @@ files:
 - lib/i18n/one_sky/simple_client.rb
 - lib/i18n/one_sky/version.rb
 - spec/active_record_client_spec.rb
+- spec/fixtures/files/config-incomplete.yml
+- spec/fixtures/files/config.yml
 - spec/fixtures/files/en.yml
 - spec/simple_client_spec.rb
 - spec/spec_helper.rb
@@ -142,6 +144,8 @@ specification_version: 3
 summary: I18n extensions using OneSky -- the community-powered translation service.
 test_files:
 - spec/active_record_client_spec.rb
+- spec/fixtures/files/config-incomplete.yml
+- spec/fixtures/files/config.yml
 - spec/fixtures/files/en.yml
 - spec/simple_client_spec.rb
 - spec/spec_helper.rb