onesky-rails 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7310078e5234d06c2c9bf53aeaf4dc69c7460386
-  data.tar.gz: 01d3730c16eb8b98cee057605eb73de3c73b2ba5
+  metadata.gz: c39b314d8923cbeb02de9aa079f5a7879b42d1cb
+  data.tar.gz: ca29ec9a0b41898afbc58f0bb361a610e8e1efc0
 SHA512:
-  metadata.gz: 769551ebb66adc4badd7dbe197fa653142719a385d732cc89c4d7dd1afff2dd74a606176d6cf3a8701e55cc787b8f4db16fc11e4f980a6470d8b7730fb3f7e79
-  data.tar.gz: 02f599857a3116ef72575bc84c7f54f02ae021e9e1afc0980d5ca5e574d4dd227de2ec141c391c5ac6844ac26425e4db5119707d4cd04bc1eb549d62197fa7d3
+  metadata.gz: 2136ba483f9b8a6455039c8dc0da0a0649b4945ce9fff4434919e92d32d9f17a38f57ec83c075e10a26735035eb08765413336168f0289955105789a899bc352
+  data.tar.gz: 0d66f3beef5005099a61e561fcd4d6a3e90e0cab30f22f21f2402d766456f3099cd287f4ff690a180043dfcb2b9e60202ff390d6a8703580c25a7b40ed6d6f83

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1

data/CHANGELOG.md

@@ -18,3 +18,8 @@
 ### 1.2.0 - 13-JUL-2015
 
 * support custom locale
+
+### 1.3.0 - 13-MAY-2016
+
+* support download base language only translation files
+* support download all translation files

data/README.md

