ruby-lokalise-api 9.3.0 → 9.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a734c5288ebac29f39891c5d83af1a5e183232bca6c163d308ea17fa2b40f71
-  data.tar.gz: cd8cf158d27398557b9b2d24e70a6b3c8cf845e9cc44065d22de24497a69d06a
+  metadata.gz: bc7bacb7f1ff0d27112db67a6fb124f6eeb35bf878f23ae897a28144e5f559fa
+  data.tar.gz: 375fa427d45798133845573106c0a4cde68e3f26a14d0b3509a66b05823015fb
 SHA512:
-  metadata.gz: 7f005996fb4ee75f9dc7b1b9064897aa3574e3dbf4afc2faad78f9bba09d088c560628ea798f3b8f5acc577596342c06b521bb233d6037c319fd901ca8694733
-  data.tar.gz: b4327dc17efb6ffa8b05cfad19d63a6eccc652cc0167afd152863509bf5a7a8b415dfc955901b5586a6f020e067096dd4b920b43b7d759209e07e7687e3634f8
+  metadata.gz: 6e1c5f558238f260eb8b612555a403d9162660da9b4e346f29d1e42e4f0ca5a51e0d0b97917be622bf849ff6ff68c7feaf4bcaf32df3eba4b924347ddf884016
+  data.tar.gz: d3f8e93c4664337c946defe4f058a8ec16ae280336e97fc69ba1b71bcedffa4e1db0b26ad03c7434a8b6bece88cebed98fcf35635a5e51de14dd5937992cab8c

data/lib/ruby_lokalise_api/collections/base.rb

@@ -54,7 +54,7 @@ module RubyLokaliseApi
       # Checks whether the next page is available
       # @return [Boolean]
       def next_page?
-        current_page.positive? && current_page < total_pages
+        !current_page.nil? && current_page.positive? && current_page < total_pages
       end
 
       # Checks whether the current page is the last one
@@ -66,7 +66,7 @@ module RubyLokaliseApi
       # Checks whether the previous page is available
       # @return [Boolean]
       def prev_page?
-        current_page > 1
+        !current_page.nil? && current_page > 1
       end
 
       # Checks whether the current page is the first one

data/lib/ruby_lokalise_api/collections/glossary_terms.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class GlossaryTerms < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::GlossaryTermsEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::GlossaryTerm
+      DATA_KEY = 'data'
+    end
+  end
+end

data/lib/ruby_lokalise_api/connection.rb

@@ -54,7 +54,7 @@ module RubyLokaliseApi
           accept: 'application/json',
           user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}"
         },
-        url: (endpoint.client.api_host || endpoint.base_url)
+        url: endpoint.client.api_host || endpoint.base_url
       }
     end
 

data/lib/ruby_lokalise_api/data/resource_attributes.yml

@@ -41,6 +41,18 @@ file:
   - file_id
   - filename
   - key_count
+glossary_term:
+  - id
+  - projectId
+  - term
+  - description
+  - caseSensitive
+  - translatable
+  - forbidden
+  - translations
+  - tags
+  - createdAt
+  - updatedAt
 jwt:
   - jwt
 key:

