ruby-lokalise-api 9.0.1 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 757096e9bd784d9fbb217a9f5717b22e76fc33789cb7afbc64c0dc40d1e5cae0
-  data.tar.gz: b1ef581136fae9704cc4acf570b7b29dbe2bcb757229594a98954aefae5229d8
+  metadata.gz: 69670957b958e42f7a92d8cd6f9b7a56e72a0ee82e83519aacebb247f39cef4d
+  data.tar.gz: def7256b54391d38d2657cb816c8be7183f773617fdd5bfcc03b68d7a4656c89
 SHA512:
-  metadata.gz: 929cae40ddbeffd97804beea0751dfd4e35bb2a5a76643c8da8cd4ce3148e9d0ed457d58a81e4f550ddb4dfb7c009b49bdbd4009392a13e10dfcf0f1c709a8fb
-  data.tar.gz: 98ea093d57d3ad8126e895da2a6a964d21a83eaed661dadb74c848e947162dea75605f3381c93a10ffe05245bae65629b1813076adddcb4ed6f3931e1a7a1adb
+  metadata.gz: a887ca5c684958a890ed292b709675cd8f404eaf8c6257356b8bb9af8d0b5075f06b837f396ab19c7bc47d856dc442dcad31d17bc90184c057250ffc8956f81f
+  data.tar.gz: a26be455d40924cc3c9efbb3ca84c4c5f14a19ce88ef8296610a4a2f371d146802dcea1b34e76da114ffe802363cd632d29ebe900eb8b8af4d6fa4ad3113edb0

data/lib/ruby_lokalise_api/client.rb

@@ -4,7 +4,7 @@ module RubyLokaliseApi
   # Regular API client used to perform requests with a basic API token
   class Client < BaseClient
     def initialize(token, params = {})
-      super(token, params)
+      super
 
       @token_header = 'x-api-token'
     end

data/lib/ruby_lokalise_api/collections/base.rb

@@ -18,7 +18,7 @@ module RubyLokaliseApi
       def_delegators :collection, :[], :last, :each
 
       attr_reader :total_pages, :total_results, :results_per_page, :current_page,
-                  :collection
+                  :collection, :next_cursor
 
       def initialize(response)
         @self_endpoint = response.endpoint
@@ -32,11 +32,15 @@ module RubyLokaliseApi
       def next_page
         return nil if last_page?
 
-        self.class.new(
-          reinit_endpoint(
-            override_req_params: { page: current_page + 1 }
-          ).do_get
-        )
+        fetch_page(current_page + 1)
+      end
+
+      # Tries to fetch the next cursor for paginated collection
+      # Returns a new collection or nil if the next cursor is not available
+      def load_next_cursor
+        return nil unless next_cursor?
+
+        fetch_cursor(next_cursor)
       end
 
       # Tries to fetch the previous page for paginated collection
@@ -44,11 +48,7 @@ module RubyLokaliseApi
       def prev_page
         return nil if first_page?
 
-        self.class.new(
-          reinit_endpoint(
-            override_req_params: { page: current_page - 1 }
-          ).do_get
-        )
+        fetch_page(current_page - 1)
       end
 
       # Checks whether the next page is available
@@ -75,6 +75,12 @@ module RubyLokaliseApi
         !prev_page?
       end
 
+      # Checks whether the next cursor is available
+      # @return [Boolean]
+      def next_cursor?
+        !next_cursor.nil? && next_cursor != ''
+      end
+
       private
 
       # This method is utilized to recreate an endpoint for the current collection
@@ -89,14 +95,17 @@ module RubyLokaliseApi
           instance_variable_set :"@#{attrib}", response.content[attrib]
         end
 
-        headers = response.headers
+        extract_common_from_headers(response.headers)
+      end
 
+      def extract_common_from_headers(headers)
         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']
+        @total_results = headers[:'x-pagination-total-count'].to_i
+        @total_pages = headers[:'x-pagination-page-count'].to_i
+        @results_per_page = headers[:'x-pagination-limit'].to_i
+        @current_page = headers[:'x-pagination-page'].to_i
+        @next_cursor = headers[:'x-pagination-next-cursor']
       end
 
       def produce_collection_from(response)
