ecoportal-api-oozes 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a177d3aabd94973437f3e4e15e16ee48d3a460031b73329d732ad30e9736a2b4
-  data.tar.gz: 5cce90e07b02cfbb416cf710c2d7d345424c754c019d5d3f50bb4315cc0abf9a
+  metadata.gz: d9c761acea6fa4c7a6cef0c0b56716906368032d14e891fbcad192487a3d46f4
+  data.tar.gz: b16661800fd19357336f645832fe0a053105febdc2e58a4556d66c2c084742a8
 SHA512:
-  metadata.gz: 88a46f8426347ccc3b771694eeb489f0591f8a9023dcc08860f83683ad369eb8e636bab3324389ec888e8e2aca990fdee2185bb3e1ad5d99f738bf40600246c9
-  data.tar.gz: a3e0a5e6079e24fbe3773b88b4fc455e1f8a9d6db142689871dafe70277b1df92f1736a68e43203cb78abe399e4cc5284a7ade46bccfa8a95058310b5d63573a
+  metadata.gz: 2931d29722ac006672127d5c675ae3522c84b118075f244ec96c3b0d1534d2170595bfbcc4e0f616de9162f46f085f2e02bce50426ba55e331f3380ef20961d7
+  data.tar.gz: 40ca60459ecc7cf9569d49a8c57a3866176b867f7dbd620941e2b975f48e9071c53cea0a6e28dab1f8fe245ca048e4108351bf16ca2b05494952c202581d36ac

data/CHANGELOG.md

@@ -1,6 +1,45 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.7.3] - 2020-10-xx
+
+### Added
+  - `Ecoportal::API::Common::Content::CollectionModel#delete!` finally scoped how delete should work :)
+  - `Ecoportal::API::V2.new` better feedback on key error.
+  - `Ecoportal::API::V2::Page::Component::SignatureField` added property `signed_by_name`
+  - `Ecoportal::API::V2::Page::Component#required` this field property is currently supported
+  - `Ecoportal::API::V2::Page::Component::DateField` more supported properties:
+    * `show_time`, `today_button`, `past_only`, `create_event`, `remind_me_in`, `renews`, `renews_every`, `renews_unit`, `renews_until`
+  - `Ecoportal::API::V2::Page::Component::ChecklistField`
+    * added more methods: `add_item`, `ordered_items`
+  - `Ecoportal::API::V2::Page::Component::GaugeField`
+    * more supported properties: `max`, `active_color` and `stops`
+      - for `stops` added class `Ecoportal::API::V2::Page::Component::GaugeStop`
+    * added more methods: `add_stop`, `ordered_stops`
+  - `Ecoportal::API::V2::Page::Component::ReferenceField` more supported properties:
+    * `register_id`, `hide_create`, `hide_attach`, `hide_metadata`, `hide_dashboards`, `display_fields`, `display_fields_in_lookup`
+  - `Ecoportal::API::V2::Page::Component::ActionField`
+    * more supported properties:`create_actions`, `required_number_of_completed_actions`, `permits_and_rules_integration`, `add_subscribed`, `add_subscribed_to_tasks`
+    * added more methods: `add_task`, `ordered_tasks`
+    - `Ecoportal::API::V2::Page::Component::Action` modified, provided that some properties are `read_only`
+  - `Ecoportal::API::V2::Page::Component::PeopleField` more supported properties:
+    * `is_me_button`, `attach_mode`, `person_schema_id`, `viewable_fields`, `singular`, `requires_number`, `cached_people`, `attached_people_permissions_enabled`, `apply_attached_people_permissions_to`, `attached_people_permissions_editable`, `attached_people_permissions_flags`
+  - `Ecoportal::API::V2::Page::Component::PlainTextField` more supported properties:
+    * `multiline`, `max_length`, `exact_index`
+  - `Ecoportal::API::V2::Page::Component::SelectionField` more supported properties:
+    * `flat`
+  - `Ecoportal::API::V2::Page::Component::TagField` more supported properties:
+    * `single_select`, `use_defaults`, `tag_tree_id`, `button_text`
+  - `Ecoportal::API::V2::Page::Section` more supported properties:
+    * `minimized`
+
+
+### Changed
+  - upgraded `ecoportal-api` dependency
+
+### Fixed
+  - `Ecoportal::API::Common::Content::CollectionModel#upsert!` was not actually moving the element to the new position when it already existed
+
 ## [0.7.2] - 2020-10-07
 
 ### Added

data/ecoportal-api-oozes.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.0",  "< 3.6"
   spec.add_development_dependency "pry"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.7.1', '< 0.8'
+  spec.add_dependency 'ecoportal-api', '>= 0.7.4', '< 0.8'
 end

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

@@ -134,6 +134,7 @@ module Ecoportal
             end
           end
 
+          # Get an element usign the `key`.
           def [](value)
             items_by_key[get_key(value)]
           end
@@ -161,6 +162,15 @@ module Ecoportal
             end
           end
 
+          def delete!(value)
+            unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel)
+              raise "'Content::DoubleModel' or 'Hash' doc required"
+            end
+            if item = self[value]
+              _doc_delete(item.doc)
+            end
+          end
+
           protected
 
           def order_matters?; self.class.order_matters; end
@@ -220,6 +230,13 @@ module Ecoportal
             super
           end
 
