ruby-lokalise-api 4.1.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d306f7be49970786734ed94a006a6fd37d54e6919c19eb61390f78ad5acff8
-  data.tar.gz: ea3a5594f544a876386ffa1d50c1a7ff2a842966ca00811df33f54d9e304106e
+  metadata.gz: f15e541afdd5e50a0e9317640b872bb04144dcaa717b2390887546b694e308fd
+  data.tar.gz: f34bb8a44f1e8552a0bc83b3f4c15d604500d56ecea503260d6423b047b36dcc
 SHA512:
-  metadata.gz: 356f32428e0732321e27bc47f2c63022bea36990fb69886fa2daff9d2016bee3f9b80795c326ef4c090f280e58de51d65e8b5e9c6711b3de2be6bb37ae2b2c01
-  data.tar.gz: 4d5eb8f4fac05abf181fe793d94b2ec5ca759c004d865bbbd085252e4ac49d5abded9056fe0535bb428e1a1308c858a760d4fedd3a05afa7aebb2c8ec1e8ff3f
+  metadata.gz: dbbc75876ec0e0c9f5a611d54520585759d77cb4f13a81126d7f9a45c89852331801054ec973f94a6c0b4e58c0a8ea8c6cb88167e5b4a4b3ac9521531b911a87
+  data.tar.gz: 2687c66c1fb1ef0012cac50329b87a7c48118cff98a890e06b7764ccce828a850750b6896d5ace0a6810e8cebb86658bbd333794e6bc94cde725c957b1c968f6

data/.github/CONTRIBUTING.md

@@ -4,7 +4,7 @@
 2. [Create a topic branch.][branch]
 3. Implement your feature or bug fix.
 4. Don't forget to add specs and make sure they pass by running `rspec .`.
-5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you. Run `rubocop -A` to make it more aggressive.
 6. If necessary, add documentation for your feature or bug fix.
 7. Commit and push your changes.
 8. [Submit a pull request.][pr]

data/README.md

