ecoportal-api-graphql 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ebcd32d52a269e3f9b9348fdb9e3ca80b3c07a75872e67759d978cd57c233d2
-  data.tar.gz: 80bbb9bbaa4a8a420b028cb3f5d4f1685621e176a239710024cede3ab12eed87
+  metadata.gz: 7c0e5dcda795491dd4687054d51f9b3888f707f320ed079742c54cbde74464ad
+  data.tar.gz: ab434f8f1f410692b0ac8f4a3cd549293045e17e469b2b09a14c1fbe85123f06
 SHA512:
-  metadata.gz: cdbb369046537a6916711f0bbae1cb7a4edd443c6ce19e97bcc529eb6eab72805dd16714aa5a6d165da6690d46d9a0e28e406d036551a6c51b787fd3f44addfb
-  data.tar.gz: 0a3f51c9733e66af42edaf63b2c93546cb8ec929fbecfa0dc70a555d9fd846f0228322d2bd85695044e0ac3b875266ae9e3a622f5226d759ebcf1345f287979f
+  metadata.gz: f3d127b631c0c567cd7831d5e1cda50f5474e1d4c262716e000aa324045b2fc228452ed2d968b620b9b58c43000b4526af5d2916e525b81af2c12999e23a00bd
+  data.tar.gz: 5c86f610a220829e975bef5ff3e459801247a7cda07368dafc2fc2278b81aed8f2535b187b6ee8682d61bc15bfb23ea84c048dac6df48c219d6f4ccb5fff84bd

data/CHANGELOG.md

@@ -1,12 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.1.5] - 2022-09-xx
+## [0.1.7] - 2022-09-xx
 
 ### Added
-
 ### Changed
-
 ### Fixed
 
 ### ToDo
@@ -16,13 +14,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.6] - 2022-09-19
+
+### Fixed
+  - Call to **private** method `remove_const` in `Ecoportal::API::GraphQL::Fragment#define`
+
+## [0.1.5] - 2022-09-19
+
+### Added
+  - Patch `GraphQL::Query#append_node` so we can use Fragments in blocks using `___` as start of the constant, and `__` for namespace separator
+    - Issue/feature request: https://github.com/ashkan18/graphlient/issues/93
+  - `Ecoportal::API::GraphQL::Fragment#define` provided that client scripts can create their own fragments in their own namespace
+    - Exposed `Ecoportal::API::GraphQL#fragments`
+    - It will always (re)define in the `Fragment` root namespace
+
 ## [0.1.4] - 2022-09-16
 
 ### Fixed
   - Able to inject connection block to `each`
   - Error handling delegated to parent class (`QueryConnection`)
   - Retrieve `id` on elements of `Array`
-  
+
 ## [0.1.3] - 2022-09-15
 
 ### Fixed

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

@@ -1,4 +1,3 @@
-require 'graphlient'
 module Ecoportal
   module API
     module Common

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

@@ -19,6 +19,15 @@ module Ecoportal
 
           module ClassMethods
             include Ecoportal::API::Common::Content::ClassHelpers
+
+            def const?(value)
+              begin
+                const_get(value)
+              rescue NameError => e
+                return false
+              end
+              true
+            end            
           end
 
           class << self

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

@@ -0,0 +1,27 @@
+module Graphlient
+  class Query
+    private
+
+    def append_node(node, args, arg_processor: nil, &block)
+      if node.to_s.start_with?("___")
+        node = node.to_s.gsub("___", "...").gsub("__", "::").to_sym
+      end
+
+      # add field
+      @query_str << "\n#{indent}#{node}"
+      # add filter
+      hash_arguments = hash_arg(args)
+      @query_str << "(#{args_str(hash_arguments, arg_processor: arg_processor)})" if hash_arguments
+
+      if block_given?
+        @indents += 1
+        @query_str << '{'
+        instance_eval(&block)
+        @query_str << '}'
+        @indents -= 1
+      end
+
+      @query_str << "\n#{indent}"
+    end
+  end
+end

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

@@ -0,0 +1 @@
+require_relative 'patches/query'

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

@@ -13,3 +13,4 @@ require 'ecoportal/api/common/graphql/client'
 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'

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

