ecoportal-api-v2 0.8.5 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1cb37cfbfaac4ca9808e7e376679915740783be63ba84507eeb5bd61006652
-  data.tar.gz: 3df01f8763b6e20e27aeca3070321f6075e6841a2b9fe7f5dfe49aef19b90875
+  metadata.gz: 5833ea731a9d1360c346264d234ce9f95266db92a5480180a17f413459f196de
+  data.tar.gz: f3ef175580d2ab47c0ee7f51dc2731c0b42bd27ffa9f59600fb506d5cde38a4b
 SHA512:
-  metadata.gz: 7086fb6f67c3c192cee87da4787c18f56dfed30ad0190dfe245eee31fc9857bcebec9dd6b0c61f16c90a1a102ef23e29a349257abce4126c0a3ae63eec96b563
-  data.tar.gz: 3cfc491ace7c26c6ea571cb303c9da41e8492ae9ba329247e339231a4c9235ffe9912c19603c3fe4ea9cbd5f621d69de35b10e7f6d6a6421842646ffab31cd62
+  metadata.gz: 52064ec37a32470e699f846ac1c6c57f8f535fb0be1d689a4f086836a47f9fb2805c0f84533842f5aaa4ee9e538c60e61c1569177ae16a015520c65248347174
+  data.tar.gz: 0f8cd291558cad37b5157dba7ffdea6670548952b6aa5b0c90b34820abd2693d8f484009265bbc4c8c83fb46684f2968e9a40d4a65563e0ffc6704cca30885d0

data/CHANGELOG.md

@@ -1,24 +1,79 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.5] - 2021-02-xx
+## [0.8.9] - 2021-06-xx
 
 ### Added
+  - `Ecoportal::API::Common::Content::ModelHelpers`
+    - Starting with `#same_string?`, this lib aims to offer a full set of helper comparers.
+  - `Ecoportal::API::V2::Page::Components#get_by_id`
+    - In future changes, method `[]` might be overriding the method of the parent class `CollectionModel`.
+  - `Ecoportal::API::V2::Page::PermissionFlags` to offer support to `can_permission`, `subscribed`, etc.
+  - `Ecoportal::API::V2::Page::Section#add_component` super handy helper to add fields to sections.
+  - `Ecoportal::API::V2::Page::Component::PeopleField#delete` to remove people using their ids.
+  - `Ecoportal::API::V2::Page::Component::GeoField` **added** suport for `#coordinates`
+    - With embedded object `Ecoportal::API::V2::Page::Component::GeoCoordinates`
+  - `#configure` method, to all the `Component` types (but `ChartField` s)
+    - This method allows to quickly set field properties.
+  - `Ecoportal::API::V2::Page::Sections#between`, aiming to obtain sections between two other ones
+
+
 ### Changed
-### Fixed
+  - `Ecoportal::API::V2::Page::Section` real support for `split` sections (right vs left)
+    - This is actually a **FIX**
+  - `Ecoportal::API::V2::Page::Component::DateField#create_event`
+    - Now it switches to _allow future dates_
+  - `Ecoportal::API::V2::Page::Component::SelectionField#add_option`, the `name` parameter is now optional
+    - This change aims to make it consistent with the back-end.
+  - To its actual `Boolean` type some properties
+    - All `Component` types
 
+### Fixed
+  - `Ecoportal::API::Common::Content::HashDiffPatch` did not support `Hash` values without `id` or `patch_ver`
+    - This fix should allow them to flow to the update
+  - `Ecoportal::API::V2::Page::Component::ChartField` did not have `doc` for `mode` based configuration
+  - `Ecoportal::API::Common::Content::ArrayModel#insert_one`
+    - When `pos`, `before` & `after` were `nil` it was failing to attach the element.
+  - `Ecoportal::API::V2::Page::Sections#add` was not adding in the correct order
+  - `Ecoportal::API::V2::Page::Section.new_doc` was unnecessarily giving `9999` as default weight
 
