ruby-lokalise-api 3.1.0 → 4.0.0

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/data/attributes.json

@@ -162,6 +162,7 @@
     "languages",
     "auto_close_languages",
     "auto_close_task",
+    "auto_close_items",
     "completed_at",
     "completed_at_timestamp",
     "completed_by",

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/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,7 +40,7 @@ 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
@@ -52,7 +57,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lokalise
-  VERSION = '3.1.0'
+  VERSION = '4.0.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',
@@ -30,9 +31,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/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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Ilya Bodrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -317,9 +317,9 @@ files:
 - spec/support/vcr.rb
 homepage: https://github.com/lokalise/ruby-lokalise-api
 licenses:
-- MIT
+- BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -327,15 +327,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API
 test_files: