ruby-lokalise-api 2.8.0 → 2.9.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class Translation < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class TranslationProvider < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class Webhook < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all branches for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns a single comment for the given key

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all contributors for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation statuses for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation files for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation keys for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all languages supported by Lokalise

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all orders for the given team

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all payment cards available to the user authorized with the API token

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all projects available to the user authorized with the API token

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all screenshots for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all snapshots for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all tasks for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all team user groups for the given team

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all team users for the given team

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all teams available to the user

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation providers for the given team

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translations for the given project (ungrouped)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all webhooks for the given project

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Utils
     module AttributeHelpers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Utils
     module EndpointHelpers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Initial code taken from Facets gem by Rubyworks
 # https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
-  VERSION = '2.8.0'.freeze
+  VERSION = '2.9.0'
 end

data/ruby-lokalise-api.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('lib/ruby-lokalise-api/version', __dir__)
 
 Gem::Specification.new do |spec|
@@ -21,14 +23,17 @@ Gem::Specification.new do |spec|
   spec.require_paths    = ['lib']
 
   spec.add_dependency 'addressable',                   '~> 2.5'
-  spec.add_dependency 'faraday',                       '~> 0.13'
+  spec.add_dependency 'faraday',                       '~> 1.0'
+  spec.add_dependency 'json',                          '~> 2.3'
 
+  spec.add_development_dependency 'codecov',                   '~> 0.1'
   spec.add_development_dependency 'dotenv',                    '~> 2.5'
   spec.add_development_dependency 'oj',                        '~> 3.8'
   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-performance',       '~> 1.0'
+  spec.add_development_dependency 'rubocop-performance',       '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec',             '~> 1.37'
   spec.add_development_dependency 'simplecov',                 '~> 0.16'
   spec.add_development_dependency 'vcr',                       '~> 5.0'
 end

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

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Connection do
   include described_class
 
-  before(:each) { Lokalise.reset_client! }
-  after(:all) do
+  before { Lokalise.reset_client! }
+
+  after do
     Lokalise.reset_client!
     Faraday.default_adapter = :net_http
   end
@@ -14,7 +17,7 @@ RSpec.describe Lokalise::Connection do
     expect(conn.headers['X-api-token']).to eq(test_client.token)
   end
 
-  it 'should allow to customize timeouts' do
+  it 'allows to customize timeouts' do
     custom_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'],
                                     open_timeout: 100, timeout: 500)
     conn = connection custom_client
@@ -29,14 +32,14 @@ RSpec.describe Lokalise::Connection do
     expect(another_conn.options.open_timeout).to eq(200)
   end
 
-  it 'should be possible to customize adapter' do
+  it 'is possible to customize adapter' do
     conn = connection test_client
-    expect(conn.builder.handlers).to include(Faraday::Adapter::NetHttp)
+    expect(conn.builder.adapter).to eq(Faraday::Adapter::NetHttp)
 
     Faraday.default_adapter = :excon
 
     another_conn = connection test_client
-    expect(another_conn.builder.handlers).to include(Faraday::Adapter::Excon)
-    expect(conn.builder.handlers).to include(Faraday::Adapter::NetHttp)
+    expect(another_conn.builder.adapter).to eq(Faraday::Adapter::Excon)
+    expect(conn.builder.adapter).to eq(Faraday::Adapter::NetHttp)
   end
 end

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

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'oj'
 
