ruby-lokalise-api 4.5.0 → 6.0.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)
@@ -13,7 +13,7 @@ module Lokalise
     TooManyRequests = Class.new(ClientError)
     Forbidden = Class.new(ClientError)
     Locked = Class.new(ClientError)
-    MethodNowAllowed = Class.new(ClientError)
+    MethodNotAllowed = Class.new(ClientError)
 
     NotImplemented = Class.new(ServerError)
     BadGateway = Class.new(ServerError)
@@ -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::MethodNowAllowed,
-      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/oauth2/auth.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module OAuth2
+    class Auth
+      include RubyLokaliseApi::OAuth2::Request
+
+      attr_reader :client_id, :client_secret
+
+      def initialize(client_id, client_secret)
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+
+      def auth(scope:, redirect_uri: nil, state: nil)
+        scope = scope.join(' ') if scope.is_a?(Array)
+
+        params = {
+          client_id: client_id,
+          scope: scope
+        }
+        params[:state] = state unless state.nil?
+        params[:redirect_uri] = redirect_uri unless redirect_uri.nil?
+
+        _build_url_from params
+      end
+
+      def token(code)
+        params = base_params.merge({
+                                     code: code,
+                                     grant_type: 'authorization_code'
+                                   })
+        post 'token', params
+      end
+
+      def refresh(token)
+        params = base_params.merge({
+                                     refresh_token: token,
+                                     grant_type: 'refresh_token'
+                                   })
+        post 'token', params
+      end
+
+      private
+
+      def base_params
+        {
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      end
+
+      def _build_url_from(params)
+        URI::HTTPS.build(
+          host: BASE_URL.host,
+          path: "#{BASE_URL.path}auth",
+          query: URI.encode_www_form(params)
+        ).to_s
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/oauth2/connection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module OAuth2
+    module Connection
+      BASE_URL = URI('https://app.lokalise.com/oauth2/')
+
+      def connection
+        Faraday.new(options) { |f| f.adapter Faraday.default_adapter }
+      end
+
+      private
+
+      def options
+        {
+          headers: {
+            accept: 'application/json',
+            user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}"
+          },
+          url: BASE_URL.to_s
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/oauth2/request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module OAuth2
+    module Request
+      include RubyLokaliseApi::BaseRequest
+      include RubyLokaliseApi::OAuth2::Connection
+
+      def post(path, params = {})
+        respond_with connection.post(prepare(path), custom_dump(params))
+      end
+
+      private
+
+      def respond_with(response)
+        body = custom_load response.body
+        status = response.status
+        raise_on_error! status, body
+        body
+      end
+    end
+  end
+end

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

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

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::Connection
-    include Lokalise::JsonHandler
+    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
@@ -50,34 +50,23 @@ module Lokalise
 
     private
 
-    # Get rid of double slashes in the `path`, leading and trailing slash
-    def prepare(path)
-      path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
-    end
-
     def respond_with(response, client)
       body = custom_load response.body
       uri = Addressable::URI.parse response.env.url
       status = response.status
-      respond_with_error status, body if status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
+      raise_on_error! status, body
       extract_headers_from(response).
         merge('content' => body,
               'client' => client,
               'path' => uri.path.gsub(%r{/api2/}, ''))
     end
 
-    # Get only pagination headers
+    # Keep only pagination headers
     def extract_headers_from(response)
       response.
         headers.
         to_h.
         keep_if { |k, _v| PAGINATION_HEADERS.include?(k) }
     end
-
-    def respond_with_error(code, body)
-      raise(Lokalise::Error, body['error'] || body) unless Lokalise::Error::ERRORS.key? code
-
-      raise Lokalise::Error::ERRORS[code].from_response(body)
-    end
   end
 end

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