ruby-lokalise-api 1.1.0 → 2.0.0

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

@@ -2,12 +2,14 @@ module Lokalise
   module Resources
     class KeyComment < Base
       DATA_KEY = 'Comment'.freeze
+      ID_KEY = 'comment'.freeze
+      supports :destroy
 
       class << self
-        private
-
-        def endpoint(project_id, key_id)
-          "projects/#{project_id}/keys/#{key_id}/comments"
+        def endpoint(project_id, key_id, comment_id = nil)
+          path_from projects: project_id,
+                    keys: key_id,
+                    comments: comment_id
         end
       end
     end

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

@@ -1,16 +1,19 @@
 module Lokalise
   module Resources
     class Project < Base
+      supports :update, :destroy
+
+      def empty
+        self.class.empty @client, @path + '/empty'
+      end
+
       class << self
-        def clear(client, project_id)
-          put("#{endpoint(project_id)}/empty", client)['content']
+        def empty(client, path, *_args)
+          put(path, client)['content']
         end
 
-        private
-
-        def endpoint(project_id = nil)
-          'projects' unless project_id
-          "projects/#{project_id}"
+        def endpoint(project_id = nil, action = nil)
+          path_from projects: [project_id, action]
         end
       end
     end

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

@@ -2,12 +2,13 @@ module Lokalise
   module Resources
     class ProjectLanguage < Base
       DATA_KEY = 'Language'.freeze
+      ID_KEY = 'lang'.freeze
+      supports :update, :destroy
 
       class << self
-        private
-
-        def endpoint(project_id)
-          "projects/#{project_id}/languages"
+        def endpoint(project_id, language_id = nil)
+          path_from projects: project_id,
+                    languages: language_id
         end
       end
     end

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

@@ -1,11 +1,12 @@
 module Lokalise
   module Resources
     class Screenshot < Base
-      class << self
-        private
+      supports :update, :destroy
 
-        def endpoint(project_id)
-          "projects/#{project_id}/screenshots"
+      class << self
+        def endpoint(project_id, screenshot_id = nil)
+          path_from projects: project_id,
+                    screenshots: screenshot_id
         end
       end
     end

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

@@ -1,15 +1,20 @@
 module Lokalise
   module Resources
     class Snapshot < Base
+      supports :destroy
+
+      def restore
+        self.class.restore @client, @path
+      end
+
       class << self
-        def restore(client, project_id, snapshot_id)
-          Lokalise::Resources::Project.new post(endpoint(project_id, snapshot_id), client)
+        def restore(client, path, *_args)
+          Lokalise::Resources::Project.new post(path, client)
         end
 
-        private
-
         def endpoint(project_id, snapshot_id = nil)
-          "projects/#{project_id}/snapshots/#{snapshot_id}"
+          path_from projects: project_id,
+                    snapshots: snapshot_id
         end
       end
     end

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

@@ -1,11 +1,12 @@
 module Lokalise
   module Resources
     class Task < Base
-      class << self
-        private
+      supports :update, :destroy
 
-        def endpoint(project_id)
-          "projects/#{project_id}/tasks"
+      class << self
+        def endpoint(project_id, task_id = nil)
+          path_from projects: project_id,
+                    tasks: task_id
         end
       end
     end

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

@@ -1,11 +1,13 @@
 module Lokalise
   module Resources
     class TeamUser < Base
-      class << self
-        private
+      ID_KEY = 'user'.freeze
+      supports :update, :destroy
 
-        def endpoint(team_id)
-          "teams/#{team_id}/users"
+      class << self
+        def endpoint(team_id, team_user_id = nil)
+          path_from teams: team_id,
+                    users: team_user_id
         end
       end
     end

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

@@ -1,11 +1,12 @@
 module Lokalise
   module Resources
     class Translation < Base
-      class << self
-        private
+      supports :update
 
-        def endpoint(project_id)
-          "projects/#{project_id}/translations"
+      class << self
+        def endpoint(project_id, translation_id = nil)
+          path_from projects: project_id,
+                    translations: translation_id
         end
       end
     end

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

@@ -8,7 +8,7 @@ module Lokalise
     # @param key_id [String, Integer]
     # @param comment_id [String, Integer]
     def comment(project_id, key_id, comment_id)
-      Lokalise::Resources::KeyComment.find self, [project_id, key_id], comment_id
+      c_r Lokalise::Resources::KeyComment, :find, [project_id, key_id, comment_id]
     end
 
     # Returns all comments for all keys inside the given project
@@ -18,7 +18,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def project_comments(project_id, params = {})
-      Lokalise::Collections::ProjectComment.all self, params, project_id
+      c_r Lokalise::Collections::ProjectComment, :all, project_id, params
     end
 
     # Returns all comments for the given key inside the given project
@@ -29,7 +29,7 @@ module Lokalise
     # @param key_id [String, Integer]
     # @param params [Hash]
     def comments(project_id, key_id, params = {})
