ecoportal-api-graphql 1.3.10 → 1.3.12

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

@@ -1,181 +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
+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/fragment/page.rb

@@ -1,85 +1,85 @@
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        # Shared fields for both BasicPage and PhasedPage (spread on BasePageInterface).
-        # Always include __typename so PageUnion can dispatch to the right concrete class.
-        fragment :PageFields, <<~GRAPHQL
-          fragment PageFields on BasePageInterface {
-            __typename
-            id
-            name
-            uid
-            icon
-            patchVer
-            state
-            archived
-            archivedAt { dateTime }
-            draft
-            externalId
-            timeZone
-            otherTags
-            taskPriority
-            sourceTemplateId
-            createdAt { dateTime }
-            updatedAt { dateTime }
-            creatorName
-            locations {
-              ...LocationNode
-            }
-            workflow {
-              autoPageCreationEnabled
-              fields { key name type total missing }
-            }
-          }
-        GRAPHQL
-
-        # BasicPage-only fields — spread alongside PageFields for basic pages.
-        # BasicPage has sections directly (PhasedPage sections live under stages).
-        fragment :BasicPageFields, <<~GRAPHQL
-          fragment BasicPageFields on BasicPage {
-            sections {
-              __typename
-              ... on ContentSection {
-                id
-                heading
-              }
-              ... on SplitSection {
-                id
-                heading
-              }
-            }
-          }
-        GRAPHQL
-
-        # PhasedPage-only fields — spread alongside PageFields for phased pages.
-        # Provides lightweight stage index, current stage, and active stages.
-        # For full stage content (sections, data fields), use CommonPageUnion.
-        fragment :PhasedPageFields, <<~GRAPHQL
-          fragment PhasedPageFields on PhasedPage {
-            stagesIndex {
-              id
-              name
-              ordering
-              state
-              started
-              hasCompleteTask
-              hasReviewTask
-            }
-            currentStage {
-              id
-              name
-              ordering
-              state
-            }
-            activeStages {
-              id
-              name
-              ordering
-            }
-          }
-        GRAPHQL
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        # Shared fields for both BasicPage and PhasedPage (spread on BasePageInterface).
+        # Always include __typename so PageUnion can dispatch to the right concrete class.
+        fragment :PageFields, <<~GRAPHQL
+          fragment PageFields on BasePageInterface {
+            __typename
+            id
+            name
+            uid
+            icon
+            patchVer
+            state
+            archived
+            archivedAt { dateTime }
+            draft
+            externalId
+            timeZone
+            otherTags
+            taskPriority
+            sourceTemplateId
+            createdAt { dateTime }
+            updatedAt { dateTime }
+            creatorName
+            locations {
+              ...LocationNode
+            }
+            workflow {
+              autoPageCreationEnabled
+              fields { key name type total missing }
+            }
+          }
+        GRAPHQL
+
+        # BasicPage-only fields — spread alongside PageFields for basic pages.
+        # BasicPage has sections directly (PhasedPage sections live under stages).
+        fragment :BasicPageFields, <<~GRAPHQL
+          fragment BasicPageFields on BasicPage {
+            sections {
+              __typename
+              ... on ContentSection {
+                id
+                heading
+              }
+              ... on SplitSection {
+                id
+                heading
+              }
+            }
+          }
+        GRAPHQL
+
+        # PhasedPage-only fields — spread alongside PageFields for phased pages.
+        # Provides lightweight stage index, current stage, and active stages.
+        # For full stage content (sections, data fields), use CommonPageUnion.
+        fragment :PhasedPageFields, <<~GRAPHQL
+          fragment PhasedPageFields on PhasedPage {
+            stagesIndex {
+              id
+              name
+              ordering
+              state
+              started
+              hasCompleteTask
+              hasReviewTask
+            }
+            currentStage {
+              id
+              name
+              ordering
+              state
+            }
+            activeStages {
+              id
+              name
+              ordering
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

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

@@ -119,6 +119,7 @@ module Ecoportal
               __typename
               id                @skip(if: $only_content)
               label
+              genomeSignature   @skip(if: $only_content)
               deindex           @include(if: $content)
               linkedFieldConfig @skip(if: $only_content) {
                 crossReferenceId

data/lib/ecoportal/api/graphql/input/action/update.rb

@@ -1,14 +1,14 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Input
-        module Action
-          class Update < Ecoportal::API::GraphQL::Base::Action
-            passthrough :clientMutationId
-            passthrough :updateMode
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module Action
+          class Update < Ecoportal::API::GraphQL::Base::Action
+            passthrough :clientMutationId
+            passthrough :updateMode
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/contractor_entity/update.rb

@@ -1,41 +1,41 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Input
-        module ContractorEntity
-          class Update < Input::ContractorEntity::Create
-            passthrough :clientMutationId
-            class_resolver :id_diff_input, "Ecoportal::API::GraphQL::Input::IdDiff"
-            embeds_one :associatedPeopleIds, klass: :id_diff_input
-            embeds_one :leadContractorIds, klass: :id_diff_input
-
-            ID_DIFF_FIELDS = %i[associatedPeopleIds leadContractorIds].freeze
-
-            class << self
-              # Overrides Logic::Input.from_model to reshape array fields into
-              # IdDiffInput format: { additions: [...], removals: [...] }
-              # Array fields are stripped from the flat diff, so we compare
-              # doc vs original_doc directly rather than relying on the diff hash.
-              def from_model(model, **kargs)
-                diff = Logic::Input.from_model(model, **kargs)
-
-                ID_DIFF_FIELDS.each do |field|
-                  key      = field.to_s
-                  current  = Array(model.doc[key])
-                  original = Array(model.original_doc[key])
-                  next if current == original
-
-                  diff       ||= {}
-                  diff[:id]  ||= model.id
-                  diff[field]  = { additions: current - original, removals: original - current }
-                end
-
-                diff
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        module ContractorEntity
+          class Update < Input::ContractorEntity::Create
+            passthrough :clientMutationId
+            class_resolver :id_diff_input, "Ecoportal::API::GraphQL::Input::IdDiff"
+            embeds_one :associatedPeopleIds, klass: :id_diff_input
+            embeds_one :leadContractorIds, klass: :id_diff_input
+
+            ID_DIFF_FIELDS = %i[associatedPeopleIds leadContractorIds].freeze
+
+            class << self
+              # Overrides Logic::Input.from_model to reshape array fields into
+              # IdDiffInput format: { additions: [...], removals: [...] }
+              # Array fields are stripped from the flat diff, so we compare
+              # doc vs original_doc directly rather than relying on the diff hash.
+              def from_model(model, **kargs)
+                diff = Logic::Input.from_model(model, **kargs)
+
+                ID_DIFF_FIELDS.each do |field|
+                  key      = field.to_s
+                  current  = Array(model.doc[key])
+                  original = Array(model.original_doc[key])
+                  next if current == original
+
+                  diff       ||= {}
+                  diff[:id]  ||= model.id
+                  diff[field]  = { additions: current - original, removals: original - current }
+                end
+
+                diff
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end