ruby-lokalise-api 2.8.0 → 3.1.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 
 begin
@@ -13,4 +15,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 require 'rubocop/rake_task'
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/lib/ruby-lokalise-api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'yaml'
 require 'addressable'
@@ -15,6 +17,7 @@ require 'ruby-lokalise-api/resources/base'
 require 'ruby-lokalise-api/resources/branch'
 require 'ruby-lokalise-api/resources/project'
 require 'ruby-lokalise-api/resources/project_language'
+require 'ruby-lokalise-api/resources/queued_process'
 require 'ruby-lokalise-api/resources/key_comment'
 require 'ruby-lokalise-api/resources/contributor'
 require 'ruby-lokalise-api/resources/file'
@@ -41,6 +44,7 @@ require 'ruby-lokalise-api/collections/team'
 require 'ruby-lokalise-api/collections/system_language'
 require 'ruby-lokalise-api/collections/project_language'
 require 'ruby-lokalise-api/collections/project_comment'
+require 'ruby-lokalise-api/collections/queued_process'
 require 'ruby-lokalise-api/collections/key_comment'
 require 'ruby-lokalise-api/collections/key'
 require 'ruby-lokalise-api/collections/contributor'

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

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'ruby-lokalise-api/rest/branches'
 require 'ruby-lokalise-api/rest/languages'
 require 'ruby-lokalise-api/rest/teams'
 require 'ruby-lokalise-api/rest/projects'
+require 'ruby-lokalise-api/rest/queued_processes'
 require 'ruby-lokalise-api/rest/comments'
 require 'ruby-lokalise-api/rest/keys'
 require 'ruby-lokalise-api/rest/contributors'
@@ -25,14 +28,25 @@ module Lokalise
 
     def initialize(token, params = {})
       @token = token
-      @timeout = params.fetch(:timeout) { nil }
-      @open_timeout = params.fetch(:open_timeout) { nil }
+      @timeout = params.fetch(:timeout, nil)
+      @open_timeout = params.fetch(:open_timeout, nil)
     end
 
-    def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil)
+    # rubocop:disable Metrics/ParameterLists
+    # Constructs request to perform the specified action
+    # @param klass The actual class to call the method upon
+    # @param method [Symbol] The method to call (:new, :update, :create etc)
+    # @param endpoint_ids [Array, Hash] IDs that are used to generate the proper path to the endpoint
+    # @param params [Array, Hash] Request parameters
+    # @param object_key [String, Symbol] Key that should be used to wrap parameters into
+    # @param initial_ids [Array] IDs that should be used to generate base endpoint path. The base path is used for method chaining
+    def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil, initial_ids = nil)
       path = klass.endpoint(*endpoint_ids)
-      klass.send method, self, path, format_params(params, object_key)
+      formatted_params = format_params(params, object_key)
+      formatted_params[:_initial_path] = klass.endpoint(*initial_ids) if initial_ids
+      klass.send method, self, path, formatted_params
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # Converts `params` to hash with arrays under the `object_key` key.
     # Used in bulk operations

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Base
@@ -7,7 +9,7 @@ module Lokalise
       extend Lokalise::Utils::EndpointHelpers
 
       attr_reader :total_pages, :total_results, :results_per_page, :current_page, :collection,
-                  :project_id, :team_id, :request_params, :client, :path
+                  :project_id, :team_id, :request_params, :client, :path, :branch, :user_id
 
       # Initializes a new collection based on the response
       #
@@ -17,9 +19,11 @@ module Lokalise
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
-        # Project and team id may not be present in some cases
+        # Project, team id, user id, and branch may not be present in some cases
         @project_id = response['content']['project_id']
         @team_id = response['content']['team_id']
+        @user_id = response['content']['user_id']
+        @branch = response['content']['branch']
         @request_params = params
         @client = response['client']
         @path = response['path']

data/lib/ruby-lokalise-api/collections/branch.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Branch < Base
-      DATA_KEY_PLURAL = 'Branches'.freeze
+      DATA_KEY_PLURAL = 'Branches'
 
       class << self
         def endpoint(project_id, *_args)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Contributor < Base

data/lib/ruby-lokalise-api/collections/custom_translation_status.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class CustomTranslationStatus < Base
-      DATA_KEY_PLURAL = 'CustomTranslationStatuses'.freeze
+      DATA_KEY_PLURAL = 'CustomTranslationStatuses'
 
       class << self
         def endpoint(project_id, *_args)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class File < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Key < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class KeyComment < Base

data/lib/ruby-lokalise-api/collections/order.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Order < Base