@@ -7,7 +7,7 @@
 
 Official opinionated Ruby interface for the [Lokalise API](https://app.lokalise.com/api2docs/curl/) that represents returned data as Ruby objects.
 
-Looking for a Rails integration? Try the new [lokalise_rails gem](https://github.com/bodrovis/lokalise_rails).
+Looking for a Rails integration? Try the [lokalise_rails gem](https://github.com/bodrovis/lokalise_rails). Also you can use a [lokalise_manager gem](https://github.com/bodrovis/lokalise_manager) which allows to exchange translation files between Lokalise and *any* Ruby script.
 
 ## Quickstart
 
@@ -39,6 +39,12 @@ process = @client.upload_file project_id,
 process.status
 ```
 
+Alternatively instantiate your client with an [OAuth2 token](http://docs.lokalise.com/en/articles/5574713-oauth-2):
+
+```ruby
+@client = Lokalise.oauth_client 'YOUR_OAUTH_TOKEN_HERE'
+```
+
 ## Usage
 
 Detailed documentation can be found at [lokalise.github.io/ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api/).
@@ -47,4 +53,4 @@ Detailed documentation can be found at [lokalise.github.io/ruby-lokalise-api](ht
 
 This gem is licensed under the [BSD 3 Clause license](https://github.com/lokalise/ruby-lokalise-api/blob/master/LICENSE). Prior to version 4 the license type was MIT.
 
-Copyright (c) [Lokalise team](http://lokalise.co), [Ilya Bodrov](http://bodrovis.tech)
+Copyright (c) [Lokalise team](http://lokalise.co) and [Ilya Bodrov](http://bodrovis.tech)

data/lib/ruby-lokalise-api/client.rb

@@ -23,13 +23,15 @@ require 'ruby-lokalise-api/rest/webhooks'
 
 module Lokalise
   class Client
-    attr_reader :token
-    attr_accessor :timeout, :open_timeout
+    attr_reader :token, :token_header
+    attr_accessor :timeout, :open_timeout, :enable_compression
 
     def initialize(token, params = {})
       @token = token
       @timeout = params.fetch(:timeout, nil)
       @open_timeout = params.fetch(:open_timeout, nil)
+      @enable_compression = params.fetch(:enable_compression, false)
+      @token_header = 'x-api-token'
     end
 
     # rubocop:disable Metrics/ParameterLists

data/lib/ruby-lokalise-api/collections/base.rb

@@ -19,11 +19,12 @@ module Lokalise
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
+        content = response['content']
         # Project, team id, user id, and branch may not be present in some cases
-        @project_id = response['content']['project_id']
-        @team_id = response['content']['team_id']
-        @user_id = response['content']['user_id']
-        @branch = response['content']['branch']
+        @project_id = content['project_id']
+        @team_id = content['team_id']
+        @user_id = content['user_id']
+        @branch = content['branch']
         @request_params = params
         @client = response['client']
         @path = response['path']

data/lib/ruby-lokalise-api/connection.rb

@@ -5,19 +5,25 @@ module Lokalise
     BASE_URL = 'https://api.lokalise.com/api2/'
 
     def connection(client)
-      options = {
+      Faraday.new(options(client), request_params_for(client)) do |faraday|
+        faraday.use(:gzip) if client.enable_compression
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def options(client)
+      {
         headers: {
           accept: 'application/json',
           user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}",
-          'x-api-token': client.token
+          client.token_header => client.token
         },
         url: BASE_URL
       }
-      Faraday.new(options, request_params_for(client)) { |faraday| faraday.adapter Faraday.default_adapter }
     end
 
-    private
-
     # Allows to customize request params per-client
     def request_params_for(client)
       {request: {timeout: client.timeout, open_timeout: client.open_timeout}}

data/lib/ruby-lokalise-api/data/attributes.json

@@ -210,7 +210,8 @@
     "is_fuzzy",
     "is_reviewed",
     "words",
-    "custom_translation_statuses"
+    "custom_translation_statuses",
+    "task_id"
   ],
   "translation_provider": [
     "provider_id",

data/lib/ruby-lokalise-api/error.rb

@@ -39,7 +39,8 @@ module Lokalise
     class << self
       # Create a new error from an HTTP response
       def from_response(body)
-        new body['error']['message'].to_s
+        msg = body.key?('error') ? body['error']['message'] : body['message']
+        new msg.to_s
       end
     end
 

data/lib/ruby-lokalise-api/oauth_client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Lokalise
+  class OAuthClient < Client
+    def initialize(token, params = {})
+      super(token, params)
+      @token_header = 'Authorization'
+      @token = "Bearer #{@token}"
+    end
+  end
+end

data/lib/ruby-lokalise-api/request.rb

@@ -58,7 +58,8 @@ module Lokalise
     def respond_with(response, client)
       body = custom_load response.body
       uri = Addressable::URI.parse response.env.url
-      respond_with_error(response.status, body) if body.respond_to?(:has_key?) && body.key?('error')
+      status = response.status
+      respond_with_error status, body if status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
       extract_headers_from(response).
         merge('content' => body,
               'client' => client,
@@ -74,7 +75,7 @@ module Lokalise
     end
 
     def respond_with_error(code, body)
-      raise(Lokalise::Error, body['error']) unless Lokalise::Error::ERRORS.key? code
+      raise(Lokalise::Error, body['error'] || body) unless Lokalise::Error::ERRORS.key? code
 
       raise Lokalise::Error::ERRORS[code].from_response(body)
     end

data/lib/ruby-lokalise-api/resources/base.rb

@@ -107,10 +107,11 @@ module Lokalise
         end
 
         def produce_resource(model_class, response)
+          content = response['content']
           data_key_singular = data_key_for model_class: model_class
-          if response['content'].key? data_key_singular
-            data = response['content'].delete data_key_singular
-            response['content'].merge! data
+          if content.key? data_key_singular
+            data = content.delete data_key_singular
+            content.merge! data
           end
 
           new response
@@ -156,9 +157,10 @@ module Lokalise
         # Sometimes there is an `id_key` but it has a value of `null`
         # (for example when we do not place the actual order but only check its price).
         # Therefore we must explicitly check if the key is present
-        return response['content'][id_key] if response['content'].key?(id_key)
+        content = response['content']
+        return content[id_key] if content.key?(id_key)
 
-        response['content'][data_key][id_key]
+        content[data_key][id_key]
       end
 
       # Store all resources attributes under the corresponding instance variables.

data/lib/ruby-lokalise-api/resources/branch.rb

@@ -6,7 +6,8 @@ module Lokalise
       supports :update, :destroy, [:reload_data, '', :find]
 
       def merge(params = {})
-        self.class.merge @client, self.class.endpoint(project_id, branch_id, :merge), params
+        klass = self.class
+        klass.merge @client, klass.endpoint(project_id, branch_id, :merge), params
       end
 
       class << self

data/lib/ruby-lokalise-api/rest/files.rb

@@ -22,7 +22,8 @@ module Lokalise
       c_r Lokalise::Resources::File, :download, [project_id, 'download'], params
     end
 
-    # Imports translation file to the given project. File data must base64-encoded
+    # Imports translation file to the given project. File data must base64-encoded.
+    # To encode your data in Base64, use `Base64.strict_encode64()` method.
     #
     # @see https://app.lokalise.com/api2docs/curl/#transition-upload-a-file-post
     # @return [Hash]

data/lib/ruby-lokalise-api/utils/attribute_helpers.rb

@@ -47,9 +47,7 @@ module Lokalise
       #
       # @return [Array<String>]
       def attributes_for(klass)
-        @attributes ||= begin
-          YAML.load_file(File.expand_path('../data/attributes.json', __dir__)).freeze
-        end
+        @attributes ||= YAML.load_file(File.expand_path('../data/attributes.json', __dir__)).freeze
 
         name = unify klass.name.snakecase
         @attributes[name]

data/lib/ruby-lokalise-api/utils/string_utils.rb

@@ -22,6 +22,6 @@ class String
   end
 
   def remove_trailing_slash
-    gsub %r{/\z}, ''
+    delete_suffix '/'
   end
 end

data/lib/ruby-lokalise-api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lokalise
-  VERSION = '4.1.0'
+  VERSION = '4.4.0'
 end

data/lib/ruby-lokalise-api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday_middleware'
 require 'yaml'
 require 'addressable'
 
@@ -62,6 +63,7 @@ require 'ruby-lokalise-api/collections/custom_translation_status'
 require 'ruby-lokalise-api/collections/webhook'
 
 require 'ruby-lokalise-api/client'
+require 'ruby-lokalise-api/oauth_client'
 
 module Lokalise
   class << self
@@ -78,5 +80,19 @@ module Lokalise
     def reset_client!
       @client = nil
     end
+
+    # Initializes a new OAuthClient object
+    #
+    # @return [Lokalise::OAuthClient]
+    # @param token [String]
+    # @param params [Hash]
+    def oauth_client(token, params = {})
+      @oauth_client ||= Lokalise::OAuthClient.new token, params
+    end
+
+    # Reset the currently set OAuth client
+    def reset_oauth_client!
+      @oauth_client = nil
+    end
   end
 end

data/ruby-lokalise-api.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable',                   '~> 2.5'
   spec.add_dependency 'faraday',                       '~> 1.0'
+  spec.add_dependency 'faraday_middleware',            '~> 1.0'
   spec.add_dependency 'json',                          '>= 1.8.0'
 
   spec.add_development_dependency 'codecov',                   '~> 0.1'

data/spec/lib/ruby-lokalise-api/connection_spec.rb

@@ -3,6 +3,9 @@
 RSpec.describe Lokalise::Connection do
   include described_class
 
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:key_id) { 44_596_059 }
+
   before { Lokalise.reset_client! }
 
   after do
@@ -10,11 +13,18 @@ RSpec.describe Lokalise::Connection do
     Faraday.default_adapter = :net_http
   end
 
-  it 'timeouts should not be set by default but the token must be present' do
+  it 'Authorization header must be present for OAuth client' do
+    conn = connection test_oauth_client
+    expect(conn.headers['Authorization']).to eq("Bearer #{test_client.token}")
+    expect(conn.headers['X-api-token']).to be_nil
+  end
+
+  it 'timeouts and compression should not be set by default but the token must be present' do
     conn = connection test_client
     expect(conn.options.timeout).to be_nil
     expect(conn.options.open_timeout).to be_nil
     expect(conn.headers['X-api-token']).to eq(test_client.token)
+    expect(conn.builder.handlers).not_to include(FaradayMiddleware::Gzip)
   end
 
   it 'allows to customize timeouts' do
@@ -42,4 +52,38 @@ RSpec.describe Lokalise::Connection do
     expect(another_conn.builder.adapter).to eq(Faraday::Adapter::Excon)
     expect(conn.builder.adapter).to eq(Faraday::Adapter::NetHttp)
   end
+
+  it 'allows to customize compression' do
+    custom_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'], enable_compression: true)
+    conn = connection custom_client
+    expect(conn.headers['X-api-token']).to eq(custom_client.token)
+    expect(conn.builder.handlers).to include(FaradayMiddleware::Gzip)
+  end
+
+  it 'is possible to enable gzip compression' do
+    gzip_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'], enable_compression: true)
+    keys = VCR.use_cassette('all_keys_gzip') do
+      gzip_client.keys project_id
+    end.collection
+
+    expect(keys.first.key_id).to eq(key_id)
+  end
+
+  it 'is possible to disable gzip compression' do
+    no_gzip_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'], enable_compression: false)
+    keys = VCR.use_cassette('all_keys_no_gzip') do
+      no_gzip_client.keys project_id
+    end.collection
+
+    expect(keys.first.key_id).to eq(key_id)
+  end
+
+  it 'gzip compression is off by default' do
+    default_gzip_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'])
+    keys = VCR.use_cassette('all_keys_default_gzip') do
+      default_gzip_client.keys project_id
+    end.collection
+
+    expect(keys.first.key_id).to eq(key_id)
+  end
 end

data/spec/lib/ruby-lokalise-api/error_spec.rb

@@ -15,6 +15,14 @@ RSpec.describe Lokalise::Error do
     end.to raise_error(described_class)
   end
 
+  it 'handles an exception when the response does not contain an error key' do
+    expect do
+      VCR.use_cassette('error_no_error_key') do
+        get 'projects', Lokalise.client('invalid')
+      end
+    end.to raise_error(Lokalise::Error::BadRequest)
+  end
+
   it 'raises BadRequest when API token is invalid' do
     expect do
       VCR.use_cassette('error_invalid_token') do

data/spec/lib/ruby-lokalise-api/rest/translations_spec.rb

@@ -59,26 +59,27 @@ RSpec.describe Lokalise::Client do
 
   specify '#translation' do
     translation = VCR.use_cassette('translation') do
-      test_client.translation project_id, translation_id
+      test_client.translation project_id, 304_581_218
     end
 
-    expect(translation.translation_id).to eq(translation_id)
-    expect(translation.key_id).to eq(15_571_975)
-    expect(translation.language_iso).to eq('en')
-    expect(translation.modified_at).to eq('2019-03-26 16:41:31 (Etc/UTC)')
-    expect(translation.modified_at_timestamp).to eq(1_553_618_491)
+    expect(translation.translation_id).to eq(304_581_218)
+    expect(translation.key_id).to eq(44_596_059)
+    expect(translation.language_iso).to eq('ru')
+    expect(translation.modified_at).to eq('2020-05-15 10:44:42 (Etc/UTC)')
+    expect(translation.modified_at_timestamp).to eq(1_589_539_482)
     expect(translation.modified_by).to eq(20_181)
     expect(translation.modified_by_email).to eq('bodrovis@protonmail.com')
-    expect(translation.translation).to eq('RSpec is a testing suite')
+    expect(translation.translation).to eq('Сообщение')
     expect(translation.is_fuzzy).to eq(false)
     expect(translation.is_reviewed).to eq(false)
-    expect(translation.words).to eq(5)
+    expect(translation.words).to eq(1)
     expect(translation.custom_translation_statuses).to eq([])
+    expect(translation.task_id).to be_nil
   end
 
   specify '#reload_data' do
     translation = VCR.use_cassette('translation') do
-      test_client.translation project_id, translation_id
+      test_client.translation project_id, 304_581_218
     end
 
     reloaded_translation = VCR.use_cassette('translation') do

data/spec/lib/ruby-lokalise-api_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe Lokalise do
     expect(test_client.token).to eq(ENV['LOKALISE_API_TOKEN'])
     expect(test_client.timeout).to be_nil
     expect(test_client.open_timeout).to be_nil
+    expect(test_client.enable_compression).to be false
   end
 
   specify '.reset_client!' do
@@ -15,6 +16,21 @@ RSpec.describe Lokalise do
     expect(current_client).to be_nil
   end
 
+  specify '.oauth_client' do
+    expect(test_oauth_client).to be_an_instance_of(Lokalise::OAuthClient)
+    expect(test_oauth_client.token).to eq("Bearer #{ENV['LOKALISE_API_TOKEN']}")
+    expect(test_oauth_client.timeout).to be_nil
+    expect(test_oauth_client.open_timeout).to be_nil
+    expect(test_oauth_client.enable_compression).to be false
+  end
+
+  specify '.reset_oauth_client!' do
+    expect(test_oauth_client).to be_an_instance_of(Lokalise::OAuthClient)
+    described_class.reset_oauth_client!
+    current_oauth_client = described_class.instance_variable_get '@oauth_client'
+    expect(current_oauth_client).to be_nil
+  end
+
   context 'with client params' do
     before { described_class.reset_client! }
 
@@ -29,5 +45,10 @@ RSpec.describe Lokalise do
       custom_client = described_class.client(ENV['LOKALISE_API_TOKEN'], open_timeout: 100)
       expect(custom_client.open_timeout).to eq(100)
     end
+
+    it 'is possible to customize compression' do
+      custom_client = described_class.client(ENV['LOKALISE_API_TOKEN'], enable_compression: true)
+      expect(custom_client.enable_compression).to be true
+    end
   end
 end

data/spec/support/test_client.rb

@@ -4,4 +4,8 @@ module TestClient
   def test_client(token = nil, params = {})
     Lokalise.client(token || ENV['LOKALISE_API_TOKEN'], params)
   end
+
+  def test_oauth_client(token = nil, params = {})
+    Lokalise.oauth_client(token || ENV['LOKALISE_API_TOKEN'], params)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +252,7 @@ files:
 - lib/ruby-lokalise-api/data/attributes.json
 - lib/ruby-lokalise-api/error.rb
 - lib/ruby-lokalise-api/json_handler.rb
+- lib/ruby-lokalise-api/oauth_client.rb
 - lib/ruby-lokalise-api/request.rb
 - lib/ruby-lokalise-api/resources/base.rb
 - lib/ruby-lokalise-api/resources/branch.rb
@@ -334,7 +349,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API
@@ -356,11 +371,11 @@ test_files:
 - spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb
 - spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb
 - spec/lib/ruby-lokalise-api/rest/tasks_spec.rb
-- spec/lib/ruby-lokalise-api/rest/teams_spec.rb
-- spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_user_groups_spec.rb
-- spec/lib/ruby-lokalise-api/rest/translations_spec.rb
+- spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
+- spec/lib/ruby-lokalise-api/rest/teams_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translation_providers_spec.rb
+- spec/lib/ruby-lokalise-api/rest/translations_spec.rb
 - spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb
 - spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
 - spec/lib/ruby-lokalise-api_spec.rb