bisu 1.10.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41fa600d8b33846f4a860595f47093d7105a79f7690968c4b3d0428fec0936ea
-  data.tar.gz: 2f4fed77d3e7b4688c8c0dd77dff43f96c32f0e52f2ebde3343115c0f25249cb
+  metadata.gz: 668059c0670a554d5a7ab95f88ab90133a0d367eaa7e08bba2c2c5a9d5ed36cb
+  data.tar.gz: fb276b9ef26e4941fb3264a366fbe9cc8404d0c296441afe5b294df652444e6d
 SHA512:
-  metadata.gz: f3ea51eff598f91be9dfdcc43fc14e858e56839c956949d38777bbf551fea15021caa25264d4f9c70ca7e8086c8beb976cd9249a8efdf2fba4c2d1572558ba34
-  data.tar.gz: f27e7c904060eb9ae83807b8c4028db4e7cfbfecd963bb3ff5d4af30d417ce8a820b9ff99eceb58d972916b0ee948f81e1a31e9f001739c3e06108ca3aa9f4c9
+  metadata.gz: 2250bd0fd198197e78a399be3c519c97ef0700564932feb4de4821573cf5a886fd056d5992180f9d18691145dbc55a9bbffc4bfc44993d1e9d34643954c2b529
+  data.tar.gz: 81e01705e4a8a3e4144b2d64f11d6f04c60d0a75fc50d05b1781b43cfb15f87351c3dab66092ae0b51507760046677efee7bc67c2f9cd7087823884a802318aa

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 All notable changes to this project will be documented in this file.
 `Bisu` adheres to [Semantic Versioning](http://semver.org/).
 
+## Unreleased
+
+
+
+## [2.0.0](https://github.com/hole19/bisu/releases/tag/v2.0.0)
+Released on 2023/12/07
+
+### Added
+- Add [Tolgee](https://tolgee.io/) as a source.
+
+### Maintenance
+- Upgrade to ruby 3.2
+
+## [1.10.2](https://github.com/hole19/bisu/releases/tag/v1.10.2)
+Released on 2021/08/30
+
+#### Fixed
+- Fixes bug where we were assuming "key" would always be the translations-key column title
+
+## [1.10.1](https://github.com/hole19/bisu/releases/tag/v1.10.1)
+Released on 2021/08/30
+
+#### Fixed
+- Crash caused by an unexpected redirect
+
 ## [1.10.0](https://github.com/hole19/bisu/releases/tag/v1.10.0)
 Released on 2021/08/30
 

data/Gemfile

@@ -1,12 +1,10 @@
 source 'https://rubygems.org'
-ruby '2.7.3'
 
-gem 'safe_yaml',  '~> 1.0'
-gem 'colorize',   '~> 0.7'
+gemspec
 
 group :test do
   gem 'rake'
-  gem 'webmock',    '~> 1.20'
+  gem 'webmock', '~> 3'
   gem 'rspec'
   gem 'rspec-its'
 end

data/Gemfile.lock

@@ -1,51 +1,56 @@
+PATH
+  remote: .
+  specs:
+    bisu (1.10.2)
+      colorize
+      rubyzip (>= 2.0.0)
+      safe_yaml (>= 1.0.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    colorize (0.8.1)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorize (1.1.0)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     hashdiff (1.0.1)
-    public_suffix (4.0.6)
-    rake (13.0.3)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    public_suffix (5.0.3)
+    rake (13.1.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
+      rspec-support (~> 3.12.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubyzip (2.3.2)
     safe_yaml (1.0.5)
-    webmock (1.24.6)
-      addressable (>= 2.3.6)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  colorize (~> 0.7)
+  bisu!
   rake
   rspec
   rspec-its
-  safe_yaml (~> 1.0)
-  webmock (~> 1.20)
-
-RUBY VERSION
-   ruby 2.7.3p183
+  webmock (~> 3)
 
 BUNDLED WITH
-   2.2.26
+   2.4.22

data/README.md

@@ -4,13 +4,19 @@ Bisu 홀
 [![Status](https://travis-ci.org/hole19/bisu.svg?branch=master)](https://travis-ci.org/hole19/bisu?branch=master)
 [![Gem](https://img.shields.io/gem/v/bisu.svg?style=flat)](http://rubygems.org/gems/bisu "View this project in Rubygems")
 
-Bisu manages your app iOS, Android and RoR localization files for you. No more copy+paste induced errors!
+Bisu manages your app [iOS](#ios), [Android](#android) and [RoR](#ruby-on-rails) localization files for you. No more copy+paste induced errors!
+
+It works with the following sources out of the box:
+- [URL](#url)
+- [Tolgee](#tolgee)
+- [Google Sheets](#google-sheets)
+- [OneSky](#onesky)
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/hole19/bisu/master/README_explanation.png" width="500">
 </p>
 
-Instalation
+Installation
 -----
 
 ```
@@ -54,7 +60,9 @@ Setup your configuration file
       language: pt
   ```
 
-##### Dictionary from a URL source:
+#### Sources
+
+##### URL
 
   ```
   dictionary:
@@ -62,7 +70,16 @@ Setup your configuration file
     url: <A-GET-URL>
   ```
 
-##### Google Sheets Dictionary:
+##### Tolgee
+
+  ```
+  dictionary:
+    type: tolgee
+    api_key: <TOLGEE-API-KEY>
+    host: <TOLGEE-CUSTOM-HOST> (default: app.tolgee.io)
+  ```
+
+##### Google Sheets
 
 1. First ["Publish to the web"](https://www.google.com/search?q=google+sheets+publish+to+web) your Google Sheet
 1. Share only the sheet that contains the translations
@@ -74,9 +91,10 @@ Setup your configuration file
   dictionary:
     type: google_sheet
     url: <GOOGLE-DRIVE-SHEET-CSV-URL>
+    keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
   ```
 
-##### OneSky integration:
+##### OneSky
 
   ```
   dictionary:

data/bisu.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.homepage    = 'https://github.com/hole19/bisu'
 
-  s.files         = `git ls-files`.split("\n")
+  s.files = `git ls-files`.split("\n")
   s.require_paths = ['lib']
+  s.executables = %w[ bisu ]
 
-  s.executables << 'bisu'
-
-  s.add_runtime_dependency 'safe_yaml',  '~> 1.0'
-  s.add_runtime_dependency 'colorize',   '~> 0.7'
+  s.add_dependency 'safe_yaml',  '>= 1.0.0'
+  s.add_dependency 'colorize'
+  s.add_runtime_dependency 'rubyzip', '>= 2.0.0' # For extracting the Tolgee zip file
 end

data/generic.translatable.yml

@@ -4,6 +4,7 @@ type: iOS
 dictionary:
   type: google_sheet
   url: <GOOGLE-DRIVE-SHEET-CSV-URL>
+  keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
 
 translate:
   - in: path/to/1st/file.translatable

data/lib/bisu/config.rb

@@ -62,6 +62,7 @@ module Bisu
       elements: {
         type: { type: String },
         url: { type: String },
+        keys_column: { type: String },
       },
     }
 
@@ -82,10 +83,18 @@ module Bisu
       },
     }
 
+    TOLGEE_STRUCT = {
+      type: Hash,
+      elements: {
+        api_key: { type: String },
+      },
+    }
+
     DICTIONARY_STRUCT = {
       "google_sheet" => GOOGLE_SHEET_STRUCT,
       "one_sky"      => ONE_SKY_STRUCT,
-      "url"          => URL_STRUCT
+      "url"          => URL_STRUCT,
+      "tolgee"       => TOLGEE_STRUCT,
     }
   end
 end

data/lib/bisu/source/google_sheet.rb

@@ -4,8 +4,9 @@ require "csv"
 module Bisu
   module Source
     class GoogleSheet
-      def initialize(url)
+      def initialize(url, keys_column)
         @url = url
+        @keys_column = keys_column
       end
 
       def to_i18
@@ -20,7 +21,7 @@ module Bisu
 
         csv.each do |row|
           languages.each do |lang|
-            hash[lang][row["key"]] = row[lang] unless row[lang].nil?
+            hash[lang][row[@keys_column]] = row[lang] unless row[lang].nil?
           end
         end
 

data/lib/bisu/source/tolgee.rb

@@ -0,0 +1,58 @@
+require 'net/https'
+require 'json'
+require 'zip'
+
+module Bisu
+  module Source
+    class Tolgee
+      def initialize(api_key, custom_host = nil)
+        @api_key = api_key
+        @host = custom_host || "app.tolgee.io"
+      end
+
+      def to_i18
+        Logger.info("Downloading dictionary from Tolgee...")
+
+        hash = {}
+        export do |language, language_data|
+          hash[language] = language_data
+        end
+
+        Logger.info("Found #{hash.count} languages.")
+
+        hash
+      end
+
+      private
+
+      def export
+        uri = URI("https://#{@host}/v2/projects/export?format=JSON&structureDelimiter=")
+
+        request = Net::HTTP::Get.new(uri)
+        request['X-API-Key'] = @api_key
+
+        response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+
+        raise "Bisu::Source::Tolgee: Http Error #{response.body}" unless response.is_a?(Net::HTTPSuccess)
+
+        # Create a temporary directory to extract the zip file
+        temp_dir = Dir.mktmpdir
+
+        # Extract the zip archive
+        Zip::File.open_buffer(response.body) do |zip_file|
+          zip_file.each do |entry|
+            language = File.basename(entry.name, '.*') # Extract language from file name
+            language_data = JSON.parse(entry.get_input_stream.read)
+
+            yield language, language_data
+          end
+        end
+
+        # Clean up the temporary directory
+        FileUtils.remove_entry(temp_dir)
+      end
+    end
+  end
+end

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.10.1'
-  VERSION_UPDATED_AT = '2021-08-30'
+  VERSION = '2.0.0'
+  VERSION_UPDATED_AT = '2023-12-07'
 end

data/lib/bisu.rb

@@ -8,6 +8,7 @@ require 'bisu/config'
 require 'bisu/source/google_sheet'
 require 'bisu/source/one_sky'
 require 'bisu/source/url'
+require 'bisu/source/tolgee'
 require 'bisu/dictionary'
 require 'bisu/localizer'
 require 'bisu/version'
@@ -59,18 +60,20 @@ module Bisu
     source =
       case config[:type]
       when "google_sheet"
-        Bisu::Source::GoogleSheet.new(config[:url])
+        Bisu::Source::GoogleSheet.new(config[:url], 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])
+      when "tolgee"
+        Bisu::Source::Tolgee.new(config[:api_key], config[:host])
       end
 
     source = source.to_i18
 
     save_to_path = options[:dictionary_save_path]
     if save_to_path && file = open_file(save_to_path, "w", false)
-      file.write(source.to_json)
+      file.write(deep_force_encoding(source).to_json)
       file.flush
       file.close
     end
@@ -149,4 +152,15 @@ module Bisu
 
     true
   end
+
+  def deep_force_encoding(hash)
+    hash.each do |_, value|
+      case value
+      when String
+        value.force_encoding(Encoding::UTF_8)
+      when Hash
+        deep_force_encoding(value)
+      end
+    end
+  end
 end

data/spec/fixtures/sample.translatable.yml

@@ -3,6 +3,7 @@ type: iOS
 dictionary:
   type: google_sheet
   url: sheet-public-url
+  keys_column: "key name"
 
 translate:
   - in: hole19/Localizable.strings.translatable

data/spec/fixtures/sample_google_response.csv

@@ -1,4 +1,4 @@
-key,en,ja,fr,de,ko
+key name,en,ja,fr,de,ko
 kConnectFacebook,Connect with Facebook,フェイスブックへ接続,Connexion par Facebook,Mit Facebook verbinden,페이스북으로 접속
 kNoNoNoMr,"No, no, no. Mr %{name} not here",,,,
 kTwitterServer,,,,,트위터 서버연결 실패. \n잠시 후 재시도.

data/spec/lib/bisu/config_spec.rb

@@ -6,6 +6,7 @@ describe Bisu::Config do
     dictionary: {
       type: "google_sheet",
       url: "https://abc1234567890",
+      keys_column: "key name",
     },
     translate: [
       { in: "path/to/file/to/1.ext.translatable",
@@ -36,7 +37,7 @@ describe Bisu::Config do
   describe "#dictionary" do
     subject(:dictionary) { config.dictionary }
 
-    it { should eq({ type: "google_sheet", url: "https://abc1234567890" }) }
+    it { should eq({ type: "google_sheet", url: "https://abc1234567890", keys_column: "key name" }) }
 
     context "when given a OneSky type dictionary" do
       before do

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

@@ -1,5 +1,5 @@
 describe Bisu::Source::GoogleSheet do
-  subject(:to_i18) { Bisu::Source::GoogleSheet.new(url).to_i18 }
+  subject(:to_i18) { Bisu::Source::GoogleSheet.new(url, "key name").to_i18 }
 
   let(:url) { "https://docs.google.com/spreadsheets/d/e/2PACX-1vTm6yu_zfbxKizC-PvUE1HVFCsplmiyz0s0qLSIGeokA7KtS3BgtqaA79CsfYfPsXH6xzUaP8HDTcj8/pub?gid=0&single=true&output=csv" }
   let(:response) { File.read("spec/fixtures/sample_google_response.csv") }

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

@@ -0,0 +1,45 @@
+describe Bisu::Source::Tolgee do
+  subject(:to_i18) { Bisu::Source::Tolgee.new(api_key).to_i18 }
+
+  let(:api_key)    { "a123" }
+  let(:os_response) { File.read("spec/fixtures/sample_tolgee_response.zip") }
+
+  def stub_url(status:, response:, host: "app.tolgee.io")
+    stub_request(:get, "https://#{host}/v2/projects/export?format=JSON&structureDelimiter=").
+      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
+
+  context "with a custom host" do
+    let(:host) { "translations.example.com" }
+    subject(:to_i18) { Bisu::Source::Tolgee.new(api_key, host).to_i18 }
+
+    before { stub_url(status: 200, response: os_response, host: host) }
+
+    it "uses that host" do
+      to_i18
+      expect(WebMock).to have_requested(:get, "https://translations.example.com/v2/projects/export?format=JSON&structureDelimiter=")
+    end
+  end
+end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 2.0.0
 platform: ruby
 authors:
 - joaoffcosta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: Bisu manages your app iOS and Android localization files for you. No
   more copy+paste induced errors!
 email: joaostacosta@gmail.com
@@ -47,7 +61,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -66,6 +79,7 @@ files:
 - lib/bisu/object_extension.rb
 - lib/bisu/source/google_sheet.rb
 - lib/bisu/source/one_sky.rb
+- lib/bisu/source/tolgee.rb
 - lib/bisu/source/url.rb
 - lib/bisu/version.rb
 - spec/fixtures/sample.translatable.yml
@@ -73,6 +87,7 @@ files:
 - spec/fixtures/sample_json_response.json
 - spec/fixtures/sample_one_sky_response.json
 - spec/fixtures/sample_one_sky_response_with_bug.json
+- spec/fixtures/sample_tolgee_response.zip
 - spec/lib/bisu/config_spec.rb
 - spec/lib/bisu/dictionary_spec.rb
 - spec/lib/bisu/localizer_spec.rb
@@ -80,6 +95,7 @@ files:
 - spec/lib/bisu/object_extension_spec.rb
 - spec/lib/bisu/source/google_sheet_spec.rb
 - spec/lib/bisu/source/one_sky_spec.rb
+- spec/lib/bisu/source/tolgee_spec.rb
 - spec/lib/bisu/source/url_spec.rb
 - spec/lib/bisu_spec.rb
 - spec/spec_helper.rb
@@ -87,7 +103,7 @@ homepage: https://github.com/hole19/bisu
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: A localization automation service
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.7.3