ecoportal-api-graphql 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9179222ef94ebb52697888787734813f4aacf5e8267dea6b54c82862087779e0
-  data.tar.gz: 495f596b1aef1e11c1fb2bd102bfbdd073325c64f81b608d4d53230ac5037d82
+  metadata.gz: 2e9ec208e89d9a86ad745b0138d3c5ecf3105de642c9fc4ededae17e7a6e278a
+  data.tar.gz: 57d342befa5dd0e2f713bd1a79a9f49ea6367b4fc0da262f0362faaeb21c6195
 SHA512:
-  metadata.gz: 92e8cbd28c4b3d38fcbecf2284c6a6ff268641417009515cd62964eb7a539b2bbdf75fbcd9423e1616c943f49c1ba722c69bb845a0b8870dfa091f25b429a8e3
-  data.tar.gz: d5812a7922aa767e912ae4385b3b6117d63e9fbafbf2a4cc404ae274982b2fa0ca95ec6e632544a1d16decde89adb4a8503c253ae0a74a8fb599a7f53d0e6b1d
+  metadata.gz: 5d3ea5e64afc249e874d38e4ed1000056c1663ba1b0edd9304b09cf8d999b6a0dd543e47819160742fcc7d73feb4bc7e389c47feba02bc0501a7cc9ff4da62b8
+  data.tar.gz: 76ac28462d5d3dbcb5239a13865f026cd790d1272feec8d9c223b8808309fee14cf8ca59a4bc1992f9aaf6a64df986dc10af21c1c27eddb1d9b9c939d2ac30f8

data/CHANGELOG.md

@@ -9,24 +9,43 @@ All notable changes to this project will be documented in this file.
   - Analyse how to "DSL" currentOrganization.action.activities
     - review `path` tracking
 
-## [0.4.3] - 2024-10-xx
+## [0.4.5] - 2025-02-xx
 
 ### Added
 
 ### Changed
 
-- upgrade core gem
-- `Ecoportal::API::Common::GraphQL::HttpClient.new` ceased to default `version` to `v1` (now it defaults to `nil`)
+### Fixed
+
+## [0.4.4] - 2025-02-23
+
+### Changed
+
+- Upgraded `ecoportal-api` gem (maintanance)
+- Upgraded `ecoportal-api-v2` gem (to provision `root!` class method)
+- Defined some models that hand on their own as `root!`
+- Refactored `Base::Model` by moving its loggic to `Common::GraphQL`
 
 ### Fixed
 
-## [0.4.2] - 2024-10-01
+- `Ecoportal::API::Common::GraphQL::HashHelpers`
+  - Truly make the iterator generic
+
+## [0.4.3] - 2024-11-21
 
 ### Changed
 
 - upgrade gems
   - `ecoportal-api`
   - `ecoportal-api-v2`
+- `Ecoportal::API::Common::GraphQL::HttpClient.new` ceased to default `version` to `v1` (now it defaults to `nil`)
+
+## [0.4.2] - 2024-10-01
+
+### Changed
+
+- upgrade gems
+  - `ecoportal-api-v2`
 - add explicit dependency onto `ecoportal-api` gem (client)
 
 ## [0.4.1] - 2024-08-09

data/Rakefile

@@ -1,36 +1,36 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
-require "yard"
-require "redcarpet"
+require 'yard'
+require 'redcarpet'
 
-desc "run the specs"
+desc 'run the specs'
 RSpec::Core::RakeTask.new(:spec)
 
-desc "run rspec showing backtrace"
+desc 'run rspec showing backtrace'
 RSpec::Core::RakeTask.new(:spec_trace) do |task|
   task.rspec_opts = ['--backtrace']
 end
 task :rspec_trace => :spec_trace
 
-desc "run rspec stopping on first fail, and show backtrace"
+desc 'run rspec stopping on first fail, and show backtrace'
 RSpec::Core::RakeTask.new(:spec_fast) do |task|
   task.rspec_opts = ['--fail-fast', '--backtrace']
 end
 task :rspec_fast  => :spec_fast
 
