ecoportal-api-graphql 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b3b994c1c3caf29f00c91a3e30ec6bd90a25f11c3da7a4de7edf7a44d43f936
-  data.tar.gz: 5dbd35520022fac826e7526daa4c33d1e009c21ee6df010d584b8ccf02b14f0b
+  metadata.gz: 3423fe59a4d52c23bc291894e4afa864eefa963033a5236f286fc214faf2309a
+  data.tar.gz: d6a5362bf375f50772bbc98c06fe37d3242a7d10596d8e067817a5ffeedb5933
 SHA512:
-  metadata.gz: 7e162e19fc732160febb41db9e0d1f397a355260b17e2ad43b960f8a1da34a8b469aeb2a146b6e80f73e7ac0e41254d715591d76d9fbb615b7be725cb8156588
-  data.tar.gz: cd480b0df06aae25e7d54a4e549fdfbf6ee0d57e5c2152ce4446fb563357266cbd785d7066fb03d6b740b1b3ac13e3ab71b85220be2142839f773f467be4b61c
+  metadata.gz: d31e6419bc84e0a3cd5b2c89c0a3d51c791ac3ee8a498cb11b7adecd7681c2b8dcbc502cbe48ae51a221b5d9bc822d7e41cc9778baa4498a42f244374322fa3a
+  data.tar.gz: 59ec3bd222d85393e6238de88fe801acc323ed0fdc89f250b609da702602b3b5c00856c4d844013d85d23248e60190cfd67fcfa1a845a3eba4da64cc507b5ab2

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.2.2
+  TargetRubyVersion: 3.2
   Exclude:
     - 'config/routes.rb'
   NewCops: enable

data/CHANGELOG.md

@@ -2,22 +2,51 @@
 
 All notable changes to this project will be documented in this file.
 
-## ToDo
+## [1.4.1] - 2025-08-xx
 
-- Add update operation for `ContractorEntity`
-- Add currentOrganization.action
-  - Analyse how to "DSL" currentOrganization.action.activities
-    - review `path` tracking
+### Added
+
+### Changed
+
+### Fixed
 
-## [1.4.1] - 2025-05-xx
+## [1.3.2] - 2025-08-19
 
 ### Added
 
+- `Mutation`: allow parameters other than **input**.
+- Location Structure `Draft` models
+- `Interface::LocationStructure::Nodes` for `LocationStructure` and `Draft::Structure`
+- `raw_response` as optional query parameter (for debugging)
+- `Logic::Input` (out of consistency)
+- Fragments:
+  - `LocationDraft`
+  - `LocationsError`
+- Query to include `draft` list when fetching an **RS**.
+- Location `Draft` queries:
+  - `Draft#byId`
+  - `Draft#create`
+  - `Draft#delete`
+  - `Draft#addCommands`
+  - `Draft#publish`
+  - `Draft#dropBadCommands`
+- Error tracking througout the payload models of location mutations
+
 ### Changed
 
+- Upgrade dependency (`ecoportal-api` **gem**).
+- Moved rescue on fragment definition to `#define` itself.
+- `NodeInterface` moved to `Interface::LocationStructure::Node`
+- Code: Shorten namespace referral.
+- Swap to `Logic::BaseModel`
+- `Mutation` to introduce `:input` required parameter by using parent class.
+
 ### Fixed
 
-## [1.3.1] - 2025-06-xx
+- `QueryConnection`: bad code.
+- `conflictingIds` should be array.
+
+## [1.3.1] - 2025-06-11
 
 ### Changed
 

data/ecoportal-api-graphql.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   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.12'
+  spec.add_dependency 'ecoportal-api',    '~> 0.10',  '>= 0.10.14'
   spec.add_dependency 'ecoportal-api-v2', '~> 3.3',   '>= 3.3.1'
   spec.add_dependency 'graphlient',       '>= 0.8.0', '< 0.9'
 end

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

@@ -27,7 +27,8 @@ module Ecoportal
 
             puts "Configuring GraphQL Client onto '#{url}'"
 
