ruby-lokalise-api 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0736dd816b0cc92d92a04277d86aaec283aa9d7f7be024c736e1a6b4c91531c
-  data.tar.gz: 725e7262b0a226db6ae1d20d856eaac895ee11f5b39df15b3167a6b0db1984ec
+  metadata.gz: 7d4e828a877250b7e76e2134f9d9bbc8e4749519d0adfcad12fbfa25f65b52a9
+  data.tar.gz: 4d8d9236940e3fdd0796b92b09544eab9565c9a41c2e16d589a8f30c07628e4d
 SHA512:
-  metadata.gz: 94f10e17e3290f76b95fef30acddc5ab448dd27c064ea6e306fe69af621e2e25e63ed51fa2f919c6421df1eeea6a230b414054c9ceb23fb120aaa7d587b1c192
-  data.tar.gz: 31d41d8735f06151825eed3db874156ef78bec552e44cb8de8dcdd761878373ed5b6a3c745b918d6474262e681f9166c0e0d551d416254436464248e92821d8e
+  metadata.gz: c1d6d1c7f192cd70a60c2f07b4fb70c16e9b7c3bfa1a3c0834eed9569c59f7dca38d042187a5a8b99122905ea0eb3adf7b574f8f41d85763d08b0d50ff03305e
+  data.tar.gz: 13dfc2c81e9057dd8ece7513f74d3d0d793040fa9755470f7167f1dd1724d93275a7c75f64ecabfc0da1d43c3ec86e5b9eca73ea87ba191188643b330899b282

data/lib/ruby-lokalise-api.rb

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

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

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lokalise
-  VERSION = '4.2.0'
+  VERSION = '4.3.0'
 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,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_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.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-07-15 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.15
+rubygems_version: 3.2.23
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API