ecoportal-api-v2 0.8.4

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

@@ -0,0 +1,25 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class SignatureField < Page::Component
+
+            class << self
+              def new_doc
+                {
+                  "color" => "#000000"
+                }
+              end
+            end
+
+            passthrough :signed_by_id, :signed_by_name, :signature_url
+            passdate    :signature_updated_at
+            passthrough :signature_content, :color
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class TagField < Page::Component
+            passthrough :single_select, :use_defaults
+            passthrough :tag_tree_id, :button_text
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Components < Common::Content::CollectionModel
+          class_resolver :component_class, "Ecoportal::API::V2::Page::Component"
+
+          self.klass do |doc|
+            component_class.get_class(doc).tap do |klass|
+              klass.key = :id
+            end
+          end
+
+          order_matters = true
+
+          def get_by_type(type)
+            self.select do |comp|
+              comp.type.downcase == type.to_s.strip.downcase
+            end
+          end
+
+          def get_by_name(name, type: nil)
+            pool = type ? get_by_type(type) : self
+
+            pool.select do |comp|
+              comp.label.to_s.strip.downcase == name.to_s.strip.downcase
+            end.first
+          end
+
+          def add(label:, type:)
+            fld_doc = component_class.new_doc(type: type)
+            upsert!(fld_doc) do |fld|
+              fld.label  = label
+              yield(fld) if block_given?
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Section < Common::Content::DoubleModel
+          class << self
+            def new_doc(split: false)
+              {
+                "id"     => new_uuid,
+                "type"   => split ? "split" : "content",
+                "weight" => 9999
+              }.tap do |out|
+                component_ids = if split
+                    {
+                      "left_component_ids" => [],
+                      "right_component_ids" => []
+                    }
+                  else
+                    {
+                      "component_ids" => []
+                    }
+                  end
+                out.merge!(component_ids)
+              end
+            end
+          end
+
+          passkey     :id
+          passthrough :patch_ver, :weight, :type
+          passthrough :heading, :left_heading, :right_heading
+          passarray   :component_ids, :left_component_ids, :right_component_ids
+          passthrough :minimized
+
+          def split?
+            doc && doc["type"] == "split"
+          end
+
+          def all_component_ids
+            return component_ids.to_a unless split?
+            left_component_ids.to_a | right_component_ids.to_a
+          end
+
+          def component?(id)
+            all_component_ids.include?(id)
+          end
+
+          def components
+            fld_ids = all_component_ids
+            root.components.values_at(*fld_ids).select.with_index do |fld, i|
+              puts "Warning: field #{id} points to missing field #{fld_ids[i]}" if !fld
+              fld && (!block_given? || yield(fld))
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Sections < Common::Content::CollectionModel
+          class_resolver :section_class, "Ecoportal::API::V2::Page::Section"
+
+          self.klass = :section_class
+
+          def add(name: nil, split: false, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+            sec_doc = section_class.new_doc(split: split)
+            upsert!(sec_doc, pos: pos, before: before, after: after) do |section|
+              section.heading  = name
+              if prev = previous_section(section)
+                section.weight = prev.weight
+              end
+              yield(section) if block_given?
+              #fix_weights! # a server bug prevents to set the weight of existing sections
+            end
+          end
+
+          def ordered
+            each_with_index.sort_by do |section, index|
+              (section.weight >= 9999) ? [index, index] : [section.weight, index]
+            end.map(&:first)
+          end
+
+          private
+
+          def fix_weights!
+            ordered.each_with_index do |section, index|
+              section.weight = index
+            end
+          end
+
+          def previous_section(value)
+            secs = ordered
+            pos  = secs.index(value) - 1
+            return if pos < 0
+            secs[pos]
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Stage < Common::Content::DoubleModel
+          passkey     :id
+          passthrough :patch_ver
+          passthrough :name
+          passarray   :subtags, order_matters: false
+          passarray   :section_ids
+          passthrough :can
+
+          def sections
+            sec_ids = section_ids.to_a
+            root.sections.values_at(*sec_ids).select.with_index do |sec, i|
+              puts "Warning: section #{id} points to missing section #{sec_ids[i]}" if !sec
+              fld && (!block_given? || yield(sec))
+            end.sort_by {|sec| sec.weight}
+          end
+
+          def attach_section(section)
+            section_ids.insert_one(section.id)
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Stages < Common::Content::CollectionModel
+          class_resolver :stage_class, "Ecoportal::API::V2::Page::Stage"
+
+          self.klass = :stage_class
+
+          def get_by_name(name)
+            find do |stage|
+              stage.name.strip.downcase == name.to_s.strip.downcase
+            end
+          end
+
+          def ordered_stages
+            stages.each_with_index.sort_by do |stage, index|
+              (stage.ordering >= 9999) ? [index, index] : [stage.ordering, index]
+            end.map(&:first)
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+module Ecoportal
+  module API
+    class V2
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      class Pages
+        STAGE_REX = /stages\/(?<sid>.*)/
+        extend Common::BaseClass
+        include Common::Content::DocHelpers
+
+        class_resolver :stages_class, "Ecoportal::API::V2::Pages::Stages"
+        class_resolver :page_class,  "Ecoportal::API::V2::Page"
+
+        attr_reader :client
+
+        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @return [Schemas] an instance object ready to make schema api requests.
+        def initialize(client)
+          @client = client
+        end
+
+        # Obtain specific object for pages api requests.
+        # @return [V2::Pages::Stages] an instance object ready to make pages api requests.
+        def stages
+          stages_class.new(client)
+        end
+
+        # Gets a page via api.
+        # @note
+        #   - if the request has `success?` the returned `object.result` gives an object with that `Page`.
+        #   - if it failed to obtain the full page, it returns a `PageStage` with the active stage data.
+        # @param id [String, Hash, Stage] the `id` of the target **page**.
+        # @param stage_id [String] the `id` of the target **stage**.
+        # @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
+          raise "Could not get page #{id} - Error #{response.status}: #{response.body}"
+        end
+
+        # Requests to update an existing page via api.
+        # @param doc [Hash, Page] data that at least contains an `id` (internal or external) of the target page.
+        # @return [Response] an object with the api response.
+        def update(doc)
+          body = get_body(doc) # , level: "page"
+          id   = get_id(doc)
+          client.patch("/pages/#{CGI.escape(id)}", data: body)
+        end
+
+        # Gets a `new` non-existing page via api with all the ids initialized.
+        # @param from [String, Hash, Page] template or `id` of the template
+        # @return [Ecoportal::API::V2::Page] the new page object.
+        def get_new(from)
+          id       = get_id(from)
+          response = client.get("/pages/new", params: {template_id: id})
+          wrapped  = Common::Content::WrappedResponse.new(response, page_class)
+
+          return wrapped.result if wrapped.success?
+          raise "Could not get new page from template #{id} - Error #{response.status}: #{response.body}"
+        end
+
+        # Requests a creation of a page via api.
+        # @param doc [Hash, Page] data that at least contains an `id` (internal or external) of the target page.
+        # @param from [String, Hash, Page] template or `id` of the template
+        # @return [Response] an object with the api response.
+        def create(doc, from:)
+          body   = get_body(doc)
+          id     = get_id(from)
+          client.post("/pages", data: body, params: {template_id: id})
+        end
+
+        private
+
+        def url_to_stage_id(url)
+          (matches = url.match(STAGE_REX)) && matches[:sid]
+        end
+
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page'
+require 'ecoportal/api/v2/pages/stages'

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

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class V2
+      class Pages
+        class PageStage < V2::Page
+          passthrough :mould_counter, :archive
+          passthrough :task_priority, :state
+          passthrough :votes_enabled, :upvotes, :downvotes
+
+          passarray   :force_errors, :subtags, :permits, order_matters: false
+          passthrough :evolution
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Ecoportal
+  module API
+    class V2
+      class Pages
+        # This API Integration level has been added due to relative permissions
+        #   - a **user** with api access may have access to a specific `stage` but not to the full `page`
+        #
+        # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        class Stages
+          extend Common::BaseClass
+          include Common::Content::DocHelpers
+
+          class_resolver :page_stage_class,  "Ecoportal::API::V2::Pages::PageStage"
+
+          attr_reader :client
+
+          # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+          # @return [Schemas] an instance object ready to make schema api requests.
+          def initialize(client)
+            @client = client
+          end
+
+          # Gets a stage via api.
+          # @note if the request has `success?` the returned `object.result` gives an object with that `Stage`.
+          # @param id [String, Hash, Stage] the `id` of the target **page**.
+          # @param stage_id [String] the `id` of the target **stage**.
+          # @return [Ecoportal::API::V2::Stage, Ecoportal::API::V2::Pages::PageStage] the target stage.
+          def get(id:, stage_id:)
+            id       = get_id(id)
+            response = client.get("/pages/#{CGI.escape(id)}/stages/#{CGI.escape(stage_id)}/")
+            wrapped  = Common::Content::WrappedResponse.new(response, page_stage_class)
+
+            return wrapped.result if wrapped.success?
+            raise "Could not get stage {#{id}} of page #{stage_id} - Error #{response.status}: #{response.body}"
+          end
+
+          # Requests to update an existing stage via api.
+          # @param doc [Hash, Stage] data that at least contains an `id` (internal or external) of the target stage.
+          # @param id [String, nil] the `id` of the target **page**.
+          # @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)}/"
+            client.patch(path, data: body)
+          end
+
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/pages/page_stage'

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

@@ -0,0 +1,31 @@
+module Ecoportal
+  module API
+    class V2
+      # @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
+
+        def job
+          unavailable_method!(__method__)
+        end
+
+        private
+
+        # Re-using hook to obtain the raw data response
+        def body_data(body)
+          return body unless body.is_a?(Hash)
+          return body unless body.key?("data")
+          body["data"]
+        end
+
+        def unavailable_method!(str)
+          raise "Unavailable method '#{str}' for api '#{VERSION}'"
+        end
+
+      end
+    end
+  end
+end