ruby-lokalise-api 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33c8b8383d4e08130e6a27af7bf66d512d4db1546e3b572f9860a67c4c280281
-  data.tar.gz: a6a2bdbd9ad4f394a32b725135c1327e64ffa82cddcb2523d4d1f166932d7d73
+  metadata.gz: 1f104ba9751dfab41967f0a7c766d4cb631a9219ae6a7d6f791b48dd3f68b171
+  data.tar.gz: 25416c89c5b24ca8439050a7adec02568eb5a6ed1379b6703957706dd33b4431
 SHA512:
-  metadata.gz: 3f68a55a77660fb86e4b4ba138f9092afeaf12462865dbd6fb72efe773593428667348c887b297af44896fcbad4272fd02e19016708b5570c90fb95a3e68b182
-  data.tar.gz: e7359331fe700fe781cf16de68cc9d44d143e96eb43cf6ab4b5d250eb3b2be52bb23c738ba9548d7fbe298895fdc688cb0b7c06f2cbda38049ca83e8f7c944a1
+  metadata.gz: 9787b6d1bd962049fa0c1963a348dffa370dc03c23dfc1799688999128d5552f7bad9cc149cd204020ae04e5ff1301ca7a87208eb9cbd40f7fa78dbf2131e32e
+  data.tar.gz: 26e9576d4b8f554954f7d1486c8abad86bab2c1cdde67aa7d57c8f8aa71b6eef3a3477e467e081d6b12c618d6239ea9c585e19e16a7d8f5633a91d3e7c7fc60c

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,9 +32,25 @@ module RubyLokaliseApi
       def next_page
         return nil if last_page?
 
+        override_params = { page: current_page + 1 }
+
         self.class.new(
           reinit_endpoint(
-            override_req_params: { page: current_page + 1 }
+            override_req_params: override_params
+          ).do_get
+        )
+      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?
+
+        override_params = { cursor: next_cursor }
+
+        self.class.new(
+          reinit_endpoint(
+            override_req_params: override_params
           ).do_get
         )
       end
@@ -75,6 +91,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
@@ -86,17 +108,20 @@ module RubyLokaliseApi
 
       def populate_common_attrs_from(response)
         supported_attrs.each do |attrib|
-          instance_variable_set "@#{attrib}", response.content[attrib]
+          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)

data/lib/ruby_lokalise_api/endpoints/base_endpoint.rb

@@ -38,7 +38,7 @@ module RubyLokaliseApi
       # Creates methods like `do_post`, `do_get` that proxy calls to the
       # corresponding methods in the `Request` module
       HTTP_METHODS.each do |method_postfix|
-        define_method "do_#{method_postfix}" do
+        define_method :"do_#{method_postfix}" do
           send method_postfix, self
         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(client, params)
 
         @uri = partial_uri(base_query(*@query_params))
       end

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

@@ -8,7 +8,7 @@ module RubyLokaliseApi
         PARTIAL_URI_TEMPLATE = '{/segments*}{?query*}'
 
         def initialize(client, params = {})
-          super client, params
+          super(client, params)
 
           @uri = partial_uri(base_query(*@query_params), params.fetch(:get, []))
         end

data/lib/ruby_lokalise_api/error.rb

@@ -40,7 +40,12 @@ module RubyLokaliseApi
     class << self
       # Create a new error from an HTTP response
       def from_response(body)
-        msg = body.key?('error') ? body['error']['message'] : body['message']
+        msg = if body.respond_to?(:key)
+                body.key?('error') ? body['error']['message'] : body['message']
+              else
+                body
+              end
+
         new msg.to_s
       end
     end

data/lib/ruby_lokalise_api/generics.rb

@@ -14,7 +14,7 @@ module RubyLokaliseApi
 
     def initialize(raw_data)
       raw_data.each do |att, val|
-        instance_variable_set "@#{att}", val
+        instance_variable_set :"@#{att}", val
 
         self.class.class_exec do
           attr_reader att.to_sym

data/lib/ruby_lokalise_api/request.rb

@@ -63,7 +63,11 @@ module RubyLokaliseApi
     end
 
     def respond_with(response, endpoint)
-      body = custom_load response.body
+      begin
+        body = custom_load response.body
+      rescue JSON::ParserError
+        respond_with_error(response.status, response.body)
+      end
 
       raise_on_error! response, body
 

data/lib/ruby_lokalise_api/resources/base.rb

@@ -49,7 +49,7 @@ module RubyLokaliseApi
 
       def read_main_params
         self.class.const_get(:MAIN_PARAMS).to_array.map do |param|
-          instance_variable_get "@#{param}"
+          instance_variable_get :"@#{param}"
         end
       end
 
@@ -69,7 +69,7 @@ module RubyLokaliseApi
                     content[attrib]
                   end
 
-          instance_variable_set "@#{attrib}", value
+          instance_variable_set :"@#{attrib}", value
         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
 
@@ -43,8 +43,7 @@ module RubyLokaliseApi
       raw_headers.
         to_h.
         keep_if { |header, _value| pagination_headers.include?(header) }.
-        transform_keys(&:to_sym).
-        transform_values(&:to_i)
+        transform_keys(&:to_sym)
     end
   end
 end

data/lib/ruby_lokalise_api/version.rb

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

data/ruby-lokalise-api.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2024-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -397,7 +397,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API