ecoportal-api-graphql 0.1.11 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2fc73626ffb4955b88d20778e32206ad4b989fc47bcc6abbdaf748c035244a6
-  data.tar.gz: c00e9f570f81de6520ef738c8cd059dbfb6d80fe18613599d2a6f7ad53556416
+  metadata.gz: 4dd9eeecfae002b0c6e3324daaaf607a420a659e28c3356ccc4bfccad3585c68
+  data.tar.gz: 4b20881fe6cf9870bc718cbf2d9f0c97d532ea140c9d08278fcf046144aaecae
 SHA512:
-  metadata.gz: 04477f6f4c8014bccd9f1fc93625f031991e0f0bd979af476ec859f1802832726686a06f1dfa665c9d0ec8762d38eb03aa5bb621a51a28112b513b0b80ef7f37
-  data.tar.gz: 249e23c774b1ee031c18d7e53a5be53948c3bf7f5bfffcb2fe4d679a4ab249d81ab59498878a0e2b209720cf6e0b556fef555b0d8dab1bf710be4b2dd243b0d4
+  metadata.gz: e9cec604868b4f55f350b62ad00325c71ca23d3e5c31c7039c2faad7a20d24bcb921ae40eaebc5c89d020862452b1e4d85cb76d0a665b3d65ac87086cc27c061
+  data.tar.gz: 59340e77fd87773691e8581aee13e86f1b7380ecfadc1af8df174a6b64dfc2e2f98f3d6d78ca1ee63d7844918bfd27233bc543fc32107d0cdda820184d2a3384

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.1.13] - 2022-11-xx
+## [0.2.2] - 2022-11-xx
 
 ### Added
 ### Changed
@@ -13,24 +13,27 @@ All notable changes to this project will be documented in this file.
     - Analyse how to "DSL" currentOrganization.action.activities
       - review `path` tracking
 
-## [0.1.12] - 2022-11-xx
+## [0.2.1] - 2023-02-23
 
 ### Added
-  - `Ecoportal::API::GraphQL::Base::Mutation`
-  - Added `createContractorEntity`
 
 ### Changed
-  - Slight internal refactor of `Ecoportal::API::GraphQL::Base::Query`
-  - Upgraded `ecoportal-api-v2` **gem** dependency
+ - Migrate from TagTrees to **reporting structures** (breaking change)
+
+### Fixed
+
 
-## [0.1.11] - 2022-11-02
+## [0.1.11] - 2022-11-29
 
 ### Added
+  - `Ecoportal::API::GraphQL::Base::Mutation`
+  - Added `createContractorEntity`
+
 ### Changed
   - **upgraded** `graphlient` gem dependency (support for framents)
     - removed patch in this gem
-
-### Fixed
+  - Slight internal refactor of `Ecoportal::API::GraphQL::Base::Query`
+  - Upgraded `ecoportal-api-v2` **gem** dependency
 
 ## [0.1.10] - 2022-09-29
 

data/ecoportal-api-graphql.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
   spec.add_development_dependency "pry"      , ">= 0.14"
 
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.9.7', '< 0.10'
+  spec.add_dependency 'ecoportal-api-v2', '>= 1.0.1', '< 1.1'
   spec.add_dependency 'graphlient',       '>= 0.7.0', '< 0.8'
 end

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

@@ -13,7 +13,7 @@ module Ecoportal
           #   The $1 query integration
           #   @return [Collection::$1, $1]
           #   @return [Connection::$1, $1]
-          def query(method, query_klass:)
+          def query(method, query_klass:, subpath: [])
             method = method.to_sym
             class_method = "#{method}_query_class".to_sym
 
@@ -26,11 +26,12 @@ module Ecoportal
             end
 
             define_method(class_method) do
+              final_path = path + [subpath].flatten.compact
               resolve_class(query_klass).tap do |klass|
-                unless klass <= Ecoportal::API::GraphQL::Base::Query
-                  raise "Expected query_klass to be of type Ecoportal::API::GraphQL::Base::Query. Given: #{klass}"
+                unless klass <= Ecoportal::API::GraphQL::Logic::Query
+                  raise "Expected query_klass to be of type Ecoportal::API::GraphQL::Logic::Query. Given: #{klass}"
                 end
-              end.new(client, base_path: path)
+              end.new(client, base_path: final_path)
             end
             private class_method
           end

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

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class LocationNode < Ecoportal::API::GraphQL::Base::Model
+          passkey :id
+          passthrough :name, :parent, :parentId
+          passthrough :weight
+          embeds_one :parent, klass: Base::LocationNode, nullable: true
+          passboolean :archived
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class LocationStructure < Ecoportal::API::GraphQL::Base::Model
+          extend Ecoportal::API::GraphQL::Helpers::LocationsTree
+
+          passkey :id
+          passthrough :name, :weight
+          passboolean :archived, :published, :visitorManagementEnabled
+          embeds_many :nodes, klass: Ecoportal::API::GraphQL::Base::LocationNode, order_key: :weight
+          passthrough :draft
+
+          def treeify
+            self.class.treeify(nodes)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,17 +9,9 @@ end
 
 require 'ecoportal/api/graphql/base/model'
 require 'ecoportal/api/graphql/base/date_time'
