bisu 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a68d1076ed50c0054f7ae7c301eb0722d54062027c5246b8065a73afe495b91a
-  data.tar.gz: 7b60f8ab4ce91a6a4b2a46339b3cc753d7a6ec22d6a7cb87ace851dd3ea18487
+  metadata.gz: e6a3bdfb1c2dedb224a6fd6e2262f30a0de2f1730ecba4bc66b6a410c67fbe15
+  data.tar.gz: 2656c1cd5c9821677d042e2e7a2bae166d27bdb6f7a7d42bf066e5f3039876fb
 SHA512:
-  metadata.gz: 4d49f5ecdc90851f79feecc6eafd089f4af9fa404f943d066102f62a389bf7217faa3e25fa75c130361d4327baf14eaf7b53191a6fdb91ad427efea4f81ee427
-  data.tar.gz: e2687094301355755ad7bd980661c0c55924eb2cb1f8ab5fbc026f45d8cf1a7b836becc840446538de777756c196bdaa240b600696f2158bb852fadbe57b7ec5
+  metadata.gz: 56770e1d056f6e098a27162c42d27abbed2c2fc3ae43a7d35f1af395ace7d23226311cd2f3a112187aa826e2ae383d13a6ff55b9bd2011c79fe95b96e7901351
+  data.tar.gz: 96438b25f69ec81dfa1b96a24fc2cdc5e085c72c4d956ec46921758e587706ade8d8909d626ed840605a7e0deb2ec6cb8c73fb42a2d989105688c8919e6d2dc1

data/CHANGELOG.md

