ecoportal-api-graphql 1.2.1 → 1.3.2

data/lib/ecoportal/api/graphql/interface/location_structure/node.rb

@@ -0,0 +1,43 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+        module LocationStructure
+          class Node < Logic::BaseModel
+            root!
+
+            class_resolver :location_classification_class, 'Ecoportal::API::GraphQL::Base::LocationClassificationType'
+            class_resolver :location_node_class, self
+
+            passkey :id
+            passthrough :name
+            embeds_many :classifications, klass: :location_classification_class
+            passarray :classificationObjectIds
+
+            passthrough :weight
+
+            passboolean :archived
+            passthrough :archivedToken
+
+            passthrough :structureId
+
+            embeds_one :parent, klass: :location_node_class, nullable: true
+            passthrough :parentObjectId
+
+            def parentId
+              parent&.id
+            end
+            alias_method :parent_id, :parentId
+
+            def parent_id_upcase
+              parent_id&.upcase
+            end
+
+            embeds_many :ancestors, klass: :location_node_class, read_only: true
+            embeds_many :children, klass: :location_node_class, read_only: true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/interface/location_structure/nodes.rb

@@ -0,0 +1,28 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+        module LocationStructure
+          class Nodes < Logic::BaseModel
+            extend Helpers::LocationsTree
+
+            root!
+
+            class_resolver :location_node_class, Node
+
+            embeds_many :nodes, klass: :location_node_class, order_key: :weight
+
+            def draft?
+              false
+            end
+
+            def treeify
+              self.class.treeify(nodes)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+        module LocationStructure
+        end
+      end
+    end
+  end
+end
+
+require_relative 'location_structure/node'
+require_relative 'location_structure/nodes'
+require_relative 'location_structure/command'

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

@@ -0,0 +1,11 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+      end
+    end
+  end
+end
+
+require_relative 'interface/location_structure'
+require_relative 'interface/base_page'

data/lib/ecoportal/api/graphql/{base/model.rb → logic/base_model.rb}

@@ -1,8 +1,8 @@
 module Ecoportal
   module API
     class GraphQL
-      module Base
-        class Model < Ecoportal::API::Common::GraphQL::Model
+      module Logic
+        class BaseModel < Ecoportal::API::Common::GraphQL::Model
           class << self
             attr_accessor :client
           end

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

@@ -40,14 +40,16 @@ module Ecoportal
 
               @field_name = nil
               @field_name = str.to_s if str
+              @field_name
             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
+              path   = path.to_s.split('.') if path.is_a?(String)
+              path   = path.map(&:to_s).compact
+
               @base_path = path
             end
           end
@@ -73,9 +75,16 @@ module Ecoportal
 
           # Query rely that manages the different blocks.
           # @return [Class] an object of `response_class` with the results hanging from `path`.
-          def query(path: self.path, **kargs, &block)
-            benchmarking("#{self.class}##{__method__}", print: true) do
-              graphql_query(path: path, **kargs, &basic_block(&block))
+          def query(path: self.path, raw_response: {}, **kargs, &block)
+            print = !is_a?(Mutation)
+
+            benchmarking("#{self.class}##{__method__}", print: print) do
+              graphql_query(
+                path:         path,
+                raw_response: raw_response,
+                **kargs,
+                &basic_block(&block)
+              )
             end
           end
 
@@ -98,11 +107,14 @@ module Ecoportal
             query_params   = self.class.slice_params(default_params.merge(kargs))
 
             request(*path) do
-              raw_response[:data] = client.query(query_params, &block)
+              client.query(**query_params, &block).tap do |response|
+                raw_response[:data] = response
+              end
             end
-          rescue Faraday::ParsingError, Graphlient::Errors::GraphQLError => _err
-            puts "Internal Error with these params:"
+          rescue Faraday::ParsingError, Graphlient::Errors::FaradayServerError, Graphlient::Errors::GraphQLError => _err
             pp kargs
+            puts "Internal Error with these params:"
+            pp query_params
             pp block
             raise
           end
@@ -113,7 +125,9 @@ module Ecoportal
           end
 
           def wrap_response(response, path = [])
-            unless (res = response.to_h.dig(*path.dup.unshift("data")))
+            # we use the Hash, because fragments are persmissioned
+            # see Use of Fragments at https://github.com/ashkan18/graphlient/tree/master?tab=readme-ov-file#use-of-fragments
+            unless (res = response.to_h.dig(*path.dup.unshift('data')))
               msg = "Complete failure on request. Path: #{path}\n#{response.to_h.pretty_inspect}"
               raise msg
             end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Logic
-        class Connection < Ecoportal::API::GraphQL::Base::Model
+        class Connection < Logic::BaseModel
           class GenericNode
             def initialize(*_args, **_kargs)
               raise "Missuse error. You should define a node_class for a class that inherits from GraphqlConnection class."
