ruby-lokalise-api 4.3.1 → 5.0.0

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '39066161618d4ecb9fdc12.00274309' }
+  let(:key_id) { 129_358_815 }
+
+  describe '#segments' do
+    it 'returns all segments for a key under lang_iso' do
+      segments = VCR.use_cassette('all_key_segments') do
+        test_client.segments project_id, key_id, 'en'
+      end.collection
+
+      expect(segments.count).to eq(4)
+      expect(segments.first.value).to eq('Hello!')
+    end
+  end
+
+  describe '#segment' do
+    it 'returns a single segment' do
+      lang_iso = 'en'
+      segment_number = 2
+
+      segment = VCR.use_cassette('key_segment') do
+        test_client.segment project_id, key_id, lang_iso, segment_number
+      end
+
+      expect(segment.key_id).to eq(key_id)
+      expect(segment.segment_number).to eq(segment_number)
+      expect(segment.language_iso).to eq(lang_iso)
+      expect(segment.modified_at).to eq('2021-11-22 16:46:50 (Etc/UTC)')
+      expect(segment.modified_at_timestamp).to eq(1_637_599_610)
+      expect(segment.modified_by).to eq(20_181)
+      expect(segment.modified_by_email).to eq('bodrovis@protonmail.com')
+      expect(segment.value).to eq('This is just a simple text.')
+      expect(segment.is_fuzzy).to eq(false)
+      expect(segment.is_reviewed).to eq(false)
+      expect(segment.reviewed_by).to eq(0)
+      expect(segment.words).to eq(6)
+      expect(segment.custom_translation_statuses.first['color']).to eq('#61bd4f')
+    end
+
+    it 'allows to pass params' do
+      lang_iso = 'en'
+      segment_number = 2
+
+      segment = VCR.use_cassette('key_segment_params') do
+        test_client.segment project_id, key_id, lang_iso, segment_number, disable_references: '1'
+      end
+
+      expect(segment.segment_number).to eq(segment_number)
+      expect(segment.value).to eq('This is just a simple text.')
+      expect(segment.language_iso).to eq(lang_iso)
+    end
+  end
+
+  specify '#update_segment' do
+    lang_iso = 'en'
+    segment_number = 3
+
+    segment = VCR.use_cassette('update_key_segment') do
+      test_client.update_segment project_id, key_id, lang_iso, segment_number,
+                                 value: 'Updated via API',
+                                 is_reviewed: true
+    end
+
+    expect(segment.segment_number).to eq(segment_number)
+    expect(segment.value).to eq('Updated via API')
+    expect(segment.language_iso).to eq(lang_iso)
+  end
+
+  context 'when segment methods are chained' do
+    specify '#reload_data' do
+      lang_iso = 'en'
+      segment_number = 2
+
+      segment = VCR.use_cassette('key_segment') do
+        test_client.segment project_id, key_id, lang_iso, segment_number
+      end
+
+      reloaded_segment = VCR.use_cassette('reload_key_segment') do
+        segment.reload_data
+      end
+
+      expect(reloaded_segment.segment_number).to eq(segment_number)
+      expect(reloaded_segment.key_id).to eq(key_id)
+    end
+
+    specify '#update' do
+      lang_iso = 'en'
+      segment_number = 4
+
+      segment = VCR.use_cassette('another_key_segment') do
+        test_client.segment project_id, key_id, lang_iso, segment_number
+      end
+
+      updated_segment = VCR.use_cassette('update_key_segment_chained') do
+        segment.update value: 'Chain Updated',
+                       is_fuzzy: true
+      end
+
+      expect(updated_segment.segment_number).to eq(segment_number)
+      expect(updated_segment.is_fuzzy).to eq(true)
+      expect(updated_segment.value).to eq('Chain Updated')
+    end
+  end
+end

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

@@ -81,7 +81,7 @@ RSpec.describe Lokalise::Client do
         new_project.update name: 'Restored and updated'
       end
 
-      expect(updated_project.client).to eq(test_client)
+      expect(updated_project.client.token).to eq(test_client.token)
       expect(updated_project.name).to eq('Restored and updated')
       expect(updated_project.project_id).to eq(new_project.project_id)
 

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

