ecoportal-api-v2 0.8.6 → 0.8.10

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

@@ -60,6 +60,8 @@ module Ecoportal
               a == b
             end
 
+            # Compares `a` as charring changes of `b`
+            # @return [Hash] patch data object with only changes
             def patch_data(a, b = nil, delete: false)
               {}.tap do |data_hash|
                 if delete
@@ -75,41 +77,59 @@ module Ecoportal
                   data_hash[key] = patch_diff(a_value, b_value)
                   data_hash.delete(key) if data_hash[key] == NO_CHANGES
                 end
+                #if (data_hash.keys - ID_KEYS).empty?
                 if (data_hash.keys - META_KEYS).empty?
                   return NO_CHANGES
                 else
-                  patch_ver = (b && b["patch_ver"]) || 1
-                  data_hash["patch_ver"] = patch_ver
+                  #patch_ver = (b && b["patch_ver"]) || 1
+                  #data_hash["patch_ver"] = patch_ver
+                  if b && b.key?("patch_ver")
+                    data_hash["patch_ver"] = b["patch_ver"]
+                  elsif a && a.key?("patch_ver")
+                    data_hash["patch_ver"] = a["patch_ver"]
+                  end
                 end
               end
             end
 
             def patch_delete(b)
-              return NO_CHANGES unless b.is_a?(Hash) && id = get_id(b, exception: false)
-              {
-                "id"        => id,
-                "operation" => "deleted",
-                "data"      => patch_data(b, delete: true)
-              }
+              return NO_CHANGES unless b.is_a?(Hash)
+              if id = get_id(b, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "deleted",
+                  "data"      => patch_data(b, delete: true)
+                }
+              else
+                nil
+              end
             end
 
             def patch_new(a)
-              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
-              {
-                "id"        => id,
-                "operation" => "new",
-                "data"      => patch_data(a)
-              }
+              return NO_CHANGES unless a.is_a?(Hash)
+              if id = get_id(a, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "new",
+                  "data"      => patch_data(a)
+                }
+              else
+                a
+              end
             end
 
             def patch_update(a, b)
-              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
-              {
-                "id"        => id,
-                "operation" => "changed",
-                "data"      => patch_data(a, b)
-              }.tap do |update_hash|
-                return nil unless update_hash["data"] != NO_CHANGES
+              return NO_CHANGES unless a.is_a?(Hash)
+              if id = get_id(a, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "changed",
+                  "data"      => patch_data(a, b)
+                }.tap do |update_hash|
+                  return nil unless update_hash["data"] != NO_CHANGES
+                end
+              else
+                a
               end
             end
 
@@ -160,7 +180,9 @@ module Ecoportal
                 arr.any? {|a| nested_array?(a)}
               when arr.length == 1
                 arr = arr.first
-                arr.any? {|item| item.is_a?(Hash)}
+                arr.any? do |item|
+                  item.is_a?(Hash) && item.has_key?("patch_ver")
+                end
               else
                 false
               end

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

@@ -0,0 +1,36 @@
+module Ecoportal
+  module API
+    module Common
+      module Content
+        module ModelHelpers
+
+          private
+
+          # Offers multiple ways to compare two strings
+          def same_string?(value1, value2, exact: false)
+            case
+            when value1.is_a?(String) && value2.is_a?(String)
+              if exact
+                value1 == value2
+              else
+                value1.to_s.strip.downcase == value2.to_s.strip.downcase
+              end
+            when value1.is_a?(Regexp) && value2.is_a?(String)
+              value2 =~ value1
+            when value1.is_a?(String) && value2.is_a?(Regexp)
+              value1 =~ value2
+            else
+              value1 == value2
+            end
+          end
+
+          def hash_except(hash, *keys)
+            keys.each {|key| hash.delete(key)}
+            hash
+          end
+
+        end
+      end
+    end
+  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,6 +35,7 @@ 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
@@ -34,6 +45,8 @@ module Ecoportal
   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'
 require 'ecoportal/api/v2/page/section'

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

@@ -26,13 +26,16 @@ module Ecoportal
 
           class << self
             def new_doc(type: nil)