-            super(url,
+            super(
+              url,
               headers:      {
                 'Authorization' => "Bearer #{session_token(host: host)}"
               },

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

@@ -29,11 +29,11 @@ module Ecoportal
               final_path = path + [subpath].flatten.compact
 
               resolve_class(query_klass).tap do |klass|
-                unless klass <= Ecoportal::API::GraphQL::Logic::BaseQuery
-                  msg  = "Expected query_klass to be of type Ecoportal::API::GraphQL::Logic::BaseQuery. "
-                  msg << "Given: #{klass}"
-                  raise msg
-                end
+                next if klass <= Ecoportal::API::GraphQL::Logic::BaseQuery
+
+                msg  = "Expected query_klass to be of type Ecoportal::API::GraphQL::Logic::BaseQuery. "
+                msg << "Given: #{klass}"
+                raise msg
               end.new(client, base_path: final_path)
             end
             private class_method

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

@@ -5,4 +5,4 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/common/graphql'
+require_relative 'common/graphql'

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Action < Ecoportal::API::GraphQL::BaseModel
+        class Action < Logic::BaseModel
           root!
 
           passkey :id

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class ActionCategory < Ecoportal::API::GraphQL::BaseModel
+        class ActionCategory < Logic::BaseModel
           root!
 
           passkey :id

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class ContractorEntity < Ecoportal::API::GraphQL::BaseModel
+        class ContractorEntity < Logic::BaseModel
           require 'ecoportal/api/graphql/base/contractor_entity/member_changes'
 
           include MemberChanges

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class DateTime < Ecoportal::API::GraphQL::BaseModel
+        class DateTime < Logic::BaseModel
           passdate    :dateTime
           passthrough :timeZone
         end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Field < Ecoportal::API::GraphQL::BaseModel
+        class Field < Logic::BaseModel
           passkey :id
           passthrough :label
         end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class FileAttachment < Ecoportal::API::GraphQL::BaseModel
+        class FileAttachment < Logic::BaseModel
           passkey :id
           passthrough :attachmentFileSize, :attachmentFileName, :attachmentContentType
           passthrough :urlType, :activeName

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class FileContainer < Ecoportal::API::GraphQL::BaseModel
+        class FileContainer < Logic::BaseModel
           passkey :id
           passthrough :name, :activeName
           passthrough :fileSize, :token, :activeVersionId

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class LocationClassificationType < Ecoportal::API::GraphQL::BaseModel
+        class LocationClassificationType < Logic::BaseModel
           root!
 
           passkey :id

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

@@ -3,12 +3,10 @@ module Ecoportal
     class GraphQL
       module Base
         # LocationNodeType
-        class LocationNode < Ecoportal::API::GraphQL::Interface::LocationNode
-          passthrough :highlights
+        class LocationNode < Interface::LocationStructure::Node
+          class_resolver :location_node_class, self
 
-          embeds_one :parent, klass: self, nullable: true
-          embeds_many :ancestors, klass: self, read_only: true
-          embeds_many :children, klass: self, read_only: true
+          passthrough :highlights
         end
       end
     end

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

@@ -0,0 +1,37 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class LocationStructure
+          class Draft
+            class Structure < Interface::LocationStructure::Nodes
+              class_resolver :location_node_class, Base::LocationNode
+
+              def draft?
+                true
+              end
+
+              def id
+                draft&.id
+              end
+
+              def name
+                draft&.name
+              end
+
+              def parent_structure
+                draft&.parent_structure
+              end
+
+              def draft
+                return if _parent == self
+
+                _parent
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class LocationStructure
+          class Draft < Logic::BaseModel
+            read_only!
+
+            class_resolver :structure_class, "Base::LocationStructure::Draft::Structure"
+
+            passkey :id
+
+            passthrough :name, :notes
+            passboolean :commited, :ok
+            alias_method :commited?, :commited
+            alias_method :ok?, :ok
+
+            embeds_one :createdAt, klass: Base::DateTime
+
+            passarray :conflictingIds
+            embeds_many :commands, klass: Interface::LocationStructure::Command
+            embeds_many :results, read_only: true, klass: "Ecoportal::API::GraphQL::Payload::LocationStructure::CommandExecutionResult"
+
+            embeds_one :structure, klass: :structure_class
+
+            include Error::LocationsError::FetchNested
+
+            def error?
+              !ok?               ||
+                result_errors?   ||
+                conflictingIds?
+            end
+
+            def error_doc
+              if result_errors?
+                {
+                  results: [result_errors.first&.error_doc]
+                }
+              elsif conflictingIds?
+                {
+                  conflictingIds: conflictingIds.doc
+                }
+              elsif !ok?
+                {
+                  ok: false
+                }
+              end
+            end
+
+            def success?
+              !error?
+            end
+
+            def structure_id
+              parent_structure&.id
+            end
+
+            def structure_name
+              parent_structure&.name
+            end
+
+            # @note draft is in a collection of drafts
+            def parent_structure
+              return unless _parent != self
+              return unless _parent._parent != _parent
+
+              _parent._parent
+            end
+
+            def result_errors?
+              result_errors.any?
+            end
+
+            def result_errors
+              results.select(&:error?)
+            end
+
+            def conflictingIds?
+              (conflictingIds || []).any?
+            end
+          end
+        end
+      end # GraphQL
+    end # API
+  end # Ecoportal
+end
+
+require_relative 'draft/structure'

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

@@ -2,22 +2,26 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class LocationStructure < Ecoportal::API::GraphQL::BaseModel
+        class LocationStructure < Interface::LocationStructure::Nodes
           read_only!
 
-          extend Ecoportal::API::GraphQL::Helpers::LocationsTree
+          class_resolver :location_node_class, Base::LocationNode
+          class_resolver :draft_class, "Base::LocationStructure::Draft"
 
           passkey :id
           passthrough :name, :weight
           passboolean :archived, :published, :visitorManagementEnabled
           embeds_one :updatedAt, klass: Base::DateTime
-          embeds_many :nodes, klass: Base::LocationNode, order_key: :weight
 
-          def treeify
-            self.class.treeify(nodes)
+          embeds_many :drafts, klass: :draft_class, order_key: :createdAt
+
+          def draft?
+            false
           end
         end
       end
     end
   end
 end
+
+require_relative 'location_structure/draft'

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Organization < Ecoportal::API::GraphQL::BaseModel
+        class Organization < Logic::BaseModel
           root!
 
           passkey :id

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Page < Ecoportal::API::GraphQL::Interface::BasePage
+        class Page < Interface::BasePage
         end
       end
     end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class PageInfo < Ecoportal::API::GraphQL::BaseModel
+        class PageInfo < Logic::BaseModel
           passthrough :startCursor, :endCursor
           passboolean :hasNextPage, :hasPreviousPage
         end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class PersonMember < Ecoportal::API::GraphQL::BaseModel
+        class PersonMember < Logic::BaseModel
           root!
 
           passkey :id

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Resource < Ecoportal::API::GraphQL::BaseModel
+        class Resource < Logic::BaseModel
           passkey :id
           passthrough :fieldId, :pageId
           passarray :stageIds

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

@@ -24,15 +24,15 @@ module Ecoportal
           private
 
           def archiveMutation
-            Ecoportal::API::GraphQL::Mutation::Action::Archive.new(client)
+            Mutation::Action::Archive.new(client)
           end
 
           def updateMutation
-            Ecoportal::API::GraphQL::Mutation::Action::Update.new(client)
+            Mutation::Action::Update.new(client)
           end
 
           def createMutation
-            Ecoportal::API::GraphQL::Mutation::Action::Create.new(client)
+            Mutation::Action::Create.new(client)
           end
         end
       end

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

@@ -24,15 +24,15 @@ module Ecoportal
           private
 
           def createMutation
-            Ecoportal::API::GraphQL::Mutation::ContractorEntity::Create.new(client)
+            Mutation::ContractorEntity::Create.new(client)
           end
 
           def updateMutation
-            Ecoportal::API::GraphQL::Mutation::ContractorEntity::Update.new(client)
+            Mutation::ContractorEntity::Update.new(client)
           end
 
           def destroyMutation
-            Ecoportal::API::GraphQL::Mutation::ContractorEntity::Destroy.new(client)
+            Mutation::ContractorEntity::Destroy.new(client)
           end
         end
       end

data/lib/ecoportal/api/graphql/builder/location_structure/draft.rb

@@ -0,0 +1,64 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Builder
+        class LocationStructure
+          class Draft
+            attr_reader :client, :parent
+
+            def initialize(client, parent:)
+              @client = client
+              @parent = parent
+            end
+
+            def nodeClassifications(**kargs, &block)
+              parent.nodeClassifications(**kargs, &block)
+            end
+
+            def create(**kargs, &block)
+              createMutation.query(**kargs, &block)
+            end
+
+            def addCommands(**kargs, &block)
+              addCommandsMutation.query(**kargs, &block)
+            end
+
+            def delete(**kargs, &block)
+              deleteMutation.query(**kargs, &block)
+            end
+
+            def publish(**kargs, &block)
+              publishMutation.query(**kargs, &block)
+            end
+
+            def DropBadCommands(**kargs, &block)
+              dropBadCommandsMutation.query(**kargs, &block)
+            end
+
+            private
+
+            def createMutation
+              Mutation::LocationStructure::Draft::Create.new(client)
+            end
+
+            def addCommandsMutation
+              Mutation::LocationStructure::Draft::AddCommands.new(client)
+            end
+
+            def deleteMutation
+              Mutation::LocationStructure::Draft::Delete.new(client)
+            end
+
+            def publishMutation
+              Mutation::LocationStructure::Draft::Publish.new(client)
+            end
+
+            def dropBadCommandsMutation
+              Mutation::LocationStructure::Draft::DropBadCommands.new(client)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,25 +10,31 @@ module Ecoportal
           end
 
           def nodeClassifications(**kargs, &block)
-            query_model = Ecoportal::API::GraphQL::Query::LocationClassifications.new(client)
+            query_model = Query::LocationClassifications.new(client)
             query_model.query(**kargs, &block)
           end
 
           def applyCommandsInput
-            Ecoportal::API::GraphQL::Input::LocationStructure::ApplyCommands.new
+            Input::LocationStructure::ApplyCommands.new
           end
 
           def applyCommands(**kargs, &block)
             applyCommandsMutation.query(**kargs, &block)
           end
 
+          def draft
+            LocationStructure::Draft.new(client, parent: self)
+          end
+
           private
 
           def applyCommandsMutation
-            Ecoportal::API::GraphQL::Mutation::LocationStructure::ApplyCommands.new(client)
+            Mutation::LocationStructure::ApplyCommands.new(client)
           end
         end
       end
     end
   end
 end
+
+require_relative 'location_structure/draft'

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

@@ -2,8 +2,8 @@ module Ecoportal
   module API
     class GraphQL
       module Connection
-        class Action < Ecoportal::API::GraphQL::Logic::Connection
-          class_resolver :node_class, Ecoportal::API::GraphQL::Model::Action
+        class Action < Logic::Connection
+          class_resolver :node_class, Model::Action
         end
       end
     end

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

@@ -2,8 +2,8 @@ module Ecoportal
   module API
     class GraphQL
       module Connection
-        class ActionCategory < Ecoportal::API::GraphQL::Logic::Connection
-          class_resolver :node_class, Ecoportal::API::GraphQL::Base::ActionCategory
+        class ActionCategory < Logic::Connection
+          class_resolver :node_class, Base::ActionCategory
         end
       end
     end

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

@@ -2,8 +2,8 @@ module Ecoportal
   module API
     class GraphQL
       module Connection
-        class ContractorEntity < Ecoportal::API::GraphQL::Logic::Connection
-          class_resolver :node_class, Ecoportal::API::GraphQL::Model::ContractorEntity
+        class ContractorEntity < Logic::Connection
+          class_resolver :node_class, Model::ContractorEntity
         end
       end
     end

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

@@ -2,8 +2,8 @@ module Ecoportal
   module API
     class GraphQL
       module Connection
-        class PersonMemberConnection < Ecoportal::API::GraphQL::Logic::Connection
-          class_resolver :node_class, Ecoportal::API::GraphQL::Model::PersonMember
+        class PersonMemberConnection < Logic::Connection
+          class_resolver :node_class, Model::PersonMember
         end
       end
     end