ruby-lokalise-api 7.2.0 → 8.0.0

data/lib/ruby_lokalise_api/resources/snapshot.rb

@@ -3,25 +3,10 @@
 module RubyLokaliseApi
   module Resources
     class Snapshot < Base
-      ID_KEY = 'snapshot_id'
-      supports :destroy
+      MAIN_PARAMS = %i[project_id snapshot_id].freeze
+      no_support_for %i[update reload_data]
 
-      def restore
-        self.class.restore @client, @path
-      end
-
-      class << self
-        def restore(client, path, *_args)
-          klass = RubyLokaliseApi::Resources::Project
-          klass.new post(path, client),
-                    ->(project_id, *_ids) { klass.endpoint(project_id) }
-        end
-
-        def endpoint(project_id, snapshot_id = nil)
-          path_from projects: project_id,
-                    snapshots: snapshot_id
-        end
-      end
+      delegate_call :restore, :restore_snapshot
     end
   end
 end

data/lib/ruby_lokalise_api/resources/system_language.rb

@@ -3,7 +3,8 @@
 module RubyLokaliseApi
   module Resources
     class SystemLanguage < Base
-      DATA_KEY = 'Language'
+      MAIN_PARAMS = [].freeze
+      no_support_for %i[update destroy reload_data]
     end
   end
 end

data/lib/ruby_lokalise_api/resources/task.rb

@@ -3,15 +3,7 @@
 module RubyLokaliseApi
   module Resources
     class Task < Base
-      ID_KEY = 'task_id'
-      supports :update, :destroy, [:reload_data, '', :find]
-
-      class << self
-        def endpoint(project_id, task_id = nil)
-          path_from projects: project_id,
-                    tasks: task_id
-        end
-      end
+      MAIN_PARAMS = %i[project_id task_id].freeze
     end
   end
 end

data/lib/ruby_lokalise_api/resources/team.rb

@@ -3,6 +3,8 @@
 module RubyLokaliseApi
   module Resources
     class Team < Base
+      MAIN_PARAMS = [].freeze
+      no_support_for %i[update destroy reload_data]
     end
   end
 end

data/lib/ruby_lokalise_api/resources/team_user.rb

@@ -3,15 +3,7 @@
 module RubyLokaliseApi
   module Resources
     class TeamUser < Base
-      ID_KEY = 'user_id'
-      supports :update, :destroy, [:reload_data, '', :find]
-
-      class << self
-        def endpoint(team_id, team_user_id = nil)
-          path_from teams: team_id,
-                    users: team_user_id
-        end
-      end
+      MAIN_PARAMS = %i[team_id user_id].freeze
     end
   end
 end

data/lib/ruby_lokalise_api/resources/team_user_billing_details.rb

@@ -3,11 +3,16 @@
 module RubyLokaliseApi
   module Resources
     class TeamUserBillingDetails < Base
-      class << self
-        def endpoint(team_id)
-          path_from teams: team_id,
-                    billing_details: ''
-        end
+      MAIN_PARAMS = %i[team_id].freeze
+      no_support_for %i[destroy]
+
+      def update(params)
+        response = reinit_endpoint(params).do_put
+
+        # We must patch content because the API does not return team_id and it's mandatory to build resource URL
+        response.patch_content_with 'team_id', @team_id
+
+        self.class.new response
       end
     end
   end

data/lib/ruby_lokalise_api/resources/team_user_group.rb

@@ -3,21 +3,13 @@
 module RubyLokaliseApi
   module Resources
     class TeamUserGroup < Base
-      DATA_KEY = 'Group'
-      ID_KEY = 'group_id'
-      supports :update, :destroy,
-               [:add_projects, '/projects/add', :update],
-               [:remove_projects, '/projects/remove', :update],
-               [:add_users, '/members/add', :update],
-               [:remove_users, '/members/remove', :update],
-               [:reload_data, '', :find]
+      MAIN_PARAMS = %i[team_id group_id].freeze
+      DATA_KEY = 'group'
 
