ecoportal-api-graphql 0.1.11 → 0.2.1

data/tests/loc_structure_update.rb

@@ -0,0 +1,51 @@
+require_relative 'local_libs'
+
+STRUCT_ID = "592642a4ae0c6a00236b110d" # mini test
+# STRUCT_ID = "626745bcba616a001f7e5011" # wcc
+
+api = Ecoportal::API::GraphQL.new
+
+# DESIRED DESIGN: (to review: it might be that draft tree model already stores the commands?)
+# tree = api.currentOrganization.LocationStructure(id: STRUCT_ID)
+# node = tree.node["SYDNEY"]
+# node.name = "Sydney City"
+# tree.node["UPS"].move("AUCKLAND") # or tree.move("UPS", to: "AUCKLAND")
+# tree.node["FFFF."].delete
+# tree.node["UPS"].insert("CHILD", name: "Child").insert("GRAND CHILD", name: "Grand Child")
+# tree.change_commands # => return Ecoportal::API::GraphQL::Input::ApplyCommands
+
+INPUT = {
+  change: {
+    clientMutationId: "",
+    id: STRUCT_ID,
+    commands: [
+      { update: { nodeId: "SYDNEY", name: "Sydney City" } },
+      { move:   { nodeId: "UPS", parentId: "AUCKLAND" } },
+      { archive: { nodeId: "FFFF." } },
+      { insert: { parentId: "UPS", nodeId: "CHILD", name: "Child" } },
+      { insert: { parentId: "CHILD", nodeId: "GRAND CHILD", name: "Grand Child" } }
+    ]
+  },
+  revert: {
+    clientMutationId: "",
+    id: STRUCT_ID,
+    commands: [
+      { update: { nodeId: "SYDNEY", name: "Sydney" } },
+      { move:   { nodeId: "UPS", parentId: "SUB'TAGs" } },
+      { unarchive: { nodeId: "FFFF." } },
+      { archive: { nodeId: "CHILD" } }
+    ]
+  }
+}
+
+operation = :change
+response = api.locationStructure.applyCommands(input: INPUT[operation])
+
+if response.success? && structure = response.structure
+  puts "Applied '#{operation}' changes to '#{structure.name}' structure:"
+  pp structure.treeify
+end
+
+puts "Some more feedback:"
+#pp response.results.as_json
+pp response.results.map(&:as_json)

data/tests/loc_structures_get.rb

@@ -0,0 +1,15 @@
+require_relative 'local_libs'
+
+api = Ecoportal::API::GraphQL.new
+kargs = {
+  includeArchived: false,
+  includeUnpublished: false
+}
+trees = api.currentOrganization.LocationStructures(**kargs)
+trees.each_with_index do |tree, idx|
+  puts "#{tree.weight}. '#{tree.name}' (#{tree.id})"
+end
+
+trees.each do |tree|
+  pp tree.treeify
+end

data/tests/local_libs.rb

@@ -12,8 +12,8 @@ $LOAD_PATH.unshift File.expand_path(api_v2_path)
 #require 'ecoportal/api-v2'
 require File.join(base_dir,'/ecoportal-api-v2/lib/ecoportal/api-v2')
 
-# $LOAD_PATH.unshift File.join(base_dir,'/graphlient/lib')
-# require File.join(base_dir,'/graphlient/lib/graphlient')
+$LOAD_PATH.unshift File.join(base_dir,'/graphlient/lib')
+require File.join(base_dir,'/graphlient/lib/graphlient')
 
 graphql = File.join(base_dir,'/ecoportal-api-graphql/lib')
 $LOAD_PATH.unshift File.expand_path(graphql)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.1
 platform: ruby
 authors:
 - Oscar Segura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,20 +130,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.7
+        version: 1.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.7
+        version: 1.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: graphlient
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: 
+description:
 email:
 - oscar@ecoportal.co.nz
 executables: []
@@ -200,45 +200,62 @@ files:
 - lib/ecoportal/api/graphql/base.rb
 - lib/ecoportal/api/graphql/base/action.rb
 - lib/ecoportal/api/graphql/base/action_category.rb
