Module: CardDB::QueryBuilder

Defined in:
lib/carddb/query_builder.rb

Overview

Builds GraphQL queries for the CardDB API. rubocop:disable Metrics/ModuleLength

Constant Summary collapse

SCHEMA_NESTED_FIELDS_DEPTH =
4

Class Method Summary collapse

Class Method Details

.create_deckObject

Builds a deckCreate mutation



364
365
366
367
368
369
370
371
372
# File 'lib/carddb/query_builder.rb', line 364

def create_deck
  <<~GRAPHQL
    mutation DeckCreate($input: DeckCreateInput!) {
      deckCreate(input: $input) {
        #{deck_fields}
      }
    }
  GRAPHQL
end

.create_deck_preview_tokenObject

Builds a deckPreviewTokenCreate mutation



417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/carddb/query_builder.rb', line 417

def create_deck_preview_token
  <<~GRAPHQL
    mutation DeckPreviewTokenCreate($input: DeckPreviewTokenCreateInput!) {
      deckPreviewTokenCreate(input: $input) {
        token
        previewToken {
          #{deck_preview_token_fields}
        }
      }
    }
  GRAPHQL
end

.deck_collaboratorsObject

Builds a deckCollaborators query



342
343
344
345
346
347
348
349
350
# File 'lib/carddb/query_builder.rb', line 342

def deck_collaborators
  <<~GRAPHQL
    query DeckCollaborators($deckId: UUID!) {
      deckCollaborators(deckId: $deckId) {
        #{deck_collaborator_fields}
      }
    }
  GRAPHQL
end

.deck_previewObject

Builds a deckPreview query



331
332
333
334
335
336
337
338
339
# File 'lib/carddb/query_builder.rb', line 331

def deck_preview
  <<~GRAPHQL
    query DeckPreview($token: String!) {
      deckPreview(token: $token) {
        #{deck_fields}
      }
    }
  GRAPHQL
end

.deck_preview_tokensObject

Builds a deckPreviewTokens query



353
354
355
356
357
358
359
360
361
# File 'lib/carddb/query_builder.rb', line 353

def deck_preview_tokens
  <<~GRAPHQL
    query DeckPreviewTokens($deckId: UUID!) {
      deckPreviewTokens(deckId: $deckId) {
        #{deck_preview_token_fields}
      }
    }
  GRAPHQL
end

.deck_versionObject

Builds a deckVersion query



307
308
309
310
311
312
313
314
315
# File 'lib/carddb/query_builder.rb', line 307

def deck_version
  <<~GRAPHQL
    query DeckVersion($id: UUID!) {
      deckVersion(id: $id) {
        #{deck_version_fields}
      }
    }
  GRAPHQL
end

.deck_versions(first: nil, after: nil) ⇒ Object

Builds a deckVersions query



318
319
320
321
322
323
324
325
326
327
328
# File 'lib/carddb/query_builder.rb', line 318

def deck_versions(first: nil, after: nil)
  args = build_args({ deckId: true, first: first, after: after }, required: [:deckId])

  <<~GRAPHQL
    query DeckVersions#{args[:definition]} {
      deckVersions#{args[:call]} {
        #{deck_version_connection_fields}
      }
    }
  GRAPHQL
end

.delete_deckObject

Builds a deckDelete mutation



440
441
442
443
444
445
446
# File 'lib/carddb/query_builder.rb', line 440

def delete_deck
  <<~GRAPHQL
    mutation DeckDelete($id: UUID!) {
      deckDelete(id: $id)
    }
  GRAPHQL
end

.fetch_dataset_by_idObject

Builds a fetchDataset query by id



133
134
135
136
137
138
139
140
141
142
# File 'lib/carddb/query_builder.rb', line 133

def fetch_dataset_by_id
  <<~GRAPHQL
    query FetchDataset($id: UUID!) {
      fetchDataset(id: $id) {
        #{dataset_fields}
        #{schema_fields}
      }
    }
  GRAPHQL
end

.fetch_dataset_by_keysObject

Builds a fetchDataset query by keys (includes schema)



145
146
147
148
149
150
151
152
153
154
# File 'lib/carddb/query_builder.rb', line 145

