Class: Types::BaseObject

Inherits:

GraphQL::Schema::Object

Object
GraphQL::Schema::Object
Types::BaseObject

show all

Includes:: Gitlab::Graphql::Authz::AuthorizeGranularToken, Gitlab::Graphql::ExposePermissions, Gitlab::Graphql::MarkdownField, Gitlab::Graphql::Present, Gitlab::Graphql::VersionFilter::FutureFieldFallback

Defined in:: app/graphql/types/base_object.rb

Direct Known Subclasses

Class Method Summary collapse

Instance Method Summary collapse

#current_user ⇒ Object
#id ⇒ Object

All graphql fields exposing an id, should expose a global id.

Methods included from Gitlab::Graphql::Present

#present, #unpresented

Class Method Details

.accepts(*types) ⇒ `Object`

# File 'app/graphql/types/base_object.rb', line 22

def self.accepts(*types)
  @accepts ||= []
  @accepts += types
  @accepts
end

.assignable?(object) ⇒ `Boolean`

Returns:

(Boolean)

# File 'app/graphql/types/base_object.rb', line 52

def self.assignable?(object)
  assignable = accepts

  return true if assignable.blank?

  assignable.any? { |cls| object.is_a?(cls) }
end

.authorization ⇒ `Object`



37
38
39

# File 'app/graphql/types/base_object.rb', line 37

def self.authorization
  @authorization ||= ::Gitlab::Graphql::Authorize::ObjectAuthorization.new(authorize, authorization_scopes)
end

.authorization_scopes ⇒ `Object`



33
34
35

# File 'app/graphql/types/base_object.rb', line 33

def self.authorization_scopes
  [:api, :read_api]
end

.authorize(*args) ⇒ `Object`

# File 'app/graphql/types/base_object.rb', line 15

def self.authorize(*args)
  raise 'Cannot redefine authorize' if @authorize_args && args.any?

  @authorize_args = args.freeze if args.any?
  @authorize_args || (superclass.respond_to?(:authorize) ? superclass.authorize : nil)
end

.authorized?(object, context) ⇒ `Boolean`

Returns:

(Boolean)

# File 'app/graphql/types/base_object.rb', line 41

def self.authorized?(object, context)
  authorization.ok?(object, context[:current_user],
    scope_validator: context[:scope_validator],
    skip_abilities: context[:skip_type_authorization]
  )
end

Instance Method Details

#current_user ⇒ `Object`



48
49
50

# File 'app/graphql/types/base_object.rb', line 48

def current_user
  context[:current_user]
end

#id ⇒ `Object`

All graphql fields exposing an id, should expose a global id.



29
30
31

# File 'app/graphql/types/base_object.rb', line 29

def id
  GitlabSchema.id_from_object(object)
end

Class: Types::BaseObject

Direct Known Subclasses

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Graphql::Present

Class Method Details

.accepts(*types) ⇒ Object

.assignable?(object) ⇒ Boolean

.authorization ⇒ Object

.authorization_scopes ⇒ Object

.authorize(*args) ⇒ Object

.authorized?(object, context) ⇒ Boolean

Instance Method Details

#current_user ⇒ Object

#id ⇒ Object

.accepts(*types) ⇒ `Object`

.assignable?(object) ⇒ `Boolean`

.authorization ⇒ `Object`

.authorization_scopes ⇒ `Object`

.authorize(*args) ⇒ `Object`

.authorized?(object, context) ⇒ `Boolean`

#current_user ⇒ `Object`

#id ⇒ `Object`