@@ -106,7 +115,7 @@ module RubyLokaliseApi
         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 }
+        other_data = content.except(data_key_plural)
 
         @collection = build_collection resources_data, other_data
       end
@@ -140,6 +149,16 @@ module RubyLokaliseApi
 
         klass.const_defined?(:RESOURCES_ENDPOINT) ? klass.const_get(:RESOURCES_ENDPOINT) : klass.const_get(:ENDPOINT)
       end
+
+      # Helper method to fetch a page for paginated collections
+      def fetch_page(page)
+        self.class.new(reinit_endpoint(override_req_params: { page: page }).do_get)
+      end
+
+      # Helper method to fetch the next cursor
+      def fetch_cursor(cursor)
+        self.class.new(reinit_endpoint(override_req_params: { cursor: cursor }).do_get)
+      end
     end
   end
 end

data/lib/ruby_lokalise_api/collections/permission_templates.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class PermissionTemplates < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::PermissionTemplatesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::PermissionTemplate
+      DATA_KEY = 'roles'
+    end
+  end
+end

data/lib/ruby_lokalise_api/connection.rb

@@ -4,10 +4,14 @@ module RubyLokaliseApi
   # Module to setup connection using Faraday
   module Connection
     # Creates a new Faraday object with specified params
+    #
+    # @param endpoint [Object] the API endpoint
+    # @param params [Hash] additional connection parameters
+    # @return [Faraday::Connection] the Faraday connection object
     def connection(endpoint, params = {})
       Faraday.new(options(endpoint, params), request_params_for(endpoint.client)) do |faraday|
         faraday.adapter Faraday.default_adapter
-        faraday.request(:gzip)
+        faraday.request :gzip
       end
     end
 
@@ -17,19 +21,33 @@ module RubyLokaliseApi
       req_params = __base_options(endpoint)
       client = endpoint.client
 
-      if client.respond_to?(:token) && client.respond_to?(:token_header)
-        req_params[:headers][client.token_header] = client.token
-      end
+      add_token_header(req_params, client) if client_responds_to_token?(client)
 
-      # Sending content-type is needed only when the body is actually present
-      # Trying to send this header in other cases seems to result in error 500
-      req_params[:headers]['Content-type'] = 'application/json' if !params[:get_request] && endpoint.req_params
+      # Set Content-Type if required (skip for GET requests)
+      add_content_type_header(req_params, params, endpoint)
 
       req_params[:headers][:accept_encoding] = 'gzip,deflate,br'
 
       req_params
     end
 
