ruby-lokalise-api 7.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9945f7943aac029086c1140f091b893f0ee19daad1658025d6bcf8df80a1b2ea
-  data.tar.gz: 15e487ca72e3bd5a06569885a7cb01082330ba4ccf68545e116873582596d918
+  metadata.gz: 95932448d2e531abc5dc2f30a4b7f1052fa9ba7b37a80e57a46117ac7102c453
+  data.tar.gz: d5101a2713268265021177c3bcb1eaa1adcfaaa2afe605d87747d55a5c4a6ec0
 SHA512:
-  metadata.gz: 66da1dc1844fa17b05d27416b2e0b2760cbb439cb0b9a22163f07d310127a9d1ca52d129d3b6c64249ef25c27501035c8c216f80b0605d45be62f744ccbe0d71
-  data.tar.gz: a9f471a3f5341c9ac99f50cb1222889d56cee9f26a57a867655f4a3c9d3bbed8f0df76efc0a3b8eaa76372deecc9e3d06b60f791baf4e1d8383c981bbc732920
+  metadata.gz: 64d290aa2c9844f3e8db8099968104845f7f7b7a52c96843b7f400124819031c3021acec02a318004079548b2666e3253cae845d447825cb5acf04d7cee43234
+  data.tar.gz: f2790492035aa26cd353372008fe8b4d41cecd47382700ec339e57d443cb5e637be24dc299ea7a1c9898f5c2446722a5709e79e684c081b1ee730d595788fb5e

data/lib/ruby_lokalise_api/base_client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
+  # This class contains the base client. Inherited by Client (regular API client)
+  # and OAuth2Client (used for OAuth-2 based authentication)
   class BaseClient
     attr_reader :token, :token_header
     attr_accessor :timeout, :open_timeout
@@ -11,39 +13,5 @@ module RubyLokaliseApi
       @open_timeout = params.fetch(:open_timeout, nil)
       @token_header = ''
     end
-
-    # 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)
-      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
-    #
-    # @return [Hash]
-    def format_params(params, object_key)
-      return params unless object_key
-
-      params = [params] unless params.is_a?(Array)
-      {object_key => params}
-    end
-
-    def base_url; end
-
-    def compression?; end
-
-    alias c_r construct_request
   end
 end

data/lib/ruby_lokalise_api/client.rb

@@ -1,43 +1,14 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
+  # Regular API client used to perform requests with a basic API token
   class Client < BaseClient
-    include RubyLokaliseApi::Rest::Branches
-    include RubyLokaliseApi::Rest::Comments
-    include RubyLokaliseApi::Rest::Contributors
-    include RubyLokaliseApi::Rest::CustomTranslationStatuses
-    include RubyLokaliseApi::Rest::Files
-    include RubyLokaliseApi::Rest::Jwt
-    include RubyLokaliseApi::Rest::Keys
-    include RubyLokaliseApi::Rest::Languages
-    include RubyLokaliseApi::Rest::Orders
-    include RubyLokaliseApi::Rest::PaymentCards
-    include RubyLokaliseApi::Rest::Projects
-    include RubyLokaliseApi::Rest::QueuedProcesses
-    include RubyLokaliseApi::Rest::Screenshots
-    include RubyLokaliseApi::Rest::Segments
-    include RubyLokaliseApi::Rest::Snapshots
-    include RubyLokaliseApi::Rest::Tasks
-    include RubyLokaliseApi::Rest::TeamUserBillingDetails
-    include RubyLokaliseApi::Rest::TeamUserGroups
-    include RubyLokaliseApi::Rest::TeamUsers
-    include RubyLokaliseApi::Rest::Teams
-    include RubyLokaliseApi::Rest::TranslationProviders
-    include RubyLokaliseApi::Rest::Translations
-    include RubyLokaliseApi::Rest::Webhooks
+    include RubyLokaliseApi::Rest
 
     def initialize(token, params = {})
       super(token, params)
 
       @token_header = 'x-api-token'
     end
-
-    def base_url
-      'https://api.lokalise.com/api2/'
-    end
-
-    def compression?
-      true
-    end
   end
 end

data/lib/ruby_lokalise_api/collections/base.rb

@@ -2,116 +2,143 @@
 
 module RubyLokaliseApi
   module Collections
+    # Base collection. Collection is an array of resources. The actual resources can be found
+    # by calling the `.collection` method
     class Base
