ecoportal-api-oozes 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6ecefc83d30f273a4ededb781765cde494d5e6e0facad8a501fc6ef023e73ee
-  data.tar.gz: b1e0b4dab879d237580bb4d599ea500fe7a5154f6f7f874e418360bfefc9700d
+  metadata.gz: 3b995a0d1c80408bc83f797ffe14f0bf8457d1e1be99eac780f3924c19d6efbe
+  data.tar.gz: f06fae1cf1aaf5fbcc7fdc102a3f78f55da137d3ab9c5f12a5852c6d74d99af3
 SHA512:
-  metadata.gz: 98694b883b97f35fc71c0633717d92ec9da2704bd6d63c824a38c43eca512645ab6f3ecd77924d41ae527d112ffc36fcc4190f82e06b4b6453d21ccca44de22d
-  data.tar.gz: 9ef14de17795590c48d3b3cb0a6e2ba96be3b1d1ff76cee959a1860cbf1689d17b0551842352b7326094d1c8071a8569cf58c6b8feb5dd8933da8cd6a69521fc
+  metadata.gz: a2cf8d4e48892f6f31e6b852f8aeff840af65729d5d811596561f4841d77a2063a23d2dd0b111a67a1e8feafee12cf892c02fa4acab46e1b3a55af39554ab54e
+  data.tar.gz: 3fe6beb0b48d961544e227328eeb43676470feab25a0713987cab4d4a44d0ec52a52f8f512a27be183efdbd1de4ac8cdddccd929ddbe859f8e1169ee3107bb95

data/ecoportal-api-oozes.gemspec

@@ -5,7 +5,7 @@ require "ecoportal/api/v2/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ecoportal-api-oozes"
-  spec.version       = Ecoportal::API::V2::VERSION
+  spec.version       = Ecoportal::API::V2::GEM_VERSION
   spec.authors       = ["Oscar Segura"]
   spec.email         = ["rien@ecoportal.co.nz", "oscar@ecoportal.co.nz", "bozydar@ecoportal.co.nz"]
 

data/lib/ecoportal/api-oozes.rb

@@ -6,5 +6,5 @@ module Ecoportal
   end
 end
 
-require "ecoportal/api/common"
-require "ecoportal/api/v2"
+require_relative "api/common"
+require_relative "api/v2"

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

@@ -30,6 +30,13 @@ module Ecoportal
               (a.order_matters? == b.order_matters?) && (a.uniq? == b.uniq?)
             end
 
+            # Creates a new object with `doc` where `original_doc` is `[]`
+            def create(doc)
+              self.new([]).tap do |page|
+                page.replace_doc(doc)
+              end
+            end
+
           end
 
           def initialize(doc = {}, parent: self, key: nil)

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

@@ -80,6 +80,13 @@ module Ecoportal
               end
             end
 
+            # Creates a new object with `doc` where `original_doc` is `[]`
+            def create(doc)
+              self.new([]).tap do |page|
+                page.replace_doc(doc)
+              end
+            end
+
           end
 
           include Enumerable

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

@@ -153,6 +153,14 @@ module Ecoportal
 
               embeds_one(method, key: key, multiple: true, klass: dim_class)
             end
+
+            # Creates a new object with `doc` where `original_doc` is `{}`
+            def create(doc)
+              self.new({}).tap do |page|
+                page.replace_doc(doc)
+              end
+            end
+
           end
 
           attr_reader :_parent, :_key
@@ -250,16 +258,6 @@ module Ecoportal
           #  self
           #end
 
-          protected
-
-          def is_root?
-            _parent == self && !!defined?(@doc)
-          end
-
-          def linked?
-            is_root? || !!_parent.doc
-          end
-
           def replace_doc(new_doc)
             raise UnlinkedModel.new(from: "#{self.class}#replace_doc", key: _key) unless linked?
             if is_root?
@@ -271,6 +269,16 @@ module Ecoportal
             end
           end
 
+          protected
+
+          def is_root?
+            _parent == self && !!defined?(@doc)
+          end
+
+          def linked?
+            is_root? || !!_parent.doc
+          end
+
           def replace_original_doc(new_doc)
             raise UnlinkedModel.new(from: "#{self.class}#replace_original_doc", key: _key) unless linked?
             if is_root?

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

@@ -31,6 +31,8 @@ module Ecoportal
             # 3. the `data` property holds the specific changes of the object
             #   - the `patch_ver` (compulsory) is **incremental** (for data integrity)
             #   - the properties that have changed
