ruby-lokalise-api 3.1.0 → 4.3.0

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
@@ -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/collections/base.rb

@@ -91,7 +91,7 @@ module Lokalise
       # Collection example: `{ "content": {"comments": [ ... ]} }`
       def produce_collection_for(response)
         model_class = self.class.name.base_class_name
-        data_key_plural = data_key_for model_class, true, true
+        data_key_plural = data_key_for model_class: model_class, plural: true, collection: true
 
         # Fetch collection data and instantiate an individual resource for each object
         # We also preserve the `client` to be able to chain API methods later

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",
@@ -162,6 +164,7 @@
     "languages",
     "auto_close_languages",
     "auto_close_task",
+    "auto_close_items",
     "completed_at",
     "completed_at_timestamp",
     "completed_by",
@@ -207,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/resources/base.rb

@@ -95,7 +95,7 @@ module Lokalise
         # Instantiates a new resource or collection based on the given response
         def object_from(response, params)
           model_class = name.base_class_name
-          data_key_plural = data_key_for model_class, true
+          data_key_plural = data_key_for model_class: model_class, plural: true
           # Preserve the initial path to allow chaining
           response['path'] = params.delete(:_initial_path) if params.key?(:_initial_path)
 
@@ -107,7 +107,7 @@ module Lokalise
         end
 
         def produce_resource(model_class, response)
-          data_key_singular = data_key_for model_class
+          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
@@ -124,7 +124,7 @@ module Lokalise
       # Generates path for the individual resource based on the path for the collection
       def infer_path_from(response, endpoint_generator = nil)
         id_key = id_key_for self.class.name.base_class_name
-        data_key = data_key_for self.class.name.base_class_name
+        data_key = data_key_for model_class: self.class.name.base_class_name
 
         path_with_id response, id_key, data_key, endpoint_generator
       end
@@ -164,7 +164,7 @@ module Lokalise
       # Store all resources attributes under the corresponding instance variables.
       # `ATTRIBUTES` is defined inside resource-specific classes
       def populate_attributes_for(content)
-        data_key = data_key_for self.class.name.base_class_name
+        data_key = data_key_for model_class: self.class.name.base_class_name
 
         self.class.const_get(:ATTRIBUTES).each do |attr|
           value = if content.key?(data_key) && content[data_key].is_a?(Hash)

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

@@ -6,7 +6,7 @@ module Lokalise
       supports :update, :destroy, [:reload_data, '', :find]
 
       def empty
-        self.class.empty @client, @path + '/empty'
+        self.class.empty @client, "#{@path}/empty"
       end
 
       class << self

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

@@ -6,7 +6,7 @@ module Lokalise
       supports :update, :destroy, [:reload_data, '', :find]
 
       def regenerate_secret
-        self.class.regenerate_secret @client, @path + '/secret/regenerate'
+        self.class.regenerate_secret @client, "#{@path}/secret/regenerate"
       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

@@ -16,16 +16,21 @@ module Lokalise
       # @return [String]
       # @param model_class [String]
       # @param plural [Boolean] Should the returned value be pluralized?
-      def data_key_for(model_class, plural = false, collection = false)
-        data_key_plural = get_key('DATA_KEY_PLURAL', model_class, true, true)
+      def data_key_for(model_class:, plural: false, collection: false)
+        data_key_plural = get_key(
+          name: 'DATA_KEY_PLURAL',
+          model_class: model_class,
+          collection: true,
+          strict: true
+        )
 
         return data_key_plural if collection && data_key_plural
 
-        data_key = get_key 'DATA_KEY', model_class, collection
+        data_key = get_key name: 'DATA_KEY', model_class: model_class, collection: collection
 
         return data_key unless plural
 
-        data_key + 's'
+        "#{data_key}s"
       end
 
       # Returns key used to determine resource id (for example `user_id` or `project_id`).
@@ -35,16 +40,14 @@ module Lokalise
       # @return [String]
       # @param model_class [String]
       def id_key_for(model_class)
-        get_key('ID_KEY', model_class) + '_id'
+        "#{get_key(name: 'ID_KEY', model_class: model_class)}_id"
       end
 
       # Loads attributes for the given resource based on its name
       #
       # @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]
@@ -52,7 +55,7 @@ module Lokalise
 
       private
 
-      def get_key(name, model_class, collection = false, strict = false)
+      def get_key(name:, model_class:, collection: false, strict: false)
         key = if collection && Module.const_defined?("Lokalise::Collections::#{model_class}::#{name}")
                 Module.const_get "Lokalise::Collections::#{model_class}::#{name}"
               elsif Module.const_defined? "Lokalise::Resources::#{model_class}::#{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 = '3.1.0'
+  VERSION = '4.3.0'
 end

data/ruby-lokalise-api.gemspec

@@ -10,8 +10,9 @@ Gem::Specification.new do |spec|
   spec.summary               = 'Ruby interface to the Lokalise API'
   spec.description           = 'Opinionated Ruby client for the Lokalise platform API allowing to work with translations, projects, users and other resources as with Ruby objects.'
   spec.homepage              = 'https://github.com/lokalise/ruby-lokalise-api'
