ecoportal-api-oozes 0.6.1 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 169653f85a26c45f2b60eb95358dd7e547185b07a5a722bb56643a63daa1fb1f
-  data.tar.gz: 696de7a2f37b8fcf7409be373bfb491b4fa70bfc504cace816a4b64076cb9bd7
+  metadata.gz: 6039e6c6b1c32fcbcd956ef9a425588cbd9dfe94d06898223af14f433bab2c3a
+  data.tar.gz: c4dca6d50e4a664d343942636079f7c3cfe11999502ca891e8cf1f8598ed79f3
 SHA512:
-  metadata.gz: 6b134337977269a67e49d451bad2a854da602724326483e72cfa3c95cbb012d6f8fbbd88742d9f58fba019869c7c11ae5e14f74e2ae8756daaa8035ab9658d09
-  data.tar.gz: 342dbf60de74361387b383428a8b066184c9b0ce73dba98f3761da5c83b5efd8393da8cc7e836b58bf47aacac660493d316b93be0a88a3876c7d7195ab7afb49
+  metadata.gz: 91f9c47478b1054e0efb2380bb623c951d751f10c24a833b7fd380ddaa35bdc825b42b5574f23524accfc0e10ba692857c0597be9805cde1acede6d5959b0730
+  data.tar.gz: 2106b17efa000c7d1b44ce667bf3d80fe84a4c59bb7c0772cc8d19396e5fa024e39fc7823064e9531ac9c82037be3bfdc17e8827ae41ae1bdb7b648c15d52abe

data/CHANGELOG.md

@@ -1,6 +1,92 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.7.4] - 2021-02-12
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::GaugeStop#color=` enabled setting colours using a `symbol`
+    - `:blue`, `:blue_greyed`, `:blue_light`
+    - `:turquoise`, `:jade`, `:green`, `:pistachio`, `:avocado`
+    - `:yellow`, `:orange`, `:pumpkin`, `:red`, `:magenta`, `:fuchsia`, `:purple`, `:violet`
+  - `Ecoportal::API::V2::Page::Component::GaugeStop#color_sym` to get the color as `symbol` name
+  - added support for chart fields:
+    - `Ecoportal::API::V2::Page::Component::ChartField` with the different `mode` types
+    - `Ecoportal::API::V2::Page::Component::ChartFrField` (LTIFR)
+
+### Changed
+  - `Ecoportal::API::Page::Component::DateField` Date objects + Timezones
+    - `#value` should be shown in local time
+    - `#value=` should be set by local time
+  - `Ecoportal::API::Common::Content::DoubleModel.embeds_multiple` renamed to `embeds_many`
+  - `Ecoportal::API::Common::Content::DoubleModel.embeds_one` removed parameter `:multiple`
+  - Fields under `Ecoportal::API::Page::Component` that `embeds_many` should generate new elements in a standard way
+    - added `Ecoportal::API::Common::Content::CollectionModel#items_class` method
+
+### Fixed
+  - solved `pretty_print` name collision renaming to `Ecoportal::API::Common::Content::DoubleModel#print_pretty`
+
+## [0.7.3] - 2021-02-01
+
+### 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
+  - automatic key builder
+    - helper: `Ecoportal::API::V2::v2key` method
+    - `user_key:` and `org_key:` as constructor methods for `Ecoportal::API::V2`
+### Changed
+### Fixed
+
+## [0.7.1] - 2020-10-07
+
+### Added
+### Changed
+  - updated dependencies
+### Fixed
+
+
+## [0.7.0] - 2020-09-10
+
+### Added
+### Changed
+  - updated dependencies
+### Fixed
+
 ## [0.6.1] - 2020-07-11
 
 ### Added

