ecoportal-api-v2 0.8.27 → 0.8.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82d67186b579f8307a36bb9e17d649eaef352bab449e1628aea603198a6ffb3f
-  data.tar.gz: 390106d2c6aafe1eb2e6154b7a81aba3622400234738140db187704a30bcba86
+  metadata.gz: dbeee3d71e92e44bd48070ae3cafcbc0d1422f7e1a266ae7a36cfd241e4674f1
+  data.tar.gz: 3a6ba98734b9fae590adee2ed5b83394d0fe4389d919f0a7e6287e683efa9220
 SHA512:
-  metadata.gz: 9aa958e8c59e53b7c9a71059f8333b8949ee35ce02bc2df4e65810b2f5c8291f67c1271dd2c44a27c37559ccd6c7ad614a31e2ede665437b9e7ed2d84bfa6624
-  data.tar.gz: 2884d7264fd3d1f72d970c144a6eecf3ab6298a81a3427fb87ad8ad05d4024b2280e66d9f22ac60998d39e957924e4496cd73c589cdcd54808d8c84dfeb72a12
+  metadata.gz: 178fb29cef779e7a804e12d04098b00baf862a00a53947f7c00783a2b19884bf377b699d9ffd5ddaa0cf7dec2b3d21379e6e79bc1cc90a23fb27c075c0a2b860
+  data.tar.gz: 2c10eb056a68dfaad088420680f32f1ad2b5945c6603f0f3f786bf3ec0581b08cc1a5b073d43a4cc47024ed7f9b691b9ebb78f85b6582c8f89dfa43bc7cf1c3c

data/CHANGELOG.md

@@ -1,7 +1,48 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.27] - 2022-03-xx
+## [0.8.30] - 2022-07-xx
+
+### Added
+  - `Ecoportal::API::V2::Page::MoultCounter`
+    - Available on `Ecoportal::API::V2::Pages::PageStage`
+  - `Ecoportal::API::V2::Page::Component#Law` added support for `LawField` content
+    - where `Ecoportal::API::V2::Page::Component#LawField` has many of
+  - `Ecoportal::API::V2::Component` added parameter `any_length:` for
+    - `#ref` and `#indexable_label` (aiming to enhance data exportability)
+
+### Changed
+  - Reviewed `to_s` method on multiple components, to ensure smooth export
+
+### Fixed
+  - `Ecoportal::API::V2::Pages::PageStage#uid`
+    - Should check if `mould_conter` exists
+    - Should return `id` if `mould_counter` does not exist
+  - **Exports**
+    - `Ecoportal::API::V2::Pages::Component::PeopleField#to_s`: fix type conversion
+    - `Ecoportal::API::V2::Pages::Component::DateField#to_s`: make time to work to the local timezone where the client script runs
+
+## [0.8.29] - 2022-07-07
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::ActionField#permitted_person_schema_ids`
+    - Integration for the new feature
+  - `Ecoportal::API::V2::Pages::PageStage#uid` new method for directly rendering the uid
+
+### Changed
+  - `Ecoportal::API::V2::Page::Component::PeopleField#configure_permits`
+    - Allow for `can_view` to prevent unnecessary errors
+
+### Fixed
+  - `Ecoportal::API::V2::Page::PermissionFlags#configure` fixed typo
+
+## [0.8.28] - 2022-05-31
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::File` added `label`
+  - `Ecoportal::API::V2::Page::Component::Image` added `upload_id` and `file_file_name`
+
+## [0.8.27] - 2022-04-25
 
 ### Added
   - `Ecoportal::API::Common::Content::CollectionModel#clear`

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

@@ -7,16 +7,16 @@ module Ecoportal
         module StringDigest
           MAX_HASH_LABEL = 64
 
-          def indexable_label(str)
+          def indexable_label(str, any_length: false)
             return nil unless str
             lbl = str.downcase.gsub(/[^A-Za-z]+/,"-").slice(0, MAX_HASH_LABEL)
-            return nil unless lbl.length >= 3
+            return nil if (lbl.length < 3) && !any_length
             lbl
           end
 
           # Calculates the Hash of the field based on label