-  spec.license               = 'MIT'
+  spec.license               = 'BSD-3-Clause'
   spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files = Dir['README.md', 'LICENSE',
                    'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby-lokalise-api/data/attributes.json',
@@ -23,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'
@@ -30,9 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'oj',                        '~> 3.10'
   spec.add_development_dependency 'rake',                      '~> 13.0'
   spec.add_development_dependency 'rspec',                     '~> 3.6'
-  spec.add_development_dependency 'rubocop',                   '~> 0.60'
+  spec.add_development_dependency 'rubocop',                   '~> 1.6'
   spec.add_development_dependency 'rubocop-performance',       '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec',             '~> 1.37'
+  spec.add_development_dependency 'rubocop-rspec',             '~> 2.0'
   spec.add_development_dependency 'simplecov',                 '~> 0.16'
   spec.add_development_dependency 'vcr',                       '~> 6.0'
 end

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

@@ -27,7 +27,7 @@ RSpec.describe Lokalise::JsonHandler do
     '{":name":"rspec proj",":description":"demo project for rspec"}'
   end
 
-  # rubocop:disable RSpec/LeakyConstantDeclaration
+  # rubocop:disable RSpec/LeakyConstantDeclaration, Lint/ConstantDefinitionInBlock
   before do
     module Lokalise
       module JsonHandler
@@ -55,10 +55,10 @@ RSpec.describe Lokalise::JsonHandler do
       end
     end
   end
-  # rubocop:enable RSpec/LeakyConstantDeclaration
+  # rubocop:enable RSpec/LeakyConstantDeclaration, Lint/ConstantDefinitionInBlock
 
   it 'allows to customize #load' do
-    expect(Oj).to receive(:load).and_return(loaded_json)
+    allow(Oj).to receive(:load).and_return(loaded_json)
     expect(JSON).not_to receive(:parse)
     projects = VCR.use_cassette('all_projects_pagination') do
       test_client.projects limit: 1, page: 2
@@ -70,7 +70,7 @@ RSpec.describe Lokalise::JsonHandler do
   end
 
   it 'allows to customize #dump' do
-    expect(Oj).to receive(:dump).and_return(dumped_json)
+    allow(Oj).to receive(:dump).and_return(dumped_json)
     expect(JSON).not_to receive(:dump)
     project = VCR.use_cassette('new_project') do
       test_client.create_project name: 'rspec proj', description: 'demo project for rspec'

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

@@ -36,9 +36,9 @@ RSpec.describe Lokalise::Client do
   specify '#create_payment_card' do
     card = VCR.use_cassette('new_payment_card') do
       test_client.create_payment_card number: '4242424242424242',
-                                      "cvc": '123',
-                                      "exp_month": 1,
-                                      "exp_year": 2030
+                                      cvc: '123',
+                                      exp_month: 1,
+                                      exp_year: 2030
     end
 
     expect(card.card_id).to eq(card_id)

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

@@ -35,8 +35,8 @@ RSpec.describe Lokalise::Client do
     expect(task.task_id).to eq(11_925)
     expect(task.title).to eq('node updated')
     expect(task.description).to eq('')
-    expect(task.status).to eq('in progress')
-    expect(task.progress).to eq(1)
+    expect(task.status).to eq('completed')
+    expect(task.progress).to eq(0)
     expect(task.due_date).to eq(nil)
     expect(task.due_date_timestamp).to eq(nil)
     expect(task.keys_count).to eq(16)
@@ -45,17 +45,18 @@ RSpec.describe Lokalise::Client do
     expect(task.created_at_timestamp).to eq(1_557_764_126)
     expect(task.created_by).to eq(20_181)
     expect(task.created_by_email).to eq('bodrovis@protonmail.com')
-    expect(task.can_be_parent).to eq(true)
+    expect(task.can_be_parent).to eq(false)
     expect(task.task_type).to eq('review')
     expect(task.parent_task_id).to eq(nil)
     expect(task.closing_tags).to eq([])
     expect(task.languages.first['language_iso']).to eq('sq')
     expect(task.auto_close_languages).to eq(true)
     expect(task.auto_close_task).to eq(true)
-    expect(task.completed_by).to eq(nil)
-    expect(task.completed_by_email).to eq(nil)
-    expect(task.completed_at).to eq(nil)
-    expect(task.completed_at_timestamp).to eq(nil)
+    expect(task.auto_close_items).to eq(true)
+    expect(task.completed_by).to eq(20_181)
+    expect(task.completed_by_email).to eq('bodrovis@protonmail.com')
+    expect(task.completed_at).to eq('2019-10-01 11:09:12 (Etc/UTC)')
+    expect(task.completed_at_timestamp).to eq(1_569_928_152)
     expect(task.do_lock_translations).to eq(false)
     expect(task.custom_translation_status_ids).to eq([])
   end