-desc "run rubocop diaplying cop names"
+desc 'run rubocop diaplying cop names'
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = ['--display-cop-names']
 end
 
 # default task name is yard
-desc "Yard: generate all the documentation"
+desc 'Yard: generate all the documentation'
 YARD::Rake::YardocTask.new(:doc) do |t|
   #t.files = ['lib/**/*.rb']
 end
 
-desc "default task: runs rubocop and rspec"
+desc 'default task: runs rubocop and rspec'
 task :default do
   Rake::Task[:rubocop].invoke
 ensure

data/ecoportal-api-graphql.gemspec

@@ -1,15 +1,16 @@
+# rubocop:disable Gemspec/DevelopmentDependencies
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ecoportal/api/graphql_version"
+require 'ecoportal/api/graphql_version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ecoportal-api-graphql"
+  spec.name          = 'ecoportal-api-graphql'
   spec.version       = Ecoportal::API::GRAPQL_VERSION
-  spec.authors       = ["Oscar Segura"]
-  spec.email         = ["oscar@ecoportal.co.nz"]
+  spec.authors       = ['Oscar Segura']
+  spec.email         = ['oscar@ecoportal.co.nz']
 
-  spec.summary       = "A collection of helpers for interacting with the ecoPortal GraphQL API"
-  spec.homepage      = "https://www.ecoportal.com"
+  spec.summary       = 'A collection of helpers for interacting with the ecoPortal GraphQL API'
+  spec.homepage      = 'https://www.ecoportal.com'
   spec.licenses      = %w[MIT]
 
   spec.metadata['rubygems_mfa_required'] = 'true'
@@ -19,19 +20,21 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
-  spec.add_development_dependency "rake",      ">= 13.0.3", "< 14"
-  spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
-  spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
-  spec.add_development_dependency "rubocop",   "~> 1"
-  spec.add_development_dependency "rubocop-rake", "~> 0"
-  spec.add_development_dependency "pry"      , ">= 0.14"
-
-  spec.add_dependency 'ecoportal-api',    '~> 0.10',  '>= 0.10.7'
-  spec.add_dependency 'ecoportal-api-v2', '~> 2.0',   '>= 2.0.12'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'pry',          '>= 0.14'
+  spec.add_development_dependency 'rake',         '>= 13.0.3', '< 14'
+  spec.add_development_dependency 'redcarpet',    '>= 3.6.0',  '< 4'
+  spec.add_development_dependency 'rspec',        '>= 3.12.0', '< 4'
+  spec.add_development_dependency 'rubocop',      '~> 1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0'
+  spec.add_development_dependency 'yard',         '>= 0.9.34', '< 1'
+
+  spec.add_dependency 'ecoportal-api',    '~> 0.10',  '>= 0.10.8'
+  spec.add_dependency 'ecoportal-api-v2', '~> 2.0',   '>= 2.0.15'
   spec.add_dependency 'graphlient',       '>= 0.8.0', '< 0.9'
 end
+
+# rubocop:enable Gemspec/DevelopmentDependencies

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

@@ -7,7 +7,10 @@ module Ecoportal
             def becomes(klass)
               klass.new.tap do |becoming|
                 instance_variables.each do |var|
-                  becoming.instance_variable_set(var, instance_variable_get(var))
+                  becoming.instance_variable_set(
+                    var,
+                    instance_variable_get(var)
+                  )
                 end
               end
             end
@@ -23,11 +26,11 @@ module Ecoportal
             def const?(value)
               begin
                 const_get(value)
-              rescue NameError => e
+              rescue NameError
                 return false
               end
               true
-            end            
+            end
           end
 
           class << self

data/lib/ecoportal/api/common/graphql/hash_helpers.rb

@@ -4,48 +4,32 @@ module Ecoportal
       module GraphQL
         module HashHelpers
           module InstanceMethods