-      Lokalise::Collections::KeyComment.all self, params, project_id, key_id
+      c_r Lokalise::Collections::KeyComment, :all, [project_id, key_id], params
     end
 
     # Creates one or more comments for the given key inside the given project
@@ -40,7 +40,7 @@ module Lokalise
     # @param key_id [String, Integer]
     # @param params [Hash, Array<Hash>]
     def create_comments(project_id, key_id, params)
-      Lokalise::Resources::KeyComment.create self, [project_id, key_id], params, :comments
+      c_r Lokalise::Resources::KeyComment, :create, [project_id, key_id], params, :comments
     end
 
     # Deletes comment for the given key inside the given project
@@ -50,8 +50,8 @@ module Lokalise
     # @param project_id [String]
     # @param key_id [String, Integer]
     # @param comment_id [String, Integer]
-    def delete_comment(project_id, key_id, comment_id)
-      Lokalise::Resources::KeyComment.destroy self, [project_id, key_id], comment_id
+    def destroy_comment(project_id, key_id, comment_id)
+      c_r Lokalise::Resources::KeyComment, :destroy, [project_id, key_id, comment_id]
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def contributors(project_id, params = {})
-      Lokalise::Collections::Contributor.all self, params, project_id
+      c_r Lokalise::Collections::Contributor, :all, project_id, params
     end
 
     # Returns a single contributor for the given project
@@ -17,7 +17,7 @@ module Lokalise
     # @param project_id [String]
     # @param contributor_id [String, Integer]
     def contributor(project_id, contributor_id)
-      Lokalise::Resources::Contributor.find self, project_id, contributor_id
+      c_r Lokalise::Resources::Contributor, :find, [project_id, contributor_id]
     end
 
     # Creates one or more contributors inside the given project
@@ -27,7 +27,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash, Array<Hash>]
     def create_contributors(project_id, params)
-      Lokalise::Resources::Contributor.create self, project_id, params, :contributors
+      c_r Lokalise::Resources::Contributor, :create, project_id, params, :contributors
     end
 
     # Updates the given contributor inside the given project
@@ -38,7 +38,7 @@ module Lokalise
     # @param contributor_id [String, Integer]
     # @param params [Hash]
     def update_contributor(project_id, contributor_id, params)
-      Lokalise::Resources::Contributor.update self, project_id, contributor_id, params
+      c_r Lokalise::Resources::Contributor, :update, [project_id, contributor_id], params
     end
 
     # Deletes contributor inside the given project
@@ -47,8 +47,8 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String]
     # @param contributor_id [String, Integer]
-    def delete_contributor(project_id, contributor_id)
-      Lokalise::Resources::Contributor.destroy self, project_id, contributor_id
+    def destroy_contributor(project_id, contributor_id)
+      c_r Lokalise::Resources::Contributor, :destroy, [project_id, contributor_id]
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def files(project_id, params = {})
-      Lokalise::Collections::File.all self, params, project_id
+      c_r Lokalise::Collections::File, :all, project_id, params
     end
 
     # Exports translation files as .zip bundle, uploads them to Amazon S3 and returns a URL to the generated bundle. The URL is valid for a year
@@ -17,7 +17,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def download_files(project_id, params)
-      Lokalise::Resources::File.download self, project_id, params
+      c_r Lokalise::Resources::File, :download, [project_id, 'download'], params
     end
 
     # Imports translation file to the given project. File data must base64-encoded
@@ -27,7 +27,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def upload_file(project_id, params)
-      Lokalise::Resources::File.upload self, project_id, params
+      c_r Lokalise::Resources::File, :upload, [project_id, 'upload'], params
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def keys(project_id, params = {})
-      Lokalise::Collections::Key.all self, params, project_id
+      c_r Lokalise::Collections::Key, :all, project_id, params
     end
 
     # Returns a single translation key for the given project
@@ -18,7 +18,7 @@ module Lokalise
     # @param key_id [String, Integer]
     # @param params [Hash]
     def key(project_id, key_id, params = {})
-      Lokalise::Resources::Key.find self, project_id, key_id, params
+      c_r Lokalise::Resources::Key, :find, [project_id, key_id], params
     end
 
     # Creates one or more translation keys for the given project
@@ -28,7 +28,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash, Array<Hash>]
     def create_keys(project_id, params = {})
-      Lokalise::Resources::Key.create self, project_id, params, :keys
+      c_r Lokalise::Resources::Key, :create, project_id, params, :keys
     end
 
     # Updates translation key for the given project
@@ -39,7 +39,7 @@ module Lokalise
     # @param key_id [String, Integer]
     # @param params [Hash]
     def update_key(project_id, key_id, params = {})
-      Lokalise::Resources::Key.update self, project_id, key_id, params
+      c_r Lokalise::Resources::Key, :update, [project_id, key_id], params
     end
 
     # Updates one or multiple translation keys for the given project
@@ -49,7 +49,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash, Array<Hash>]
     def update_keys(project_id, params)
-      Lokalise::Resources::Key.update self, project_id, nil, params, :keys
+      c_r Lokalise::Resources::Key, :update, project_id, params, :keys
     end
 
     # Deletes translation key for the given project