def fetch_dataset_by_keys
  <<~GRAPHQL
    query FetchDataset($publisherSlug: String!, $gameKey: String!, $datasetKey: String!) {
      fetchDataset(publisherSlug: $publisherSlug, gameKey: $gameKey, datasetKey: $datasetKey) {
        #{dataset_fields}
        #{schema_fields}
      }
    }
  GRAPHQL
end

.fetch_datasetsObject

Builds a fetchDatasets batch query



157
158
159
160
161
162
163
164
165
# File 'lib/carddb/query_builder.rb', line 157

def fetch_datasets
  <<~GRAPHQL
    query FetchDatasets($ids: [UUID!]!) {
      fetchDatasets(ids: $ids) {
        #{dataset_fields}
      }
    }
  GRAPHQL
end

.fetch_deckObject

Builds a fetchDeck query



263
264
265
266
267
268
269
270
271
# File 'lib/carddb/query_builder.rb', line 263

def fetch_deck
  <<~GRAPHQL
    query FetchDeck($id: UUID!) {
      fetchDeck(id: $id) {
        #{deck_fields}
      }
    }
  GRAPHQL
end

.fetch_deck_by_external_refObject

Builds a fetchDeckByExternalRef query



296
297
298
299
300
301
302
303
304
# File 'lib/carddb/query_builder.rb', line 296

def fetch_deck_by_external_ref
  <<~GRAPHQL
    query FetchDeckByExternalRef($externalRef: String!) {
      fetchDeckByExternalRef(externalRef: $externalRef) {
        #{deck_fields}
      }
    }
  GRAPHQL
end

.fetch_deck_by_slugObject

Builds a fetchDeckBySlug query



285
286
287
288
289
290
291
292
293
# File 'lib/carddb/query_builder.rb', line 285

def fetch_deck_by_slug
  <<~GRAPHQL
    query FetchDeckBySlug($publisherSlug: String!, $gameKey: String!, $slug: String!) {
      fetchDeckBySlug(publisherSlug: $publisherSlug, gameKey: $gameKey, slug: $slug) {
        #{deck_fields}
      }
    }
  GRAPHQL
end

.fetch_game_by_idObject

Builds a fetchGame query by id



80
81
82
83
84
85
86
87
88
# File 'lib/carddb/query_builder.rb', line 80

def fetch_game_by_id
  <<~GRAPHQL
    query FetchGame($id: UUID!) {
      fetchGame(id: $id) {
        #{game_fields}
      }
    }
  GRAPHQL
end

.fetch_game_by_keysObject

Builds a fetchGame query by publisher slug and game key



91
92
93
94
95
96
97
98
99
# File 'lib/carddb/query_builder.rb', line 91

def fetch_game_by_keys
  <<~GRAPHQL
    query FetchGame($publisherSlug: String!, $gameKey: String!) {
      fetchGame(publisherSlug: $publisherSlug, gameKey: $gameKey) {
        #{game_fields}
      }
    }
  GRAPHQL
end

.fetch_gamesObject

Builds a fetchGames batch query



102
103
104
105
106
107
108
109
110
# File 'lib/carddb/query_builder.rb', line 102

def fetch_games
  <<~GRAPHQL
    query FetchGames($ids: [UUID!]!) {
      fetchGames(ids: $ids) {
        #{game_fields}
      }
    }
  GRAPHQL
end

.fetch_meObject

Builds a fetchMe query



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
# File 'lib/carddb/query_builder.rb', line 449

def fetch_me
  <<~GRAPHQL
    query FetchMe {
      fetchMe {
        application {
          id
          name
          description
          environment
          apiKeyPrefix
          allowedOrigins
          allowedIps
          createdAt
          updatedAt
          lastUsedAt
        }
        account {
          id
          displayName
          createdAt
        }
      }
    }
  GRAPHQL
end

.fetch_publisher_by_idObject

Builds a fetchPublisher query (by id or slug)



29
30
31
32
33
34
35
36
37
# File 'lib/carddb/query_builder.rb', line 29

def fetch_publisher_by_id
  <<~GRAPHQL
    query FetchPublisher($id: UUID!) {
      fetchPublisher(id: $id) {
        #{publisher_fields}
      }
    }
  GRAPHQL
end

.fetch_publisher_by_slugObject

Builds a fetchPublisher query by slug



40
41
42
43
44
45
46
47
48
# File 'lib/carddb/query_builder.rb', line 40