-            def transform_keys_deep(value, &block)
-              case value
-              when Hash
-                value.dup.each_with_object({}) do |(k, v), out|
-                  k_val = block_given?? yield(k) : k
-                  out[k_val] = keys_to_sym_deep(v)
-                end
-              when Enumerable
-                value.map {|v| keys_to_sym_deep(v)}
-              else
-                value
-              end
-            end
-
             def keys_to_sym_deep(value)
-               transform_keys_deep(value) {|k| k.to_sym}
+              transform_keys_deep(value, &:to_sym)
             end
 
             def keys_to_s_deep(value)
-              transform_keys_deep(value) {|k| k.to_s}
+              transform_keys_deep(value, &:to_s)
             end
 
-            def remove_nil_keys_deep(value, target: [])
-              target = [target].flatten.compact unless target.is_a?(Array)
-              return value if target.empty?
-              case value
-              when Hash
-                value.dup.each_with_object({}) do |(k, v), out|
-                  next unless v || !target.include?(k)
-                  out[k] = remove_nil_keys_deep(v, target: target)
-                end
-              when Enumerable
-                value.map {|v| remove_nil_keys_deep(v, target: target)}
-              else
-                value
+            def except_keys(value, *keys)
+              return value unless value.is_a?(Hash)
+
+              deep_dup(value).tap do |out|
+                keys.each {|key| out.delete(key)}
               end
             end
 
+            # Targetted removal of keys in `target` that are `nil`
+            def remove_nil_keys_deep(value, target: [])
+              remove_keys_deep_if(value, target: target, &:nil?)
+            end
+
+            # Based on Rails support.
             def deep_dup(data)
               case data
               when Hash
-                data.each_with_object({}) do |(k,v), copy|
+                data.each_with_object({}) do |(k, v), copy|
                   if k.is_a?(::String) || k.is_a?(::Symbol)
                     copy[k] = deep_dup(v)
                   else
@@ -59,6 +43,52 @@ module Ecoportal
                 data.dup
               end
             end
+
+            private
+
+            # Iterator
+            # @param value [Variadic]
+            # @return [value.class]
+            def transform_keys_deep(value, &block)
+              case value
+              when Hash
+                value.dup.each_with_object({}) do |(k, v), out|
+                  k_val      = block_given?? yield(k) : k
+                  out[k_val] = transform_keys_deep(v, &block)
+                end
+              when Enumerable
+                value.map {|v| transform_keys_deep(v, &block)}
+              else
+                value
+              end
+            end
+
+            # Targetted removal of keys in `target` that meet
+            # the `block` condition.
+            # @param value [Variadic]
+            # @param target [Array<String>, Array<Symbol>] the target
+            #   `keys` to yield `block` onto.
+            # @return [value.class]
+            def remove_keys_deep_if(value, target: [], &block)
+              msg = 'Expected block. None given.'
+              raise ArgumentError, msg unless block_given?
+
+              target = [target].flatten.compact
+              return value if target.empty?
+
+              case value
+              when Hash
+                value.dup.each_with_object({}) do |(k, v), out|
+                  next if yield(v) && target.include?(k) # skip
+
+                  out[k] = remove_nil_keys_deep(v, target: target, &block)
+                end
+              when Enumerable
+                value.map {|v| remove_nil_keys_deep(v, target: target, &block)}
+              else
+                value
+              end
+            end
           end
 
           module ClassMethods

data/lib/ecoportal/api/common/graphql/http_client.rb

@@ -16,19 +16,13 @@ module Ecoportal
           attr_reader :host, :version
 
           def initialize(
-            api_key:          nil,
-            version:          nil,
-            host:             'live.ecoportal.com',
-            logger:           ::Logger.new(IO::NULL),
-            deep_logging:     false
+            api_key:      nil,
+            version:      nil,
+            host:         'live.ecoportal.com',
+            logger:       ::Logger.new(IO::NULL),
+            deep_logging: false
           )
-            super(
-              api_key:          api_key,
-              version:          version,
-              host:             host,
-              logger:           logger,
-              deep_logging:     deep_logging
-            )
+            super
           end
 
           def refresh_key(value)

