ecoportal-api-v2 2.0.0 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff49546bff744816505c3656a7549ade52395b0a8a57a419b2ec35add4c2d0f5
-  data.tar.gz: 031e3d3f89dd29c22994372fa32175572c1b1773e1ce1841a7904b52fe0bd22c
+  metadata.gz: 97b022ff724f1d1d3f80b357d482e54ebba3750751de3771097840c1a9a1e697
+  data.tar.gz: f587813ad0917441c55c1a5dde359ca5e12070ee22d899f5a41646fa63af40dc
 SHA512:
-  metadata.gz: 2e261c78abc998494c48c817e1910178483c7db5a5842c1a92010e097258551fe2ffbfa57201e339fa1600c2cdffb54babffd66a8807f7c5543ee7776064b11b
-  data.tar.gz: 7f347723b84099f93df288eddf643cb5967472e03bcec92e86613ef220c142e0d4978bd9c90a03d21dd461045da9efdb7b7114f33de24dbdec90aace3ef30718
+  metadata.gz: 8d4e4f6c25ab85c7c8c0a119fdab33b107b519022c66ce57c2159e1de89cb73e200243e59105adc7c50d0dd3a718367ecbc9d47e8fda5766d6ab33c3a09ed3cd
+  data.tar.gz: d8230c7c42ff3f358d9b33a8a81d194f8aba30149089c5201f5bf21a905028195503e8a0530a6a99e4c1ce4f828f4ea5e4b691b4528a569e20fb362c6884f84e

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.6] - 2024-08-xx
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [2.0.5] - 2024-08-07
+
+### Fixed
+
+- Use correct endpoint to update page-stages
+
+## [2.0.4] - 2024-08-07
+
+### Added
+
+- Ability to `submit!` and `sign_off!`
+
 ## [2.0.0] - 2024-08-01
 
 ### Added
@@ -14,8 +34,6 @@ All notable changes to this project will be documented in this file.
 
 - require `ruby 3`
 
-### Fixed
-
 ## [1.1.8] - 2024-03-23
 
 ### Changed

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

@@ -11,6 +11,7 @@ module Ecoportal
           state task_priority
           votes_enabled upvotes downvotes
           forces force_errors subtags
+          tasks
         ].freeze
 
         passkey     :id

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

@@ -0,0 +1,63 @@
+module Ecoportal
+  module API
+    class V2
+      class Pages
+        class PageStage
+          class Task < Common::Content::DoubleModel
+            passkey     :id
+            passforced  :patch_ver, default: 0
+
+            passthrough :name
+            passthrough :user_lookups, :user_ids
+            passthrough :strategies, :scheduled_callbacks
+            passboolean :historic
+
+            passboolean :complete, :completable
+            passdate :due, :complete_at
+            passthrough :complete_by_id, :completed_by_name
+
+            passthrough :last_strategy
+            passboolean :is_retry, :rejected
+            passthrough :retry_reason
+            passthrough :rejected_by, :rejected_by_name, :rejected_notes
+            passdate :rejected_at
+
+            passboolean :escalated
+            passdate :escalated_at
+
+            passboolean :submitted
+            passthrough :type
+            passthrough :view_type
+
+            def ooze
+              self._parent.ooze
+            end
+
+            def fill_in?
+              type == 'complete_page'
+            end
+
+            def review?
+              type == 'review_page'
+            end
+
+            def complete!
+              return mark_as_submit   if fill_in?
+              return mark_as_sign_off if review?
+            end
+
+            private
+
+            def mark_as_submit
+              doc['submitted'] = true
+            end
+
+            def mark_as_sign_off
+              doc['sign_off'] = true
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Ecoportal
+  module API
+    class V2
+      class Pages
+        class PageStage
+          class Tasks < Common::Content::CollectionModel
+            class_resolver :task_class, "Ecoportal::API::V2::Pages::PageStage::Task"
+
+            self.klass = :task_class
+
+            def ooze
+              self._parent.ooze
+            end
+
+            # @return [Ecoportal::API::V2::Pages::PageStage::Task]
+            def get_by_id(id)
+              self.find do |task|
+                task.id == id
+              end
+            end
+
+            # @return [Array<Ecoportal::API::V2::Pages::PageStage::Task>]
+            def get_by_type(type)
+              select do |task|
+                task.type == type
+              end
+            end
+
+            # @return [Array<Ecoportal::API::V2::Pages::PageStage::Task>]
+            def open(&block)
+              reject(&:complete).tap do |res|
+                res.each(&block)
+              end
+            end
+
+            # @return [Array<Ecoportal::API::V2::Pages::PageStage::Task>]
+            def complete(&block)
+              select(&:complete).tap do |res|
+                res.each(&block)
+              end
+            end
+
+            # @return [Array<Ecoportal::API::V2::Pages::PageStage::Task>]
+            def fill_in(active: :unused, &block)
+              target = self
+              target = open     if active == true
+              target = complete if active == false
+
+              target.select(&:fill_in?).tap do |res|
+                res.each(&block)
+              end
+            end
+
+            # @return [Array<Ecoportal::API::V2::Pages::PageStage::Task>]
+            def review(active: :unused, &block)
+              target = self
+              target = open     if active == true
+              target = complete if active == false
+
+              target.select(&:review?).tap do |res|
+                res.each(&block)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,9 @@ module Ecoportal
           passthrough :task_priority, :state, :status
           passthrough :votes_enabled, :upvotes, :downvotes
 