-              if type
-                type_doc = {"type" => type}
-                base_doc = get_class(type_doc)&.new_doc || {}
-                base_doc.merge!(type_doc)
+              {
+                "id"         => new_uuid
+              }.tap do |base_doc|
+                if type
+                  base_doc.merge!({"type" => type})
+                  if klass = get_class(base_doc)
+                    base_doc.merge!(klass.new_doc || {})
+                  end
+                end
               end
-              return base_doc if base_doc&.key?("id")
-              (base_doc || {}).merge("id" => new_uuid)
             end
 
             def get_class(doc)
@@ -59,7 +62,6 @@ module Ecoportal
                 when "checklist"
                   checklist_field_class
                 when "page_action","checklist_task"
-                  #doc["type"] = "checklist_task"
                   action_field_class
                 when "file"
                   files_field_class
@@ -83,10 +85,12 @@ module Ecoportal
           end
 
           passkey     :id
-          passthrough :patch_ver, :undeletable
+          passforced  :patch_ver, default: 1
+          passboolean :undeletable
           passthrough :type, :label, :tooltip, :global_binding
-          passthrough :hidden, :accent, :deindex, :required
-          passthrough :hide_view, :hidden_on_reports, :hidden_on_mobile
+          passboolean :hidden, :deindex, :required
+          passthrough :accent
+          passboolean :hide_view, :hidden_on_reports, :hidden_on_mobile
           passarray   :refs
 
           def ref_backend
@@ -107,6 +111,36 @@ module Ecoportal
             self.class.indexable_label(label)
           end
 
+          # Quick config helper
+          # @param conf [Symbol, Array<Symbol>]
+          #   - `:required`
+          #   - `:hide_view` to hide in view mode
+          #   - `:hide_mobile` to hide in mobile app
+          #   - `:hide_reports` to hide in reports
+          #   - `:global` to define a global binding
+          def configure(*conf)
+            conf.each_with_object([]) do |cnf, unused|
+              case cnf
+              when :required
+                self.required  = true
+              when :hide_view
+                self.hide_view = true
+              when :hide_mobile
+                self.hidden_on_mobile = true
+              when :hide_reports
+                self.hidden_on_reports = true
+              when Hash
+                if cnf.key?(:global)
+                  self.global_binding = cnf[:global]
+                end
+              else
+                unused.push(cnf)
+              end
+            end.tap do |unused|
+              raise "Unsupported configuration options '#{unused}' for #{self.class}" unless unused.empty?
+            end
+          end
+
         end
       end
     end

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

@@ -7,19 +7,28 @@ module Ecoportal
             class << self
               def new_doc
                 {
-                  "id"     => new_uuid,
-                  "weight" => 9999
+                  "id"         => new_uuid,
+                  "weight"     => 9999
                 }
               end
             end
-            
+
             passkey     :id
-            passthrough :patch_ver, :name
-            passthrough :weight, :complete, :other_information
-            passdate    :due_date
-            pass_reader :overdue
+            passforced  :patch_ver, default: 1
+            passthrough :name
+            passthrough :weight, :other_information
+            passboolean :complete
+
             passdate    :created_at, read_only: true #, :completed_at
-            pass_reader :created_by, :assigned_person_member_id
+            passthrough :created_by, read_only: true
+            passthrough :assigned_person_member_id, :assigned_person_member
+
+            passdate    :due_date, :reminder_date
+            passboolean :overdue, read_only: true
+
+            passthrough :duration_in_days, read_only: true
+            passarray   :file_container_ids
+
           end
         end
       end

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

@@ -4,9 +4,9 @@ module Ecoportal
       class Page
         class Component
           class ActionField < Page::Component
-            passthrough :create_actions
+            passboolean :create_actions
             passthrough :required_number_of_completed_actions
-            passthrough :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
+            passboolean :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
 
             embeds_many :actions, klass: "Ecoportal::API::V2::Page::Component::Action", order_key: :weight
 
@@ -30,8 +30,43 @@ module Ecoportal
               end.map(&:first)
             end
 
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:requires` required number of completed actions
+            #     - `:all`
+            #     - `#Number`
+            def configure(*conf)
+              self.create_actions = true
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when Hash
+                  supported = [:requires]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:requires) then configure_required(cnf[:requires]) end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
             private
 