data/lib/ruby_lokalise_api/endpoints/glossary_terms_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class GlossaryTermsEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, term_id = nil)
+        {
+          projects: project_id,
+          'glossary-terms': term_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/resources/base.rb

@@ -40,7 +40,7 @@ module RubyLokaliseApi
         # Delegates instance method calls to the client methods
         def delegate_call(from, to = nil)
           define_method(from) do |*args|
-            @self_endpoint.client.send((to || from), *read_main_params.push(*args))
+            @self_endpoint.client.send(to || from, *read_main_params.push(*args))
           end
         end
       end

data/lib/ruby_lokalise_api/resources/glossary_term.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Resources
+    class GlossaryTerm < Base
+      MAIN_PARAMS = %i[projectId id].freeze
+      DATA_KEY = 'data'
+      no_support_for %i[update destroy]
+    end
+  end
+end

data/lib/ruby_lokalise_api/resources/project.rb

@@ -36,8 +36,15 @@ module RubyLokaliseApi
       delegate_call :files
       delegate_call :upload_file
       delegate_call :download_files
+      delegate_call :download_files_async
       delegate_call :destroy_file
 
+      delegate_call :glossary_terms
+      delegate_call :glossary_term
+      delegate_call :create_glossary_terms
+      delegate_call :update_glossary_terms
+      delegate_call :destroy_glossary_terms
+
       delegate_call :create_jwt
 
       delegate_call :keys

data/lib/ruby_lokalise_api/rest/files.rb

@@ -50,6 +50,24 @@ module RubyLokaliseApi
         RubyLokaliseApi::Generics::DownloadBundle.new data.content
       end
 
+      # Downloads translation files from the project asynchronously
+      #
+      # @see https://developers.lokalise.com/reference/download-files-async
+      # @return [RubyLokaliseApi::Resources::QueuedProcess]
+      # @param project_id [String]
+      # @param req_params [Hash]
+      def download_files_async(project_id, req_params)
+        params = { query: [project_id, :'async-download'], req: req_params }
+
+        response = endpoint(name: 'Files', params: params).do_post
+
+        process_id = response.content['process_id']
+
+        response.patch_endpoint_with endpoint(name: 'QueuedProcesses', params: { query: [project_id, process_id] })
+
+        resource 'QueuedProcess', response
+      end
+
       # Deletes a single file from the project.
       # Only the "Documents" projects are supported
       #

data/lib/ruby_lokalise_api/rest/glossary_terms.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module GlossaryTerms
+      using RubyLokaliseApi::Utils::Classes
+
+      # Returns a single glossary term
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-a-glossary-term
+      # @return [RubyLokaliseApi::Resources::GlossaryTerm]
+      # @param project_id [String]
+      # @param term_id [String, Integer]
+      def glossary_term(project_id, term_id)
+        params = { query: [project_id, term_id] }
+
+        data = endpoint(name: 'GlossaryTerms', params: params).do_get
+
+        resource 'GlossaryTerm', data
+      end
+
+      # Returns glossary terms
+      #
+      # @see https://developers.lokalise.com/reference/list-glossary-terms
+      # @return [RubyLokaliseApi::Collections::GlossaryTerms]
+      # @param project_id [String]
+      # @param req_params [Hash]
+      def glossary_terms(project_id, req_params = {})
+        name = 'GlossaryTerms'
+        params = { query: project_id, req: req_params }
+
+        data = endpoint(name: name, params: params).do_get
+
+        collection name, data
+      end
+
+      # Creates one or multiple glossary terms in the project
+      #
+      # @see https://developers.lokalise.com/reference/create-glossary-terms
+      # @return [RubyLokaliseApi::Collections::GlossaryTerms]
+      # @param project_id [String]
+      # @param req_params [Hash, Array]
+      def create_glossary_terms(project_id, req_params)
+        name = 'GlossaryTerms'
+        params = { query: project_id, req: req_params.to_array_obj(:terms) }
+
+        data = endpoint(name: name, params: params).do_post
+
+        collection name, data
+      end
+
+      # Updates one or multiple glossary terms in the project
+      #
+      # @see https://developers.lokalise.com/reference/update-glossary-terms
+      # @return [RubyLokaliseApi::Collections::GlossaryTerms]
+      # @param project_id [String]
+      # @param req_params [Hash, Array]
+      def update_glossary_terms(project_id, req_params)
+        name = 'GlossaryTerms'
+        params = { query: project_id, req: req_params.to_array_obj(:terms) }
+
+        data = endpoint(name: name, params: params).do_put
+
+        collection name, data
+      end
+
+      # Deletes one or multiple glossary terms from the project
+      #
+      # @see https://developers.lokalise.com/reference/delete-glossary-terms
+      # @return [RubyLokaliseApi::Generics::DeletedResource]
+      # @param project_id [String]
+      # @param term_ids [Array, String]
+      def destroy_glossary_terms(project_id, term_ids)
+        params = { query: project_id, req: term_ids.to_array_obj(:terms) }
+
+        data = endpoint(name: 'GlossaryTerms', params: params).do_delete
+
+        RubyLokaliseApi::Generics::DeletedResource.new data.content
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest.rb

@@ -9,6 +9,7 @@ module RubyLokaliseApi
     include Rest::Contributors
     include Rest::CustomTranslationStatuses
     include Rest::Files
+    include Rest::GlossaryTerms
     include Rest::Jwts
     include Rest::Keys
     include Rest::Languages

data/lib/ruby_lokalise_api/utils/attributes.rb

@@ -6,10 +6,10 @@ module RubyLokaliseApi
       using RubyLokaliseApi::Utils::Strings
       using RubyLokaliseApi::Utils::Classes
 
-      private
-
       UNIFIED_RESOURCES = %w[comment].freeze
 
+      private
+
       # Loads attributes for the given resource based on its name
       #
       # @return [Array<String>]

data/lib/ruby_lokalise_api/version.rb

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

data/ruby-lokalise-api.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json',                            '~> 2'
   spec.add_dependency 'zeitwerk',                        '~> 2.4'
 
+  spec.add_development_dependency 'base64',              '~> 0.2.0'
   spec.add_development_dependency 'dotenv',              '~> 3.0'
   spec.add_development_dependency 'oj',                  '~> 3.10'
   spec.add_development_dependency 'rake',                '~> 13.0'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 9.3.0
+  version: 9.5.0
 platform: ruby
 authors:
 - Ilya Krukowski
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -86,6 +85,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +278,7 @@ files:
 - lib/ruby_lokalise_api/collections/contributors.rb
 - lib/ruby_lokalise_api/collections/custom_translation_statuses.rb
 - lib/ruby_lokalise_api/collections/files.rb
+- lib/ruby_lokalise_api/collections/glossary_terms.rb
 - lib/ruby_lokalise_api/collections/key_comments.rb
 - lib/ruby_lokalise_api/collections/keys.rb
 - lib/ruby_lokalise_api/collections/orders.rb
@@ -296,6 +310,7 @@ files:
 - lib/ruby_lokalise_api/endpoints/contributors_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/custom_translation_statuses_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/files_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/glossary_terms_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/jwts_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/key_comments_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/keys_endpoint.rb
@@ -332,6 +347,7 @@ files:
 - lib/ruby_lokalise_api/resources/contributor.rb
 - lib/ruby_lokalise_api/resources/custom_translation_status.rb
 - lib/ruby_lokalise_api/resources/file.rb
+- lib/ruby_lokalise_api/resources/glossary_term.rb
 - lib/ruby_lokalise_api/resources/jwt.rb
 - lib/ruby_lokalise_api/resources/key.rb
 - lib/ruby_lokalise_api/resources/oauth2_refreshed_token.rb
@@ -361,6 +377,7 @@ files:
 - lib/ruby_lokalise_api/rest/contributors.rb
 - lib/ruby_lokalise_api/rest/custom_translation_statuses.rb
 - lib/ruby_lokalise_api/rest/files.rb
+- lib/ruby_lokalise_api/rest/glossary_terms.rb
 - lib/ruby_lokalise_api/rest/jwts.rb
 - lib/ruby_lokalise_api/rest/keys.rb
 - lib/ruby_lokalise_api/rest/languages.rb
@@ -392,7 +409,6 @@ licenses:
 - BSD-3-Clause
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -407,8 +423,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Ruby interface to the Lokalise API
 test_files: []