ecoportal-api-v2 0.8.20 → 0.8.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcd685a294969e210f94f8b8728fec32a94372d349064e14f9a59e24429b7753
-  data.tar.gz: d1c8b4ddf1bcd9b3ac2203c6f1bb293aafcfc6de1d58dde79c7b425c87fe444b
+  metadata.gz: fb1c34f7a92da53d66d3274e36401d853d62054e53706515dcc62d4f5a5447e7
+  data.tar.gz: 6443519538afe51f6e41544ad4be7ca652379fb1b812add8a45655e00467b853
 SHA512:
-  metadata.gz: 145593ad0fe8adf038c9565bafdeee1497e13ed165c45f8a40572463ff9fffb2bcb3eec8834595eab7b89efc6274ca9c1352ff7dd043ec6c632bdff8a01a2793
-  data.tar.gz: 7b8bbb9a4ef83eb033005f5898254f4d67d1fd5e095453f111a4fe350e9ff30236bf0effc4a79c36edf72519a305f1f9596a5ac61dc99a0bdc06a2b5f74b7e1b
+  metadata.gz: e55afda3b52bc454997937bb18a523a993069497df4aa2104d434bf345f992e2ea0a08ecc06db0911427ccc634d79cbeddc1f2c7b6ef6bd929868807d06ebec8
+  data.tar.gz: 143157a46e72041e54aace3f0c28a9f056295c2ddd41e3358a3472a4e6b447faa2486a8782fe3961b42e7f93627d88749af68da1c3d753ca1bc85273a87b2abc

data/CHANGELOG.md

@@ -1,14 +1,47 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.20] - 2021-10-xx
+## [0.8.24] - 2022-01-05
 
 ### Added
+### Changed
+
+### 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
+  - To children of `Ecoportal::API::V2::Page::Component` added method `#to_s` (for exporting)
+  - `Ecoportal::API::V2::Page::Component::ReferenceField`
+    - added `#references` (the lookup results)
+    - added `#reference_ids` (the `ids` of the referenced oozes)
+
+### Changed
+  - Re-exposed `Ecoportal::API::V2::Stages#ordered`
+
+### Fixed
+  - `Ecoportal::API::V2::Page::Component::ImagesField#images` typo in `klass`
+
+## [0.8.20] - 2021-12-09
+
 ### Changed
   - `Ecoportal::API::V2::Pages::PageStage#permits` removed
     - The reason is that it should be changed using the `Stage#permits` instead
   - Upgraded `ecoportal-api` gem dependency
-  
+
 ### Fixed
   - `Ecoportal::API::V2::Page::Stage#sections` typo
 

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

@@ -55,6 +55,10 @@ module Ecoportal
             doc.tap {|d| d.uniq! if uniq?}
           end
 
+          def to_s(delimiter: "|")
+            map(&:to_s).join(delimiter)
+          end
+
           # @see #_items
           # @return [Array] a **copy** of the `Array` elements
           def to_a

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

@@ -29,6 +29,19 @@ module Ecoportal
             passthrough :duration_in_days, read_only: true
             passarray   :file_container_ids
 
+            def to_s
+              stat = case
+                when overdue
+                  "Overdue"
+                when complete
+                  "Complete"
+                else
+                  "Pending"
+              end
+              assignee = assigned_person_member["name"] || assigned_person_member["email"]
+              "#{name}, #{created_at.to_s}, #{stat}, #{assignee}"
+            end
+
           end
         end
       end

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

@@ -30,6 +30,10 @@ module Ecoportal
               end
             end
 
+            def to_s(delimiter: "\n")
+              ordered_tasks.map(&:to_s).join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:requires` required number of completed actions

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

@@ -24,6 +24,10 @@ module Ecoportal
               end
             end
 
+            def to_s(delimiter: "\n")
+              ordered_items.map(&:to_s).compact.join(delimiter)
+            end
+
             private
 
             def fix_item_weights!

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

@@ -19,6 +19,10 @@ module Ecoportal
             passthrough :label
             passthrough :weight
             passboolean :checked
+
+            def to_s
+              checked ? label : nil
+            end
           end
         end
       end

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

@@ -34,6 +34,10 @@ module Ecoportal
               doc["create_event"] = !!value
             end
 
+            def to_s
+              value.to_s
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:time` to show time

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