-## [0.8.4] - 2021-02-22
+## [0.8.8] - 2021-08-03
 
 ### Added
+  - `Ecoportal::API::V2::Page::Component::ChartField::Benchmark`
+  - Support to convert selection options between numeric and text type.
+  - Add `Permit` object to `Page` and `Stage`
+
 ### Changed
-  - roll back `ecoportal-api` dependency
+  - Removed `Stages.ordered_stages`: detected bug with Enumerable iteration
+
+
+## [0.8.7] - 2021-05-25
+
+### Changed
+  - Upgrade `ecoportal-api` gem
 
 ### Fixed
+  - Requiring `api/common` from 2 different ends
 
-## [0.8.3] - 2021-02-22
+## [0.8.6] - 2021-02-23
 
 ### Added
+  - `Ecoportal::API::V2::Page::Component::SelectionField` added methods `#numeric!` `#text!`
+
+## [0.8.5] - 2021-02-22
+
+### Changed
+  - upgrade
+
+
+## [0.8.4] - 2021-02-22
+
+### Changed
+  - roll back `ecoportal-api` dependency
+
+## [0.8.3] - 2021-02-22
+
 ### Changed
   - updated `rspec` for expected patch data on `delete` operation.
 
@@ -27,23 +82,16 @@ All notable changes to this project will be documented in this file.
 
 ## [0.8.2] - 2021-02-21
 
-### Added
 ### Changed
   - some necessary changes for the new gem to be active
 
-### Fixed
-
 ## [0.8.1] - 2021-02-21
 
-### Added
 ### Changed
   - renamed parameters (backwards incompatible change):
     - `Ecoportal::API::V2::Pages::Stages` methods `#get` and `#update`
       - updated `Ecoportal::API::V2::Pages#` accordingly
 
-### Fixed
-
-
 ## MOVED TO GEM `ecoportal-api-v2` ##
 
 ## [0.7.5] - 2021-02-21
@@ -137,42 +185,29 @@ All notable changes to this project will be documented in this file.
   - automatic key builder
     - helper: `Ecoportal::API::V2::v2key` method
     - `user_key:` and `org_key:` as constructor methods for `Ecoportal::API::V2`
-### Changed
-### Fixed
 
 ## [0.7.1] - 2020-10-07
 
-### Added
 ### Changed
   - updated dependencies
-### Fixed
-
 
 ## [0.7.0] - 2020-09-10
 
-### Added
 ### Changed
   - updated dependencies
-### Fixed
 
 ## [0.6.1] - 2020-07-11
 
 ### Added
   - `Ecoportal::API::Common::Content::DoubleModel#pretty_print`
-### Changed
-### Fixed
 
 ## [0.6.0] - 2020-07-11
 
-### Added
 ### Changed
   - upgraded `ecoportal-api` gem
-### Fixed
 
 ## [0.5.9] - 2020-07-02
 
 ### Added
   - helper `Ecoportal::API::Common::Content::StringDigest#indexable_label`: to see the part of a label that gets indexed
   - this `CHANGELOG.md` file
-### Changed
-### Fixed

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "ecoportal/api"
+require "ecoportal/api-v2"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/ecoportal-api-v2.gemspec

@@ -1,11 +1,11 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ecoportal/api/v2/version"
+require "ecoportal/api/v2_version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ecoportal-api-v2"
-  spec.version       = Ecoportal::API::V2::GEM_VERSION
+  spec.version       = Ecoportal::API::GEM2_VERSION
   spec.authors       = ["Oscar Segura"]
   spec.email         = ["rien@ecoportal.co.nz", "oscar@ecoportal.co.nz", "bozydar@ecoportal.co.nz"]
 
@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.2.11",  "< 2.3"
+  spec.add_development_dependency "bundler",   ">= 2.2.17", "< 2.3"
   spec.add_development_dependency "rspec",     ">= 3.10.0", "< 3.11"
   spec.add_development_dependency "rake",      ">= 13.0.3", "< 13.1"
   spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
