bisu 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26ffcf701edd984c84baed76e830e65220823f1d
-  data.tar.gz: 6dbe37c9b9843a5ba581ffafe6fc1462e12e8296
+  metadata.gz: bed28be32f24a03d0e812b3ad88980911bd4d13a
+  data.tar.gz: 13f1165c2bf416965c75e24553f5f2672a91f1ec
 SHA512:
-  metadata.gz: 2ce5fd404b32dade76d949895228f6f4d42936c74bfd94f3a728af616348bb8bb372cba87c25a225b1b49a25c2d93f1829375e90072def75337b3897b4e91ec2
-  data.tar.gz: 1dae210c8331482902d0f680198ef5a0f0d84e5ec2e7f108c396a16567a1dfca8176e39814472c0e0e23fa8621cd5912d30f8f60085569e97b920d02b68b3923
+  metadata.gz: 2e4ebf64ac0b36be4fa1f058347a7029a676986289a216120bc22f680c9bbcdca545660017f2da39a2a6a05f822c3cf110820ce579d8c20f149fb16257e3adc3
+  data.tar.gz: fb3ce272578ae914ca44b785a456dec185c87435a0abba11c1debb328e2dec1909bdf2d2648b40dda9b0030d63283b28120d16ac22db95f3b2347c84e3da181f

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 All notable changes to this project will be documented in this file.
 `Bisu` adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.7.0](https://github.com/hole19/bisu/releases/tag/v1.7.0)
+Released on 2019/02/18
+
+#### Added
+- Adds support for a dictionary source from generic URL
+
+## [1.6.0](https://github.com/hole19/bisu/releases/tag/v1.6.0)
+Released on 2019/02/18
+
+#### Added
+- Merges changes from [Onfido's fork](https://github.com/onfido/bisu)
+  - Removes the restriction for keys to start with k
+  - Adds a strict mode to fail if there's any warning
+
 ## [1.5.0](https://github.com/hole19/bisu/releases/tag/v1.5.0)
 Released on 2019/01/19
 

data/README.md

@@ -50,6 +50,13 @@ Configuration
       language: pt
   ```
 
+  Also available generic URL source:
+  ```
+  dictionary:
+    type: url
+    url: <A-GET-URL>
+  ```
+
   Also available [OneSky](https://www.oneskyapp.com) integration:
   ```
   dictionary:

data/generic.translatable.yml

@@ -1,27 +1,22 @@
 # supported types are iOS/Android/RoR
 type: iOS
 
-sheet_id: knownledge-base-sheet-id
-keys_column: column-with-translation-keys
+dictionary:
+  type: google_sheet
+  sheet_id: <GOOGLE-DRIVE-SHEET-ID>
+  keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
 
-in:
-  - path/to/file/to/1.ext.translatable
-  - path/to/file/to/2.ext.translatable
-  - path/to/file/to/3.ext.translatable
+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
 
-# you may define a generic out_path common for all files
-# or a more specific one in out:path
-#
-# when generating the out path you can use two variables:
-# - locale:   replaced by the out:locale
-# - out_name: replaced by the input file name without .translatable
-
-out_path: path/to/final-%{locale}/%{out_name}
-out:
-  - locale: en
-    kb_language: english
-    path: path/to/default/%{out_name}
-  - locale: pt
-    kb_language: portuguese
-  - locale: pt-PT
-    kb_language: portuguese
+languages:
+  - locale:   en
+    language: en
+  - locale:   en-US
+    language: en
+  - locale:   pt
+    language: pt

data/lib/bisu.rb

@@ -7,6 +7,7 @@ require 'bisu/object_extension'
 require 'bisu/config'
 require 'bisu/source/google_sheet'
 require 'bisu/source/one_sky'
+require 'bisu/source/url'
 require 'bisu/dictionary'
 require 'bisu/localizer'
 require 'bisu/version'
@@ -59,6 +60,8 @@ module Bisu
         Bisu::Source::GoogleSheet.new(config[:sheet_id], config[:keys_column])
       when "one_sky"
         Bisu::Source::OneSky.new(config[:api_key], config[:api_secret], config[:project_id], config[:file_name])
+      when "url"
+        Bisu::Source::Url.new(config[:url])
       end
 
     source = source.to_i18

data/lib/bisu/config.rb

@@ -75,9 +75,17 @@ module Bisu
       }
     }
 
+    URL_STRUCT = {
+      type: Hash,
+      elements: {
+        url: { type: String }
+      }
+    }
+
     DICTIONARY_STRUCT = {
       "google_sheet" => GOOGLE_SHEET_STRUCT,
-      "one_sky"      => ONE_SKY_STRUCT
+      "one_sky"      => ONE_SKY_STRUCT,
+      "url"          => URL_STRUCT
     }
   end
 end

data/lib/bisu/localizer.rb

@@ -26,11 +26,15 @@ module Bisu
               Logger.error("Parameter #{param} not found in translation for #{l[:key]} in #{language}")
             end
           end
-          t = t.gsub(l[:match], process(localized))
+
+          unless t.gsub!(l[:match], process(localized))
+            Logger.warn("Could not find translation for #{l[:match]} in #{language}")
+          end
+        else
+          Logger.warn("Could not find translation for #{l[:match]} in #{language}")
         end
       end
 
-      t.scan(/\$([^\$\{]+)(?:\{(.+)\})?\$/) { |match| Logger.warn("Could not find translation for #{match[0]} in #{language}") }
       unless @type.eql?(:ror)
         t.scan(/%{[^}]+}/) { |match| Logger.error("Could not find translation param for #{match} in #{language}") }
       end

data/lib/bisu/source/google_sheet.rb