def fetch_publisher_by_slug
  <<~GRAPHQL
    query FetchPublisher($slug: String!) {
      fetchPublisher(slug: $slug) {
        #{publisher_fields}
      }
    }
  GRAPHQL
end

.fetch_publishersObject

Builds a fetchPublishers query



51
52
53
54
55
56
57
58
59
# File 'lib/carddb/query_builder.rb', line 51

def fetch_publishers
  <<~GRAPHQL
    query FetchPublishers($slugs: [String!]!) {
      fetchPublishers(slugs: $slugs) {
        #{publisher_fields}
      }
    }
  GRAPHQL
end

.fetch_recordObject

Builds a fetchRecord query



228
229
230
231
232
233
234
235
236
# File 'lib/carddb/query_builder.rb', line 228

def fetch_record
  <<~GRAPHQL
    query FetchRecord($id: UUID!) {
      fetchRecord(id: $id) {
        #{record_fields}
      }
    }
  GRAPHQL
end

.fetch_record_by_identifierObject

Builds a fetchRecordByIdentifier query



206
207
208
209
210
211
212
213
214
# File 'lib/carddb/query_builder.rb', line 206

def fetch_record_by_identifier
  <<~GRAPHQL
    query FetchRecordByIdentifier($publisherSlug: String!, $gameKey: String!, $datasetKey: String!, $identifier: String!) {
      fetchRecordByIdentifier(publisherSlug: $publisherSlug, gameKey: $gameKey, datasetKey: $datasetKey, identifier: $identifier) {
        #{record_fields}
      }
    }
  GRAPHQL
end

.fetch_recordsObject

Builds a fetchRecords query



239
240
241
242
243
244
245
246
247
# File 'lib/carddb/query_builder.rb', line 239

def fetch_records
  <<~GRAPHQL
    query FetchRecords($ids: [UUID!]!) {
      fetchRecords(ids: $ids) {
        #{record_fields}
      }
    }
  GRAPHQL
end

.fetch_records_by_identifierObject

Builds a fetchRecordsByIdentifier query



217
218
219
220
221
222
223
224
225
# File 'lib/carddb/query_builder.rb', line 217

def fetch_records_by_identifier
  <<~GRAPHQL
    query FetchRecordsByIdentifier($publisherSlug: String!, $gameKey: String!, $datasetKey: String!, $identifiers: [String!]!) {
      fetchRecordsByIdentifier(publisherSlug: $publisherSlug, gameKey: $gameKey, datasetKey: $datasetKey, identifiers: $identifiers) {
        #{record_fields}
      }
    }
  GRAPHQL
end

.list_my_decks(first: nil, after: nil) ⇒ Object

Builds a myDecks query



250
251
252
253
254
255
256
257
258
259
260
# File 'lib/carddb/query_builder.rb', line 250

def list_my_decks(first: nil, after: nil)
  args = build_args({ first: first, after: after })

  <<~GRAPHQL
    query MyDecks#{args[:definition]} {
      myDecks#{args[:call]} {
        #{deck_connection_fields}
      }
    }
  GRAPHQL
end

.my_deckObject

Builds a myDeck query



274
275
276
277
278
279
280
281
282
# File 'lib/carddb/query_builder.rb', line 274

def my_deck
  <<~GRAPHQL
    query MyDeck($id: UUID!) {
      myDeck(id: $id) {
        #{deck_fields}
      }
    }
  GRAPHQL
end

.publish_deckObject

Builds a deckPublish mutation



386
387
388
389
390
391
392
393
394
# File 'lib/carddb/query_builder.rb', line 386

def publish_deck
  <<~GRAPHQL
    mutation DeckPublish($id: UUID!, $input: DeckPublishInput!) {
      deckPublish(id: $id, input: $input) {
        #{deck_version_fields}
      }
    }
  GRAPHQL
end

.remove_deck_collaboratorObject

Builds a deckCollaboratorRemove mutation



408
409
410
411
412
413
414
# File 'lib/carddb/query_builder.rb', line 408

def remove_deck_collaborator
  <<~GRAPHQL
    mutation DeckCollaboratorRemove($deckId: UUID!, $accountId: UUID!) {
      deckCollaboratorRemove(deckId: $deckId, accountId: $accountId)
    }
  GRAPHQL