-      class << self
-        def endpoint(team_id, team_user_group_id = nil, *actions)
-          path_from teams: team_id,
-                    groups: [team_user_group_id, *actions]
-        end
-      end
+      delegate_call :add_projects, :add_projects_to_group
+      delegate_call :remove_projects, :remove_projects_from_group
+      delegate_call :add_members, :add_members_to_group
+      delegate_call :remove_members, :remove_members_from_group
     end
   end
 end

data/lib/ruby_lokalise_api/resources/translation.rb

@@ -3,15 +3,8 @@
 module RubyLokaliseApi
   module Resources
     class Translation < Base
-      ID_KEY = 'translation_id'
-      supports :update, [:reload_data, '', :find]
-
-      class << self
-        def endpoint(project_id, translation_id = nil)
-          path_from projects: project_id,
-                    translations: translation_id
-        end
-      end
+      MAIN_PARAMS = %i[project_id translation_id].freeze
+      no_support_for %i[destroy]
     end
   end
 end

data/lib/ruby_lokalise_api/resources/translation_provider.rb

@@ -3,15 +3,8 @@
 module RubyLokaliseApi
   module Resources
     class TranslationProvider < Base
-      supports [:reload_data, '', :find]
-      ID_KEY = 'provider_id'
-
-      class << self
-        def endpoint(team_id, provider_id = nil)
-          path_from teams: team_id,
-                    translation_providers: provider_id
-        end
-      end
+      MAIN_PARAMS = %i[team_id provider_id].freeze
+      no_support_for %i[update destroy]
     end
   end
 end

data/lib/ruby_lokalise_api/resources/webhook.rb

@@ -3,23 +3,9 @@
 module RubyLokaliseApi
   module Resources
     class Webhook < Base
-      ID_KEY = 'webhook_id'
-      supports :update, :destroy, [:reload_data, '', :find]
+      MAIN_PARAMS = %i[project_id webhook_id].freeze
 
-      def regenerate_secret
-        self.class.regenerate_secret @client, "#{@path}/secret/regenerate"
-      end
-
-      class << self
-        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, *actions]
-        end
-      end
+      delegate_call :regenerate_secret, :regenerate_webhook_secret
     end
   end
 end

data/lib/ruby_lokalise_api/response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  # This class is utilized to prepare Lokalise API response
+  class Response
+    # 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
+
+    attr_reader :content, :endpoint, :headers
+
+    def initialize(body, endpoint, raw_headers = {})
+      @content = body
+      @endpoint = endpoint
+      @headers = extract_headers_from raw_headers
+    end
+
+    # Adds attribute to the raw content returned by the API.
+    # Sometimes this is required to store important data like team_id or project_id
+    # that is not returned in the response but required to properly build resources URIs
+    def patch_content_with(attribute, value)
+      @content[attribute] = value
+    end
+
+    # Sets endpoint to a new value.
+    # This is required in rare cases when the response contains a resource of different kind.
+    # For example, when restoring a snapshot, it returns a new project which means that
+    # initially we were working with a snapshots endpoint but the response should contain
+    # the projects endpoint to properly preserve method chaining
+    def patch_endpoint_with(new_endpoint)
+      @endpoint = new_endpoint
+    end
+
+    # Returns an array of pagination headers
+    def pagination_headers
+      self.class.const_get(:PAGINATION_HEADERS)
+    end
+
+    private
+
+    # Keep only pagination headers
+    def extract_headers_from(raw_headers)
+      raw_headers.
+        to_h.
+        keep_if { |header, _value| pagination_headers.include?(header) }.
+        transform_keys(&:to_sym).
+        transform_values(&:to_i)
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/branches.rb

@@ -3,66 +3,91 @@
 module RubyLokaliseApi
   module Rest
     module Branches
-      # Returns all branches for the given project
+      # Returns project branches
       #
       # @see https://developers.lokalise.com/reference/list-all-branches
-      # @return [RubyLokaliseApi::Collection::Branch<RubyLokaliseApi::Resources::Branch>]
+      # @return [RubyLokaliseApi::Collections::Branches]
       # @param project_id [String]
