ecoportal-api-graphql 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b3cd9bc9cd023b6bf5d146de136fbdd617fea7f60d9f12a01abdb7ba87645e2
-  data.tar.gz: fe14a47cf34fb401a5e563fbc4c30bfdb392d2f3129e841ff89bb8f06076f3d5
+  metadata.gz: 76cdada612c878305f9e858213257fc1a9f92ebc2997ed71295b81e987344cb3
+  data.tar.gz: 9554e3751ad19aa4de5b66d4d949f8fd77d9e5ad63c15ad2b17c1806e02d5c8b
 SHA512:
-  metadata.gz: 8a3c50b23152c2c7acd777139c616d6087e83bc91a69864a54085bbf1beb64861cbf0fecbaa4d23e059fa7f814a52a5bc6f376b76434e6dea09014ed26c19616
-  data.tar.gz: 07b0ba2a2c94e0d058e105d655697aaf6ea9cfeed6c2eb71b8ded614dcb0eb282cf9ded815e83bfff9a9fa2ef4eb97c68bd0b70476ac1cfef415588c1c8099c3
+  metadata.gz: d5f0a0fcf7e9e123ec91387f07084e0d92bebe6e5ec4d642a2a1906b382e4eeece58caeac8543938ebb04da22bf67f8eb89082e7062b2b7f990f81674f0dbb5e
+  data.tar.gz: 8dee0453e5d49178e107bc567ceb93d5150cfd0e2f024a1db3e36e928718f3dece27bdceb2c17a2fe10bb34e6bec62bd217d62ed490f18f3ea2eb9aa92983c08

data/.gitignore

@@ -19,3 +19,4 @@ Gemfile.lock
 # rspec failure tracking
 .rspec_status
 scratch.rb
+tests/.byebug_history

data/CHANGELOG.md

@@ -1,10 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.1.9] - 2022-09-xx
+## [0.1.10] - 2022-09-xx
 
 ### Added
-### Changed  
+### Changed
 ### Fixed
 
 ### ToDo
@@ -14,6 +14,25 @@ All notable changes to this project will be documented in this file.
     - Analyse how to "DSL" currentOrganization.action.activities
       - review `path` tracking
 
+## [0.1.10] - 2022-09-29
+
+### Changed
+  - **upgraded** `ecoportal-api-v2` gem dependency
+
+### Fixed
+  - Remove debugging message
+
+## [0.1.9] - 2022-09-26
+
+### Added
+  - `Ecoportal::API::GraphQL::Query::TagTree`
+
+### Changed
+  - **upgraded** `ecoportal-api-v2` gem dependency
+  - added `Ecoportal::API::Common::GraphQL::QueryIntegration`
+    - restructured `Ecoportal::API::GraphQL::Model::Organization` class
+  - **Patch** on `Graphlient::Query` for fragments support (**pull request**: https://github.com/ashkan18/graphlient/pull/94)
+
 ## [0.1.8] - 2022-09-23
 
 ### Added
@@ -23,8 +42,6 @@ All notable changes to this project will be documented in this file.
   - **upgraded** `ecoportal-api-v2` gem dependency
   - Restructured the `Query` inheritance chain to make things simpler
 
-### Fixed
-
 ## [0.1.6] - 2022-09-19
 
 ### Fixed

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

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

@@ -1,11 +1,33 @@
 module Graphlient
   class Query
+    FRAGMENT_DEFITION = /___(?<const>[A-Z][a-zA-Z0-9_]*(__[A-Z][a-zA-Z0-9_]*)*)/
+
+    def initialize(&block)
+      @indents = 0
+      @query_str = ''
+      @variables = []
+      evaluate(&block)
+    end
+
     private
 
-    def append_node(node, args, arg_processor: nil, &block)
-      if node.to_s.start_with?("___")
-        node = node.to_s.gsub("___", "...").gsub("__", "::").to_sym
+    def evaluate(&block)
+      @last_block = block || self
+      (@context ||= {})[@last_block] ||= @last_block.binding
+      instance_eval(&block)
+    end
+
+    def resolve_fragment_constant(value)
+      return nil unless (match = value.to_s.match(FRAGMENT_DEFITION))
+      raw_const = match[:const].gsub('__', '::')
+      @context[@last_block].eval(raw_const).tap do |const|
+        msg = "Expected constant #{raw_const} to be GraphQL::Client::FragmentDefinition. Given #{const.class}"
+        raise Graphlient::Errors::Error, msg unless const.is_a? GraphQL::Client::FragmentDefinition
       end
+    end
+
+    def append_node(node, args, arg_processor: nil, &block)
+      node = "...#{resolve_fragment_constant(node)}".to_sym if node.to_s.start_with?('___')
 
       # add field
       @query_str << "\n#{indent}#{node}"
@@ -16,7 +38,7 @@ module Graphlient
       if block_given?
         @indents += 1
         @query_str << '{'
-        instance_eval(&block)
+        evaluate(&block)
         @query_str << '}'
         @indents -= 1
       end

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

@@ -0,0 +1,41 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        module QueryIntegration
+          include Ecoportal::API::Common::GraphQL::ClassHelpers::ClassMethods
+
+          attr_accessor :client
+          attr_reader :path
+
+          # @!macro [attach] query
+          #   @method $1
+          #   The $1 query integration
+          #   @return [Collection::$1, $1]
+          #   @return [Connection::$1, $1]
+          def query(method, query_klass:)
+            method = method.to_sym
+            class_method = "#{method}_query_class".to_sym
+
+            define_method(method) do |**kargs, &block|
+              if kargs.empty? && !block_given?
+                method(class_method).call
+              else
+                method(class_method).call.query(**kargs, &block)
+              end
+            end
+
+            define_method(class_method) do
+              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}"
+                end
+              end.new(client, base_path: path)
+            end
+            private class_method
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,3 +14,4 @@ require 'ecoportal/api/common/graphql/class_helpers'
 require 'ecoportal/api/common/graphql/doc_helpers'
 require 'ecoportal/api/common/graphql/hash_helpers'
 require 'ecoportal/api/common/graphql/patches'
