ruby-lokalise-api 2.10.0 → 4.2.0

data/lib/ruby-lokalise-api.rb

@@ -17,6 +17,7 @@ require 'ruby-lokalise-api/resources/base'
 require 'ruby-lokalise-api/resources/branch'
 require 'ruby-lokalise-api/resources/project'
 require 'ruby-lokalise-api/resources/project_language'
+require 'ruby-lokalise-api/resources/queued_process'
 require 'ruby-lokalise-api/resources/key_comment'
 require 'ruby-lokalise-api/resources/contributor'
 require 'ruby-lokalise-api/resources/file'
@@ -43,6 +44,7 @@ require 'ruby-lokalise-api/collections/team'
 require 'ruby-lokalise-api/collections/system_language'
 require 'ruby-lokalise-api/collections/project_language'
 require 'ruby-lokalise-api/collections/project_comment'
+require 'ruby-lokalise-api/collections/queued_process'
 require 'ruby-lokalise-api/collections/key_comment'
 require 'ruby-lokalise-api/collections/key'
 require 'ruby-lokalise-api/collections/contributor'

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

@@ -4,6 +4,7 @@ require 'ruby-lokalise-api/rest/branches'
 require 'ruby-lokalise-api/rest/languages'
 require 'ruby-lokalise-api/rest/teams'
 require 'ruby-lokalise-api/rest/projects'
+require 'ruby-lokalise-api/rest/queued_processes'
 require 'ruby-lokalise-api/rest/comments'
 require 'ruby-lokalise-api/rest/keys'
 require 'ruby-lokalise-api/rest/contributors'
@@ -27,14 +28,25 @@ module Lokalise
 
     def initialize(token, params = {})
       @token = token
-      @timeout = params.fetch(:timeout) { nil }
-      @open_timeout = params.fetch(:open_timeout) { nil }
+      @timeout = params.fetch(:timeout, nil)
+      @open_timeout = params.fetch(:open_timeout, nil)
     end
 
-    def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil)
+    # rubocop:disable Metrics/ParameterLists
+    # Constructs request to perform the specified action
+    # @param klass The actual class to call the method upon
+    # @param method [Symbol] The method to call (:new, :update, :create etc)
+    # @param endpoint_ids [Array, Hash] IDs that are used to generate the proper path to the endpoint
+    # @param params [Array, Hash] Request parameters
+    # @param object_key [String, Symbol] Key that should be used to wrap parameters into
+    # @param initial_ids [Array] IDs that should be used to generate base endpoint path. The base path is used for method chaining
+    def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil, initial_ids = nil)
       path = klass.endpoint(*endpoint_ids)
-      klass.send method, self, path, format_params(params, object_key)
+      formatted_params = format_params(params, object_key)
+      formatted_params[:_initial_path] = klass.endpoint(*initial_ids) if initial_ids
+      klass.send method, self, path, formatted_params
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # Converts `params` to hash with arrays under the `object_key` key.
     # Used in bulk operations
@@ -44,7 +56,7 @@ module Lokalise
       return params unless object_key
 
       params = [params] unless params.is_a?(Array)
-      Hash[object_key, params]
+      {object_key => params}
     end
 
     alias c_r construct_request

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

@@ -9,7 +9,7 @@ module Lokalise
       extend Lokalise::Utils::EndpointHelpers
 
       attr_reader :total_pages, :total_results, :results_per_page, :current_page, :collection,
-                  :project_id, :team_id, :request_params, :client, :path
+                  :project_id, :team_id, :request_params, :client, :path, :branch, :user_id
 
       # Initializes a new collection based on the response
       #
@@ -19,9 +19,11 @@ module Lokalise
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
-        # Project and team id may not be present in some cases
+        # 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']
@@ -89,7 +91,7 @@ module Lokalise
       # Collection example: `{ "content": {"comments": [ ... ]} }`
       def produce_collection_for(response)
         model_class = self.class.name.base_class_name
-        data_key_plural = data_key_for model_class, true, true
+        data_key_plural = data_key_for model_class: model_class, plural: true, collection: true
 
         # Fetch collection data and instantiate an individual resource for each object
         # We also preserve the `client` to be able to chain API methods later

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Collections
+    class QueuedProcess < Base
+      DATA_KEY_PLURAL = 'Processes'
+
+      class << self
+        def endpoint(project_id, *_args)
+          path_from projects: [project_id, 'processes']
+        end
+      end
+    end
+  end
+end

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

@@ -21,11 +21,11 @@
     "email",
     "fullname",
     "created_at",
+    "created_at_timestamp",
     "is_admin",
     "is_reviewer",
     "languages",