-      # @param params [Hash]
-      def branches(project_id, params = {})
-        c_r RubyLokaliseApi::Collections::Branch, :all, project_id, params
+      # @param req_params [Hash]
+      def branches(project_id, req_params = {})
+        name = 'Branches'
+        params = { query: project_id, req: req_params }
+
+        data = endpoint(name: name, params: params).do_get
+
+        collection name, data
       end
 
-      # Creates a new branch inside the given project
+      # Returns a single branch
       #
-      # @see https://developers.lokalise.com/reference/create-a-branch
+      # @see https://developers.lokalise.com/reference/retrieve-a-branch
       # @return [RubyLokaliseApi::Resources::Branch]
       # @param project_id [String]
-      # @param params [Hash]
-      def create_branch(project_id, params)
-        c_r RubyLokaliseApi::Resources::Branch, :create, project_id, params
+      # @param branch_id [String, Integer]
+      def branch(project_id, branch_id)
+        params = { query: [project_id, branch_id] }
+
+        data = endpoint(name: 'Branches', params: params).do_get
+
+        resource 'Branch', data
       end
 
-      # Returns a single branch for the given project
+      # Creates a branch
       #
-      # @see https://developers.lokalise.com/reference/retrieve-a-branch
+      # @see https://developers.lokalise.com/reference/create-a-branch
       # @return [RubyLokaliseApi::Resources::Branch]
       # @param project_id [String]
-      # @param branch_id [String, Integer]
-      def branch(project_id, branch_id)
-        c_r RubyLokaliseApi::Resources::Branch, :find, [project_id, branch_id]
+      # @param req_params [Hash]
+      def create_branch(project_id, req_params)
+        params = { query: project_id, req: req_params }
+
+        data = endpoint(name: 'Branches', params: params).do_post
+
+        resource 'Branch', data
       end
 
-      # Updates the given branch inside the given project
+      # Updates a branch
       #
       # @see https://developers.lokalise.com/reference/update-a-branch
       # @return [RubyLokaliseApi::Resources::Branch]
       # @param project_id [String]
       # @param branch_id [String, Integer]
-      # @param params [Hash]
-      def update_branch(project_id, branch_id, params)
-        c_r RubyLokaliseApi::Resources::Branch, :update, [project_id, branch_id], params
+      # @param req_params [Hash]
+      def update_branch(project_id, branch_id, req_params = {})
+        params = { query: [project_id, branch_id], req: req_params }
+
+        data = endpoint(name: 'Branches', params: params).do_put
+
+        resource 'Branch', data
       end
 
-      # Deletes branch inside the given project
+      # Deletes a branch
       #
       # @see https://developers.lokalise.com/reference/delete-a-branch
-      # @return [Hash]
+      # @return [RubyLokaliseApi::Generics::DeletedResource]
       # @param project_id [String]
       # @param branch_id [String, Integer]
       def destroy_branch(project_id, branch_id)
-        c_r RubyLokaliseApi::Resources::Branch, :destroy, [project_id, branch_id]
+        params = { query: [project_id, branch_id] }
+
+        data = endpoint(name: 'Branches', params: params).do_delete
+
+        RubyLokaliseApi::Generics::DeletedResource.new data.content
       end
 
-      # Merges a branch in the project
+      # Merges two branches
       #
       # @see https://developers.lokalise.com/reference/merge-a-branch
-      # @return [Hash]
+      # @return [RubyLokaliseApi::Generics::MergedBranches]
       # @param project_id [String]
       # @param branch_id [String, Integer]
-      # @param params [Hash]
-      def merge_branch(project_id, branch_id, params = {})
-        c_r RubyLokaliseApi::Resources::Branch, :merge, [project_id, branch_id, :merge], params
+      # @param req_params [Hash]
+      def merge_branch(project_id, branch_id, req_params)
+        params = { query: [project_id, branch_id, :merge], req: req_params }
+
+        data = endpoint(name: 'Branches', params: params).do_post
+
+        RubyLokaliseApi::Generics::MergedBranches.new data.content
       end
     end
   end

data/lib/ruby_lokalise_api/rest/comments.rb

