bisu 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae037a0d6145c6c2517b9ada533931cce6fbb028
-  data.tar.gz: bb08d97f16d8a1fe65a8eced03d785961e7369d2
+  metadata.gz: 352d33d3ac9d54082135084e8cd3e03a6ace04d5
+  data.tar.gz: 3f07ec0e51bde13656405514a72aedefd63f9f65
 SHA512:
-  metadata.gz: 3bf229024552eb4081d51aeaeffcb014c2f2787e8592eb166a5d2aa04fc980fa9789c605b4f796c1be68d6a56b5763a2b9662b8480c2ac472dd3e66fe3135254
-  data.tar.gz: 3b2fdc69cade70b5a7d6d14e615dd129e8296adb2ab57b7ba82ca57fd17d9e0cf858391f84af839694b9cbed354284cdd5c7a8c29782d5c0ce7fd1f2e166646d
+  metadata.gz: 3126fa41a9805d8b1fb028e73c2ac4674ea73e981c5808b2cfc28324b31546f6ada14436294941fbf8278148f4987b32afe5dd0a3d2d1138fe3d8923aa6a9a12
+  data.tar.gz: 5f76fd4c33ac8dea50f8c5a9b5472d09f7ad245897b749af15a2c0327df603b04167739ae78244c15d750a33362561ce6c89e8d607048fc69dc48f3ac81b5e88

data/Gemfile

@@ -4,6 +4,7 @@ ruby '2.3.1'
 gem 'safe_yaml',  '~> 1.0'
 gem 'colorize',   '~> 0.7'
 gem 'xml-simple', '~> 1.1'
+gem 'onesky-ruby'
 
 gem 'webmock',    '~> 1.20'
 gem 'rspec'

data/Gemfile.lock