@@ -0,0 +1,53 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :Action, <<~'GRAPHQL'
+          fragment on Action {
+            id
+            altId
+            actionCategory {
+              name
+              value
+            }
+            standaloneAction
+            status
+            relativeStatus
+            archived
+            tags
+            name
+            description
+            assignedTo {
+              id
+              name
+              email
+            }
+            createdAt {
+              dateTime
+              timeZone
+            }
+            dueDate {
+              dateTime
+              timeZone
+            }
+            completedAt {
+              dateTime
+              timeZone
+            }
+            completer {
+              name
+              email
+            }
+            linkedResources {
+              id
+              page {
+                name
+                mouldCounter
+              }
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :Pagination, <<~'GRAPHQL'
-          fragment on ContractorEntityConnection {
+          fragment on ActionConnection {
             totalCount
             pageInfo {
               endCursor

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

@@ -1,17 +1,15 @@
+# Namespace to create custom fragments from client scripts
+module Fragment
+  include Ecoportal::API::Common::GraphQL::ClassHelpers
+end
+# Class to define/parse fragments
 module Ecoportal
   module API
     class GraphQL
       class Fragment
-        class << self
-          def const?(value)
-            begin
-              const_get(value)
-            rescue NameError => e
-              return false
-            end
-            true
-          end
+        include Ecoportal::API::Common::GraphQL::ClassHelpers
 
+        class << self
           def fragment(sym, heredoc)
             fragments[sym] = heredoc
           end
@@ -28,17 +26,19 @@ module Ecoportal
           parse
         end
 
+        def define(sym, heredoc, namespace: ::Fragment)
+          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
+          end
+        end
+
         private
 
         def parse
           fragments = self.class.fragments.each_with_object({}) do |(sym, heredoc), out|
-            if self.class.const?(sym)
-              fragment = self.class.get_const(sym)
-            else
-              fragment = client.parse(heredoc)
-              self.class.const_set(sym, fragment)
-            end
-            out[sym] = fragment
+            out[sym] = define(sym, heredoc, namespace: self.class)
           end
         end
       end
@@ -46,5 +46,6 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/graphql/fragment/contractor_entity'
 require 'ecoportal/api/graphql/fragment/pagination'
+require 'ecoportal/api/graphql/fragment/action'
+require 'ecoportal/api/graphql/fragment/contractor_entity'

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

@@ -39,52 +39,9 @@ module Ecoportal
 
           def default_connection_block
             Proc.new {
-              totalCount
-              pageInfo {
-                endCursor
-              }
+              ___Ecoportal__API__GraphQL__Fragment__Pagination
               nodes {
-                id
-                altId
-                actionCategory {
-                  name
-                  value
-                }
-                standaloneAction
-                status
-                relativeStatus
-                archived
-                tags
-                name
-                description
-                assignedTo {
-                  id
-                  name
-                  email
-                }
-                createdAt {
-                  dateTime
-                  timeZone
-                }
-                dueDate {
-                  dateTime
-                  timeZone
-                }
-                completedAt {
-                  dateTime
-                  timeZone
-                }
-                completer {
-                  name
-                  email
-                }
-                linkedResources {
-                  id
-                  page {
-                    name
-                    mouldCounter
-                  }
-                }
+                ___Ecoportal__API__GraphQL__Fragment__Action
               }
             }
           end

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

@@ -45,13 +45,7 @@ module Ecoportal
                 endCursor
               }
               nodes {
-                id
-                name
-                schemaId
-                active
-                approved
-                associatedPeopleIds
-                leadContractorIds
+                ___Ecoportal__API__GraphQL__Fragment__ContractorEntity
               }
             }
           end

data/lib/ecoportal/api/graphql.rb

@@ -5,7 +5,7 @@ module Ecoportal
     class GraphQL
       include Ecoportal::API::Common::GraphQL::ClassHelpers
 
-      attr_reader :client
+      attr_reader :client, :fragments
 
       # Creates a `GraphQL` object to interact with the ecoPortal `GraphQL API`.
       # @param org_id [String] the id of the target organization.

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = "0.1.4"
+    GRAPQL_VERSION = "0.1.6"
   end
 end

data/tests/actions_get.rb

@@ -1,5 +1,4 @@
 require_relative 'local_libs'
-require 'ecoportal/api-graphql'
 
 api = Ecoportal::API::GraphQL.new
 api.currentOrganization.actions.each_with_index do |action, idx|

data/tests/local_libs.rb

@@ -12,3 +12,7 @@ $LOAD_PATH.unshift File.expand_path(api_v2_path)
 require File.join(base_dir,'/ecoportal-api-v2/lib/ecoportal/api-v2')
 api_path = '../lib'
 $LOAD_PATH.unshift File.expand_path(api_path)
+
+graphql = File.join(base_dir,'/ecoportal-api-graphql/lib')
+$LOAD_PATH.unshift File.expand_path(graphql)
+require_relative File.expand_path(File.join(graphql, 'ecoportal/api-graphql'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -194,6 +194,8 @@ files:
 - lib/ecoportal/api/common/graphql/doc_helpers.rb
 - lib/ecoportal/api/common/graphql/hash_helpers.rb
 - 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/graphql.rb
 - lib/ecoportal/api/graphql/base.rb
 - lib/ecoportal/api/graphql/base/action.rb
@@ -220,6 +222,7 @@ files:
 - lib/ecoportal/api/graphql/connection/contractor_entity.rb
 - lib/ecoportal/api/graphql/connection/person_member.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/pagination.rb
 - lib/ecoportal/api/graphql/input.rb