ecoportal-api-v2 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5ea635d5dd6ea66c4b9cc4c8600b73b0df6cf03f13c5e1a7df17deaf5a4232
-  data.tar.gz: 05c9e704cd669859e0cd92e53f7e3d132eeea1c81d9f733b8ac890ebd3a6c9a2
+  metadata.gz: 99d119cc599b33a68117699108312e7a885ec570cbab5ea43087b1366f79cda2
+  data.tar.gz: a3de4653f9319c0d5a39edc4b7d113666b16241bdfb3cab98e3185ff6bfd153e
 SHA512:
-  metadata.gz: 43abd514484022e5732b3f187c8da5eb744887b6dde31ef666445af71289e31d6e95d5cca97674d608bb876ac18f3236ab3b6e51ed59f33d5663d1523143e6d4
-  data.tar.gz: e3fad6061fc3ed020fadc88c2444d80526d2c8605a814efc4009fa35a8c5a8a1e8781990bbf3b51eb9a96bb739336dde6c132fda31c1b69bc154cbaeb88aca5b
+  metadata.gz: 8437419e3eda3f7dfccffb48c4ba5b309cb670f1cdd18470e79b38ad2fba19f9c7b1498b19d4f0f241a7ae80fbbffe0a5a168a99314398c0e59bfa2119a9a1d3
+  data.tar.gz: 6fd2348676568bca1b50701b7f142c4e8531f3f735d7db73d00764a65ced988c4054f26dea14004d89225db9b1a6213f3b2c7c47bc1a9021cca098d24e29dacb

data/CHANGELOG.md

@@ -1,12 +1,18 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [1.1.3] - 2023-04-xx
+## [1.1.4] - 2023-06-xx
 
 ### Added
 ### Changed
 ### Fixed
 
+## [1.1.3] - 2023-06-28
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::ContractorEntitiesField`
+    - Added support for contractor entities fields.
+
 ## [1.1.2] - 2023-04-17
 
 ### Changed

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

@@ -0,0 +1,124 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ContractorEntitiesField < Page::Component
+            passboolean :is_me_button
+            passboolean :show_approval_status
+
+            passboolean :singular
+
+            passarray   :contractor_entities_ids
+            pass_reader :cached_people
+
+            passboolean :grant_permissions_enabled
+            passthrough :apply_attached_contractors_permissions_to
+            passthrough :admin_access, :regular_access
+            embeds_one  :attached_contractors_permissions_flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
+            embeds_one  :attached_contractors_admin_permissions_flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
+
+            def empty?
+              contractor_entities_ids.empty?
+            end
+
+            # Attaches people
+            def add(*ids)
+              contractor_entities_ids << ids
+            end
+
+            # Deletes people
+            def delete(*ids)
+              contractor_entities_ids.reject! {|id| ids.include?(id)}
+            end
+
+            def to_s(delimiter: "\n")
+              contractor_entities_ids.to_a.join(delimiter)
+            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 :me_button
+                  self.is_me_button = true
+                when :singular
+                  self.singular = true
+                when Hash
+                  supported = [:singular, :permits]
+                  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.regular_access = true
+                      configure_permits(*[permits].flatten.compact)
+                    else
+                      self.regular_access = false
+                    end
+                  end
+                  if cnf.key?(:admin_permits)
+                    if permits = cnf[:permits]
+                      self.admin_access = true
+                      configure_permits(*[permits].flatten.compact)
+                    else
+                      self.admin_access = false
+                    end
+                  end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
+            private
+
+            def configure_permits(*conf, to: :regular)
+              conf.each_with_object([]) do |cnf, flags|
+                permits_scope = :apply_attached_contractors_permissions_to=
+                case cnf
+                when :all
+                  send(permits_scope, "page")
+                when :stages
+                  send(permits_scope, "all_stages")
+                when :page
+                  send(permits_scope, "page_only")
+                when :stage
+                  send(permits_scope, "current_stage")
+                else
+                  flags.push(cnf)
+                end
+              end.yield_self do |flags|
+                target_flags   = :attached_contractors_admin_permissions_flags if to == :admin
+                target_flags ||= :attached_contractors_permissions_flags
+                self.send(target_flags).configure *flags
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,7 @@ module Ecoportal
           class_resolver :plain_text_field_class, "Ecoportal::API::V2::Page::Component::PlainTextField"
           class_resolver :rich_text_field_class,  "Ecoportal::API::V2::Page::Component::RichTextField"
           class_resolver :people_field_class,     "Ecoportal::API::V2::Page::Component::PeopleField"
+          class_resolver :contractor_entities_field_class, "Ecoportal::API::V2::Page::Component::ContractorEntitiesField"
           class_resolver :checklist_field_class,  "Ecoportal::API::V2::Page::Component::ChecklistField"
           class_resolver :action_field_class,     "Ecoportal::API::V2::Page::Component::ActionField"
           class_resolver :files_field_class,      "Ecoportal::API::V2::Page::Component::FilesField"
@@ -59,6 +60,8 @@ module Ecoportal
                   rich_text_field_class
                 when "people"
                   people_field_class
+                when "contractor_entities"
+                  contractor_entities_field_class
                 when "checklist"
                   checklist_field_class
                 when "page_action","checklist_task"
@@ -229,6 +232,7 @@ require 'ecoportal/api/v2/page/component/gauge_field'
 require 'ecoportal/api/v2/page/component/plain_text_field'
 require 'ecoportal/api/v2/page/component/rich_text_field'
 require 'ecoportal/api/v2/page/component/people_field'
+require 'ecoportal/api/v2/page/component/contractor_entities_field'
 require 'ecoportal/api/v2/page/component/checklist_field'
 require 'ecoportal/api/v2/page/component/action_field'
 require 'ecoportal/api/v2/page/component/files_field'

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "1.1.2"
+    GEM2_VERSION = "1.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,6 +197,7 @@ files:
 - lib/ecoportal/api/v2/page/component/chart_fr_field.rb
 - lib/ecoportal/api/v2/page/component/checklist_field.rb
 - lib/ecoportal/api/v2/page/component/checklist_item.rb
+- lib/ecoportal/api/v2/page/component/contractor_entities_field.rb
 - lib/ecoportal/api/v2/page/component/date_field.rb
 - lib/ecoportal/api/v2/page/component/file.rb
 - lib/ecoportal/api/v2/page/component/files_field.rb
@@ -264,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's V2 API