ecoportal-api-v2 0.8.30 → 0.8.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbeee3d71e92e44bd48070ae3cafcbc0d1422f7e1a266ae7a36cfd241e4674f1
-  data.tar.gz: 3a6ba98734b9fae590adee2ed5b83394d0fe4389d919f0a7e6287e683efa9220
+  metadata.gz: 61f3db1a50844d2f5ca194ff29939ed8daa393a6d3596e50a670ebc0f99e58db
+  data.tar.gz: b39bd03de67e23d12a48e12fdc19de1b33d131a1c4bec1aa193bf35fcbdc1035
 SHA512:
-  metadata.gz: 178fb29cef779e7a804e12d04098b00baf862a00a53947f7c00783a2b19884bf377b699d9ffd5ddaa0cf7dec2b3d21379e6e79bc1cc90a23fb27c075c0a2b860
-  data.tar.gz: 2c10eb056a68dfaad088420680f32f1ad2b5945c6603f0f3f786bf3ec0581b08cc1a5b073d43a4cc47024ed7f9b691b9ebb78f85b6582c8f89dfa43bc7cf1c3c
+  metadata.gz: fba38418ad4ed3febd3859f0d4d096d75f079aa1e7abc745ca76a7deb5479de93ab5fecede2954646691e1aa17ee66348e04a8f349d2f8800f06ca36e76efa28
+  data.tar.gz: dcfad6f62286db5b028d3ab1b29b29a0f34c04c4a8d73d2cdc01c060601d92e678d6e51f96a4ce6caa22e10d9f3bb36ec97dc8f9fef4b894c5c52ba5332e388a

data/CHANGELOG.md

@@ -1,7 +1,48 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.30] - 2022-07-xx
+## [0.8.33] - 2022-09-xx
+
+### Added
+### Changed
+### Fixed
+
+
+## [0.8.32] - 2022-09-19
+
+### Added
+  - `Ecoportal::API::V2::Pages::PageCreateResponse` to wrap the response on creation
+
+### Changed
+  - `Ecoportal::API::V2::Pages#create` to rather return a `PageCreateResponse`
+
+### Fixed
+  - `Ecoportal::API::V2::Pages#create` to make sure new page with no changes can be created.
+
+
+## [0.8.31] - 2022-09-15
+
+### Added
+  - `Ecoportal::API::Common::Content::ClassHelpers.uid` to generate a random uid
+
+### Changed
+  - added **inheritable attributes** to
+    - `Ecoportal::API::Common::Content::ArrayModel` (:order_matteres, :uniq)
+    - `Ecoportal::API::Common::Content::CollectionModel` (klass, :order_matters, :order_key, :items_key, :new_item)
+    - `Ecoportal::API::Common::Content::DoubleModel` (:key)
+  - moved `SecureRandom` dependency to `Ecoportal::API::Common::Content::ClassHelpers`
+
+### Fixed
+  - `Ecoportal::API::V2::Page::Component::SelectionOption#numeric!` fix conversion
+  - `Ecoportal::API::Common::Content::ClassHelpers`, `new_class`
+    - **Added** parameter `namespace` (default: the class `inherits` parameter): it's purpose is to define the namespace where the new class will sit
+    - **Fixed** also the namespace where the new class constant will sit (it was using always the source class `self`)
+    - **Improved** `name` parameter to have a default value that is randomized. This is useful when we just want to do something like `SomeClass.new_class`, where the name of the new class doesn't really matter.
+  - **Fixed** lost reference of class resolvers when using `embeds_many`
+    - `Ecoportal::API::Common::Content::ClassHelpers`, `resolve_class` accepts now a `Hash` with `key` referrer class, and `value` any of the previously accepted ones (i.e. `Symbol` or `String`). To this purpose, `source_class` parameter has been added.
+    - This has been natively wrapped in `Ecoportal::API::Common::Content::DoubleModel.embeds_many`, as it naturally shares the `class_resolver` with a third party class that loses the reference.
+
+## [0.8.30] - 2022-07-11
 
 ### Added
   - `Ecoportal::API::V2::Page::MoultCounter`

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

@@ -6,7 +6,7 @@ module Ecoportal
         # @note
         #   - Its purpose is to handle an Array of basic objects (i.e. `Date`, `String`, `Number`)
         class ArrayModel < Content::DoubleModel
