ruby-lokalise-api 1.0.1

data/lib/ruby-lokalise-api/error.rb

@@ -0,0 +1,47 @@
+module Lokalise
+  class Error < StandardError
+    ClientError = Class.new(self)
+    ServerError = Class.new(self)
+
+    BadRequest = Class.new(ClientError)
+    Unauthorized = Class.new(ClientError)
+    NotAcceptable = Class.new(ClientError)
+    NotFound = Class.new(ClientError)
+    Conflict = Class.new(ClientError)
+    TooManyRequests = Class.new(ClientError)
+    Forbidden = Class.new(ClientError)
+    Locked = Class.new(ClientError)
+
+    NotImplemented = Class.new(ServerError)
+    BadGateway = Class.new(ServerError)
+    ServiceUnavailable = Class.new(ServerError)
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS = {
+      400 => Lokalise::Error::BadRequest,
+      401 => Lokalise::Error::Unauthorized,
+      403 => Lokalise::Error::Forbidden,
+      404 => Lokalise::Error::NotFound,
+      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
+    }.freeze
+
+    class << self
+      # Create a new error from an HTTP response
+      def from_response(body)
+        new body['error']['message'].to_s
+      end
+    end
+
+    # Initializes a new Error object
+    def initialize(message = '')
+      super(message)
+    end
+  end
+end

data/lib/ruby-lokalise-api/request.rb

