ecoportal-api-graphql 1.3.5 → 1.3.17

data/lib/ecoportal/api/graphql/interface/location_structure/nodes.rb

@@ -1,28 +1,27 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Interface
-        module LocationStructure
-          class Nodes < Logic::BaseModel
-            extend Helpers::LocationsTree
-
-            root!
-
-            class_resolver :location_node_class, Node
-
-            embeds_many :nodes, klass: :location_node_class, order_key: :weight
-
-            def draft?
-              false
-            end
-
-            def treeify
-              self.class.treeify(nodes)
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+        module LocationStructure
+          class Nodes < Logic::BaseModel
+            extend Helpers::LocationsTree
+
+            root!
+
+            class_resolver :location_node_class, Node
+
+            embeds_many :nodes, klass: :location_node_class, order_key: :weight
+
+            def draft?
+              false
+            end
+
+            def treeify
+              self.class.treeify(nodes)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/interface/location_structure.rb

@@ -1,14 +1,14 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Interface
-        module LocationStructure
-        end
-      end
-    end
-  end
-end
-
-require_relative 'location_structure/node'
-require_relative 'location_structure/nodes'
-require_relative 'location_structure/command'
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+        module LocationStructure
+        end
+      end
+    end
+  end
+end
+
+require_relative 'location_structure/node'
+require_relative 'location_structure/nodes'
+require_relative 'location_structure/command'

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

@@ -1,11 +1,11 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Interface
-      end
-    end
-  end
-end
-
-require_relative 'interface/location_structure'
-require_relative 'interface/base_page'
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+      end
+    end
+  end
+end
+
+require_relative 'interface/location_structure'
+require_relative 'interface/base_page'

data/lib/ecoportal/api/graphql/logic/base_model.rb

@@ -1,13 +1,15 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class BaseModel < Ecoportal::API::Common::GraphQL::Model
-          class << self
-            attr_accessor :client
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class BaseModel < Ecoportal::API::Common::GraphQL::Model
+          include Ecoportal::API::GraphQL::Concerns::SnakeCamelAccess
+
+          class << self
+            attr_accessor :client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/logic/base_query.rb