-      using RubyLokaliseApi::Utils::StringUtils
-
-      extend RubyLokaliseApi::Request
-      extend RubyLokaliseApi::Utils::AttributeHelpers
-      include RubyLokaliseApi::Utils::AttributeHelpers
-      extend RubyLokaliseApi::Utils::EndpointHelpers
-
-      attr_reader :total_pages, :total_results, :results_per_page, :current_page, :collection,
-                  :project_id, :team_id, :request_params, :client, :path, :branch, :user_id
-
-      # Initializes a new collection based on the response
-      #
-      # @param response [Hash]
-      # @param params [Hash]
-      # @return [RubyLokaliseApi::Collections::Base]
-      def initialize(response, params = {})
-        produce_collection_for response
-        populate_pagination_data_for response
-        @request_params = params
-        popular_common_attrs response
+      include Enumerable
+      extend Forwardable
+
+      using RubyLokaliseApi::Utils::Classes
+      extend RubyLokaliseApi::Utils::Attributes
+      extend RubyLokaliseApi::Concerns::AttrsLoadable
+      include RubyLokaliseApi::Utils::Keys
+
+      ATTRS_FILENAME = 'collection_attributes.yml'
+
+      def_delegators :collection, :[], :last, :each
+
+      attr_reader :total_pages, :total_results, :results_per_page, :current_page,
+                  :collection
+
+      def initialize(response)
+        @self_endpoint = response.endpoint
+
+        populate_common_attrs_from response
+        produce_collection_from response
       end
 
-      class << self
-        # Performs a batch query fetching multiple records
-        def all(client, path, params = {})
-          new get(path, client, params),
-              params
-        end
+      # Tries to fetch the next page for paginated collection
+      # Returns a new collection or nil if the next page is not available
+      def next_page
+        return nil if last_page?
+
+        self.class.new(
+          reinit_endpoint(
+            override_req_params: { page: current_page + 1 }
+          ).do_get
+        )
+      end
+
+      # Tries to fetch the previous page for paginated collection
+      # Returns a new collection or nil if the previous page is not available
+      def prev_page
+        return nil if first_page?
+
+        self.class.new(
+          reinit_endpoint(
+            override_req_params: { page: current_page - 1 }
+          ).do_get
+        )
       end
 
+      # Checks whether the next page is available
       # @return [Boolean]
       def next_page?
-        @current_page.positive? && @current_page < @total_pages
+        current_page.positive? && current_page < total_pages
       end
 
+      # Checks whether the current page is the last one
       # @return [Boolean]
       def last_page?
         !next_page?
       end
 
+      # Checks whether the previous page is available
       # @return [Boolean]
       def prev_page?
-        @current_page > 1
+        current_page > 1
       end
 
+      # Checks whether the current page is the first one
       # @return [Boolean]
       def first_page?
         !prev_page?
       end
 
-      # @return [Integer]
-      def next_page
-        return nil if last_page?
+      private
 
-        fetch_page @current_page + 1
+      # This method is utilized to recreate an endpoint for the current collection
+      def reinit_endpoint(req_params: @self_endpoint.req_params, override_req_params: {})
+        @self_endpoint.reinitialize(
+          req_params: req_params.merge(override_req_params)
+        )
       end
 
-      # @return [Integer]
-      def prev_page
-        return nil if first_page?
+      def populate_common_attrs_from(response)
+        supported_attrs.each do |attrib|
+          instance_variable_set "@#{attrib}", response.content[attrib]
+        end
+
+        headers = response.headers
 
-        fetch_page @current_page - 1
+        return unless headers.any?
+
+        @total_results = headers[:'x-pagination-total-count']
+        @total_pages = headers[:'x-pagination-page-count']
+        @results_per_page = headers[:'x-pagination-limit']
+        @current_page = headers[:'x-pagination-page']
       end
 
-      private
+      def produce_collection_from(response)
+        content = response.content
+        return unless content
+
+        data_key_plural = collection_key_for klass: self.class.base_name
+
+        resources_data = content[data_key_plural]
+        other_data = content.reject { |key, _| key == data_key_plural }
 
-      def populate_pagination_data_for(response)
-        @total_results = response['x-pagination-total-count'].to_i
-        @total_pages = response['x-pagination-page-count'].to_i
-        @results_per_page = response['x-pagination-limit'].to_i
-        @current_page = response['x-pagination-page'].to_i
+        @collection = build_collection resources_data, other_data
       end
 
-      # Gets the specified page
-      def fetch_page(page_num)
-        self.class.all @client,
-                       @path,
-                       @request_params.merge(page: page_num)
+      def build_collection(resources_data, other_data)
+        resources_data.map do |raw_resource|
+          self.class.const_get(:RESOURCE).new(resource_data(raw_resource, other_data))
+        end
       end
 
-      # Dynamically produces collection of resources based on the given response
-      # Collection example: `{ "content": {"comments": [ ... ]} }`
-      def produce_collection_for(response)
-        return unless response['content']
+      def resource_data(raw_resource, other_data)
+        RubyLokaliseApi::Response.new(
+          raw_resource.merge(other_data),
+          resource_endpoint.new(
+            @self_endpoint.client,
+            query: query_for(raw_resource, other_data)
+          )
+        )
+      end
 
