ecoportal-api-graphql 1.3.5 → 1.3.17

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

@@ -0,0 +1,192 @@
+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)
+        #
+        # Step 1 (GraphQL) authenticates via the gem's email/pass OAuth bearer token.
+        # Steps 3-4 (REST v2 `/s3/files`) require the gem to ALSO have been initialised
+        # with `api_key:` — `Ecoportal::API::GraphQL.new(email:, pass:, api_key:)` — since
+        # those endpoints authenticate via `X-ECOPORTAL-API-KEY`, not the GraphQL bearer
+        # token (mirrors `Ecoportal::API::Common::Content::Client#base_request` in
+        # ecoportal-api-v2).
+        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, X-ECOPORTAL-API-KEY auth) ---
+
+          def api_key
+            @api_key ||= @http_client.api_key.tap do |key|
+              if key.nil? || key.to_s.strip.empty?
+                raise 'File upload requires an api_key: Ecoportal::API::GraphQL.new(email:, pass:, api_key:). ' \
+                      'The v2 REST endpoints used to register/poll an upload authenticate via ' \
+                      'X-ECOPORTAL-API-KEY, not the GraphQL OAuth bearer token.'
+              end
+            end
+          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['X-ECOPORTAL-API-KEY'] = api_key
+            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['X-ECOPORTAL-API-KEY'] = api_key
+            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

