class

App::Models::ApiKey

Inherits PgORM::Timestamps < PgORM::Base < PgORM::Validators < PgORM::Table < PgORM::Persistence < PgORM::Associations < ActiveModel::Callbacks < ActiveModel::Validation < ActiveModel::Model < DB::Mappable < DB::Serializable < YAML::Serializable < JSON::Serializable < Reference < Object

Constants

CALLBACKS = { before_save: [do if (__temp_252 = @user) && __temp_252.new_record? __temp_252.save self.user_id = __temp_252.id.not_nil! end end] of Nil, after_save: [] of Nil, before_create: [do self.created_at = self.updated_at = Time.utc end] of Nil, after_create: [] of Nil, before_update: [do self.updated_at = Time.utc end] of Nil, after_update: [] of Nil, before_destroy: [] of Nil, after_destroy: [do end] of Nil, }

PRIMARY_KEY_TYPES = {:id => UUID} of Nil => Nil

macro level key => type

PRIMARY_KEYS = [{:id}]

Constructors

from_json(string_or_io : String | IO, trusted : Bool = false) : self

from_json(string_or_io : String | IO, root : String, trusted : Bool = false) : self

Deserializes the given JSON in string_or_io into an instance of self, assuming the JSON consists of an JSON object with key root, and whose value is the value to deserialize. Will not deserialise from fields with mass_assign: false

class User < ActiveModel::Model
  attribute name : String
  attribute google_id : UUID, mass_assign: false
end

User.from_json(%({"main": {"name": "Jason", "google_id": "f6f70bfb-c882-446d-8758-7ce47db39620"}}), root: "main") # => #<User:0x103131b20 @name="Jason">

from_trusted_json(string_or_io : String | IO, root : String) : self

from_trusted_json(string_or_io : String | IO) : self

Serialize from a trusted JSON source

from_trusted_yaml(string_or_io : String | IO) : self

Serialize from a trusted YAML source

from_yaml(string_or_io : String | IO, trusted : Bool = false) : self

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

new(pull : JSON::PullParser)

new(rs : DB::ResultSet)

new(id : UUID | ActiveModel::Model::None = ::ActiveModel::Model::None.new, user_id : UUID | ActiveModel::Model::None = ::ActiveModel::Model::None.new, name : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, key_hash : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, key_prefix : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, scopes : Array(String) | ActiveModel::Model::None = ::ActiveModel::Model::None.new, expires_at : Time | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, last_used_at : Time | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, created_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, updated_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new)

new(params : HTTP::Params | Hash(String, String) | Tuple(String, String))

Initialize App::Models::ApiKey from HTTP::Params.

Class methods

attributes

Returns all attribute keys.

authenticate(raw_key : String) : ApiKey | Nil

Verify and return the API key if valid

by_user_id(id)

changes(id : UUID | Nil = nil) : ChangeFeed

Changefeed at row (if id passed) or whole table level. Returns a ChangeFeed instance which can be used to invoke async callbacks via on or use blocking Iterator via each method.

create_for_user(user : User, name : String, scopes : Array(String) = [] of String, expires_at : Time | Nil = nil) : Tuple(ApiKey, String)

Generate a new API key and return the raw key (only shown once)

find_by_key(raw_key : String) : ApiKey | Nil

Find API key by raw key

from_rs(__temp_447 : DB::ResultSet)

on_error(err : Exception | IO::Error)

primary_key

table_name

Instance methods

after_create

after_destroy

after_initialize(trusted : Bool)

after_save

after_update

apply_defaults

Generate code to apply default values

assign_attributes(id : UUID | Missing = Missing, user_id : UUID | Missing = Missing, name : String | Missing = Missing, key_hash : String | Missing = Missing, key_prefix : String | Missing = Missing, scopes : Array(String) | Missing = Missing, expires_at : Time | Nil | Missing = Missing, last_used_at : Time | Nil | Missing = Missing, created_at : Time | Missing = Missing, updated_at : Time | Missing = Missing)

Assign to multiple attributes.

assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))

Assign to mulitple attributes via HTTP::Params.

assign_attributes(model : App::Models::ApiKey)

Assign to multiple attributes from a model object

assign_attributes_from_json(json, root : String)

assign_attributes_from_json(json)

assign_attributes_from_trusted_json(json, root : String)

assign_attributes_from_trusted_json(json)

Assign each field from JSON if field exists in JSON and has changed in model

assign_attributes_from_trusted_yaml(yaml)

assign_attributes_from_yaml(yaml)

Uses the YAML parser as JSON is valid YAML

attributes

Returns a Hash of all attribute values

attributes_tuple

Returns a NamedTuple of all attribute values.

