crowdin-api 1.1.1 → 1.3.0

data/lib/crowdin-api/api_resources/screenshots.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Screenshots
+      def list_screenshots(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_screenshot(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_screenshot(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def update_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_screenshot(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def replace_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_tag(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def clear_tags(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_tag(screenshot_id = nil, tag_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/{api-resources → api_resources}/source_files.rb

@@ -7,26 +7,24 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/branches",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/branches",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def add_branch(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/branches",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/branches",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_branch(branch_id = nil, project_id = config.project_id)
@@ -34,12 +32,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/branches/#{branch_id}"
+          "#{config.target_api_url}/projects/#{project_id}/branches/#{branch_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def delete_branch(branch_id = nil, project_id = config.project_id)
@@ -47,12 +44,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/projects/#{project_id}/branches/#{branch_id}"
+          "#{config.target_api_url}/projects/#{project_id}/branches/#{branch_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def edit_branch(branch_id = nil, query = {}, project_id = config.project_id)
@@ -60,39 +56,36 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :patch,
-          "/projects/#{project_id}/branches/#{branch_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/branches/#{branch_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def list_directories(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/directories",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/directories",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def add_directory(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/directories",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/directories",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_directory(directory_id = nil, project_id = config.project_id)
@@ -100,12 +93,11 @@ module Crowdin
         project_id   || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/directories/#{directory_id}"
+          "#{config.target_api_url}/projects/#{project_id}/directories/#{directory_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def delete_directory(directory_id = nil, project_id = config.project_id)
@@ -113,12 +105,11 @@ module Crowdin
         project_id   || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/projects/#{project_id}/directories/#{directory_id}"
+          "#{config.target_api_url}/projects/#{project_id}/directories/#{directory_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def edit_directory(directory_id = nil, query = {}, project_id = config.project_id)
@@ -126,57 +117,36 @@ module Crowdin
         project_id   || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :patch,
-          "/projects/#{project_id}/directories/#{directory_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/directories/#{directory_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def list_files(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/files",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/files",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
-      # Add custom language.
-      #
-      # === Parameters
-      #
-      # * +:projectId+ [Integer] - Project Identifier. Get via list_projects. Can be initialized with the Crowdin Client
-      # * +:storageId+ [Integer] - Storage Identifier. Get via list_storages
-      # * +:name+ [String] - File name. Note: Can't contain \ / : * ? " < > | symbols. ZIP files are not allowed.
-      #
-      # === Example
-      #
-      # when you're initialized Crowdin Client with a project_id
-      #
-      #  crowdin.add_file(storage_id: your_storage_id, name: 'your_filename')
-      #
-      # or you can specify project_id
-      #
-      #  crowdin.add_file({ storage_id: your_storage_id, name: 'your_filename' }, your_project_id)
-      #
       def add_file(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/files",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/files",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_file(file_id = nil, project_id = config.project_id)
@@ -184,12 +154,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/files/#{file_id}"
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def update_or_restore_file(file_id = nil, query = {}, project_id = config.project_id)
@@ -197,13 +166,12 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :put,
-          "/projects/#{project_id}/files/#{file_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def delete_file(file_id = nil, project_id = config.project_id)
@@ -211,12 +179,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/projects/#{project_id}/files/#{file_id}"
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def edit_file(file_id = nil, query = {}, project_id = config.project_id)
@@ -224,65 +191,37 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :patch,
-          "/projects/#{project_id}/files/#{file_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def download_file(file_id = nil, destination = nil, project_id = config.project_id)
-        destination || raise_parameter_is_required_error(:destination)
         file_id     || raise_parameter_is_required_error(:file_id)
         project_id  || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/files/#{file_id}/download",
-          {},
-          {},
-          destination
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/download"
         )
-
-        request.perform
+        Web::SendRequest.new(request, destination).perform
       end
 
-      # List file revisions.
-      #
-      # === Parameters
-      #
-      # * +:projectId+ [Integer] - Project Identifier. Get via list_projects. Can be initialized with the Crowdin Client
-      # * +:fileId+ [Integer] - File Identifier. Get via list_files
-      #
-      # Optional:
-      # * +:limit+ [Integer 1..500] - A maximum number of items to retrieve, default - 25
-      # * +:offset+ [Integer >= 0] - A starting offset in the collection, default - 0
-      #
-      # === Example
-      #
-      # when you're initialized Crowdin Client with a project_id
-      #
-      #  crowdin.list_file_revisions(your_file_id, limit: your_value)
-      #
-      # or you can specify project_id
-      #
-      #  crowdin.list_file_revisions(your_file_id, { limit: your_value }, your_project_id)
-      #
       def list_file_revisions(file_id = nil, query = {}, project_id = config.project_id)
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/files/#{file_id}/revisions",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/revisions",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_file_revision(file_id = nil, revision_id = nil, project_id = config.project_id)
@@ -291,12 +230,11 @@ module Crowdin
         project_id  || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/files/#{file_id}/revisions/#{revision_id}"
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/revisions/#{revision_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
     end
   end

data/lib/crowdin-api/{api-resources → api_resources}/source_strings.rb

@@ -7,26 +7,24 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/strings",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/strings",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def add_string(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/strings",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/strings",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_string(string_id = nil, query = {}, project_id = config.project_id)
@@ -34,13 +32,12 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/strings/#{string_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/strings/#{string_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def delete_string(string_id = nil, project_id = config.project_id)
@@ -48,12 +45,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/projects/#{project_id}/strings/#{string_id}"
+          "#{config.target_api_url}/projects/#{project_id}/strings/#{string_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def edit_string(string_id = nil, query = {}, project_id = config.project_id)
@@ -61,13 +57,12 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :patch,
-          "/projects/#{project_id}/strings/#{string_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/strings/#{string_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
     end
   end

data/lib/crowdin-api/api_resources/storages.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Storages
+      def list_storages(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/storages",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_storage(file = nil)
+        file || raise_parameter_is_required_error(:file)
+
+        file    = file.is_a?(File) ? file : File.open(file, 'r')
+        headers = { 'Content-Type' => 'application/octet-stream', 'Crowdin-API-FileName' => File.basename(file) }
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/storages",
+          { params: file, headers: headers }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_storage(storage_id = nil)
+        storage_id || raise_parameter_is_required_error(:storage_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/storages/#{storage_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_storage(storage_id = nil)
+        storage_id || raise_parameter_is_required_error(:storage_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/storages/#{storage_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end