@@ -3,7 +3,9 @@
 module RubyLokaliseApi
   module Rest
     module Comments
-      # Returns a single comment for the given key
+      using RubyLokaliseApi::Utils::Classes
+
+      # Returns a single key comment
       #
       # @see https://developers.lokalise.com/reference/retrieve-a-comment
       # @return [RubyLokaliseApi::Resources::Comment]
@@ -11,50 +13,73 @@ module RubyLokaliseApi
       # @param key_id [String, Integer]
       # @param comment_id [String, Integer]
       def comment(project_id, key_id, comment_id)
-        c_r RubyLokaliseApi::Resources::KeyComment, :find, [project_id, key_id, comment_id]
+        params = { query: [project_id, key_id, comment_id] }
+
+        data = endpoint(name: 'KeyComments', params: params).do_get
+
+        resource 'Comment', data
       end
 
-      # Returns all comments for all keys inside the given project
+      # Returns all comments for a key
       #
-      # @see https://developers.lokalise.com/reference/list-project-comments
-      # @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
+      # @see https://developers.lokalise.com/reference/list-key-comments
+      # @return [RubyLokaliseApi::Collections::KeyComments]
       # @param project_id [String]
-      # @param params [Hash]
-      def project_comments(project_id, params = {})
-        c_r RubyLokaliseApi::Collections::ProjectComment, :all, project_id, params
+      # @param key_id [String, Integer]
+      # @param req_params [Hash]
+      def comments(project_id, key_id, req_params = {})
+        name = 'KeyComments'
+        params = { query: [project_id, key_id], req: req_params }
+
+        data = endpoint(name: name, params: params).do_get
+
+        collection name, data
       end
 
-      # Returns all comments for the given key inside the given project
+      # Returns all comments for a project
       #
-      # @see https://developers.lokalise.com/reference/list-key-comments
-      # @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
+      # @see https://developers.lokalise.com/reference/list-project-comments
+      # @return [RubyLokaliseApi::Collections::ProjectComments]
       # @param project_id [String]
-      # @param key_id [String, Integer]
-      # @param params [Hash]
-      def comments(project_id, key_id, params = {})
-        c_r RubyLokaliseApi::Collections::KeyComment, :all, [project_id, key_id], params
+      # @param req_params [Hash]
+      def project_comments(project_id, req_params = {})
+        name = 'ProjectComments'
+        params = { query: project_id, req: req_params }
+
+        data = endpoint(name: name, params: params).do_get
+
+        collection name, data
       end
 
-      # Creates one or more comments for the given key inside the given project
+      # Creates one or multiple comments for a key
       #
       # @see https://developers.lokalise.com/reference/create-comments
-      # @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
+      # @return [RubyLokaliseApi::Collections::KeyComments]
       # @param project_id [String]
       # @param key_id [String, Integer]
-      # @param params [Hash, Array<Hash>]
-      def create_comments(project_id, key_id, params)
-        c_r RubyLokaliseApi::Resources::KeyComment, :create, [project_id, key_id], params, :comments
+      # @param req_params [Hash, Array]
+      def create_comments(project_id, key_id, req_params)
+        name = 'KeyComments'
+        params = { query: [project_id, key_id], req: req_params.to_array_obj(:comments) }
+
+        data = endpoint(name: name, params: params).do_post
+
+        collection name, data
       end
 
-      # Deletes comment for the given key inside the given project
+      # Deletes a single key comment
       #
       # @see https://developers.lokalise.com/reference/delete-a-comment
-      # @return [Hash]
+      # @return [RubyLokaliseApi::Generics::DeletedResource]
       # @param project_id [String]
       # @param key_id [String, Integer]
       # @param comment_id [String, Integer]
       def destroy_comment(project_id, key_id, comment_id)
-        c_r RubyLokaliseApi::Resources::KeyComment, :destroy, [project_id, key_id, comment_id]
+        params = { query: [project_id, key_id, comment_id] }
+
+        data = endpoint(name: 'KeyComments', params: params).do_delete
+
+        RubyLokaliseApi::Generics::DeletedResource.new data.content
       end
     end
   end

