ecoportal-api-graphql 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4546feadd8f75c4df5ee12df6c7777a1e6e149a39df1e0dd774ea9453d52aa2
-  data.tar.gz: 2833d0fafea1d9d5ef7bbdf0812c00578d470ebd1cb126918e7b7a29e33643e4
+  metadata.gz: 2e84ebd7d21833d62b3d0723997bf8cddc8ab5bf69a53197113f25062d041580
+  data.tar.gz: 47e7b4ac0468a82b5548942ee8381fb07e58a60a1adbae7c219aa7259617af6f
 SHA512:
-  metadata.gz: 952bda5933f5e5c0d7b746f627aae46af22d011b58fd3e0c81615141deb4a487926bb6ba829d594b7b1987f5f4bc35aa17084401a9ab88f7cff5f470b38193df
-  data.tar.gz: abd9299ae5f9a915e7fbe372aeeffe30ae6e6132df7d65a880529b6037a5c2d249e19c7e5f982dedd867f8100dd95825f5c87cdc460663232bf49b16dac3921a
+  metadata.gz: a8eb13e8e3f8a6880cc1b4fd6f7e734d0b163f0eaba42fbc503e297e1e76833420b37f05dc598865aca43553109d6bc4316df1c8a504b41667f8c0fabacaa6b7
+  data.tar.gz: d5931f5c1c5eba0102dae8da2745ce415159a861f61259e850978bf1fe38b4f342494553701d0521bcf353a2172266ec8c77b826fccac560ccd0490fe0d35806

data/CHANGELOG.md

@@ -1,12 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.1.6] - 2022-09-xx
+## [0.1.8] - 2022-09-xx
 
 ### Added
-
-### Changed
-
+### Changed  
 ### Fixed
 
 ### ToDo
@@ -16,6 +14,22 @@ All notable changes to this project will be documented in this file.
     - Analyse how to "DSL" currentOrganization.action.activities
       - review `path` tracking
 
+## [0.1.7] - 2022-09-23
+
+### Added
+  - `currentOrganization.tagTrees` query
+
+### Changed
+  - **upgraded** `ecoportal-api-v2` gem dependency
+  - Restructured the `Query` inheritance chain to make things simpler
+
+### Fixed
+
+## [0.1.6] - 2022-09-19
+
+### Fixed
+  - Call to **private** method `remove_const` in `Ecoportal::API::GraphQL::Fragment#define`
+
 ## [0.1.5] - 2022-09-19
 
 ### Added

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.8.31', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.33', '< 0.9'
   spec.add_dependency 'graphlient',       '>= 0.6.0', '< 0.7'
 end

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

@@ -27,15 +27,41 @@ module Ecoportal
             def slice_params(kargs)
               kargs.slice(*accepted_params)
             end
+
+            # Used to obtain the full `path` in the GraphQL query by using `base_path`
+            # @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
           end
 
           class_resolver :item_class, GenericItem
           attr_reader :client
 
-          def initialize(client)
+          attr_reader :base_path
+
+          def initialize(client, path: nil, base_path: nil)
+            @path        = path
+            @base_path   = base_path
             @client = client
           end
 
+          # Resolves the `path` by using `path` or `base_path` + `class.field_name`.
+          def path(field_name = self.class.field_name)
+            result   = @path
+            result ||= default_path if self.respond_to?(:default_path, true)
+            result ||= (base_path + [field_name]) if base_path && field_name
+            result
+          end
+
+          # Query rely that manages the different blocks.
+          # @return [Class] an object of `response_class` with the results hanving from `path`.
+          def query(path: self.path, **kargs, &block)
+            graphql_query(path: path, **kargs, &basic_block(&block))
+          end
+
           def response_class
             item_class
           end
@@ -44,6 +70,19 @@ module Ecoportal
             path.last
           end
 
+          private
+
+          def graphql_query(path: self.path, **kargs, &block)
+            query_params = self.class.slice_params(kargs)
+            request(*path) do
+              client.query(query_params, &block)
+            end
+          rescue Faraday::ParsingError => e
+            puts "Internal Error with these params:"
+            pp kargs
+            raise
+          end
+
           def request(*path)
             response = yield
             wrap_response(response, path)

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

@@ -0,0 +1,35 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class QueryArray < Ecoportal::API::GraphQL::Base::Query
+          include Enumerable
+
+          def each(item_block: nil, **kargs, &block)
+            return to_enum(:each, **kargs, item_block: connection_block) unless block
+            query(**kargs, &item_block).each do |item|
+              yield(item) if block_given?
+            end
+          end
+
+          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
+            ) do |klass|
+              puts "created class #{klass}: item_class: #{item_class}"
+              klass.klass = item_class
+            end
+          end
+
+          private
+
+          def basic_block
+            raise "Missuse. You have to implement 'basic_block' private method in the child class"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,29 +6,6 @@ module Ecoportal
           accepted_params :searchConf, :after, :before, :first, :last
           include Enumerable
 
