ruby-lokalise-api 5.0.0 → 6.0.0

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/oauth2/auth.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module OAuth2
     class Auth
-      include Lokalise::OAuth2::Request
+      include RubyLokaliseApi::OAuth2::Request
 
       attr_reader :client_id, :client_secret
 

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/oauth2/connection.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module OAuth2
     module Connection
       BASE_URL = URI('https://app.lokalise.com/oauth2/')
@@ -15,7 +15,7 @@ module Lokalise
         {
           headers: {
             accept: 'application/json',
-            user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}"
+            user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}"
           },
           url: BASE_URL.to_s
         }

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/oauth2/request.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module OAuth2
     module Request
-      include Lokalise::BaseRequest
-      include Lokalise::OAuth2::Connection
+      include RubyLokaliseApi::BaseRequest
+      include RubyLokaliseApi::OAuth2::Connection
 
       def post(path, params = {})
         respond_with connection.post(prepare(path), custom_dump(params))

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/oauth2_client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   class OAuth2Client < Client
     def initialize(token, params = {})
       super(token, params)

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/request.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Request
-    include Lokalise::BaseRequest
-    include Lokalise::Connection
+    include RubyLokaliseApi::BaseRequest
+    include RubyLokaliseApi::Connection
 
     # 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

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/base.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Base
-      using Lokalise::Utils::StringUtils
+      using RubyLokaliseApi::Utils::StringUtils
 
-      extend Lokalise::Request
-      extend Lokalise::Utils::AttributeHelpers
-      include Lokalise::Utils::AttributeHelpers
-      extend Lokalise::Utils::EndpointHelpers
+      extend RubyLokaliseApi::Request
+      extend RubyLokaliseApi::Utils::AttributeHelpers
+      include RubyLokaliseApi::Utils::AttributeHelpers
+      extend RubyLokaliseApi::Utils::EndpointHelpers
 
       attr_reader :raw_data, :project_id, :client, :path, :branch, :user_id, :team_id, :key_id
 
@@ -19,7 +19,7 @@ module Lokalise
       #
       # @param response [Hash]
       # @param endpoint_generator [Proc] Generate proper paths for certain resources
-      # @return [Lokalise::Resources::Base]
+      # @return [RubyLokaliseApi::Resources::Base]
       def initialize(response, endpoint_generator = nil)
         populate_attributes_for response['content']
         extract_common_attributes_for response['content']
@@ -120,7 +120,7 @@ module Lokalise
         end
 
         def produce_collection(model_class, response, params)
-          Module.const_get("Lokalise::Collections::#{model_class}").new(response, params)
+          Module.const_get("RubyLokaliseApi::Collections::#{model_class}").new(response, params)
         end
       end
 

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/branch.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Branch < Base
       ID_KEY = 'branch_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/contributor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Contributor < Base
       ID_KEY = 'user_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/custom_translation_status.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class CustomTranslationStatus < Base
       ID_KEY = 'status_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class File < Base
       class << self
@@ -9,7 +9,7 @@ module Lokalise
         end
 
         def upload(client, path, params)
-          klass = Lokalise::Resources::QueuedProcess
+          klass = RubyLokaliseApi::Resources::QueuedProcess
           klass.new post(path, client, params),
                     ->(project_id, id) { klass.endpoint(project_id, id) }
         end

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/key.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Key < Base
       ID_KEY = 'key_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/key_comment.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class KeyComment < Base
       DATA_KEY = 'Comment'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/order.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Order < Base
       ID_KEY = 'order_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/payment_card.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class PaymentCard < Base
       ID_KEY = 'card_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/project.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Project < Base
       ID_KEY = 'project_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/project_comment.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class ProjectComment < Base
       ID_KEY = 'comment_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/project_language.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class ProjectLanguage < Base
       DATA_KEY = 'Language'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/queued_process.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class QueuedProcess < Base
       DATA_KEY = 'Process'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/screenshot.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Screenshot < Base
       ID_KEY = 'screenshot_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/segment.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Segment < Base
       DATA_KEY = 'Segment'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/snapshot.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Snapshot < Base
       ID_KEY = 'snapshot_id'
@@ -12,7 +12,7 @@ module Lokalise
 
       class << self
         def restore(client, path, *_args)
-          klass = Lokalise::Resources::Project
+          klass = RubyLokaliseApi::Resources::Project
           klass.new post(path, client),
                     ->(project_id, *_ids) { klass.endpoint(project_id) }
         end

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/system_language.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class SystemLanguage < Base
       DATA_KEY = 'Language'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/task.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Task < Base
       ID_KEY = 'task_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/team.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Team < Base
     end

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/team_user.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class TeamUser < Base
       ID_KEY = 'user_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/team_user_billing_details.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class TeamUserBillingDetails < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/team_user_group.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class TeamUserGroup < Base
       DATA_KEY = 'Group'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/translation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Translation < Base
       ID_KEY = 'translation_id'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/translation_provider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class TranslationProvider < Base
       supports [:reload_data, '', :find]

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/resources/webhook.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Resources
     class Webhook < Base
       ID_KEY = 'webhook_id'

