ruby-lokalise-api 4.5.0 → 6.0.0

data/spec/lib/{ruby-lokalise-api/rest → ruby_lokalise_api/client}/team_user_groups_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Lokalise::Client do
+RSpec.describe RubyLokaliseApi::Client do
   let(:team_id) { 176_692 }
   let(:group_id) { 515 }
   let(:second_group_id) { 690 }
@@ -39,7 +39,7 @@ RSpec.describe Lokalise::Client do
 
     expect(group.group_id).to eq(group_id)
     expect(group.name).to eq('Demo')
-    expect(group.permissions['is_admin']).to eq(true)
+    expect(group.permissions['is_admin']).to be(true)
     expect(group.created_at).to eq('2019-03-19 19:53:04 (Etc/UTC)')
     expect(group.created_at_timestamp).to eq(1_553_025_184)
     expect(group.team_id).to eq(team_id)
@@ -81,8 +81,8 @@ RSpec.describe Lokalise::Client do
 
     expect(group.name).to eq('updated rspec')
     expect(group.team_id).to eq(team_id)
-    expect(group.permissions['is_admin']).to eq(true)
-    expect(group.permissions['is_reviewer']).to eq(true)
+    expect(group.permissions['is_admin']).to be(true)
+    expect(group.permissions['is_reviewer']).to be(true)
   end
 
   specify '#destroy_team_user_group' do
@@ -90,7 +90,7 @@ RSpec.describe Lokalise::Client do
       test_client.destroy_team_user_group team_id, second_group_id
     end
     expect(response['team_id']).to eq(team_id)
-    expect(response['group_deleted']).to eq(true)
+    expect(response['group_deleted']).to be(true)
   end
 
   specify '#add_projects_to_group' do
@@ -184,7 +184,7 @@ RSpec.describe Lokalise::Client do
       end
 
       expect(group.group_id).to eq(third_group_id)
-      expect(group.permissions['is_admin']).to eq(true)
+      expect(group.permissions['is_admin']).to be(true)
       expect(group.name).to eq('another group updated')
 
       response = VCR.use_cassette('destroy_another_team_user_group') do
@@ -192,7 +192,7 @@ RSpec.describe Lokalise::Client do
       end
 
       expect(response['team_id']).to eq(team_id)
-      expect(response['group_deleted']).to eq(true)
+      expect(response['group_deleted']).to be(true)
     end
 
     it 'supports project management' do

data/spec/lib/{ruby-lokalise-api/rest → ruby_lokalise_api/client}/team_users_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Lokalise::Client do
+RSpec.describe RubyLokaliseApi::Client do
   let(:team_id) { 176_692 }
   let(:team_user_id) { 25_953 }
   let(:another_user_id) { 26_265 }
@@ -68,7 +68,7 @@ RSpec.describe Lokalise::Client do
       test_client.destroy_team_user team_id, team_user_id
     end
     expect(response['team_id']).to eq(team_id)
-    expect(response['team_user_deleted']).to eq(true)
+    expect(response['team_user_deleted']).to be(true)
   end
 
   context 'when team user methods are chained' do
@@ -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
@@ -89,7 +89,7 @@ RSpec.describe Lokalise::Client do
       end
 
       expect(delete_response['team_id']).to eq(team_id)
-      expect(delete_response['team_user_deleted']).to eq(true)
+      expect(delete_response['team_user_deleted']).to be(true)
     end
   end
 end

data/spec/lib/{ruby-lokalise-api/rest → ruby_lokalise_api/client}/teams_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Lokalise::Client do
+RSpec.describe RubyLokaliseApi::Client do
   specify '#teams' do
     teams = VCR.use_cassette('teams') do
       test_client.teams page: 2, limit: 1

data/spec/lib/{ruby-lokalise-api/rest → ruby_lokalise_api/client}/translation_providers_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Lokalise::Client do
+RSpec.describe RubyLokaliseApi::Client do
   let(:team_id) { 176_692 }
 
   describe '#translation_providers' do
@@ -36,7 +36,7 @@ RSpec.describe Lokalise::Client do
     expect(provider.slug).to eq('gengo')
     expect(provider.price_pair_min).to eq('0.00')
     expect(provider.website_url).to eq('https://gengo.com')
-    expect(provider.description.start_with?('At')).to eq(true)
+    expect(provider.description.start_with?('At')).to be(true)
     expect(provider.tiers.first['title']).to eq('Native speaker')
     expect(provider.pairs.first['price_per_word']).to eq('0.05')
 