-require 'ecoportal/api/graphql/base/id_diff_input'
 require 'ecoportal/api/graphql/base/page_info'
-require 'ecoportal/api/graphql/base/query'
-require 'ecoportal/api/graphql/base/mutation'
-require 'ecoportal/api/graphql/base/connection'
-require 'ecoportal/api/graphql/base/query_array'
-require 'ecoportal/api/graphql/base/query_connection'
-require 'ecoportal/api/graphql/base/validation_errors'
-require 'ecoportal/api/graphql/base/payload'
-require 'ecoportal/api/graphql/base/tag_tree_node'
-require 'ecoportal/api/graphql/base/tag_tree'
+require 'ecoportal/api/graphql/base/location_node'
+require 'ecoportal/api/graphql/base/location_structure'
 require 'ecoportal/api/graphql/base/person_member'
 require 'ecoportal/api/graphql/base/file_attachment'
 require 'ecoportal/api/graphql/base/file_container'

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

@@ -0,0 +1,29 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Builder
+        class LocationStructure
+          attr_reader :client
+
+          def initialize(client)
+            @client = client
+          end
+
+          def applyCommandsInput
+            Ecoportal::API::GraphQL::Input::LocationStructure::ApplyCommands.new
+          end
+
+          def applyCommands(**kargs, &block)
+            applyCommandsMutation.query(**kargs, &block)
+          end
+
+          private
+
+          def applyCommandsMutation
+            Ecoportal::API::GraphQL::Mutation::LocationStructure::ApplyCommands.new(client)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Builder
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/graphql/builder/location_structure'

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

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

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

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

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

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

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Error
+        class LocationsError < Ecoportal::API::GraphQL::Base::Model
+          passthrough :message, :conflictingIds
+          passthrough :type
+          embeds_many :validationErrors, klass: Ecoportal::API::GraphQL::Error::LocationsValidationError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Error
+        class LocationsValidationError < Ecoportal::API::GraphQL::Base::Model
+          passthrough :error, :message, :property
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/{base → error}/validation_errors.rb

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class GraphQL
-      module Base
+      module Error
         class ValidationErrors < Ecoportal::API::GraphQL::Base::Model
           include Enumerable
 

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

@@ -0,0 +1,12 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Error
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/graphql/error/locations_validation_error'
+require 'ecoportal/api/graphql/error/validation_errors'
+require 'ecoportal/api/graphql/error/locations_error'

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