-          attr_reader :path
-
-          def initialize(*args, path: default_base_path, **kargs)
-            @path = path
-            super(*args, **kargs)
-          end
-
-          def query(path: default_base_path, **kargs, &block)
-            path ||= default_base_path
-            kargs = self.class.slice_params(kargs)
-            ap = access_point(path)
-            raise "Missuse. You have to implement this method in the child class"
-          end
-
-          def graphql_query(**kargs, &block)
-            query_params = self.class.slice_params(kargs)
-            client.query(query_params, &block)
-          rescue Faraday::ParsingError => e
-            puts "Internal Error with these params:"
-            pp kargs
-            raise
-          end
-
           def each(connection_block: nil, **kargs, &block)
             return to_enum(:each, **kargs, connection_block: connection_block) unless block
             cursor = nil; results = 0
@@ -51,13 +28,9 @@ module Ecoportal
               inherits: Ecoportal::API::GraphQL::Base::Connection,
               namespace: "Ecoportal::API::GraphQL::Connection"
             ) do |klass|
-                klass.item_class = item_class
+              klass.item_class = item_class
             end
           end
-
-          def default_base_path
-            ["currentOrganization"]
-          end
         end
       end
     end

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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,13 @@
+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/base.rb

@@ -13,9 +13,12 @@ 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/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/person_member'
 require 'ecoportal/api/graphql/base/file_attachment'
 require 'ecoportal/api/graphql/base/file_container'

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

@@ -0,0 +1,16 @@
+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/fragment.rb

@@ -27,7 +27,7 @@ module Ecoportal
         end
 
         def define(sym, heredoc, namespace: ::Fragment)
-          namespace.remove_const(sym) if namespace.const?(sym)
+          namespace.send(:remove_const, sym) if namespace.const?(sym)
           client.parse(heredoc).tap do |fragment|
             namespace.const_set(sym, fragment)
             ::Fragment.const_set(sym, fragment) unless namespace == ::Fragment
@@ -47,5 +47,6 @@ module Ecoportal
 end
 
 require 'ecoportal/api/graphql/fragment/pagination'
+require 'ecoportal/api/graphql/fragment/tag_tree_node'
 require 'ecoportal/api/graphql/fragment/action'
 require 'ecoportal/api/graphql/fragment/contractor_entity'

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