@@ -2,7 +2,13 @@
 All notable changes to this project will be documented in this file.
 `Bisu` adheres to [Semantic Versioning](http://semver.org/).
 
-## Unreleased
+## [3.1.0](https://github.com/hole19/bisu/releases/tag/v3.1.0)(2026-07-30)
+
+- Add Bisu Platform as a translation source
+
+## [3.0.2](https://github.com/hole19/bisu/releases/tag/v3.0.2)(2025-11-26)
+
+- Escape percentage character properly on Android
 
 ## [3.0.1](https://github.com/hole19/bisu/releases/tag/v3.0.1)(2025-10-13)
 

data/README.md

@@ -79,6 +79,15 @@ Setup your configuration file
     host: <TOLGEE-CUSTOM-HOST> (default: app.tolgee.io)
   ```
 
+##### [Bisu Platform](https://github.com/hole19/bisu-platform)
+
+  ```
+  dictionary:
+    type: bisu
+    api_key: <BISU-API-TOKEN> # bsu_...
+    host: <BISU-PLATFORM-HOST>
+  ```
+
 ##### Google Sheets
 
 1. First ["Publish to the web"](https://www.google.com/search?q=google+sheets+publish+to+web) your Google Sheet

data/bisu.gemspec

@@ -3,22 +3,31 @@ require_relative "lib/bisu/version"
 Gem::Specification.new do |s|
   s.name        = 'bisu'
   s.version     = Bisu::VERSION
-  s.date        = Bisu::VERSION_UPDATED_AT
   s.summary     = 'A localization automation service'
-  s.description = 'Bisu manages your app iOS and Android localization files for you. No more copy+paste induced errors!'
+  s.description = "Bisu manages your app's iOS and Android localization files for you. No more copy+paste induced errors!"
   s.authors     = ['joaoffcosta']
   s.email       = 'joaostacosta@gmail.com'
   s.license     = 'MIT'
   s.homepage    = 'https://github.com/hole19/bisu'
 
-  s.files = `git ls-files`.split("\n")
+  s.metadata = {
+    'source_code_uri'       => 'https://github.com/hole19/bisu',
+    'changelog_uri'         => 'https://github.com/hole19/bisu/blob/main/CHANGELOG.md',
+    'bug_tracker_uri'       => 'https://github.com/hole19/bisu/issues',
+    'rubygems_mfa_required' => 'true',
+  }
+
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{\A(?:spec|\.github)/}) ||
+      f.match(%r{\A\.(?:travis\.yml|rspec)\z}) ||
+      %w[README_explanation.png Gemfile.lock].include?(f)
+  end
   s.require_paths = ['lib']
   s.executables = %w[ bisu ]
 
   s.required_ruby_version = '>= 3.0.0'
 
-  s.add_dependency 'safe_yaml',  '>= 1.0.0'
-  s.add_dependency 'colorize'
-  s.add_runtime_dependency 'csv' # For Google Sheets interpretation
-  s.add_runtime_dependency 'rubyzip', '>= 2.0.0' # For extracting the Tolgee zip file
+  s.add_dependency 'colorize', '~> 1.1'
+  s.add_dependency 'csv', '>= 3.0'                 # For Google Sheets interpretation
+  s.add_dependency 'rubyzip', '>= 2.0.0', '< 4.0'  # For extracting the Tolgee zip file
 end

data/lib/bisu/config.rb

@@ -90,11 +90,20 @@ module Bisu
       },
     }
 
+    BISU_STRUCT = {
+      type: Hash,
+      elements: {
+        api_key: { type: String },
+        host: { type: String },
+      },
+    }
+
     DICTIONARY_STRUCT = {
       "google_sheet" => GOOGLE_SHEET_STRUCT,
       "one_sky"      => ONE_SKY_STRUCT,
       "url"          => URL_STRUCT,
       "tolgee"       => TOLGEE_STRUCT,
+      "bisu"         => BISU_STRUCT,
     }
   end
 end

data/lib/bisu/localizer.rb

@@ -87,7 +87,7 @@ module Bisu
         text = text.gsub("...", "…")
         text = text.gsub("&", "&")
         text = text.gsub("@", "\\\\@")
-        text = text.gsub(/%(?!{)/, "\\\\%%")
+        text = text.gsub(/%(?!{)/, "%%") if is_formatted_string
       when :ios
         text = text.gsub(/%(?!{)/, "%%") if is_formatted_string
       end

data/lib/bisu/source/bisu.rb

@@ -0,0 +1,41 @@
+require 'net/https'
+require 'json'
+
+module Bisu
+  module Source
+    class Bisu
+      def initialize(api_key, host)
+        @api_key = api_key
+        @host = host
+      end
+
+      def to_i18
+        Logger.info("Downloading dictionary from Bisu Platform...")
+
+        hash = export
+
+        Logger.info("Found #{hash.count} languages.")
+
+        hash
+      end
+
+      private
+
+      def export
+        uri = URI("https://#{@host}/api/v1/export?languages=all&mode=flat")
+
+        request = Net::HTTP::Get.new(uri)
+        request['Authorization'] = "Bearer #{@api_key}"
+        request['Accept'] = 'application/json'
+
+        response = Net::HTTP.start(uri.host, uri.port, use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE) do |http|
+          http.request(request)
+        end
+
+        raise "Bisu::Source::Bisu: Http Error #{response.body}" unless response.is_a?(Net::HTTPSuccess)
+
+        JSON.parse(response.body).fetch("data")
+      end
+    end
+  end
+end

data/lib/bisu/version.rb

@@ -1,4 +1,3 @@
 module Bisu
-  VERSION = '3.0.1'
-  VERSION_UPDATED_AT = '2025-10-13'
+  VERSION = '3.1.0'
 end

data/lib/bisu.rb

@@ -9,6 +9,7 @@ require 'bisu/source/google_sheet'
 require 'bisu/source/one_sky'
 require 'bisu/source/url'
 require 'bisu/source/tolgee'
+require 'bisu/source/bisu'
 require 'bisu/dictionary'
 require 'bisu/localizer'
 require 'bisu/version'
@@ -67,6 +68,8 @@ module Bisu
         Bisu::Source::Url.new(config[:url])
       when "tolgee"
         Bisu::Source::Tolgee.new(config[:api_key], config[:host])
+      when "bisu"
+        Bisu::Source::Bisu.new(config[:api_key], config[:host])
       end
 
     source = source.to_i18

metadata

@@ -1,56 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - joaoffcosta
 bindir: bin
 cert_chain: []
-date: 2025-10-13 00:00:00.000000000 Z
+date: 1980-01-02 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.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +44,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -65,7 +54,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-description: Bisu manages your app iOS and Android localization files for you. No
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Bisu manages your app's iOS and Android localization files for you. No
   more copy+paste induced errors!
 email: joaostacosta@gmail.com
 executables:
@@ -73,14 +65,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
-- README_explanation.png
 - Rakefile
 - bin/bisu
 - bisu.gemspec
@@ -91,32 +78,20 @@ files:
 - lib/bisu/localizer.rb
 - lib/bisu/logger.rb
 - lib/bisu/object_extension.rb
+- lib/bisu/source/bisu.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
-- spec/fixtures/sample_google_response.csv
-- 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
-- spec/lib/bisu/logger_spec.rb
-- 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
 homepage: https://github.com/hole19/bisu
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/hole19/bisu
+  changelog_uri: https://github.com/hole19/bisu/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hole19/bisu/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -131,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A localization automation service
 test_files: []

data/.github/workflows/test.yml

@@ -1,30 +0,0 @@
-name: Test
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ "*" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4']
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Ruby ${{ matrix.ruby-version }}
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-
-    - name: Run tests
-      run: bundle exec rake

data/.rspec

@@ -1,4 +0,0 @@
---color
---format documentation
---profile
---require spec_helper

data/.travis.yml

@@ -1 +0,0 @@
-language: ruby

data/Gemfile.lock

@@ -1,60 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bisu (3.0.1)
-      colorize
-      csv
-      rubyzip (>= 2.0.0)
-      safe_yaml (>= 1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
-    bigdecimal (3.3.1)
-    colorize (1.1.0)
-    crack (1.0.0)
-      bigdecimal
-      rexml
-    csv (3.3.5)
-    diff-lcs (1.6.2)
-    hashdiff (1.2.1)
-    public_suffix (6.0.2)
-    rake (13.3.0)
-    rexml (3.4.4)
-    rspec (3.13.1)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.5)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-its (2.0.0)
-      rspec-core (>= 3.13.0)
-      rspec-expectations (>= 3.13.0)
-    rspec-mocks (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
-    rubyzip (3.1.1)
-    safe_yaml (1.0.5)
-    webmock (3.25.1)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bisu!
-  rake
-  rspec
-  rspec-its
-  webmock (~> 3)
-
-BUNDLED WITH
-   2.4.22

data/spec/fixtures/sample.translatable.yml

@@ -1,19 +0,0 @@
-type: iOS
-
-dictionary:
-  type: google_sheet
-  url: sheet-public-url
-  keys_column: "key name"
-
-translate:
-  - in: hole19/Localizable.strings.translatable
-    out: hole19/%{locale}.lproj/Localizable.strings
-  - in: hole19/Countries.strings.translatable
-    out: hole19/%{locale}.lproj/Countries.strings
-
-languages:
-  - locale: en
-    language: english
-  - locale: en-US
-    language: english-us
-    fallback_language: english

data/spec/fixtures/sample_google_response.csv

@@ -1,4 +0,0 @@
-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/fixtures/sample_json_response.json

@@ -1,19 +0,0 @@
-{
-    "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/fixtures/sample_one_sky_response.json

@@ -1,29 +0,0 @@
-{
-    "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/fixtures/sample_one_sky_response_with_bug.json

@@ -1,8 +0,0 @@
-{
-    "en": {
-        "translation": {
-            "kRegularNewLine": "This is the first line\\nthis is the second line",
-            "kErrorNewLine": "This is the first line\nthis is the second line"
-        }
-    }
-}

data/spec/lib/bisu/config_spec.rb

@@ -1,89 +0,0 @@
-describe Bisu::Config do
-  subject(:config) { Bisu::Config.new(hash: hash) }
-
-  let(:hash) { {
-    type: "BisuOS",
-    dictionary: {
-      type: "google_sheet",
-      url: "https://abc1234567890",
-      keys_column: "key name",
-    },
-    translate: [
-      { in: "path/to/file/to/1.ext.translatable",
-        out: "path/to/final-%{locale}/1.ext",
-        out_en_us: "path/to/default/1.ext"
-      },
-      { in: "path/to/file/to/2.ext.translatable",
-        out: "path/to/final-%{locale}/2.ext",
-        out_en_us: "path/to/default/2.ext"
-      },
-    ],
-    languages: [
-      { locale: "en-US", language: "english"    },
-      { locale: "pt", language: "portuguese" },
-      { locale: "pt-PT", language: "portuguese" },
-      { locale: "pt-Batatas", language: "portuguese-bt", fallback_language: "portuguese" }
-    ]
-  } }
-
-  context "when hash is missing params" do
-    before { hash.delete(:type) }
-    it { expect { config }.to raise_error /missing keys/i }
-  end
-
-  its(:to_h) { should eq(hash) }
-  its(:type) { should eq("BisuOS") }
-
-  describe "#dictionary" do
-    subject(:dictionary) { config.dictionary }
-
-    it { should eq({ type: "google_sheet", url: "https://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 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 }
-    end
-  end
-
-  describe "#localize_files" do
-    it "yields 5 times with the expected arguments" do
-      expect { |b|
-        config.localize_files(&b)
-      }.to yield_successive_args(
-        ["path/to/file/to/1.ext.translatable", "path/to/default/1.ext",          "en-US",      "english",       nil         ],
-        ["path/to/file/to/1.ext.translatable", "path/to/final-pt/1.ext",         "pt",         "portuguese",    nil         ],
-        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-PT/1.ext",      "pt-PT",      "portuguese",    nil         ],
-        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-Batatas/1.ext", "pt-Batatas", "portuguese-bt", "portuguese"],
-        ["path/to/file/to/2.ext.translatable", "path/to/default/2.ext",          "en-US",      "english",       nil         ],
-        ["path/to/file/to/2.ext.translatable", "path/to/final-pt/2.ext",         "pt",         "portuguese",    nil         ],
-        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-PT/2.ext",      "pt-PT",      "portuguese",    nil         ],
-        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-Batatas/2.ext", "pt-Batatas", "portuguese-bt", "portuguese"]
-      )
-    end
-  end
-end