@@ -19,6 +19,10 @@ module Ecoportal
             passthrough :file_size, :content_type, :token, read_only: true
             passthrough :file_container_id
             passdate    :file_update_at, read_only: true
+
+            def to_s
+              file_container_id
+            end
           end
         end
       end

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

@@ -24,6 +24,10 @@ module Ecoportal
               end
             end
 
+            def to_s(delimiter: "\n")
+              ordered_files.map(&:to_s).join(delimiter)
+            end
+
             private
 
             def fix_file_positions!

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

@@ -26,6 +26,9 @@ module Ecoportal
               end
             end
 
+            def to_s
+              value.to_s
+            end
           end
         end
       end

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

@@ -5,6 +5,10 @@ module Ecoportal
         class Component
           class GeoCoordinates < Common::Content::DoubleModel
             passthrough :lat, :lon
+
+            def to_s
+              "#{lat},#{lon}" if lat & lon
+            end
           end
         end
       end

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

@@ -6,6 +6,10 @@ module Ecoportal
           class GeoField < Page::Component
             passthrough :address
             embeds_one  :coordinates, klass: "Ecoportal::API::V2::Page::Component::GeoCoordinates"
+
+            def to_s
+              coordinates.to_s
+            end
           end
         end
       end

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

@@ -15,7 +15,11 @@ module Ecoportal
 
             passthrough :layout
             passboolean :strech, :no_popup, :hide_options
-            embeds_many :images, klass: "Ecoportal::API::V2::Page::Image", order_key: :weight
+            embeds_many :images, klass: "Ecoportal::API::V2::Page::Component::Image", order_key: :weight
+
+            def to_s
+              images.count
+            end
 
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]

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

@@ -40,6 +40,10 @@ module Ecoportal
               viewable_fields.delete!(field_id)
             end
 
+            def to_s(delimiter: "\n")
+              people_ids.join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:snapshot` to set mode to `snapshot`

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

@@ -9,6 +9,10 @@ module Ecoportal
             passthrough :max_length
             passboolean :exact_index
 
+            def to_s
+              value
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:multiline` multi line mode

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

@@ -5,10 +5,21 @@ module Ecoportal
         class Component
           class ReferenceField < Page::Component
             passthrough :register_id
+            passarray   :references
             passboolean :hide_create, :hide_attach
             passboolean :hide_metadata, :hide_dashboards
             passboolean :display_fields, :display_fields_in_lookup
 
+            def reference_ids
+              references.map do |ref|
+                ref["id"]
+              end
+            end
+
+            def to_s(delimiter: "\n")
+              reference_ids.to_a.join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:show_fields` specify if the public register fields should be shown (requires `register_id`)

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

@@ -5,6 +5,23 @@ module Ecoportal
         class Component
           class RichTextField < Page::Component
             passthrough :content
+
+            HTML_TAGS_REX = /<("[^"]*"|'[^']*'|[^'">])*>/
+
+            def to_s
+              remove_html_tags(content)
+            end
+
+            private
+
+            def remove_html_tags(str)
+              str = str.gsub(HTML_TAGS_REX, ' ')  if str
+              str = str.gsub(/[^[:print:]]/, '') if str
+              str = str.gsub(":&nbsp;", ' ')     if str
+              str = str.gsub("&#34;", '"')       if str
+              str = str.gsub("&amp;", '&')       if str
+              str
+            end
           end
         end
       end

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

@@ -63,6 +63,12 @@ module Ecoportal
               end
             end
 
+            def to_s(name: true, delimiter: "\n")
+              [selected].flatten.compact.map do |opt|
+                name ? opt.name : opt.value
+              end.join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:flat` to display in flat mode

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

@@ -7,6 +7,10 @@ module Ecoportal
             passboolean :single_select, :use_defaults
             passthrough :tag_tree_id, :button_text
 
+            def to_s(delimiter: "\n")
+              root.tags.to_s(delimiter: delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:multiple` to allow multiple selection

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/stages.rb

@@ -19,11 +19,11 @@ module Ecoportal
             end
           end
 
-          #def ordered
-          #  self.sort_by.with_index do |stage, index|
-          #    [stage.ordering, index]
-          #  end
-          #end
+          def ordered
+            self.sort_by.with_index do |stage, index|
+              [stage.ordering, index]
+            end
+          end
 
         end
       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.20"
+    GEM2_VERSION = "0.8.24"
   end
 end

metadata

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