@@ -6,7 +6,19 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
+    domain_name (0.5.20161021)
+      unf (>= 0.0.5, < 1.0.0)
     hashdiff (0.3.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (2.99.3)
+    netrc (0.11.0)
+    onesky-ruby (1.0.1)
+      rest-client (~> 1.8)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -24,6 +36,9 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
     webmock (1.24.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -35,6 +50,7 @@ PLATFORMS
 
 DEPENDENCIES
   colorize (~> 0.7)
+  onesky-ruby
   rspec
   rspec-its
   safe_yaml (~> 1.0)

data/README.md

@@ -1,13 +1,13 @@
 Bisu 홀
 ========
 
-Bisu manages your app iOS and Android localization files for you. No more copy+paste induced errors!
+Bisu manages your app iOS, Android and RoR localization files for you. No more copy+paste induced errors!
 
 ---
 
 Instalation
 -----
-  
+
 ```
 gem install bisu
 ```
@@ -24,25 +24,40 @@ Usage
 Configuration
 -----
 
-1. Create in your **iOS/Android** app project base folder a translatable.yml:
+1. Create in your project base folder a translatable.yml:
 
   ```
-  type: <iOS/Android/RoR>
-  
-  sheet_id: <GOOGLE-DRIVE-SHEET-ID>
-  keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
-  
-  in:
-    - path/to/1st/file.translatable
-    - path/to/2nd/file.translatable
-  
-  out_path: path/to/%{locale}.lproj/%{out_name}
-  out:
+  type: <iOS|Android|RoR>
+
+  dictionary:
+    type: google_sheet
+    sheet_id: <GOOGLE-DRIVE-SHEET-ID>
+    keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
+
+  translate:
+    - in: path/to/1st/file.translatable
+      out: path/to/%{locale}/strings.xml
+      out_en: path/to/default/strings.xml
+    - in: path/to/2nd/file.translatable
+      out: path/to/2nd-%{locale}/strings.xml
+
+  languages:
     - locale:   en
-      language: english
-      path:     default_path/%{out_name}
-    - locale:   ko
-      language: korean
+      language: en
+    - locale:   en-US
+      language: en
+    - locale:   pt
+      language: pt
+  ```
+
+  Also available [OneSky](https://www.oneskyapp.com) integration:
+  ```
+  dictionary:
+    type: one_sky
+    api_key: <ONE-SKY-API-KEY>
+    api_secret: <ONE-SKY-API-SECRET>
+    project_id: <ONE-SKY-PROJECT-ID>
+    file_name: <ONE-SKY-FILE-NAME>
   ```
 
 1. Create a \*.translatable version for your **iOS** localization files:
@@ -50,13 +65,13 @@ Configuration
   ```
   // $specialKComment1$
   // $specialKComment2$
-  
+
   // Locale: $specialKLocale$; Language used: $specialKLanguage$
-  
+
   /***********
   *  General
   ************/
-  
+
   "klGeneral_Delete" = "$kDelete$";
   "klGeneral_Cancel" = "$kCancel$";
   "klGeneral_Close"  = "$kClose$";
@@ -67,11 +82,11 @@ Configuration
 
   ```
   <?xml version="1.0" encoding="utf-8"?>
-  
+
   <!-- $specialKComment1$ -->
   <!-- $specialKComment2$ -->
   <!-- Locale: $specialKLocale$; Language used: $specialKLanguage$ -->
-  
+
   <resources>
       <string name="delete">$kDelete$</string>
       <string name="cancel">$kCancel$</string>
@@ -79,7 +94,7 @@ Configuration
       <string name="request_name">$kRequestName%{user_name: %s}$</string>
   </resources>
   ```
-  
+
 1. Create a \*.translatable version for your **RoR** localization files:
 
   ```

data/lib/bisu/config.rb

@@ -2,7 +2,13 @@ module Bisu
   class Config
     def initialize(hash:)
       @hash = hash.deep_symbolize
-      @hash.validate_structure!(EXPECTED_HASH)
+      @hash.validate_structure!(CONFIG_STRUCT)
+
+      unless dict_struct = DICTIONARY_STRUCT[@hash[:dictionary][:type]]
+        raise ArgumentError.new("unknown dictionary type '#{@hash[:dictionary][:type]}'")
+      end
+
+      @hash[:dictionary].validate_structure!(dict_struct)
     end
 
     def to_h
@@ -28,13 +34,12 @@ module Bisu
 
     private
 
-    EXPECTED_HASH = {
+    CONFIG_STRUCT = {
       type: Hash,
       elements: {
         type: { type: String },
         dictionary: { type: Hash, elements: {
-          sheet_id: { type: String },
-          keys_column: { type: String }
+          type: { type: String }
         } },
         translate: { type: Array, elements: {
           type: Hash, elements: {
@@ -50,5 +55,29 @@ module Bisu
         } }
       }
     }
+
+    GOOGLE_SHEET_STRUCT = {
+      type: Hash,
+      elements: {
+        type: { type: String },
+        sheet_id: { type: String },
+        keys_column: { type: String }
+      }
+    }
+
+    ONE_SKY_STRUCT = {
+      type: Hash,
+      elements: {
+        api_key: { type: String },
+        api_secret: { type: String },
+        project_id: { type: Integer },
+        file_name: { type: String }
+      }
+    }
+
+    DICTIONARY_STRUCT = {
+      "google_sheet" => GOOGLE_SHEET_STRUCT,
+      "one_sky"      => ONE_SKY_STRUCT
+    }
   end
 end

data/lib/bisu/google_sheet.rb

@@ -3,15 +3,15 @@ require "xmlsimple"
 
 module Bisu
   class GoogleSheet
-    def initialize(sheet_id, keys_column_title)
+    def initialize(sheet_id, keys_column)
       @sheet_id = sheet_id
-      @key_column = keys_column_title
+      @key_column = keys_column
     end
 
     def to_i18
       raw = raw_data(@sheet_id)
 
-      Logger.info("Parsing Google Sheet...")
+      Logger.info("Downloading dictionary from Google Sheet...")
 
       non_language_columns = ["id", "updated", "category", "title", "content", "link", @key_column]
 
@@ -28,7 +28,7 @@ module Bisu
       end
 
       Logger.info("Google Sheet parsed successfully!")
-      Logger.info("Found #{kb.count} keys in #{kb.values.first.keys.count} languages.")
+      Logger.info("Found #{kb.count} languages.")
 
       kb
     end

data/lib/bisu/one_sky.rb

@@ -0,0 +1,31 @@
+require 'onesky'
+
+module Bisu
+  class OneSky
+    def initialize(api_key, api_secret, project_id, file_name)
+      @client     = Onesky::Client.new(api_key, api_secret)
+      @project_id = project_id
+      @file_name  = file_name
+    end
+
+    def to_i18
+      Logger.info("Downloading dictionary from OneSky...")
+
+      proj = @client.project(@project_id)
+      file = proj.export_multilingual(source_file_name: @file_name, file_format: "I18NEXT_MULTILINGUAL_JSON")
+
+      hash = JSON.parse(file)
+      hash.each do |lang, v|
+        hash[lang] = v["translation"]
+        hash[lang].each do |key, text|
+          hash[lang][key] = hash[lang][key].join("\n") if hash[lang][key].is_a? Array
+        end
+      end
+
+      Logger.info("OneSky response parsed successfully!")
+      Logger.info("Found #{hash.count} languages.")
+
+      hash
+    end
+  end
+end

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.3.1'
-  VERSION_UPDATED_AT = '2016-11-15'
+  VERSION = '1.4.0'
+  VERSION_UPDATED_AT = '2016-11-18'
 end

data/lib/bisu.rb

@@ -5,6 +5,7 @@ require 'bisu/logger'
 require 'bisu/object_extension'
 require 'bisu/config'
 require 'bisu/google_sheet'
+require 'bisu/one_sky'
 require 'bisu/dictionary'
 require 'bisu/localizer'
 require 'bisu/version'
@@ -17,8 +18,7 @@ module Bisu
 
     if config_file = open_file("translatable.yml", "r", true)
       config       = Bisu::Config.new(hash: YAML::load(config_file))
-      google_sheet = Bisu::GoogleSheet.new(config.dictionary[:sheet_id], config.dictionary[:keys_column])
-      dictionary   = Bisu::Dictionary.new(google_sheet.to_i18)
+      dictionary   = dictionary_for(config: config.dictionary, save_to_path: options[:dictionary_save_path])
       localizer    = Bisu::Localizer.new(dictionary, config.type)
 
       config.localize_files do |in_path, out_path, language, locale|
@@ -36,6 +36,26 @@ module Bisu
 
   private
 
+  def dictionary_for(config:, save_to_path:)
+    source =
+      case config[:type]
+      when "google_sheet"
+        Bisu::GoogleSheet.new(config[:sheet_id], config[:keys_column])
+      when "one_sky"
+        Bisu::OneSky.new(config[:api_key], config[:api_secret], config[:project_id], config[:file_name])
+      end
+
+    source = source.to_i18
+
+    if save_to_path && file = open_file(save_to_path, "w", false)
+      file.write(source.to_json)
+      file.flush
+      file.close
+    end
+
+    Bisu::Dictionary.new(source)
+  end
+
   def command_line_options(options)
     opts_hash = {}
 
@@ -44,6 +64,10 @@ module Bisu
         opts_hash[:default_language] = language
       end
 
+      opts.on("--save-dictionary PATH", "Save downloaded dictionary locally at given path") do |path|
+        opts_hash[:dictionary_save_path] = path
+      end
+
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
         exit

data/spec/fixtures/sample.translatable.yml

@@ -1,6 +1,7 @@
 type: iOS
 
 dictionary:
+  type: google_sheet
   sheet_id: sheet-id
   keys_column: keys-column
 

data/spec/fixtures/sample_one_sky_response.txt

@@ -0,0 +1,29 @@
+{
+    "en": {
+        "translation": {
+            "kConnectFacebook": "Connect with Facebook",
+            "kNoNoNoMr": "No, no, no. Mr %{name} not here"
+        }
+    },
+    "ja": {
+        "translation": {
+            "kConnectFacebook": "\u30d5\u30a7\u30a4\u30b9\u30d6\u30c3\u30af\u3078\u63a5\u7d9a"
+        }
+    },
+    "fr": {
+        "translation": {
+            "kConnectFacebook": "Connexion par Facebook"
+        }
+    },
+    "de": {
+        "translation": {
+            "kConnectFacebook": "Mit Facebook verbinden"
+        }
+    },
+    "ko": {
+        "translation": {
+            "kConnectFacebook": "\ud398\uc774\uc2a4\ubd81\uc73c\ub85c \uc811\uc18d",
+            "kTwitterServer": ["트위터 서버연결 실패. ", "잠시 후 재시도."]
+        }
+    }
+}

data/spec/lib/bisu/config_spec.rb

@@ -4,8 +4,9 @@ describe Bisu::Config do
   let(:hash) { {
     type: "BisuOS",
     dictionary: {
-      sheet_id:    "abc1234567890",
-      keys_column: "key_name"
+      type:         "google_sheet",
+      sheet_id:     "abc1234567890",
+      keys_column:  "key_name"
     },
     translate: [
       { in:        "path/to/file/to/1.ext.translatable",
@@ -30,9 +31,33 @@ describe Bisu::Config do
     it { expect { config }.to raise_error /missing keys/i }
   end
 
-  its(:to_h)       { should eq(hash) }
-  its(:type)       { should eq("BisuOS") }
-  its(:dictionary) { should eq({ sheet_id: "abc1234567890", keys_column: "key_name" }) }
+  its(:to_h) { should eq(hash) }
+  its(:type) { should eq("BisuOS") }
+
+  describe "#dictionary" do
+    subject(:dictionary) { config.dictionary }
+
+    it { should eq({ type: "google_sheet", sheet_id: "abc1234567890", keys_column: "key_name" }) }
+
+    context "when given a OneSky type dictionary" do
+      before do
+        hash[:dictionary] = {
+          type:       "one_sky",
+          api_key:    "as387oavh48",
+          api_secret: "bp0s5avo8a59",
+          project_id: 328742,
+          file_name:  "file.json"
+        }
+      end
+
+      it { should eq({ type: "one_sky", api_key: "as387oavh48", api_secret: "bp0s5avo8a59", project_id: 328742, file_name: "file.json" }) }
+    end
+
+    context "when given an unknown type dictionary" do
+      before { hash[:dictionary] = { type: "i_dunno" } }
+      it { expect { config }.to raise_error /unknown dictionary type 'i_dunno'/i }
+    end
+  end
 
   describe "#localize_files" do
     it "yields 5 times with the expected arguments" do

data/spec/lib/bisu/one_sky_spec.rb

@@ -0,0 +1,36 @@
+describe Bisu::OneSky do
+  subject(:to_i18) { Bisu::OneSky.new(api_key, api_secret, project_id, file_name).to_i18 }
+
+  let(:api_key)    { "a123" }
+  let(:api_secret) { "b123" }
+  let(:project_id) { 98765 }
+  let(:file_name)  { "file456.json" }
+
+  let(:os_response) { File.read("spec/fixtures/sample_one_sky_response.txt") }
+
+  before do
+    project = double("OSProject")
+    allow_any_instance_of(Onesky::Client).to receive(:project).with(project_id).and_return(project)
+    allow(project).to receive(:export_multilingual).with(source_file_name: file_name, file_format: "I18NEXT_MULTILINGUAL_JSON").and_return(os_response)
+  end
+
+  it { expect { to_i18 }.not_to raise_error }
+
+  it "returns an hash in i18 format" do
+    expect(to_i18).to eq({
+      "en" => { "kConnectFacebook" => "Connect with Facebook", "kNoNoNoMr" => "No, no, no. Mr %{name} not here" },
+      "ja" => { "kConnectFacebook" => "フェイスブックへ接続" },
+      "fr" => { "kConnectFacebook" => "Connexion par Facebook" },
+      "de" => { "kConnectFacebook" => "Mit Facebook verbinden" },
+      "ko" => { "kConnectFacebook" => "페이스북으로 접속", "kTwitterServer" => "트위터 서버연결 실패. \n잠시 후 재시도." }
+    })
+  end
+
+  context "when OneSky raises an error" do
+    before { allow_any_instance_of(Onesky::Client).to receive(:project).and_raise("ups... not allowed!") }
+
+    it "raises that same error" do
+      expect { to_i18 }.to raise_error /not allowed/
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -90,16 +90,19 @@ files:
 - lib/bisu/localizer.rb
 - lib/bisu/logger.rb
 - lib/bisu/object_extension.rb
+- lib/bisu/one_sky.rb
 - lib/bisu/version.rb
 - spec/fixtures/sample.translatable.yml
 - spec/fixtures/sample_kb_public_info.html
 - spec/fixtures/sample_kb_public_sheet.html
+- spec/fixtures/sample_one_sky_response.txt
 - spec/lib/bisu/config_spec.rb
 - spec/lib/bisu/dictionary_spec.rb
 - spec/lib/bisu/google_sheet_spec.rb
 - spec/lib/bisu/localizer_spec.rb
 - spec/lib/bisu/logger_spec.rb
 - spec/lib/bisu/object_extension_spec.rb
+- spec/lib/bisu/one_sky_spec.rb
 - spec/lib/bisu_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/hole19/bisu