@@ -0,0 +1,27 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Helpers
+        module TagTree
+          def treeify(nodes)
+            parents = nodes.each_with_object({}) do |node, parents|
+              (parents[node.parentId] ||= []).push(node)
+            end
+            get_children(nil, parents)
+          end
+
+          private
+
+          def get_children(node_id, parents)
+            (parents[node_id] ||= []).each_with_object([]) do |child, results|
+              results << {
+                "tag" =>   child.tag,
+                "nodes" => get_children(child.id, parents).compact
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Helpers
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/graphql/helpers/tag_tree'

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

@@ -3,41 +3,64 @@ module Ecoportal
     class GraphQL
       module Model
         class Organization < Ecoportal::API::GraphQL::Base::Organization
+          DEFAULT_PATH = ["currentOrganization"]
+
           class << self
-            #userGroup, userGroups,
-            #tagTree, tagTrees,
+            def path(*add)
+              DEFAULT_PATH.dup.push(*add)
+            end
+
+            #userGroup, userGroups
+
+            # @return [Collection::TagTree, Query::TagTrees]
+            def tagTrees(**kargs, &block)
+              if kargs.empty? && !block_given?
+                tagTreesQuery
+              else
+                tagTreesQuery.query(**kargs, &block)
+              end
+            end
+
+            #tagTree
+
             #register, registers
             #personMembers, attachablePersonMembers
             #contractorEntity,
 
             # @return [Connection::ContractorEntity, Query::ContractorEntities]
             def contractorEntities(**kargs, &block)
-              if kargs.empty?
+              if kargs.empty? && !block_given?
                 contractorEntitiesQuery
               else
                 contractorEntitiesQuery.query(**kargs, &block)
               end
             end
 
-            def contractorEntitiesQuery
-              Ecoportal::API::GraphQL::Query::ContractorEntities.new(client)
-            end
-
             # @return [Connection::Action, Query::Actions]
             def actions(**kargs, &block)
-              if kargs.empty?
+              if kargs.empty? && !block_given?
                 actionsQuery
               else
                 actionsQuery.query(**kargs, &block)
               end
             end
 
-            def actionsQuery
-              Ecoportal::API::GraphQL::Query::Actions.new(client)
+            #action, actionsByPage, actionsCounter
+            #actionCategories
+
+            private
+
+            def tagTreesQuery
+              Ecoportal::API::GraphQL::Query::TagTrees.new(client, base_path: path)
             end
 
-            #actionCategories
-            #action, actionsByPage, actionsCounter
+            def contractorEntitiesQuery
+              Ecoportal::API::GraphQL::Query::ContractorEntities.new(client, base_path: path)
+            end
+
+            def actionsQuery
+              Ecoportal::API::GraphQL::Query::Actions.new(client, base_path: path)
+            end
           end
         end
       end

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

@@ -0,0 +1,11 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Model
+        class TagTree < Ecoportal::API::GraphQL::Base::TagTree
+          embeds_many :nodes, klass: Ecoportal::API::GraphQL::Model::TagTreeNode, order_key: :weight
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+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/model.rb

@@ -7,6 +7,8 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/graphql/model/tag_tree_node'
+require 'ecoportal/api/graphql/model/tag_tree'
 require 'ecoportal/api/graphql/model/account'
 require 'ecoportal/api/graphql/model/user'
 require 'ecoportal/api/graphql/model/person_member'

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

@@ -3,20 +3,11 @@ module Ecoportal
     class GraphQL
       module Query
         class Actions < Ecoportal::API::GraphQL::Base::QueryConnection
+          field_name :actions
+
           class_resolver :item_class, Ecoportal::API::GraphQL::Model::Action
           class_resolver :connection_class, Ecoportal::API::GraphQL::Connection::Action
 
-          def query(path: default_base_path, **kargs, &block)
-            path ||= default_base_path
-            request(*path, "actions") do
-              graphql_query(**kargs, &basic_block(&block))
-            end
-          end
-
-          def default_base_path
-            ["currentOrganization"]
-          end
-
           private
 
           def basic_block(&block)

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

@@ -3,21 +3,11 @@ module Ecoportal
     class GraphQL
       module Query
         class ContractorEntities < Ecoportal::API::GraphQL::Base::QueryConnection
+          field_name :contractorEntities
+
           class_resolver :item_class, Ecoportal::API::GraphQL::Model::ContractorEntity
           class_resolver :connection_class, Ecoportal::API::GraphQL::Connection::ContractorEntity
 
-          def query(path: default_base_path, **kargs, &block)
-            path ||= default_base_path
-            #ap = access_point(path)
-            request(*path, "contractorEntities") do
-              graphql_query(**kargs, &basic_block(&block))
-            end
-          end
-
-          def default_base_path
-            ["currentOrganization"]
-          end
-
           private
 
           def basic_block(&block)

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

@@ -0,0 +1,37 @@
+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/lib/ecoportal/api/graphql/query.rb

@@ -7,5 +7,6 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/graphql/query/tag_trees'
 require 'ecoportal/api/graphql/query/actions'
 require 'ecoportal/api/graphql/query/contractor_entities'

data/lib/ecoportal/api/graphql.rb

@@ -29,6 +29,7 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/graphql/helpers'
 require 'ecoportal/api/graphql/base'
 require 'ecoportal/api/graphql/model'
 require 'ecoportal/api/graphql/connection'

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = "0.1.5"
+    GRAPQL_VERSION = "0.1.7"
   end
 end

data/tests/tagtrees_get.rb

@@ -0,0 +1,7 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.31
+        version: 0.8.33
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -140,7 +140,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.31
+        version: 0.8.33
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -214,8 +214,11 @@ files:
 - 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/connection.rb
 - lib/ecoportal/api/graphql/connection/action.rb
@@ -225,6 +228,9 @@ files:
 - lib/ecoportal/api/graphql/fragment/action.rb
 - lib/ecoportal/api/graphql/fragment/contractor_entity.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/input.rb
 - lib/ecoportal/api/graphql/input/create_contractor_entity.rb
 - lib/ecoportal/api/graphql/input/destroy_contractor_entity.rb
@@ -243,6 +249,8 @@ files:
 - 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/payload.rb
 - lib/ecoportal/api/graphql/payload/create_contractor_entity.rb
@@ -251,10 +259,12 @@ files:
 - 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_trees.rb
 - lib/ecoportal/api/graphql_version.rb
 - tests/actions_get.rb
 - tests/contractor_entities_get.rb
 - tests/local_libs.rb
+- tests/tagtrees_get.rb
 homepage: https://www.ecoportal.com
 licenses:
 - MIT