ruby-lokalise-api 2.10.0 → 3.0.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'

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
 
       # Initializes a new collection based on the response
       #
@@ -19,9 +19,10 @@ 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 and branch may not be present in some cases
         @project_id = response['content']['project_id']
         @team_id = response['content']['team_id']
+        @branch = response['content']['branch']
         @request_params = params
         @client = response['client']
         @path = response['path']

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

@@ -105,6 +105,17 @@
     "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",
@@ -211,4 +222,4 @@
     "events",
     "event_lang_map"
   ]
-}
+}

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

@@ -8,25 +8,30 @@ 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
 
-      # 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']
+        @branch = response['content']['branch']
         @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,7 +48,8 @@ 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, 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
@@ -56,30 +62,34 @@ 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
@@ -96,7 +106,6 @@ module Lokalise
 
         def produce_resource(model_class, response)
           data_key_singular = data_key_for model_class
-
           if response['content'].key? data_key_singular
             data = response['content'].delete data_key_singular
             response['content'].merge! data
@@ -111,20 +120,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
 
-        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/)

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)

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

@@ -9,7 +9,10 @@ module Lokalise
         end
 
         def upload(client, path, params)
-          post(path, client, params)['content']
+          params[:queue] = true
+          klass = Lokalise::Resources::QueuedProcess
+          klass.new post(path, client, params),
+                    ->(project_id, id) { klass.endpoint(project_id, id) }
         end
 
         def endpoint(project_id, action = '')

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Key < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, key_id = nil)

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

@@ -5,7 +5,7 @@ module Lokalise
     class KeyComment < Base
       DATA_KEY = 'Comment'
       ID_KEY = 'comment'
-      supports :destroy
+      supports :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, key_id, comment_id = nil)

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

@@ -3,6 +3,8 @@
 module Lokalise
   module Resources
     class Order < Base
+      supports [:reload_data, '', :find]
+
       class << self
         def endpoint(team_id, order_id = nil)
           path_from teams: team_id,

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class PaymentCard < Base
-      supports :destroy
+      supports :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(card_id = nil)

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Project < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       def empty
         self.class.empty @client, @path + '/empty'

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Resources
+    class QueuedProcess < Base
+      DATA_KEY = 'Process'
+      ID_KEY = 'process'
+      supports [:reload_data, '', :find]
+
+      class << self
+        def endpoint(project_id, process_id = nil)
+          path_from projects: project_id,
+                    processes: process_id
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Screenshot < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, screenshot_id = nil)

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

@@ -11,7 +11,9 @@ module Lokalise
 
       class << self
         def restore(client, path, *_args)
-          Lokalise::Resources::Project.new post(path, client)
+          klass = Lokalise::Resources::Project
+          klass.new post(path, client),
+                    ->(project_id, *_ids) { klass.endpoint(project_id) }
         end
 
         def endpoint(project_id, snapshot_id = nil)

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Task < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, task_id = nil)

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

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

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Translation < Base
-      supports :update
+      supports :update, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, translation_id = nil)

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

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Webhook < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       def regenerate_secret
         self.class.regenerate_secret @client, @path + '/secret/regenerate'

data/lib/ruby-lokalise-api/rest/comments.rb

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns a single comment for the given key
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-comment-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-comment-get
     # @return [Lokalise::Resources::Comment]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -15,7 +15,7 @@ module Lokalise
 
     # Returns all comments for all keys inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-project-comments-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-project-comments-get
     # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
     # @param project_id [String]
     # @param params [Hash]
@@ -25,7 +25,7 @@ module Lokalise
 
     # Returns all comments for the given key inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-key-comments-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-key-comments-get
     # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -36,7 +36,7 @@ module Lokalise
 
     # Creates one or more comments for the given key inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-comments-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-comments-post
     # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -47,7 +47,7 @@ module Lokalise
 
     # Deletes comment for the given key inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-comment-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-comment-delete
     # @return [Hash]
     # @param project_id [String]
     # @param key_id [String, Integer]

data/lib/ruby-lokalise-api/rest/contributors.rb

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all contributors for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-contributors-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-contributors-get
     # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
     # @param project_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns a single contributor for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-contributor-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-contributor-get
     # @return [Lokalise::Resources::Contributor]
     # @param project_id [String]
     # @param contributor_id [String, Integer]
@@ -24,7 +24,7 @@ module Lokalise
 
     # Creates one or more contributors inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-contributors-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-contributors-post
     # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
     # @param project_id [String]
     # @param params [Hash, Array<Hash>]
@@ -34,7 +34,7 @@ module Lokalise
 
     # Updates the given contributor inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-contributor-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-contributor-put
     # @return [Lokalise::Resources::Contributor]
     # @param project_id [String]
     # @param contributor_id [String, Integer]
@@ -45,7 +45,7 @@ module Lokalise
 
     # Deletes contributor inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-contributor-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-contributor-delete
     # @return [Hash]
     # @param project_id [String]
     # @param contributor_id [String, Integer]