ruby-lokalise-api 4.3.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4147ca27a676c98d74fa654c4244212aa7e296855d4bda492fd061a3a3a02347
-  data.tar.gz: 59c042db99a7f2899baef674319ec18ab9ee193f3581f35b40fd92b0c43118bb
+  metadata.gz: f15e541afdd5e50a0e9317640b872bb04144dcaa717b2390887546b694e308fd
+  data.tar.gz: f34bb8a44f1e8552a0bc83b3f4c15d604500d56ecea503260d6423b047b36dcc
 SHA512:
-  metadata.gz: 38e44afa51cb74149fb4b7aff68d958232f39d111bef8927835fc9bd012c8738ac0a4a4c175ab1bc9e7b2a846135a5f4ff5473845d562d45d408200e439abedf
-  data.tar.gz: 67cc5c58134b64955f65595f5b5797c72adbaa8dbe9e239fff0d434044e3a599c0eea4dd7418bbbb2834b9cd8f9e7572258f07a514f80c048508cfba408cd2d0
+  metadata.gz: dbbc75876ec0e0c9f5a611d54520585759d77cb4f13a81126d7f9a45c89852331801054ec973f94a6c0b4e58c0a8ea8c6cb88167e5b4a4b3ac9521531b911a87
+  data.tar.gz: 2687c66c1fb1ef0012cac50329b87a7c48118cff98a890e06b7764ccce828a850750b6896d5ace0a6810e8cebb86658bbd333794e6bc94cde725c957b1c968f6

data/README.md