+          def _doc_delete(value)
+            if current_pos = _doc_key(value)
+              _doc_items.delete_at(current_pos)
+              on_change
+            end
+          end
+
           def _doc_upsert(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             current_pos = _doc_key(value)
             pos = case
@@ -228,7 +245,7 @@ module Ecoportal
               when used_param?(before)
                 _doc_key(before)
               when used_param?(after)
-                puts "to add after #{after.id}"
+                #puts "to add after #{after.id}"
                 if i = _doc_key(after)
                   i + 1
                 end
@@ -237,10 +254,10 @@ module Ecoportal
             pos ||= current_pos
 
             if current_pos && pos
-              _doc_items.delete(current_pos)
+              _doc_items.delete_at(current_pos)
               pos = (pos <= current_pos)? pos : pos - 1
             end
-            
+
             pos = (pos && pos < _doc_items.length)? pos : _doc_items.length
 
             pos.tap do |i|

data/lib/ecoportal/api/v2.rb

@@ -33,7 +33,7 @@ module Ecoportal
       # @param host [String] api server domain.
       # @param logger [Logger] an object with `Logger` interface to generate logs.
       def initialize(api_key = nil, user_key: nil, org_key: nil, host: "live.ecoportal.com", logger: default_logger)
-        v2key   = (user_key && org_key && self.class.v2key(user_key, org_key)) || api_key #|| ENV['X_ECOPORTAL_API_KEY']
+        v2key   = get_key(api_key: api_key, user_key: user_key, org_key: org_key)
         @logger = logger
         @client = Common::Content::Client.new(
           api_key: v2key,
@@ -55,6 +55,15 @@ module Ecoportal
         pages_class.new(client)
       end
 
+      private
+
+      def get_key(api_key: nil, user_key: nil, org_key: nil)
+        return self.class.v2key(user_key, org_key) if user_key && org_key
+        return api_key if api_key #|| ENV['X_ECOPORTAL_API_KEY']
+        raise "You need to provide either an api_key or user_key" unless user_key
+        raise "You need to provide an org_key as well (not just a user_key)" unless org_key
+      end
+
     end
   end
 end

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

@@ -53,7 +53,8 @@ module Ecoportal
                   people_field_class
                 when "checklist"
                   checklist_field_class
-                when "page_action"
+                when "page_action","checklist_task"
+                  #doc["type"] = "checklist_task"
                   action_field_class
                 when "file"
                   files_field_class
@@ -75,7 +76,7 @@ module Ecoportal
           passkey     :id
           passthrough :patch_ver, :undeletable
           passthrough :type, :label, :tooltip, :global_binding
-          passthrough :hidden, :accent, :deindex
+          passthrough :hidden, :accent, :deindex, :required
           passthrough :hide_view, :hidden_on_reports, :hidden_on_mobile
 
           def ref

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

@@ -4,11 +4,22 @@ module Ecoportal
       class Page
         class Component
           class Action < Common::Content::DoubleModel
+            class << self
+              def new_doc
+                {
+                  "id"     => new_uuid,
+                  "weight" => 9999
+                }
+              end
+            end
+            
             passkey     :id
             passthrough :patch_ver, :name
-            passthrough :weight, :complete, :overdue, :other_information
-            passdate    :due_date, :created_at #, :completed_at
-            passthrough :created_by, :assigned_person_member_id
+            passthrough :weight, :complete, :other_information
+            passdate    :due_date
+            pass_reader :overdue
+            passdate    :created_at, read_only: true #, :completed_at
+            pass_reader :created_by, :assigned_person_member_id
           end
         end
       end

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

@@ -4,8 +4,46 @@ module Ecoportal
       class Page
         class Component
           class ActionField < Page::Component
-            #class_resolver :action_class, "Ecoportal::API::V2::Page::Component::Action"
+            passthrough :create_actions
+            passthrough :required_number_of_completed_actions
+            passthrough :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
+
             embeds_multiple :actions, klass: "Ecoportal::API::V2::Page::Component::Action", order_key: :weight
+
+            # Adds a task with `name` short description
+            # @return [Ecoportal::API::V2::Page::Component::Action]
+            def add_task (name)
+              task_doc = Ecoportal::API::V2::Page::Component::Action.new_doc
+              actions.upsert!(task_doc) do |task|
+                task.name = name
+                if prev = previous_task(task)
+                  task.weight = prev.weight
+                end
+                yield(task) if block_given?
+                fix_task_weights!
+              end
+            end
+
+            def ordered_tasks
+              actions.each_with_index.sort_by do |task, index|
+                (task.weight >= 9999) ? [index, index] : [task.weight, index]
+              end.map(&:first)
+            end
+
+            private
+
+            def fix_task_weights!
+              ordered_tasks.each_with_index do |task, index|
+                task.weight = index
+              end
+            end
+
+            def previous_task(value)
+              tasks = ordered_tasks
+              pos  = tasks.index(value) - 1
+              return if pos < 0
+              tasks[pos]
+            end
           end
         end
       end

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
+
+            def add_item(label:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              itm_doc = Ecoportal::API::V2::Page::Component::ChecklistItem.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,9 @@ 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
           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_multiple :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 = Ecoportal::API::V2::Page::Component::GaugeStop.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,26 @@
+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
+          end
+        end
+      end
+    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,7 +4,8 @@ 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
@@ -33,7 +34,6 @@ 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
               options.upsert!(opt_doc, pos: pos, before: before, after: after) do |option|

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,7 +4,7 @@ module Ecoportal
       class Page
         class Component
           class SignatureField < Page::Component
-            passthrough :signed_by_id, :signature_url
+            passthrough :signed_by_id, :signed_by_name, :signature_url
             passdate    :signature_updated_at
           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/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/version.rb

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class V2
-      GEM_VERSION = "0.7.2"
+      GEM_VERSION = "0.7.3"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-oozes
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -140,7 +140,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -189,6 +189,7 @@ files:
 - lib/ecoportal/api/v2/page/component/file.rb
 - 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_field.rb
 - lib/ecoportal/api/v2/page/component/image.rb
 - lib/ecoportal/api/v2/page/component/images_field.rb