@@ -1,65 +1,65 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        fragment :Action, <<~GRAPHQL
-          fragment on Action {
-            id
-            altId
-            actionCategory {
-              name
-              value
-            }
-            actionCategoryId
-            standaloneAction
-            status
-            relativeStatus
-            archived
-            locations {
-              id
-              name
-              objectId
-            }
-            name
-            description
-            assignedTo {
-              id
-              name
-              email
-            }
-            createdAt {
-              dateTime
-              timeZone
-            }
-            updatedAt {
-              dateTime
-              timeZone
-            }
-            dueDate {
-              dateTime
-              timeZone
-            }
-            completedAt {
-              dateTime
-              timeZone
-            }
-            completer {
-              name
-              email
-            }
-            linkedResources {
-              id
-              page {
-                ... on BasePageInterface {
-                  id
-                  name
-                  uid
-                }
-              }
-            }
-          }
-        GRAPHQL
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :Action, <<~GRAPHQL
+          fragment Action on Action {
+            id
+            altId
+            actionCategory {
+              name
+              value
+            }
+            actionCategoryId
+            standaloneAction
+            status
+            relativeStatus
+            archived
+            locations {
+              id
+              name
+              objectId
+            }
+            name
+            description
+            assignedTo {
+              id
+              name
+              email
+            }
+            createdAt {
+              dateTime
+              timeZone
+            }
+            updatedAt {
+              dateTime
+              timeZone
+            }
+            dueDate {
+              dateTime
+              timeZone
+            }
+            completedAt {
+              dateTime
+              timeZone
+            }
+            completer {
+              name
+              email
+            }
+            linkedResources {
+              id
+              page {
+                ... on BasePageInterface {
+                  id
+                  name
+                  uid
+                }
+              }
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -1,17 +1,17 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        fragment :ActionCategory, <<~GRAPHQL
-          fragment on Category {
-            id
-            name
-            value
-            archived
-            weight
-          }
-        GRAPHQL
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :ActionCategory, <<~GRAPHQL
+          fragment ActionCategory on Category {
+            id
+            name
+            value
+            archived
+            weight
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -1,20 +1,20 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        fragment :ContractorEntity, <<~GRAPHQL
-          fragment on ContractorEntity {
-            id
-            externalId
-            name
-            schemaId
-            active
-            approved
-            associatedPeopleIds
-            leadContractorIds
-          }
-        GRAPHQL
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :ContractorEntity, <<~GRAPHQL
+          fragment ContractorEntity on ContractorEntity {
+            id
+            externalId
+            name
+            schemaId
+            active
+            approved
+            associatedPeopleIds
+            leadContractorIds
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        # `RegisterPresetView#fieldConfigurations` returns a FieldConfigurationUnion.
+        # Selections can't be made directly on a union (GraphQL error: "Selections can't
+        # be made directly on unions"); the common fields live on FieldConfigurationInterface,
+        # which every union member implements, so they're pulled via an inline fragment on
+        # the interface rather than repeated per concrete type. Verified against the real
+        # frontend fragment (RegisterDataGrid/api/fieldConfigurationFragments/
+        # fieldConfigurationFields.graphql) — kept to the interface surface + the same three
+        # concrete-type extras it selects; other concrete types fall back to interface-only
+        # fields (matches the frontend, which doesn't cover every member either).
+        fragment :FieldConfiguration, <<~GRAPHQL
+          fragment FieldConfiguration on FieldConfigurationUnion {
+            __typename
+            ... on FieldConfigurationInterface {
+              id
+              key
+              name
+              dataFieldLabel
+              weight
+            }
+            ... on DateFieldConfiguration {
+              showTime
+            }
+            ... on DisplayLocationsFieldConfiguration {
+              mode
+            }
+            ... on PageNameFieldConfiguration {
+              displayUid
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        # Fields for a Force object, including all bindings needed for scripting.
+        #
+        # `Force.bindings` is `[BindingInterface]` (verified in the backend:
+        # `app/graphql/types/force_type.rb` + `types/forces/binding_interface.rb`), so its common
+        # fields are selected directly on the interface — no per-member inline fragments needed.
+        #
+        # ★ The interface exposes ONLY `name` and `referenceId` (+ `reference` per concrete type):
+        # there is NO `id` on a binding. The previous selection asked for `id` inside
+        # `... on DataFieldBinding` / `... on SectionBinding`, which makes the whole query invalid.
+        # Read/write asymmetry to be aware of: `WorkflowEditBindingInput` / `removeBinding` DO
+        # require a binding `id`, so `Force::Binding#id` (and `BindingCollection#delete!`) has no
+        # readable source for it — tracked as a shape-asymmetry finding, not fixable client-side.
+        fragment :ForceFields, <<~GRAPHQL
+          fragment ForceFields on Force {
+            id
+            name
+            script
+            customScript
+            globalBindingIds
+            bindings {
+              __typename
+              name
+              referenceId
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -1,53 +1,53 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        fragment :LocationDraft, <<~GRAPHQL
-          fragment on Draft {
-            id
-            name
-            notes
-            committed
-            createdAt
-            ok
-            conflictingIds
-            results {
-              ok
-              command {
-                id
-                state
-                __typename
-                ... on LocationInsertCommand    {
-                  nodeId name parentId insertBefore classificationIds
-                }
-                ... on LocationUpdateCommand    {
-                  nodeId newId
-                  newName: name
-                  newClassificationIds: classificationIds
-                }
-                ... on LocationArchiveCommand   { nodeId }
-                ... on LocationUnarchiveCommand { nodeId }
-                ... on LocationMoveCommand      { nodeId parentId insertBefore }
-                ... on LocationReorderCommand   { parentId orderedIds }
-              }
-              error {
-                message
-                conflictingIds
-                validationErrors {
-                  property
-                  error
-                  message
-                }
-              }
-            }
-            commands {
-              id
-              state
-              __typename
-            }
-          }
-        GRAPHQL
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :LocationDraft, <<~GRAPHQL
+          fragment LocationDraft on Draft {
+            id
+            name
+            notes
+            committed
+            createdAt
+            ok
+            conflictingIds
+            results {
+              ok
+              command {
+                id
+                state
+                __typename
+                ... on LocationInsertCommand    {
+                  nodeId name parentId insertBefore classificationIds
+                }
+                ... on LocationUpdateCommand    {
+                  nodeId newId
+                  newName: name
+                  newClassificationIds: classificationIds
+                }
+                ... on LocationArchiveCommand   { nodeId }
+                ... on LocationUnarchiveCommand { nodeId }
+                ... on LocationMoveCommand      { nodeId parentId insertBefore }
+                ... on LocationReorderCommand   { parentId orderedIds }
+              }
+              error {
+                message
+                conflictingIds
+                validationErrors {
+                  property
+                  error
+                  message
+                }
+              }
+            }
+            commands {
+              id
+              state
+              __typename
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -1,26 +1,26 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        fragment :LocationNode, <<~GRAPHQL
-          fragment on LocationNodeInterface {
-            id
-            name
-            weight
-            archived
-            archivedToken
-            parent {
-              id
-              name
-            }
-            classifications {
-              active
-              id
-              name
-            }
-          }
-        GRAPHQL
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :LocationNode, <<~GRAPHQL
+          fragment LocationNode on LocationNodeInterface {
+            id
+            name
+            weight
+            archived
+            archivedToken
+            parent {
+              id
+              name
+            }
+            classifications {
+              active
+              id
+              name
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -1,19 +1,19 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        fragment :LocationsError, <<~GRAPHQL
-          fragment on LocationsError {
-            message
-            conflictingIds
-            validationErrors {
-              property
-              error
-              message
-            }
-          }
-        GRAPHQL
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        fragment :LocationsError, <<~GRAPHQL
+          fragment LocationsError on LocationsError {
+            message
+            conflictingIds
+            validationErrors {
+              property
+              error
+              message
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end