@@ -7,7 +7,7 @@
 
 Official opinionated Ruby interface for the [Lokalise API](https://app.lokalise.com/api2docs/curl/) that represents returned data as Ruby objects.
 
-Looking for a Rails integration? Try the new [lokalise_rails gem](https://github.com/bodrovis/lokalise_rails).
+Looking for a Rails integration? Try the [lokalise_rails gem](https://github.com/bodrovis/lokalise_rails). Also you can use a [lokalise_manager gem](https://github.com/bodrovis/lokalise_manager) which allows to exchange translation files between Lokalise and *any* Ruby script.
 
 ## Quickstart
 
@@ -39,6 +39,12 @@ process = @client.upload_file project_id,
 process.status
 ```
 
+Alternatively instantiate your client with an [OAuth2 token](http://docs.lokalise.com/en/articles/5574713-oauth-2):
+
+```ruby
+@client = Lokalise.oauth_client 'YOUR_OAUTH_TOKEN_HERE'
+```
+
 ## Usage
 
 Detailed documentation can be found at [lokalise.github.io/ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api/).

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

@@ -23,7 +23,7 @@ require 'ruby-lokalise-api/rest/webhooks'
 
 module Lokalise
   class Client
-    attr_reader :token
+    attr_reader :token, :token_header
     attr_accessor :timeout, :open_timeout, :enable_compression
 
     def initialize(token, params = {})
@@ -31,6 +31,7 @@ module Lokalise
       @timeout = params.fetch(:timeout, nil)
       @open_timeout = params.fetch(:open_timeout, nil)
       @enable_compression = params.fetch(:enable_compression, false)
+      @token_header = 'x-api-token'
     end
 
     # rubocop:disable Metrics/ParameterLists

data/lib/ruby-lokalise-api/collections/base.rb

@@ -19,11 +19,12 @@ module Lokalise
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
+        content = response['content']
         # Project, team id, user id, and branch may not be present in some cases
-        @project_id = response['content']['project_id']
-        @team_id = response['content']['team_id']
-        @user_id = response['content']['user_id']
-        @branch = response['content']['branch']
+        @project_id = content['project_id']
+        @team_id = content['team_id']
+        @user_id = content['user_id']
+        @branch = content['branch']
         @request_params = params
         @client = response['client']
         @path = response['path']

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

@@ -18,7 +18,7 @@ module Lokalise
         headers: {
           accept: 'application/json',
           user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}",
-          'x-api-token': client.token
+          client.token_header => client.token
         },
         url: BASE_URL
       }

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Lokalise
+  class OAuthClient < Client
+    def initialize(token, params = {})
+      super(token, params)
+      @token_header = 'Authorization'
+      @token = "Bearer #{@token}"
+    end
+  end
+end

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

@@ -58,7 +58,8 @@ module Lokalise
     def respond_with(response, client)
       body = custom_load response.body
       uri = Addressable::URI.parse response.env.url
-      respond_with_error response.status, body if response.status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
+      status = response.status
+      respond_with_error status, body if status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
       extract_headers_from(response).
         merge('content' => body,
               'client' => client,

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

@@ -107,10 +107,11 @@ module Lokalise
         end
 
         def produce_resource(model_class, response)
+          content = response['content']
           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
+          if content.key? data_key_singular
+            data = content.delete data_key_singular
+            content.merge! data
           end
 
           new response
@@ -156,9 +157,10 @@ module Lokalise
         # Sometimes there is an `id_key` but it has a value of `null`
         # (for example when we do not place the actual order but only check its price).
         # Therefore we must explicitly check if the key is present
-        return response['content'][id_key] if response['content'].key?(id_key)
+        content = response['content']
+        return content[id_key] if content.key?(id_key)
 
-        response['content'][data_key][id_key]
+        content[data_key][id_key]
       end
 
       # Store all resources attributes under the corresponding instance variables.

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

@@ -6,7 +6,8 @@ module Lokalise
       supports :update, :destroy, [:reload_data, '', :find]
 
       def merge(params = {})
-        self.class.merge @client, self.class.endpoint(project_id, branch_id, :merge), params
+        klass = self.class
+        klass.merge @client, klass.endpoint(project_id, branch_id, :merge), params
       end
 
       class << self

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lokalise
-  VERSION = '4.3.1'
+  VERSION = '4.4.0'
 end

data/lib/ruby-lokalise-api.rb

@@ -63,6 +63,7 @@ require 'ruby-lokalise-api/collections/custom_translation_status'
 require 'ruby-lokalise-api/collections/webhook'
 
 require 'ruby-lokalise-api/client'
+require 'ruby-lokalise-api/oauth_client'
 
 module Lokalise
   class << self
@@ -79,5 +80,19 @@ module Lokalise
     def reset_client!
       @client = nil
     end
+
+    # Initializes a new OAuthClient object
+    #
+    # @return [Lokalise::OAuthClient]
+    # @param token [String]
+    # @param params [Hash]
+    def oauth_client(token, params = {})
+      @oauth_client ||= Lokalise::OAuthClient.new token, params
+    end
+
+    # Reset the currently set OAuth client
+    def reset_oauth_client!
+      @oauth_client = nil
+    end
   end
 end

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

@@ -13,6 +13,12 @@ RSpec.describe Lokalise::Connection do
     Faraday.default_adapter = :net_http
   end
 
+  it 'Authorization header must be present for OAuth client' do
+    conn = connection test_oauth_client
+    expect(conn.headers['Authorization']).to eq("Bearer #{test_client.token}")
+    expect(conn.headers['X-api-token']).to be_nil
+  end
+
   it 'timeouts and compression should not be set by default but the token must be present' do
     conn = connection test_client
     expect(conn.options.timeout).to be_nil

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

@@ -16,6 +16,21 @@ RSpec.describe Lokalise do
     expect(current_client).to be_nil
   end
 
+  specify '.oauth_client' do
+    expect(test_oauth_client).to be_an_instance_of(Lokalise::OAuthClient)
+    expect(test_oauth_client.token).to eq("Bearer #{ENV['LOKALISE_API_TOKEN']}")
+    expect(test_oauth_client.timeout).to be_nil
+    expect(test_oauth_client.open_timeout).to be_nil
+    expect(test_oauth_client.enable_compression).to be false
+  end
+
+  specify '.reset_oauth_client!' do
+    expect(test_oauth_client).to be_an_instance_of(Lokalise::OAuthClient)
+    described_class.reset_oauth_client!
+    current_oauth_client = described_class.instance_variable_get '@oauth_client'
+    expect(current_oauth_client).to be_nil
+  end
+
   context 'with client params' do
     before { described_class.reset_client! }
 

data/spec/support/test_client.rb

@@ -4,4 +4,8 @@ module TestClient
   def test_client(token = nil, params = {})
     Lokalise.client(token || ENV['LOKALISE_API_TOKEN'], params)
   end
+
+  def test_oauth_client(token = nil, params = {})
+    Lokalise.oauth_client(token || ENV['LOKALISE_API_TOKEN'], params)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -252,6 +252,7 @@ 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/oauth_client.rb
 - lib/ruby-lokalise-api/request.rb
 - lib/ruby-lokalise-api/resources/base.rb
 - lib/ruby-lokalise-api/resources/branch.rb