ecoportal-api-graphql 1.3.4 → 1.3.9

data/lib/ecoportal/api/graphql/concerns/data_field_access.rb

@@ -0,0 +1,71 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        # Provides typed data field access on page models.
+        # Include in Interface::BasePage so all concrete page classes inherit it.
+        #
+        # Exposes:
+        #   page.components             — DataField::Collection (v2 compat alias for dataFields)
+        #   page.field_collection       — same, memoized
+        #   page.data_fields_updates    — [DataFieldInput, ...] for dirty fields
+        #   page.data_fields_additions  — [DataFieldInput, ...] for added fields
+        #   page.data_fields_deletions  — [field_id, ...] queued for deletion
+        module DataFieldAccess
+          # Returns a DataField::Collection wrapping raw dataFields from doc.
+          # Memoized — mutating a field object persists across calls.
+          def field_collection
+            @field_collection ||= Base::Page::DataField::Collection.from_doc(raw_data_fields)
+          end
+
+          # v2 compat alias — eco-helpers scripts call entry.components
+          def components
+            field_collection
+          end
+
+          # Returns a SectionCollection wrapping sections from doc.
+          # For BasicPage: doc['sections']. For PhasedPage: merged from stages (override in Phased).
+          def section_collection
+            @section_collection ||= Base::Page::SectionCollection.from_doc(raw_sections)
+          end
+
+          # v2 compat alias — eco-helpers scripts call entry.sections
+          def sections
+            section_collection
+          end
+
+          # Returns DataFieldInput hashes for modified existing fields (updates).
+          def data_fields_updates
+            field_collection.dirty_inputs
+          end
+
+          # Returns DataFieldInput hashes for newly added fields (via components.add).
+          def data_fields_additions
+            field_collection.dirty_additions
+          end
+
+          # Returns field IDs queued for deletion (via components.mark_for_deletion).
+          def data_fields_deletions
+            field_collection.dirty_deletions
+          end
+
+          def data_fields_dirty?
+            field_collection.dirty?
+          end
+
+          private
+
+          # Override in subclasses if fields live elsewhere (e.g. nested in stages).
+          def raw_data_fields
+            doc['dataFields'] || []
+          end
+
+          # Override in subclasses for different section sources.
+          def raw_sections
+            doc['sections'] || []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/concerns/deprecation.rb

@@ -0,0 +1,20 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        module Deprecation
+          SCHEMA_VERSION = '20260605'.freeze
+
+          WARNED = Set.new
+
+          def self.warn_once(key, message)
+            return if WARNED.include?(key)
+
+            WARNED << key
+            warn "[ecoportal-api-graphql] DEPRECATED (#{key}): #{message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/concerns/fragment_definitions.rb

@@ -0,0 +1,68 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        module FragmentDefinitions
+          class << self
+            private
+
+            def included(base)
+              super
+
+              base.send :include, Ecoportal::API::Common::GraphQL::ClassHelpers
+              base.extend ClassMethods
+              base.send :include, InstanceMethods
+            end
+          end
+
+          module ClassMethods
+            def fragment(sym, heredoc)
+              fragments[sym] = heredoc
+            end
+
+            def fragments
+              @fragments ||= {}
+            end
+
+            # Register a sub-namespace class whose fragments are visible via assemble.
+            def register_namespace(klass)
+              namespaces << klass
+            end
+
+            def namespaces
+              @namespaces ||= []
+            end
+
+            # Returns concatenated fragment definition strings for the given symbols.
+            # Searches own fragments and all registered sub-namespaces.
+            def assemble(*syms)
+              all = namespaces.reduce(fragments.dup) { |h, ns| h.merge(ns.fragments) }
+              syms.map { |sym| all[sym] }.compact.join("\n\n")
+            end
+          end
+
+          module InstanceMethods
+            attr_reader :client, :fragments
+
+            def initialize(client)
+              @client = client
+              parse
+            end
+
+            # Returns the raw fragment string for the given symbol.
+            # The namespace parameter is retained for API compatibility but has no effect.
+            def define(sym, heredoc, namespace: nil) # rubocop:disable Lint/UnusedMethodArgument
+              heredoc
+            end
+
+            private
+
+            def parse
+              @fragments = self.class.fragments.dup
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/concerns/page_compat.rb

