ruby-lokalise-api 2.8.0 → 3.1.0

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all snapshots for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-snapshots-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-snapshots-get
     # @return [Lokalise::Collection::Snapshot<Lokalise::Resources::Snapshot>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Creates snapshot for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-snapshot-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-snapshot-post
     # @return [Lokalise::Resources::Snapshot]
     # @param project_id [String]
     # @param params [Hash]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Restore project from the given snapshot by producing project's copy
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-restore-a-snapshot-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-restore-a-snapshot-post
     # @return [Lokalise::Resources::Project]
     # @param project_id [String]
     # @param snapshot_id [String, Integer]
@@ -32,7 +34,7 @@ module Lokalise
 
     # Deletes snapshot
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-snapshot-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-snapshot-delete
     # @return [Hash]
     # @param project_id [String]
     # @param snapshot_id [String, Integer]

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all tasks for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-tasks-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-tasks-get
     # @return [Lokalise::Collection::Task<Lokalise::Resources::Task>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns a single task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-task-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-task-get
     # @return [Lokalise::Resources::Task]
     # @param project_id [String]
     # @param task_id [String, Integer]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Creates task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-task-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-task-post
     # @return [Lokalise::Resources::Task]
     # @param project_id [String]
     # @param params [Hash]
@@ -32,7 +34,7 @@ module Lokalise
 
     # Updates task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-task-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-task-put
     # @return [Lokalise::Resources::Task]
     # @param project_id [String]
     # @param task_id [String, Integer]
@@ -43,7 +45,7 @@ module Lokalise
 
     # Deletes task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-task-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-task-delete
     # @return [Hash]
     # @param project_id [String]
     # @param task_id [String, Integer]

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
@@ -60,7 +62,7 @@ module Lokalise
     def add_projects_to_group(team_id, group_id, project_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'projects', 'add'],
-          project_ids, :projects
+          project_ids, :projects, [team_id, group_id]
     end
 
     # Removes projects from the given group
@@ -73,7 +75,7 @@ module Lokalise
     def remove_projects_from_group(team_id, group_id, project_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'projects', 'remove'],
-          project_ids, :projects
+          project_ids, :projects, [team_id, group_id]
     end
 
     # Adds users to the given group
@@ -86,7 +88,7 @@ module Lokalise
     def add_users_to_group(team_id, group_id, users_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'members', 'add'],
-          users_ids, :users
+          users_ids, :users, [team_id, group_id]
     end
 
     # Removes users from the given group
@@ -99,7 +101,7 @@ module Lokalise
     def remove_users_from_group(team_id, group_id, users_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'members', 'remove'],
-          users_ids, :users
+          users_ids, :users, [team_id, group_id]
     end
   end
 end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all team users for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-team-users-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-team-users-get
     # @return [Lokalise::Collection::TeamUser<Lokalise::Resources::TeamUser>]
     # @param team_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns team user from the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-team-user-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-team-user-get
     # @return [Lokalise::Resources::TeamUser]
     # @param team_id [String]
     # @param user_id [String, Integer]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Updates team user for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-team-user-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-team-user-put
     # @return [Lokalise::Resources::TeamUser]
     # @param team_id [String]
     # @param user_id [String, Integer]
@@ -33,7 +35,7 @@ module Lokalise
 
     # Deletes team user from the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-team-user-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-team-user-delete
     # @return [Lokalise::Resources::TeamUser]
     # @param team_id [String]
     # @param user_id [String, Integer]

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all teams available to the user
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-teams-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-teams-get
     # @return [Lokalise::Collection::Team<Lokalise::Resources::Team>]
     # @param params [Hash]
     def teams(params = {})

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation providers for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-providers-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-providers-get
     # @return [Lokalise::Collection::TranslationProvider<Lokalise::Resources::TranslationProvider>]
     # @param team_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns a single translation provider for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-provider-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-provider-get
     # @return [Lokalise::Resources::TranslationProvider]
     # @param team_id [String]
     # @param provider_id [String, Integer]

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translations for the given project (ungrouped)
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-translations-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-translations-get
     # @return [Lokalise::Collection::Translation<Lokalise::Resources::Translation>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns translation of the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-translation-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-translation-get
     # @return [Lokalise::Resources::Translation]
     # @param project_id [String]
     # @param translation_id [String, Integer]
@@ -23,7 +25,7 @@ module Lokalise
 
     # Updates translation of the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-translation-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-translation-put
     # @return [Lokalise::Resources::Translation]
     # @param project_id [String]
     # @param translation_id [String, Integer]

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all webhooks for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-webhooks-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-webhooks-get
     # @return [Lokalise::Collection::Webhook<Lokalise::Resources::Webhook>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns a single webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-webhook-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-webhook-get
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Creates webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-webhook-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-webhook-post
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param params [Hash]
@@ -32,7 +34,7 @@ module Lokalise
 
     # Updates webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-webhook-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-webhook-put
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
@@ -43,12 +45,23 @@ module Lokalise
 
     # Deletes webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-webhook-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-webhook-delete
     # @return [Hash]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
     def destroy_webhook(project_id, webhook_id)
       c_r Lokalise::Resources::Webhook, :destroy, [project_id, webhook_id]
     end
+
+    # Regenerates secret for the given webhook
+    #
+    # @see https://lokalise.com/api2docs/curl/#transition-regenerate-a-webhook-secret-patch
+    # @return [Hash]
+    # @param project_id [String]
+    # @param webhook_id [String, Integer]
+    def regenerate_webhook_secret(project_id, webhook_id)
+      c_r Lokalise::Resources::Webhook, :regenerate_secret,
+          [project_id, webhook_id, 'secret', 'regenerate']
+    end
   end
 end

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 = '3.1.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|
@@ -10,7 +12,6 @@ Gem::Specification.new do |spec|
   spec.homepage              = 'https://github.com/lokalise/ruby-lokalise-api'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.4.0'
 
   spec.files = Dir['README.md', 'LICENSE',
                    'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby-lokalise-api/data/attributes.json',
@@ -21,14 +22,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',                          '>= 1.8.0'
 
+  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 '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-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'
+  spec.add_development_dependency 'vcr',                       '~> 6.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,21 @@
+# 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 'raises a generic error when the code is unknown' do
+    expect do
+      VCR.use_cassette('error_unknown_code') do
+        get 'projects', Lokalise.client('invalid')
+      end
+    end.to raise_error(described_class)
+  end
 
-  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 +23,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