+            def configure_required(req)
+              self.required = true
+              case req
+              when :all, NilClass
+                self.required_number_of_completed_actions = "all"
+              when Numeric
+                self.required_number_of_completed_actions = req
+              else
+                # Unsupported
+              end
+            end
+
             def fix_task_weights!
               ordered_tasks.each_with_index do |task, index|
                 task.weight = index

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

@@ -5,10 +5,14 @@ module Ecoportal
         class Component
           class ChartField < Page::Component
             passthrough :mode
-            passthrough :relative, :relstart, :relbound
-            passthrough :bounded, :ubound, :lbound
+            passboolean :relative, :bounded
+            passthrough :relstart, :relbound
+            passthrough :ubound, :lbound
+
             passthrough :filter_date_input
-            passthrough :user_id, :lock_chart_user
+
+            passthrough :user_id, :user_lookup
+            passboolean :lock_chart_user
 
             embeds_one :series_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::SeriesConfig"
             embeds_one :frequency_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Frequency"
@@ -16,13 +20,22 @@ module Ecoportal
             embeds_one :sankey_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Sankey"
             embeds_one :indicator_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Indicator"
             embeds_one :faceted_series_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Multiseries"
+            embeds_one :benchmark_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Benchmark"
 
             embeds_many :series, klass: "Ecoportal::API::V2::Page::Component::ChartField::Serie"
 
-            MODES = ["frequency", "series", "heatmap", "sankey", "indicator", "faceted_series"]
+            MODES = ["frequency", "series", "heatmap", "sankey", "indicator", "faceted_series", "benchmark"]
+
+            def mode=(value)
+              raise "Unsuported mode #{value}. Should be one of #{MODES}" unless MODES.include?(value)
+              config_doc(nil)
+              doc["mode"] = value
+              config_doc(config.class.new_doc)
+              self.mode
+            end
 
             def config
-              case mode
+              case self.mode
               when "frequency"
                 frequency_config
               when "series"
@@ -35,6 +48,29 @@ module Ecoportal
                 indicator_config
               when "faceted_series"
                 faceted_series_config
+              when "benchmark"
+                benchmark_config
+              end
+            end
+
+            private
+
+            def config_doc(value)
+              case self.mode
+              when "frequency"
+                doc["frequency_config"] = value
+              when "series"
+                doc["series_config"] = value
+              when "heatmap"
+                doc["heatmap_config"] = value
+              when "sankey"
+                doc["sankey_config"] = value
+              when "indicator"
+                doc["indicator_config"] = value
+              when "faceted_series"
+                doc["faceted_series_config"] = value
+              when "benchmark"
+                doc["benchmark_config"] = value
               end
             end
 
@@ -45,6 +81,7 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/v2/page/component/chart_field/config'
 require 'ecoportal/api/v2/page/component/chart_field/frequency'
 require 'ecoportal/api/v2/page/component/chart_field/series_config'
 require 'ecoportal/api/v2/page/component/chart_field/serie'
@@ -52,3 +89,4 @@ require 'ecoportal/api/v2/page/component/chart_field/heatmap'
 require 'ecoportal/api/v2/page/component/chart_field/sankey'
 require 'ecoportal/api/v2/page/component/chart_field/indicator'
 require 'ecoportal/api/v2/page/component/chart_field/multiseries'
+require 'ecoportal/api/v2/page/component/chart_field/benchmark'

data/lib/ecoportal/api/v2/page/component/chart_field/benchmark.rb

@@ -0,0 +1,30 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Benchmark < ChartField::Config
+              passthrough :register_id, :source_type
+
+              passthrough :benchmark_field, :benchmark_label
+
+              passboolean :across
+              passthrough :across_field
+
+              passboolean :grouped
+              passthrough :group_field
+
+              passthrough :against_field, :against_label
+
+              passthrough :calculation_mode
+              passthrough :min, :max
+
+              passthrough :filters
+            end
+          end
+        end
+      end
+    end
+  end
+end