data/spec/lib/{ruby-lokalise-api/rest → ruby_lokalise_api/client}/translations_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Lokalise::Client do
+RSpec.describe RubyLokaliseApi::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:translation_id) { 80_015_147 }
   let(:another_translation_id) { 82_070_312 }
@@ -33,27 +33,27 @@ RSpec.describe Lokalise::Client do
         translations.next_page
       end
 
-      expect(next_page_trans).to be_an_instance_of(Lokalise::Collections::Translation)
+      expect(next_page_trans).to be_an_instance_of(RubyLokaliseApi::Collections::Translation)
       expect(next_page_trans.client).to be_an_instance_of(described_class)
       expect(next_page_trans.request_params[:page]).to eq(3)
       expect(next_page_trans.request_params[:disable_references]).to eq(0)
       expect(next_page_trans.total_results).to eq(187)
       expect(next_page_trans.current_page).to eq(3)
-      expect(next_page_trans.next_page?).to eq(true)
-      expect(next_page_trans.prev_page?).to eq(true)
+      expect(next_page_trans.next_page?).to be(true)
+      expect(next_page_trans.prev_page?).to be(true)
 
       prev_page_trans = VCR.use_cassette('translations_prev_page') do
         translations.prev_page
       end
 
-      expect(prev_page_trans).to be_an_instance_of(Lokalise::Collections::Translation)
+      expect(prev_page_trans).to be_an_instance_of(RubyLokaliseApi::Collections::Translation)
       expect(prev_page_trans.client).to be_an_instance_of(described_class)
       expect(prev_page_trans.request_params[:page]).to eq(1)
       expect(next_page_trans.request_params[:disable_references]).to eq(0)
       expect(prev_page_trans.total_results).to eq(187)
       expect(prev_page_trans.current_page).to eq(1)
-      expect(prev_page_trans.next_page?).to eq(true)
-      expect(prev_page_trans.prev_page?).to eq(false)
+      expect(prev_page_trans.next_page?).to be(true)
+      expect(prev_page_trans.prev_page?).to be(false)
     end
   end
 
@@ -70,8 +70,8 @@ RSpec.describe Lokalise::Client do
     expect(translation.modified_by).to eq(20_181)
     expect(translation.modified_by_email).to eq('bodrovis@protonmail.com')
     expect(translation.translation).to eq('Сообщение')
-    expect(translation.is_fuzzy).to eq(false)
-    expect(translation.is_reviewed).to eq(false)
+    expect(translation.is_fuzzy).to be(false)
+    expect(translation.is_reviewed).to be(false)
     expect(translation.words).to eq(1)
     expect(translation.custom_translation_statuses).to eq([])
     expect(translation.task_id).to be_nil
@@ -97,7 +97,7 @@ RSpec.describe Lokalise::Client do
 
     expect(translation.translation_id).to eq(translation_id)
     expect(translation.translation).to eq('rspec trans')
-    expect(translation.is_reviewed).to eq(true)
+    expect(translation.is_reviewed).to be(true)
   end
 
   context 'when translation chained methods are used' do
@@ -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/rest → ruby_lokalise_api/client}/webhooks_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Lokalise::Client do
+RSpec.describe RubyLokaliseApi::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:webhook_id) { 'c7eb7e6e3c2fb2b26d0b64d0de083a5a71675b3d' }
   let(:new_webhook_id) { 'b345ccc6499920c490e8f4fe9487b1378dbf1dbf' }
@@ -84,7 +84,7 @@ RSpec.describe Lokalise::Client do
     end
 
     expect(response['project_id']).to eq(project_id)
-    expect(response['webhook_deleted']).to eq(true)
+    expect(response['webhook_deleted']).to be(true)
   end
 
   specify '#regenerate_webhook_secret' do