data/ecoportal-api-oozes.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   "~> 2.1"
-  spec.add_development_dependency "rake",      "~> 12.0"
-  spec.add_development_dependency "rspec",     "~> 3.0"
-  spec.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
-  spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
+  spec.add_development_dependency "bundler",   ">= 2.1.3",  "< 2.2"
+  spec.add_development_dependency "rspec",     ">= 3.9",    "< 4"
+  spec.add_development_dependency "rake",      ">= 12.3.0", "< 13"
+  spec.add_development_dependency "yard",      ">= 0.9.18", "< 0.10"
+  spec.add_development_dependency "redcarpet", ">= 3.5.0",  "< 3.6"
   spec.add_development_dependency "pry"
 
-  spec.add_dependency 'ecoportal-api',  '~> 0.6', '>= 0.6.0'
+  spec.add_dependency 'ecoportal-api', '>= 0.7.4', '< 0.8'
 end

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

@@ -101,6 +101,11 @@ module Ecoportal
             super(ini_doc, parent: parent, key: key)
           end
 
+          # @return [Class] the class of the elements of the Collection
+          def items_class
+            self.class.klass
+          end
+
           # Transforms `value` into the actual `key` to access the object in the doc `Array`
           def _doc_key(value)
             #print "*(#{value.class})"
@@ -134,6 +139,7 @@ module Ecoportal
             end
           end
 
+          # Get an element usign the `key`.
           def [](value)
             items_by_key[get_key(value)]
           end
@@ -161,6 +167,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 +235,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 +250,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 +259,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/common/content/double_model.rb

@@ -131,7 +131,32 @@ module Ecoportal
             end
 
             # Helper to embed one nested object under one property
-            def embeds_one(method, key: method, nullable: false, multiple: false, klass:)
+            def embeds_one(method, key: method, nullable: false, klass:)
+              embed(method, key: key, nullable: nullable, multiple: false, klass: klass)
+            end
+
+            # @note
+            #   - if you have a dedicated `Enumerable` class to manage `many`, you should use `:enum_class`
+            #   - otherwise, just indicate the child class in `:klass` and it will auto generate the class
+            # @param
+            def embeds_many(method, key: method, order_matters: false, order_key: nil, klass: nil, enum_class: nil)
+              if enum_class
+                eclass = enum_class
+              elsif klass
+                eclass = new_class(method, inherits: Common::Content::CollectionModel) do |dim_class|
+                  dim_class.klass         = klass
+                  dim_class.order_matters = order_matters
+                  dim_class.order_key     = order_key
+                end
+              else
+                raise "You should either specify the 'klass' of the elements or the 'enum_class'"
+              end
+              embed(method, key: key, multiple: true, klass: eclass)              
+            end
+
+            private
+
+            def embed(method, key: method, nullable: false, multiple: false, klass:)
               method = method.to_s.freeze
               var    = instance_variable_name(method).freeze
               k      = key.to_s.freeze
@@ -150,16 +175,6 @@ module Ecoportal
               end
             end
 
-            def embeds_multiple(method, key: method, order_matters: false, order_key: nil, klass:)
-              dim_class = new_class(method, inherits: Common::Content::CollectionModel) do |dklass|
-                dklass.klass         = klass
-                dklass.order_matters = order_matters
-                dklass.order_key     = order_key
-              end
-
-              embeds_one(method, key: key, multiple: true, klass: dim_class)
-            end
-
           end
 
           attr_reader :_parent, :_key
@@ -252,7 +267,7 @@ module Ecoportal
             end
           end
 
-          def pretty_print
+          def print_pretty
             puts JSON.pretty_generate(as_json)
             self
           end

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

@@ -60,8 +60,13 @@ module Ecoportal
               a == b
             end
 
-            def patch_data(a, b = nil)
+            def patch_data(a, b = nil, delete: false)
               {}.tap do |data_hash|
+                if delete
+                  patch_ver = (a && a["patch_ver"]) || 1
+                  data_hash["patch_ver"] = patch_ver
+                  next
+                end
                 a.each do |key, a_value|
                   b_value = b[key] if b_has_key = b && b.key?(key)
                   is_meta_key = META_KEYS.include?(key)
@@ -85,6 +90,8 @@ module Ecoportal
                 "id"        => id,
                 "operation" => "delete"
               }