@@ -0,0 +1,51 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        # v2-compatibility accessors for page model objects.
+        # Include in Interface::BasePage so all concrete page classes inherit them.
+        # These aliases allow eco-helpers scripts to work against GraphQL page models
+        # using the same method names they used with ecoportal-api-v2.
+        module PageCompat
+          # v2 called this externalId (camelCase) or external_id (snake_case)
+          def external_id
+            externalId
+          end
+
+          # v2 called sourceTemplateId "template_id"
+          def template_id
+            sourceTemplateId
+          end
+
+          # v2 compatibility: dataFields were called "components" in APIv2
+          def components
+            respond_to?(:dataFields) ? dataFields : []
+          end
+
+          # Whether the page has any stages (PhasedPage check)
+          def stages?
+            respond_to?(:stages) && !stages.nil? && !stages.empty?
+          end
+
+          # Clears dirty tracking — call after a successful update.
+          # Mirrors v2's ooze.consolidate! which resets the change baseline.
+          def consolidate!
+            @original_doc = doc.dup if respond_to?(:doc)
+            self
+          end
+
+          # v2 validate stub — always returns nil (no client-side validation in GraphQL path).
+          # Server-side errors are returned in the mutation payload's errors field.
+          def validate
+            nil
+          end
+
+          # Dirty check — returns true if there are pending changes.
+          def dirty?
+            !as_update.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/concerns/snake_camel_access.rb

@@ -0,0 +1,60 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        # Provides snake_case access to camelCase methods on GraphQL model objects.
+        # eco-helpers scripts (and v2 models) use snake_case, GraphQL uses camelCase.
+        #
+        # Converts any snake_case method call to its camelCase equivalent and delegates.
+        # Works for both readers (external_id → externalId) and writers (time_zone= → timeZone=).
+        #
+        # Examples:
+        #   page.external_id        → page.externalId
+        #   page.patch_ver          → page.patchVer
+        #   page.source_template_id → page.sourceTemplateId
+        #   page.other_tags = ['x'] → page.otherTags = ['x']
+        module SnakeCamelAccess
+          def method_missing(method_name, *args, &block)
+            str    = method_name.to_s
+            setter = str.end_with?('=')
+            base   = setter ? str[0..-2] : str
+            camel  = snake_to_camel(base)
+
+            # Only intercept if conversion actually changed something and target exists
+            if camel != base
+              target = setter ? :"#{camel}=" : camel.to_sym
+              return send(target, *args, &block) if respond_to?(target)
+            end
+
+            super
+          end
+
+          def respond_to_missing?(method_name, include_private = false)
+            str    = method_name.to_s
+            setter = str.end_with?('=')
+            base   = setter ? str[0..-2] : str
+            camel  = snake_to_camel(base)
+
+            if camel != base
+              target = setter ? :"#{camel}=" : camel.to_sym
+              return true if respond_to?(target, include_private)
+            end
+
+            super
+          end
+
+          private
+
+          # Convert snake_case to lowerCamelCase.
+          # external_id → externalId, source_template_id → sourceTemplateId
+          def snake_to_camel(snake_str)
+            parts = snake_str.split('_')
+            return snake_str if parts.length < 2
+
+            parts[0] + parts[1..].map(&:capitalize).join
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+      end
+    end
+  end
+end
+
+require_relative 'concerns/deprecation'
+require_relative 'concerns/fragment_definitions'
+require_relative 'concerns/snake_camel_access'
+require_relative 'concerns/page_compat'
+require_relative 'concerns/data_field_access'

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

@@ -0,0 +1,11 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Connection
+        class Page < Logic::Connection
+          class_resolver :node_class, 'Ecoportal::API::GraphQL::Model::PageUnion'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Connection
+        class PagesWorkflowCommand < Logic::Connection
+          SCHEMA_VERSION = '20260605'.freeze
+
+          class_resolver :node_class, 'Ecoportal::API::GraphQL::Base::PagesWorkflow::CommandInterface'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Connection
+        class PresetView < Logic::Connection
+          class_resolver :item_class, 'Ecoportal::API::GraphQL::Model::PresetView'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Connection
+        class PreviewPage < Logic::Connection
+          class_resolver :node_class, 'Ecoportal::API::GraphQL::Model::PreviewPage'
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,11 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/graphql/connection/person_member'
-require 'ecoportal/api/graphql/connection/contractor_entity'
-require 'ecoportal/api/graphql/connection/action_category'
-require 'ecoportal/api/graphql/connection/action'
+require_relative 'connection/person_member'
+require_relative 'connection/contractor_entity'
+require_relative 'connection/action_category'
+require_relative 'connection/action'
+require_relative 'connection/page'
+require_relative 'connection/preview_page'
+require_relative 'connection/preset_view'
+require_relative 'connection/pages_workflow_command'

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