+          class_resolver :tasks_class,   "Ecoportal::API::V2::Pages::PageStage::Tasks"
+          embeds_many :tasks, enum_class: :tasks_class
+
           #embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
           passarray   :force_errors, :subtags, order_matters: false
 
@@ -64,16 +67,19 @@ module Ecoportal
           end
 
           def mark_as_submit
-            doc["submitted"] = true
-            doc["type"]      = "complete_page"
+            tasks.fill_in(active: true).each(&:complete!)
           end
+          alias_method :submit!, :mark_as_submit
 
           def mark_as_sign_off
-            doc["sign_off"] = true
-            doc["type"]     = "review_page"
+            tasks.review(active: true).each(&:complete!)
           end
+          alias_method :sign_off!, :mark_as_sign_off
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/pages/page_stage/task'
+require 'ecoportal/api/v2/pages/page_stage/tasks'

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

@@ -40,12 +40,11 @@ module Ecoportal
           # @param stage_id [String] the `id` of the target **stage**.
           # @return [Response] an object with the api response.
           def update(doc, id: nil, stage_id:)
-            body = get_body(doc)
-            id   = id || get_id(doc)
-            path = "/pages/#{CGI.escape(id)}/stages/#{CGI.escape(stage_id)}/"
+            body   = get_body(doc)
+            id   ||= get_id(doc)
+            path   = "/pages/#{CGI.escape(id)}/stages/#{CGI.escape(stage_id)}/"
             client.patch(path, data: body)
           end
-
         end
       end
     end

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

@@ -57,11 +57,17 @@ module Ecoportal
         # @param doc [Hash, Page] data that at least contains an `id` (internal or external) of the target page.
         # @return [Ecoportal::API::Common::Response] an object with the api response.
         def update(doc)
+          if doc.is_a?(Ecoportal::API::V2::Pages::PageStage)
+            stage_id = doc.current_stage_id
+            return stages.update(doc, stage_id: stage_id)
+          end
+
           body = get_body(doc) # , level: "page"
           # Launch only if there are changes
           raise "Missing page object" unless body && body["page"]
 
           id = get_id(doc)
+
           client.patch("/pages/#{CGI.escape(id)}", data: body)
         end
 

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "2.0.0".freeze
+    GEM2_VERSION = '2.0.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.5
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -230,6 +230,8 @@ files:
 - lib/ecoportal/api/v2/pages.rb
 - lib/ecoportal/api/v2/pages/page_create_response.rb
 - lib/ecoportal/api/v2/pages/page_stage.rb
+- lib/ecoportal/api/v2/pages/page_stage/task.rb
+- lib/ecoportal/api/v2/pages/page_stage/tasks.rb
 - lib/ecoportal/api/v2/pages/stages.rb
 - lib/ecoportal/api/v2/people.rb
 - lib/ecoportal/api/v2/registers.rb