-- lib/ecoportal/api/graphql/base/connection.rb
 - lib/ecoportal/api/graphql/base/contractor_entity.rb
 - lib/ecoportal/api/graphql/base/date_time.rb
 - lib/ecoportal/api/graphql/base/field.rb
 - lib/ecoportal/api/graphql/base/file_attachment.rb
 - lib/ecoportal/api/graphql/base/file_container.rb
-- lib/ecoportal/api/graphql/base/id_diff_input.rb
+- lib/ecoportal/api/graphql/base/location_node.rb
+- lib/ecoportal/api/graphql/base/location_structure.rb
 - lib/ecoportal/api/graphql/base/model.rb
-- lib/ecoportal/api/graphql/base/mutation.rb
 - lib/ecoportal/api/graphql/base/organization.rb
 - lib/ecoportal/api/graphql/base/page.rb
 - lib/ecoportal/api/graphql/base/page_info.rb
-- lib/ecoportal/api/graphql/base/payload.rb
 - lib/ecoportal/api/graphql/base/person_member.rb
-- lib/ecoportal/api/graphql/base/query.rb
-- lib/ecoportal/api/graphql/base/query_array.rb
-- lib/ecoportal/api/graphql/base/query_connection.rb
 - lib/ecoportal/api/graphql/base/resource.rb
-- lib/ecoportal/api/graphql/base/tag_tree.rb
-- lib/ecoportal/api/graphql/base/tag_tree_node.rb
-- lib/ecoportal/api/graphql/base/validation_errors.rb
+- lib/ecoportal/api/graphql/builder.rb
+- lib/ecoportal/api/graphql/builder/location_structure.rb
 - lib/ecoportal/api/graphql/connection.rb
 - lib/ecoportal/api/graphql/connection/action.rb
 - lib/ecoportal/api/graphql/connection/contractor_entity.rb
 - lib/ecoportal/api/graphql/connection/person_member.rb
+- lib/ecoportal/api/graphql/error.rb
+- lib/ecoportal/api/graphql/error/locations_error.rb
+- lib/ecoportal/api/graphql/error/locations_validation_error.rb
+- lib/ecoportal/api/graphql/error/validation_errors.rb
 - lib/ecoportal/api/graphql/fragment.rb
 - lib/ecoportal/api/graphql/fragment/action.rb
 - lib/ecoportal/api/graphql/fragment/contractor_entity.rb
+- lib/ecoportal/api/graphql/fragment/location_node.rb
 - lib/ecoportal/api/graphql/fragment/pagination.rb
-- lib/ecoportal/api/graphql/fragment/tag_tree_node.rb
 - lib/ecoportal/api/graphql/helpers.rb
-- lib/ecoportal/api/graphql/helpers/tag_tree.rb
+- lib/ecoportal/api/graphql/helpers/locations_tree.rb
 - lib/ecoportal/api/graphql/input.rb
-- lib/ecoportal/api/graphql/input/create_contractor_entity.rb
-- lib/ecoportal/api/graphql/input/destroy_contractor_entity.rb
+- lib/ecoportal/api/graphql/input/contractor_entity.rb
+- lib/ecoportal/api/graphql/input/contractor_entity/create.rb
+- lib/ecoportal/api/graphql/input/contractor_entity/destroy.rb
+- lib/ecoportal/api/graphql/input/contractor_entity/update.rb
+- lib/ecoportal/api/graphql/input/id_diff.rb
+- lib/ecoportal/api/graphql/input/location_structure.rb
+- lib/ecoportal/api/graphql/input/location_structure/apply_commands.rb
+- lib/ecoportal/api/graphql/input/location_structure/archive_command.rb
+- lib/ecoportal/api/graphql/input/location_structure/command_interface.rb
+- lib/ecoportal/api/graphql/input/location_structure/delete_command.rb
+- lib/ecoportal/api/graphql/input/location_structure/insert_command.rb
+- lib/ecoportal/api/graphql/input/location_structure/move_command.rb
+- lib/ecoportal/api/graphql/input/location_structure/reorder_command.rb
+- lib/ecoportal/api/graphql/input/location_structure/unarchive_command.rb
+- lib/ecoportal/api/graphql/input/location_structure/update_command.rb
 - lib/ecoportal/api/graphql/input/search.rb
 - lib/ecoportal/api/graphql/input/search_filter.rb
 - lib/ecoportal/api/graphql/input/search_sorter.rb