@@ -36,12 +36,24 @@ Upload all string files of `I18n.default_locale` to [OneSky](http://www.oneskyap
 ```
 rake onesky:download
 ```
-Download translations of files uploaded in all languages activated in project.
+Download translations of files uploaded in all languages activated in project other than the base language.
+
+**Download base language translations**
+```
+rake onesky:download_base
+```
+Download translations of files uploaded only for the base language.
+
+**Download all languages translations**
+```
+rake onesky:download_all
+```
+Download translations of files uploaded for all the languages including the base language.
 
 ## TODO
 - Specify file to upload
 - Specify file and language to download
-- Support framework other than RoR
+- Support different backend
 
 ## Contributing
 

data/lib/onesky/rails/file_client.rb

@@ -28,12 +28,30 @@ NOTICE
         end
       end
 
-      def download(string_path)
+      ##
+      # Download translations from OneSky platform
+      #
+      # +string_path+ specify the folder path where all localization files locate
+      # +options+     indicate which files to download
+      #               - :base_only => base language only
+      #               - :all       => all languages including base language
+      #               - <empty>    => default value; translation languages
+      #
+      def download(string_path, options = {})
         verify_languages!
 
         files = get_default_locale_files(string_path).map {|path| File.basename(path)}
 
-        @onesky_locales.each do |locale|
+        locales = if options[:base_only]
+          [@base_locale]
+        elsif options[:all]
+          [@base_locale] + @onesky_locales
+        else
+          @onesky_locales
+        end
+
+        locales.each do |locale|
+          locale = locale.to_s
           puts "#{locale_dir(locale)}/"
           onesky_locale = locale.gsub('_', '-')
           files.each do |file|
@@ -53,6 +71,8 @@ NOTICE
       end
 
       def make_translation_dir(dir_path, locale)
+        return dir_path if locale == @base_locale.to_s
+
         target_path = File.join(dir_path, locale_dir(locale))
         Dir.mkdir(target_path) unless File.directory?(target_path)
         target_path

data/lib/onesky/rails/version.rb

@@ -1,5 +1,5 @@
 module Onesky
   module Rails
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

data/lib/tasks/onesky.rake

@@ -1,17 +1,29 @@
 namespace :onesky do
 
-  desc "Upload string files of base locale to OneSky platform."
+  desc 'Upload string files of base locale to OneSky platform.'
   task :upload => :environment do
     file_client.upload(locale_path)
     puts 'Done!'
   end
 
-  desc "Download translations from OneSky platform."
+  desc 'Download translations from OneSky platform.'
   task :download => :environment do
     file_client.download(locale_path)
     puts 'Done!'
   end
 
+  desc 'Download base language translations from OneSky platform.'
+  task :download_base => :environment do
+    file_client.download(locale_path, base_only: true)
+    puts 'Done!'
+  end
+
+  desc 'Download all languages translations from OneSky platform.'
+  task :download_all => :environment do
+    file_client.download(locale_path, all: true)
+    puts 'Done!'
+  end
+
   def file_client
     require 'erb'
     data = YAML::load(ERB.new(File.read(Rails.root.join('config', 'onesky.yml'))).result)
@@ -19,7 +31,7 @@ namespace :onesky do
   end
 
   def locale_path
-    Rails.root.join("config/locales")
+    Rails.root.join('config/locales')
   end
 
 end

data/spec/fixtures/sample_files/en/en.yml

@@ -0,0 +1,13 @@
+en:
+  week:
+    sun: Sunday
+    mon: Monday
+    tue: Tuesday
+    wed: Wednesday
+    thu: Thursday
+    fri: Friday
+    sat: Saturday
+  date:
+    year: Year
+    month: month
+    day: Day

data/spec/fixtures/sample_files/en/special_en.yml

@@ -0,0 +1,3 @@
+en:
+  some: thing
+  i18n: internationalization

data/spec/fixtures/{locales → sample_files/ja}/ja.yml

@@ -7,3 +7,7 @@ ja:
     thu: 木曜日
     fri: 金曜日
     sat: 土曜日
+  date:
+    year: 年
+    month: 月
+    day: 日

data/spec/fixtures/sample_files/ja/special_ja.yml

@@ -0,0 +1,3 @@
+ja:
+  some: もの
+  i18n: 国際化

data/spec/onesky/rails/file_client_spec.rb

@@ -4,10 +4,19 @@ describe Onesky::Rails::FileClient do
 
   let(:config_hash) { create_config_hash }
   let(:client) {Onesky::Rails::FileClient.new(config_hash)}
+  let(:sample_file_path) { File.expand_path("../../../fixtures/sample_files", __FILE__) }
   let(:file_path) { File.expand_path("../../../fixtures/locales", __FILE__) }
 
   before(:each) do
     stub_language_request(config_hash['api_key'], config_hash['api_secret'], config_hash['project_id'])
+
+    # create test dir
+    FileUtils.copy_entry "#{sample_file_path}/original", file_path
+  end
+
+  after(:each) do
+    # delete test dir
+    FileUtils.remove_dir(file_path) if File.directory?(file_path)
   end
 
   context '#upload' do
@@ -21,55 +30,76 @@ describe Onesky::Rails::FileClient do
 
   context 'download' do
 
-    let(:expected_locale_files) do
-      ["#{locale_dir}/ja.yml", "#{locale_dir}/special_ja.yml"]
-    end
-
     let(:file_names) {['en.yml', 'special_en.yml']}
 
-    def locale_dir
-      File.join(file_path, 'onesky_ja')
+    def locale_dir(locale)
+      locale == I18n.default_locale.to_s ? file_path : File.join(file_path, 'onesky_ja')
     end
 
-    def locale_files
-      Dir.glob("#{locale_dir}/*.yml")
+    def locale_files(locale)
+      Dir.glob("#{locale_dir(locale)}/*.yml")
     end
 
-    def delete_test_dir
-      if File.directory?(locale_dir)
-        File.delete(*Dir.glob("#{locale_dir}/**/*"))
-        Dir.delete(locale_dir)
-      end
+    def expected_locale_files(locale)
+      ["#{locale_dir(locale)}/#{locale}.yml", "#{locale_dir(locale)}/special_#{locale}.yml"]
     end
 
-    before(:each) do
-      delete_test_dir
+    it 'download translations from OneSky and save as YAML files' do
+      locale = 'ja'
+      prepare_download_requests!(locale)
+
+      expect(locale_files(locale)).to be_empty
+      client.download(file_path)
+      expect(locale_files(locale)).to match_array(expected_locale_files(locale))
     end
 
-    after(:each) do
-      delete_test_dir
+    it 'download translations of base language from OneSky' do
+      locale = 'en'
+      prepare_download_requests!(locale)
+
+      client.download(file_path, base_only: true)
+
+      # test files created
+      expected_files = expected_locale_files(locale)
+      expect(locale_files(locale)).to match_array(expected_files)
+
+      # test file content
+      content = YAML.load_file(expected_files.pop)
+      expected_content = YAML.load_file(File.join(sample_file_path, locale, 'special_en.yml'))
+      expect(content).to eq(expected_content)
     end
 
-    it 'download translations from OneSky and save as YAML files' do
-      prepare_download_requests!
+    it 'download all translations including base language from OneSky' do
+      locales = ['en', 'ja']
+      locales.each { |locale| prepare_download_requests!(locale) }
 
-      expect(locale_files).to be_empty
-      client.download(file_path)
-      expect(locale_files).to match_array(expected_locale_files)
+      client.download(file_path, all: true)
+
+      locales.each do |locale|
+        # test files created
+        expected_files = expected_locale_files(locale)
+        expect(locale_files(locale)).to match_array(expected_files)
+
+        # test file content
+        content = YAML.load_file(expected_files.pop)
+        expected_content = YAML.load_file(File.join(sample_file_path, locale, "special_#{locale}.yml"))
+        expect(content).to eq(expected_content)
+      end
     end
 
-    def prepare_download_requests!
+    def prepare_download_requests!(locale)
       Timecop.freeze
       file_names.each do |file_name|
+        downloaded_file_name = file_name.sub(/en/, locale)
         response_headers = {
           'Content-Type'        => 'text/plain',
-          'Content-Disposition' => "attachment; filename=#{file_name}",
+          'Content-Disposition' => "attachment; filename=#{downloaded_file_name}",
         }
-        query_string = "&source_file_name=#{file_name}&locale=ja"
+        query_string = "&source_file_name=#{file_name}&locale=#{locale}"
         stub_request(:get, full_path_with_auth_hash("/projects/#{config_hash['project_id']}/translations", config_hash['api_key'], config_hash['api_secret']) + query_string)
           .to_return(
             status: 200,
-            body: File.read(File.join(file_path, file_name)),
+            body: File.read(File.join(sample_file_path, locale, downloaded_file_name)),
             headers: response_headers)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onesky-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Victor Lam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -133,10 +133,12 @@ files:
 - lib/onesky/rails/version.rb
 - lib/tasks/onesky.rake
 - onesky-rails.gemspec
-- spec/fixtures/locales/en.json
-- spec/fixtures/locales/en.yml
-- spec/fixtures/locales/ja.yml
-- spec/fixtures/locales/special_en.yml
+- spec/fixtures/sample_files/en/en.yml
+- spec/fixtures/sample_files/en/special_en.yml
+- spec/fixtures/sample_files/ja/ja.yml
+- spec/fixtures/sample_files/ja/special_ja.yml
+- spec/fixtures/sample_files/original/en.yml
+- spec/fixtures/sample_files/original/special_en.yml
 - spec/onesky/rails/client_spec.rb
 - spec/onesky/rails/file_client_spec.rb
 - spec/spec_helper.rb
@@ -165,10 +167,12 @@ signing_key:
 specification_version: 4
 summary: Rails plugin to sync string files with OneSky
 test_files:
-- spec/fixtures/locales/en.json
-- spec/fixtures/locales/en.yml
-- spec/fixtures/locales/ja.yml
-- spec/fixtures/locales/special_en.yml
+- spec/fixtures/sample_files/en/en.yml
+- spec/fixtures/sample_files/en/special_en.yml
+- spec/fixtures/sample_files/ja/ja.yml
+- spec/fixtures/sample_files/ja/special_ja.yml
+- spec/fixtures/sample_files/original/en.yml
+- spec/fixtures/sample_files/original/special_en.yml
 - spec/onesky/rails/client_spec.rb
 - spec/onesky/rails/file_client_spec.rb
 - spec/spec_helper.rb

data/spec/fixtures/locales/en.json

@@ -1,13 +0,0 @@
-{
-  "en": {
-    "week": {
-      "sun": "Sunday",
-      "mon": "Monday",
-      "tue": "Tuesday",
-      "wed": "Wednesday",
-      "thu": "Thursday",
-      "fri": "Friday",
-      "sat": "Saturday"
-    }
-  }
-}