ecoportal-api-v2 1.1.8 → 2.0.5

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page < Common::Content::DoubleModel
         ALLOWED_KEYS = %w[
-          id patch_ver name template_id
+          id external_id patch_ver name template_id
           base_tags tags
           time_zone created_at updated_at
           components sections stages
@@ -11,9 +11,11 @@ module Ecoportal
           state task_priority
           votes_enabled upvotes downvotes
           forces force_errors subtags
+          tasks
         ].freeze
 
         passkey     :id
+        passthrough :external_id
         passforced  :patch_ver, default: 1
         passthrough :name, :template_id
         passarray   :base_tags, :tags, order_matters: false
@@ -41,12 +43,13 @@ module Ecoportal
 
         def as_update
           super.tap do |hash|
-            if hash
-              hash["data"].select! do |key, value|
-                ALLOWED_KEYS.include?(key)
-              end
-              return nil if (hash["data"].keys - ["patch_ver"]).empty?
+            next unless hash
+
+            hash["data"].select! do |key, _value|
+              ALLOWED_KEYS.include?(key)
             end
+
+            return nil if (hash["data"].keys - ["patch_ver"]).empty?
           end
         end
 
@@ -57,32 +60,33 @@ module Ecoportal
         # @return [String] with feedback, if for this page instance, there are any of:
         #   1. components multi-section (fields belonging to more than one section)
         def validate
-          msg = ""
-          if (multi = components.multi_section).length.positive?
-            msg += "There are fields attached to more than one section:\n  • "
-            msg += multi.map do |fld|
-              fld.label
-            end.join("\n  • ") + "\n"
-          end
+          multi = components.multi_section
+          return true unless multi.length.positive?
 
-          msg.empty?? true : msg
+          msg = ""
+          msg << "There are fields attached to more than one section:"
+          msg << "\n  • "
+          msg << multi.map(&:label).join("\n  • ")
+          msg << "\n"
+          msg
         end
 
         private
 
         def _doc_bug_fix(hash)
-          hash.tap do |hash|
+          hash.tap do
             _fix_doc(hash["stages"], "flow_node_ids", "section_ids") if hash.key?("stages")
-            if hash.key?("sections")
-              _fix_doc(hash["sections"], "membrane_ids", "component_ids")
-              _fix_doc(hash["sections"], "left_membrane_ids", "left_component_ids")
-              _fix_doc(hash["sections"], "right_membrane_ids", "right_component_ids")
-            end
+
+            next unless hash.key?("sections")
+
+            _fix_doc(hash["sections"], "membrane_ids", "component_ids")
+            _fix_doc(hash["sections"], "left_membrane_ids", "left_component_ids")
+            _fix_doc(hash["sections"], "right_membrane_ids", "right_component_ids")
           end
         end
 
         def _fix_doc(value, source, dest)
-          value.tap do |value|
+          value.tap do
             case value
             when Array
               value.each {|v| _fix_doc(v, source, dest)}
@@ -91,7 +95,7 @@ module Ecoportal
                 value[dest] = value[source]
                 value.delete(source)
               end
-            else
+            else # rubocop:disable Style/EmptyElse
               # Do nothing!
             end
           end

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
 
@@ -18,11 +21,10 @@ module Ecoportal
 
           # @return [String] unique id
           def uid
-            if mould_counter? && counter = mould_counter
-              counter.render
-            else
-              id
-            end
+            return id unless mould_counter?
+            return id unless (counter = mould_counter)
+
+            counter.render
           end
 
           # @return [String] `id` of the stage we got the data of.
@@ -32,46 +34,52 @@ module Ecoportal
 
           # @return [Ecoportal::API::V2::Page::Stage]
           def current_stage
-            if stage_id = current_stage_id
-              stages[stage_id]
-            end
+            return false unless (stage_id = current_stage_id)
+
+            stages[stage_id]
           end
 
           # @return [String] with feedback, if for this page instance, there are any of:
           #   1. orphaned components (fields not belonging to any section)
           #   2. orphaned sections (sections not belonging to any stage)
-          def validate
+          def validate # rubocop:disable Metrics/AbcSize
             msg  = super
             msg  = "" unless msg.is_a?(String)
 
             orphans = components.unattached.select {|comp| comp.global_binding.to_s.strip.empty?}