data/lib/ruby-lokalise-api/collections/payment_card.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class PaymentCard < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Project < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class ProjectComment < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class ProjectLanguage < Base

data/lib/ruby-lokalise-api/collections/queued_process.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Collections
+    class QueuedProcess < Base
+      DATA_KEY_PLURAL = 'Processes'
+
+      class << self
+        def endpoint(project_id, *_args)
+          path_from projects: [project_id, 'processes']
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Screenshot < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Snapshot < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class SystemLanguage < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Task < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Team < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class TeamUser < Base

data/lib/ruby-lokalise-api/collections/team_user_group.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class TeamUserGroup < Base
-      DATA_KEY = 'UserGroup'.freeze
+      DATA_KEY = 'UserGroup'
 
       class << self
         def endpoint(team_id, *_args)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Translation < Base

data/lib/ruby-lokalise-api/collections/translation_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class TranslationProvider < Base

data/lib/ruby-lokalise-api/collections/webhook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Collections
     class Webhook < Base

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

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Connection
-    BASE_URL = 'https://api.lokalise.co/api2/'.freeze
+    BASE_URL = 'https://api.lokalise.com/api2/'
 
     def connection(client)
       options = {

data/lib/ruby-lokalise-api/data/attributes.json

@@ -21,11 +21,11 @@
     "email",
     "fullname",
     "created_at",
+    "created_at_timestamp",
     "is_admin",
     "is_reviewer",
     "languages",
-    "admin_rights",
-    "created_at_timestamp"
+    "admin_rights"
   ],
   "custom_translation_status": [
     "status_id",
@@ -39,6 +39,7 @@
   "key": [
     "key_id",
     "created_at",
+    "created_at_timestamp",
     "key_name",
     "filenames",
     "description",
@@ -55,7 +56,10 @@
     "base_words",
     "char_limit",
     "custom_attributes",
-    "created_at_timestamp"
+    "modified_at",
+    "modified_at_timestamp",
+    "translations_modified_at",
+    "translations_modified_at_timestamp"
   ],
   "language": [
     "lang_id",
@@ -70,6 +74,7 @@
     "card_id",
     "status",
     "created_at",
+    "created_at_timestamp",
     "created_by",
     "created_by_email",
     "source_language_iso",
@@ -81,8 +86,7 @@
     "translation_tier",
     "translation_tier_name",
     "briefing",
-    "total",
-    "created_at_timestamp"
+    "total"
   ],
   "payment_card": [
     "card_id",
@@ -96,15 +100,26 @@
     "name",
     "description",
     "created_at",
+    "created_at_timestamp",
     "created_by",
     "created_by_email",
     "team_id",
-    "created_at_timestamp",
     "base_language_id",
     "base_language_iso",
     "settings",
     "statistics"
   ],
+  "queued_process": [
+    "process_id",
+    "type",
+    "status",
+    "message",
+    "created_by",
+    "created_by_email",
+    "created_at",
+    "created_at_timestamp",
+    "details"
+  ],
   "screenshot": [
     "screenshot_id",
     "key_ids",
@@ -121,9 +136,9 @@
     "snapshot_id",
     "title",
     "created_at",
+    "created_at_timestamp",
     "created_by",
-    "created_by_email",
-    "created_at_timestamp"
+    "created_by_email"
   ],
   "task": [
     "task_id",
@@ -157,18 +172,18 @@
     "team_id",
     "name",
     "created_at",
+    "created_at_timestamp",
     "plan",
     "quota_usage",
-    "quota_allowed",
-    "created_at_timestamp"
+    "quota_allowed"
   ],
   "team_user": [
     "user_id",
     "email",
     "fullname",
     "created_at",
-    "role",
-    "created_at_timestamp"
+    "created_at_timestamp",
+    "role"
   ],
   "team_user_group": [
     "group_id",
@@ -211,4 +226,4 @@
     "events",
     "event_lang_map"
   ]
-}
+}

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Error < StandardError
     ClientError = Class.new(self)

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   module Request
     include Lokalise::Connection
@@ -27,6 +29,13 @@ module Lokalise
       )
     end
 
+    def patch(path, client, params = {})
+      respond_with(
+        connection(client).patch(prepare(path), params.any? ? custom_dump(params) : nil),
+        client
+      )
+    end
+
     def delete(path, client, params = {})
       respond_with(
         # Rubocop tries to replace `delete` with `gsub` but that's a different method here!
@@ -43,7 +52,7 @@ module Lokalise
 
     # Get rid of double slashes in the `path`, leading and trailing slash
     def prepare(path)
-      path.gsub(%r{\A/}, '').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
+      path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
     end
 
     def respond_with(response, client)