ecoportal-api-oozes 0.7.0 → 0.7.5

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

@@ -4,8 +4,41 @@ module Ecoportal
       class Page
         class Component
           class ChecklistField < Page::Component
-            #class_resolver :checklist_item_class, "Ecoportal::API::V2::Page::Component::ChecklistItem"
-            embeds_multiple :items, klass: "Ecoportal::API::V2::Page::Component::ChecklistItem", order_key: :weight
+            embeds_many :items, klass: "Ecoportal::API::V2::Page::Component::ChecklistItem", order_key: :weight
+
+            def add_item(label:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              itm_doc = items.stops.items_class.new_doc
+              items.upsert!(itm_doc, pos: pos, before: before, after: after) do |item|
+                item.label  = label
+                if prev = previous_item(item)
+                  item.weight = prev.weight
+                end
+                yield(item) if block_given?
+                fix_item_weights!
+              end
+            end
+
+            def ordered_items
+              items.each_with_index.sort_by do |item, index|
+                (item.weight >= 9999) ? [index, index] : [item.weight, index]
+              end.map(&:first)
+            end
+
+            private
+
+            def fix_item_weights!
+              ordered_items.each_with_index do |item, index|
+                item.weight = index
+              end
+            end
+
+            def previous_item(value)
+              itms = ordered_items
+              pos  = itms.index(value) - 1
+              return if pos < 0
+              itms[pos]
+            end
+
           end
         end
       end

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

@@ -4,6 +4,16 @@ module Ecoportal
       class Page
         class Component
           class ChecklistItem < Common::Content::DoubleModel
+
+            class << self
+              def new_doc
+                {
+                  "id"     => new_uuid,
+                  "weight" => 9999
+                }
+              end
+            end
+            
             passkey     :id
             passthrough :patch_ver, :label
             passthrough :weight, :checked

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

@@ -5,6 +5,27 @@ module Ecoportal
         class Component
           class DateField < Page::Component
             passthrough :value
+            passthrough :show_time, :today_button, :past_only
+            passthrough :create_event, :remind_me_in
+            passthrough :renews, :renews_every, :renews_unit, :renews_until
+
+            ISO8601 = "%Y-%m-%dT%H:%M:00Z" # "%Y-%m-%dT%H:%M:00.00Z"
+
+            def value=(val)
+              doc["value"] = self.class.to_time(val).yield_self do |datetime|
+                datetime = datetime.utc.strftime(ISO8601) if datetime
+                datetime
+              end
+            end
+
+            def value
+              if val = doc["value"]
+                (Time.parse(val) rescue nil).yield_self do |datetime|
+                  datetime.localtime if datetime
+                end
+              end
+            end
+
           end
         end
       end

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

@@ -4,8 +4,7 @@ module Ecoportal
       class Page
         class Component
           class FilesField < Page::Component
-            #class_resolver :file_class, "Ecoportal::API::V2::Page::File"
-            embeds_multiple :items, klass: "Ecoportal::API::V2::Page::File", order_key: :position
+            embeds_many :items, klass: "Ecoportal::API::V2::Page::File", order_key: :position
           end
         end
       end

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

@@ -4,10 +4,33 @@ module Ecoportal
       class Page
         class Component
           class GaugeField < Page::Component
-            passthrough :value
+            passthrough :value, :max
+            passthrough :active_color
+
+            embeds_many :stops, klass: "Ecoportal::API::V2::Page::Component::GaugeStop", order_key: :threshold
+
+            # Adds a stop at `threshold` with `color`
+            # @return [Ecoportal::API::V2::Page::Component::GaugeStop]
+            def add_stop (threshold: 0.0, color: '#e256d1')
+              stop_doc = stops.items_class.new_doc
+              stops.upsert!(stop_doc) do |stop|
+                stop.threshold = threshold
+                stop.color     = color
+                yield(stop) if block_given?
+              end
+            end
+
+            def ordered_stops
+              stops.each_with_index.sort_by do |stop, index|
+                (stop.threshold >= 9999) ? [index, index] : [stop.threshold, index]
+              end.map(&:first)
+            end
+
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/gauge_stop'

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

@@ -0,0 +1,88 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class GaugeStop < Common::Content::DoubleModel
+
+            class << self
+              def new_doc
+                {
+                  "id"        => new_uuid,
+                  "threshold" => nil,
+                  "color"     => nil
+                }
+              end
+            end
+
+            passkey     :id
+            passthrough :patch_ver, :threshold
+            passthrough :color
+
+            # Assign the color to the stop.
+            # @note These are the available colors:
+            #   - :blue, :blue_greyed, :blue_light
+            #   - :turquoise, :jade, :green, :pistachio, :avocado
+            #   - :yellow, :orange, :pumpkin, :red, :magenta, :fuchsia, :purple, :violet
+            # @param value [String, Symbol] you can use a `symbol` to specify a color
+            def color=(value)
+              value  = to_color(value) if value.is_a?(Symbol)
+              doc["color"] = value
+            end
+
+            # @return [Symbol] to get the `color` sym code
+            def color_sym
+              color_maps.each do |k, v|
+                return k if color == v
+              end
+              :undefined
+            end
+
+            private
+
+            def to_color(value)
+              return nil unless valid_color?(value)
+              return value if value.is_a?(String)
+              color_maps[value]
+            end
+
+            def valid_color?(value)
+              return true if value.is_a?(String) && colors.any? {|c| c == value}
+              return true if value.is_a?(Symbol) && color_syms.any? {|s| s == value}
+            end
+
+            def color_syms
+              @color_syms ||= color_maps.keys
+            end
+
+            def colors
+              @colors ||= color_maps.values
+            end
+
+            def color_maps
+              @color_maps ||= [
+                [:blue, "#5656e2"],
+                [:blue_greyed, "#568be2"],
+                [:blue_light, "#56c0e2"],
+                [:turquoise, "#56e2cf"],
+                [:jade, "#56e29b"],
+                [:green, "#56e267"],
+                [:pistachio, "#79e256"],
+                [:avocado, "#aee256"],
+                [:yellow, "#e2e156"],
+                [:orange, "#e2ad56"],
+                [:pumpkin, "#e27956"],
+                [:red, "#e25667"],
+                [:magenta, "#e2569c"],
+                [:fuchsia, "#e256d1"],
+                [:purple, "#be56e2"],
+                [:violet, "#8a56e2"]
+              ].to_h
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,17 @@ module Ecoportal
       class Page
         class Component
           class ImagesField < Page::Component
-            #class_resolver :image_class, "Ecoportal::API::V2::Page::Image"
-            embeds_multiple :images, klass: "Ecoportal::API::V2::Page::Image", order_key: :weight
+
+            class << self
+              def new_doc
+                {
+                  "layout" => "third"
+                }
+              end
+            end
+
+            passthrough :layout, :strech, :no_popup, :hide_options
+            embeds_many :images, klass: "Ecoportal::API::V2::Page::Image", order_key: :weight
           end
         end
       end

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

@@ -4,7 +4,14 @@ module Ecoportal
       class Page
         class Component
           class PeopleField < Page::Component
-            passarray :people_ids
+            passthrough :is_me_button, :attach_mode
+            passthrough :person_schema_id
+            pass_reader :viewable_fields
+            passthrough :singular, :requires_number
+            passarray   :people_ids
+            pass_reader :cached_people
+            passthrough :attached_people_permissions_enabled, :apply_attached_people_permissions_to
+            passthrough :attached_people_permissions_editable, :attached_people_permissions_flags
 
             def add(id)
               people_ids << id

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

@@ -5,6 +5,8 @@ module Ecoportal
         class Component
           class PlainTextField < Page::Component
             passthrough :value
+            passthrough :multiline, :max_length
+            pass_reader :exact_index
           end
         end
       end

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

@@ -4,6 +4,10 @@ module Ecoportal
       class Page
         class Component
           class ReferenceField < Page::Component
+            passthrough :register_id
+            passthrough :hide_create, :hide_attach
+            passthrough :hide_metadata, :hide_dashboards
+            passthrough :display_fields, :display_fields_in_lookup
           end
         end
       end

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

@@ -4,10 +4,10 @@ module Ecoportal
       class Page
         class Component
           class SelectionField < Page::Component
-            passthrough :multiple, :other, :other_desc
+            passthrough :multiple, :flat
+            passthrough :other, :other_desc
 
-            #class_resolver :selection_option_class, "Ecoportal::API::V2::Page::Component::SelectionOption"
-            embeds_multiple :options, klass: "Ecoportal::API::V2::Page::Component::SelectionOption", order_key: :weight
+            embeds_many :options, klass: "Ecoportal::API::V2::Page::Component::SelectionOption", order_key: :weight
 
             def select(value)
               opt = options.find {|opt| opt.value == value}
@@ -33,9 +33,8 @@ module Ecoportal
               end
             end
 
-            # a server bug prevents to add new options to an existing field
             def add_option(name:, value:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-              opt_doc = Ecoportal::API::V2::Page::Component::SelectionOption.new_doc
+              opt_doc = options.items_class.new_doc              
               options.upsert!(opt_doc, pos: pos, before: before, after: after) do |option|
                 option.name  = name
                 option.value = value

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

@@ -4,6 +4,7 @@ module Ecoportal
       class Page
         class Component
           class SelectionOption < Common::Content::DoubleModel
+            
             class << self
               def new_doc
                 {

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

@@ -4,8 +4,19 @@ module Ecoportal
       class Page
         class Component
           class SignatureField < Page::Component
-            passthrough :signed_by_id, :signature_url
+
+            class << self
+              def new_doc
+                {
+                  "color" => "#000000"
+                }
+              end
+            end
+
+            passthrough :signed_by_id, :signed_by_name, :signature_url
             passdate    :signature_updated_at
+            passthrough :signature_content, :color
+
           end
         end
       end

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

@@ -4,6 +4,8 @@ module Ecoportal
       class Page
         class Component
           class TagField < Page::Component
+            passthrough :single_select, :use_defaults
+            passthrough :tag_tree_id, :button_text
           end
         end
       end

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

@@ -21,14 +21,14 @@ module Ecoportal
 
           def get_by_name(name, type: nil)
             pool = type ? get_by_type(type) : self
-            
+
             pool.select do |comp|
               comp.label.to_s.strip.downcase == name.to_s.strip.downcase
             end.first
           end
 
           def add(label:, type:)
-            fld_doc = Ecoportal::API::V2::Page::Component.new_doc(type: type)
+            fld_doc = component_class.new_doc(type: type)
             upsert!(fld_doc) do |fld|
               fld.label  = label
               yield(fld) if block_given?

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

@@ -29,6 +29,7 @@ module Ecoportal
           passthrough :patch_ver, :weight, :type
           passthrough :heading, :left_heading, :right_heading
           passarray   :component_ids, :left_component_ids, :right_component_ids
+          passthrough :minimized
 
           def split?
             doc && doc["type"] == "split"

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

@@ -8,7 +8,7 @@ module Ecoportal
           self.klass = :section_class
 
           def add(name: nil, split: false, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-            sec_doc = Ecoportal::API::V2::Page::Section.new_doc(split: split)
+            sec_doc = section_class.new_doc(split: split)
             upsert!(sec_doc, pos: pos, before: before, after: after) do |section|
               section.heading  = name
               if prev = previous_section(section)

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

@@ -13,6 +13,12 @@ module Ecoportal
             end
           end
 
+          def ordered_stages
+            stages.each_with_index.sort_by do |stage, index|
+              (stage.ordering >= 9999) ? [index, index] : [stage.ordering, index]
+            end.map(&:first)
+          end
+
         end
       end
     end

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

@@ -28,22 +28,33 @@ module Ecoportal
         # @note
         #   - if the request has `success?` the returned `object.result` gives an object with that `Page`.
         #   - if it failed to obtain the full page, it returns a `PageStage` with the active stage data.
-        # @param doc [String, Hash, Page] data containing an `id` of the target page.
+        # @param id [String, Hash, Stage] the `id` of the target **page**.
+        # @param stage_id [String] the `id` of the target **stage**.
         # @return [Ecoportal::API::V2::Page, Ecoportal::API::V2::Pages::PageStage] the target page.
-        def get(doc)
-          pid      = get_id(doc)
-          response = client.get("/pages/#{CGI.escape(pid)}")
+        def get(id, stage_id: nil)
+          return stages.get(pid: id, sid: stage_id) if stage_id
+          id       = get_id(id)
+          response = client.get("/pages/#{CGI.escape(id)}")
           wrapped  = Common::Content::WrappedResponse.new(response, page_class)
 
           return wrapped.result if wrapped.success?
           if (response.status == 302) && (url = response.body["data"])
-            if sid = url_to_stage_id(url)
-              return stages.get(pid: pid, sid: sid)
+            if stage_id = url_to_stage_id(url)
+              return stages.get(pid: id, sid: stage_id)
             end
           end
           raise "Could not get page #{pid} - Error #{response.status}: #{response.body}"
         end
 
+        # Requests to update an existing page via api.
+        # @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"
+          id   = get_id(doc)
+          client.patch("/pages/#{CGI.escape(id)}", data: body)
+        end
+
         # Gets a `new` non-existing page via api with all the ids initialized.
         # @param from [String, Hash, Page] template or `id` of the template
         # @return [Ecoportal::API::V2::Page] the new page object.
@@ -66,15 +77,6 @@ module Ecoportal
           client.post("/pages", data: body, params: {template_id: id})
         end
 
-        # Requests to update an existing page via api.
-        # @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"
-          id   = get_id(doc)
-          client.patch("/pages/#{CGI.escape(id)}", data: body)
-        end
-
         private
 
         def url_to_stage_id(url)