data/lib/ruby_lokalise_api/rest/branches.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Branches
+      # Returns all branches for the given project
+      #
+      # @see https://lokalise.com/api2docs/curl/#transition-list-all-branches-get
+      # @return [RubyLokaliseApi::Collection::Branch<RubyLokaliseApi::Resources::Branch>]
+      # @param project_id [String]
+      # @param params [Hash]
+      def branches(project_id, params = {})
+        c_r RubyLokaliseApi::Collections::Branch, :all, project_id, params
+      end
+
+      # Creates a new branch inside the given project
+      #
+      # @see https://lokalise.com/api2docs/curl/#transition-create-a-branch-post
+      # @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
+      end
+
+      # Returns a single branch for the given project
+      #
+      # @see https://lokalise.com/api2docs/curl/#transition-retrieve-a-branch-get
+      # @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]
+      end
+
+      # Updates the given branch inside the given project
+      #
+      # @see https://lokalise.com/api2docs/curl/#transition-update-a-branch-put
+      # @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
+      end
+
+      # Deletes branch inside the given project
+      #
+      # @see https://lokalise.com/api2docs/curl/#transition-delete-a-branch-delete
+      # @return [Hash]
+      # @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]
+      end
+
+      # Merges a branch in the project
+      #
+      # @see https://lokalise.com/api2docs/curl/#transition-merge-a-branch-post
+      # @return [Hash]
+      # @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
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/comments.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Comments
+      # Returns a single comment for the given key
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-comment-get
+      # @return [RubyLokaliseApi::Resources::Comment]
+      # @param project_id [String]
+      # @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]
+      end
+
+      # Returns all comments for all keys inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-list-project-comments-get
+      # @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
+      # @param project_id [String]
+      # @param params [Hash]
+      def project_comments(project_id, params = {})
+        c_r RubyLokaliseApi::Collections::ProjectComment, :all, project_id, params
+      end
+
+      # Returns all comments for the given key inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-list-key-comments-get
+      # @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
+      # @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
+      end
+
+      # Creates one or more comments for the given key inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-create-comments-post
+      # @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
+      # @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
+      end
+
+      # Deletes comment for the given key inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-comment-delete
+      # @return [Hash]
+      # @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]
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/contributors.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Contributors
+      # Returns all contributors for the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-contributors-get
+      # @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
+
+      # Returns a single contributor for the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-contributor-get
+      # @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]
+      end
+
+      # Creates one or more contributors inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-create-contributors-post
+      # @return [RubyLokaliseApi::Collection::Contributor<RubyLokaliseApi::Resources::Contributor>]
+      # @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
+      end
+
+      # Updates the given contributor inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-contributor-put
+      # @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
+      end
+
+      # Deletes contributor inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-contributor-delete
+      # @return [Hash]
+      # @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]
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/custom_translation_statuses.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module CustomTranslationStatuses
+      # Returns all translation statuses for the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-custom-translation-statuses-get
+      # @return [RubyLokaliseApi::Collection::CustomTranslationStatus<RubyLokaliseApi::Resources::CustomTranslationStatus>]
+      # @param project_id [String]
+      # @param params [Hash]
+      def translation_statuses(project_id, params = {})
+        c_r RubyLokaliseApi::Collections::CustomTranslationStatus, :all, project_id, params
+      end
+
+      # Returns a single translation status for the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-custom-translation-status-get
+      # @return [RubyLokaliseApi::Resources::CustomTranslationStatus]
+      # @param project_id [String]
+      # @param status_id [String, Integer]
+      def translation_status(project_id, status_id)
+        c_r RubyLokaliseApi::Resources::CustomTranslationStatus, :find, [project_id, status_id]
+      end
+
+      # Creates translation status inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-custom-translation-status-post
+      # @return RubyLokaliseApi::Resources::CustomTranslationStatus
+      # @param project_id [String]
+      # @param params Hash
+      def create_translation_status(project_id, params)
+        c_r RubyLokaliseApi::Resources::CustomTranslationStatus, :create, project_id, params
+      end
+
+      # Updates the given translation status inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-custom-translation-status-put
+      # @return [RubyLokaliseApi::Resources::CustomTranslationStatus]
+      # @param project_id [String]
+      # @param status_id [String, Integer]
+      # @param params [Hash]
+      def update_translation_status(project_id, status_id, params)
+        c_r RubyLokaliseApi::Resources::CustomTranslationStatus, :update, [project_id, status_id], params
+      end
+
+      # Deletes translation status inside the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-custom-translation-status-delete
+      # @return [Hash]
+      # @param project_id [String]
+      # @param status_id [String, Integer]
+      def destroy_translation_status(project_id, status_id)
+        c_r RubyLokaliseApi::Resources::CustomTranslationStatus, :destroy, [project_id, status_id]
+      end
+
+      # Returns an array of available colors that can be assigned to custom translation statuses
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-available-colors-for-custom-translation-statuses-get
+      # @return [Array]
+      # @param project_id [String]
+      def translation_status_colors(project_id)
+        c_r RubyLokaliseApi::Resources::CustomTranslationStatus, :colors, [project_id, 'colors']
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/files.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Files
+      # Returns all translation files for the given project
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-files-get
+      # @return [RubyLokaliseApi::Collection::File<RubyLokaliseApi::Resources::File>]
+      # @param project_id [String]
+      # @param params [Hash]
+      def files(project_id, params = {})
+        c_r RubyLokaliseApi::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
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-download-files-post
+      # @return [Hash]
+      # @param project_id [String]
+      # @param params [Hash]
+      def download_files(project_id, params)
+        c_r RubyLokaliseApi::Resources::File, :download, [project_id, 'download'], params
+      end
+
+      # Imports translation file to the given project. File data must base64-encoded.
+      # To encode your data in Base64, use `Base64.strict_encode64()` method.
+      #
+      # @see https://app.lokalise.com/api2docs/curl/#transition-upload-a-file-post
+      # @return [Hash]
+      # @param project_id [String]
+      # @param params [Hash]
+      def upload_file(project_id, params)
+        c_r RubyLokaliseApi::Resources::File, :upload, [project_id, 'upload'], params
+      end
+    end
+  end
+end