ecoportal-api-v2 0.8.22 → 0.8.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6699a6cd1b82c54b0bf097dde24c034b4b114faa6cf23a7765429c384d45b3d
-  data.tar.gz: eef7fb625d8073d7de972f028fe9628886eb04e3b1eee6e9a8bf760170e64a1c
+  metadata.gz: 95c3cc7227186059ebac670bc0b3ba3637addab3f51dfe22d9303a27088cb2fd
+  data.tar.gz: 05c0ee0a0a548081136d328ef1b33a27d6ee4f029752a8a1f3c28308fd05ea82
 SHA512:
-  metadata.gz: b6eb538df89c4d99b7715d23c75c3eea53a4ffbb3063c612a797a7aebe58f4e427393c410a10e7b67b3744f4986d550c24659ad4d17b9dd870d742f924c0d7c7
-  data.tar.gz: 3da71eae2f509fa6a7afaf7b6744e18210741efddffa5f7d06858de091922f1dccbc64017be8dbc9b13bc8f6aaaaea4abb0b94b433f8a7bb178f07407268dd57
+  metadata.gz: 2ad708f7fcec88a0380997bbf493d2186b5853e1eb4884e62c1107a4116337c53939852f99ab3d7cedbf2dddceed5fca63531f985a32a3a67139e150c9b94e7d
+  data.tar.gz: aec3d7c8faa9cae78da045b34865da17a5ceb5b548fb9a66a1be51dc2448da92c150f528d9a9b62d1fdb93d1bfbeadbb7ff812ea02a9c7c0d6eb07aadb985f0d

data/CHANGELOG.md

@@ -1,10 +1,16 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.22] - 2021-12-23
+## [0.8.23] - 2021-12-24
 
 ### Added
+  - `Ecoportal::API::V2::Registers#search` added more feedback on what is going on
+
 ### Changed
+### Fixed
+
+## [0.8.22] - 2021-12-23
+
 ### Fixed
   - `Ecoportal::API::V2::Page::Section#add_component` was not using correctly `before` and `after`
     - It was not correctly translating them into the existing component

data/lib/ecoportal/api/v2/pages.rb

@@ -49,7 +49,7 @@ module Ecoportal
         # Requests to update an existing page via api.
         # @note It won't launch the update unless there are changes
         # @param doc [Hash, Page] data that at least contains an `id` (internal or external) of the target page.
-        # @return [Response] an object with the api response.
+        # @return [Ecoportal::API::Common::Response] an object with the api response.
         def update(doc)
           body = get_body(doc) # , level: "page"
           # Launch only if there are changes

data/lib/ecoportal/api/v2/registers.rb

@@ -1,3 +1,4 @@
+require 'base64'
 module Ecoportal
   module API
     class V2
@@ -42,18 +43,7 @@ module Ecoportal
         # @return [Ecoportal::API::V2::Registers, Ecoportal::API::V2::Registers::SearchResults]
         def search(register_id, options = {})
           only_first = options.delete(:only_first)
-          # supply a query string
-          # or a filter array (copy/paste from dev tools in the browser)
-          options = {query: nil, filters: []}.update(options)
-          options = {}.tap do |ret|
-            options.each do |key, value|
-              if key == :filters && value.any?
-                ret[key] = {filters: value}.to_json
-              else
-                ret[key] = value if key
-              end
-            end
-          end
+          options    = build_options(options)
 
           if only_first
             response = client.get("/registers/#{register_id}/search", params: options)
@@ -62,19 +52,23 @@ module Ecoportal
           end
 
           cursor_id = nil
-          results = 0
+          results = 0; total = nil
           loop do
             options.update(cursor_id: cursor_id) if cursor_id
             response = client.get("/registers/#{register_id}/search", params: options)
             raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
 
-            data = response.body["data"]
-            unless (total = data["total"]) == 0
+            data    = response.body["data"]
+            total ||= data["total"]
+            if total != data["total"]
+              msg  = "Change of total in search results. Probably due to changes that affect the filter (register: #{register_id}):"
+              print_search_status(msg, total, results, cursor_id, data)
+              #total = data["total"]
+            end
+
+            unless total == 0
               results += data["results"].length
-              percent  = results * 100 / total
-              msg      = "Registers SEARCH"
-              print "#{msg}: #{percent.round}% (of #{total})\r"
-              $stdout.flush
+              print_progress(results, total)
             end
 
             data["results"].each do |result|
@@ -83,12 +77,50 @@ module Ecoportal
             end
 
             break if total <= results
+            unless data["cursor_id"]
+              msg  = "Possible error... finishing search for lack of cursor_id in response:"
+              print_search_status(msg, total, results, cursor_id, data)
+            end
             break unless (cursor_id = data["cursor_id"])
           end
           self
         end
 
+        private
+
+        def build_options(options)
+          # supply a query string
+          # or a filter array (copy/paste from dev tools in the browser)
+          options = {query: nil, filters: []}.update(options)
+          {}.tap do |ret|
+            options.each do |key, value|
+              if key == :filters && value.any?
+                ret[key] = {filters: value}.to_json
+              else
+                ret[key] = value if key
+              end
+            end
+          end
+        end
+
+        def print_search_status(msg, total, results, cursor_id, data)
+          msg += "\n"
+          msg += "  • Original total: #{total}\n"
+          msg += "  • Total results retrieved: #{results}\n"
+          msg += "  • Cursor id: #{cursor_id} (#{Base64.decode64(cursor_id)})\n"
+          msg += "    • Current cursor results: #{data["results"]&.length}\n"
+          msg += "    • Next id: #{data["cursor_id"]} (#{Base64.decode64(data["cursor_id"])})\n" if data["cursor_id"]
+          msg += "  • Options:"
+          puts msg
+          pp options
+        end
 
+        def print_progress(results, total)
+          percent  = results * 100 / total
+          msg      = "Registers SEARCH"
+          print "#{msg}: #{percent.round}% (of #{total})\r"
+          $stdout.flush
+        end
       end
     end
   end

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.22"
+    GEM2_VERSION = "0.8.23"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.22
+  version: 0.8.23
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2021-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler