carddb 0.3.0 → 0.3.5

data/examples/publisher_content_pipeline.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'carddb'
+
+client = CardDB::Client.new(secret_key: ENV.fetch('CARDDB_SECRET_KEY'))
+publisher_id = ENV.fetch('CARDDB_PUBLISHER_ID')
+game_key = ENV.fetch('CARDDB_GAME_KEY', 'example-tcg')
+
+game = client.games.get_by_key(publisher_id: publisher_id, game_key: game_key, cache: false) ||
+       client.games.create(
+         input: {
+           publisherId: publisher_id,
+           key: game_key,
+           name: 'Example TCG',
+           visibility: 'PRIVATE'
+         }
+       )
+
+client.import_formats.create(
+  input: {
+    gameId: game.id,
+    key: 'ci-json',
+    name: 'CI JSON',
+    config: { schemaVersion: 1 }
+  }
+)
+
+advanced_payload = {
+  datasets: [
+    {
+      name: 'cards',
+      schema: {
+        identifier: { type: 'STRING', isIdentifier: true },
+        name: { type: 'STRING', required: true }
+      },
+      records: [{ identifier: 'CARD-001', name: 'Example Card' }]
+    }
+  ]
+}
+
+preview = client.imports.preview_game(input: { gameId: game.id, data: advanced_payload })
+raise "Import preview blocked: #{preview.warnings.map(&:message).join(', ')}" unless preview.can_proceed?
+
+import_job = client.imports.run_game(
+  input: {
+    gameId: game.id,
+    data: advanced_payload,
+    options: { mode: 'CREATE', onConflict: 'UPDATE' }
+  }
+)
+completed_import = client.imports.wait_for_game_job(import_job.id)
+raise completed_import.error_message unless completed_import.completed?
+
+dataset = client.datasets.get_by_key(game_id: game.id, dataset_key: 'cards')
+raise 'cards dataset was not created' unless dataset
+
+upsert = client.records.upsert_batch(
+  input: {
+    datasetId: dataset.id,
+    records: [{ identifier: 'CARD-002', name: 'Second Example Card' }],
+    options: { mode: 'STRICT', onConflict: 'UPDATE', dryRun: true }
+  }
+)
+
+raise "Upsert validation failed: #{upsert.dry_run_result.errors.map(&:index).join(', ')}" if upsert.dry_run_result&.errors&.any?
+
+delete_preview = client.records.delete_batch(
+  input: {
+    datasetId: dataset.id,
+    reconcileIdentifiers: %w[CARD-001 CARD-002],
+    dryRun: true
+  }
+)
+puts "Would delete #{delete_preview.matched_count} records"
+
+export_job = client.exports.run(input: { datasetId: dataset.id, format: 'JSON' })
+export_result = client.exports.wait_for_job(export_job.id)
+export_with_fresh_url = client.exports.refresh_url(id: export_result.id)
+puts export_with_fresh_url.download_url

data/lib/carddb/client.rb

@@ -98,6 +98,34 @@ module CardDB
       @records ||= Resources::Records.new(self, connection, config)
     end
 
+    # Access the Import Formats resource
+    #
+    # @return [Resources::ImportFormats]
+    def import_formats
+      @import_formats ||= Resources::ImportFormats.new(self, connection, config)
+    end
+
+    # Access the Imports resource
+    #
+    # @return [Resources::Imports]
+    def imports
+      @imports ||= Resources::Imports.new(self, connection, config)
+    end
+
+    # Access the Exports resource
+    #
+    # @return [Resources::Exports]
+    def exports
+      @exports ||= Resources::Exports.new(self, connection, config)
+    end
+
+    # Access the Files resource
+    #
+    # @return [Resources::Files]
+    def files
+      @files ||= Resources::Files.new(self, connection, config)
+    end
+
     # Access the Decks resource
     #
     # @return [Resources::Decks]

data/lib/carddb/collection.rb

@@ -344,6 +344,14 @@ module CardDB
       data['description']
     end
 
+    def metafy_game_uuid
+      data['metafyGameUuid']
+    end
+
+    def metafy_game_slug
+      data['metafyGameSlug']
+    end
+
     def website
       data['website']
     end
@@ -372,6 +380,10 @@ module CardDB
       data.dig('coverFile', 'url')
     end
 