-        model_class = self.class.name.base_class_name
-        data_key_plural = data_key_for model_class: model_class, plural: true, collection: true
+      def query_for(raw_resource, other_data)
+        main_params = self.class.const_get(:RESOURCE).const_get(:MAIN_PARAMS).to_array
 
-        # Fetch collection data and instantiate an individual resource for each object
-        # We also preserve the `client` to be able to chain API methods later
-        @collection = response['content'][data_key_plural].map do |raw_model|
-          Module.const_get("RubyLokaliseApi::Resources::#{model_class}").new 'content' => raw_model,
-                                                                             'client' => response['client'],
-                                                                             'base_path' => response['path']
+        main_params.map do |param|
+          other_data[param.to_s] || raw_resource[param.to_s] || nil
         end
       end
 
-      def popular_common_attrs(response)
-        @client = response['client']
-        @path = response['path']
-
-        return unless response['content']
+      def resource_endpoint
+        klass = self.class
 
-        content = response['content']
-        # Project, team id, user id, and branch may not be present in some cases
-        @project_id = content['project_id']
-        @team_id = content['team_id']
-        @user_id = content['user_id']
-        @branch = content['branch']
+        klass.const_defined?(:RESOURCES_ENDPOINT) ? klass.const_get(:RESOURCES_ENDPOINT) : klass.const_get(:ENDPOINT)
       end
     end
   end

data/lib/ruby_lokalise_api/collections/branches.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Branches < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::BranchesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Branch
+      DATA_KEY = 'branches'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/contributors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Contributors < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::ContributorsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Contributor
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/custom_translation_statuses.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class CustomTranslationStatuses < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::CustomTranslationStatusesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::CustomTranslationStatus
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/files.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Files < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::FilesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::File
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/key_comments.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class KeyComments < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::KeyCommentsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Comment
+      DATA_KEY = 'comments'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/keys.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Keys < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::KeysEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Key
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/orders.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Orders < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::OrdersEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Order
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/payment_cards.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class PaymentCards < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::PaymentCardsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::PaymentCard
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/project_comments.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class ProjectComments < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::ProjectCommentsEndpoint
+      RESOURCES_ENDPOINT = RubyLokaliseApi::Endpoints::KeyCommentsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Comment
+      DATA_KEY = 'comments'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/project_languages.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class ProjectLanguages < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::ProjectLanguagesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::ProjectLanguage
+      DATA_KEY = 'languages'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/projects.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Projects < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::ProjectsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Project
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/queued_processes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class QueuedProcesses < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::QueuedProcessesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::QueuedProcess
+      DATA_KEY = 'processes'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/screenshots.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Screenshots < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::ScreenshotsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Screenshot
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/segments.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Segments < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::SegmentsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Segment
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/snapshots.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Snapshots < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::SnapshotsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Snapshot
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/system_languages.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class SystemLanguages < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::SystemLanguagesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::SystemLanguage
+      DATA_KEY = 'languages'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/tasks.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Tasks < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::TasksEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Task
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/team_user_groups.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class TeamUserGroups < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::TeamUserGroupsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::TeamUserGroup
+      DATA_KEY = 'user_groups'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/team_users.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class TeamUsers < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::TeamUsersEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::TeamUser
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/teams.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Teams < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::TeamsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Team
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/translation_providers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class TranslationProviders < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::TranslationProvidersEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::TranslationProvider
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/translations.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Translations < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::TranslationsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Translation
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/webhooks.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class Webhooks < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::WebhooksEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::Webhook
+    end
+  end
+end

data/lib/ruby_lokalise_api/concerns/attrs_loadable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Concerns
+    # Allows to set supported attributes for classes
+    module AttrsLoadable
+      class << self
+        def extended(klass)
+          klass.class_exec do
+            define_method :supported_attrs do
+              that_klass = self.class
+              that_klass.const_defined?(:ATTRS) ? that_klass.const_get(:ATTRS) : []
+            end
+          end
+        end
+      end
+
+      def inherited(subclass)
+        klass_attributes = attributes_for subclass, const_get(:ATTRS_FILENAME)
+
+        if klass_attributes&.any?
+          subclass.class_exec do
+            const_set :ATTRS, klass_attributes
+            attr_reader(*klass_attributes)
+          end
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/concerns/hash_accessible.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Concerns
+    # Adds the `[]` method for invariant access
+    module HashAccessible
+      def [](raw_key_attr)
+        key_attr = :"@#{raw_key_attr}"
+
+        return nil unless instance_variables.include?(key_attr) && respond_to?(raw_key_attr.to_sym)
+
+        instance_variable_get(key_attr)
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/concerns/unsupportable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Concerns
+    # Allows to undefine certain methods
+    module Unsupportable
+      def no_support_for(methods)
+        return unless methods.any?
+
+        methods.each do |method|
+          undef_method(method)
+        end
+      end
+    end
+  end
+end