@@ -16,7 +16,7 @@ module Ecoportal
           passthrough :edges
           passthrough :totalCount
           embeds_many :nodes, klass: :node_class
-          embeds_one :pageInfo, klass: Ecoportal::API::GraphQL::Base::PageInfo
+          embeds_one :pageInfo, klass: Base::PageInfo
 
           def empty?
             count < 1

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

@@ -0,0 +1,11 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class Input < Logic::BaseModel
+          passthrough :clientMutationId
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Logic
-        class Mutation < Ecoportal::API::GraphQL::Logic::BaseQuery
+        class Mutation < 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.'
@@ -18,17 +18,12 @@ module Ecoportal
           class_resolver :payload_class, GenericPayload
           class_resolver :input_class, GenericInput
 
+          accepted_params :input
+
           # Query rely that manages the different blocks.
           # @return [Class] an object of `response_class` with the results hanving from `path`.
-          def query(input:, path: self.path, &block)
-            request(*path) do
-              client.query(input: as_input(input), &basic_block(&block))
-            end
-          rescue Faraday::ParsingError, Graphlient::Errors::FaradayServerError => _err
-            puts "Internal Error with these input ('#{input.class}'):"
-            pp input
-            raise
-          # rescue Graphlient::Errors::TimeoutError => _err
+          def query(input:, path: self.path, **kargs, &block)
+            super(input: as_input(input), path: path, **kargs, &block)
           end
 
           def response_class
@@ -39,7 +34,7 @@ module Ecoportal
 
           def as_input(value)
             case value
-            when input_class, Ecoportal::API::GraphQL::Base::Model
+            when input_class, Logic::BaseModel
               value.as_input
             when Hash
               value

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Logic
-        class Payload < Ecoportal::API::GraphQL::Base::Model
+        class Payload < Logic::BaseModel
           class GenericItem
             def initialize(*_args, **_kargs)
               raise "Missuse error. You should define a item_class for a class that inherits from GraphqlPayload class."
@@ -14,11 +14,24 @@ module Ecoportal
           passthrough :clientMutationId
 
           class_resolver :item_class, GenericItem
+
           embeds_one :item, klass: :item_class
-          embeds_one :errors, klass: Ecoportal::API::GraphQL::Error::ValidationErrors, nullable: true
+          embeds_one :errors, klass: Error::ValidationErrors, nullable: true
+
+          def error?
+            errors && !errors.empty?
+          end
 
           def success?
-            !errors || errors.empty?
+            !error?
+          end
+
+          def error_doc
+            return unless (err_doc = errors&.doc)
+
+            {
+              validationErrors: err_doc
+            }
           end
         end
       end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Logic
-        class Query < Ecoportal::API::GraphQL::Logic::BaseQuery
+        class Query < Logic::BaseQuery
           class GenericItem
             def initialize(*_args, **_kargs)
               msg  = "Missuse error. "

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Logic
-        class QueryArray < Ecoportal::API::GraphQL::Logic::Query
+        class QueryArray < Logic::Query
           include Enumerable
 
           def each(item_block: nil, **kargs, &block)

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Logic
-        class QueryConnection < Ecoportal::API::GraphQL::Logic::Query
+        class QueryConnection < Logic::Query
           accepted_params :searchConf, :after, :before, :first, :last
           include Enumerable
 
@@ -27,17 +27,17 @@ module Ecoportal
 
             @response_class ||= self.class.new_class(
               item_class,
-              inherits:  Ecoportal::API::GraphQL::Logic::Connection,
+              inherits:  Logic::Connection,
               namespace: "Ecoportal::API::GraphQL::Connection"
             ) do |klass|
               klass.item_class = item_class
             end
+          end
 
-            privae
+          private
 
-            def default_connection_block
-              raise 'You should defined this method'
-            end
+          def default_connection_block
+            raise 'You should defined this method'
           end
         end
       end

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

@@ -7,6 +7,7 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/graphql/logic/base_model'
 require 'ecoportal/api/graphql/logic/base_query'
 require 'ecoportal/api/graphql/logic/query'
 require 'ecoportal/api/graphql/logic/mutation'
@@ -14,3 +15,4 @@ require 'ecoportal/api/graphql/logic/connection'
 require 'ecoportal/api/graphql/logic/query_array'
 require 'ecoportal/api/graphql/logic/query_connection'
 require 'ecoportal/api/graphql/logic/payload'
