ruby-lokalise-api 5.0.0 → 6.2.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   class Error < StandardError
     ClientError = Class.new(self)
     ServerError = Class.new(self)
@@ -21,19 +21,19 @@ module Lokalise
     GatewayTimeout = Class.new(ServerError)
 
     ERRORS = {
-      400 => Lokalise::Error::BadRequest,
-      401 => Lokalise::Error::Unauthorized,
-      403 => Lokalise::Error::Forbidden,
-      404 => Lokalise::Error::NotFound,
-      405 => Lokalise::Error::MethodNotAllowed,
-      406 => Lokalise::Error::NotAcceptable,
-      409 => Lokalise::Error::Conflict,
-      423 => Lokalise::Error::Locked,
-      429 => Lokalise::Error::TooManyRequests,
-      500 => Lokalise::Error::ServerError,
-      502 => Lokalise::Error::BadGateway,
-      503 => Lokalise::Error::ServiceUnavailable,
-      504 => Lokalise::Error::GatewayTimeout
+      400 => RubyLokaliseApi::Error::BadRequest,
+      401 => RubyLokaliseApi::Error::Unauthorized,
+      403 => RubyLokaliseApi::Error::Forbidden,
+      404 => RubyLokaliseApi::Error::NotFound,
+      405 => RubyLokaliseApi::Error::MethodNotAllowed,
+      406 => RubyLokaliseApi::Error::NotAcceptable,
+      409 => RubyLokaliseApi::Error::Conflict,
+      423 => RubyLokaliseApi::Error::Locked,
+      429 => RubyLokaliseApi::Error::TooManyRequests,
+      500 => RubyLokaliseApi::Error::ServerError,
+      502 => RubyLokaliseApi::Error::BadGateway,
+      503 => RubyLokaliseApi::Error::ServiceUnavailable,
+      504 => RubyLokaliseApi::Error::GatewayTimeout
     }.freeze
 
     class << self

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

@@ -2,7 +2,7 @@
 
 require 'json'
 
-module Lokalise
+module RubyLokaliseApi
   module JsonHandler
     # JSON custom parser. Uses built-in JSON by default but can be overridden to any other parser
 

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']
@@ -27,6 +27,14 @@ module Lokalise
         @path = infer_path_from response, endpoint_generator
       end
 
+      def [](raw_key_attr)
+        key_attr = raw_key_attr.to_s.to_sym
+
+        return nil unless self.instance_variables.include?(:"@#{key_attr}")
+
+        self.send key_attr
+      end
+
       class << self
         # Dynamically adds attribute readers for each inherited class.
         # Attributes are defined in the `data/attributes.json` file.
@@ -120,7 +128,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://developers.lokalise.com/reference/list-all-branches
+      # @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://developers.lokalise.com/reference/create-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
+      end
+
+      # Returns a single branch for the given project
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-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]
+      end
+
+      # Updates the given branch inside the given project
+      #
+      # @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
+      end
+
+      # Deletes branch inside the given project
+      #
+      # @see https://developers.lokalise.com/reference/delete-a-branch
+      # @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://developers.lokalise.com/reference/merge-a-branch
+      # @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://developers.lokalise.com/reference/retrieve-a-comment
+      # @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://developers.lokalise.com/reference/list-project-comments
+      # @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://developers.lokalise.com/reference/list-key-comments
+      # @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://developers.lokalise.com/reference/create-comments
+      # @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://developers.lokalise.com/reference/delete-a-comment
+      # @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://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
+
+      # Returns a single contributor for the given project
+      #
+      # @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]
+      end
+
+      # Creates one or more contributors inside the given project
+      #
+      # @see https://developers.lokalise.com/reference/create-contributors
+      # @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://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
+      end
+
+      # Deletes contributor inside the given project
+      #
+      # @see https://developers.lokalise.com/reference/delete-a-contributor
+      # @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