@@ -1,150 +1,193 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class BaseQuery
-          include Ecoportal::API::Common::GraphQL::ClassHelpers
-
-          inheritable_attrs :accepted_params, :param_defaults
-
-          DETAIL_ERRORS = [
-            Faraday::ParsingError,
-            Graphlient::Errors::FaradayServerError,
-            Graphlient::Errors::GraphQLError,
-            Graphlient::Errors::ClientError
-          ].freeze
-
-          class << self
-            def param_defaults
-              @param_defaults ||= {}
-            end
-
-            def accepted_params(*keys, default: :unused)
-              @accepted_params ||= []
-              return @accepted_params if keys.empty?
-
-              keys.map(&:to_sym).uniq.each do |key|
-                @accepted_params   |= [key]
-                param_defaults[key] = default unless default == :unused
-              end
-
-              @accepted_params.push(*keys).tap(&:uniq!)
-              @accepted_params
-            end
-
-            def clear_accepted_params
-              @param_defaults  = {}
-              @accepted_params = []
-            end
-
-            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
-              @field_name
-            end
-
-            def base_path(path = :unused)
-              return @base_path if path == :unused
-
-              path ||= []
-              path   = path.to_s.split('.') if path.is_a?(String)
-              path   = path.map(&:to_s).compact
-
-              @base_path = path
-            end
-          end
-
-          include Ecoportal::API::Common::Concerns::Benchmarkable
-
-          attr_reader :client, :base_path
-
-          def initialize(client, path: nil, base_path: self.class.base_path)
-            @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 respond_to?(:default_path, true)
-            result ||= (base_path + [field_name]) if base_path && field_name
-            result ||= [field_name]
-            result
-          end
-
-          # Query rely that manages the different blocks.
-          # @return [Class] an object of `response_class` with the results hanging from `path`.
-          def query(path: self.path, raw_response: {}, **kargs, &block)
-            print = !is_a?(Mutation)
-
-            benchmarking("#{self.class}##{__method__}", print: print) do
-              graphql_query(
-                path:         path,
-                raw_response: raw_response,
-                **kargs,
-                &basic_block(&block)
-              )
-            end
-          end
-
-          def response_class
-            raise "You should override this method in #{self.class}"
-          end
-
-          def access_point(path = [])
-            path.last
-          end
-
-          private
-
-          def basic_block
-            raise "This method should be implemented in the child class #{self.class}"
-          end
-
-          def graphql_query(path: self.path, raw_response: {}, **kargs, &block)
-            default_params = self.class.param_defaults.dup
-            query_params   = self.class.slice_params(default_params.merge(kargs))
-
-            request(*path) do
-              client.query(**query_params, &block).tap do |response|
-                raw_response[:data] = response
-              end
-            end
-          rescue *DETAIL_ERRORS => _err
-            pp kargs
-            puts "Internal Error with these params:\n"
-            pp query_params
-            pp block
-            raise
-          end
-
-          def request(*path)
-            response = yield
-            wrap_response(response, path)
-          end
-
-          def wrap_response(response, path = [])
-            # we use the Hash, because fragments are persmissioned
-            # see Use of Fragments at https://github.com/ashkan18/graphlient/tree/master?tab=readme-ov-file#use-of-fragments
-            unless (res = response.to_h.dig(*path.dup.unshift('data')))
-              msg = "Complete failure on request. Path: #{path}\n#{response.to_h.pretty_inspect}"
-              raise msg
-            end
-
-            data = Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(res)
-            response_class.new(data)
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class BaseQuery
+          include Ecoportal::API::Common::GraphQL::ClassHelpers
+
+          inheritable_attrs :accepted_params, :param_defaults
+
+          DETAIL_ERRORS = [
+            Ecoportal::API::Common::GraphQL::ResponseError,
+            Ecoportal::API::Common::Client::Error::UnexpectedServerError,
+            Faraday::ParsingError,
+            Graphlient::Errors::FaradayServerError,
+            Graphlient::Errors::GraphQLError,
+            Graphlient::Errors::ClientError
+          ].freeze
+
+          class << self
+            def param_defaults
+              @param_defaults ||= {}
+            end
+
+            def accepted_params(*keys, default: :unused)
+              @accepted_params ||= []
+              return @accepted_params if keys.empty?
+
+              keys.map(&:to_sym).uniq.each do |key|
+                @accepted_params   |= [key]
+                param_defaults[key] = default unless default == :unused
+              end
+
+              @accepted_params.push(*keys).tap(&:uniq!)
+              @accepted_params
+            end
+
+            def clear_accepted_params
+              @param_defaults  = {}
+              @accepted_params = []
+            end
+
+            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
+              @field_name
+            end
+
+            def base_path(path = :unused)
+              return @base_path if path == :unused
+
+              path ||= []
+              path   = path.to_s.split('.') if path.is_a?(String)
+              path   = path.map(&:to_s).compact
+
+              @base_path = path
+            end
+          end
+
+          include Ecoportal::API::Common::Concerns::Benchmarkable
+
+          attr_reader :client, :base_path
+
+          def initialize(client, path: nil, base_path: self.class.base_path)
+            @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 respond_to?(:default_path, true)
+            result ||= (base_path + [field_name]) if base_path && field_name
+            result ||= [field_name]
+            result
+          end
+
+          # Query rely that manages the different blocks.
+          # @return [Class] an object of `response_class` with the results hanging from `path`.
+          def query(path: self.path, raw_response: {}, **kargs, &block)
+            print = !is_a?(Mutation)
+
+            benchmarking("#{self.class}##{__method__}", print: print) do
+              graphql_query(
+                path:         path,
+                raw_response: raw_response,
+                **kargs,
+                &basic_block(&block)
+              )
+            end
+          end
+
+          def response_class
+            raise "You should override this method in #{self.class}"
+          end
+
+          def access_point(path = [])
+            path.last
+          end
+
+          private
+
+          def basic_block
+            raise "This method should be implemented in the child class #{self.class}"
+          end
+
+          # Types that should be passed through as-is as GraphQL variable values.
+          # Anything else that responds to to_h is treated as a serialisable value object.
+          VARIABLE_PRIMITIVES = [
+            ::NilClass, ::TrueClass, ::FalseClass,
+            ::Integer, ::Float, ::String, ::Symbol,
+            ::Hash, ::Array
+          ].freeze
+          private_constant :VARIABLE_PRIMITIVES
+
+          def normalize_variables(kargs)
+            kargs.transform_values do |v|
+              VARIABLE_PRIMITIVES.any? { |t| v.is_a?(t) } || !v.respond_to?(:to_h) ? v : v.to_h
+            end
+          end
+
+          def graphql_query(path: self.path, raw_response: {}, **kargs, &block)
+            default_params = self.class.param_defaults.dup
+            query_params   = self.class.slice_params(normalize_variables(default_params.merge(kargs)))
+
+            query_str    = client.to_query_string(&block)
+            fragment_str = assemble_fragments(query_str)
+            full_query   = fragment_str.empty? ? query_str : "#{query_str}\n\n#{fragment_str}"
+
+            request(*path) do
+              client.http_client.execute(full_query, variables: query_params).tap do |response|
+                raw_response[:data] = response
+              end
+            end
+          rescue *DETAIL_ERRORS => _err
+            pp kargs
+            puts "Internal Error with these params:\n"
+            pp query_params
+            pp block
+            raise
+          end
+
+          def request(*path)
+            response = yield
+            wrap_response(response, path)
+          end
+
+          # Resolves all fragment spreads in query_str, recursively following
+          # spreads inside assembled fragment bodies until no new names are found.
+          # Names that don't resolve to a registered fragment are skipped safely.
+          def assemble_fragments(query_str)
+            tried     = {}
+            assembled = {}
+            pending   = query_str.scan(/\.\.\.(\w+)/).flatten.map(&:to_sym).uniq
+
+            until (unresolved = pending.reject { |n| tried.key?(n) }).empty?
+              unresolved.each do |name|
+                tried[name] = true
+                frag        = Ecoportal::API::GraphQL::Fragment.assemble(name)
+                next if frag.empty?
+
+                assembled[name] = frag
+                pending |= frag.scan(/\.\.\.(\w+)/).flatten.map(&:to_sym)
+              end
+            end
+
+            assembled.values.join("\n\n")
+          end
+
+          def wrap_response(response, path = [])
+            # we use the Hash, because fragments are persmissioned
+            # see Use of Fragments at https://github.com/ashkan18/graphlient/tree/master?tab=readme-ov-file#use-of-fragments
+            unless (res = response.to_h.dig(*path.dup.unshift('data')))
+              msg = "Complete failure on request. Path: #{path}\n#{response.to_h.pretty_inspect}"
+              raise msg
+            end
+
+            data = Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(res)
+            response_class.new(data)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/logic/connection.rb