-    "admin_rights",
-    "created_at_timestamp"
+    "admin_rights"
   ],
   "custom_translation_status": [
     "status_id",
@@ -39,6 +39,7 @@
   "key": [
     "key_id",
     "created_at",
+    "created_at_timestamp",
     "key_name",
     "filenames",
     "description",
@@ -55,7 +56,10 @@
     "base_words",
     "char_limit",
     "custom_attributes",
-    "created_at_timestamp"
+    "modified_at",
+    "modified_at_timestamp",
+    "translations_modified_at",
+    "translations_modified_at_timestamp"
   ],
   "language": [
     "lang_id",
@@ -70,6 +74,7 @@
     "card_id",
     "status",
     "created_at",
+    "created_at_timestamp",
     "created_by",
     "created_by_email",
     "source_language_iso",
@@ -82,7 +87,8 @@
     "translation_tier_name",
     "briefing",
     "total",
-    "created_at_timestamp"
+    "payment_method",
+    "dry_run"
   ],
   "payment_card": [
     "card_id",
@@ -96,15 +102,26 @@
     "name",
     "description",
     "created_at",
+    "created_at_timestamp",
     "created_by",
     "created_by_email",
     "team_id",
-    "created_at_timestamp",
     "base_language_id",
     "base_language_iso",
     "settings",
     "statistics"
   ],
+  "queued_process": [
+    "process_id",
+    "type",
+    "status",
+    "message",
+    "created_by",
+    "created_by_email",
+    "created_at",
+    "created_at_timestamp",
+    "details"
+  ],
   "screenshot": [
     "screenshot_id",
     "key_ids",
@@ -121,9 +138,9 @@
     "snapshot_id",
     "title",
     "created_at",
+    "created_at_timestamp",
     "created_by",
-    "created_by_email",
-    "created_at_timestamp"
+    "created_by_email"
   ],
   "task": [
     "task_id",
@@ -147,6 +164,7 @@
     "languages",
     "auto_close_languages",
     "auto_close_task",
+    "auto_close_items",
     "completed_at",
     "completed_at_timestamp",
     "completed_by",
@@ -157,18 +175,18 @@
     "team_id",
     "name",
     "created_at",
+    "created_at_timestamp",
     "plan",
     "quota_usage",
-    "quota_allowed",
-    "created_at_timestamp"
+    "quota_allowed"
   ],
   "team_user": [
     "user_id",
     "email",
     "fullname",
     "created_at",
-    "role",
-    "created_at_timestamp"
+    "created_at_timestamp",
+    "role"
   ],
   "team_user_group": [
     "group_id",
@@ -192,7 +210,8 @@
     "is_fuzzy",
     "is_reviewed",
     "words",
-    "custom_translation_statuses"
+    "custom_translation_statuses",
+    "task_id"
   ],
   "translation_provider": [
     "provider_id",
@@ -211,4 +230,4 @@
     "events",
     "event_lang_map"
   ]
-}
+}

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

@@ -52,7 +52,7 @@ module Lokalise
 
     # Get rid of double slashes in the `path`, leading and trailing slash
     def prepare(path)
-      path.gsub(%r{\A/}, '').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
+      path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
     end
 
     def respond_with(response, client)

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

@@ -8,25 +8,27 @@ module Lokalise
       include Lokalise::Utils::AttributeHelpers
       extend Lokalise::Utils::EndpointHelpers
 
-      attr_reader :raw_data, :project_id, :client, :path
+      attr_reader :raw_data, :project_id, :client, :path, :branch, :user_id, :team_id
 
-      # Initializes a new resource based on the response
+      # Initializes a new resource based on the response.
+      # `endpoint_generator` is used in cases when a new instance is generated
+      # from a different resource. For example, restoring from a snapshot
+      # creates a totally different project which should have a new path.
       #
       # @param response [Hash]
+      # @param endpoint_generator [Proc] Generate proper paths for certain resources
       # @return [Lokalise::Resources::Base]
-      def initialize(response)
+      def initialize(response, endpoint_generator = nil)
         populate_attributes_for response['content']
-
-        @raw_data = response['content']
-        @project_id = response['content']['project_id']
+        extract_common_attributes_for response['content']
         @client = response['client']
-        @path = infer_path_from response
+        @path = infer_path_from response, endpoint_generator
       end
 
       class << self
-        # Dynamically add attribute readers for each inherited class.
+        # Dynamically adds attribute readers for each inherited class.
         # Attributes are defined in the `data/attributes.json` file.
-        # Also set the `ATTRIBUTES` constant to assign values to each attribute later when
+        # Also sets the `ATTRIBUTES` constant to assign values to each attribute later when
         # the response arrives from the API
         def inherited(subclass)
           klass_attributes = attributes_for subclass