-  spec.add_development_dependency "pry"      , "~> 0.14"
+  spec.add_development_dependency "pry"      , ">= 0.14"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.8.1', '< 0.9'
+  spec.add_dependency 'ecoportal-api', '>= 0.8.3', '< 0.9'
 end

data/lib/ecoportal/api-v2.rb

@@ -1,10 +1,10 @@
 require "ecoportal/api"
-require "ecoportal/api/v2/version"
+require "ecoportal/api/v2_version"
 
 module Ecoportal
   module API
   end
 end
 
-require_relative "api/common"
+require_relative "api/common.v2"
 require_relative "api/v2"

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

@@ -0,0 +1,8 @@
+module Ecoportal
+  module API
+    module Common
+    end
+  end
+end
+
+require 'ecoportal/api/common/content'

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

@@ -9,6 +9,7 @@ end
 
 require 'ecoportal/api/common/content/class_helpers'
 require 'ecoportal/api/common/content/string_digest'
+require 'ecoportal/api/common/content/model_helpers'
 require 'ecoportal/api/common/content/double_model'
 require 'ecoportal/api/common/content/array_model'
 require 'ecoportal/api/common/content/collection_model'

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

@@ -3,7 +3,8 @@ module Ecoportal
     module Common
       module Content
         # Class to handle a plain Array embedded in a Hashed model.
-        # @note its purpose is to handle an Array of basic objects (i.e. `Date`, `String`, `Number`)
+        # @note
+        #   - Its purpose is to handle an Array of basic objects (i.e. `Date`, `String`, `Number`)
         class ArrayModel < Content::DoubleModel
           class TypeMismatchedComparison < Exception
             def initialize (this: nil, that: msg = "Trying to compare objects with different behavior.")
@@ -222,15 +223,16 @@ module Ecoportal
           def insert_one(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             i = index(value)
             return i if (i && uniq?)
-
             pos = case
                   when used_param?(pos)
-                    pos
+                    pos || length
                   when used_param?(before)
-                    index(before)
+                    before ? index(before) : length
                   when used_param?(after)
-                    if i = index(after)
-                      i + 1
+                    if after
+                      if i = index(after) then i + 1 end
+                    else
+                      length
                     end
                   else
                     length

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

@@ -2,6 +2,9 @@ module Ecoportal
   module API
     module Common
       module Content
+        # CollectionModel aims to deal with Arrays of actual objects.
+        # @note to be able to refer to the correct element of the Collection,
+        #   it is required that those elements have a unique `key` that allows to identify them
         class CollectionModel < Content::DoubleModel
 
           class << self
@@ -167,6 +170,7 @@ module Ecoportal
             end
           end
 
+          # Deletes `value` from this `CollectionModel` instance
           def delete!(value)
             unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel)
               raise "'Content::DoubleModel' or 'Hash' doc required"
@@ -186,7 +190,7 @@ module Ecoportal
             variables_remove!
           end
 
-          # Gets the `key` of the object
+          # Gets the `key` of the object `value`
           def get_key(value)
             case value
             when Content::DoubleModel
@@ -235,10 +239,13 @@ module Ecoportal
             super
           end
 
+          # Deletes `value` from `doc` (here referred as `_doc_items`)
+          # @return [Object] the element deleted from `doc`
           def _doc_delete(value)
             if current_pos = _doc_key(value)
-              _doc_items.delete_at(current_pos)
-              on_change
+              _doc_items.delete_at(current_pos).tap do |deleted|
+                on_change
+              end
             end
           end
 
@@ -250,7 +257,6 @@ module Ecoportal
               when used_param?(before)
                 _doc_key(before)
               when used_param?(after)
-                #puts "to add after #{after.id}"
                 if i = _doc_key(after)
                   i + 1
                 end

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