@@ -0,0 +1,20 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :LocationNode, <<~'GRAPHQL'
+          fragment on LocationNodeInterface {
+            id
+            name
+            weight
+            archived
+            parent {
+              id
+              name
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -47,6 +47,6 @@ module Ecoportal
 end
 
 require 'ecoportal/api/graphql/fragment/pagination'
-require 'ecoportal/api/graphql/fragment/tag_tree_node'
+require 'ecoportal/api/graphql/fragment/location_node'
 require 'ecoportal/api/graphql/fragment/action'
 require 'ecoportal/api/graphql/fragment/contractor_entity'

data/lib/ecoportal/api/graphql/helpers/{tag_tree.rb → locations_tree.rb}

@@ -2,10 +2,14 @@ module Ecoportal
   module API
     class GraphQL
       module Helpers
-        module TagTree
+        module LocationsTree
           def treeify(nodes)
             parents = nodes.each_with_object({}) do |node, parents|
-              (parents[node.parentId] ||= []).push(node)
+              parent   = node.parent
+              # puts "Node '#{node.name}' with ID: '#{node.id}'. "
+              # puts "  • Parent '#{parent.name}' with ID: '#{parent.id}'." if parent
+              parentId = parent && parent.id.upcase
+              (parents[parentId] ||= []).push(node)
             end
             get_children(nil, parents)
           end
@@ -15,7 +19,10 @@ module Ecoportal
           def get_children(node_id, parents)
             (parents[node_id] ||= []).each_with_object([]) do |child, results|
               results << {
-                "tag" =>   child.tag,
+                "id"    => child.id,
+                "name"  => child.name,
+                "weight" => child.weight,
+                "archived" => child.archived,
                 "nodes" => get_children(child.id, parents).compact
               }
             end

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

@@ -7,4 +7,4 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/graphql/helpers/tag_tree'
+require 'ecoportal/api/graphql/helpers/locations_tree'

data/lib/ecoportal/api/graphql/input/contractor_entity/create.rb

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module ContractorEntity
+          class Create < Ecoportal::API::GraphQL::Base::ContractorEntity
+            passthrough :clientMutationId
+            class_resolver :id_diff_input, "Ecoportal::API::GraphQL::Input::IdDiff"
+            embeds_one :associatedPeopleIds, klass: :id_diff_input
+            embeds_one :leadContractorIds, klass: :id_diff_input
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/contractor_entity/destroy.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module ContractorEntity
+          class Destroy < Ecoportal::API::GraphQL::Base::Model
+            passkey :id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/{update_contractor_entity.rb → contractor_entity/update.rb}

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       module Input
-        class UpdateContractorEntity < Ecoportal::API::GraphQL::Input::CreateContractorEntity
+        class Update < Ecoportal::API::GraphQL::Input::ContractorEntity::Create
         end
       end
     end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module ContractorEntity
+        end
+      end
+    end
+  end
+end
+
+require_relative 'contractor_entity/create'
+require_relative 'contractor_entity/destroy'
+require_relative 'contractor_entity/update'

data/lib/ecoportal/api/graphql/{base/id_diff_input.rb → input/id_diff.rb}

@@ -1,8 +1,8 @@
 module Ecoportal
   module API
     class GraphQL
-      module Base
-        class IdDiffInput < Ecoportal::API::GraphQL::Base::Model
+      module Input
+        class IdDiff < Ecoportal::API::GraphQL::Base::Model
           passarray :additions, :removals
         end
       end

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

@@ -0,0 +1,48 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class ApplyCommands < Ecoportal::API::GraphQL::Base::Model
+            passkey :id
+            passthrough :clientMutationId
+            passboolean :force
+            embeds_many :commands, klass: Ecoportal::API::GraphQL::Input::LocationStructure::CommandInterface
+            passboolean :preview
+
+            def add(type, **kargs)
+              if command = new_command(type)
+                command.set_values(**kargs) unless kargs.empty?
+                yield(command) if block_given?
+              end
+              command
+            end
+
+            private
+
+            def new_command(type)
+              case type
+              when :archive
+                Input::LocationStructure::ArchiveCommand.new
+              when :unarchive
+                Input::LocationStructure::UnarchiveCommand.new
+              when :delete
+                Input::LocationStructure::DeleteCommand.new
+              when :move
+                Input::LocationStructure::MoveCommand.new
+              when :insert
+                Input::LocationStructure::InsertCommand.new
+              when :update
+                Input::LocationStructure::UpdateCommand.new
+              when :reoder
+                Input::LocationStructure::ReoderCommand.new
+              else
+                raise "Unknown command type: '#{type}'"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/archive_command.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class ArchiveCommand < Ecoportal::API::GraphQL::Input::LocationStructure::CommandInterface
+            passthrough :nodeId
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/command_interface.rb

@@ -0,0 +1,26 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class CommandInterface < Ecoportal::API::GraphQL::Base::Model
+            passkey :id
+            passthrough :state
+
+            def initialize(*args, **kargs, &block)
+              self.id = self.class.new_uuid
+              super
+            end
+
+            def set_values(**kargs)
+              kargs.each do |key, value|
+                self.send(key, value) if self.respond_to?(key, true)
+              end
+              self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/delete_command.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class DeleteCommand < Ecoportal::API::GraphQL::Input::LocationStructure::CommandInterface
+            passthrough :nodeId
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/insert_command.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class InsertCommand < Ecoportal::API::GraphQL::Input::LocationStructure::MoveCommand
+            passthrough :classificationIds
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/move_command.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class MoveCommand < Ecoportal::API::GraphQL::Input::LocationStructure::CommandInterface
+            passthrough :nodeId, :parentId
+            passthrough :insertBefore
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/reorder_command.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class ReorderCommand < Ecoportal::API::GraphQL::Input::LocationStructure::CommandInterface
+            passthrough :parentId, :orderedIds
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/unarchive_command.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class UnarchiveCommand < Ecoportal::API::GraphQL::Input::LocationStructure::CommandInterface
+            passthrough :nodeId
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/location_structure/update_command.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+          class UpdateCommand < Ecoportal::API::GraphQL::Input::LocationStructure::CommandInterface
+            passthrough :nodeId, :newId
+            passthrough :name, :classificationIds
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module LocationStructure
+        end
+      end
+    end
+  end
+end
+
+require_relative 'location_structure/command_interface'
+require_relative 'location_structure/delete_command'
+require_relative 'location_structure/archive_command'
+require_relative 'location_structure/unarchive_command'
+require_relative 'location_structure/move_command'
+require_relative 'location_structure/insert_command'
+require_relative 'location_structure/reorder_command'
+require_relative 'location_structure/update_command'
+require_relative 'location_structure/apply_commands'

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

@@ -7,9 +7,9 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/graphql/input/id_diff'
 require 'ecoportal/api/graphql/input/search_filter'
 require 'ecoportal/api/graphql/input/search_sorter'
 require 'ecoportal/api/graphql/input/search'
-require 'ecoportal/api/graphql/input/create_contractor_entity'
-require 'ecoportal/api/graphql/input/update_contractor_entity'
-require 'ecoportal/api/graphql/input/destroy_contractor_entity'
+require 'ecoportal/api/graphql/input/location_structure'
+require 'ecoportal/api/graphql/input/contractor_entity'

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

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class GraphQL
-      module Base
+      module Logic
         class Connection < Ecoportal::API::GraphQL::Base::Model
           class GenericNode
             def initialize(*args, **kargs)