+              #,
+              #{}"data"      => patch_data(b, delete: true)
             end
 
             def patch_new(a)

data/lib/ecoportal/api/v2.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module Ecoportal
   module API
     # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
@@ -8,19 +10,33 @@ module Ecoportal
 
       VERSION = "v2"
 
+      class << self
+        def v2key (ukey, gkey)
+          Base64.urlsafe_encode64({
+            organization: gkey,
+            user:         ukey
+          }.to_json)
+        end
+      end
+
       class_resolver :registers_class, "Ecoportal::API::V2::Registers"
       class_resolver :pages_class,     "Ecoportal::API::V2::Pages"
 
       attr_reader :client, :logger
 
       # Creates an `V2` object to scope version specific api requests.
+      # @note
+      #  - you should use either `api_key` or `user_key` and `org_key`
       # @param api_key [String] the key version to stablish the api connection.
+      # @param user_key [String] the user key used for the api connection (requires `org_key`).
+      # @param org_key [String] the org key used for the api connection (requires `user_key`).
       # @param host [String] api server domain.
       # @param logger [Logger] an object with `Logger` interface to generate logs.
-      def initialize(api_key, host: "live.ecoportal.com", logger: default_logger)
+      def initialize(api_key = nil, user_key: nil, org_key: nil, host: "live.ecoportal.com", logger: default_logger)
+        v2key   = get_key(api_key: api_key, user_key: user_key, org_key: org_key)
         @logger = logger
         @client = Common::Content::Client.new(
-          api_key: api_key,
+          api_key: v2key,
           host:    host,
           version: self.class::VERSION,
           logger:  @logger
@@ -39,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.rb

@@ -15,9 +15,9 @@ module Ecoportal
         class_resolver :sections_class,   "Ecoportal::API::V2::Page::Sections"
         class_resolver :stages_class,     "Ecoportal::API::V2::Page::Stages"
 
-        embeds_one :components, multiple: true, klass: :components_class
-        embeds_one :sections,   multiple: true, klass: :sections_class
-        embeds_one :stages,     multiple: true, klass: :stages_class
+        embeds_many :components, enum_class: :components_class
+        embeds_many :sections,   enum_class: :sections_class
+        embeds_many :stages,     enum_class: :stages_class
 
         def as_update
           super.tap do |hash|

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

@@ -21,6 +21,8 @@ module Ecoportal
           class_resolver :signature_field_class,  "Ecoportal::API::V2::Page::Component::SignatureField"
           class_resolver :reference_field_class,  "Ecoportal::API::V2::Page::Component::ReferenceField"
           class_resolver :law_field_class,        "Ecoportal::API::V2::Page::Component::LawField"
+          class_resolver :chart_field_class,      "Ecoportal::API::V2::Page::Component::ChartField"
+          class_resolver :chart_fr_field_class,   "Ecoportal::API::V2::Page::Component::ChartFrField"
 
           class << self
             def new_doc(type:)
@@ -53,7 +55,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
@@ -65,6 +68,10 @@ module Ecoportal
                   reference_field_class
                 when "law"
                   law_field_class
+                when "chart"
+                  chart_field_class
+                when "frequency_rate_chart"
+                  chart_fr_field_class
                 else
                   self
                 end
@@ -75,7 +82,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
@@ -114,3 +121,5 @@ require 'ecoportal/api/v2/page/component/images_field'
 require 'ecoportal/api/v2/page/component/signature_field'
 require 'ecoportal/api/v2/page/component/reference_field'
 require 'ecoportal/api/v2/page/component/law_field'
+require 'ecoportal/api/v2/page/component/chart_field'
+require 'ecoportal/api/v2/page/component/chart_fr_field'

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"
-            embeds_multiple :actions, klass: "Ecoportal::API::V2::Page::Component::Action", order_key: :weight
+            passthrough :create_actions
+            passthrough :required_number_of_completed_actions
+            passthrough :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
+
+            embeds_many :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 = actions.items_class.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