-            if orphans.length > 0
-              msg += "There are fields not attached to any sections:\n  • "
-              msg += orphans.map do |fld|
-                fld.label
-              end.join("\n  • ") + "\n"
+            if orphans.length.positive?
+              msg << "There are fields not attached to any sections:"
+              msg << "\n  • "
+              msg << orphans.map(&:label).join("\n  • ")
+              msg << "\n"
             end
 
-            if (orphans = sections.unattached).length > 0
-              msg += "There are sections not attached to any stage:\n  • "
-              msg += orphans.map do |sec|
+            if (orphans = sections.unattached).length.positive?
+              msg << "There are sections not attached to any stage:"
+              msg << "\n  • "
+              msg << orphans.map do |sec|
                 "'#{sec.heading}' (#{sec.id})"
-              end.join("\n  • ") + "\n"
+              end.join("\n  • ")
+              msg << "\n"
             end
+
             msg.empty?? true : msg
           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

@@ -1,16 +1,17 @@
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      # @attr_reader client [Common::Client] a `Common::Client` object that
+      #   holds the configuration of the api connection.
       class Pages
-        STAGE_REX = /stages\/(?<sid>.*)/
+        STAGE_REX = /stages\/(?<sid>.*)/.freeze
         extend Common::BaseClass
         include Common::Content::DocHelpers
 
         class_resolver :stages_class, "Ecoportal::API::V2::Pages::Stages"
-        class_resolver :page_class,  "Ecoportal::API::V2::Page"
-        class_resolver :page_stage_class,  "Ecoportal::API::V2::Pages::PageStage"
-        class_resolver :create_page_response_class,  "Ecoportal::API::V2::Pages::PageCreateResponse"
+        class_resolver :page_class, "Ecoportal::API::V2::Page"
+        class_resolver :page_stage_class, "Ecoportal::API::V2::Pages::PageStage"
+        class_resolver :create_page_response_class, "Ecoportal::API::V2::Pages::PageCreateResponse"
 
         attr_reader :client
 
@@ -35,16 +36,19 @@ module Ecoportal
         # @return [Ecoportal::API::V2::Page, Ecoportal::API::V2::Pages::PageStage] the target page.
         def get(id, stage_id: nil)
           return stages.get(id: id, stage_id: stage_id) if stage_id
+
           id       = get_id(id)
           response = client.get("/pages/#{CGI.escape(id)}")
           wrapped  = Common::Content::WrappedResponse.new(response, page_class)
 
           return wrapped.result if wrapped.success?
-          if (response.status == 302) && (url = response.body["data"])
-            if stage_id = url_to_stage_id(url)
-              return stages.get(id: id, stage_id: stage_id)
-            end
-          end
+
+          url = nil
+          url = response.body["data"]     if response.status == 302
+          stage_id = url_to_stage_id(url) unless url.nil?
+
+          return stages.get(id: id, stage_id: stage_id) if stage_id
+
           raise "Could not get page #{id} - Error #{response.status}: #{response.body}"
         end
 
@@ -53,10 +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)
+
+          id = get_id(doc)
+
           client.patch("/pages/#{CGI.escape(id)}", data: body)
         end
 
@@ -81,9 +92,9 @@ module Ecoportal
           body   = get_body(doc).tap do |hash|
             unless hash["page"]
               hash["page"] = {
-                "id" => "111111111111111111111111",
+                "id"        => "111111111111111111111111",
                 "operation" => "changed",
-                "data" => {"patch_ver" => 0}
+                "data"      => {"patch_ver" => 0}
               }
             end
           end
@@ -98,7 +109,6 @@ module Ecoportal
         def url_to_stage_id(url)
           (matches = url.match(STAGE_REX)) && matches[:sid]
         end
-
       end
     end
   end

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

@@ -1,9 +1,9 @@
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      # @attr_reader client [Common::Client] a `Common::Client` object that
+      #   holds the configuration of the api connection.
       class People < API::Internal::People
-
         def batch
           unavailable_method!(__method__)
         end
@@ -24,7 +24,6 @@ module Ecoportal
         def unavailable_method!(str)
           raise "Unavailable method '#{str}' for api '#{VERSION}'"
         end
-
       end
     end
   end

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

@@ -2,26 +2,29 @@ require 'base64'
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      # @attr_reader client [Common::Client] a `Common::Client` object that
+      #   holds the configuration of the api connection.
       class Registers
         extend Common::BaseClass
         include Enumerable
         include Common::Content::DocHelpers
 