+            # @note
+            #   * there should not be difference between `null` and `""` (empty string)
             # @param a [Hash] current hash model
             # @param b [Hash] previous hash model
             # @return [Hash] a `patch data`
@@ -51,12 +53,19 @@ module Ecoportal
 
             private
 
+            def equal_values(a, b)
+              if a.is_a?(String) || b.is_a?(String)
+                return true if a.to_s.strip.empty? && b.to_s.strip.empty?
+              end
+              a == b
+            end
+
             def patch_data(a, b = nil)
               {}.tap do |data_hash|
                 a.each do |key, a_value|
                   b_value = b[key] if b_has_key = b && b.key?(key)
                   is_meta_key = META_KEYS.include?(key)
-                  skip_equals = b_has_key && a_value == b_value
+                  skip_equals = b_has_key && equal_values(a_value, b_value)
                   next if is_meta_key || skip_equals
                   data_hash[key] = patch_diff(a_value, b_value)
                   data_hash.delete(key) if data_hash[key] == NO_CHANGES
@@ -106,7 +115,7 @@ module Ecoportal
                 else
                   a
                 end
-              else
+              else # array with nested elements
                 a_ids = array_ids(a)
                 b_ids = array_ids(b)
 
@@ -116,19 +125,20 @@ module Ecoportal
 
                 arr_delete = del_ids.map do |id|
                   patch_delete(array_id_item(b, id))
-                end
+                end.compact
 
                 arr_update = oth_ids.map do |id|
                   patch_update(array_id_item(a, id), array_id_item(b, id))
-                end
+                end.compact
 
                 arr_new = new_ids.map do |id|
                   patch_new(array_id_item(a, id))
-                end
+                end.compact
 
                 (arr_delete.concat(arr_update).concat(arr_new)).tap do |patch_array|
                   # remove data with no `id`
                   patch_array.reject! {|item| !item.is_a?(Hash)}
+                  return NO_CHANGES if patch_array.empty?
                 end
               end
             end

data/lib/ecoportal/api/v2.rb

@@ -45,4 +45,3 @@ end
 
 require 'ecoportal/api/v2/registers'
 require 'ecoportal/api/v2/pages'
-#require 'ecoportal/api/v2/stages'

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

@@ -2,6 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page < Common::Content::DoubleModel
+        ALLOWED_KEYS  = %w[id patch_ver name template_id base_tags tags time_zone created_at updated_at can components sections stages]
         passkey     :id
         passthrough :patch_ver
         passthrough :name, :template_id
@@ -17,6 +18,17 @@ module Ecoportal
         embeds_one :components, multiple: true, klass: :components_class
         embeds_one :sections,   multiple: true, klass: :sections_class
         embeds_one :stages,     multiple: true, klass: :stages_class
+
+        def as_update
+          super.tap do |hash|
+            unless !hash
+              hash["data"].select! do |key, value|
+                ALLOWED_KEYS.include?(key)
+              end
+            end
+          end
+        end
+
       end
     end
   end

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

@@ -4,8 +4,8 @@ module Ecoportal
       class Page
         class Component
           class ActionField < Page::Component
-            class_resolver :action_class, "Ecoportal::API::V2::Page::Component::Action"
-            embeds_multiple :actions, klass: :action_class, order_key: :weight
+            #class_resolver :action_class, "Ecoportal::API::V2::Page::Component::Action"
+            embeds_multiple :actions, klass: "Ecoportal::API::V2::Page::Component::Action", order_key: :weight
           end
         end
       end

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

@@ -4,8 +4,8 @@ module Ecoportal
       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
+            #class_resolver :checklist_item_class, "Ecoportal::API::V2::Page::Component::ChecklistItem"
+            embeds_multiple :items, klass: "Ecoportal::API::V2::Page::Component::ChecklistItem", order_key: :weight
           end
         end
       end

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

@@ -4,8 +4,8 @@ module Ecoportal
       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
+            #class_resolver :file_class, "Ecoportal::API::V2::Page::File"
+            embeds_multiple :items, klass: "Ecoportal::API::V2::Page::File", order_key: :position
           end
         end
       end

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

@@ -4,8 +4,8 @@ module Ecoportal
       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
+            #class_resolver :image_class, "Ecoportal::API::V2::Page::Image"
+            embeds_multiple :images, klass: "Ecoportal::API::V2::Page::Image", order_key: :weight
           end
         end
       end

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

@@ -5,6 +5,11 @@ module Ecoportal
         class Component
           class PeopleField < Page::Component
             passarray :people_ids
+
+            def add(id)
+              people_ids << id
+            end
+
           end
         end
       end

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