-- lib/ecoportal/api/graphql/input/update_contractor_entity.rb
+- lib/ecoportal/api/graphql/logic.rb
+- lib/ecoportal/api/graphql/logic/connection.rb
+- lib/ecoportal/api/graphql/logic/mutation.rb
+- lib/ecoportal/api/graphql/logic/payload.rb
+- lib/ecoportal/api/graphql/logic/query.rb
+- lib/ecoportal/api/graphql/logic/query_array.rb
+- lib/ecoportal/api/graphql/logic/query_connection.rb
 - lib/ecoportal/api/graphql/model.rb
 - lib/ecoportal/api/graphql/model/account.rb
 - lib/ecoportal/api/graphql/model/action.rb
@@ -246,36 +263,45 @@ files:
 - lib/ecoportal/api/graphql/model/field.rb
 - lib/ecoportal/api/graphql/model/file_attachment.rb
 - lib/ecoportal/api/graphql/model/file_container.rb
+- lib/ecoportal/api/graphql/model/location_node.rb
+- lib/ecoportal/api/graphql/model/location_structure.rb
 - lib/ecoportal/api/graphql/model/organization.rb
 - lib/ecoportal/api/graphql/model/page.rb
 - lib/ecoportal/api/graphql/model/person_member.rb
 - lib/ecoportal/api/graphql/model/resource.rb
-- lib/ecoportal/api/graphql/model/tag_tree.rb
-- lib/ecoportal/api/graphql/model/tag_tree_node.rb
 - lib/ecoportal/api/graphql/model/user.rb
 - lib/ecoportal/api/graphql/mutation.rb
-- lib/ecoportal/api/graphql/mutation/create_contractor_entity.rb
+- lib/ecoportal/api/graphql/mutation/contractor_entity.rb
+- lib/ecoportal/api/graphql/mutation/contractor_entity/create.rb
+- lib/ecoportal/api/graphql/mutation/location_structure.rb
+- lib/ecoportal/api/graphql/mutation/location_structure/apply_commands.rb
 - lib/ecoportal/api/graphql/payload.rb
-- lib/ecoportal/api/graphql/payload/create_contractor_entity.rb
-- lib/ecoportal/api/graphql/payload/destroy_contractor_entity.rb
-- lib/ecoportal/api/graphql/payload/update_contractor_entity.rb
+- lib/ecoportal/api/graphql/payload/contractor_entity.rb
+- lib/ecoportal/api/graphql/payload/contractor_entity/create.rb
+- lib/ecoportal/api/graphql/payload/contractor_entity/destroy.rb
+- lib/ecoportal/api/graphql/payload/contractor_entity/update.rb
+- lib/ecoportal/api/graphql/payload/location_structure.rb
+- lib/ecoportal/api/graphql/payload/location_structure/apply_commands.rb
+- lib/ecoportal/api/graphql/payload/location_structure/command_execution_result.rb
+- lib/ecoportal/api/graphql/payload/location_structure/command_interface.rb
 - lib/ecoportal/api/graphql/query.rb
 - lib/ecoportal/api/graphql/query/actions.rb
 - lib/ecoportal/api/graphql/query/contractor_entities.rb
-- lib/ecoportal/api/graphql/query/tag_tree.rb
-- lib/ecoportal/api/graphql/query/tag_trees.rb
+- lib/ecoportal/api/graphql/query/location_structure.rb
+- lib/ecoportal/api/graphql/query/location_structures.rb
 - lib/ecoportal/api/graphql_version.rb
 - tests/actions_get.rb
 - tests/contractor_entities_get.rb
-- tests/create_contractor_entity.rb
+- tests/contractor_entity_create.rb
+- tests/loc_structure_get.rb
+- tests/loc_structure_update.rb
+- tests/loc_structures_get.rb
 - tests/local_libs.rb