@@ -120,7 +120,7 @@ RSpec.describe Lokalise::Client do
                                             ]
       end
 
-      expect(task.client).to eq(test_client)
+      expect(task.client.token).to eq(test_client.token)
       expect(task.title).to eq('chained')
 
       path = task.path
@@ -129,7 +129,7 @@ RSpec.describe Lokalise::Client do
         task.update title: 'updated!'
       end
 
-      expect(updated_task.client).to eq(test_client)
+      expect(updated_task.client.token).to eq(test_client.token)
       expect(updated_task.title).to eq('updated!')
       expect(updated_task.task_id).to eq(task.task_id)
       expect(updated_task.path).to eq(path)

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+RSpec.describe Lokalise::Client do
+  let(:team_id) { 176_692 }
+  let(:team_id2) { 273_879 }
+
+  specify '#team_user_billing_details' do
+    details = VCR.use_cassette('team_user_billing_details') do
+      test_client.team_user_billing_details team_id
+    end
+
+    expect(details.billing_email).to eq('hello@example.com')
+    expect(details.country_code).to eq('LV')
+    expect(details.zip).to eq('LV-6543')
+    expect(details.state_code).to eq('')
+    expect(details.address1).to eq('Sample line 1')
+    expect(details.address2).to eq('Sample line 2')
+    expect(details.city).to eq('Riga')
+    expect(details.phone).to eq('+371123456')
+    expect(details.company).to eq('Self-employed')
+    expect(details.vatnumber).to eq('123')
+  end
+
+  specify '#create_team_user_billing_details' do
+    details = VCR.use_cassette('create_team_user_billing_details') do
+      test_client.create_team_user_billing_details team_id2, billing_email: 'ruby@example.com',
+                                                             country_code: 'LV',
+                                                             zip: 'LV-1111'
+    end
+
+    expect(details.billing_email).to eq('ruby@example.com')
+    expect(details.country_code).to eq('LV')
+    expect(details.address1).to eq('')
+  end
+
+  specify '#update_team_user_billing_details' do
+    details = VCR.use_cassette('update_team_user_billing_details') do
+      test_client.update_team_user_billing_details team_id2, billing_email: 'ruby_rspec@example.com',
+                                                             country_code: 'LV',
+                                                             zip: 'LV-1111',
+                                                             address1: 'Addr line 1'
+    end
+
+    expect(details.billing_email).to eq('ruby_rspec@example.com')
+    expect(details.country_code).to eq('LV')
+    expect(details.address1).to eq('Addr line 1')
+  end
+end

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

@@ -81,7 +81,7 @@ RSpec.describe Lokalise::Client do
         team_user.update role: 'admin'
       end
 
-      expect(updated_team_user.client).to eq(test_client)
+      expect(updated_team_user.client.token).to eq(test_client.token)
       expect(updated_team_user.role).to eq('admin')
 
       delete_response = VCR.use_cassette('delete_team_user_chained') do

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

@@ -110,7 +110,7 @@ RSpec.describe Lokalise::Client do
         translation.update translation: 'chained updated'
       end
 
-      expect(updated_translation.client).to eq(test_client)
+      expect(updated_translation.client.token).to eq(test_client.token)
       expect(updated_translation.translation).to eq('chained updated')
       expect(updated_translation.translation_id).to eq(translation.translation_id)
     end

data/spec/lib/ruby-lokalise-api_spec.rb

@@ -6,16 +6,29 @@ 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
     expect(test_client).to be_an_instance_of(Lokalise::Client)
     described_class.reset_client!
-    current_client = described_class.instance_variable_get '@client'
+    current_client = described_class.instance_variable_get :@client
     expect(current_client).to be_nil
   end
 
+  specify '.oauth2_client' do
+    expect(test_oauth2_client).to be_an_instance_of(Lokalise::OAuth2Client)
+    expect(test_oauth2_client.token).to eq("Bearer #{ENV['OAUTH2_TOKEN']}")
+    expect(test_oauth2_client.timeout).to be_nil
+    expect(test_oauth2_client.open_timeout).to be_nil
+  end
+
+  specify '.reset_oauth2_client!' do
+    expect(test_oauth2_client).to be_an_instance_of(Lokalise::OAuth2Client)
+    described_class.reset_oauth2_client!
+    current_oauth_client = described_class.instance_variable_get :@oauth2_client
+    expect(current_oauth_client).to be_nil
+  end
+
   context 'with client params' do
     before { described_class.reset_client! }
 