-          class TypeMismatchedComparison < Exception
+          class TypeMismatchedComparison < StandardError
             def initialize (this: nil, that: msg = "Trying to compare objects with different behavior.")
               if this
                 msg += " From object with 'order_matters: #{this.order_matters?}' and 'uniq: #{this.uniq?}'."
@@ -30,9 +30,10 @@ module Ecoportal
               raise "To use this comparison both objects should be `ArrayModel`" unless a.is_a?(ArrayModel) && b.is_a?(ArrayModel)
               (a.order_matters? == b.order_matters?) && (a.uniq? == b.uniq?)
             end
-
           end
 
+          inheritable_class_vars :order_matteres, :uniq
+
           def initialize(doc = [], parent: self, key: nil)
             super(doc, parent: parent, key: key)
           end

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

@@ -1,3 +1,4 @@
+require 'securerandom'
 module Ecoportal
   module API
     module Common
@@ -10,9 +11,10 @@ module Ecoportal
           # @note it caches the resolved `klass`es
           # @raise [Exception] when could not resolve if `exception` is `true`
           # @param klass [Class, String, Symbol] the class to resolve
+          # @param source_class [Class] when the reference to `klass` belongs to a different inheritance chain.
           # @param exception [Boolean] if it should raise exception when could not resolve
           # @return [Class] the `Class` constant
-          def resolve_class(klass, exception: true)
+          def resolve_class(klass, source_class: self, exception: true)
             @resolved ||= {}
             @resolved[klass] ||=
               case klass
@@ -25,18 +27,24 @@ module Ecoportal
                     raise if exception
                   end
                 when Symbol
-                  resolve_class(self.send(klass))
+                  source_class.resolve_class(source_class.send(klass))
+                when Hash
+                  referrer, referred = klass.first
+                  resolve_class(referred, source_class: referrer, exception: exception)
                 else
                   raise "Unknown class: #{klass}" if exception
               end
           end
 
           # Helper to normalize `key` into a correct `ruby` **constant name**
+          # @note it removes namespace syntax `::`
           # @param key [String, Symbol] to be normalized
           # @return [String] a correct constant name
           def to_constant(key)
-            str_name = key.to_s.strip.split(/[\-\_ ]/i).compact.map do |str|
-              str.slice(0).upcase + str.slice(1..-1).downcase
+            str_name = key.to_s.strip.split(/::/).compact.map do |str|
+              str.slice(0).upcase + str.slice(1..-1)
+            end.join("").split(/[\-\_ :]+/i).compact.map do |str|
+              str.slice(0).upcase + str.slice(1..-1)
             end.join("")
           end
 
@@ -49,20 +57,27 @@ module Ecoportal
             str
           end
 
+          # Generates random ids in hexadecimal to use in class name generation.
+          # @param len [Integeter] length of the `uid`
+          # @return [String] a random unique id of length `len`
+          def uid(len = 8);
+            SecureRandom.hex(len/2)
+          end
+
           # If the class for `name` exists, it returns it. Otherwise it generates it.
           # @param name [String, Symbol] the name of the new class
           # @param inherits [Class] the parent class to _inherit_ from
+          # @param namespace [Class, String] an existing `constant` (class or module) the new class will be namespaced on
           # @yield [child_class] configure the new class
           # @yieldparam child_class [Class] the new class
           # @return [Class] the new generated class
-          def new_class(name, inherits:)
+          def new_class(name = "Child#{uid}", inherits: self, namespace: inherits)
             name            = name.to_sym.freeze
             class_name      = to_constant(name)
-            full_class_name = "#{inherits}::#{class_name}"
 
-            unless target_class = resolve_class(full_class_name, exception: false)
+            unless target_class = resolve_class("#{namespace}::#{class_name}", exception: false)
               target_class = Class.new(inherits)
-              self.const_set class_name, target_class
+              Kernel.const_get(namespace.to_s).const_set class_name, target_class
             end
 
             target_class.tap do |klass|
@@ -138,7 +153,6 @@ module Ecoportal
               subclass.instance_variable_set(instance_var, value.freeze)
             end
           end
-
         end
       end
     end

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

@@ -82,11 +82,12 @@ module Ecoportal
                 klass.uniq          = uniq
               end
             end
-
           end
 
           include Enumerable
 