-          def hash_label(str)
-            return nil unless lbl = indexable_label(str)
+          def hash_label(str, any_length: false)
+            return nil unless lbl = indexable_label(str, any_length: any_length)
             "z" +  Digest::MD5.hexdigest(lbl).slice(0, 8);
           end
 

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

@@ -41,7 +41,6 @@ module Ecoportal
               assignee = assigned_person_member["name"] || assigned_person_member["email"]
               "#{name}, #{created_at.to_s}, #{stat}, #{assignee}"
             end
-
           end
         end
       end

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

@@ -7,7 +7,8 @@ module Ecoportal
             passboolean :create_actions
             passthrough :required_number_of_completed_actions
             passboolean :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
-
+            passarray   :permitted_person_schema_ids, order_matters: false
+            
             embeds_many :actions, klass: "Ecoportal::API::V2::Page::Component::Action", order_key: :weight
 
             # Adds a task with `name` short description

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

@@ -35,7 +35,8 @@ module Ecoportal
             end
 
             def to_s
-              value.to_s
+              return nil unless value
+              to_local_time(value).strftime(ISO8601)
             end
 
             # Quick config helper
@@ -78,6 +79,23 @@ module Ecoportal
 
             private
 
+            def to_local_time(value)
+              case value
+              when DateTime
+                value.new_offset(local_offset).to_time
+              when String
+                to_local_time(Time.parse(value))
+              when Date
+                to_local_time(value.to_time)
+              when Time
+                to_local_time(value.to_datetime)
+              end
+            end
+
+            def local_offset
+              @local_offset ||= DateTime.now.offset
+            end
+
             def configure_reminder(value)
               case value
               when :never, NilClass

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

@@ -16,12 +16,13 @@ module Ecoportal
             passkey     :id
             passforced  :patch_ver, default: 1
             passthrough :position
+            passthrough :label
             passthrough :file_size, :content_type, :token, read_only: true
             passthrough :file_container_id
             passdate    :file_update_at, read_only: true
 
             def to_s
-              file_container_id
+              [label, file_container_id].join(" => ")
             end
           end
         end

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

@@ -8,6 +8,7 @@ module Ecoportal
             passforced  :patch_ver, default: 1
             passthrough :weight
             passthrough :height, :width, :caption
+            passthrough :upload_id, :file_file_name
             passthrough :dimensions, :styles
           end
         end

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

@@ -0,0 +1,32 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class Law < Common::Content::DoubleModel
+
+            class << self
+              def new_doc
+                {
+                  "id"         => new_uuid,
+                  "weight"     => 999
+                }
+              end
+            end
+
+            passkey     :id
+            passforced  :patch_ver, default: 1
+            passthrough :title, :weight
+            passthrough :content, :product
+            passthrough :legislation, :category, :topic
+            passdate    :updated_at, read_only: true
+
+            def to_s
+              [legislation, title, category, topic].join(" <:> ")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,9 +4,22 @@ module Ecoportal
       class Page
         class Component
           class LawField < Page::Component
+            embeds_many :snippets, klass: "Ecoportal::API::V2::Page::Component::Law", order_key: :weight
+
+            def ordered_snippets
+              snippets.sort_by.with_index do |snippet, index|
+                [snippet.weight, index]
+              end
+            end
+
+            def to_s(delimiter: "\n")
+              ordered_snippets.map(&:to_s).join(delimiter)
+            end
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/law'

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

@@ -5,6 +5,10 @@ module Ecoportal
         class Component
           class NumberField < Page::Component
             passthrough :value
+
+            def to_s
+              value
+            end
           end
         end
       end

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

@@ -41,7 +41,7 @@ module Ecoportal
             end
 
             def to_s(delimiter: "\n")
-              people_ids.join(delimiter)
+              people_ids.to_a.join(delimiter)
             end
 
             # Quick config helper
@@ -121,6 +121,8 @@ module Ecoportal
                   self.apply_attached_people_permissions_to = "current_stage"
                 when :can_edit
                   self.attached_people_permissions_editable = true
+                when :can_view
+                  # do nothing
                 else
                   flags.push(cnf)
                 end

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

@@ -130,9 +130,9 @@ module Ecoportal
               end
             end
 
-            def to_s(name: true, delimiter: "\n")
+            def to_s(value: true, delimiter: "\n")
               [selected].flatten.compact.map do |opt|
