carddb 0.3.0 → 0.3.5

data/lib/carddb/resources/records.rb

@@ -6,6 +6,163 @@ module CardDB
     class Records < Base
       include FilterOperators
 
+      # List records in a publisher-accessible dataset by dataset ID.
+      # rubocop:disable Metrics/MethodLength
+      def list(
+        dataset_id:,
+        filter: nil,
+        order_by: nil,
+        first: nil,
+        after: nil,
+        last: nil,
+        before: nil,
+        validate_schema: nil,
+        cache: nil,
+        &block
+      )
+        final_filter = block_given? ? FilterBuilder.build(&block) : filter
+        query = QueryBuilder.list_dataset_records(
+          dataset_id: dataset_id,
+          filter: final_filter,
+          order_by: order_by,
+          first: first,
+          after: after,
+          last: last,
+          before: before,
+          validate_schema: validate_schema
+        )
+        variables = build_variables(
+          datasetId: dataset_id,
+          filter: final_filter,
+          orderBy: order_by,
+          first: first,
+          after: after,
+          last: last,
+          before: before,
+          validateSchema: validate_schema
+        )
+        key = cache_key('records', 'list', **variables)
+
+        data = with_cache(key, resource: :records, cache: cache) { connection.execute(query, variables) }
+
+        Collection.new(
+          data['datasetRecords'],
+          item_class: Record,
+          next_page_loader: lambda { |cursor|
+            list(
+              dataset_id: dataset_id,
+              filter: final_filter,
+              order_by: order_by,
+              first: first,
+              after: cursor,
+              validate_schema: validate_schema,
+              cache: cache
+            )
+          },
+          client: client
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # Get a publisher-accessible record by dataset ID and identifier value.
+      def get_by_dataset_identifier(dataset_id:, identifier:, cache: nil, include_pricing: false)
+        key = cache_key(
+          'records',
+          'get_by_dataset_identifier',
+          dataset_id: dataset_id,
+          identifier: identifier,
+          include_pricing: include_pricing
+        )
+        with_cache(key, resource: :records, cache: cache) do
+          query = QueryBuilder.dataset_record(
+            dataset_id: dataset_id,
+            identifier: identifier,
+            include_pricing: include_pricing
+          )
+          data = connection.execute(query, { datasetId: dataset_id, identifier: identifier })
+
+          data['datasetRecord'] ? Record.new(data['datasetRecord'], client: client) : nil
+        end
+      end
+
+      # Start an import-backed batch upsert, or return a dry-run result.
+      def upsert_batch(input:)
+        config.require_secret_credential!('records.upsert_batch')
+
+        data = connection.execute(QueryBuilder.upsert_dataset_records, { input: input })
+        DatasetRecordsUpsertPayload.new(data['datasetRecordsUpsert'], client: client)
+      end
+
+      # Create a dry-run or destructive bulk delete/reconciliation job.
+      def delete_batch(input:)
+        config.require_secret_credential!('records.delete_batch')
+
+        data = connection.execute(QueryBuilder.delete_dataset_records, { input: input })
+        DatasetRecordDeleteJob.new(data['datasetRecordsDelete'], client: client)
+      end
+
+      # Get one bulk delete/reconciliation job.
+      def get_delete_job(id, cache: nil)
+        key = cache_key('records', 'get_delete_job', id: id)
+        with_cache(key, resource: :records, cache: cache) do
+          data = connection.execute(QueryBuilder.dataset_record_delete_job, { id: id })
+          data['datasetRecordDeleteJob'] ? DatasetRecordDeleteJob.new(data['datasetRecordDeleteJob'], client: client) : nil
+        end
+      end
+
+      # List bulk delete/reconciliation jobs for a publisher.
+      def list_delete_jobs(publisher_id:, dataset_id: nil, status: nil, first: nil, after: nil, cache: nil)
+        query = QueryBuilder.dataset_record_delete_jobs(
+          publisher_id: publisher_id,
+          dataset_id: dataset_id,
+          status: status,
+          first: first,
+          after: after
+        )
+        variables = build_variables(
+          publisherId: publisher_id,
+          datasetId: dataset_id,
+          status: status,
+          first: first,
+          after: after
+        )
+        key = cache_key('records', 'list_delete_jobs', **variables)
+
+        data = with_cache(key, resource: :records, cache: cache) { connection.execute(query, variables) }
+
+        Collection.new(
+          data['datasetRecordDeleteJobs'],
+          item_class: DatasetRecordDeleteJob,
+          next_page_loader: lambda { |cursor|
+            list_delete_jobs(
+              publisher_id: publisher_id,
+              dataset_id: dataset_id,
+              status: status,
+              first: first,
+              after: cursor,
+              cache: cache
+            )
+          },
+          client: client
+        )
+      end
+
+      # Poll a delete job until it reaches a terminal state.
+      def wait_for_delete_job(id, interval: 1, timeout: 300)
+        started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        loop do
+          job = get_delete_job(id, cache: false)
+          raise Error, "Delete job '#{id}' was not found" unless job
+          return job if job.completed? || job.failed?
+
+          elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at
+          raise Error, "Timed out waiting for delete job '#{id}'" if elapsed >= timeout
+
+          sleep interval
+        end
+      end
+
       # Search for records in a dataset
       #
       # @param dataset_key [String] Dataset key (required)

data/lib/carddb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CardDB
-  VERSION = '0.3.0'
+  VERSION = '0.3.5'
 end

data/lib/carddb.rb

@@ -13,6 +13,10 @@ require_relative 'carddb/resources/publishers'
 require_relative 'carddb/resources/games'
 require_relative 'carddb/resources/datasets'
 require_relative 'carddb/resources/records'
+require_relative 'carddb/resources/import_formats'
+require_relative 'carddb/resources/imports'
+require_relative 'carddb/resources/exports'
+require_relative 'carddb/resources/files'
 require_relative 'carddb/resources/decks'
 require_relative 'carddb/resources/rules'
 require_relative 'carddb/batch'
@@ -110,6 +114,34 @@ module CardDB
       default_client.records
     end
 
+    # Access the Import Formats resource via the default client.
+    #
+    # @return [Resources::ImportFormats]
+    def import_formats
+      default_client.import_formats
+    end
+
+    # Access the Imports resource via the default client.
+    #
+    # @return [Resources::Imports]
+    def imports
+      default_client.imports
+    end
+
+    # Access the Exports resource via the default client.
+    #
+    # @return [Resources::Exports]
+    def exports
+      default_client.exports
+    end
+
+    # Access the Files resource via the default client.
+    #
+    # @return [Resources::Files]
+    def files
+      default_client.files
+    end
+
     # Access the Decks resource via the default client.
     #
     # @return [Resources::Decks]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carddb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - CardDB Team
@@ -57,6 +57,7 @@ files:
 - examples/basic_usage.rb
 - examples/filtering.rb
 - examples/pagination.rb
+- examples/publisher_content_pipeline.rb
 - lib/carddb.rb
 - lib/carddb/batch.rb
 - lib/carddb/cache.rb
@@ -70,7 +71,11 @@ files:
 - lib/carddb/resources/base.rb
 - lib/carddb/resources/datasets.rb
 - lib/carddb/resources/decks.rb
+- lib/carddb/resources/exports.rb
+- lib/carddb/resources/files.rb
 - lib/carddb/resources/games.rb
+- lib/carddb/resources/import_formats.rb
+- lib/carddb/resources/imports.rb
 - lib/carddb/resources/publishers.rb
 - lib/carddb/resources/records.rb
 - lib/carddb/resources/rules.rb