@@ -1,34 +1,34 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class Connection < Logic::BaseModel
-          class GenericNode
-            def initialize(*_args, **_kargs)
-              raise "Missuse error. You should define a node_class for a class that inherits from GraphqlConnection class."
-            end
-          end
-
-          include Enumerable
-
-          class_resolver :node_class, GenericNode
-
-          passthrough :edges
-          passthrough :totalCount
-          embeds_many :nodes, klass: :node_class
-          embeds_one :pageInfo, klass: Base::PageInfo
-
-          def empty?
-            count < 1
-          end
-
-          def each(&block)
-            return to_enum(:each) unless block
-
-            nodes.each(&block)
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class Connection < Logic::BaseModel
+          class GenericNode
+            def initialize(*_args, **_kargs)
+              raise "Missuse error. You should define a node_class for a class that inherits from GraphqlConnection class."
+            end
+          end
+
+          include Enumerable
+
+          class_resolver :node_class, GenericNode
+
+          passthrough :edges
+          passthrough :totalCount
+          embeds_many :nodes, klass: :node_class
+          embeds_one :pageInfo, klass: Base::PageInfo
+
+          def empty?
+            count < 1
+          end
+
+          def each(&block)
+            return to_enum(:each) unless block
+
+            nodes.each(&block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,11 +1,26 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class Input < Logic::BaseModel
-          passthrough :clientMutationId
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class Input < Logic::BaseModel
+          passthrough :clientMutationId
+
+          class << self
+            # Builds a mutation input hash from a model's diff.
+            # Subclasses override this to reshape fields (e.g. array → IdDiffInput).
+            # @param model [Common::GraphQL::Model] the subject model.
+            # @return [Hash, nil] the mutation input hash, or nil when there are no changes.
+            def from_model(model, client_mutation_id: '')
+              diff = model.as_update
+              return nil if diff.nil?
+
+              diff[:patchVer]         = model.patchVer if model.respond_to?(:patchVer) && !model.patchVer.nil?
+              diff[:clientMutationId] = client_mutation_id unless client_mutation_id.to_s.empty?
+              diff
+            end
+          end
+        end
+      end
+    end
+  end
+end