ecoportal-api-v2 0.8.8 → 0.8.12

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

@@ -6,9 +6,9 @@ module Ecoportal
           class << self
             def new_doc(split: false)
               {
-                "id"     => new_uuid,
-                "type"   => split ? "split" : "content",
-                "weight" => 9999
+                "id"         => new_uuid,
+                "type"       => split ? "split" : "content",
+                "weight"     => 800
               }.tap do |out|
                 component_ids = if split
                     {
@@ -26,10 +26,11 @@ module Ecoportal
           end
 
           passkey     :id
-          passthrough :patch_ver, :weight, :type
+          passforced  :patch_ver, default: 1
+          passthrough :weight, :type
           passthrough :heading, :left_heading, :right_heading
           passarray   :component_ids, :left_component_ids, :right_component_ids
-          passthrough :minimized
+          passboolean :minimized
 
           def split?
             doc && doc["type"] == "split"
@@ -44,10 +45,70 @@ module Ecoportal
             all_component_ids.include?(id)
           end
 
-          def components
-            fld_ids = all_component_ids
-            root.components.values_at(*fld_ids).select.with_index do |fld, i|
-              puts "Warning: field #{id} points to missing field #{fld_ids[i]}" if !fld
+          def components(side: nil)
+            case side
+            when :right
+              components_right
+            when :left
+              components_left
+            when NilClass
+              components_by_id(*all_component_ids)
+            else
+              raise "Side should be one of [nil, :right, :left]. Given: #{side}"
+            end
+          end
+
+          def components_left
+            raise "You are trying to retrieve side components in a Split Section" unless split?
+            components_by_id(*left_component_ids)
+          end
+
+          def components_right
+            raise "You are trying to retrieve side components in a Split Section" unless split?
+            components_by_id(*right_component_ids)
+          end
+
+          # Adds `field` to the section
+          # @note
+          #   - To the specified `side`, when split section (default `:left`)
+          #   - To the end if `after` is not specified
+          #   - If `after` is specified, it searches field
+          #     - On the specific `side`, if specified (and split section)
+          #     - And adds the `field` after it, when found, or at the end if `after` is not found
+          # @param field [Ecoportal::API::V2::Page::Component] the field to be added.
+          def add_component(field, after: nil, side: nil)
+            raise "field should be a Ecoportal::API::V2::Page::Component. Given: #{field.class}" unless field.is_a?(Ecoportal::API::V2::Page::Component)
+            if field.section == self
+              raise "Field with id '#{field.id}' already belongs to this section"
+            elsif sec = field.section
+              # Field belongs to another section
+              raise "Field with id '#{field.id}' belongs to section '#{sec.heading || "Unnamed"}' (id: '#{sec.id}')"
+            end
+
+            if split?
+              ids_ary = side == :right ? right_component_ids : left_component_ids
+              fields  = components(side: side || :left)
+            else
+              ids_ary = component_ids
+              fields  = components
+            end
+            if after
+              after_fld = fields.find do |fld|
+                found   = nil
+                found ||= !!after if after.is_a?(Ecoportal::API::V2::Page::Component)
+                found ||= fld.id == after
+                found ||= same_string?(fld.label, after)
+              end
+            end
+            ids_ary.insert_one(field.id, after: after_fld&.id)
+            self
+          end
+
+          private
+
+          def components_by_id(*ids)
+            root.components.values_at(*ids).select.with_index do |fld, i|
+              puts "Warning: field id #{ids[i]} points to missing field" if !fld
               fld && (!block_given? || yield(fld))
             end
           end

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

@@ -7,26 +7,84 @@ module Ecoportal
 
           self.klass = :section_class
 
+          # Creates a new `section`
           def add(name: nil, split: false, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             sec_doc = section_class.new_doc(split: split)
-            upsert!(sec_doc, pos: pos, before: before, after: after) do |section|
+            upsert!(sec_doc) do |section| #, pos: pos, before: before, after: after) do |section|
               section.heading  = name
-              if prev = previous_section(section)
-                section.weight = prev.weight
+              if weight = scope_weight(pos: pos, before: before, after: after)
+                section.weight = weight
               end
+              fix_weights!
               yield(section) if block_given?
-              #fix_weights! # a server bug prevents to set the weight of existing sections
             end
           end
 
+          def get_by_type(type)
+            ordered.select do |sec|
+              sec.type == type
+            end
+          end
+
+          def get_by_heading(heading)
+            ordered.select do |sec|
+              value = heading == :unnamed ? nil : heading
+              same_string?(sec.heading, value)
+            end
+          end
+
+          # Gets all the sections between `sec1` and `sec2`
+          def between(sec1, sec2, included: false)
+            sorted_secs = ordered
+            pos1 = (sec1 = to_section(sec1)) && sorted_secs.index(sec1)
+            pos2 = (sec2 = to_section(sec2)) && sorted_secs.index(sec2)
+            if included
+              pos1 = pos1 ? pos1 : 0
+              pos2 = pos2 ? pos2 : -1
+            else
+              pos1 = pos1 ? (pos1 + 1) : 0
+              pos2 = pos2 ? (pos2 - 1) : -1
+            end
+            sorted_secs[pos1..pos2]
+          end
+
+          # Gets the sections ordered by `weight` (as they appear in the page)
           def ordered
-            each_with_index.sort_by do |section, index|
+            self.sort_by.with_index do |section, index|
               (section.weight >= 9999) ? [index, index] : [section.weight, index]
-            end.map(&:first)
+            end
           end
 
           private
 
+          def scope_weight(pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+            case
+            when used_param?(pos)
+              if pos    = to_section(pos)
+                pos.weight - 1
+              end
+            when used_param?(before)
+              if before = to_section(before)
+                before.weight - 1
+              end
+            when used_param?(after)
+              if after  = to_section(after)
+                after.weight
+              end
+            end
+          end
+
+          def to_section(value)
+            case value
+            when Ecoportal::API::V2::Page::Section
+              value
+            when Numeric
+              ordered[value]
+            else
+              get_by_heading(value).first
+            end
+          end
+
           def fix_weights!
             ordered.each_with_index do |section, index|
               section.weight = index

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

@@ -4,14 +4,17 @@ module Ecoportal
       class Page
         class Stage < Common::Content::DoubleModel
           passkey     :id
-          passthrough :patch_ver
-          passthrough :namem, :ordering
+          passforced  :patch_ver, default: 1
+          passthrough :name, :ordering
           passarray   :subtags, order_matters: false
           passarray   :section_ids
-          passthrough :complete, :status, :lock_after_completion
+          passthrough :status
+          passboolean :complete, :lock_after_completion
+
           embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
-          passthrough :disable_direct_permissions
-          passthrough :creator_enabled, :creator_editable, :creator_flags
+          passboolean :disable_direct_permissions
+          passboolean :creator_enabled, :creator_editable
+          embeds_one  :creator_flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
           passthrough :can
 
           def sections
@@ -22,8 +25,9 @@ module Ecoportal
             end.sort_by {|sec| sec.weight}
           end
 
-          def attach_section(section)
-            section_ids.insert_one(section.id)
+          def add_section(*secs)
+            secs.each {|sec| section_ids.insert_one(sec.id)}
+            self
           end
 
         end

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

@@ -8,8 +8,8 @@ module Ecoportal
           self.klass = :stage_class
 
           def get_by_name(name)
-            find do |stage|
-              stage.name.strip.downcase == name.to_s.strip.downcase
+            self.find do |stage|
+              same_string?(stage.name, name)
             end
           end
 

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

@@ -2,9 +2,19 @@ module Ecoportal
   module API
     class V2
       class Page < Common::Content::DoubleModel
-        ALLOWED_KEYS  = %w[id patch_ver name template_id base_tags tags time_zone created_at updated_at can components sections stages]
+        ALLOWED_KEYS  = [
+          "id", "patch_ver", "name", "template_id",
+          "base_tags", "tags",
+          "time_zone", "created_at", "updated_at",
+          "components", "sections", "stages",
+          "permits", "mould_counter", "mould",
+          "state", "task_priority",
+          "votes_enabled", "upvotes", "downvotes",
+          "force_errors", "subtags"
+        ]
+
         passkey     :id
-        passthrough :patch_ver
+        passforced  :patch_ver, default: 1
         passthrough :name, :template_id
         passarray   :base_tags, :tags, order_matters: false
         passthrough :time_zone
@@ -25,15 +35,21 @@ module Ecoportal
               hash["data"].select! do |key, value|
                 ALLOWED_KEYS.include?(key)
               end
+              return nil if (hash["data"].keys - ["patch_ver"]).empty?
             end
           end
         end
 
+        def stages?
+          self.stages.count > 0
+        end
+
       end
     end
   end
 end
 
+require 'ecoportal/api/v2/page/permission_flags'
 require 'ecoportal/api/v2/page/permit'
 require 'ecoportal/api/v2/page/component'
 require 'ecoportal/api/v2/page/components'

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

@@ -9,7 +9,19 @@ module Ecoportal
 
           embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
           passarray   :force_errors, :subtags, order_matters: false
-          #passthrough :evolution
+
+          # `id` of the stage we got the data of.
+          def current_stage_id
+            doc.dig("active_stage", "id") || doc["current_stage_id"]
+          end
+
+          # @return [Ecoportal::API::V2::Page::Stage]
+          def current_stage
+            if stage_id = current_stage_id
+              stages[stage_id]
+            end
+          end
+
         end
       end
     end

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

@@ -47,10 +47,13 @@ module Ecoportal
         end
 
         # 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.
         def update(doc)
           body = get_body(doc) # , level: "page"
+          # Launch only if there are changes
+          raise "Missing page object" unless body && body["page"]
           id   = get_id(doc)
           client.patch("/pages/#{CGI.escape(id)}", data: body)
         end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class SearchResults < Common::Content::DoubleModel
+          passthrough :total, :total_before_filtering
+          passarray   :tags, order_matters: false
+          embeds_many :results, klass: "Ecoportal::API::V2::Registers::PageResult"
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,7 @@ module Ecoportal
 
         class_resolver :register_class,  "Ecoportal::API::V2::Registers::Register"
         class_resolver :register_search_result_class, "Ecoportal::API::V2::Registers::PageResult"
+        class_resolver :register_search_results, "Ecoportal::API::V2::Registers::SearchResults"
 
         attr_reader :client
 
@@ -35,7 +36,12 @@ module Ecoportal
         # @param options [Hash] the search options
         # @option options [Hash<Symbol, String>] :query plain search (like the search box in register).
         # @option options [Hash<Symbol, Array<Object>>] :filters the set of filters.
+        # @option options [Boolean] if `true`, it only performs the first search and results `Ecoportal::API::V2::Registers::SearchResults`.
+        # @yield [result]  something to do with search page-result.
+        # @yieldparam result [Ecoportal::V2::Registers::PageResult] a page result.
+        # @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)
@@ -49,6 +55,12 @@ module Ecoportal
             end
           end
 
+          if only_first
+            response = client.get("/registers/#{register_id}/search", params: options)
+            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+            return register_search_results.new(response.body["data"])
+          end
+
           cursor_id = nil
           results = 0
           loop do
@@ -70,8 +82,8 @@ module Ecoportal
               yield object
             end
 
-            # break unless (cursor_id = data["cursor_id"])
-            break if total == results
+            break if total <= results
+            break unless (cursor_id = data["cursor_id"])
           end
           self
         end
@@ -87,3 +99,4 @@ require 'ecoportal/api/v2/registers/register'
 require 'ecoportal/api/v2/registers/stage_result'
 require 'ecoportal/api/v2/registers/stages_result'
 require 'ecoportal/api/v2/registers/page_result'
+require 'ecoportal/api/v2/registers/search_results'

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.8"
+    GEM2_VERSION = "0.8.12"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.8.12
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,6 +176,7 @@ files:
 - lib/ecoportal/api/common/content/doc_helpers.rb
 - lib/ecoportal/api/common/content/double_model.rb
 - lib/ecoportal/api/common/content/hash_diff_patch.rb
+- lib/ecoportal/api/common/content/model_helpers.rb
 - lib/ecoportal/api/common/content/string_digest.rb
 - lib/ecoportal/api/common/content/wrapped_response.rb
 - lib/ecoportal/api/v2.rb
@@ -185,6 +186,7 @@ files:
 - lib/ecoportal/api/v2/page/component/action_field.rb
 - lib/ecoportal/api/v2/page/component/chart_field.rb
 - lib/ecoportal/api/v2/page/component/chart_field/benchmark.rb
+- lib/ecoportal/api/v2/page/component/chart_field/config.rb
 - lib/ecoportal/api/v2/page/component/chart_field/frequency.rb
 - lib/ecoportal/api/v2/page/component/chart_field/heatmap.rb
 - lib/ecoportal/api/v2/page/component/chart_field/indicator.rb
@@ -200,12 +202,14 @@ files:
 - lib/ecoportal/api/v2/page/component/files_field.rb
 - lib/ecoportal/api/v2/page/component/gauge_field.rb
 - lib/ecoportal/api/v2/page/component/gauge_stop.rb
+- lib/ecoportal/api/v2/page/component/geo_coordinates.rb
 - lib/ecoportal/api/v2/page/component/geo_field.rb
 - lib/ecoportal/api/v2/page/component/image.rb
 - lib/ecoportal/api/v2/page/component/images_field.rb
 - lib/ecoportal/api/v2/page/component/law_field.rb
 - lib/ecoportal/api/v2/page/component/number_field.rb
 - lib/ecoportal/api/v2/page/component/people_field.rb
+- lib/ecoportal/api/v2/page/component/people_viewable_field.rb
 - lib/ecoportal/api/v2/page/component/plain_text_field.rb
 - lib/ecoportal/api/v2/page/component/reference_field.rb
 - lib/ecoportal/api/v2/page/component/rich_text_field.rb
@@ -214,6 +218,7 @@ files:
 - lib/ecoportal/api/v2/page/component/signature_field.rb
 - lib/ecoportal/api/v2/page/component/tag_field.rb
 - lib/ecoportal/api/v2/page/components.rb
+- lib/ecoportal/api/v2/page/permission_flags.rb
 - lib/ecoportal/api/v2/page/permit.rb
 - lib/ecoportal/api/v2/page/section.rb
 - lib/ecoportal/api/v2/page/sections.rb
@@ -226,6 +231,7 @@ files:
 - lib/ecoportal/api/v2/registers.rb
 - lib/ecoportal/api/v2/registers/page_result.rb
 - lib/ecoportal/api/v2/registers/register.rb
+- lib/ecoportal/api/v2/registers/search_results.rb
 - lib/ecoportal/api/v2/registers/stage_result.rb
 - lib/ecoportal/api/v2/registers/stages_result.rb
 - lib/ecoportal/api/v2/registers/template.rb