@@ -43,10 +45,16 @@ module Lokalise
         # Usage: `supports :update, :destroy, [:complex_method, '/sub/path', :update]`
         def supports(*methods)
           methods.each do |m_data|
-            method_name, sub_path, c_method = m_data.is_a?(Array) ? m_data : [m_data, '', m_data]
+            # `method_name` - the method that the resource should support
+            # `sub_path` - a string that has to be appended to a base path
+            # `c_method` - method name to delegate the work to
+            method_name, sub_path, c_method =
+              m_data.is_a?(Array) ? m_data : [m_data, '', m_data]
+
             define_method method_name do |params = {}|
               path = instance_variable_get(:@path)
-              # If there's a sub_path, preserve the initial path to allow further chaining
+              # If there's a sub_path which is a string,
+              # preserve the initial path to allow further chaining
               params = params.merge(_initial_path: path) if sub_path
               self.class.send c_method, instance_variable_get(:@client),
                               path + sub_path, params
@@ -56,34 +64,38 @@ module Lokalise
 
         # Fetches a single record
         def find(client, path, params = {})
-          new get(path, client, params)
+          new get(path, client, prepare_params(params))
         end
 
         # Creates one or multiple records
         def create(client, path, params)
-          response = post path, client, params
-
+          response = post path, client, prepare_params(params)
           object_from response, params
         end
 
         # Updates one or multiple records
         def update(client, path, params)
-          response = put path, client, params
-
+          response = put path, client, prepare_params(params)
           object_from response, params
         end
 
         # Destroys records by given ids
         def destroy(client, path, params = {})
-          delete(path, client, params)['content']
+          delete(path, client, prepare_params(params))['content']
         end
 
         private
 
+        # Filters out internal attributes that should not be sent to Lokalise
+        def prepare_params(params)
+          filter_attrs = %i[_initial_path]
+          params.reject { |key, _v| filter_attrs.include?(key) }
+        end
+
         # Instantiates a new resource or collection based on the given response
         def object_from(response, params)
           model_class = name.base_class_name
-          data_key_plural = data_key_for model_class, true
+          data_key_plural = data_key_for model_class: model_class, plural: true
           # Preserve the initial path to allow chaining
           response['path'] = params.delete(:_initial_path) if params.key?(:_initial_path)
 
@@ -95,8 +107,7 @@ module Lokalise
         end
 
         def produce_resource(model_class, response)
-          data_key_singular = data_key_for model_class
-
+          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
@@ -111,20 +122,27 @@ module Lokalise
       end
 
       # Generates path for the individual resource based on the path for the collection
-      def infer_path_from(response)
+      def infer_path_from(response, endpoint_generator = nil)
         id_key = id_key_for self.class.name.base_class_name
-        data_key = data_key_for self.class.name.base_class_name
+        data_key = data_key_for model_class: self.class.name.base_class_name
 
-        path_with_id response, id_key, data_key
+        path_with_id response, id_key, data_key, endpoint_generator
       end
 
-      def path_with_id(response, id_key, data_key)
+      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)
 
         # ID of the resource
         id = id_from response, id_key, data_key
 
+        # If `endpoint_generator` is present, generate a new path
+        # based on the fetched id
+        if endpoint_generator
+          path = endpoint_generator.call project_id, id
+          return path.remove_trailing_slash
+        end
+
         path = response['path'] || response['base_path']
         # If path already has id - just return it
         return path if path.match?(/#{id}\z/)
@@ -146,7 +164,7 @@ module Lokalise
       # Store all resources attributes under the corresponding instance variables.
       # `ATTRIBUTES` is defined inside resource-specific classes
       def populate_attributes_for(content)
-        data_key = data_key_for self.class.name.base_class_name
+        data_key = data_key_for model_class: self.class.name.base_class_name
 
         self.class.const_get(:ATTRIBUTES).each do |attr|
           value = if content.key?(data_key) && content[data_key].is_a?(Hash)
@@ -158,6 +176,18 @@ module Lokalise
           instance_variable_set "@#{attr}", value
         end
       end
+
+      # Extracts all common attributes that resources have.
+      # Some of them may be absent in certain cases.
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      def extract_common_attributes_for(content)
+        @raw_data = content
+        @project_id ||= content['project_id']
+        @user_id ||= content['user_id']
+        @team_id ||= content['team_id']
+        @branch ||= content['branch']
+      end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
     end
   end
 end

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

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

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

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class Contributor < Base
       ID_KEY = 'user'
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, contributor_id = nil)

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

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class CustomTranslationStatus < Base
       ID_KEY = 'status'
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def colors(client, path, *_args)