@@ -30,10 +43,5 @@ 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

data/spec/support/test_client.rb

@@ -4,4 +4,12 @@ module TestClient
   def test_client(token = nil, params = {})
     Lokalise.client(token || ENV['LOKALISE_API_TOKEN'], params)
   end
+
+  def test_oauth2_client(token = nil, params = {})
+    Lokalise.oauth2_client(token || ENV['OAUTH2_TOKEN'], params)
+  end
+
+  def auth_client
+    Lokalise.auth_client(ENV['OAUTH2_CLIENT_ID'], ENV['OAUTH2_CLIENT_SECRET'])
+  end
 end

data/spec/support/vcr.rb

@@ -7,4 +7,9 @@ VCR.configure do |c|
   c.hook_into :faraday
   c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'vcr_cassettes')
   c.filter_sensitive_data('<LOKALISE_TOKEN>') { ENV.fetch('LOKALISE_API_TOKEN') }
+  c.filter_sensitive_data('<OAUTH2_CLIENT_ID>') { ENV.fetch('OAUTH2_CLIENT_ID') }
+  c.filter_sensitive_data('<OAUTH2_CLIENT_SECRET>') { ENV.fetch('OAUTH2_CLIENT_SECRET') }
+  c.filter_sensitive_data('<OAUTH2_TOKEN>') { ENV.fetch('OAUTH2_TOKEN') }
+  c.filter_sensitive_data('<OAUTH2_CODE>') { ENV.fetch('OAUTH2_CODE') }
+  c.filter_sensitive_data('<OAUTH2_REFRESH_TOKEN>') { ENV.fetch('OAUTH2_REFRESH_TOKEN') }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 5.0.0
 platform: ruby
 authors:
-- Ilya Bodrov
+- Ilya Bodrov-Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-gzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -224,6 +224,7 @@ files:
 - README.md
 - Rakefile
 - lib/ruby-lokalise-api.rb
+- lib/ruby-lokalise-api/base_request.rb
 - lib/ruby-lokalise-api/client.rb
 - lib/ruby-lokalise-api/collections/base.rb
 - lib/ruby-lokalise-api/collections/branch.rb
@@ -239,6 +240,7 @@ files:
 - lib/ruby-lokalise-api/collections/project_language.rb
 - lib/ruby-lokalise-api/collections/queued_process.rb
 - lib/ruby-lokalise-api/collections/screenshot.rb
+- lib/ruby-lokalise-api/collections/segment.rb
 - lib/ruby-lokalise-api/collections/snapshot.rb
 - lib/ruby-lokalise-api/collections/system_language.rb
 - lib/ruby-lokalise-api/collections/task.rb
@@ -252,6 +254,10 @@ files:
 - lib/ruby-lokalise-api/data/attributes.json
 - lib/ruby-lokalise-api/error.rb
 - lib/ruby-lokalise-api/json_handler.rb
+- lib/ruby-lokalise-api/oauth2/auth.rb
+- lib/ruby-lokalise-api/oauth2/connection.rb
+- lib/ruby-lokalise-api/oauth2/request.rb
+- lib/ruby-lokalise-api/oauth2_client.rb
 - lib/ruby-lokalise-api/request.rb
 - lib/ruby-lokalise-api/resources/base.rb
 - lib/ruby-lokalise-api/resources/branch.rb
@@ -267,11 +273,13 @@ files:
 - lib/ruby-lokalise-api/resources/project_language.rb
 - lib/ruby-lokalise-api/resources/queued_process.rb
 - lib/ruby-lokalise-api/resources/screenshot.rb
+- lib/ruby-lokalise-api/resources/segment.rb
 - lib/ruby-lokalise-api/resources/snapshot.rb
 - lib/ruby-lokalise-api/resources/system_language.rb
 - lib/ruby-lokalise-api/resources/task.rb
 - lib/ruby-lokalise-api/resources/team.rb
 - lib/ruby-lokalise-api/resources/team_user.rb