@@ -10,6 +10,7 @@ module Ecoportal
         class DoubleModel < Common::BaseModel
           NOT_USED = Common::Content::ClassHelpers::NOT_USED
           extend Common::Content::ClassHelpers
+          include Common::Content::ModelHelpers
 
           class UnlinkedModel < Exception
             def initialize (msg = "Something went wrong when linking the document.", from: nil, key: nil)
@@ -109,6 +110,16 @@ module Ecoportal
               self
             end
 
+            # To link as a `Boolean` to a subjacent `Hash` model property
+            # @param read_only [Boolean] should it only define the reader?
+            def passboolean(*methods, read_only: false)
+              pass_reader(*methods) {|value| value}
+              unless read_only
+                pass_writer(*methods) {|value| !!value}
+              end
+              self
+            end
+
             # To link as plain `Array` to a subjacent `Hash` model property
             # @param order_matters [Boolean] does the order matter
             # @param uniq [Boolean] should it contain unique elements
@@ -151,7 +162,7 @@ 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)
             end
 
             private
@@ -258,10 +269,10 @@ module Ecoportal
 
           def reset!(key = nil)
             if key
-              keys    = [].push(key).compact
+              keys    = [key].flatten.compact
               odoc    = original_doc.dig(*keys)
-              dig_set(doc, key, odoc && JSON.parse(odoc.to_json))
-
+              odoc    = odoc && JSON.parse(odoc.to_json)
+              dig_set(doc, keys, odoc)
             else
               replace_doc(JSON.parse(original_doc.to_json))
             end

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

@@ -85,31 +85,43 @@ module Ecoportal
             end
 
             def patch_delete(b)
-              return NO_CHANGES unless b.is_a?(Hash) && id = get_id(b, exception: false)
-              {
-                "id"        => id,
-                "operation" => "deleted",
-                "data"      => patch_data(b, delete: true)
-              }
+              return NO_CHANGES unless b.is_a?(Hash)
+              if id = get_id(b, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "deleted",
+                  "data"      => patch_data(b, delete: true)
+                }
+              else
+                nil
+              end
             end
 
             def patch_new(a)
-              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
-              {
-                "id"        => id,
-                "operation" => "new",
-                "data"      => patch_data(a)
-              }
+              return NO_CHANGES unless a.is_a?(Hash)
+              if id = get_id(a, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "new",
+                  "data"      => patch_data(a)
+                }
+              else
+                a
+              end
             end
 
             def patch_update(a, b)
-              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
-              {
-                "id"        => id,
-                "operation" => "changed",
-                "data"      => patch_data(a, b)
-              }.tap do |update_hash|
-                return nil unless update_hash["data"] != NO_CHANGES
+              return NO_CHANGES unless a.is_a?(Hash)
+              if id = get_id(a, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "changed",
+                  "data"      => patch_data(a, b)
+                }.tap do |update_hash|
+                  return nil unless update_hash["data"] != NO_CHANGES
+                end
+              else
+                a
               end
             end
 

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

@@ -0,0 +1,36 @@
+module Ecoportal
+  module API
+    module Common
+      module Content
+        module ModelHelpers
+
+          private
+
+          # Offers multiple ways to compare two strings
+          def same_string?(value1, value2, exact: false)
+            case
+            when value1.is_a?(String) && value2.is_a?(String)
+              if exact
+                value1 == value2
+              else
+                value1.to_s.strip.downcase == value2.to_s.strip.downcase
+              end
+            when value1.is_a?(Regexp) && value2.is_a?(String)
+              value2 =~ value1
+            when value1.is_a?(String) && value2.is_a?(Regexp)
+              value1 =~ value2
+            else
+              value1 == value2
+            end
+          end
+
+          def hash_except(hash, *keys)
+            keys.each {|key| hash.delete(key)}
+            hash
+          end
+
+        end
+      end
+    end
+  end
+end