@@ -19,7 +19,7 @@ module Bisu
         kb = {}
         raw["entry"].each do |entry|
           unless (key = entry[@key_column]) && key = key.first
-            raise "Cannot find key column '#{@key_column}'"
+            raise "Bisu::Source::GoogleSheet: Cannot find key column '#{@key_column}'"
           end
 
           entry.select { |c| !non_language_columns.include?(c) }.each do |lang, texts|
@@ -44,13 +44,13 @@ module Bisu
         data = http.get(uri.path, headers)
 
         unless data.code.to_i == 200
-          raise "Cannot access sheet at #{uri} - HTTP #{data.code}"
+          raise "Bisu::Source::GoogleSheet: Cannot access sheet at #{uri} - HTTP #{data.code}"
         end
 
         begin
           XmlSimple.xml_in(data.body, 'KeyAttr' => 'name')
         rescue
-          raise "Cannot parse. Expected XML at #{uri}"
+          raise "Bisu::Source::GoogleSheet: Cannot parse. Expected XML at #{uri}"
         end
       end
 

data/lib/bisu/source/one_sky.rb

@@ -47,7 +47,7 @@ module Bisu
         request = Net::HTTP::Get.new(uri.request_uri)
         response = http.request(request)
 
-        raise "OneSky: Http Error #{JSON.parse(response.body)}" if response.code.to_i >= 400
+        raise "Bisu::Source::OneSky: Http Error #{JSON.parse(response.body)}" if response.code.to_i >= 400
 
         response.body
       end

data/lib/bisu/source/url.rb

@@ -0,0 +1,40 @@
+require 'net/https'
+require 'json'
+
+module Bisu
+  module Source
+    class Url
+      def initialize(url)
+        @url = url
+      end
+
+      def to_i18
+        Logger.info("Downloading dictionary from #{@url}...")
+
+        file = get(@url)
+        hash = JSON.parse(file)
+
+        Logger.info("Found #{hash.count} languages.")
+
+        hash
+      end
+
+      private
+
+      def get(url)
+        uri = URI(url)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(request)
+
+        raise "Bisu::Source::Url: Http Error #{response.body}" if response.code.to_i >= 400
+
+        response.body
+      end
+    end
+  end
+end

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
   VERSION_UPDATED_AT = '2019-02-18'
 end

data/spec/fixtures/sample_json_response.json

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

data/spec/lib/bisu/config_spec.rb

@@ -53,6 +53,17 @@ describe Bisu::Config do
       it { should eq({ type: "one_sky", api_key: "as387oavh48", api_secret: "bp0s5avo8a59", project_id: 328742, file_name: "file.json" }) }
     end
 
+    context "when given a Url type dictionary" do
+      before do
+        hash[:dictionary] = {
+          type: "url",
+          url:  "a_url"
+        }
+      end
+
+      it { should eq({ type: "url", url: "a_url" }) }
+    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 }

data/spec/lib/bisu/{one_sky_spec.rb → source/one_sky_spec.rb}

@@ -6,7 +6,7 @@ describe Bisu::Source::OneSky do
   let(:project_id) { 98765 }
   let(:file_name)  { "file456.json" }
 
-  let(:os_response) { File.read("spec/fixtures/sample_one_sky_response.txt") }
+  let(:os_response) { File.read("spec/fixtures/sample_one_sky_response.json") }
 
   def stub_multilingual(status:, response:)
     stub_request(:get, "https://platform.api.onesky.io/1/projects/#{project_id}/translations/multilingual").
@@ -37,7 +37,7 @@ describe Bisu::Source::OneSky do
   end
 
   context "when OneSky returns the newline bug" do
-    let(:os_response) { File.read("spec/fixtures/sample_one_sky_response_with_bug.txt") }
+    let(:os_response) { File.read("spec/fixtures/sample_one_sky_response_with_bug.json") }
 
     it { expect { to_i18 }.not_to raise_error }
 

data/spec/lib/bisu/source/url_spec.rb

@@ -0,0 +1,33 @@
+describe Bisu::Source::Url do
+  subject(:to_i18) { Bisu::Source::Url.new(url).to_i18 }
+
+  let(:url) { "https://in17n-08c12b370aeb6c66.herokuapp.com/documents/1/json?api_key=0320cd5d-1a51-4785-a832-a5bed8e62ed6" }
+  let(:os_response) { File.read("spec/fixtures/sample_json_response.json") }
+
+  def stub_url(status:, response:)
+    stub_request(:get, url).
+      to_return(:status => status, :body => response, :headers => {})
+  end
+
+  before { stub_url(status: 200, response: os_response) }
+
+  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 get request to that URL raises an error" do
+    before { stub_url(status: 400, response: { error: "ups... not allowed!" }.to_json) }
+
+    it "raises that same error" do
+      expect { to_i18 }.to raise_error /not allowed/
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - joaoffcosta
@@ -92,19 +92,22 @@ files:
 - lib/bisu/object_extension.rb
 - lib/bisu/source/google_sheet.rb
 - lib/bisu/source/one_sky.rb
+- lib/bisu/source/url.rb
 - lib/bisu/version.rb
 - spec/fixtures/sample.translatable.yml
+- spec/fixtures/sample_json_response.json
 - spec/fixtures/sample_kb_public_info.html
 - spec/fixtures/sample_kb_public_sheet.html
-- spec/fixtures/sample_one_sky_response.txt
-- spec/fixtures/sample_one_sky_response_with_bug.txt
+- spec/fixtures/sample_one_sky_response.json
+- spec/fixtures/sample_one_sky_response_with_bug.json
 - 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/source/google_sheet_spec.rb
+- spec/lib/bisu/source/one_sky_spec.rb
+- spec/lib/bisu/source/url_spec.rb
 - spec/lib/bisu_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/hole19/bisu