@@ -58,8 +58,8 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String]
     # @param key_id [String, Integer]
-    def delete_key(project_id, key_id)
-      Lokalise::Resources::Key.destroy self, project_id, key_id
+    def destroy_key(project_id, key_id)
+      c_r Lokalise::Resources::Key, :destroy, [project_id, key_id]
     end
 
     # Deletes one or multiple translation keys for the given project
@@ -68,8 +68,8 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String]
     # @param key_ids [String, Integer, Array<String>, Array<Integer>]
-    def delete_keys(project_id, key_ids)
-      Lokalise::Resources::Key.destroy self, project_id, keys: key_ids
+    def destroy_keys(project_id, key_ids)
+      c_r Lokalise::Resources::Key, :destroy, project_id, key_ids, :keys
     end
   end
 end

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

@@ -6,7 +6,7 @@ module Lokalise
     # @return [Lokalise::Collection::SystemLanguage<Lokalise::Resources::SystemLanguage>]
     # @param params [Hash]
     def system_languages(params = {})
-      Lokalise::Collections::SystemLanguage.all self, params
+      c_r Lokalise::Collections::SystemLanguage, :all, nil, params
     end
 
     # Returns all languages for the given project
@@ -16,7 +16,7 @@ module Lokalise
     # @param project_id [String, Integer]
     # @param params [Hash]
     def project_languages(project_id, params = {})
-      Lokalise::Collections::ProjectLanguage.all self, params, project_id
+      c_r Lokalise::Collections::ProjectLanguage, :all, project_id, params
     end
 
     # Returns a single language for the given project
@@ -26,7 +26,7 @@ module Lokalise
     # @param project_id [String]
     # @param language_id [String, Integer]
     def language(project_id, language_id)
-      Lokalise::Resources::ProjectLanguage.find self, project_id, language_id
+      c_r Lokalise::Resources::ProjectLanguage, :find, [project_id, language_id]
     end
 
     # Creates one or more language for the given project
@@ -36,7 +36,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def create_languages(project_id, params)
-      Lokalise::Resources::ProjectLanguage.create self, project_id, params, :languages
+      c_r Lokalise::Resources::ProjectLanguage, :create, project_id, params, :languages
     end
 
     # Updates language for the given project
@@ -47,7 +47,7 @@ module Lokalise
     # @param language_id [String, Integer]
     # @param params [Hash]
     def update_language(project_id, language_id, params)
-      Lokalise::Resources::ProjectLanguage.update self, project_id, language_id, params
+      c_r Lokalise::Resources::ProjectLanguage, :update, [project_id, language_id], params
     end
 
     # Deletes language for the given project
@@ -56,8 +56,8 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String]
     # @param language_id [String, Integer]
-    def delete_language(project_id, language_id)
-      Lokalise::Resources::ProjectLanguage.destroy self, project_id, language_id
+    def destroy_language(project_id, language_id)
+      c_r Lokalise::Resources::ProjectLanguage, :destroy, [project_id, language_id]
     end
   end
 end

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

@@ -6,7 +6,7 @@ module Lokalise
     # @return [Lokalise::Collection::Project<Lokalise::Resources::Project>]
     # @param params [Hash]
     def projects(params = {})
-      Lokalise::Collections::Project.all self, params
+      c_r Lokalise::Collections::Project, :all, nil, params
     end
 
     # Returns a single project
@@ -15,7 +15,7 @@ module Lokalise
     # @return [Lokalise::Resources::Project]
     # @param project_id [String, Integer]
     def project(project_id)
-      Lokalise::Resources::Project.find self, nil, project_id
+      c_r Lokalise::Resources::Project, :find, project_id
     end
 
     # Creates project
@@ -24,7 +24,7 @@ module Lokalise
     # @return [Lokalise::Resources::Project]
     # @param params [Hash]
     def create_project(params)
-      Lokalise::Resources::Project.create self, nil, params
+      c_r Lokalise::Resources::Project, :create, nil, params
     end
 
     # Updates project
@@ -34,7 +34,7 @@ module Lokalise
     # @param project_id [String, Integer]
     # @param params [Hash]
     def update_project(project_id, params)
-      Lokalise::Resources::Project.update self, nil, project_id, params
+      c_r Lokalise::Resources::Project, :update, project_id, params
     end
 
     # Deletes all keys and translations from the project
@@ -43,7 +43,7 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String, Integer]
     def empty_project(project_id)
-      Lokalise::Resources::Project.clear self, project_id
+      c_r Lokalise::Resources::Project, :empty, [project_id, 'empty']
     end
 
     # Deletes the project
@@ -51,8 +51,8 @@ module Lokalise
     # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-project-delete
     # @return [Hash]
     # @param project_id [String, Integer]
-    def delete_project(project_id)
-      Lokalise::Resources::Project.destroy self, nil, project_id
+    def destroy_project(project_id)
+      c_r Lokalise::Resources::Project, :destroy, project_id
     end
   end
 end