ecoportal-api-v2 0.8.21 → 0.8.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfc9e699414df7fd4298148668b5b0a95759dc114758614d29da2ba7bc6472de
-  data.tar.gz: d589c4f84d7f0d55912d6542129bdebc74d599730a8980c1ec83b8317b7dd942
+  metadata.gz: 6d0fd873fa135b382e7a8e272ab0bbdee729e6d15ebaceea8b4699fb3af650f2
+  data.tar.gz: 55e54d6e2b07d8108f2ca1a915118133ca6d4180519e6c8cafb7eacc449c60b0
 SHA512:
-  metadata.gz: 901028e62fb4e10920918815635a7b99b54fb058ab0c79514a338373aa3b9e6b200757f26912876c2b7bf97201e3958353795dea870e7dbc3154e4e1ad578954
-  data.tar.gz: 85951a26535f34d0cbbc66d35410c8059b83df436359fea19e478196db2b93496f8a17ac0fe048ef231309f2684546fac4cc037076ffb0603b54d03ccb0de22c
+  metadata.gz: 907b384d0f7f31fc9f1d656c7e535c814ac7bbe4d0d8034d7c80f924b3896f4cc8855296e871fa0f1c9d4dc4cff12e05bbedd893c4750dc9d34d02d355678531
+  data.tar.gz: 9ca8fc0aaf31e37dfd61abdc45e42269abacbb3220b6dcc5fa020a26f5f3e1096dbb2723ed23d8036281db86453c2a187f026877f98e94324a614daa23ae10c2

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.8.25] - 2022-02-04
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::ReferenceField#add` to add new references
+
+### Changed
+  - `Ecoportal::API::Common::Content::HashDiffPatch#patch_data`
+    - Added support for model objects with no `patch_ver` (so diffs are calculated as well)
+
+### Fixed
+
+## [0.8.24] - 2022-01-05
+
+### Fixed
+  - `Ecoportal::API::V2::Page#stages?` do not generate an object to this purpose
+  - `Ecoportal::API::V2::Registers#search` fix typo in print feedback
+
+## [0.8.23] - 2021-12-24
+
+### Added
+  - `Ecoportal::API::V2::Registers#search` added more feedback on what is going on
+
+## [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
+
 ## [0.8.21] - 2021-12-15
 
 ### Added
@@ -11,7 +39,7 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
   - Re-exposed `Ecoportal::API::V2::Stages#ordered`
-  
+
 ### Fixed
   - `Ecoportal::API::V2::Page::Component::ImagesField#images` typo in `klass`
 

data/lib/ecoportal/api/common/content/hash_diff_patch.rb

@@ -88,6 +88,7 @@ module Ecoportal
                   elsif a && a.key?("patch_ver")
                     data_hash["patch_ver"] = a["patch_ver"]
                   end
+                  data_hash.delete("force_patch")
                 end
               end
             end

data/lib/ecoportal/api/v2/page/component/reference_field.rb

@@ -16,6 +16,14 @@ module Ecoportal
               end
             end
 
+            def add(ref_id)
+              doc["references"].push({
+                "id" => ref_id,
+                "weight" => 0,
+                "patch_ver" => 0
+              })
+            end
+
             def to_s(delimiter: "\n")
               reference_ids.to_a.join(delimiter)
             end

data/lib/ecoportal/api/v2/page/section.rb

@@ -137,7 +137,7 @@ module Ecoportal
             if before
               before_fld = to_component(before, side: side)
             elsif after
-              after_fld  = to_component(afterm, side: side)
+              after_fld  = to_component(after, side: side)
             end
 
             if split?
@@ -145,7 +145,6 @@ module Ecoportal
             else
               ids_ary = component_ids
             end
-
             ids_ary.insert_one(field.id, before: before_fld&.id, after: after_fld&.id)
             self
           end
@@ -168,7 +167,7 @@ module Ecoportal
 
             fields.find do |fld|
               found   = nil
-              found ||= !!value if value.is_a?(Ecoportal::API::V2::Page::Component)
+              found ||= fld.id == value.id if value.is_a?(Ecoportal::API::V2::Page::Component)
               found ||= fld.id == value
               found ||= same_string?(fld.label, value)
             end

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

@@ -51,7 +51,7 @@ module Ecoportal
         end
 
         def stages?
-          self.stages.count > 0
+          self.doc["stages"] && (self.stages.count > 0)
         end
 
         # @return [String] with feedback, if for this page instance, there are any of:

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, options)
+              #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,51 @@ 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, options)
+            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, options)
+          msg += "\n"
+          msg += "  • Original total: #{total}\n"
+          msg += "    • Current total: #{data&.dig("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.21"
+    GEM2_VERSION = "0.8.25"
   end
 end

metadata

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