lokalise_manager 4.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e050488025db0f9c199092084e0b7925ffe56de86ea958f5647c073d396a1bc4
-  data.tar.gz: a172734358df197f42c6c1f54c12de213bd5cb76537bb75167d69fca9ea81e90
+  metadata.gz: e651c10cfc08624f8bbfe88970210ed7a9e012e8637cc8cbb61aa4328942016b
+  data.tar.gz: f0dea631f1afba287ff49ff7336a1d74030347feafbafb848e8e5f445d466df9
 SHA512:
-  metadata.gz: 73721527aed2b9fcfcdcf54c2475b6f9cc51307f82ab5c32a2736b6c909c48187d04c72ebfab1cd616293562a5c0bbbbc47dd41cd8e37d7eef83527c3452f86f
-  data.tar.gz: f42762cc96263e83c84be880678914265eb43dcd595050fa63d17f7e72bdb566af27185874ff1b135964cb8ce33e6ba61be2d2e2d321137c99777ab2e33b5374
+  metadata.gz: d4792e56612597b654536c72b0c29550b15c9e3666da1422208d613e546cb2870b9749a7150111e40296bd5e2550ca9eacedc55715b0c28292eb1cff45eddf9c
+  data.tar.gz: 59cfbc87f48a4293fa064946d638b27510211d05bdd8dd5b9c4c63716455b55cdec851da5b2f35b4a4941d153639874bf87e2e34040cc433fe6a46ce978bc0c8

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 5.1.0 (09-Feb-2024)
+
+* Handle rare case when the server returns HTML instead of JSON which happens when too many requests are sent
+
+## 5.0.0 (09-Nov-2023)
+
+* **Breaking change**: require Ruby 3+. Version 2.7 has reached end-of-life and thus we are not planning to support it anymore. If you need support for Ruby 2.7, please stay on 4.0.0.
+* **Potential breaking change**: lambda returned by the `lang_iso_inferer` method has been slightly enhanced. It now accepts not only the file data but also the full path to the file. Therefore, if you redefine the `lang_iso_inferer` option please make sure that the returned lambda accepts two params, not one. This way, you can be more flexible when inferring the locale. For example:
+
+```ruby
+lang_iso_inferer: ->(_data, path) { path.basename('.yml').to_s }
+```
+
+* Use ruby-lokalise-api v9.0.0
+
 ## 4.0.0 (27-Jul-2023)
 
 * **Use ruby-lokalise-api version 8**. It should not introduce any breaking changes (as main methods have similar signatures) but you should be aware that v8 is a complete rewrite of the original SDK so please make sure your tests pass.

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Ilya Krukowski
+Copyright (c) 2024 Ilya Krukowski
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,6 +3,7 @@
 ![Gem](https://img.shields.io/gem/v/lokalise_manager)
 ![CI](https://github.com/bodrovis/lokalise_manager/actions/workflows/ci.yml/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/bodrovis/lokalise_manager/badge.svg?branch=master)](https://coveralls.io/github/bodrovis/lokalise_manager?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9b682367a274ee3dcdee/maintainability)](https://codeclimate.com/github/bodrovis/lokalise_manager/maintainability)
 ![Downloads total](https://img.shields.io/gem/dt/lokalise_manager)
 
 This gem provides [Lokalise](http://lokalise.com) integration for Ruby and allows to exchange translation files between your project and TMS easily. It relies on [ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api) to send APIv2 requests.
@@ -13,7 +14,7 @@ If you are looking for a Rails integration, please check [lokalise_rails](https:
 
 ### Requirements
 
-This gem requires Ruby 2.5+. You will also need to [setup a Lokalise account](https://app.lokalise.com/signup) and create a [translation project](https://docs.lokalise.com/en/articles/1400460-projects). Finally, you will need to generate a [read/write API token](https://docs.lokalise.com/en/articles/1929556-api-tokens) at your Lokalise profile.
+This gem requires Ruby 3.0+. You will also need to [setup a Lokalise account](https://app.lokalise.com/signup) and create a [translation project](https://docs.lokalise.com/en/articles/1400460-projects). Finally, you will need to generate a [read/write API token](https://docs.lokalise.com/en/articles/1929556-api-tokens) at your Lokalise profile.
 
 Alternatively, you can utilize a token obtained via OAuth 2 flow. When using such a token, you'll have to set `:use_oauth2_token` option to `true` (see below).
 
@@ -202,7 +203,7 @@ If your translation files are not in YAML format, you will need to adjust the fo
 * `file_ext_regexp` (`regexp`) — regular expression applied to file extensions to determine which files should be imported and exported. Defaults to `/\.ya?ml\z/i` (YAML files).
 * `translations_loader` (`lambda` or `proc`) — loads translations data and makes sure they are valid before saving them to a translation file. Defaults to `->(raw_data) { YAML.safe_load raw_data }`. In the simplest case you may just return the data back, for example `-> (raw_data) { raw_data }`.
 * `translations_converter` (`lambda` or `proc`) — converts translations data to a proper format before saving them to a translation file. Defaults to `->(raw_data) { YAML.dump(raw_data).gsub(/\\\\n/, '\n') }`. In the simplest case you may just return the data back, for example `-> (raw_data) { raw_data }`.
-* `lang_iso_inferer` (`lambda` or `proc`) — infers language ISO code based on the translation file data before uploading it to Lokalise. Defaults to `->(data) { YAML.safe_load(data)&.keys&.first }`.
+* `lang_iso_inferer` (`lambda` or `proc`) — infers language ISO code based on the translation file data and path before uploading it to Lokalise. Defaults to `->(data, _path) { YAML.safe_load(data)&.keys&.first }`. To infer locale based on the filename, you can use something like `->(_data, path) { path.basename('.yml').to_s }`. `path` is an instance of the `Pathname` class.
 
 ### Customizing JSON parser and network adapter
 

data/lib/lokalise_manager/global_config.rb

@@ -99,8 +99,10 @@ module LokaliseManager
       end
 
       # Infers lang ISO for the given translation file
+      # The lambda expects to accept the raw contents of the translation file
+      # and the full path to the file (instance of the `Pathname` class)
       def lang_iso_inferer
-        @lang_iso_inferer || ->(data) { YAML.safe_load(data)&.keys&.first }
+        @lang_iso_inferer || ->(data, _path) { YAML.safe_load(data)&.keys&.first }
       end
     end
   end

data/lib/lokalise_manager/task_definitions/base.rb

@@ -88,6 +88,11 @@ module LokaliseManager
         "#{config.project_id}:#{config.branch}"
       end
 
+      # In rare cases the server might return HTML instead of JSON.
+      # It happens when too many requests are being sent.
+      # Until this is fixed, we revert to this quick'n'dirty solution.
+      EXCEPTIONS = [JSON::ParserError, RubyLokaliseApi::Error::TooManyRequests].freeze
+
       # Sends request with exponential backoff mechanism
       def with_exp_backoff(max_retries)
         return unless block_given?
@@ -95,7 +100,7 @@ module LokaliseManager
         retries = 0
         begin
           yield
-        rescue RubyLokaliseApi::Error::TooManyRequests => e
+        rescue *EXCEPTIONS => e
           raise(e.class, "Gave up after #{retries} retries") if retries >= max_retries
 
           sleep 2**retries

data/lib/lokalise_manager/task_definitions/exporter.rb

@@ -84,7 +84,7 @@ module LokaliseManager
         initial_opts = {
           data: Base64.strict_encode64(content.strip),
           filename: relative_p,
-          lang_iso: config.lang_iso_inferer.call(content)
+          lang_iso: config.lang_iso_inferer.call(content, full_p)
         }
 
         initial_opts.merge config.export_opts

data/lib/lokalise_manager/task_definitions/importer.rb

@@ -19,7 +19,7 @@ module LokaliseManager
           return false
         end
 
-        open_and_process_zip download_files['bundle_url']
+        open_and_process_zip download_files.bundle_url
 
         $stdout.print('Task complete!') unless config.silent_mode
         true

data/lib/lokalise_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseManager
-  VERSION = '4.0.0'
+  VERSION = '5.1.0'
 end

data/lib/lokalise_manager.rb

@@ -2,7 +2,6 @@
 
 require 'zeitwerk'
 require 'yaml'
-require 'psych'
 
 loader = Zeitwerk::Loader.for_gem
 loader.setup

data/lokalise_manager.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage              = 'https://github.com/bodrovis/lokalise_manager'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.files = Dir['README.md', 'LICENSE',
                    'CHANGELOG.md', 'lib/**/*.rb',
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'ruby-lokalise-api', '~> 8.0'
+  spec.add_dependency 'ruby-lokalise-api', '~> 9.0'
   spec.add_dependency 'rubyzip', '~> 2.3'
   spec.add_dependency 'zeitwerk', '~> 2.4'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -231,14 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby