Class: CardDB::Resource

Inherits:

Object

• Object
• CardDB::Resource

Defined in:

lib/carddb/collection.rb

Overview

Base class for resource wrappers

Direct Known Subclasses

Dataset, Deck, DeckAPIApplicationAccess, DeckAccessApplication, DeckAccessToken, DeckAccessTokenExchangePayload, DeckAccessTokenIssuer, DeckCollaborator, DeckDiff, DeckEmbedToken, DeckEmbedTokenCreatePayload, DeckEntry, DeckEntryMutationPayload, DeckEntryReorderPayload, DeckExportPayload, DeckHydrateEntriesPayload, DeckImportAmbiguousEntry, DeckImportCandidate, DeckImportEntry, DeckImportFormatDefinition, DeckImportFormatDetection, DeckImportIssue, DeckOwnershipTransferPayload, DeckPreviewToken, DeckPreviewTokenCreatePayload, DeckPublishPayload, DeckSectionDefinition, DeckUpsertByExternalRefPayload, DeckValidatedAgainst, DeckValidation, DeckValidationAffectedEntry, DeckValidationIssue, DeckVersion, Game, Publisher, Record

Instance Attribute Summary

• #client ⇒ Client^? readonly

  The client instance for making related queries.

• #data ⇒ Hash readonly

  The raw data from the API.

Instance Method Summary

• #[](key) ⇒ Object

  Access raw data fields.

• #initialize(data, client: nil) ⇒ Resource constructor

  A new instance of Resource.

• #key?(key) ⇒ Boolean

  Check if a field exists.

• #to_h ⇒ Object
• #to_json(*args) ⇒ Object

Constructor Details

#initialize(data, client: nil) ⇒ Resource

Returns a new instance of Resource.

# File 'lib/carddb/collection.rb', line 226

def initialize(data, client: nil)
  @data = data || {}
  @client = client
end

Instance Attribute Details

#client ⇒ Client^? (readonly)

Returns The client instance for making related queries.

Returns:

• (Client, nil) —

  The client instance for making related queries

# File 'lib/carddb/collection.rb', line 224

def client
  @client
end

#data ⇒ Hash (readonly)

Returns The raw data from the API.

Returns:

• (Hash) —

  The raw data from the API

# File 'lib/carddb/collection.rb', line 221

def data
  @data
end

Instance Method Details

#[](key) ⇒ Object

Access raw data fields

# File 'lib/carddb/collection.rb', line 232

def [](key)
  data[key.to_s]
end

#key?(key) ⇒ Boolean

Check if a field exists

Returns:

• (Boolean)

# File 'lib/carddb/collection.rb', line 237

def key?(key)
  data.key?(key.to_s)
end

#to_h ⇒ Object

# File 'lib/carddb/collection.rb', line 241

def to_h
  data
end

#to_json(*args) ⇒ Object

# File 'lib/carddb/collection.rb', line 245

def to_json(*args)
  data.to_json(*args)
end