ecoportal-api-graphql 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ba83146627efb03fc8dff405390cafd4f5cfdb4ad2f3bc4411a49d42d8a259
-  data.tar.gz: 7be60f892e80c06418312fe6f566cc57b7f8c23bd45ebc339305439df8e5ca80
+  metadata.gz: b4546feadd8f75c4df5ee12df6c7777a1e6e149a39df1e0dd774ea9453d52aa2
+  data.tar.gz: 2833d0fafea1d9d5ef7bbdf0812c00578d470ebd1cb126918e7b7a29e33643e4
 SHA512:
-  metadata.gz: 59d820cad74807d561595cb157d92ec16094a028c1354501c8e5ea43efc4f962cee87f10bb0689055acd81839902319db4903bcd5ce8b4c1bbd84f97ff1fd2a2
-  data.tar.gz: e60dea5941855d499dbdaa60f2f835607612560a11b047623adbbd5f71a646492c37df234d265ac05a932bd3e784194ac921580329b35b1aaf5a1e418b5b2af6
+  metadata.gz: 952bda5933f5e5c0d7b746f627aae46af22d011b58fd3e0c81615141deb4a487926bb6ba829d594b7b1987f5f4bc35aa17084401a9ab88f7cff5f470b38193df
+  data.tar.gz: abd9299ae5f9a915e7fbe372aeeffe30ae6e6132df7d65a880529b6037a5c2d249e19c7e5f982dedd867f8100dd95825f5c87cdc460663232bf49b16dac3921a

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.1.4] - 2022-09-xx
+## [0.1.6] - 2022-09-xx
 
 ### Added
 
@@ -16,6 +16,21 @@ All notable changes to this project will be documented in this file.
     - Analyse how to "DSL" currentOrganization.action.activities
       - review `path` tracking
 
+## [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
 

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/base/query_connection.rb

@@ -20,12 +20,21 @@ module Ecoportal
             raise "Missuse. You have to implement this method in the child class"
           end
 
-          def each(**kargs, &block)
-            return to_enum(:each, **kargs) unless block
+          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
             loop do
               kargs.update(after: cursor) if cursor
-              connection = query(**kargs)
+              connection = query(**kargs, &connection_block)
               #total    = connection.totalCount
               pageInfo = connection.pageInfo
               connection.nodes.each do |item|

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.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

@@ -8,10 +8,8 @@ module Ecoportal
 
           def query(path: default_base_path, **kargs, &block)
             path ||= default_base_path
-            kargs = self.class.slice_params(kargs)
             request(*path, "actions") do
-              next client.query(kargs, &basic_block(&block)) if block_given?
-              client.query(kargs, &basic_block)
+              graphql_query(**kargs, &basic_block(&block))
             end
           end
 
@@ -41,49 +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 {
-                  name
-                  email
-                }
-                dueDate {
-                  dateTime
-                  timeZone
-                }
-                completedAt {
-                  dateTime
-                  timeZone
-                }
-                completer {
-                  name
-                  email
-                }
-                linkedResources {
-                  page {
-                    name
-                    mouldCounter
-                  }
-                  field {
-                    label
-                  }
-                }
+                ___Ecoportal__API__GraphQL__Fragment__Action
               }
             }
           end

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

@@ -8,11 +8,9 @@ module Ecoportal
 
           def query(path: default_base_path, **kargs, &block)
             path ||= default_base_path
-            kargs = self.class.slice_params(kargs)
-            ap = access_point(path)
+            #ap = access_point(path)
             request(*path, "contractorEntities") do
-              next client.query(kargs, &basic_block(&block)) if block_given?
-              client.query(kargs, &basic_block)
+              graphql_query(**kargs, &basic_block(&block))
             end
           end
 
@@ -47,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.3"
+    GRAPQL_VERSION = "0.1.5"
   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.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-15 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