ecoportal-api-v2 0.8.5 → 0.8.9

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

@@ -7,7 +7,7 @@ module Ecoportal
             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
+              itm_doc = items.items_class.new_doc
               items.upsert!(itm_doc, pos: pos, before: before, after: after) do |item|
                 item.label  = label
                 if prev = previous_item(item)

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

@@ -13,10 +13,11 @@ module Ecoportal
                 }
               end
             end
-            
+
             passkey     :id
             passthrough :patch_ver, :label
-            passthrough :weight, :checked
+            passthrough :weight
+            passboolean :checked
           end
         end
       end

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

@@ -4,10 +4,13 @@ module Ecoportal
       class Page
         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
+            passdate    :value
+            passboolean :show_time, :today_button, :past_only
+            passboolean :create_event
+            passthrough :remind_me_in
+            passboolean :renews
+            passthrough :renews_every, :renews_unit
+            passdate    :renews_until
 
             ISO8601 = "%Y-%m-%dT%H:%M:00Z" # "%Y-%m-%dT%H:%M:00.00Z"
 
@@ -26,6 +29,70 @@ module Ecoportal
               end
             end
 
+            def create_event=(value)
+              self.past_only = false
+              doc["create_event"] = !!value
+            end
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:time` to show time
+            #   - `:now_button` to display `NOW` button
+            #   - `:past` to only allow past dates
+            #   - `:event` to enable event
+            #   - `:reminder` to set the reminder (requires `:event`)
+            #     - `:never`
+            #     - `:one_day`
+            #     - `:three_days`
+            #     - `:one_week`
+            #     - `:two_weeks`
+            #     - `:one_month`
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :time
+                  self.show_time  = true
+                when :now_button
+                  self.today_button = true
+                when :past
+                  self.past_only = true
+                when :event
+                  self.create_event = true
+                when Hash
+                  supported = [:reminder]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:reminder) then configure_reminder(cnf[:reminder]) end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
+            private
+
+            def configure_reminder(value)
+              case value
+              when :never, NilClass
+                self.remind_me_in = "never"
+              when :one_day
+                self.remind_me_in = "1.day"
+              when :three_days
+                self.remind_me_in = "3.days"
+              when :one_week
+                self.remind_me_in = "1.week"
+              when :two_weeks
+                self.remind_me_in = "2.weeks"
+              when :one_month
+                self.remind_me_in = "1.month"
+              else
+                # Unsupported
+              end
+            end
+
           end
         end
       end

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

@@ -6,8 +6,9 @@ module Ecoportal
           class File < Common::Content::DoubleModel
             passkey     :id
             passthrough :patch_ver, :position
-            passthrough :content_type, :file_size, :file_container_id
-            passdate    :file_update_at
+            passthrough :file_size, :token, read_only: true
+            passthrough :content_type, :file_container_id
+            passdate    :file_update_at, read_only: true
           end
         end
       end

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

@@ -5,13 +5,13 @@ module Ecoportal
         class Component
           class GaugeField < Page::Component
             passthrough :value, :max
-            passthrough :active_color
+            passthrough :active_color, read_only: true
 
             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')
+            def add_stop(threshold: 0.0, color: '#e256d1')
               stop_doc = stops.items_class.new_doc
               stops.upsert!(stop_doc) do |stop|
                 stop.threshold = threshold

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class GeoCoordinates < Common::Content::DoubleModel
+            passthrough :lat, :lon
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,10 +4,13 @@ module Ecoportal
       class Page
         class Component
           class GeoField < Page::Component
-            passthrough :address, :coordinates
+            passthrough :address
+            embeds_one  :coordinates, klass: "Ecoportal::API::V2::Page::Component::GeoCoordinates"
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/geo_coordinates'

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

@@ -13,11 +13,67 @@ module Ecoportal
               end
             end
 
-            passthrough :layout, :strech, :no_popup, :hide_options
+            passthrough :layout
+            passboolean :strech, :no_popup, :hide_options
             embeds_many :images, klass: "Ecoportal::API::V2::Page::Image", order_key: :weight
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:strech` to make the image fit the full size of the image field
+            #   - `:popup` to set to enable disable poupup on `click`
+            #   - `:layout_button` to offer layout options to user
+            #   - `:layout` with the following available values
+            #     - `:three_crop` to specify _3 across_ by cutting the image to equalize size
+            #     - `:three` to specify _3 across_
+            #     - `:two` to specify _2 across_
+            #     - `:one` to specify _Full width (1 Across)_
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :strech
+                  self.strech = true
+                when :popup
+                  self.no_popup = false
+                when :layout_button
+                  self.hide_options = false
+                when Hash
+                  supported = [:layout_button, :layout]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+
+                  if cnf.key?(:layout_button) then self.hide_options = !cnf[:layout_button] end
+                  if cnf.key?(:layout) then configure_layour cnf[:layout] end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
+            private
+
+            def configure_layout(value)
+              case value
+              when :three
+                self.layout = "third"
+              when :two
+                self.layout = "half"
+              when :one
+                self.layout = "fill"
+              when :three_crop
+                self.layout = "third_crop"
+              else
+                # Unsupported
+              end
+            end
+
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/image'

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

