lokalise_manager 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0640f0599d5b4967f79d2ced69f63d7cb7edde3e2a3a49336d08d17e5fb4c0f
-  data.tar.gz: 0766d8cb7f6b478e427f8ef7dd1409d86072a74a4606b026eaa718f6fe4761b5
+  metadata.gz: a6dbbda54dc255ed4ec13547b954213e41ab38c90d1520ffe3762d36dc2917f8
+  data.tar.gz: a341a91e4fea6ff76e0de87e5efa9660f5a0c5a7659656fbcfa14600fc4937d8
 SHA512:
-  metadata.gz: 38a3adfcc0bf4a78f595547cdc3ba2962a4122d8bbeaa7e132d47dc4e76992711e653710a802e395fafcb0c316743607876a10f0914c2633472994891fd4850e
-  data.tar.gz: 98b2edd83de044615db56ee71d090afa03fcfc7793c55854e322ab466996e0eb46c74f3b22dbdbd44e570f31746d40394912ba39c29dd17337b17e08d0417761
+  metadata.gz: 2f5f277f431596f70ee52f45186a972dcd507d1be08f6fc71bd04117556ca803efbe3e8b0d6a123ec6f81b959a5a1c99d9aa63a3189a4700a195fb823ca766e2
+  data.tar.gz: c64848ee98ee90cd77507bae719048ac425c60b7f16581b52de6ed6ab2301976487f6999027eab729244c4d3e8b27af1d5d6875c74d8b3d7cbd35112e0ededf1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.1.0 (25-Oct-21)
+
+* Add a new option `:use_oauth2_token` which is `false` by default. When enabled, you'll be able to provide a token obtained via [OAuth 2 flow](https://docs.lokalise.com/en/articles/5574713-oauth-2) rather than generated via Lokalise profile. The token should still be provided via the `:api_token` option:
+
+```ruby
+importer = LokaliseManager.importer api_token: 'TOKEN_VIA_OAUTH2', project_id: '123.abc', use_oauth2_token: true
+```
+
 ## 1.0.0 (14-Oct-21)
 
 * Initial release

data/README.md

@@ -87,6 +87,7 @@ Please don't forget that Lokalise API has rate limiting and you cannot send more
 ### Common config
 
 * `api_token` (`string`, required) — Lokalise API token with read/write permissions.
+* `use_oauth2_token` (`boolean`) — whether you would like to use a token obtained via [OAuth 2 flow](https://docs.lokalise.com/en/articles/5574713-oauth-2). Defaults to `false`.
 * `project_id` (`string`, required) — Lokalise project ID. You must have import/export permissions in the specified project.
 * `locales_path` (`string`) — path to the directory with your translation files. Defaults to `"#{Dir.getwd}/locales"`.
 * `branch` (`string`) — Lokalise project branch to use. Defaults to `""` (no branch is provided).
@@ -169,6 +170,10 @@ If your translation files are not in YAML format, you will need to adjust the fo
 * `translations_converter` (`lambda` or `proc`) — converts translations data to a proper format before saving them to a translation file. Defaults to `->(raw_data) { raw_data.to_yaml }`. 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 }`.
 
+### Customizing JSON parser and network adapter
+
+JSON parser and network adapter utilized by lokalise_manager can be customized as well. Please check [ruby-lokalise-api doc](https://lokalise.github.io/ruby-lokalise-api/additional_info/customization) to learn more.
+
 ## Providing config options
 
 ### Per-client

data/lib/lokalise_manager/global_config.rb

@@ -7,13 +7,19 @@ module LokaliseManager
       attr_writer :import_opts, :import_safe_mode, :export_opts, :locales_path,
                   :file_ext_regexp, :skip_file_export, :branch, :timeouts,
                   :translations_loader, :translations_converter, :lang_iso_inferer,
-                  :max_retries_export, :max_retries_import
+                  :max_retries_export, :max_retries_import, :use_oauth2_token
 
       # Main interface to provide configuration options
       def config
         yield self
       end
 
+      # When enabled, will use OAuth 2 Lokalise client and will require to provide a token obtained via OAuth 2 flow
+      # rather than via Lokalise profile
+      def use_oauth2_token
+        @use_oauth2_token || false
+      end
+
       # Full path to directory with translation files
       def locales_path
         @locales_path || "#{Dir.getwd}/locales"

data/lib/lokalise_manager/task_definitions/base.rb

@@ -30,7 +30,10 @@ module LokaliseManager
       #
       # @return [Lokalise::Client]
       def api_client
-        @api_client ||= ::Lokalise.client config.api_token, {enable_compression: true}.merge(config.timeouts)
+        client_opts = [config.api_token, {enable_compression: true}.merge(config.timeouts)]
+        client_method = config.use_oauth2_token ? :oauth_client : :client
+
+        @api_client ||= ::Lokalise.send(client_method, *client_opts)
       end
 
       # Resets API client

data/lib/lokalise_manager/version.rb

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

data/spec/lib/lokalise_manager/global_config_spec.rb

@@ -14,6 +14,11 @@ describe LokaliseManager::GlobalConfig do
     fake_class.project_id = '123.abc'
   end
 
+  it 'is possible to set use_oauth2_token' do
+    allow(fake_class).to receive(:use_oauth2_token=).with(true)
+    fake_class.use_oauth2_token = true
+  end
+
   it 'is possible to set file_ext_regexp' do
     allow(fake_class).to receive(:file_ext_regexp=).with(Regexp.new('.*'))
     fake_class.file_ext_regexp = Regexp.new('.*')

data/spec/lib/lokalise_manager/task_definitions/base_spec.rb

@@ -94,9 +94,20 @@ describe LokaliseManager::TaskDefinitions::Base do
                                                                         timeout: 500
                                                                       })
 
-      expect(described_object.api_client).to be_an_instance_of(Lokalise::Client)
-      expect(described_object.api_client.open_timeout).to eq(100)
-      expect(described_object.api_client.timeout).to eq(500)
+      client = described_object.api_client
+      expect(client).to be_an_instance_of(Lokalise::Client)
+      expect(client).not_to be_an_instance_of(Lokalise::OAuthClient)
+      expect(client.open_timeout).to eq(100)
+      expect(client.timeout).to eq(500)
+    end
+
+    it 'uses .oauth_client when the use_oauth2_token is true' do
+      allow(described_object.config).to receive(:use_oauth2_token).and_return(true)
+
+      client = described_object.api_client
+
+      expect(client).to be_an_instance_of(Lokalise::OAuthClient)
+      expect(client).not_to be_an_instance_of(Lokalise::Client)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api