ruby-lokalise-api 4.3.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4147ca27a676c98d74fa654c4244212aa7e296855d4bda492fd061a3a3a02347
-  data.tar.gz: 59c042db99a7f2899baef674319ec18ab9ee193f3581f35b40fd92b0c43118bb
+  metadata.gz: b99a57388157ac9dea3e17b78cf19b27ada718b172b9b5e91230e4b0772073f2
+  data.tar.gz: fff194faef3d317f122987fc866c9358f3169dbf8d5a1d52fdf5d810bff0cb84
 SHA512:
-  metadata.gz: 38e44afa51cb74149fb4b7aff68d958232f39d111bef8927835fc9bd012c8738ac0a4a4c175ab1bc9e7b2a846135a5f4ff5473845d562d45d408200e439abedf
-  data.tar.gz: 67cc5c58134b64955f65595f5b5797c72adbaa8dbe9e239fff0d434044e3a599c0eea4dd7418bbbb2834b9cd8f9e7572258f07a514f80c048508cfba408cd2d0
+  metadata.gz: 478a91cc6130208809c783ac145270d89d3a059d76d9b011133a2e62b8b82bee8d9011004945cfb02b9cd950699f45d6354522281904aaf61b885935aee28dca
+  data.tar.gz: 15b10938bcfd13534fbcbea1f7f705b74b39e9f9c02895d413f9c859246a389b020ca4abd1d35c59078388564c7c22995bd558b47aad52b5e233229f34e4bec3

data/README.md