+          inheritable_class_vars :klass, :order_matters, :order_key, :items_key, :new_item
+
           def initialize(ini_doc = [], parent: self, key: nil)
             unless self.class.klass?
               raise "Undefined base 'klass' or 'new_item' callback for #{self.class}"

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

@@ -1,5 +1,3 @@
-require 'securerandom'
-
 module Ecoportal
   module API
     module Common
@@ -12,7 +10,7 @@ module Ecoportal
           extend Common::Content::ClassHelpers
           include Common::Content::ModelHelpers
 
-          class UnlinkedModel < Exception
+          class UnlinkedModel < StandardError
             def initialize (msg = "Something went wrong when linking the document.", from: nil, key: nil)
               msg += " From: #{from}." if from
               msg += " key: #{key}."   if key
@@ -31,8 +29,8 @@ module Ecoportal
               @key = value.to_s.freeze
             end
 
-            def new_uuid(length: 12)
-              SecureRandom.hex(length)
+            def new_uuid(length: 24)
+              uid(length)
             end
 
             # Same as `attr_reader` but links to a subjacent `Hash` model property
@@ -208,18 +206,24 @@ module Ecoportal
               else
                 raise "You should either specify the 'klass' of the elements or the 'enum_class'"
               end
-              embed(method, key: key, multiple: true, klass: eclass)
+              embed(method, key: key, multiple: true, klass: eclass) do |instance_with_called_method|
+                # keep reference to the original class to resolve the `klass` dependency
+                # See stackoverflow: https://stackoverflow.com/a/73709529/4352306
+                referrer_class = instance_with_called_method.class
+                eclass.klass = {referrer_class => klass} if klass
+              end
             end
 
             private
 
-            def embed(method, key: method, nullable: false, multiple: false, klass:)
+            def embed(method, key: method, nullable: false, multiple: false, klass:, &block)
               method = method.to_s.freeze
               var    = instance_variable_name(method).freeze
               k      = key.to_s.freeze
 
               # retrieving method (getter)
               define_method(method) do
+                yield(self) if block_given?
                 return instance_variable_get(var) if instance_variable_defined?(var)
                 unless nullable
                   doc[k] ||= multiple ? [] : {}
@@ -239,7 +243,7 @@ module Ecoportal
 
           end
 
-          inheritable_class_vars :forced_model_keys
+          inheritable_class_vars :forced_model_keys, :key
 
           attr_reader :_parent, :_key
 

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

@@ -30,7 +30,7 @@ module Ecoportal
 
             private
 
-            def to_i
+            def to_i(value)
               Float(value).to_i
             end
 

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Pages
+        # @attr_reader page_id [String] the `id` of the new ooze.
+        # @attr_reader active_stage_id [String] the active stage `id` of the new ooze.
+        class PageCreateResponse < Common::Content::DoubleModel
+          passthrough :page_id, :active_stage_id
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,7 @@ module Ecoportal
 
         class_resolver :stages_class, "Ecoportal::API::V2::Pages::Stages"
         class_resolver :page_class,  "Ecoportal::API::V2::Page"
+        class_resolver :create_page_response_class,  "Ecoportal::API::V2::Pages::PageCreateResponse"
 
         attr_reader :client
 
@@ -75,9 +76,20 @@ module Ecoportal
         # @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})
+          body   = get_body(doc).tap do |hash|
+            unless hash["page"]
+              hash["page"] = {
+                "id" => "111111111111111111111111",
+                "operation" => "changed",
+                "data" => {"patch_ver" => 0}
+              }
+            end
+          end
+          response = client.post("/pages", data: body, params: {template_id: id})
+          wrapped  = Common::Content::WrappedResponse.new(response, create_page_response_class)
+          return wrapped.result if wrapped.success?
+          raise "Could not create page from template #{id} - Error #{response.status}: #{response.body}"
         end
 
         private
@@ -93,3 +105,4 @@ end
 
 require 'ecoportal/api/v2/page'
 require 'ecoportal/api/v2/pages/stages'
+require 'ecoportal/api/v2/pages/page_create_response'

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.30"
+    GEM2_VERSION = "0.8.32"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.30
+  version: 0.8.32
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -231,6 +231,7 @@ 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_create_response.rb
 - lib/ecoportal/api/v2/pages/page_stage.rb
 - lib/ecoportal/api/v2/pages/stages.rb
 - lib/ecoportal/api/v2/people.rb