+- lib/ruby-lokalise-api/resources/team_user_billing_details.rb
 - lib/ruby-lokalise-api/resources/team_user_group.rb
 - lib/ruby-lokalise-api/resources/translation.rb
 - lib/ruby-lokalise-api/resources/translation_provider.rb
@@ -288,8 +296,10 @@ files:
 - lib/ruby-lokalise-api/rest/projects.rb
 - lib/ruby-lokalise-api/rest/queued_processes.rb
 - lib/ruby-lokalise-api/rest/screenshots.rb
+- lib/ruby-lokalise-api/rest/segments.rb
 - lib/ruby-lokalise-api/rest/snapshots.rb
 - lib/ruby-lokalise-api/rest/tasks.rb
+- lib/ruby-lokalise-api/rest/team_user_billing_details.rb
 - lib/ruby-lokalise-api/rest/team_user_group.rb
 - lib/ruby-lokalise-api/rest/team_users.rb
 - lib/ruby-lokalise-api/rest/teams.rb
@@ -304,6 +314,7 @@ files:
 - spec/lib/ruby-lokalise-api/connection_spec.rb
 - spec/lib/ruby-lokalise-api/custom_json_parser_spec.rb
 - spec/lib/ruby-lokalise-api/error_spec.rb
+- spec/lib/ruby-lokalise-api/oauth2/auth_spec.rb
 - spec/lib/ruby-lokalise-api/rest/branches_spec.rb
 - spec/lib/ruby-lokalise-api/rest/comments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/contributors_spec.rb
@@ -316,15 +327,16 @@ files:
 - spec/lib/ruby-lokalise-api/rest/projects_spec.rb
 - spec/lib/ruby-lokalise-api/rest/queued_processes_spec.rb
 - spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/segments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb
 - spec/lib/ruby-lokalise-api/rest/tasks_spec.rb
+- spec/lib/ruby-lokalise-api/rest/team_user_billing_details_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_user_groups_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
 - spec/lib/ruby-lokalise-api/rest/teams_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translation_providers_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translations_spec.rb
 - spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb
-- spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
 - spec/lib/ruby-lokalise-api_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_client.rb
@@ -332,7 +344,8 @@ files:
 homepage: https://github.com/lokalise/ruby-lokalise-api
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -348,7 +361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API
@@ -356,6 +369,7 @@ test_files:
 - spec/lib/ruby-lokalise-api/connection_spec.rb
 - spec/lib/ruby-lokalise-api/custom_json_parser_spec.rb
 - spec/lib/ruby-lokalise-api/error_spec.rb
+- spec/lib/ruby-lokalise-api/oauth2/auth_spec.rb
 - spec/lib/ruby-lokalise-api/rest/branches_spec.rb
 - spec/lib/ruby-lokalise-api/rest/comments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/contributors_spec.rb
@@ -368,15 +382,16 @@ test_files:
 - spec/lib/ruby-lokalise-api/rest/projects_spec.rb
 - spec/lib/ruby-lokalise-api/rest/queued_processes_spec.rb
 - spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/segments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb
 - spec/lib/ruby-lokalise-api/rest/tasks_spec.rb
+- spec/lib/ruby-lokalise-api/rest/team_user_billing_details_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_user_groups_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
 - spec/lib/ruby-lokalise-api/rest/teams_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translation_providers_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translations_spec.rb
 - spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb
-- spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
 - spec/lib/ruby-lokalise-api_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_client.rb

data/spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe String do
-  let(:snake_result) { 'snake_case' }
-  let(:bc_result) { 'Klass' }
-
-  specify '#snakecase' do
-    expect('SnakeCase'.snakecase).to eq snake_result
-    expect('Snake-Case'.snakecase).to eq snake_result
-    expect('Snake Case'.snakecase).to eq snake_result
-    expect('Snake  -  Case'.snakecase).to eq snake_result
-  end
-
-  specify '#base_class_name' do
-    expect('Namespace::Nested::Klass'.base_class_name).to eq bc_result
-    expect('Nested::Klass'.base_class_name).to eq bc_result
-    expect('Klass'.base_class_name).to eq bc_result
-  end
-end