ecoportal-api-v2 0.8.5 → 0.8.9

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

@@ -34,6 +34,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

@@ -59,7 +59,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
@@ -85,8 +84,9 @@ module Ecoportal
           passkey     :id
           passthrough :patch_ver, :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 +107,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

@@ -12,14 +12,22 @@ module Ecoportal
                 }
               end
             end
-            
+
             passkey     :id
             passthrough :patch_ver, :name
-            passthrough :weight, :complete, :other_information
-            passdate    :due_date
-            pass_reader :overdue
+            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

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

@@ -0,0 +1,23 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Config < Common::Content::DoubleModel
+
+              class << self
+                def new_doc
+                  {"id" => new_uuid}
+                end
+              end
+              
+              passkey     :id
+              passthrough :patch_ver
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,9 +4,7 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Frequency < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Frequency < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :mode, :input
@@ -14,7 +12,8 @@ module Ecoportal
               passthrough :secondary
 
               passthrough :output, :bar_mode
-              passthrough :series_size, :skip_zeroes
+              passthrough :series_size
+              passboolean :skip_zeroes
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false
 

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

@@ -4,9 +4,7 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Heatmap < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Heatmap < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :xinput, :xmode

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

@@ -4,15 +4,14 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Indicator < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Indicator < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :date_input, :secondary
-              passthrough :duration, :math_mode, :currency
+              passthrough :duration, :math_mode
 
-              passthrough :display_previous, :change_format, :invert_colors
+              passboolean :currency, :display_previous, :invert_colors
+              passthrough :change_format
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false
 

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

@@ -4,17 +4,15 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Multiseries < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Multiseries < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :xinput, :xlabel
               passthrough :interval, :calc_mode
 
               passthrough :yinput, :ylabel
-              passthrough :facet_by_discrete, :discrete_facet
-              passthrough :facet_by_tags
+              passboolean :facet_by_discrete, :facet_by_tags
+              passthrough :discrete_facet
               passarray   :facet_tags
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false

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

@@ -4,9 +4,7 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Sankey < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Sankey < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :xinput, :xmode

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

@@ -4,15 +4,14 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Serie < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Serie < ChartField::Config
               passthrough :register_id
 
               passthrough :input, :type
               passarray   :y_axes
 
-              passthrough :visual, :stacked
+              passthrough :visual
+              passboolean :stacked
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false
 

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

@@ -4,16 +4,14 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class SeriesConfig < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
-
+            class SeriesConfig < ChartField::Config
               passthrough :xlabel, :xtype
-              passthrough :interval, :calc_mode, :comparative_year
               passthrough :ylabel
+              passthrough :interval, :calc_mode
+              passboolean :comparative_year
 
-              passthrough :filled_up_with_zeros, :zero_y, :bounds_rigid
-              passthrough :stack_all
+              passboolean :filled_up_with_zeros, :zero_y, :bounds_rigid
+              passboolean :stack_all
             end
           end
         end

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

@@ -7,16 +7,18 @@ module Ecoportal
             passthrough :register_id, :date_input
             passthrough :filter
 
-            passthrough :facet_by_tags, :facet_by_select
-            passthrough :select_input, :select_mapping
+            passboolean :facet_by_tag, :facet_by_select
             passarray   :facet_tags
+            passthrough :select_input, :select_mapping
 
-            passthrough :relative, :relstart, :relbound
-            passthrough :bounded, :ubound, :lbound
+            passboolean :relative, :bounded
+            passthrough :relstart, :relbound
+            passthrough :ubound, :lbound
 
             passthrough :display_mode, :display_type
             passarray   :guidelines
-            passthrough :cumulative, :cumulative_mode, :cumulative_start
+            passboolean :cumulative
+            passthrough :cumulative_mode, :cumulative_start
             passthrough :multiplier, :granularity
 
             passthrough :color