before_create

before_destroy

before_save

before_update

build_user

changed?

Check if any attributes have changed.

changed_attributes

Returns a Hash with all changed attributes.

changed_json(io : IO) : Nil

Serialize the set of changed attributes to JSON.

changed_json

Serialize the set of changed attributes to JSON.

changed_persist_attributes

changed_yaml(io : IO) : Nil

Serialize the set of changed attributes to YAML.

changed_yaml

Serialize the set of changed attributes to YAML.

clear_changes_information

Reset changes for all attributes.

create_user

create_user!

created_at

created_at getter

created_at=(value : Time)

created_at setter

created_at?

Assign instance variable to correct type

created_at_assigned?

created_at_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

created_at_changed?

created_at_default

created_at's default value

created_at_present?

created_at_removed?

created_at_was

created_at_will_change!

Include created_at in the set of changed attributes, whether it has changed or not.

expired?

expires_at

expires_at getter

expires_at=(value : Time | Nil)

expires_at setter

expires_at_assigned?

expires_at_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

expires_at_changed?

expires_at_default

expires_at's default value

expires_at_present?

expires_at_removed?

expires_at_was

expires_at_will_change!

Include expires_at in the set of changed attributes, whether it has changed or not.

has_scope?(scope : String) : Bool

id

id getter

id=(value : UUID)

Setters id setter

id?

Assign instance variable to correct type

id_assigned?

id_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

id_changed?

id_default

id's default value

id_present?

id_removed?

id_was

id_will_change!

Include id in the set of changed attributes, whether it has changed or not.

invoke_props

key_hash

key_hash getter

key_hash=(value : String)

key_hash setter

key_hash?

Assign instance variable to correct type

key_hash_assigned?

key_hash_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

key_hash_changed?

key_hash_default

key_hash's default value

key_hash_present?

key_hash_removed?

key_hash_was

key_hash_will_change!

Include key_hash in the set of changed attributes, whether it has changed or not.

key_prefix

key_prefix getter

key_prefix=(value : String)

key_prefix setter

key_prefix?

Assign instance variable to correct type

key_prefix_assigned?

key_prefix_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

key_prefix_changed?

key_prefix_default

key_prefix's default value

key_prefix_present?

key_prefix_removed?

key_prefix_was

key_prefix_will_change!

Include key_prefix in the set of changed attributes, whether it has changed or not.

last_used_at

last_used_at getter

last_used_at=(value : Time | Nil)

last_used_at setter

last_used_at_assigned?

last_used_at_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

last_used_at_changed?

last_used_at_default

last_used_at's default value

last_used_at_present?

last_used_at_removed?

last_used_at_was

last_used_at_will_change!

Include last_used_at in the set of changed attributes, whether it has changed or not.

name

name getter

name=(value : String)

name setter

name?

Assign instance variable to correct type

name_assigned?

name_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

name_changed?

name_default

name's default value

name_present?

name_removed?

name_was

name_will_change!

Include name in the set of changed attributes, whether it has changed or not.

persistent_attributes

Returns a Hash of all attributes that can be persisted.

primary_key

primary_key_hash

reload_user

reload_user?

restore_attributes

Reset each attribute to their previous values and clears all changes.

run_create_callbacks

Wrap a block with callbacks for the appropriate crud operation

run_destroy_callbacks

run_save_callbacks

run_update_callbacks

scopes

scopes getter

scopes=(value : Array(String))

scopes setter

scopes?

Assign instance variable to correct type

scopes_assigned?

scopes_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

scopes_changed?

scopes_default

scopes's default value

scopes_present?

scopes_removed?

scopes_was

scopes_will_change!

Include scopes in the set of changed attributes, whether it has changed or not.

table_name

touch_last_used!

updated_at

updated_at getter

updated_at=(value : Time)

updated_at setter

updated_at?

Assign instance variable to correct type

updated_at_assigned?

updated_at_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

updated_at_changed?

updated_at_default

updated_at's default value

updated_at_present?

updated_at_removed?

updated_at_was

updated_at_will_change!

Include updated_at in the set of changed attributes, whether it has changed or not.

user

user!

user=(record : User) : User

user?

user_id

user_id getter

user_id=(value : UUID)

user_id setter

user_id?

Assign instance variable to correct type

user_id_assigned?

user_id_change

Returns a Tuple of the previous and the current value of an instance variable if it has changed

user_id_changed?

user_id_default

user_id's default value

user_id_present?

user_id_removed?

user_id_was

user_id_will_change!

Include user_id in the set of changed attributes, whether it has changed or not.

valid_key?

validate_nilability

Validate that all non-nillable fields have values.

Nested types