-        class_resolver :register_class,  "Ecoportal::API::V2::Registers::Register"
+        class_resolver :register_class, "Ecoportal::API::V2::Registers::Register"
         class_resolver :register_search_result_class, "Ecoportal::API::V2::Registers::PageResult"
         class_resolver :register_search_results, "Ecoportal::API::V2::Registers::SearchResults"
 
         attr_reader :client
 
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @param client [Common::Client] a `Common::Client` object that
+        #   holds the configuration of the api connection.
         # @return [Registers] an instance object ready to make registers api requests.
         def initialize(client)
           @client = client
         end
 
         def each(params: {}, &block)
-          return to_enum(:each) unless block
+          return to_enum(:each, params: params) unless block
+
           get.each(&block)
         end
 
@@ -29,7 +32,11 @@ module Ecoportal
         # @return [Enumerable<Register>] an `Enumerable` with all schemas already wrapped as `Register` objects.
         def get
           response = client.get("/templates")
-          Common::Content::WrappedResponse.new(response, register_class, key: "registers")
+          Common::Content::WrappedResponse.new(
+            response,
+            register_class,
+            key: "registers"
+          )
         end
 
         # Gets all the oozes/pages of `register_id` matching the `options`
@@ -41,18 +48,21 @@ module Ecoportal
         # @yield [result]  something to do with search page-result.
         # @yieldparam result [Ecoportal::V2::Registers::PageResult] a page result.
         # @return [Ecoportal::API::V2::Registers, Ecoportal::API::V2::Registers::SearchResults]
-        def search(register_id, options = {})
+        def search(register_id, options = {}) # rubocop:disable Metrics/AbcSize
           only_first = options.delete(:only_first)
           options    = build_options(options)
 
           if only_first
             response = client.get("/registers/#{register_id}/search", params: options)
             raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+
             return register_search_results.new(response.body["data"])
           end
 
           cursor_id = nil
-          results = 0; total = nil
+          results   = 0
+          total     = nil
+
           loop do
             options.update(cursor_id: cursor_id) if cursor_id
             response = client.get("/registers/#{register_id}/search", params: options)
@@ -61,12 +71,14 @@ module Ecoportal
             data    = response.body["data"]
             total ||= data["total"]
             if total != data["total"]
-              msg  = "Change of total in search results. Probably due to changes that affect the filter (register: #{register_id}):"
+              msg  = "Change of total in search results. "
+              msg << "Probably due to changes that affect the filter"
+              msg << "(register: #{register_id}):"
               print_search_status(msg, total, results, cursor_id, data, options)
               #total = data["total"]
             end
 
-            unless total == 0
+            unless total&.zero?
               results += data["results"].length
               print_progress(results, total)
             end
@@ -77,12 +89,15 @@ module Ecoportal
             end
 
             break if total <= results
+
             unless data["cursor_id"]
-              msg  = "Possible error... finishing search for lack of cursor_id in response:"
+              msg = "Possible error... finishing search for lack of cursor_id in response:"
               print_search_status(msg, total, results, cursor_id, data, options)
             end
+
             break unless (cursor_id = data["cursor_id"])
           end
+
           self
         end
 
@@ -96,14 +111,14 @@ module Ecoportal
             options.each do |key, value|
               if key == :filters && value.any?
                 ret[key] = {filters: value}.to_json
-              else
-                ret[key] = value if key
+              elsif key
+                ret[key] = value
               end
             end
           end
         end
 
-        def print_search_status(msg, total, results, cursor_id, data, options)
+        def print_search_status(msg, total, results, cursor_id, data, options) # rubocop:disable Metrics/ParameterLists
           msg += "\n"
           msg += "  • Original total: #{total}\n"
           msg += "    • Current total: #{data&.dig("total")}\n"

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

@@ -0,0 +1,27 @@
+module Ecoportal
+  module API
+    class V2
+      class S3
+        class Data < Common::Content::DoubleModel
+          passthrough :s3_endpoint, :AWSAccessKeyId
+          passthrough :policy, :signature
+          passthrough :user_tmpdir
+
+          def x_amz_server_side_encryption
+            doc['x-amz-server-side-encryption']
+          end
+
+          def [](key)
+            doc[key.to_s]
+          end
+
+          def user_id
+            return unless user_tmpdir
+
+            user_tmpdir.split('uploads/').last
+          end
+        end
+      end
+    end
+  end
+end