@@ -1,13 +1,13 @@
 # Lokalise API v2 official Ruby interface
 
 ![Gem](https://img.shields.io/gem/v/ruby-lokalise-api)
-[![Build Status](https://travis-ci.com/lokalise/ruby-lokalise-api.svg?branch=master)](https://travis-ci.com/github/lokalise/ruby-lokalise-api)
+![CI](https://github.com/lokalise/ruby-lokalise-api/actions/workflows/ci.yml/badge.svg)
 [![Test Coverage](https://codecov.io/gh/lokalise/ruby-lokalise-api/graph/badge.svg)](https://codecov.io/gh/lokalise/ruby-lokalise-api)
 ![Downloads total](https://img.shields.io/gem/dt/ruby-lokalise-api)
 
 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,10 +39,18 @@ 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.oauth2_client 'YOUR_OAUTH2_TOKEN_HERE'
+```
+
 ## Usage
 
 Detailed documentation can be found at [lokalise.github.io/ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api/).
 
+You can also check [this repo containing some usage examples](https://github.com/bodrovis-learning/Lokalise-APIv2-Samples) and [this blog post with explanations](https://lokalise.com/blog/lokalise-apiv2-in-practice).
+
 ## License
 
 This gem is licensed under the [BSD 3 Clause license](https://github.com/lokalise/ruby-lokalise-api/blob/master/LICENSE). Prior to version 4 the license type was MIT.

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module BaseRequest
+    include Lokalise::JsonHandler
+
+    private
+
+    # Get rid of double slashes in the `path`, leading and trailing slash
+    def prepare(path)
+      path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
+    end
+
+    def raise_on_error!(status, body)
+      respond_with_error(status, body) if status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
+    end
+
+    def respond_with_error(code, body)
+      raise(Lokalise::Error, body['error'] || body) unless Lokalise::Error::ERRORS.key? code
+
+      raise Lokalise::Error::ERRORS[code].from_response(body)
+    end
+  end
+end

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

@@ -20,17 +20,19 @@ require 'ruby-lokalise-api/rest/translation_providers'
 require 'ruby-lokalise-api/rest/team_user_group'
 require 'ruby-lokalise-api/rest/custom_translation_statuses'
 require 'ruby-lokalise-api/rest/webhooks'
+require 'ruby-lokalise-api/rest/segments'
+require 'ruby-lokalise-api/rest/team_user_billing_details'
 
 module Lokalise
   class Client
-    attr_reader :token
-    attr_accessor :timeout, :open_timeout, :enable_compression
+    attr_reader :token, :token_header
+    attr_accessor :timeout, :open_timeout
 
     def initialize(token, params = {})
       @token = token
       @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

@@ -3,6 +3,8 @@
 module Lokalise
   module Collections
     class Base
+      using Lokalise::Utils::StringUtils
+
       extend Lokalise::Request
       extend Lokalise::Utils::AttributeHelpers
       include Lokalise::Utils::AttributeHelpers
@@ -19,14 +21,8 @@ module Lokalise
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
-        # 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']
         @request_params = params
-        @client = response['client']
-        @path = response['path']
+        popular_common_attrs response
       end
 
       class << self
@@ -90,6 +86,8 @@ module Lokalise
       # Dynamically produces collection of resources based on the given response
       # Collection example: `{ "content": {"comments": [ ... ]} }`
       def produce_collection_for(response)
+        return unless response['content']
+
         model_class = self.class.name.base_class_name
         data_key_plural = data_key_for model_class: model_class, plural: true, collection: true
 
@@ -101,6 +99,20 @@ module Lokalise
                                                                       'base_path' => response['path']
         end
       end
+
+      def popular_common_attrs(response)
+        @client = response['client']
+        @path = response['path']
+
+        return unless response['content']
+
+        content = response['content']
+        # Project, team id, user id, and branch may not be present in some cases
+        @project_id = content['project_id']
+        @team_id = content['team_id']
+        @user_id = content['user_id']
+        @branch = content['branch']
+      end
     end
   end
 end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Collections
+    class Segment < Base
+      class << self
+        def endpoint(project_id, key_id, lang_iso, *_args)
+          path_from projects: project_id,
+                    keys: key_id,
+                    segments: lang_iso
+        end
+      end
+    end
+  end
+end

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

@@ -6,8 +6,8 @@ module Lokalise
 
     def connection(client)
       Faraday.new(options(client), request_params_for(client)) do |faraday|
-        faraday.use(:gzip) if client.enable_compression
         faraday.adapter Faraday.default_adapter
+        faraday.request :gzip
       end
     end
 
@@ -18,7 +18,8 @@ module Lokalise
         headers: {
           accept: 'application/json',
           user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}",
-          'x-api-token': client.token
+          accept_encoding: 'gzip,deflate,br',
+          client.token_header => client.token
         },
         url: BASE_URL
       }

data/lib/ruby-lokalise-api/data/attributes.json

@@ -134,6 +134,20 @@
     "created_at",
     "created_at_timestamp"
   ],
+  "segment": [
+    "segment_number",
+    "language_iso",
+    "modified_at",
+    "modified_at_timestamp",
+    "modified_by",
+    "modified_by_email",
+    "value",
+    "is_fuzzy",
+    "is_reviewed",
+    "reviewed_by",
+    "words",
+    "custom_translation_statuses"
+  ],
   "snapshot": [
     "snapshot_id",
     "title",
@@ -188,6 +202,18 @@
     "created_at_timestamp",
     "role"
   ],
+  "team_user_billing_details": [
+    "billing_email",
+    "country_code",
+    "zip",
+    "state_code",
+    "address1",
+    "address2",
+    "city",
+    "phone",
+    "company",
+    "vatnumber"
+  ],
   "team_user_group": [
     "group_id",
     "name",

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

@@ -13,7 +13,7 @@ module Lokalise
     TooManyRequests = Class.new(ClientError)
     Forbidden = Class.new(ClientError)
     Locked = Class.new(ClientError)
-    MethodNowAllowed = Class.new(ClientError)
+    MethodNotAllowed = Class.new(ClientError)
 
     NotImplemented = Class.new(ServerError)
     BadGateway = Class.new(ServerError)
@@ -25,7 +25,7 @@ module Lokalise
       401 => Lokalise::Error::Unauthorized,
       403 => Lokalise::Error::Forbidden,
       404 => Lokalise::Error::NotFound,
-      405 => Lokalise::Error::MethodNowAllowed,
+      405 => Lokalise::Error::MethodNotAllowed,
       406 => Lokalise::Error::NotAcceptable,
       409 => Lokalise::Error::Conflict,
       423 => Lokalise::Error::Locked,

data/lib/ruby-lokalise-api/oauth2/auth.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module OAuth2
+    class Auth
+      include Lokalise::OAuth2::Request
+
+      attr_reader :client_id, :client_secret
+
+      def initialize(client_id, client_secret)
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+
+      def auth(scope:, redirect_uri: nil, state: nil)
+        scope = scope.join(' ') if scope.is_a?(Array)
+
+        params = {
+          client_id: client_id,
+          scope: scope
+        }
+        params[:state] = state unless state.nil?
+        params[:redirect_uri] = redirect_uri unless redirect_uri.nil?
+
+        _build_url_from params
+      end
+
+      def token(code)
+        params = base_params.merge({
+                                     code: code,
+                                     grant_type: 'authorization_code'
+                                   })
+        post 'token', params
+      end
+
+      def refresh(token)
+        params = base_params.merge({
+                                     refresh_token: token,
+                                     grant_type: 'refresh_token'
+                                   })
+        post 'token', params
+      end
+
+      private
+
+      def base_params
+        {
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      end
+
+      def _build_url_from(params)
+        URI::HTTPS.build(
+          host: BASE_URL.host,
+          path: "#{BASE_URL.path}auth",
+          query: URI.encode_www_form(params)
+        ).to_s
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module OAuth2
+    module Connection
+      BASE_URL = URI('https://app.lokalise.com/oauth2/')
+
+      def connection
+        Faraday.new(options) { |f| f.adapter Faraday.default_adapter }
+      end
+
+      private
+
+      def options
+        {
+          headers: {
+            accept: 'application/json',
+            user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}"
+          },
+          url: BASE_URL.to_s
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module OAuth2
+    module Request
+      include Lokalise::BaseRequest
+      include Lokalise::OAuth2::Connection
+
+      def post(path, params = {})
+        respond_with connection.post(prepare(path), custom_dump(params))
+      end
+
+      private
+
+      def respond_with(response)
+        body = custom_load response.body
+        status = response.status
+        raise_on_error! status, body
+        body
+      end
+    end
+  end
+end

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

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

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

@@ -2,8 +2,8 @@
 
 module Lokalise
   module Request
+    include Lokalise::BaseRequest
     include Lokalise::Connection
-    include Lokalise::JsonHandler
 
     # Lokalise returns pagination info in special headers
     PAGINATION_HEADERS = %w[x-pagination-total-count x-pagination-page-count x-pagination-limit x-pagination-page].freeze
@@ -50,33 +50,23 @@ module Lokalise
 
     private
 
-    # Get rid of double slashes in the `path`, leading and trailing slash
-    def prepare(path)
-      path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
-    end
-
     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
+      raise_on_error! status, body
       extract_headers_from(response).
         merge('content' => body,
               'client' => client,
               'path' => uri.path.gsub(%r{/api2/}, ''))
     end
 
-    # Get only pagination headers
+    # Keep only pagination headers
     def extract_headers_from(response)
       response.
         headers.
         to_h.
         keep_if { |k, _v| PAGINATION_HEADERS.include?(k) }
     end
-
-    def respond_with_error(code, body)
-      raise(Lokalise::Error, body['error'] || body) unless Lokalise::Error::ERRORS.key? code
-
-      raise Lokalise::Error::ERRORS[code].from_response(body)
-    end
   end
 end

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

@@ -3,12 +3,14 @@
 module Lokalise
   module Resources
     class Base
+      using Lokalise::Utils::StringUtils
+
       extend Lokalise::Request
       extend Lokalise::Utils::AttributeHelpers
       include Lokalise::Utils::AttributeHelpers
       extend Lokalise::Utils::EndpointHelpers
 
-      attr_reader :raw_data, :project_id, :client, :path, :branch, :user_id, :team_id
+      attr_reader :raw_data, :project_id, :client, :path, :branch, :user_id, :team_id, :key_id
 
       # Initializes a new resource based on the response.
       # `endpoint_generator` is used in cases when a new instance is generated
@@ -107,10 +109,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
@@ -131,7 +134,7 @@ module Lokalise
 
       def path_with_id(response, id_key, data_key, endpoint_generator = nil)
         # Some resources do not have ids at all
-        return nil unless response['content'].key?(id_key) || response['content'].key?(data_key)
+        return unless response['content'] && (response['content'].key?(id_key) || response['content'].key?(data_key))
 
         # ID of the resource
         id = id_from response, id_key, data_key
@@ -155,15 +158,20 @@ module Lokalise
         # Content may be `{"project_id": '123', ...}` or {"snapshot": {"snapshot_id": '123', ...}}
         # 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).
+        # In rare cases the actual identifier does not have an "_id" suffix
+        # (for segments that have "segment_number" field instead)
         # 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.respond_to?(:key?) && 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.
       # `ATTRIBUTES` is defined inside resource-specific classes
       def populate_attributes_for(content)
+        return unless content
+
         data_key = data_key_for model_class: self.class.name.base_class_name
 
         self.class.const_get(:ATTRIBUTES).each do |attr|
@@ -181,10 +189,13 @@ module Lokalise
       # Some of them may be absent in certain cases.
       # rubocop:disable Naming/MemoizedInstanceVariableName
       def extract_common_attributes_for(content)
+        return unless content
+
         @raw_data = content
         @project_id ||= content['project_id']
         @user_id ||= content['user_id']
         @team_id ||= content['team_id']
+        @key_id ||= content['key_id']
         @branch ||= content['branch']
       end
       # rubocop:enable Naming/MemoizedInstanceVariableName

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

@@ -3,10 +3,12 @@
 module Lokalise
   module Resources
     class Branch < Base
+      ID_KEY = 'branch_id'
       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/resources/contributor.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Contributor < Base
-      ID_KEY = 'user'
+      ID_KEY = 'user_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class CustomTranslationStatus < Base
-      ID_KEY = 'status'
+      ID_KEY = 'status_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Key < Base
+      ID_KEY = 'key_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class KeyComment < Base
       DATA_KEY = 'Comment'
-      ID_KEY = 'comment'
+      ID_KEY = 'comment_id'
       supports :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Order < Base
+      ID_KEY = 'order_id'
       supports [:reload_data, '', :find]
 
       class << self

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class PaymentCard < Base
+      ID_KEY = 'card_id'
       supports :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Project < Base
+      ID_KEY = 'project_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       def empty

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class ProjectComment < Base
+      ID_KEY = 'comment_id'
       DATA_KEY = 'Comment'
     end
   end

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

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class ProjectLanguage < Base
       DATA_KEY = 'Language'
-      ID_KEY = 'lang'
+      ID_KEY = 'lang_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class QueuedProcess < Base
       DATA_KEY = 'Process'
-      ID_KEY = 'process'
+      ID_KEY = 'process_id'
       supports [:reload_data, '', :find]
 
       class << self

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Screenshot < Base
+      ID_KEY = 'screenshot_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Resources
+    class Segment < Base
+      DATA_KEY = 'Segment'
+      ID_KEY = 'segment_number'
+      supports :update, [:reload_data, '', :find]
+
+      class << self
+        def endpoint(project_id, key_id, lang_iso, segment_number = nil)
+          path_from projects: project_id,
+                    keys: key_id,
+                    segments: [lang_iso, segment_number]
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Snapshot < Base
+      ID_KEY = 'snapshot_id'
       supports :destroy
 
       def restore

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

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Task < Base
+      ID_KEY = 'task_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class TeamUser < Base
-      ID_KEY = 'user'
+      ID_KEY = 'user_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self