-                name ? opt.name : opt.value
+                value ? opt.value : opt.name
               end.join(delimiter)
             end
 

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

@@ -18,6 +18,9 @@ module Ecoportal
             passdate    :signature_updated_at, read_only: true
             passthrough :signature_content, :color
 
+            def to_s
+              [signed_by_name, signature_updated_at].join(" at ")
+            end
           end
         end
       end

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

@@ -101,8 +101,8 @@ module Ecoportal
             refs.first
           end
 
-          def ref
-            if digest = self.class.hash_label(label)
+          def ref(any_length: false)
+            if digest = self.class.hash_label(label, any_length: any_length)
               [type, digest].join(".")
             end
           end
@@ -144,8 +144,8 @@ module Ecoportal
             forces.count > 0
           end
 
-          def indexable_label
-            self.class.indexable_label(label)
+          def indexable_label(any_length: false)
+            self.class.indexable_label(label, any_length: any_length)
           end
 
           # Quick config helper

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

@@ -0,0 +1,32 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class MouldCounter < Common::Content::DoubleModel
+          UID_REGEX    = /^(?<prefix>.*?)(?<counter>\d+)(?<postfix>.*)$/i
+          STR_LEN      = 5
+          BASE_NUM_STR = "0" * STR_LEN
+
+          passthrough :prefix, :postfix
+          passthrough :counter
+          passthrough :render
+
+          def set(uid)
+            return nil unless uid.is_a?(String)
+            return nil unless match = uid.match(UID_REGEX)
+            self.counter = count_str(match[:counter])
+            self.prefix = match[:prefix]
+            self.postfix = match[:postfix]
+            self.render = "#{match[:prefix]}#{counter}#{match[:postfix]}"
+          end
+
+          private
+
+          def count_str(num)
+            (BASE_NUM_STR + num.to_s)[-5..-1]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -69,7 +69,7 @@ module Ecoportal
             when :subscribed_to_tasks
               self.subscribed_to_tasks = val
             else
-              residual.push(cnf)
+              residual.push(key)
             end
           end
         end

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

@@ -102,6 +102,7 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/v2/page/mould_counter'
 require 'ecoportal/api/v2/page/permission_flags'
 require 'ecoportal/api/v2/page/permit'
 require 'ecoportal/api/v2/page/component'

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

@@ -3,13 +3,28 @@ module Ecoportal
     class V2
       class Pages
         class PageStage < V2::Page
-          passthrough :mould_counter, :archive
+          passthrough :archive
+          embeds_one :mould_counter, klass: "Ecoportal::API::V2::Page::MouldCounter"
           passthrough :task_priority, :state, :status
           passthrough :votes_enabled, :upvotes, :downvotes
 
           #embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
           passarray   :force_errors, :subtags, order_matters: false
 
+          # @return [Boolean] whether or not this entry has mould counter
+          def mould_counter?
+            !!doc["moult_counter"]
+          end
+
+          # @return [String] unique id
+          def uid
+            if mould_counter? && counter = mould_counter
+              counter.render
+            else
+              id
+            end
+          end
+
           # @return [String] `id` of the stage we got the data of.
           def current_stage_id
             doc.dig("active_stage", "id") || doc["current_stage_id"]
@@ -45,7 +60,6 @@ module Ecoportal
             end
             msg.empty?? true : msg
           end
-
         end
       end
     end

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.27"
+    GEM2_VERSION = "0.8.30"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.27
+  version: 0.8.30
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-25 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,7 @@ files:
 - 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
+- lib/ecoportal/api/v2/page/component/law.rb
 - lib/ecoportal/api/v2/page/component/law_field.rb
 - lib/ecoportal/api/v2/page/component/number_field.rb
 - lib/ecoportal/api/v2/page/component/people_field.rb
@@ -222,6 +223,7 @@ files:
 - lib/ecoportal/api/v2/page/force/binding.rb
 - lib/ecoportal/api/v2/page/force/bindings.rb
 - lib/ecoportal/api/v2/page/forces.rb
+- lib/ecoportal/api/v2/page/mould_counter.rb
 - lib/ecoportal/api/v2/page/permission_flags.rb
 - lib/ecoportal/api/v2/page/permit.rb
 - lib/ecoportal/api/v2/page/section.rb