data/lib/ruby_lokalise_api/rest/contributors.rb

@@ -3,55 +3,79 @@
 module RubyLokaliseApi
   module Rest
     module Contributors
-      # Returns all contributors for the given project
-      #
-      # @see https://developers.lokalise.com/reference/list-all-contributors
-      # @return [RubyLokaliseApi::Collection::Contributor<RubyLokaliseApi::Resources::Contributor>]
-      # @param project_id [String]
-      # @param params [Hash]
-      def contributors(project_id, params = {})
-        c_r RubyLokaliseApi::Collections::Contributor, :all, project_id, params
-      end
+      using RubyLokaliseApi::Utils::Classes
 
-      # Returns a single contributor for the given project
+      # Returns a single contributor
       #
       # @see https://developers.lokalise.com/reference/retrieve-a-contributor
       # @return [RubyLokaliseApi::Resources::Contributor]
       # @param project_id [String]
       # @param contributor_id [String, Integer]
       def contributor(project_id, contributor_id)
-        c_r RubyLokaliseApi::Resources::Contributor, :find, [project_id, contributor_id]
+        params = { query: [project_id, contributor_id] }
+
+        data = endpoint(name: 'Contributors', params: params).do_get
+
+        resource 'Contributor', data
       end
 
-      # Creates one or more contributors inside the given project
+      # Returns project contributors
+      #
+      # @see https://developers.lokalise.com/reference/list-all-contributors
+      # @return [RubyLokaliseApi::Collections::Contributors]
+      # @param project_id [String]
+      # @param req_params [Hash]
+      def contributors(project_id, req_params = {})
+        name = 'Contributors'
+        params = { query: project_id, req: req_params }
+
+        data = endpoint(name: name, params: params).do_get
+
+        collection name, data
+      end
+
+      # Creates one or multiple contributors for a project
       #
       # @see https://developers.lokalise.com/reference/create-contributors
-      # @return [RubyLokaliseApi::Collection::Contributor<RubyLokaliseApi::Resources::Contributor>]
+      # @return [RubyLokaliseApi::Collections::Contributors]
       # @param project_id [String]
-      # @param params [Hash, Array<Hash>]
-      def create_contributors(project_id, params)
-        c_r RubyLokaliseApi::Resources::Contributor, :create, project_id, params, :contributors
+      # @param req_params [Hash, Array]
+      def create_contributors(project_id, req_params)
+        name = 'Contributors'
+        params = { query: project_id, req: req_params.to_array_obj(:contributors) }
+
+        data = endpoint(name: name, params: params).do_post
+
+        collection name, data
       end
 
-      # Updates the given contributor inside the given project
+      # Updates a contributor for a project
       #
       # @see https://developers.lokalise.com/reference/update-a-contributor
       # @return [RubyLokaliseApi::Resources::Contributor]
       # @param project_id [String]
       # @param contributor_id [String, Integer]
-      # @param params [Hash]
-      def update_contributor(project_id, contributor_id, params)
-        c_r RubyLokaliseApi::Resources::Contributor, :update, [project_id, contributor_id], params
+      # @param req_params [Hash]
+      def update_contributor(project_id, contributor_id, req_params)
+        params = { query: [project_id, contributor_id], req: req_params }
+
+        data = endpoint(name: 'Contributors', params: params).do_put
+
+        resource 'Contributor', data
       end
 
-      # Deletes contributor inside the given project
+      # Deletes a single contributor from the project
       #
       # @see https://developers.lokalise.com/reference/delete-a-contributor
-      # @return [Hash]
+      # @return [RubyLokaliseApi::Generics::DeletedResource]
       # @param project_id [String]
       # @param contributor_id [String, Integer]
       def destroy_contributor(project_id, contributor_id)
-        c_r RubyLokaliseApi::Resources::Contributor, :destroy, [project_id, contributor_id]
+        params = { query: [project_id, contributor_id] }
+
+        data = endpoint(name: 'Contributors', params: params).do_delete
+
+        RubyLokaliseApi::Generics::DeletedResource.new data.content
       end
     end
   end