ruby-lokalise-api 4.0.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b871674214b37d9a6b0621c0e237d393755ecb14dbdf190fb6689decb0798b6f
-  data.tar.gz: 2422640be2390f293d46b642097c4f9e5b0848f7720504acb6e0618910fd5188
+  metadata.gz: 4147ca27a676c98d74fa654c4244212aa7e296855d4bda492fd061a3a3a02347
+  data.tar.gz: 59c042db99a7f2899baef674319ec18ab9ee193f3581f35b40fd92b0c43118bb
 SHA512:
-  metadata.gz: 2850e23fb85b2512095416d5decdb7fb6462ca6837d7b3827ae2e4d0c91aef2632f720c23ca7b11af4d66676597e7290af3cf4a2a65055ac2ac2cf61ca453827
-  data.tar.gz: 03c7adf6eddd058429c3ebffadc455d8748610d7a5afa7d3c5c54b6d249696b2ad2c040b14f464bfeb89823d75b64a375e26f821ac0451649c17bd47cf4ccd4c
+  metadata.gz: 38e44afa51cb74149fb4b7aff68d958232f39d111bef8927835fc9bd012c8738ac0a4a4c175ab1bc9e7b2a846135a5f4ff5473845d562d45d408200e439abedf
+  data.tar.gz: 67cc5c58134b64955f65595f5b5797c72adbaa8dbe9e239fff0d434044e3a599c0eea4dd7418bbbb2834b9cd8f9e7572258f07a514f80c048508cfba408cd2d0

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

@@ -47,4 +47,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

@@ -24,12 +24,13 @@ require 'ruby-lokalise-api/rest/webhooks'
 module Lokalise
   class Client
     attr_reader :token
-    attr_accessor :timeout, :open_timeout
+    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)
     end
 
     # rubocop:disable Metrics/ParameterLists
@@ -56,7 +57,7 @@ module Lokalise
       return params unless object_key
 
       params = [params] unless params.is_a?(Array)
-      Hash[object_key, params]
+      {object_key => params}
     end
 
     alias c_r construct_request

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

@@ -5,7 +5,16 @@ 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}",
@@ -13,11 +22,8 @@ module Lokalise
         },
         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

@@ -86,7 +86,9 @@
     "translation_tier",
     "translation_tier_name",
     "briefing",
-    "total"
+    "total",
+    "payment_method",
+    "dry_run"
   ],
   "payment_card": [
     "card_id",
@@ -208,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/request.rb

@@ -58,7 +58,7 @@ 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')
+      respond_with_error response.status, body if response.status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
       extract_headers_from(response).
         merge('content' => body,
               'client' => client,
@@ -74,7 +74,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/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.0.0'
+  VERSION = '4.3.1'
 end

data/lib/ruby-lokalise-api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday_middleware'
 require 'yaml'
 require 'addressable'
 

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,12 @@ 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 '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 +46,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/orders_spec.rb

@@ -37,8 +37,8 @@ RSpec.describe Lokalise::Client do
 
     expect(order.order_id).to eq(order_id)
     expect(order.project_id).to eq(project_id)
-    expect(order.card_id).to eq(card_id.to_s)
-    expect(order.status).to eq('in progress')
+    expect(order.card_id).to eq(card_id)
+    expect(order.status).to eq('completed')
     expect(order.created_at).to eq('2019-03-19 18:18:21 (Etc/UTC)')
     expect(order.created_by).to eq(20_181)
     expect(order.created_by_email).to eq('bodrovis@protonmail.com')
@@ -52,6 +52,7 @@ RSpec.describe Lokalise::Client do
     expect(order.translation_tier_name).to eq('Professional translator')
     expect(order.briefing).to eq('Some briefing')
     expect(order.total).to eq(0.07)
+    expect(order.payment_method).to be_nil
   end
 
   specify '#reload_data' do
@@ -86,4 +87,27 @@ RSpec.describe Lokalise::Client do
     expect(order.order_id).to eq(order_id)
     expect(order.status).to eq('in progress')
   end
+
+  it 'creates an order with dry run' do
+    order = VCR.use_cassette('create_order_dry_run') do
+      test_client.create_order team_id,
+                               project_id: project_id,
+                               card_id: card_id,
+                               briefing: 'Some briefing',
+                               source_language_iso: 'en',
+                               target_language_isos: [
+                                 'ru'
+                               ],
+                               keys: [
+                                 74_189_435
+                               ],
+                               provider_slug: 'gengo',
+                               translation_tier: '1',
+                               dry_run: true
+    end
+
+    expect(order.order_id).to be_nil
+    expect(order.status).to eq('draft')
+    expect(order.dry_run).to be true
+  end
 end

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
@@ -29,5 +30,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.3.1
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-09-21 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
@@ -334,7 +348,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API
@@ -356,11 +370,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