ecoportal-api-oozes 0.5.5

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

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChecklistField < Page::Component
+            class_resolver :checklist_item_class, "Ecoportal::API::V2::Page::Component::ChecklistItem"
+            embeds_multiple :items, klass: :checklist_item_class, order_key: :weight
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page/component/checklist_item'

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

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChecklistItem < Common::Content::DoubleModel
+            passkey     :id
+            passthrough :patch_ver, :label
+            passthrough :weight, :checked
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class DateField < Page::Component
+            passthrough :value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class File < Common::Content::DoubleModel
+            passkey     :id
+            passthrough :patch_ver, :position
+            passthrough :content_type, :file_size, :file_container_id
+            passdate    :file_update_at
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class FilesField < Page::Component
+            class_resolver :file_class, "Ecoportal::API::V2::Page::File"
+            embeds_multiple :items, klass: :file_class, order_key: :position
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class GaugeField < Page::Component
+            passthrough :value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class GeoField < Page::Component
+            passthrough :address, :coordinates
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class Image < Common::Content::DoubleModel
+            passkey     :id
+            passthrough :patch_ver, :weight
+            passthrough :height, :width, :caption
+            passthrough :dimensions, :styles
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ImagesField < Page::Component
+            class_resolver :image_class, "Ecoportal::API::V2::Page::Image"
+            embeds_multiple :images, klass: :image_class, order_key: :weight
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class LawField < Page::Component
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class NumberField < Page::Component
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class PeopleField < Page::Component
+            passarray :people_ids
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class PlainTextField < Page::Component
+            passthrough :value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ReferenceField < Page::Component
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class RichTextField < Page::Component
+            passthrough :content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class SelectionField < Page::Component
+            passthrough :multiple, :other, :other_desc
+
+            class_resolver :selection_option_class, "Ecoportal::API::V2::Page::Component::SelectionOption"
+            embeds_multiple :options, klass: :selection_option_class, order_key: :weight
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page/component/selection_option'

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

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class SelectionOption < Common::Content::DoubleModel
+            passkey     :id
+            passthrough :patch_ver, :name, :value
+            passthrough :weight, :selected
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class SignatureField < Page::Component
+            passthrough :signed_by_id, :signature_url
+            passdate    :signature_updated_at
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class TagField < Page::Component
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+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
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Section < Common::Content::DoubleModel
+          passkey     :id
+          passthrough :patch_ver, :weight, :type
+          passthrough :heading, :left_heading, :right_heading
+          passarray   :component_ids, :left_component_ids, :right_component_ids
+
+          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
+            sec_ids = all_component_ids
+            root.components.values_at(*sec_ids).select.with_index do |fld, i|
+              puts "Warning: section #{id} points to missing field #{sec_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,14 @@
+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
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+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
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+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
+        extend Common::BaseClass
+        include Common::Content::DocHelpers
+
+        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
+
+        # Gets a page via api.
+        # @note if the request has `success?` the returned `object.result` gives an object with that `Page`.
+        # @param doc [String, Hash, Page] data containing an `id` of the target page.
+        # @return [Ecoportal::API::V2::Page] the target page.
+        def get(doc)
+          id       = get_id(doc)
+          response = client.get("/pages/#{CGI.escape(id)}")
+          Common::Content::WrappedResponse.new(response, page_class).result
+        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})
+          # TODO: make it so the obtained `doc` can be used as `doc`, yet `source_doc` to be empty {}
+          #Common::Content::WrappedResponse.new(response, page_class).result
+        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
+
+        # 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
+
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page'