+require 'ecoportal/api/graphql/logic/input'

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

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

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class Action < Ecoportal::API::GraphQL::Base::Action
+        class Action < Base::Action
           embeds_one :actionCategory, klass: GraphQL::Base::ActionCategory
           embeds_many :assignedTo, klass: Model::PersonMember
           embeds_one :creator, klass: Model::PersonMember

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class ContractorEntity < Ecoportal::API::GraphQL::Base::ContractorEntity
+        class ContractorEntity < Base::ContractorEntity
           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

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class Field < Ecoportal::API::GraphQL::Base::Field
+        class Field < Base::Field
         end
       end
     end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class FileAttachment < Ecoportal::API::GraphQL::Base::FileAttachment
+        class FileAttachment < Base::FileAttachment
         end
       end
     end

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

@@ -2,8 +2,8 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class FileContainer < Ecoportal::API::GraphQL::Base::FileContainer
-          embeds_many :fileAttachments, klass: Ecoportal::API::GraphQL::Model::FileAttachment
+        class FileContainer < Base::FileContainer
+          embeds_many :fileAttachments, klass: Model::FileAttachment
         end
       end
     end

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

@@ -2,18 +2,11 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class LocationNode < Ecoportal::API::GraphQL::Base::LocationNode
-          embeds_one :parent, klass: Model::LocationNode, nullable: true
-          embeds_many :ancestors, read_only: true, klass: Model::LocationNode
+        class LocationNode < Base::LocationNode
+          class_resolver :location_node_class, self
 
-          def parentId
-            parent&.id
-          end
-          alias_method :parent_id, :parentId
-
-          def parent_id_upcase
-            parent_id&.upcase
-          end
+          # embeds_one :structure, klass: 'Model::LocationStructure'
+          # embeds_one :enabledLocationCode, klass: 'Model::LocationCode'
         end
       end
     end

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

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Model
+        class LocationStructure
+          class Draft
+            class Structure < Base::LocationStructure::Draft::Structure
+              class_resolver :location_node_class, Model::LocationNode
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Model
+        class LocationStructure
+          class Draft < Base::LocationStructure::Draft
+            class_resolver :structure_class, "Ecoportal::API::GraphQL::Model::LocationStructure::Draft::Structure"
+          end
+        end
+      end
+    end
+  end
+end
+
+require_relative 'draft/structure'

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

@@ -3,10 +3,14 @@ module Ecoportal
     class GraphQL
       module Model
         class LocationStructure < Ecoportal::API::GraphQL::Base::LocationStructure
-          embeds_many :nodes, klass: Model::LocationNode, order_key: :weight
+          class_resolver :location_node_class, Model::LocationNode
+          class_resolver :draft_class, "Model::LocationStructure::Draft"
+
           embeds_one :lastUpdatedBy, klass: "Ecoportal::API::GraphQL::Model::User"
         end
       end
     end
   end
 end
+
+require_relative 'location_structure/draft'

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

@@ -1,9 +1,11 @@
+# rubocop:disable Layout/ArgumentAlignment
+
 module Ecoportal
   module API
     class GraphQL
       module Model
-        class Organization < Ecoportal::API::GraphQL::Base::Organization
-          DEFAULT_PATH = ["currentOrganization"].freeze
+        class Organization < Base::Organization
+          DEFAULT_PATH = ['currentOrganization'].freeze
 
           class << self
             extend Ecoportal::API::Common::GraphQL::QueryIntegration
@@ -12,14 +14,27 @@ module Ecoportal
               DEFAULT_PATH.dup.push(*add)
             end
 
-            query :locationStructure, subpath: "locations", query_klass: "Ecoportal::API::GraphQL::Query::LocationStructure"
-            query :locationStructures, subpath: "locations", query_klass: "Ecoportal::API::GraphQL::Query::LocationStructures"
-            query :contractorEntities, query_klass: "Ecoportal::API::GraphQL::Query::ContractorEntities"
+            query :locationStructure,
+              subpath:     'locations',
+              query_klass: 'Ecoportal::API::GraphQL::Query::LocationStructure'
+            query :locationStructures,
+              subpath:     'locations',
+              query_klass: 'Ecoportal::API::GraphQL::Query::LocationStructures'
+            query :locationDraftById,
+              subpath:     %w[locations structure],
+              query_klass: 'Ecoportal::API::GraphQL::Query::LocationStructure::Draft'
+
+            query :contractorEntities,
+              query_klass: 'Ecoportal::API::GraphQL::Query::ContractorEntities'
             #contractorEntity,