@@ -7,6 +7,6 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/graphql/error/locations_validation_error'
-require 'ecoportal/api/graphql/error/validation_errors'
-require 'ecoportal/api/graphql/error/locations_error'
+require_relative 'error/locations_validation_error'
+require_relative 'error/validation_errors'
+require_relative 'error/locations_error'

data/lib/ecoportal/api/graphql/file_upload/client.rb

@@ -0,0 +1,181 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'mime/types'
+
+module Ecoportal
+  module API
+    class GraphQL
+      module FileUpload
+        # Orchestrates the full file upload workflow:
+        #
+        #   Step 1 — Get S3 pre-signed credentials via GraphQL
+        #   Step 2 — Upload file directly to S3 (multipart form POST)
+        #   Step 3 — Register the upload with EcoPortal (REST POST /v2/s3/files)
+        #   Step 4 — Poll until the FileContainer is created
+        #
+        # Returns a fileContainerId string on success, suitable for use in
+        # DataField::FileField#file_container_ids= or DataField::ImageGallery#file_container_ids=
+        #
+        # Usage:
+        #   container_id = api.file_upload.upload('/path/to/report.pdf')
+        #   page.components.get_by_name('Attachment').file_container_ids = [container_id]
+        #   api.pages.update(page)
+        #
+        # Requires the gem to have been initialised with email/pass (OAuth Bearer token).
+        class Client
+          POLL_INTERVAL = 2      # seconds between poll attempts
+          POLL_MAX_WAIT = 120    # seconds before giving up
+
+          def initialize(graphql_client)
+            @graphql_client  = graphql_client
+            @http_client     = graphql_client.client.http_client
+            @org_id          = @http_client.org_id
+            @host            = @http_client.host
+          end
+
+          # Upload a file and return the fileContainerId.
+          # Raises RuntimeError on failure.
+          def upload(file_path)
+            raise ArgumentError, "File not found: #{file_path}" unless File.exist?(file_path)
+
+            creds    = fetch_s3_credentials
+            s3_key   = direct_upload_to_storage(file_path, creds)
+            poll_id  = register_upload(file_path, s3_key)
+            poll_for_container_id(poll_id)
+          end
+
+          private
+
+          # Step 1: GraphQL query → S3 presigned credentials
+          def fetch_s3_credentials
+            Query::FileUploadSignature.new(@graphql_client.client).query
+          end
+
+          # Step 2: Direct multipart POST to S3
+          def direct_upload_to_storage(file_path, creds)
+            filename  = File.basename(file_path)
+            s3_key    = "#{creds.upload_prefix}#{filename}"
+            mime_type = detect_mime_type(file_path)
+            endpoint  = URI(creds.endpoint)
+
+            File.open(file_path, 'rb') do |file|
+              Net::HTTP.start(endpoint.host, endpoint.port,
+                              use_ssl: endpoint.scheme == 'https') do |http|
+                boundary = "EcoPortalUpload#{SecureRandom.hex(8)}"
+                body     = build_multipart(boundary, {
+                  s3_key: s3_key, access_key: creds.access_key,
+                  policy: creds.policy, signature: creds.signature,
+                  mime_type: mime_type, filename: filename
+                }, file)
+                request = Net::HTTP::Post.new(endpoint.path.empty? ? '/' : endpoint.path)
+                request['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
+                request.body = body
+                response = http.request(request)
+                raise "S3 upload failed (#{response.code}): #{response.body}" unless response.code.to_i < 300
+              end
+            end
+
+            s3_key
+          end
+
+          # Step 3: Register with EcoPortal backend (REST v2)
+          def register_upload(file_path, s3_key)
+            filename  = File.basename(file_path)
+            mime_type = detect_mime_type(file_path)
+            filesize  = File.size(file_path)
+
+            body     = { filename: filename, filetype: mime_type, filesize: filesize, path: s3_key }
+            response = upload_post('/s3/files', body)
+            raise "File registration failed: #{response.body}" unless response.code.to_i < 300
+
+            JSON.parse(response.body)['id']
+          end
+
+          # Step 4: Poll until FileContainer is created; return fileContainerId
+          def poll_for_container_id(poll_id)
+            deadline = Time.now + POLL_MAX_WAIT
+            loop do
+              raise 'File upload timed out' if Time.now > deadline
+
+              response = upload_get("/s3/files/poll/#{poll_id}")
+              raise "Poll failed: #{response.body}" unless response.code.to_i < 300
+
+              data   = JSON.parse(response.body)
+              status = data['status'] || data.dig('file', 'status')
+
+              return data.dig('file', 'file_container_id') if data['status'] == 'success'
+              raise "File upload failed: #{data.inspect}"  if status == 'failed'
+
+              sleep POLL_INTERVAL
+            end
+          end
+
+          # --- REST helpers (v2 endpoints, Bearer token auth) ---
+
+          def bearer_token
+            @bearer_token ||= @http_client.send(:key_token)
+          end
+
+          def upload_base_url
+            "https://#{@host}/api/v2/#{@org_id}"
+          end
+
+          def upload_get(path)
+            uri     = URI("#{upload_base_url}#{path}")
+            request = Net::HTTP::Get.new(uri)
+            request['Authorization'] = "Bearer #{bearer_token}"
+            request['Accept']        = 'application/json'
+            Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
+          end
+
+          def upload_post(path, body)
+            uri     = URI("#{upload_base_url}#{path}")
+            request = Net::HTTP::Post.new(uri)
+            request['Authorization'] = "Bearer #{bearer_token}"
+            request['Content-Type']  = 'application/json'
+            request['Accept']        = 'application/json'
+            request.body             = JSON.generate(body)
+            Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
+          end
+
+          # --- Multipart builder ---
+
+          def build_multipart(boundary, opts, file_io)
+            parts = {
+              'key'                          => opts[:s3_key],
+              'AWSAccessKeyId'               => opts[:access_key],
+              'policy'                       => opts[:policy],
+              'signature'                    => opts[:signature],
+              'x-amz-server-side-encryption' => 'AES256',
+              'Content-Type'                 => opts[:mime_type]
+            }
+            filename  = opts[:filename]
+            mime_type = opts[:mime_type]
+
+            body = +''
+            parts.each do |name, value|
+              body << "--#{boundary}\r\n"
+              body << "Content-Disposition: form-data; name=\"#{name}\"\r\n\r\n"
+              body << "#{value}\r\n"
+            end
+            # File field last
+            body << "--#{boundary}\r\n"
+            body << "Content-Disposition: form-data; name=\"file\"; filename=\"#{filename}\"\r\n"
+            body << "Content-Type: #{mime_type}\r\n\r\n"
+            body << file_io.read
+            body << "\r\n--#{boundary}--\r\n"
+            body
+          end
+
+          def detect_mime_type(file_path)
+            types = MIME::Types.type_for(file_path)
+            types.first&.to_s || 'application/octet-stream'
+          rescue StandardError
+            'application/octet-stream'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module FileUpload
+      end
+    end
+  end
+end
+
+require_relative 'file_upload/client'

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

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :Action, <<~GRAPHQL
-          fragment on Action {
+          fragment Action on Action {
             id
             altId
             actionCategory {

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

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :ActionCategory, <<~GRAPHQL
-          fragment on Category {
+          fragment ActionCategory on Category {
             id
             name
             value

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

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :ContractorEntity, <<~GRAPHQL
-          fragment on ContractorEntity {
+          fragment ContractorEntity on ContractorEntity {
             id
             externalId
             name

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

@@ -0,0 +1,30 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        # Fields for a Force object, including all bindings needed for scripting.
+        fragment :ForceFields, <<~GRAPHQL
+          fragment ForceFields on Force {
+            id
+            name
+            script
+            customScript
+            globalBindingIds
+            bindings {
+              ... on DataFieldBinding {
+                id
+                name
+                referenceId
+              }
+              ... on SectionBinding {
+                id
+                name
+                referenceId
+              }
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -3,12 +3,12 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :LocationDraft, <<~GRAPHQL
-          fragment on Draft {
+          fragment LocationDraft on Draft {
             id
             name
             notes
             committed
-            createdAt
+            createdAt { dateTime }
             ok
             conflictingIds
             results {

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

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :LocationNode, <<~GRAPHQL
-          fragment on LocationNodeInterface {
+          fragment LocationNode on LocationNodeInterface {
             id
             name
             weight

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

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :LocationsError, <<~GRAPHQL
-          fragment on LocationsError {
+          fragment LocationsError on LocationsError {
             message
             conflictingIds
             validationErrors {