+    # Adds the token header to the request parameters if token is present
+    def add_token_header(req_params, client)
+      req_params[:headers][client.token_header] = client.token
+    end
+
+    # Checks if the client can respond to token and token header methods
+    def client_responds_to_token?(client)
+      client.respond_to?(:token) && client.respond_to?(:token_header)
+    end
+
+    # Conditionally adds the Content-Type header
+    def add_content_type_header(req_params, params, endpoint)
+      return unless !params[:get_request] && endpoint.req_params
+
+      req_params[:headers]['Content-Type'] = 'application/json'
+    end
+
     def __base_options(endpoint)
       {
         headers: {

data/lib/ruby_lokalise_api/data/resource_attributes.yml

@@ -28,6 +28,7 @@ contributor:
   - is_reviewer
   - languages
   - admin_rights
+  - role_id
 custom_translation_status:
   - project_id
   - branch
@@ -142,6 +143,15 @@ queued_process:
   - created_at
   - created_at_timestamp
   - details
+permission_template:
+  - id
+  - role
+  - permissions
+  - description
+  - tag
+  - tagColor
+  - tagInfo
+  - doesEnableAllReadOnlyLanguages
 screenshot:
   - project_id
   - branch
@@ -256,6 +266,7 @@ team_user_group:
   - team_id
   - projects
   - members
+  - role_id
 translation:
   - project_id
   - branch

data/lib/ruby_lokalise_api/endpoints/base_endpoint.rb

@@ -28,11 +28,11 @@ module RubyLokaliseApi
       end
 
       def base_url
-        self.class.const_get(:BASE_URL)
+        self.class::BASE_URL
       end
 
       def full_uri
-        base_url + uri
+        base_url + uri.to_s
       end
 
       # Creates methods like `do_post`, `do_get` that proxy calls to the
@@ -52,7 +52,7 @@ module RubyLokaliseApi
       end
 
       def partial_uri_template
-        self.class.const_get(:PARTIAL_URI_TEMPLATE)
+        self.class::PARTIAL_URI_TEMPLATE
       end
     end
   end

data/lib/ruby_lokalise_api/endpoints/main_endpoint.rb

@@ -6,7 +6,7 @@ module RubyLokaliseApi
       BASE_URL = 'https://api.lokalise.com/api2'
 
       def initialize(client, params = {})
-        super(client, params)
+        super
 
         @uri = partial_uri(base_query(*@query_params))
       end

data/lib/ruby_lokalise_api/endpoints/oauth2/oauth2_endpoint.rb

@@ -8,22 +8,32 @@ module RubyLokaliseApi
         PARTIAL_URI_TEMPLATE = '{/segments*}{?query*}'
 
         def initialize(client, params = {})
-          super(client, params)
+          super
 
-          @uri = partial_uri(base_query(*@query_params), params.fetch(:get, []))
+          @uri = build_uri(params.fetch(:get, []))
         end
 
         private
 
+        # Builds the complete URI for the OAuth2 endpoint
+        def build_uri(query)
+          partial_uri(base_query(*@query_params), query)
+        end
+
         def partial_uri(segments, query)
           template = super
 
           template.expand(
             segments: segments.to_a.flatten,
-            query: query.filter { |_k, v| !v.nil? }
+            query: filter_query_params(query)
           ).to_s
         end
 
+        # Filters out nil values from query parameters
+        def filter_query_params(query)
+          query.compact
+        end
+
         def base_query(segment = nil)
           [segment]
         end

data/lib/ruby_lokalise_api/endpoints/permission_templates_endpoint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class PermissionTemplatesEndpoint < MainEndpoint
+      private
+
+      def base_query(team_id)
+        {
+          teams: [team_id, :roles]
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/error.rb

@@ -52,7 +52,7 @@ module RubyLokaliseApi
 
     # Initializes a new Error object
     def initialize(message = '')
-      super(message)
+      super
     end
   end
 end

data/lib/ruby_lokalise_api/oauth2/auth.rb

@@ -29,7 +29,7 @@ module RubyLokaliseApi
       def auth(scope:, redirect_uri: nil, state: nil)
         get_params = {
           client_id: client_id,
-          scope: (scope.is_a?(Array) ? scope.join(' ') : scope),
+          scope: scope_to_string(scope),
           state: state,
           redirect_uri: redirect_uri
         }
@@ -37,41 +37,42 @@ module RubyLokaliseApi
         oauth2_endpoint.new(self, query: 'auth', get: get_params).full_uri
       end
 
-      # Requests OAuth2 access token. Requires OAuth2 code obtained
-      # using the `.auth` method
-      # @return [RubyLokaliseApi::Resources::OAuth2Token]
-      # @param code [String]
+      # Requests an OAuth2 access token using a code
+      # @param code [String] The authorization code
+      # @return [RubyLokaliseApi::Resources::OAuth2Token] The OAuth2 token resource
       def token(code)
-        endpoint = oauth2_endpoint.new(
-          self,
-          query: :token,
-          req: common_params.merge(
-            grant_type: 'authorization_code',
-            code: code
-          )
-        )
-
-        RubyLokaliseApi::Resources::OAuth2Token.new endpoint.do_post
+        request_token(grant_type: 'authorization_code', code: code)
       end
 
-      # Refreshes expired OAuth2 access token.
-      # @return [RubyLokaliseApi::Resources::OAuth2RefreshedToken]
-      # @param refresh_token [String]
+      # Refreshes an expired OAuth2 token
+      # @param refresh_token [String] The refresh token
+      # @return [RubyLokaliseApi::Resources::OAuth2RefreshedToken] The refreshed token resource
       def refresh(refresh_token)
-        endpoint = oauth2_endpoint.new(
-          self,
-          query: :token,
-          req: common_params.merge(
-            grant_type: 'refresh_token',
-            refresh_token: refresh_token
-          )
-        )
-
-        RubyLokaliseApi::Resources::OAuth2RefreshedToken.new endpoint.do_post
+        request_token(grant_type: 'refresh_token', refresh_token: refresh_token)
       end
 
       private
 
+      # Generalized method for requesting a token
+      # @param params [Hash] Request parameters including grant type
+      # @return [RubyLokaliseApi::Resources::OAuth2Token, RubyLokaliseApi::Resources::OAuth2RefreshedToken]
+      def request_token(params)
+        endpoint = oauth2_endpoint.new(self, query: :token, req: common_params.merge(params))
+        resource_class = if params[:grant_type] == 'authorization_code'
+                           RubyLokaliseApi::Resources::OAuth2Token
+                         else
+                           RubyLokaliseApi::Resources::OAuth2RefreshedToken
+                         end
+        resource_class.new(endpoint.do_post)
+      end
+
+      # Converts scope to a space-separated string if it's an array
+      # @param scope [Array, String] The scope or scopes
+      # @return [String] The scope as a string
+      def scope_to_string(scope)
+        scope.is_a?(Array) ? scope.join(' ') : scope
+      end
+
       def common_params
         {
           client_id: @client_id,

data/lib/ruby_lokalise_api/oauth2_client.rb

@@ -4,7 +4,7 @@ module RubyLokaliseApi
   # Client used to perform API requests with an OAuth2 access token
   class OAuth2Client < Client
     def initialize(token, params = {})
-      super(token, params)
+      super
       @token_header = 'Authorization'
       @token = "Bearer #{@token}"
     end

data/lib/ruby_lokalise_api/request.rb

@@ -63,17 +63,19 @@ module RubyLokaliseApi
     end
 
     def respond_with(response, endpoint)
-      begin
-        body = custom_load response.body
-      rescue JSON::ParserError
-        respond_with_error(response.status, response.body)
-      end
+      body = parse_response_body(response)
 
       raise_on_error! response, body
 
       RubyLokaliseApi::Response.new(body, endpoint, response.headers)
     end
 
+    def parse_response_body(response)
+      custom_load(response.body)
+    rescue JSON::ParserError
+      respond_with_error(response.status, response.body)
+    end
+
     def respond_with_error(code, body)
       raise(RubyLokaliseApi::Error, body['error'] || body) unless RubyLokaliseApi::Error::ERRORS.key? code
 

data/lib/ruby_lokalise_api/resources/base.rb

@@ -57,20 +57,28 @@ module RubyLokaliseApi
         @self_endpoint.reinitialize(query_params: read_main_params, req_params: req_params)
       end
 
+      # Populates attributes from the response content
       def populate_attrs_from(content)
         return unless content
 
-        data_key = data_key_for klass: self.class.base_name
+        data_key = data_key_for(klass: self.class.base_name)
+        supported_attrs.each { |attrib| set_instance_variable(attrib, content, data_key) }
+      end
 
-        supported_attrs.each do |attrib|
-          value = if content.key?(data_key) && content[data_key].is_a?(Hash) && content[data_key].key?(attrib)
-                    content[data_key][attrib]
-                  else
-                    content[attrib]
-                  end
+      # Sets the instance variable for a given attribute
+      def set_instance_variable(attrib, content, data_key)
+        value = if content_key_exists?(content, data_key, attrib)
+                  content[data_key][attrib]
+                else
+                  content[attrib]
+                end
 
-          instance_variable_set :"@#{attrib}", value
-        end
+        instance_variable_set(:"@#{attrib}", value)
+      end
+
+      # Checks if the content contains the specified key
+      def content_key_exists?(content, data_key, attrib)
+        content.key?(data_key) && content[data_key].is_a?(Hash) && content[data_key].key?(attrib)
       end
     end
   end

data/lib/ruby_lokalise_api/resources/permission_template.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Resources
+    class PermissionTemplate < Base
+      MAIN_PARAMS = %i[nil].freeze
+      no_support_for %i[update destroy reload_data]
+    end
+  end
+end

data/lib/ruby_lokalise_api/response.rb

@@ -5,7 +5,7 @@ module RubyLokaliseApi
   class Response
     # 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
+                            x-pagination-page x-pagination-next-cursor].freeze
 
     attr_reader :content, :endpoint, :headers
 
@@ -31,20 +31,11 @@ module RubyLokaliseApi
       @endpoint = new_endpoint
     end
 
-    # Returns an array of pagination headers
-    def pagination_headers
-      self.class.const_get(:PAGINATION_HEADERS)
-    end
-
     private
 
     # Keep only pagination headers
     def extract_headers_from(raw_headers)
-      raw_headers.
-        to_h.
-        keep_if { |header, _value| pagination_headers.include?(header) }.
-        transform_keys(&:to_sym).
-        transform_values(&:to_i)
+      raw_headers.to_h.slice(*PAGINATION_HEADERS).transform_keys(&:to_sym)
     end
   end
 end

data/lib/ruby_lokalise_api/rest/permission_templates.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module PermissionTemplates
+      # Returns permission tempates for a team
+      #
+      # @see https://developers.lokalise.com/reference/list-all-permission-templates
+      # @return [RubyLokaliseApi::Collections::PermissionTemplates]
+      # @param team_id [Integer, String]
+      def permission_templates(team_id)
+        name = 'PermissionTemplates'
+        params = { query: team_id }
+
+        data = endpoint(name: name, params: params).do_get
+
+        collection name, data
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest.rb

@@ -14,6 +14,7 @@ module RubyLokaliseApi
     include Rest::Languages
     include Rest::Orders
     include Rest::PaymentCards
+    include Rest::PermissionTemplates
     include Rest::Projects
     include Rest::QueuedProcesses
     include Rest::Segments

data/lib/ruby_lokalise_api/utils/attributes.rb

@@ -14,11 +14,11 @@ module RubyLokaliseApi
       #
       # @return [Array<String>]
       def attributes_for(klass, filename)
-        @attributes ||= YAML.load_file(File.expand_path("../data/#{filename}", __dir__)).freeze
+        @attributes ||= load_attributes(filename)
 
         name = unify klass.base_name.snakecase
 
-        @attributes.key?(name) ? @attributes[name] : @attributes["#{name}s"]
+        @attributes[name] || @attributes["#{name}s"]
       end
 
       # Unify some resources' names (eg, `ProjectComment` and `KeyComment` have the same
@@ -26,11 +26,15 @@ module RubyLokaliseApi
       #
       # @return [String]
       def unify(name)
-        UNIFIED_RESOURCES.each do |u_a|
-          return u_a if name.match?(/#{u_a}/)
-        end
+        UNIFIED_RESOURCES.find { |u_a| name.match?(/#{u_a}/) } || name
+      end
 
-        name
+      # Loads attributes from a YAML file
+      #
+      # @param filename [String] The filename to load attributes from
+      # @return [Hash] The loaded attributes hash
+      def load_attributes(filename)
+        YAML.load_file(File.expand_path("../data/#{filename}", __dir__)).freeze
       end
     end
   end

data/lib/ruby_lokalise_api/utils/classes.rb

@@ -5,18 +5,25 @@ module RubyLokaliseApi
   module Utils
     module Classes
       refine Object do
-        # Turn `Module::Nested::ClassName` to just `ClassName`
+        # Extracts the base name of a class, removing any module nesting.
+        #
+        # @return [String] The base class name
         def base_name
           name.split('::').last
         end
 
-        # Converts object to array unless it is already an array
+        # Converts the object to an array, unless it is already an array.
+        #
+        # @return [Array] The object wrapped in an array if not already an array
         def to_array
           is_a?(Array) ? self : [self]
         end
 
-        # Converts object to array and then places this array
-        # inside hash under the provided key
+        # Converts the object to an array, then places this array inside a hash
+        # under the provided key.
+        #
+        # @param key [Symbol, String] The key under which to place the array
+        # @return [Hash] The hash with the array under the provided key
         def to_array_obj(key)
           return self if is_a?(Hash) && (key?(key) || key?(key.to_s))
 

data/lib/ruby_lokalise_api/utils/keys.rb

@@ -5,25 +5,36 @@ module RubyLokaliseApi
     module Keys
       using RubyLokaliseApi::Utils::Strings
 
-      # Reads DATA_KEY for resources. DATA_KEY specifies the name of the key
-      # in the API response that contains the actual data
+      # Retrieves the DATA_KEY for resources.
+      # DATA_KEY specifies the key in the API response containing the actual data.
+      #
+      # @param klass [Class] The class of the resource
+      # @return [String] The snake-cased DATA_KEY
       def data_key_for(klass:)
-        key = if Module.const_defined? "RubyLokaliseApi::Resources::#{klass}::DATA_KEY"
-                Module.const_get "RubyLokaliseApi::Resources::#{klass}::DATA_KEY"
-              else
-                klass
-              end
-
-        key.snakecase
+        retrieve_data_key("RubyLokaliseApi::Resources::#{klass}::DATA_KEY", klass)
       end
 
-      # Reads DATA_KEY for collections. DATA_KEY specifies the name of the key
-      # in the API response that contains the actual data
+      # Retrieves the DATA_KEY for collections.
+      # DATA_KEY specifies the key in the API response containing the actual data.
+      #
+      # @param klass [Class] The class of the collection
+      # @return [String] The snake-cased DATA_KEY
       def collection_key_for(klass:)
-        key = if Module.const_defined?("RubyLokaliseApi::Collections::#{klass}::DATA_KEY")
-                Module.const_get("RubyLokaliseApi::Collections::#{klass}::DATA_KEY")
+        retrieve_data_key("RubyLokaliseApi::Collections::#{klass}::DATA_KEY", klass)
+      end
+
+      private
+
+      # Helper method to retrieve the DATA_KEY for a given class.
+      #
+      # @param constant_path [String] The constant path to check
+      # @param fallback [Class] The fallback class if the constant isn't defined
+      # @return [String] The snake-cased key
+      def retrieve_data_key(constant_path, fallback)
+        key = if Module.const_defined?(constant_path)
+                Module.const_get(constant_path)
               else
-                klass
+                fallback
               end
 
         key.snakecase

data/lib/ruby_lokalise_api/utils/loaders.rb

@@ -6,21 +6,40 @@ module RubyLokaliseApi
       private
 
       # Instantiates an endpoint
+      #
+      # @param name [String] The name of the endpoint
+      # @param client [Object] The client to associate with the endpoint (default: self)
+      # @param params [Hash] Additional parameters for the endpoint
+      # @return [Object] The instantiated endpoint
       def endpoint(name:, client: self, params: {})
-        klass = RubyLokaliseApi.const_get "Endpoints::#{name}Endpoint"
-        klass.new client, params
+        instantiate("Endpoints::#{name}Endpoint", client, params)
       end
 
       # Instantiates a resource
+      #
+      # @param name [String] The name of the resource
+      # @param data [Hash] The data to initialize the resource with
+      # @return [Object] The instantiated resource
       def resource(name, data)
-        klass = RubyLokaliseApi.const_get "Resources::#{name}"
-        klass.new data
+        instantiate("Resources::#{name}", data)
       end
 
       # Instantiates a collection
+      #
+      # @param name [String] The name of the collection
+      # @param data [Hash] The data to initialize the collection with
+      # @return [Object] The instantiated collection
       def collection(name, data)
-        klass = RubyLokaliseApi.const_get "Collections::#{name}"
-        klass.new data
+        instantiate("Collections::#{name}", data)
+      end
+
+      # Helper method to instantiate a class by constant name
+      #
+      # @param constant_path [String] The constant path for the class
+      # @param args [Array] Arguments to initialize the class with
+      # @return [Object] The instantiated class
+      def instantiate(constant_path, *args)
+        RubyLokaliseApi.const_get(constant_path).new(*args)
       end
     end
   end

data/lib/ruby_lokalise_api/utils/strings.rb

@@ -4,15 +4,16 @@ module RubyLokaliseApi
   module Utils
     module Strings
       refine String do
-        # Initial code taken from Facets gem by Rubyworks
+        # Converts a string to snake_case format.
+        # Original code inspired by the Facets gem by Rubyworks:
         # https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
         def snakecase
-          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
-            gsub(/([a-z\d])([A-Z])/, '\1_\2').
-            tr('-', '_').
-            gsub(/\s/, '_').
-            gsub(/__+/, '_').
-            downcase
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2'). # Handle acronyms like 'HTMLParser'
+            gsub(/([a-z\d])([A-Z])/, '\1_\2').      # Handle camelCase to snake_case
+            tr('-', '_').                           # Replace dashes with underscores
+            gsub(/\s/, '_').                        # Replace spaces with underscores
+            gsub(/__+/, '_').                       # Collapse multiple underscores
+            downcase # Convert everything to lowercase
         end
       end
     end

data/lib/ruby_lokalise_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
-  VERSION = '9.0.1'
+  VERSION = '9.2.0'
 end

data/ruby-lokalise-api.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop',             '~> 1.6'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
   spec.add_development_dependency 'rubocop-rake',        '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec',       '~> 2.0'
+  spec.add_development_dependency 'rubocop-rspec',       '~> 3.0'
   spec.add_development_dependency 'simplecov',           '~> 0.21'
   spec.add_development_dependency 'simplecov-lcov',      '~> 0.8'
   spec.add_development_dependency 'webmock',             '~> 3.14'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 9.0.1
+  version: 9.2.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -263,6 +263,7 @@ files:
 - lib/ruby_lokalise_api/collections/keys.rb
 - lib/ruby_lokalise_api/collections/orders.rb
 - lib/ruby_lokalise_api/collections/payment_cards.rb
+- lib/ruby_lokalise_api/collections/permission_templates.rb
 - lib/ruby_lokalise_api/collections/project_comments.rb
 - lib/ruby_lokalise_api/collections/project_languages.rb
 - lib/ruby_lokalise_api/collections/projects.rb
@@ -296,6 +297,7 @@ files:
 - lib/ruby_lokalise_api/endpoints/oauth2/oauth2_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/orders_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/payment_cards_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/permission_templates_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/project_comments_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/project_languages_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/projects_endpoint.rb
@@ -330,6 +332,7 @@ files:
 - lib/ruby_lokalise_api/resources/oauth2_token.rb
 - lib/ruby_lokalise_api/resources/order.rb
 - lib/ruby_lokalise_api/resources/payment_card.rb
+- lib/ruby_lokalise_api/resources/permission_template.rb
 - lib/ruby_lokalise_api/resources/project.rb
 - lib/ruby_lokalise_api/resources/project_language.rb
 - lib/ruby_lokalise_api/resources/queued_process.rb
@@ -357,6 +360,7 @@ files:
 - lib/ruby_lokalise_api/rest/languages.rb
 - lib/ruby_lokalise_api/rest/orders.rb
 - lib/ruby_lokalise_api/rest/payment_cards.rb
+- lib/ruby_lokalise_api/rest/permission_templates.rb
 - lib/ruby_lokalise_api/rest/projects.rb
 - lib/ruby_lokalise_api/rest/queued_processes.rb
 - lib/ruby_lokalise_api/rest/screenshots.rb
@@ -397,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API