+    def archived_at
+      parse_time(data['archivedAt'])
+    end
+
     def created_at
       parse_time(data['createdAt'])
     end
@@ -446,6 +458,10 @@ module CardDB
       data['purpose']
     end
 
+    def active_version_id
+      data['activeVersionId']
+    end
+
     def tcgplayer_product_id_field_key
       data['tcgplayerProductIdFieldKey']
     end
@@ -458,6 +474,22 @@ module CardDB
       data['isArchived']
     end
 
+    def archived_at
+      parse_time(data['archivedAt'])
+    end
+
+    def pos_x
+      data['posX']
+    end
+
+    def pos_y
+      data['posY']
+    end
+
+    def sort_order
+      data['sortOrder']
+    end
+
     def publisher_id
       data['publisherId']
     end
@@ -592,6 +624,10 @@ module CardDB
       @fields ||= (data['fields'] || []).map { |f| FieldInfo.new(f) }
     end
 
+    def field_keys
+      fields.map(&:key)
+    end
+
     def filterable_fields
       data['filterableFields'] || []
     end
@@ -650,10 +686,38 @@ module CardDB
       data['isIdentifier']
     end
 
+    def sort_order
+      data['sortOrder']
+    end
+
     def item_type
       data['itemType']
     end
 
+    def link_dataset_id
+      data['linkDatasetId']
+    end
+
+    def link_dataset_key
+      data['linkDatasetKey']
+    end
+
+    def link_dataset_name
+      data['linkDatasetName']
+    end
+
+    def link_field_key
+      data['linkFieldKey']
+    end
+
+    def link_alias
+      data['linkAlias']
+    end
+
+    def link_direction
+      data['linkDirection']
+    end
+
     def display_format
       data['displayFormat']
     end
@@ -662,10 +726,54 @@ module CardDB
       data['semanticType']
     end
 
+    def placeholder
+      data['placeholder']
+    end
+
+    def hidden?
+      data['isHidden']
+    end
+
+    def computed?
+      data['isComputed']
+    end
+
+    def system_field?
+      data['isSystemField']
+    end
+
+    def default_value
+      data['defaultValue']
+    end
+
     def allowed_values
       data['allowedValues']
     end
 
+    def min_length
+      data['minLength']
+    end
+
+    def max_length
+      data['maxLength']
+    end
+
+    def min_value
+      data['minValue']
+    end
+
+    def max_value
+      data['maxValue']
+    end
+
+    def pattern
+      data['pattern']
+    end
+
+    def unique?
+      data['isUnique']
+    end
+
     def nested_fields
       @nested_fields ||= (data['nestedFields'] || []).map { |f| FieldInfo.new(f) }
     end
@@ -698,6 +806,22 @@ module CardDB
     def target_dataset_id
       data['targetDatasetId']
     end
+
+    def target_field_key
+      data['targetFieldKey']
+    end
+
+    def link_alias
+      data['linkAlias']
+    end
+
+    def link_direction
+      data['linkDirection']
+    end
+
+    def array?
+      data['isArray']
+    end
   end
 
   # Wrapper for DatasetRecord objects
@@ -784,6 +908,399 @@ module CardDB
     end
   end
 