end

.revoke_deck_preview_tokenObject

Builds a deckPreviewTokenRevoke mutation



431
432
433
434
435
436
437
# File 'lib/carddb/query_builder.rb', line 431

def revoke_deck_preview_token
  <<~GRAPHQL
    mutation DeckPreviewTokenRevoke($id: UUID!) {
      deckPreviewTokenRevoke(id: $id)
    }
  GRAPHQL
end

.search_datasets(publisher_slug: nil, game_key: nil, search: nil, purpose: nil, first: nil, after: nil) ⇒ Object

Builds a searchDatasets query



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/carddb/query_builder.rb', line 113

def search_datasets(publisher_slug: nil, game_key: nil, search: nil, purpose: nil, first: nil, after: nil)
  args = build_args({
                      publisherSlug: publisher_slug,
                      gameKey: game_key,
                      search: search,
                      purpose: purpose,
                      first: first,
                      after: after
                    })

  <<~GRAPHQL
    query SearchDatasets#{args[:definition]} {
      searchDatasets#{args[:call]} {
        #{dataset_connection_fields}
      }
    }
  GRAPHQL
end

.search_games(publisher_slug: nil, search: nil, first: nil, after: nil) ⇒ Object

Builds a searchGames query



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/carddb/query_builder.rb', line 62

def search_games(publisher_slug: nil, search: nil, first: nil, after: nil)
  args = build_args({
                      publisherSlug: publisher_slug,
                      search: search,
                      first: first,
                      after: after
                    })

  <<~GRAPHQL
    query SearchGames#{args[:definition]} {
      searchGames#{args[:call]} {
        #{game_connection_fields}
      }
    }
  GRAPHQL
end

.search_publishers(search: nil, first: nil, after: nil) ⇒ Object

Builds a searchPublishers query



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'lib/carddb/query_builder.rb', line 12

def search_publishers(search: nil, first: nil, after: nil)
  args = build_args({
                      search: search,
                      first: first,
                      after: after
                    })

  <<~GRAPHQL
    query SearchPublishers#{args[:definition]} {
      searchPublishers#{args[:call]} {
        #{publisher_connection_fields}
      }
    }
  GRAPHQL
end

.search_records(publisher_slug:, game_key:, dataset_key:, filter: nil, search: nil, order_by: nil, resolve_links: nil, first: nil, after: nil, validate_schema: nil) ⇒ Object

Builds a searchRecords query



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/carddb/query_builder.rb', line 168

def search_records(
  publisher_slug:,
  game_key:,
  dataset_key:,
  filter: nil,
  search: nil,
  order_by: nil,
  resolve_links: nil,
  first: nil,
  after: nil,
  validate_schema: nil
)
  args = build_args(
    {
      publisherSlug: publisher_slug,
      gameKey: game_key,
      datasetKey: dataset_key,
      filter: filter,
      search: search,
      orderBy: order_by,
      resolveLinks: resolve_links,
      first: first,
      after: after,
      validateSchema: validate_schema
    },
    required: %i[publisherSlug gameKey datasetKey]
  )

  <<~GRAPHQL
    query SearchRecords#{args[:definition]} {
      searchRecords#{args[:call]} {
        #{record_connection_fields(include_resolved_links: resolve_links&.any?)}
      }
    }
  GRAPHQL
end

.update_deckObject

Builds a deckUpdate mutation



375
376
377
378
379
380
381
382
383
# File 'lib/carddb/query_builder.rb', line 375

def update_deck
  <<~GRAPHQL
    mutation DeckUpdate($id: UUID!, $input: DeckUpdateInput!) {
      deckUpdate(id: $id, input: $input) {
        #{deck_fields}
      }
    }
  GRAPHQL
end

.upsert_deck_collaboratorObject

Builds a deckCollaboratorUpsert mutation



397
398
399
400
401
402
403
404
405
# File 'lib/carddb/query_builder.rb', line 397

def upsert_deck_collaborator
  <<~GRAPHQL
    mutation DeckCollaboratorUpsert($deckId: UUID!, $accountId: UUID!, $role: DeckCollaboratorRole!) {
      deckCollaboratorUpsert(deckId: $deckId, accountId: $accountId, role: $role) {
        #{deck_collaborator_fields}
      }
    }
  GRAPHQL
end