data/spec/lib/ruby_lokalise_api/connection_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+RSpec.describe RubyLokaliseApi::Connection do
+  let(:dummy) { Class.new { include RubyLokaliseApi::Connection }.new }
+
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:key_id) { 44_596_059 }
+
+  before { RubyLokaliseApi.reset_client! }
+
+  after { RubyLokaliseApi.reset_client! }
+
+  it 'Authorization header must be present for OAuth2 client' do
+    conn = dummy.connection test_oauth2_client
+    expect(conn.headers['Authorization']).to eq(test_oauth2_client.token)
+    expect(conn.headers['X-api-token']).to be_nil
+  end
+
+  it 'timeouts are not be set by default but the token must be present' do
+    conn = dummy.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)
+  end
+
+  it 'allows to customize timeouts' do
+    custom_client = RubyLokaliseApi.client(ENV['LOKALISE_API_TOKEN'],
+                                           open_timeout: 100, timeout: 500)
+    conn = dummy.connection custom_client
+    expect(conn.options.timeout).to eq(500)
+    expect(conn.options.open_timeout).to eq(100)
+    expect(conn.headers['X-api-token']).to eq(custom_client.token)
+
+    custom_client.timeout = 300
+    custom_client.open_timeout = 200
+    another_conn = dummy.connection custom_client
+    expect(another_conn.options.timeout).to eq(300)
+    expect(another_conn.options.open_timeout).to eq(200)
+  end
+
+  it 'works with gzip compression' do
+    gzip_client = RubyLokaliseApi.client(ENV['LOKALISE_API_TOKEN'])
+    keys = VCR.use_cassette('all_keys_gzip') do
+      gzip_client.keys project_id, limit: 30
+    end.collection
+
+    expect(keys.first.key_id).to eq(key_id)
+  end
+
+  it 'gzip compression is on by default' do
+    custom_client = RubyLokaliseApi.client(ENV['LOKALISE_API_TOKEN'])
+    conn = dummy.connection custom_client
+    expect(conn.headers['X-api-token']).to eq(custom_client.token)
+    expect(conn.builder.handlers).to include(Faraday::Gzip::Middleware)
+  end
+
+  it 'is possible to customize adapter' do
+    conn = dummy.connection test_client
+    expect(conn.builder.adapter).to eq(Faraday::Adapter::NetHttp)
+
+    Faraday.default_adapter = :test
+
+    another_conn = dummy.connection test_client
+
+    expect(another_conn.builder.adapter).to eq(Faraday::Adapter::Test)
+    expect(conn.builder.adapter).to eq(Faraday::Adapter::NetHttp)
+  end
+end

data/spec/lib/{ruby-lokalise-api → ruby_lokalise_api}/custom_json_parser_spec.rb

@@ -2,7 +2,7 @@
 
 require 'oj'
 