data/lib/ecoportal/api/common/graphql/model/as_input.rb

@@ -0,0 +1,40 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model
+          module AsInput
+            class << self
+              def included(base)
+                super
+                base.send(:include, Model::Diffable)
+                base.extend ClassMethods
+              end
+            end
+
+            module ClassMethods
+              def as_input(hash, clientMutationId: '')
+                hash_input = Ecoportal::API::Common::GraphQL::HashHelpers.
+                  keys_to_sym_deep(hash)
+
+                hash_input.merge!(clientMutationId: clientMutationId)
+
+                Ecoportal::API::Common::GraphQL::HashHelpers.
+                  remove_nil_keys_deep(hash_input, target: :id)
+              end
+            end
+
+            # INSTANCE METHODS
+
+            def as_input(clientMutationId: '')
+              self.class.as_input(
+                as_update,
+                clientMutationId: clientMutationId
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/graphql/model/diffable/hash_diff.rb

@@ -0,0 +1,60 @@
+# rubocop:disable Naming/MethodParameterName
+
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model
+          module Diffable
+            module HashDiff
+              class << self
+                def included(base)
+                  super
+                  base.extend ClassMethods
+                end
+              end
+
+              module ClassMethods
+                # @todo: refactor to only reach the current level
+                # @note the aim is to delegate `hash_diff` to the specific classes
+                #   of the model... bulding the payload/input_base in a cascaded
+                #   way (rather than in a one-off way from the top alone).
+                def hash_diff(a, b, ignore: [])
+                  case a
+                  when Hash
+                    {}.tap do |diffed|
+                      a.each do |key, a_value|
+                        b_value    = b && b[key]
+                        no_changes = (a_value == b_value) || ignore.include?(key)
+                        next if !ID_KEYS.include?(key) && no_changes
+
+                        diffed[key] = diff(a_value, b_value, ignore: ignore)
+                        diffed.delete(key) if diffed[key] == {}
+                      end
+
+                      # All keys are IDs, so it's actually blank
+                      return {} if (diffed.keys - ID_KEYS).empty?
+                    end
+                  when Array
+                    return a unless b.is_a?(Array) && a.length == b.length
+
+                    a.map.with_index do |a_value, idx|
+                      b_value = b[idx]
+                      diff(a_value, b_value, ignore: ignore)
+                    end.reject do |el|
+                      el == {}
+                    end
+                  else
+                    a
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Naming/MethodParameterName

data/lib/ecoportal/api/common/graphql/model/diffable.rb

@@ -0,0 +1,32 @@
+require 'ecoportal/api/common/graphql/model/diffable/hash_diff'
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model
+          module Diffable
+            class << self
+              def included(base)
+                super
+                base.send(:include, HashDiff)
+              end
+            end
+
+            # INSTANCE METHODS
+
+            def as_update(ref = :last, ignore: [])
+              new_doc = as_json
+              ref_doc = ref == :total ? initial_doc : original_doc
+
+              self.class.hash_diff(
+                new_doc,
+                ref_doc,
+                ignore: ignore
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/graphql/model.rb

@@ -0,0 +1,17 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model < Ecoportal::API::Common::Content::DoubleModel
+          require 'ecoportal/api/common/graphql/model/diffable'
+          require 'ecoportal/api/common/graphql/model/as_input'
+
+          include Ecoportal::API::Common::GraphQL::ClassHelpers
+
+          include Diffable
+          include AsInput
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/graphql/query_integration.rb

@@ -15,7 +15,7 @@ module Ecoportal
           #   @return [Connection::$1, $1]
           def query(method, query_klass:, subpath: [])
             method = method.to_sym
-            class_method = "#{method}_query_class".to_sym
+            class_method = :"#{method}_query_class"
 
             define_method(method) do |**kargs, &block|
               if kargs.empty? && !block_given?
@@ -27,9 +27,12 @@ module Ecoportal
 
             define_method(class_method) do
               final_path = path + [subpath].flatten.compact
+
               resolve_class(query_klass).tap do |klass|
                 unless klass <= Ecoportal::API::GraphQL::Logic::BaseQuery
-                  raise "Expected query_klass to be of type Ecoportal::API::GraphQL::Logic::BaseQuery. Given: #{klass}"
+                  msg  = "Expected query_klass to be of type Ecoportal::API::GraphQL::Logic::BaseQuery. "
+                  msg << "Given: #{klass}"
+                  raise msg
                 end
               end.new(client, base_path: final_path)
             end

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

@@ -11,7 +11,6 @@ require 'ecoportal/api/common/graphql/http_client'
 require 'ecoportal/api/common/graphql/auth_service'
 require 'ecoportal/api/common/graphql/client'
 require 'ecoportal/api/common/graphql/class_helpers'
-require 'ecoportal/api/common/graphql/doc_helpers'
 require 'ecoportal/api/common/graphql/hash_helpers'
-require 'ecoportal/api/common/graphql/patches'
+require 'ecoportal/api/common/graphql/model'
 require 'ecoportal/api/common/graphql/query_integration'

data/lib/ecoportal/api/graphql/base/action.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class Action < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :altId
           passthrough :name, :description

data/lib/ecoportal/api/graphql/base/action_category.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class ActionCategory < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :name, :value
           passboolean :archived

data/lib/ecoportal/api/graphql/base/contractor_entity.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class ContractorEntity < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :externalId
           passthrough :name

data/lib/ecoportal/api/graphql/base/location_classification_type.rb

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       module Base
         class LocationClassificationType < Ecoportal::API::GraphQL::Base::Model
-          read_only!
+          root!
 
           passkey :id
           passthrough :name

data/lib/ecoportal/api/graphql/base/location_node.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class LocationNode < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :name
           passthrough :weight

data/lib/ecoportal/api/graphql/base/location_structure.rb

@@ -4,6 +4,7 @@ module Ecoportal
       module Base
         class LocationStructure < Ecoportal::API::GraphQL::Base::Model
           read_only!
+
           extend Ecoportal::API::GraphQL::Helpers::LocationsTree
 
           passkey :id

data/lib/ecoportal/api/graphql/base/model.rb

@@ -2,29 +2,9 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Model < Ecoportal::API::Common::Content::DoubleModel
-          include Ecoportal::API::Common::GraphQL::ClassHelpers
-          #include GraphModel::HashKeys
+        class Model < Ecoportal::API::Common::GraphQL::Model
           class << self
             attr_accessor :client
-            
-            def as_input(hash, clientMutationId: "")
-              hash_input = hash.merge(clientMutationId: clientMutationId)
-              Ecoportal::API::Common::GraphQL::HashHelpers.remove_nil_keys_deep(hash_input, target: :id)
-            end
-          end
-
-          def as_update(ref = :last, ignore: [], sym_keys: false)
-            new_doc = as_json
-            ref_doc = ref == :total ? initial_doc : original_doc
-            Ecoportal::API::Common::HashDiff.diff(new_doc, ref_doc, ignore: ignore).yield_self do |out|
-              next out unless sym_keys
-              Ecoportal::API::Common::GraphQL::HashHelpers.keys_to_sym_deep(out)
-            end
-          end
-
-          def as_input(clientMutationId: "")
-            self.class.as_input(as_update(sym_keys: true), clientMutationId: clientMutationId)
           end
         end
       end

data/lib/ecoportal/api/graphql/base/organization.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class Organization < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :name, :companyName
           passthrough :logoUrl, read_only: true

data/lib/ecoportal/api/graphql/base/page.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class Page < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :mouldCounter, :name
         end

data/lib/ecoportal/api/graphql/base/person_member.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class PersonMember < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :name, :email
           passarray :tagRestrict, :userGroupIds

data/lib/ecoportal/api/graphql/error/locations_error.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Error
         class LocationsError < Ecoportal::API::GraphQL::Base::Model
+          read_only!
+
           passthrough :message, :conflictingIds
           passthrough :type
           embeds_many :validationErrors, klass: Ecoportal::API::GraphQL::Error::LocationsValidationError

data/lib/ecoportal/api/graphql/error/locations_validation_error.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Error
         class LocationsValidationError < Ecoportal::API::GraphQL::Base::Model
+          read_only!
+
           passthrough :error, :message, :property
         end
       end

data/lib/ecoportal/api/graphql/error/validation_errors.rb

@@ -14,6 +14,7 @@ module Ecoportal
 
           def each(&block)
             return to_enum(:each) unless block
+
             fullMessages.each(&block)
           end
         end

data/lib/ecoportal/api/graphql/fragment.rb

@@ -2,6 +2,7 @@
 module Fragment
   include Ecoportal::API::Common::GraphQL::ClassHelpers
 end
+
 # Class to define/parse fragments
 module Ecoportal
   module API
@@ -28,6 +29,7 @@ module Ecoportal
 
         def define(sym, heredoc, namespace: ::Fragment)
           namespace.send(:remove_const, sym) if namespace.const_defined?(sym)
+
           client.parse(heredoc).tap do |fragment|
             without_warnings do
               namespace.const_set(sym, fragment)

data/lib/ecoportal/api/graphql/helpers/locations_tree.rb

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       module Helpers
         module LocationsTree
-          RELEVANT_NODES_COUNT = 1000
+          RELEVANT_NODES_COUNT = 1_000
 
           def treeify(nodes)
             parents = nodes.each_with_object({}) do |node, out|
@@ -21,15 +21,15 @@ module Ecoportal
               class_names = class_types.map(&:name)
 
               results << {
-                "id"                   => child.id,
-                "name"                 => child.name,
-                "weight"               => child.weight,
-                "parent_id"            => node_id,
-                "archived"             => child.archived,
-                "archived_token"       => child.archivedToken,
-                "classifications"      => class_ids,
-                "classification_names" => class_names,
-                "nodes"                => get_children(child.id, parents).compact
+                'id'                   => child.id,
+                'name'                 => child.name,
+                'weight'               => child.weight,
+                'parent_id'            => node_id,
+                'archived'             => child.archived,
+                'archived_token'       => child.archivedToken,
+                'classifications'      => class_ids,
+                'classification_names' => class_names,
+                'nodes'                => get_children(child.id, parents).compact
               }
             end
           end

data/lib/ecoportal/api/graphql/logic/base_query.rb

@@ -14,6 +14,7 @@ module Ecoportal
             def accepted_params(*keys, default: :unused)
               @accepted_params ||= []
               return @accepted_params if keys.empty?
+
               keys.map(&:to_sym).uniq.each do |key|
                 @accepted_params   |= [key]
                 param_defaults[key] = default unless default == :unused
@@ -36,12 +37,14 @@ module Ecoportal
             # @note it is meant for reusability of queries from different end-points
             def field_name(str = nil)
               return @field_name unless str
+
               @field_name = nil
               @field_name = str.to_s if str
             end
 
             def base_path(path = :unused)
               return @base_path if path == :unused
+
               path ||= []
               path = path.to_s.split('.') if path.is_a?(String)
               path = path.map(&:to_s).compact
@@ -51,8 +54,7 @@ module Ecoportal
 
           include Ecoportal::API::Common::Concerns::Benchmarkable
 
-          attr_reader :client
-          attr_reader :base_path
+          attr_reader :client, :base_path
 
           def initialize(client, path: nil, base_path: self.class.base_path)
             @path      = path
@@ -94,6 +96,7 @@ module Ecoportal
           def graphql_query(path: self.path, raw_response: {}, **kargs, &block)
             default_params = self.class.param_defaults.dup
             query_params   = self.class.slice_params(default_params.merge(kargs))
+
             request(*path) do
               raw_response[:data] = client.query(query_params, &block)
             end

data/lib/ecoportal/api/graphql/logic/mutation.rb

@@ -5,13 +5,13 @@ module Ecoportal
         class Mutation < Ecoportal::API::GraphQL::Logic::BaseQuery
           class GenericPayload
             def initialize(*_args, **_kargs)
-              raise "Missuse error. You should define a payload_class for a class that inherits from Mutation class."
+              raise 'Missuse error. You should define a payload_class for a class that inherits from Mutation class.'
             end
           end
 
           class GenericInput
             def initialize(*_args, **_kargs)
-              raise "Missuse error. You should define a input_class for a class that inherits from Mutation class."
+              raise 'Missuse error. You should define a input_class for a class that inherits from Mutation class.'
             end
           end
 
@@ -38,12 +38,10 @@ module Ecoportal
 
           def as_input(value)
             case value
-            when input_class
+            when input_class, Ecoportal::API::GraphQL::Base::Model
               value.as_input
             when Hash
               value
-            when Ecoportal::API::GraphQL::Base::Model
-              value.as_input
             # when Hash
             #   value = Helpers::Model::HashKeys.keys_to_sym_deep(value)
             #   Ecoportal::API::Base::Model.as_input(value)

data/lib/ecoportal/api/graphql/logic/payload.rb

@@ -9,6 +9,8 @@ module Ecoportal
             end
           end
 
+          read_only!
+
           passthrough :clientMutationId
 
           class_resolver :item_class, GenericItem

data/lib/ecoportal/api/graphql/logic/query.rb

@@ -5,7 +5,10 @@ module Ecoportal
         class Query < Ecoportal::API::GraphQL::Logic::BaseQuery
           class GenericItem
             def initialize(*_args, **_kargs)
-              raise "Missuse error. You should define a item_class for a class that inherits from Query class."
+              msg  = "Missuse error. "
+              msg << "You should define a item_class for a class that "
+              msg << "inherits from Query class."
+              raise msg
             end
           end
           class_resolver :item_class, GenericItem

data/lib/ecoportal/api/graphql/logic/query_array.rb

@@ -14,6 +14,7 @@ module Ecoportal
 
           def response_class
             return array_class if respond_to?(:array_class)
+
             @response_class ||= self.class.new_class(
               item_class,
               inherits: Ecoportal::API::Common::Content::CollectionModel

data/lib/ecoportal/api/graphql/logic/query_connection.rb

@@ -8,6 +8,7 @@ module Ecoportal
 
           def each(connection_block: nil, **kargs, &block)
             return to_enum(:each, **kargs, connection_block: connection_block) unless block
+
             cursor = nil
             loop do
               kargs.update(after: cursor) if cursor
@@ -21,6 +22,7 @@ module Ecoportal
 
           def response_class
             return connection_class if respond_to?(:connection_class)
+
             @response_class ||= self.class.new_class(
               item_class,
               inherits:  Ecoportal::API::GraphQL::Logic::Connection,

data/lib/ecoportal/api/graphql/model/account.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Model
         class Account < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :default_tag
           passboolean :active

data/lib/ecoportal/api/graphql/model/contractor_entity.rb

@@ -3,8 +3,8 @@ module Ecoportal
     class GraphQL
       module Model
         class ContractorEntity < Ecoportal::API::GraphQL::Base::ContractorEntity
-          embeds_one :associatedPeople, klass: "Ecoportal::API::GraphQL::Connections::PersonMemberConnection"
-          embeds_many :leadContractors, enum_class: "Ecoportal::API::GraphQL::Model::PersonMember"
+          embeds_one :associatedPeople, read_only: true, klass: "Ecoportal::API::GraphQL::Connections::PersonMemberConnection"
+          embeds_many :leadContractors, read_only: true, klass: "Ecoportal::API::GraphQL::Model::PersonMember"
         end
       end
     end

data/lib/ecoportal/api/graphql/model/location_node.rb

@@ -4,7 +4,7 @@ module Ecoportal
       module Model
         class LocationNode < Ecoportal::API::GraphQL::Base::LocationNode
           embeds_one :parent, klass: Model::LocationNode, nullable: true
-          embeds_many :ancestors, klass: Model::LocationNode
+          embeds_many :ancestors, read_only: true, klass: Model::LocationNode
 
           def parentId
             parent&.id

data/lib/ecoportal/api/graphql/model/user.rb

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Model
         class User < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :email, :name
         end

data/lib/ecoportal/api/graphql/payload/location_structure/apply_commands.rb

@@ -4,6 +4,8 @@ module Ecoportal
       module Payload
         module LocationStructure
           class ApplyCommands < Ecoportal::API::GraphQL::Base::Model
+            read_only!
+
             passthrough :clientMutationId
             embeds_one :structure, klass: Ecoportal::API::GraphQL::Model::LocationStructure
             embeds_one :errors, klass: Ecoportal::API::GraphQL::Error::ValidationErrors, nullable: true

data/lib/ecoportal/api/graphql/payload/location_structure/command_execution_result.rb

@@ -4,6 +4,8 @@ module Ecoportal
       module Payload
         module LocationStructure
           class CommandExecutionResult < Ecoportal::API::GraphQL::Base::Model
+            read_only!
+
             embeds_one :command, klass: Ecoportal::API::GraphQL::Payload::LocationStructure::CommandInterface
             embeds_one :error, nullable: true, klass: Ecoportal::API::GraphQL::Error::LocationsError
             passboolean :ok

data/lib/ecoportal/api/graphql/query/location_structures.rb

@@ -15,14 +15,15 @@ module Ecoportal
           def basic_block(&block)
             final_block = block || default_query_block
             proc {
-              query(includeArchived: :boolean,
-                    includeUnpublished: :boolean,
-                    includeArchivedNodes: :boolean
+              query(
+                includeArchived:      :boolean,
+                includeUnpublished:   :boolean,
+                includeArchivedNodes: :boolean
               ) {
                 currentOrganization {
                   locations {
                     structures(
-                      includeArchived: :includeArchived,
+                      includeArchived:    :includeArchived,
                       includeUnpublished: :includeUnpublished,
                       &final_block
                     )

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = '0.4.3'.freeze
+    GRAPQL_VERSION = '0.4.4'.freeze
   end
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.12.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.12.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -51,32 +45,32 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '14'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -86,7 +80,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -119,19 +113,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.9.34
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.9.34
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: ecoportal-api
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +141,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.7
+        version: 0.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -151,7 +151,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.7
+        version: 0.10.8
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-v2
   requirement: !ruby/object:Gem::Requirement
@@ -161,7 +161,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -171,7 +171,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.15
 - !ruby/object:Gem::Dependency
   name: graphlient
   requirement: !ruby/object:Gem::Requirement
@@ -220,9 +220,12 @@ files:
 - lib/ecoportal/api/common/graphql/auth_service.rb
 - lib/ecoportal/api/common/graphql/class_helpers.rb
 - lib/ecoportal/api/common/graphql/client.rb
-- lib/ecoportal/api/common/graphql/doc_helpers.rb
 - lib/ecoportal/api/common/graphql/hash_helpers.rb
 - lib/ecoportal/api/common/graphql/http_client.rb
+- lib/ecoportal/api/common/graphql/model.rb
+- lib/ecoportal/api/common/graphql/model/as_input.rb
+- lib/ecoportal/api/common/graphql/model/diffable.rb
+- lib/ecoportal/api/common/graphql/model/diffable/hash_diff.rb
 - lib/ecoportal/api/common/graphql/patches.rb
 - lib/ecoportal/api/common/graphql/query_integration.rb
 - lib/ecoportal/api/graphql.rb

data/lib/ecoportal/api/common/graphql/doc_helpers.rb

@@ -1,10 +0,0 @@
-module Ecoportal
-  module API
-    module Common
-      module GraphQL
-        module DocHelpers
-        end
-      end
-    end
-  end
-end