-- tests/tagtree_get.rb
-- tests/tagtrees_get.rb
 homepage: https://www.ecoportal.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -290,8 +316,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal GraphQL API
 test_files: []

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

@@ -1,20 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        class TagTree < Ecoportal::API::GraphQL::Base::Model
-          extend Ecoportal::API::GraphQL::Helpers::TagTree
-
-          passkey :id
-          passthrough :name
-          passboolean :visitorManagementEnabled
-          embeds_many :nodes, klass: Ecoportal::API::GraphQL::Base::TagTreeNode, order_key: :weight
-
-          def treeify
-            self.class.treeify(nodes)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        class TagTreeNode < Ecoportal::API::GraphQL::Base::Model
-          passkey :id
-          passthrough :tag, :parent, :parentId
-          passboolean :enabledLocationCode
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        fragment :TagTreeNode, <<~'GRAPHQL'
-          fragment on TagTreeNode {
-            id
-            parentId
-            tag
-            weight
-          }
-        GRAPHQL
-      end
-    end
-  end
-end

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

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

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

@@ -1,11 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Input
-        class DestroyContractorEntity < Ecoportal::API::GraphQL::Base::Model
-          passkey :id
-        end
-      end
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Model
-        class TagTreeNode < Ecoportal::API::GraphQL::Base::TagTreeNode
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Mutation
-        class CreateContractorEntity < Ecoportal::API::GraphQL::Base::Mutation
-          field_name :createContractorEntity
-
-          #class_resolver :item_class, Ecoportal::API::GraphQL::Model::ContractorEntity
-          class_resolver :payload_class, Ecoportal::API::GraphQL::Payload::CreateContractorEntity
-
-          private
-
-          def basic_block(&block)
-            payload_block = block || default_payload_block
-            Proc.new {
-              mutation(input: :CreateContractorEntityInput!) {
-                createContractorEntity(input: :input, &payload_block)
-              }
-            }
-          end
-
-          def default_payload_block
-            Proc.new {
-              clientMutationId
-              errors {
-                details
-                fullMessages
-              }
-              item {
-                ___Fragment__ContractorEntity
-              }
-            }
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Payload
-        class CreateContractorEntity < Ecoportal::API::GraphQL::Base::Payload
-          class_resolver :item_class, "Ecoportal::API::GraphQL::Model::ContractorEntity"
-        end
-      end
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Payload
-        class DestroyContractorEntity < Ecoportal::API::GraphQL::Payload::CreateContractorEntity
-        end
-      end
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Payload
-        class UpdateContractorEntity < Ecoportal::API::GraphQL::Payload::CreateContractorEntity
-        end
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Query
-        class TagTrees < Ecoportal::API::GraphQL::Base::QueryArray
-          field_name :tagTrees
-          
-          class_resolver :item_class, Ecoportal::API::GraphQL::Model::TagTree
-
-          private
-
-          def basic_block(&block)
-            final_block = block || default_tree_block
-            Proc.new {
-              query {
-                currentOrganization {
-                  tagTrees(&final_block)
-                }
-              }
-            }
-          end
-
-          def default_tree_block
-            Proc.new {
-              id
-              name
-              visitorManagementEnabled
-              nodes {
-                ___Ecoportal__API__GraphQL__Fragment__TagTreeNode
-              }
-            }
-          end
-        end
-      end
-    end
-  end
-end

data/tests/tagtree_get.rb

@@ -1,7 +0,0 @@
-require_relative 'local_libs'
-
-api = Ecoportal::API::GraphQL.new
-api.currentOrganization.tagTree(id: "6154d517860cb700112b7c99").tap do |tree|
-  puts "'#{tree.name}' (#{tree.id})"
-  pp tree.treeify
-end

data/tests/tagtrees_get.rb

@@ -1,7 +0,0 @@
-require_relative 'local_libs'
-
-api = Ecoportal::API::GraphQL.new
-api.currentOrganization.tagTrees.each_with_index do |tree, idx|
-  puts "#{idx+1}. '#{tree.name}' (#{tree.id})"
-  pp tree.treeify
-end