@@ -0,0 +1,60 @@
+module Lokalise
+  module Request
+    include Lokalise::Connection
+
+    PAGINATION_HEADERS = %w[x-pagination-total-count x-pagination-page-count x-pagination-limit x-pagination-page].freeze
+
+    def get(path, client, params = {})
+      respond_with(
+        connection(client.token).get(prepare(path), params),
+        client
+      )
+    end
+
+    def post(path, client, params = {})
+      respond_with(
+        connection(client.token).post(prepare(path), MultiJson.dump(params)),
+        client
+      )
+    end
+
+    def put(path, client, params = {})
+      respond_with(
+        connection(client.token).put(prepare(path), MultiJson.dump(params)),
+        client
+      )
+    end
+
+    def delete(path, client, params = {})
+      respond_with(
+        connection(client.token).run_request(:delete, prepare(path), MultiJson.dump(params), {}),
+        client
+      )
+      # TODO: current version of Faraday does not allow to pass DELETE body request
+      # As soon as this PR https://github.com/lostisland/faraday/issues/693 is merged,
+      # replace above with:
+      # delete(path, MultiJson.dump(params))
+    end
+
+    private
+
+    def prepare(path)
+      path.gsub /\/\//, '/'
+    end
+
+    def respond_with(response, client)
+      body = MultiJson.load response.body
+      respond_with_error(response.status, body) if body.respond_to?(:has_key?) && body.key?('error')
+      response.
+        headers.
+        keep_if { |k, _v| PAGINATION_HEADERS.include?(k) }.
+        merge(content: body, client: client)
+    end
+
+    def respond_with_error(code, body)
+      raise(Lokalise::Error, body['error']) unless Lokalise::Error::ERRORS.key? code
+
+      raise Lokalise::Error::ERRORS[code].from_response(body)
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+module Lokalise
+  module Resources
+    class Base
+      extend Lokalise::Request
+      extend Lokalise::Utils::AttributeHelpers
+      include Lokalise::Utils::AttributeHelpers
+
+      attr_reader :raw_data, :project_id, :client
+
+      def initialize(response)
+        populate_attributes_for response['content']
+
+        @raw_data = response['content']
+        @project_id = response['content']['project_id']
+        @client = response['client']
+      end
+
+      class << self
+        # Dynamically add attribute readers for each inherited class.
+        # Attributes are defined in the `data/attributes.json` file.
+        # Also set the `ATTRIBUTES` constant to assign values to each attribute later when
+        # the response arrives from the API
+        def inherited(subclass)
+          klass_attributes = attributes_for subclass
+          subclass.class_exec do
+            const_set :ATTRIBUTES, klass_attributes
+            attr_reader(*klass_attributes)
+          end
+          super
+        end
+
+        # Fetches a single record
+        def find(client, endpoint_ids, resource_id = '', params = {})
+          new get("#{endpoint(*endpoint_ids)}/#{resource_id}",
+                  client,
+                  params)
+        end
+
+        # Creates one or multiple records
+        def create(client, endpoint_ids, params, object_key = nil)
+          response = post(endpoint(*endpoint_ids),
+                          client,
+                          body_from(params, object_key))
+
+          object_from response
+        end
+
+        # Updates one or multiple records
+        def update(client, endpoint_ids, resource_id, params, object_key = nil)
+          response = put("#{endpoint(*endpoint_ids)}/#{resource_id}",
+                         client,
+                         body_from(params, object_key))
+
+          object_from response
+        end
+
+        # Destroys records by given ids
+        #
+        # @param client [Lokalise::Client]
+        # @return [Hash]
+        # @param endpoint_ids [String, Integer, Array]
+        # @param resource_id [String, Integer, Hash<Array>]
+        def destroy(client, endpoint_ids, resource_id)
+          path = endpoint(*endpoint_ids).to_s
+          if resource_id.is_a?(Hash)
+            delete path, client, resource_id
+          else
+            delete "#{path}/#{resource_id}", client
+          end['content']
+        end
+
+        private
+
+        # Converts `params` to hash with arrays under the `object_key` key.
+        # Used in bulk operations
+        #
+        # @return [Hash]
+        def body_from(params, object_key)
+          return params unless object_key
+
+          params = [params] unless params.is_a?(Array)
+          Hash[object_key, params]
+        end
+
+        # Instantiates a new resource or collection based on the given response
+        def object_from(response)
+          model_class = name.base_class_name
+          data_key_plural = data_key_for model_class, true
+
+          if response['content'].key? data_key_plural
+            Module.const_get("Lokalise::Collections::#{model_class}").new response
+          else
+            new response
+          end
+        end
+      end
+
+      private
+
+      # Store all resources attributes under the corresponding instance variables.
+      # `ATTRIBUTES` is defined inside resource-specific classes
+      def populate_attributes_for(content)
+        data_key = data_key_for self.class.name.base_class_name
+
+        self.class.const_get(:ATTRIBUTES).each do |attr|
+          value = if content.key?(data_key) && content[data_key].is_a?(Hash)
+                    content[data_key][attr]
+                  else
+                    content[attr]
+                  end
+
+          instance_variable_set "@#{attr}", value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Resources
+    class Contributor < Base
+      class << self
+        private
+
+        def endpoint(project_id)
+          "projects/#{project_id}/contributors"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Lokalise
+  module Resources
+    class File < Base
+      class << self
+        def download(client, project_id, params)
+          up_down client, endpoint(project_id), params, 'download'
+        end
+
+        def upload(client, project_id, params)
+          up_down client, endpoint(project_id), params, 'upload'
+        end
+
+        private
+
+        def up_down(client, path, params, action)
+          post("#{path}/#{action}", client, params)['content']
+        end
+
+        def endpoint(project_id)
+          "projects/#{project_id}/files"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Resources
+    class Key < Base
+      class << self
+        private
+
+        def endpoint(project_id)
+          "projects/#{project_id}/keys"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Lokalise
+  module Resources
+    class KeyComment < Base
+      DATA_KEY = 'Comment'.freeze
+
+      class << self
+        private
+
+        def endpoint(project_id, key_id)
+          "projects/#{project_id}/keys/#{key_id}/comments"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Lokalise
+  module Resources
+    class Project < Base
+      class << self
+        def clear(client, project_id)
+          put("#{endpoint(project_id)}/empty", client)['content']
+        end
+
+        private
+
+        def endpoint(project_id = nil)
+          'projects' unless project_id
+          "projects/#{project_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Lokalise
+  module Resources
+    class ProjectComment < Base
+      DATA_KEY = 'Comment'.freeze
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Lokalise
+  module Resources
+    class ProjectLanguage < Base
+      DATA_KEY = 'Language'.freeze
+
+      class << self
+        private
+
+        def endpoint(project_id)
+          "projects/#{project_id}/languages"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Resources
+    class Screenshot < Base
+      class << self
+        private
+
+        def endpoint(project_id)
+          "projects/#{project_id}/screenshots"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Lokalise
+  module Resources
+    class Snapshot < Base
+      class << self
+        def restore(client, project_id, snapshot_id)
+          Lokalise::Resources::Project.new post(endpoint(project_id, snapshot_id), client)
+        end
+
+        private
+
+        def endpoint(project_id, snapshot_id = nil)
+          "projects/#{project_id}/snapshots/#{snapshot_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Lokalise
+  module Resources
+    class SystemLanguage < Base
+      DATA_KEY = 'Language'.freeze
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Resources
+    class Task < Base
+      class << self
+        private
+
+        def endpoint(project_id)
+          "projects/#{project_id}/tasks"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Lokalise
+  module Resources
+    class Team < Base
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Resources
+    class TeamUser < Base
+      class << self
+        private
+
+        def endpoint(team_id)
+          "teams/#{team_id}/users"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Resources
+    class Translation < Base
+      class << self
+        private
+
+        def endpoint(project_id)
+          "projects/#{project_id}/translations"
+        end
+      end
+    end
+  end
+end

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

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