-RSpec.describe 'Custom JSON parser' do
+RSpec.describe Lokalise::JsonHandler do
   let(:loaded_json) do
     {'projects' => [{'project_id' => '547879415c01a0e6e0b855.29978928',
                      'name' => 'demo phoenix copy',
@@ -25,7 +27,8 @@ RSpec.describe 'Custom JSON parser' do
     '{":name":"rspec proj",":description":"demo project for rspec"}'
   end
 
-  before :all do
+  # rubocop:disable RSpec/LeakyConstantDeclaration
+  before do
     module Lokalise
       module JsonHandler
         def custom_dump(obj)
@@ -39,7 +42,7 @@ RSpec.describe 'Custom JSON parser' do
     end
   end
 
-  after :all do
+  after do
     module Lokalise
       module JsonHandler
         def custom_dump(obj)
@@ -52,8 +55,9 @@ RSpec.describe 'Custom JSON parser' do
       end
     end
   end
+  # rubocop:enable RSpec/LeakyConstantDeclaration
 
-  it 'should allow to customize #load' do
+  it 'allows to customize #load' do
     expect(Oj).to receive(:load).and_return(loaded_json)
     expect(JSON).not_to receive(:parse)
     projects = VCR.use_cassette('all_projects_pagination') do
@@ -65,7 +69,7 @@ RSpec.describe 'Custom JSON parser' do
     expect(projects.collection.first.name).to eq('demo phoenix copy')
   end
 
-  it 'should allow to customize #dump' do
+  it 'allows to customize #dump' do
     expect(Oj).to receive(:dump).and_return(dumped_json)
     expect(JSON).not_to receive(:dump)
     project = VCR.use_cassette('new_project') do

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

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Error do
   include Lokalise::Request
 
-  before(:each) { Lokalise.reset_client! }
-  after(:all) { Lokalise.reset_client! }
+  before { Lokalise.reset_client! }
+
+  after { Lokalise.reset_client! }
 
-  it 'should raise BadRequest when API token is invalid' do
+  it 'raises BadRequest when API token is invalid' do
     expect do
       VCR.use_cassette('error_invalid_token') do
         get 'projects', Lokalise.client('invalid')
@@ -12,7 +15,7 @@ RSpec.describe Lokalise::Error do
     end.to raise_error(Lokalise::Error::BadRequest)
   end
 
-  it 'should raise NotFound when the provided path cannot be found' do
+  it 'raises NotFound when the provided path cannot be found' do
     expect do
       VCR.use_cassette('error_not_found') do
         get 'invalid_path', test_client

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:branch_id) { 41_302 }
 
   describe '#branches' do
-    it 'should return all branches' do
+    it 'returns all branches' do
       branches = VCR.use_cassette('all_branches') do
         test_client.branches project_id
       end.collection
@@ -11,7 +13,7 @@ RSpec.describe Lokalise::Client do
       expect(branches.count).to eq(1)
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       branches = VCR.use_cassette('all_branches_pagination') do
         test_client.branches project_id, limit: 1, page: 1
       end
@@ -82,8 +84,8 @@ RSpec.describe Lokalise::Client do
     expect(response['branch']['name']).to eq(branch.name)
   end
 
-  context 'branch chained methods' do
-    it 'should support merge' do
+  context 'when branch methods are chained' do
+    it 'supports merge' do
       branch = VCR.use_cassette('create_branch_to_merge2') do
         test_client.create_branch project_id, name: 'merge-me-plz'
       end
@@ -102,7 +104,7 @@ RSpec.describe Lokalise::Client do
       expect(response['branch']['name']).to eq(branch.name)
     end
 
-    it 'should support update and destroy' do
+    it 'supports update and destroy' do
       branch = VCR.use_cassette('create_another_branch') do
         test_client.create_branch project_id, name: 'ruby-second-branch'
       end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:key_id) { 15_305_182 }
   let(:another_key_id) { 15_519_786 }
 
   describe '#comments' do
-    it 'should return all comments' do
+    it 'returns all comments' do
       comments = VCR.use_cassette('all_comments') do
         test_client.comments project_id, key_id
       end.collection
@@ -12,7 +14,7 @@ RSpec.describe Lokalise::Client do
       expect(comments.count).to eq(3)
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       comments = VCR.use_cassette('all_comments_pagination') do
         test_client.comments project_id, key_id, limit: 1, page: 2
       end
@@ -29,7 +31,7 @@ RSpec.describe Lokalise::Client do
       expect(comments.prev_page?).to eq(true)
       expect(comments.first_page?).to eq(false)
 
-      expect(comments.client).to be_an_instance_of(Lokalise::Client)
+      expect(comments.client).to be_an_instance_of(described_class)
     end
   end
 
@@ -85,8 +87,8 @@ RSpec.describe Lokalise::Client do
     expect(response['comment_deleted']).to eq(true)
   end
 
-  context 'comment chained methods' do
-    it 'should support destroy' do
+  context 'when comment methods are chained' do
+    it 'supports destroy' do
       comment = VCR.use_cassette('create_another_comment') do
         test_client.create_comments project_id, another_key_id, comment: 'chained comment'
       end.collection.first

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:contributor_id) { 25_953 }
 
   describe '#contributors' do
-    it 'should return all contributors' do
+    it 'returns all contributors' do
       contributors = VCR.use_cassette('all_contributors') do
         test_client.contributors project_id
       end.collection
@@ -12,7 +14,7 @@ RSpec.describe Lokalise::Client do
       expect(contributors.first.fullname).to eq('John Doe')
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       contributors = VCR.use_cassette('all_contributors_pagination') do
         test_client.contributors project_id, limit: 1, page: 2
       end
@@ -83,8 +85,8 @@ RSpec.describe Lokalise::Client do
     expect(response['contributor_deleted']).to eq(true)
   end
 
-  context 'contributor chained methods' do
-    it 'should support update and destroy' do
+  context 'when contributor methods are chained' do
+    it 'supports update and destroy' do
       contributor = VCR.use_cassette('create_another_contributor') do
         test_client.create_contributors project_id,
                                         email: 'demo@test.com',

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:status_id) { 128 }
   let(:new_status_id) { 126 }
 
   describe '#translation_statuses' do
-    it 'should return all statuses' do
+    it 'returns all statuses' do
       statuses = VCR.use_cassette('all_translation_statuses') do
         test_client.translation_statuses project_id
       end.collection
@@ -13,7 +15,7 @@ RSpec.describe Lokalise::Client do
       expect(statuses.first.status_id).to eq(status_id)
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       statuses = VCR.use_cassette('all_translation_statuses_pagination') do
         test_client.translation_statuses project_id, limit: 1, page: 2
       end
@@ -85,8 +87,8 @@ RSpec.describe Lokalise::Client do
     expect(response).to include('#f2d600')
   end
 
-  context 'translation status chained methods' do
-    it 'should support update and destroy' do
+  context 'when translation status methods are chained' do
+    it 'supports update and destroy' do
       status = VCR.use_cassette('create_another_translation_status') do
         test_client.create_translation_status project_id,
                                               title: 'rspec',