-RSpec.describe Lokalise::JsonHandler do
+RSpec.describe RubyLokaliseApi::JsonHandler do
   let(:loaded_json) do
     {'projects' => [{'project_id' => '547879415c01a0e6e0b855.29978928',
                      'name' => 'demo phoenix copy',
@@ -29,7 +29,7 @@ RSpec.describe Lokalise::JsonHandler do
 
   # rubocop:disable RSpec/LeakyConstantDeclaration, Lint/ConstantDefinitionInBlock
   before do
-    module Lokalise
+    module RubyLokaliseApi
       module JsonHandler
         def custom_dump(obj)
           Oj.dump obj
@@ -43,7 +43,7 @@ RSpec.describe Lokalise::JsonHandler do
   end
 
   after do
-    module Lokalise
+    module RubyLokaliseApi
       module JsonHandler
         def custom_dump(obj)
           JSON.dump obj

data/spec/lib/{ruby-lokalise-api → ruby_lokalise_api}/error_spec.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-RSpec.describe Lokalise::Error do
-  include Lokalise::Request
+RSpec.describe RubyLokaliseApi::Error do
+  include RubyLokaliseApi::Request
 
-  before { Lokalise.reset_client! }
+  before { RubyLokaliseApi.reset_client! }
 
-  after { Lokalise.reset_client! }
+  after { RubyLokaliseApi.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')
+        get 'projects', RubyLokaliseApi.client('invalid')
       end
     end.to raise_error(described_class)
   end
@@ -18,17 +18,17 @@ RSpec.describe Lokalise::Error do
   it 'handles an exception when the response does not contain an error key' do
     expect do
       VCR.use_cassette('error_no_error_key') do
-        get 'projects', Lokalise.client('invalid')
+        get 'projects', RubyLokaliseApi.client('invalid')
       end
-    end.to raise_error(Lokalise::Error::BadRequest)
+    end.to raise_error(RubyLokaliseApi::Error::BadRequest)
   end
 
   it 'raises BadRequest when API token is invalid' do
     expect do
       VCR.use_cassette('error_invalid_token') do
-        get 'projects', Lokalise.client('invalid')
+        get 'projects', RubyLokaliseApi.client('invalid')
       end
-    end.to raise_error(Lokalise::Error::BadRequest)
+    end.to raise_error(RubyLokaliseApi::Error::BadRequest)
   end
 
   it 'raises NotFound when the provided path cannot be found' do
@@ -36,6 +36,6 @@ RSpec.describe Lokalise::Error do
       VCR.use_cassette('error_not_found') do
         get 'invalid_path', test_client
       end
-    end.to raise_error(Lokalise::Error::NotFound)
+    end.to raise_error(RubyLokaliseApi::Error::NotFound)
   end
 end

data/spec/lib/ruby_lokalise_api/oauth2/auth_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+RSpec.describe RubyLokaliseApi::OAuth2::Auth do
+  describe '#auth' do
+    it 'returns auth code' do
+      uri = auth_client.auth scope: 'read_projects'
+      expect(uri).to include(described_class::BASE_URL.to_s)
+      expect(uri).to include('auth?client_id=')
+      expect(uri).to include('&scope=read_projects')
+    end
+
+    it 'allows to pass an array of scopes' do
+      scopes = %w[write_projects write_team_groups write_tasks]
+      uri = auth_client.auth scope: scopes
+      expect(uri).to include(described_class::BASE_URL.to_s)
+      expect(uri).to include('auth?client_id=')
+      expect(uri).to include("&scope=#{scopes.join('+')}")
+    end
+
+    it 'allows to set redirect_uri' do
+      uri = auth_client.auth scope: 'read_projects', redirect_uri: 'http://example.com/callback'
+      expect(uri).to include(described_class::BASE_URL.to_s)
+      expect(uri).to include('example.com%2Fcallback')
+    end
+
+    it 'allows to set state' do
+      state = '123abc'
+      uri = auth_client.auth scope: 'read_projects', state: state
+      expect(uri).to include(described_class::BASE_URL.to_s)
+      expect(uri).to include(state)
+    end
+  end
+
+  describe '#token' do
+    it 'returns an OAuth2 token' do
+      resp = VCR.use_cassette('oauth2/token') do
+        auth_client.token ENV['OAUTH2_CODE']
+      end
+      expect(resp['access_token']).not_to be_nil
+      expect(resp['refresh_token']).not_to be_nil
+      expect(resp['expires_in']).to eq(3600)
+      expect(resp['token_type']).to eq('Bearer')
+    end
+
+    it 'raises an error when the code is invalid' do
+      expect do
+        VCR.use_cassette('oauth2/token_error') do
+          auth_client.token 'incorrect_code'
+        end
+      end.to raise_error(RubyLokaliseApi::Error::BadRequest)
+    end
+  end
+
+  describe '#refresh' do
+    it 'returns a refreshed OAuth2 token' do
+      resp = VCR.use_cassette('oauth2/refresh') do
+        auth_client.refresh ENV['OAUTH2_REFRESH_TOKEN']
+      end
+      expect(resp['access_token']).not_to be_nil
+      expect(resp['refresh_token']).to be_nil
+      expect(resp['expires_in']).to eq(3600)
+      expect(resp['token_type']).to eq('Bearer')
+    end
+
+    it 'raises an error when the token is invalid' do
+      expect do
+        VCR.use_cassette('oauth2/refresh_error') do
+          auth_client.refresh 'incorrect_token'
+        end
+      end.to raise_error(RubyLokaliseApi::Error::BadRequest)
+    end
+  end
+end

data/spec/lib/ruby_lokalise_api_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+RSpec.describe RubyLokaliseApi do
+  specify '.client' do
+    expect(test_client).to be_an_instance_of(RubyLokaliseApi::Client)
+    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
+  end
+
+  specify '.reset_client!' do
+    expect(test_client).to be_an_instance_of(RubyLokaliseApi::Client)
+    described_class.reset_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(RubyLokaliseApi::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(RubyLokaliseApi::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! }
+
+    after { described_class.reset_client! }
+
+    it 'is possible to customize timeout' do
+      custom_client = described_class.client(ENV['LOKALISE_API_TOKEN'], timeout: 600)
+      expect(custom_client.timeout).to eq(600)
+    end
+
+    it 'is possible to customize open timeout' do
+      custom_client = described_class.client(ENV['LOKALISE_API_TOKEN'], open_timeout: 100)
+      expect(custom_client.open_timeout).to eq(100)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,7 +12,7 @@ if ENV['CI'] == 'true'
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
-require 'ruby-lokalise-api'
+require 'ruby_lokalise_api'
 
 # Support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }

data/spec/support/test_client.rb

@@ -2,10 +2,14 @@
 
 module TestClient
   def test_client(token = nil, params = {})
-    Lokalise.client(token || ENV['LOKALISE_API_TOKEN'], params)
+    RubyLokaliseApi.client(token || ENV['LOKALISE_API_TOKEN'], params)
   end
 
-  def test_oauth_client(token = nil, params = {})
-    Lokalise.oauth_client(token || ENV['LOKALISE_API_TOKEN'], params)
+  def test_oauth2_client(token = nil, params = {})
+    RubyLokaliseApi.oauth2_client(token || ENV['OAUTH2_TOKEN'], params)
+  end
+
+  def auth_client
+    RubyLokaliseApi.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