-            query :actionCategories, query_klass: "Ecoportal::API::GraphQL::Query::ActionCategories"
-            query :action, query_klass: "Ecoportal::API::GraphQL::Query::Action"
-            query :actions, query_klass: "Ecoportal::API::GraphQL::Query::Actions"
-            query :archiveAction, query_klass: "Ecoportal::API::GraphQL::Mutation::Action::Archive"
+            query :actionCategories,
+              query_klass: 'Ecoportal::API::GraphQL::Query::ActionCategories'
+            query :action,
+              query_klass: 'Ecoportal::API::GraphQL::Query::Action'
+            query :actions,
+              query_klass: 'Ecoportal::API::GraphQL::Query::Actions'
+            query :archiveAction,
+              query_klass: 'Ecoportal::API::GraphQL::Mutation::Action::Archive'
             #action, actionsByPage, actionsCounter
             #actionCategories
 
@@ -33,3 +48,5 @@ module Ecoportal
     end
   end
 end
+
+# rubocop:enable Layout/ArgumentAlignment

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

@@ -2,7 +2,13 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class Page < Ecoportal::API::GraphQL::Base::Page
+        class Page < Base::Page
+          class_resolver :user_class, 'Ecoportal::API::GraphQL::Model::User'
+          # class_resolver :force_class, 'Ecoportal::API::GraphQL::Model::Force'
+          # class_resolver :theme_class, 'Ecoportal::API::GraphQL::Model::Theme'
+          # class_resolver :template_class, 'Ecoportal::API::GraphQL::Model::Template'
+          # class_resolver :register_class, 'Ecoportal::API::GraphQL::Model::Register'
+          class_resolver :organization_class, 'Ecoportal::API::GraphQL::Model::Organization'
         end
       end
     end

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

@@ -2,9 +2,9 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class PersonMember < Ecoportal::API::GraphQL::Base::PersonMember
+        class PersonMember < Base::PersonMember
           embeds_one :contractorOrganization, klass: "Ecoportal::API::GraphQL::Model::ContractorEntity"
-          embeds_one :account, klass: Ecoportal::API::GraphQL::Model::Account
+          embeds_one :account, klass: Model::Account
 
           # embeds_many :privateFields, enum_class: Ecoportal::API::GraphQL::Model::MemberSchemaFields
           # embeds_many :publicFields, enum_class: Ecoportal::API::GraphQL::Model::MemberSchemaFields

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

@@ -2,9 +2,10 @@ module Ecoportal
   module API
     class GraphQL
       module Model
-        class Resource < Ecoportal::API::GraphQL::Base::Resource
-          embeds_one :page, klass: "Ecoportal::API::GraphQL::Model::Page"
-          embeds_one :field, klass: "Ecoportal::API::GraphQL::Model::Field"
+        class Resource < Base::Resource
+          embeds_one :page, klass: 'Ecoportal::API::GraphQL::Model::Page', read_only: true # PageUnion
+          embeds_one :field, klass: 'Ecoportal::API::GraphQL::Model::Field', read_only: true
+          # embeds_many :stages, klass: 'Ecoportal::API::GraphQL::Model::SimpleStage'
         end
       end
     end

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

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

data/lib/ecoportal/api/graphql/mutation/action/archive.rb

@@ -3,12 +3,12 @@ module Ecoportal
     class GraphQL
       module Mutation
         module Action
-          class Archive < Ecoportal::API::GraphQL::Logic::Mutation
+          class Archive < Logic::Mutation
             field_name :archiveAction
             accepted_params :id
 
-            class_resolver :payload_class, Ecoportal::API::GraphQL::Payload::Action::Archive
-            class_resolver :input_class, Ecoportal::API::GraphQL::Input::Action::Archive
+            class_resolver :payload_class, Payload::Action::Archive
+            class_resolver :input_class, Input::Action::Archive
 
             private
 

data/lib/ecoportal/api/graphql/mutation/action/create.rb

@@ -3,11 +3,11 @@ module Ecoportal
     class GraphQL
       module Mutation
         module Action
-          class Create < Ecoportal::API::GraphQL::Logic::Mutation
+          class Create < Logic::Mutation
             field_name :createAction
 
-            class_resolver :payload_class, Ecoportal::API::GraphQL::Payload::Action::Create
-            class_resolver :input_class, Ecoportal::API::GraphQL::Input::Action::Create
+            class_resolver :payload_class, Payload::Action::Create
+            class_resolver :input_class, Input::Action::Create
 
             private
 

data/lib/ecoportal/api/graphql/mutation/action/update.rb

@@ -3,11 +3,11 @@ module Ecoportal
     class GraphQL
       module Mutation
         module Action
-          class Update < Ecoportal::API::GraphQL::Logic::Mutation
+          class Update < Logic::Mutation
             field_name :updateAction
 
-            class_resolver :payload_class, Ecoportal::API::GraphQL::Payload::Action::Update
-            class_resolver :input_class, Ecoportal::API::GraphQL::Input::Action::Update
+            class_resolver :payload_class, Payload::Action::Update
+            class_resolver :input_class, Input::Action::Update
 
             private