@@ -6,8 +6,33 @@ module Ecoportal
           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
+            #class_resolver :selection_option_class, "Ecoportal::API::V2::Page::Component::SelectionOption"
+            embeds_multiple :options, klass: "Ecoportal::API::V2::Page::Component::SelectionOption", order_key: :weight
+
+            def select(value)
+              opt = options.find {|opt| opt.value == value}
+              sel = selected
+              return true if !multiple && opt == sel
+              sel.selected = false if !multiple && sel
+              opt.selected = true unless !opt
+            end
+
+            def selected
+              if multiple
+                options.select {|opt| opt.selected}
+              else
+                options.find {|opt| opt.selected}
+              end
+            end
+
+            def value
+              if multiple
+                selected.map {|opt| opt.value}
+              else
+                selected&.value
+              end
+            end
+
           end
         end
       end

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

@@ -13,6 +13,20 @@ module Ecoportal
 
           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
+
         end
       end
     end

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

@@ -7,6 +7,18 @@ module Ecoportal
 
           self.klass = :stage_class
 
+          def get_by_name(name)
+            find do |stage|
+              stage.name.strip.downcase == name.to_s.strip.downcase
+            end
+          end
+
+          def sections
+            section_ids.map do |id|
+              root.sections.find {|sec| sec.id == id}
+            end
+          end
+
         end
       end
     end

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

@@ -3,9 +3,11 @@ module Ecoportal
     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
@@ -16,14 +18,30 @@ module Ecoportal
           @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`.
+        # @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 doc [String, Hash, Page] data containing an `id` of the target page.
-        # @return [Ecoportal::API::V2::Page] the target page.
+        # @return [Ecoportal::API::V2::Page, Ecoportal::API::V2::Pages::PageStage] 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
+          pid      = get_id(doc)
+          response = client.get("/pages/#{CGI.escape(pid)}")
+          wrapped  = Common::Content::WrappedResponse.new(response, page_class)
+
+          return wrapped.result if wrapped.success?
+          if (response.status == 302) && (url = response.body["data"])
+            if sid = url_to_stage_id(url)
+              return stages.get(pid: pid, sid: sid)
+            end
+          end
+          raise "Could not get page #{id} - Error #{response.status}: #{response.body}"
         end
 
         # Gets a `new` non-existing page via api with all the ids initialized.
@@ -32,8 +50,11 @@ module Ecoportal
         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
+          wrapped  = Common::Content::WrappedResponse.new(response, page_class)
+
+          return wrapped.result if wrapped.success?
+          #return page_class.create(response.body["data"]) if response.success?
+          raise "Could not get new page from template #{id} - Error #{response.status}: #{response.body}"
         end
 
         # Requests a creation of a page via api.
@@ -55,9 +76,16 @@ module Ecoportal
           client.patch("/pages/#{CGI.escape(id)}", data: body)
         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,11 @@
+module Ecoportal
+  module API
+    class V2
+      class Pages
+        class PageStage < V2::Page
+          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+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 doc [String, Hash, Stage] data containing an `id` of the target page.
+          # @return [Ecoportal::API::V2::Stage, Ecoportal::API::V2::Pages::PageStage] the target stage.
+          def get(pid:, sid:)
+            pid      = get_id(pid)
+            response = client.get("/pages/#{CGI.escape(pid)}/stages/#{CGI.escape(sid)}/")
+            wrapped  = Common::Content::WrappedResponse.new(response, page_stage_class)
+
+            return wrapped.result if wrapped.success?
+            raise "Could not get stage {#{sid}} of page #{pid} - 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.
+          # @return [Response] an object with the api response.
+          def update(doc, pid: nil, sid:)
+            body = get_body(doc)
+            pid  = pid || get_id(doc)
+            path = "/pages/#{CGI.escape(pid)}/stages/#{CGI.escape(sid)}/"
+            client.patch(path, data: body)
+          end
+
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/pages/page_stage'

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

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class V2
-      VERSION = "0.5.5"
+      GEM_VERSION = "0.5.6"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-oozes
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,6 +189,8 @@ files:
 - lib/ecoportal/api/v2/page/stage.rb
 - lib/ecoportal/api/v2/page/stages.rb
 - lib/ecoportal/api/v2/pages.rb
+- lib/ecoportal/api/v2/pages/page_stage.rb
+- lib/ecoportal/api/v2/pages/stages.rb
 - lib/ecoportal/api/v2/register.rb
 - lib/ecoportal/api/v2/registers.rb
 - lib/ecoportal/api/v2/template.rb