+require 'ecoportal/api/common/graphql/query_integration'

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

@@ -18,7 +18,6 @@ module Ecoportal
               item_class,
               inherits: Ecoportal::API::Common::Content::CollectionModel
             ) do |klass|
-              puts "created class #{klass}: item_class: #{item_class}"
               klass.klass = item_class
             end
           end

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

@@ -6,61 +6,24 @@ module Ecoportal
           DEFAULT_PATH = ["currentOrganization"]
 
           class << self
+            extend Ecoportal::API::Common::GraphQL::QueryIntegration
+
             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
+            query :tagTree, query_klass: "Ecoportal::API::GraphQL::Query::TagTree"
+            query :tagTrees, query_klass: "Ecoportal::API::GraphQL::Query::TagTrees"
+            query :contractorEntities, query_klass: "Ecoportal::API::GraphQL::Query::ContractorEntities"
             #contractorEntity,
-
-            # @return [Connection::ContractorEntity, Query::ContractorEntities]
-            def contractorEntities(**kargs, &block)
-              if kargs.empty? && !block_given?
-                contractorEntitiesQuery
-              else
-                contractorEntitiesQuery.query(**kargs, &block)
-              end
-            end
-
-            # @return [Connection::Action, Query::Actions]
-            def actions(**kargs, &block)
-              if kargs.empty? && !block_given?
-                actionsQuery
-              else
-                actionsQuery.query(**kargs, &block)
-              end
-            end
-
+            query :actions, query_klass: "Ecoportal::API::GraphQL::Query::Actions"
             #action, actionsByPage, actionsCounter
             #actionCategories
 
-            private
-
-            def tagTreesQuery
-              Ecoportal::API::GraphQL::Query::TagTrees.new(client, base_path: path)
-            end
-
-            def contractorEntitiesQuery
-              Ecoportal::API::GraphQL::Query::ContractorEntities.new(client, base_path: path)
-            end
+            #userGroup, userGroups
 
-            def actionsQuery
-              Ecoportal::API::GraphQL::Query::Actions.new(client, base_path: path)
-            end
+            #register, registers
+            #personMembers, attachablePersonMembers
           end
         end
       end

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

@@ -0,0 +1,38 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Query
+        class TagTree < Ecoportal::API::GraphQL::Base::Query
+          accepted_params :id
+          field_name :tagTree
+
+          class_resolver :item_class, Ecoportal::API::GraphQL::Model::TagTree
+
+          private
+
+          def basic_block(&block)
+            final_block = block || default_tree_block
+            Proc.new {
+              query(id: :id!) {
+                currentOrganization {
+                  tagTree(id: :id, &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,6 +7,7 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/graphql/query/tag_tree'
 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_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = "0.1.8"
+    GRAPQL_VERSION = "0.1.10"
   end
 end

data/tests/local_libs.rb

@@ -1,3 +1,4 @@
+require 'byebug'
 base_dir = 'C:/ruby_scripts/git'
 
 api_path   = File.join(base_dir,'/ecoportal-api/lib')
@@ -10,8 +11,9 @@ api_v2_path = File.join(base_dir,'/ecoportal-api-v2/lib')
 $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')
-api_path = '../lib'
-$LOAD_PATH.unshift File.expand_path(api_path)
+
+# $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)

data/tests/tagtree_get.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,20 +130,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.33
+        version: 0.9.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.33
+        version: 0.9.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: graphlient
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,7 @@ files:
 - lib/ecoportal/api/common/graphql/http_client.rb
 - lib/ecoportal/api/common/graphql/patches.rb
 - lib/ecoportal/api/common/graphql/patches/query.rb
+- lib/ecoportal/api/common/graphql/query_integration.rb
 - lib/ecoportal/api/graphql.rb
 - lib/ecoportal/api/graphql/base.rb
 - lib/ecoportal/api/graphql/base/action.rb
@@ -259,11 +260,13 @@ 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_tree.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/tagtree_get.rb
 - tests/tagtrees_get.rb
 homepage: https://www.ecoportal.com
 licenses: