ruby-lokalise-api 2.8.0 → 3.1.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class Base
@@ -6,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
@@ -41,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
@@ -54,30 +64,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
@@ -94,7 +108,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
@@ -109,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
 
-        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/)
@@ -156,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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class Contributor < Base
-      ID_KEY = 'user'.freeze
-      supports :update, :destroy
+      ID_KEY = 'user'
+      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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class CustomTranslationStatus < Base
-      ID_KEY = 'status'.freeze
-      supports :update, :destroy
+      ID_KEY = 'status'
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def colors(client, path, *_args)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class File < Base
@@ -7,7 +9,9 @@ module Lokalise
         end
 
         def upload(client, path, params)
-          post(path, client, params)['content']
+          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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class KeyComment < Base
-      DATA_KEY = 'Comment'.freeze
-      ID_KEY = 'comment'.freeze
-      supports :destroy
+      DATA_KEY = 'Comment'
+      ID_KEY = 'comment'
+      supports :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, key_id, comment_id = nil)

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

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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/project_comment.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class ProjectComment < Base
-      DATA_KEY = 'Comment'.freeze
+      DATA_KEY = 'Comment'
     end
   end
 end

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class ProjectLanguage < Base
-      DATA_KEY = 'Language'.freeze
-      ID_KEY = 'lang'.freeze
-      supports :update, :destroy
+      DATA_KEY = 'Language'
+      ID_KEY = 'lang'
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, language_id = nil)

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class Snapshot < Base
@@ -9,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/system_language.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class SystemLanguage < Base
-      DATA_KEY = 'Language'.freeze
+      DATA_KEY = 'Language'
     end
   end
 end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class Team < Base

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class TeamUser < Base
-      ID_KEY = 'user'.freeze
-      supports :update, :destroy
+      ID_KEY = 'user'
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(team_id, team_user_id = nil)

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

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class TeamUserGroup < Base
-      DATA_KEY = 'Group'.freeze
-      ID_KEY = 'group'.freeze
+      DATA_KEY = 'Group'
+      ID_KEY = 'group'
       supports :update, :destroy,
                [:add_projects, '/projects/add', :update],
                [:remove_projects, '/projects/remove', :update],
                [:add_users, '/members/add', :update],
-               [:remove_users, '/members/remove', :update]
+               [:remove_users, '/members/remove', :update],
+               [:reload_data, '', :find]
 
       class << self
         def endpoint(team_id, team_user_group_id = nil, *actions)

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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/translation_provider.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Resources
     class TranslationProvider < Base
+      supports [:reload_data, '', :find]
+      ID_KEY = 'provider'
+
       class << self
         def endpoint(team_id, provider_id = nil)
           path_from teams: team_id,

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

@@ -1,12 +1,22 @@
+# frozen_string_literal: true
+
 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'
+      end
 
       class << self
-        def endpoint(project_id, webhook_id = nil)
+        def regenerate_secret(client, path, *_args)
+          patch(path, client)['content']
+        end
+
+        def endpoint(project_id, webhook_id = nil, *actions)
           path_from projects: project_id,
-                    webhooks: webhook_id
+                    webhooks: [webhook_id, *actions]
         end
       end
     end