+  class File < Resource
+    def id = data['id']
+    def key = data['key']
+    def filename = data['filename']
+    def content_type = data['contentType']
+    def size = data['size']
+    def status = data['status']
+    def public? = !!data['isPublic']
+    def entity_type = data['entityType']
+    def entity_id = data['entityId']
+    def url = data['url']
+    def created_at = parse_time(data['createdAt'])
+    def updated_at = parse_time(data['updatedAt'])
+  end
+
+  class PresignedUpload < Resource
+    def upload_url = data['uploadUrl']
+    def expires_at = parse_time(data['expiresAt'])
+
+    def file
+      @file ||= data['file'] ? File.new(data['file'], client: client) : nil
+    end
+  end
+
+  class ObjectField < Resource
+    def id = data['id']
+    def object_type_id = data['objectTypeId']
+    def key = data['key']
+    def label = data['label']
+    def data_type = data['dataType']
+    def required? = !!data['isRequired']
+    def filterable? = !!data['isFilterable']
+    def searchable? = !!data['isSearchable']
+    def identifier? = !!data['isIdentifier']
+    def sort_order = data['sortOrder']
+    def description = data['description']
+    def placeholder = data['placeholder']
+    def display_format = data['displayFormat']
+    def semantic_type = data['semanticType']
+    def hidden? = !!data['isHidden']
+    def computed? = !!data['isComputed']
+    def system_field? = !!data['isSystemField']
+    def default_value = data['defaultValue']
+    def allowed_values = data['allowedValues']
+    def min_length = data['minLength']
+    def max_length = data['maxLength']
+    def min_value = data['minValue']
+    def max_value = data['maxValue']
+    def pattern = data['pattern']
+    def unique? = !!data['isUnique']
+    def item_type = data['itemType']
+    def link_dataset_id = data['linkDatasetId']
+    def link_field_key = data['linkFieldKey']
+    def link_alias = data['linkAlias']
+    def link_direction = data['linkDirection']
+    def parent_field_id = data['parentFieldId']
+    def created_at = parse_time(data['createdAt'])
+    def updated_at = parse_time(data['updatedAt'])
+  end
+
+  class RecordValidationError < Resource
+    def field = data['field']
+    def message = data['message']
+    def details = data['details'] || {}
+  end
+
+  class BulkRecordError < Resource
+    def dataset_key = data['datasetKey']
+    def index = data['index']
+
+    def errors
+      @errors ||= (data['errors'] || []).map { |error| RecordValidationError.new(error, client: client) }
+    end
+  end
+
+  class ImportStats < Resource
+    def total = data['total']
+    def inserted = data['inserted']
+    def updated = data['updated']
+    def skipped = data['skipped']
+    def failed = data['failed']
+  end
+
+  class BulkImportResult < Resource
+    def inserted
+      @inserted ||= (data['inserted'] || []).map { |record| Record.new(record, client: client) }
+    end
+
+    def updated
+      @updated ||= (data['updated'] || []).map { |record| Record.new(record, client: client) }
+    end
+
+    def skipped = data['skipped']
+
+    def errors
+      @errors ||= (data['errors'] || []).map { |error| BulkRecordError.new(error, client: client) }
+    end
+
+    def created_fields
+      @created_fields ||= (data['createdFields'] || []).map { |field| ObjectField.new(field, client: client) }
+    end
+
+    def stats
+      @stats ||= data['stats'] ? ImportStats.new(data['stats'], client: client) : nil
+    end
+  end
+
+  class DatasetRecordsUpsertPayload < Resource
+    def job
+      @job ||= data['job'] ? ImportJob.new(data['job'], client: client) : nil
+    end
+
+    def dry_run_result
+      @dry_run_result ||= data['dryRunResult'] ? BulkImportResult.new(data['dryRunResult'], client: client) : nil
+    end
+  end
+
+  class DatasetRecordDeleteJobResult < Resource
+    def target = data['target']
+    def record_id = data['recordId']
+    def identifier = data['identifier']
+    def status = data['status']
+    def message = data['message']
+  end
+
+  class DatasetRecordDeleteJob < Resource
+    def id = data['id']
+    def publisher_id = data['publisherId']
+    def dataset_id = data['datasetId']
+    def account_id = data['accountId']
+    def status = data['status']
+    def target_type = data['targetType']
+    def dry_run? = !!data['dryRun']
+    def targets = data['targets'] || []
+    def progress = data['progress']
+    def total_targets = data['totalTargets']
+    def processed_targets = data['processedTargets']
+    def matched_count = data['matchedCount']
+    def deleted_count = data['deletedCount']
+    def missing_count = data['missingCount']
+    def blocked_count = data['blockedCount']
+    def failed_count = data['failedCount']
+    def error_message = data['errorMessage']
+    def started_at = parse_time(data['startedAt'])
+    def completed_at = parse_time(data['completedAt'])
+    def created_at = parse_time(data['createdAt'])
+    def updated_at = parse_time(data['updatedAt'])
+    def completed? = status == 'COMPLETED'
+    def failed? = status == 'FAILED'
+
+    def publisher
+      @publisher ||= data['publisher'] ? Publisher.new(data['publisher'], client: client) : nil
+    end
+
+    def dataset
+      @dataset ||= data['dataset'] ? Dataset.new(data['dataset'], client: client) : nil
+    end
+
+    def results
+      @results ||= (data['results'] || []).map { |result| DatasetRecordDeleteJobResult.new(result, client: client) }
+    end
+  end
+
+  class ImportJobAsset < Resource
+    def file_id = data['fileId']
+    def filename = data['filename']
+
+    def file
+      @file ||= data['file'] ? File.new(data['file'], client: client) : nil
+    end
+  end
+
+  class ImportJob < Resource
+    def id = data['id']
+    def publisher_id = data['publisherId']
+    def dataset_id = data['datasetId']
+    def account_id = data['accountId']
+    def status = data['status']
+    def mode = data['mode']
+    def on_conflict = data['onConflict']
+    def format = data['format']
+    def file_id = data['fileId']
+    def progress = data['progress']
+    def total_records = data['totalRecords']
+    def processed_records = data['processedRecords']
+    def inserted_count = data['insertedCount']
+    def updated_count = data['updatedCount']
+    def skipped_count = data['skippedCount']
+    def failed_count = data['failedCount']
+    def error_message = data['errorMessage']
+    def started_at = parse_time(data['startedAt'])
+    def completed_at = parse_time(data['completedAt'])
+    def created_at = parse_time(data['createdAt'])
+    def updated_at = parse_time(data['updatedAt'])
+    def last_checkpoint_index = data['lastCheckpointIndex']
+    def resumed? = !!data['isResumed']
+    def images_pending = data['imagesPending']
+    def images_completed = data['imagesCompleted']
+    def images_failed = data['imagesFailed']
+    def completed? = status == 'COMPLETED'
+    def failed? = status == 'FAILED'
+
+    def publisher
+      @publisher ||= data['publisher'] ? Publisher.new(data['publisher'], client: client) : nil
+    end
+
+    def dataset
+      @dataset ||= data['dataset'] ? Dataset.new(data['dataset'], client: client) : nil
+    end
+
+    def created_fields
+      @created_fields ||= (data['createdFields'] || []).map { |field| ObjectField.new(field, client: client) }
+    end
+
+    def errors
+      @errors ||= (data['errors'] || []).map { |error| BulkRecordError.new(error, client: client) }
+    end
+
+    def assets
+      @assets ||= (data['assets'] || []).map { |asset| ImportJobAsset.new(asset, client: client) }
+    end
+  end
+
+  class ImportJobLog < Resource
+    def id = data['id']
+    def import_job_id = data['importJobId']
+    def level = data['level']
+    def message = data['message']
+    def dataset_key = data['datasetKey']
+    def record_index = data['recordIndex']
+    def field_key = data['fieldKey']
+    def details = data['details'] || {}
+    def created_at = parse_time(data['createdAt'])
+  end
+
+  class FieldMapping < Resource
+    def source_field = data['sourceField']
+    def target_field = data['targetField']
+    def target_field_label = data['targetFieldLabel']
+    def inferred_type = data['inferredType']
+    def inferred_item_type = data['inferredItemType']
+    def inferred_children = data['inferredChildren'] || []
+    def inferred_link_dataset = data['inferredLinkDataset']
+    def inferred_link_field_key = data['inferredLinkFieldKey']
+    def inferred_link_direction = data['inferredLinkDirection']
+    def target_field_type = data['targetFieldType']
+    def sample_values = data['sampleValues'] || []
+    def status = data['status']
+  end
+
+  class ImportWarning < Resource
+    def dataset_key = data['datasetKey']
+    def field = data['field']
+    def message = data['message']
+    def severity = data['severity']
+  end
+
+  class DatasetImportPreview < Resource
+    def dataset_key = data['datasetKey']
+    def dataset_name = data['datasetName']
+    def dataset_id = data['datasetId']
+    def exists? = !!data['exists']
+    def record_count = data['recordCount']
+    def sample_records = data['sampleRecords'] || []
+
+    def field_mappings
+      @field_mappings ||= (data['fieldMappings'] || []).map { |mapping| FieldMapping.new(mapping, client: client) }
+    end
+
+    def warnings
+      @warnings ||= (data['warnings'] || []).map { |warning| ImportWarning.new(warning, client: client) }
+    end
+  end
+
+  class DatasetImportPreviewResult < DatasetImportPreview
+    def can_proceed? = !!data['canProceed']
+
+    def available_datasets
+      @available_datasets ||= (data['availableDatasets'] || []).map { |dataset| Dataset.new(dataset, client: client) }
+    end
+  end
+
+  class GameImportPreview < Resource
+    def import_order = data['importOrder'] || []
+    def can_proceed? = !!data['canProceed']
+
+    def datasets
+      @datasets ||= (data['datasets'] || []).map { |dataset| DatasetImportPreview.new(dataset, client: client) }
+    end
+
+    def warnings
+      @warnings ||= (data['warnings'] || []).map { |warning| ImportWarning.new(warning, client: client) }
+    end
+  end
+
+  class GameImportDatasetStatus < Resource
+    def dataset_key = data['datasetKey']
+    def dataset_id = data['datasetId']
+    def dataset_name = data['datasetName']
+    def status = data['status']
+    def record_count = data['recordCount']
+    def inserted_count = data['insertedCount']
+    def updated_count = data['updatedCount']
+    def skipped_count = data['skippedCount']
+    def failed_count = data['failedCount']
+    def error_message = data['errorMessage']
+  end
+
+  class GameImportJob < Resource
+    def id = data['id']
+    def publisher_id = data['publisherId']
+    def game_id = data['gameId']
+    def account_id = data['accountId']
+    def status = data['status']
+    def mode = data['mode']
+    def on_conflict = data['onConflict']
+    def file_id = data['fileId']
+    def total_datasets = data['totalDatasets']
+    def completed_datasets = data['completedDatasets']
+    def progress = data['progress']
+    def import_order = data['importOrder'] || []
+    def error_message = data['errorMessage']
+    def started_at = parse_time(data['startedAt'])
+    def completed_at = parse_time(data['completedAt'])
+    def created_at = parse_time(data['createdAt'])
+    def updated_at = parse_time(data['updatedAt'])
+    def completed_dataset_keys = data['completedDatasetKeys'] || []
+    def current_dataset_key = data['currentDatasetKey']
+    def last_checkpoint_index = data['lastCheckpointIndex']
+    def resumed? = !!data['isResumed']
+    def images_pending = data['imagesPending']
+    def images_completed = data['imagesCompleted']
+    def images_failed = data['imagesFailed']
+    def phase = data['phase']
+    def link_building_dataset = data['linkBuildingDataset']
+    def link_building_total_datasets = data['linkBuildingTotalDatasets']
+    def link_building_completed_datasets = data['linkBuildingCompletedDatasets']
+    def link_building_processed_records = data['linkBuildingProcessedRecords']
+    def link_building_total_records = data['linkBuildingTotalRecords']
+    def completed? = status == 'COMPLETED'
+    def failed? = status == 'FAILED'
+
+    def publisher
+      @publisher ||= data['publisher'] ? Publisher.new(data['publisher'], client: client) : nil
+    end
+
+    def game
+      @game ||= data['game'] ? Game.new(data['game'], client: client) : nil
+    end
+
+    def assets
+      @assets ||= (data['assets'] || []).map { |asset| ImportJobAsset.new(asset, client: client) }
+    end
+
+    def dataset_statuses
+      @dataset_statuses ||= (data['datasetStatuses'] || []).map do |status|
+        GameImportDatasetStatus.new(status, client: client)
+      end
+    end
+  end
+
+  class ExportJob < Resource
+    def id = data['id']
+    def publisher_id = data['publisherId']
+    def dataset_id = data['datasetId']
+    def account_id = data['accountId']
+    def status = data['status']
+    def format = data['format']
+    def filter = data['filter']
+    def total_records = data['totalRecords']
+    def processed_records = data['processedRecords']
+    def progress = data['progress']
+    def file_id = data['fileId']
+    def download_url = data['downloadUrl']
+    def download_expires_at = parse_time(data['downloadExpiresAt'])
+    def error_message = data['errorMessage']
+    def started_at = parse_time(data['startedAt'])
+    def completed_at = parse_time(data['completedAt'])
+    def created_at = parse_time(data['createdAt'])
+    def updated_at = parse_time(data['updatedAt'])
+    def last_checkpoint_index = data['lastCheckpointIndex']
+    def completed? = status == 'COMPLETED'
+    def failed? = status == 'FAILED'
+
+    def publisher
+      @publisher ||= data['publisher'] ? Publisher.new(data['publisher'], client: client) : nil
+    end
+
+    def dataset
+      @dataset ||= data['dataset'] ? Dataset.new(data['dataset'], client: client) : nil
+    end
+  end
+
   # Wrapper for hosted Deck objects
   class Deck < Resource
     def id