@@ -4,17 +4,115 @@ module Ecoportal
       class Page
         class Component
           class PeopleField < Page::Component
-            passthrough :is_me_button, :attach_mode
+            passboolean :is_me_button
+            passthrough :attach_mode
             passthrough :person_schema_id
             pass_reader :viewable_fields
-            passthrough :singular, :requires_number
+
+            passboolean :singular
+            passthrough :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
+            passboolean :attached_people_permissions_enabled, :attached_people_permissions_editable
+            passthrough :apply_attached_people_permissions_to
+
+            embeds_one  :attached_people_permissions_flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
+
+            # Attaches people
+            def add(*ids)
+              people_ids << ids
+            end
+
+            # Deletes people
+            def delete(*ids)
+              people_ids.reject! {|id| ids.include?(id)}
+            end
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:snapshot` to set mode to `snapshot`
+            #   - `:live` to set mode to `live`
+            #   - `:me_button` to display `ME` button
+            #   - `:permits` to define the permissions
+            #     - `:all` for _entire page/all stages_
+            #     - `:stages` for _all stages containing this field_
+            #     - `:page` for _page only_
+            #     - `:stage` for _only the stage containing this field when attached_
+            #     - `:restructure`
+            #     - `:configure`
+            #     - `:can_permission`
+            #     - `:create_actions`
+            #     - `:admin_actions`
+            #     - `:subscribed`
+            #     - `:subscribed_to_tasks`
+            #   - `requires: number` to fine the number of required people to be attached
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :snapshot
+                  self.attach_mode  = "snapshot"
+                when :live
+                  self.attach_mode  = "live"
+                when :me_button
+                  self.is_me_button = true
+                when :singular
+                  self.singular = true
+                when Hash
+                  supported = [:singular, :permits, :requires]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  
+                  if cnf.key?(:singular) then self.singular = !!cnf[:singular] end
+                  if cnf.key?(:permits)
+                    if permits = cnf[:permits]
+                      self.attached_people_permissions_enabled = true
+                      configure_permits(*[permits].flatten.compact)
+                    else
+                      self.attached_people_permissions_enabled = false
+                    end
+                  end
+                  if cnf.key?(:requires)
+                    self.singular = false
+                    if requires = cnf[:requires]
+                      self.required        = true
+                      self.requires_number = requires
+                    else
+                      self.required        = false
+                      self.requires_number = nil
+                    end
+                  end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
+            private
+
+            def configure_permits(*conf)
+              conf.each_with_object([]) do |cnf, flags|
+                case cnf
+                when :all
+                  self.apply_attached_people_permissions_to = "page"
+                when :stages
+                  self.apply_attached_people_permissions_to = "all_stages"
+                when :page
+                  self.apply_attached_people_permissions_to = "page_only"
+                when :stage
+                  self.apply_attached_people_permissions_to = "current_stage"
+                when :can_edit
+                  self.attached_people_permissions_editable = true
+                else
+                  flags.push(cnf)
+                end
+              end.yield_self do |flags|
+                self.attached_people_permissions_flags.configure *flags
+              end
             end
 
           end

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

@@ -5,8 +5,40 @@ module Ecoportal
         class Component
           class PlainTextField < Page::Component
             passthrough :value
-            passthrough :multiline, :max_length
-            pass_reader :exact_index
+            passboolean :multiline
+            passthrough :max_length
+            passboolean :exact_index
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:multiline` multi line mode
+            #   - `:singleline` signle line mode
+            #   - `:exact_index` to make the `value` indexed as a **whole** (as opposite to its parts or n-grams)
+            #   - `:max_length` specify the maximum length of the `value`
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :multiline
+                  self.multiline = true
+                when :singleline
+                  self.multiline = false
+                when :exact_index
+                  self.exact_index = true
+                when Hash
+                  supported = [:multiline, :max_length]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:multiline)  then self.multiline = !!cnf[:multiline] end
+                  if cnf.key?(:max_length) then self.max_length = cnf[:max_length] end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
           end
         end
       end

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

@@ -5,9 +5,38 @@ module Ecoportal
         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
+            passboolean :hide_create, :hide_attach
+            passboolean :hide_metadata, :hide_dashboards
+            passboolean :display_fields, :display_fields_in_lookup
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:show_fields` specify if the public register fields should be shown (requires `register_id`)
+            #   - `:create` specify if the `NEW` button should appear
+            #   - `:attach` specify if the `ATTACH` button should appear
+            #   - `:metadata` specify if `metadata` should be shown (i.e. status)
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :show_fields
+                  self.display_fields = true
+                  self.display_fields_in_lookup = true
+                when Hash
+                  supported = [:create, :attach, :metadata]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:create)   then self.hide_create = !cnf[:create] end
+                  if cnf.key?(:attach)   then self.hide_attach = !cnf[:attach] end
+                  if cnf.key?(:metadata) then self.hide_metadata = !cnf[:metadata] end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
           end
         end
       end