lib/gitlab/client/avatar.rb - ruby-gitlab (87adcfe)

Tree @87adcfe (Download .tar.gz)

..
access_requests.rb
application_settings.rb
avatar.rb
award_emojis.rb
boards.rb
branches.rb
broadcast_messages.rb
build_variables.rb
builds.rb
commits.rb
container_registry.rb
deployments.rb
environments.rb
epics.rb
events.rb
features.rb
group_boards.rb
group_labels.rb
group_milestones.rb
groups.rb
issue_links.rb
issues.rb
jobs.rb
keys.rb
labels.rb
lint.rb
markdown.rb
merge_request_approvals.rb
merge_requests.rb
milestones.rb
namespaces.rb
notes.rb
pipeline_schedules.rb
pipeline_triggers.rb
pipelines.rb
project_badges.rb
project_clusters.rb
project_release_links.rb
project_releases.rb
projects.rb
protected_tags.rb
repositories.rb
repository_files.rb
repository_submodules.rb
resource_label_events.rb
runners.rb
search.rb
services.rb
sidekiq.rb
snippets.rb
system_hooks.rb
tags.rb
templates.rb
todos.rb
users.rb
versions.rb
wikis.rb

avatar.rb @87adcfe — raw · history · blame

# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to avatar.
  # @see https://docs.gitlab.com/ce/api/avatar.html
  module Avatar
    # Get a single avatar URL for a user with the given email address.
    #
    # @example
    #   Gitlab.avatar(email: 'admin@example.com')
    #   Gitlab.avatar(email: 'admin@example.com', size: 32)
    #
    # @param  [Hash] options A customizable set of options.
    # @option options [String] :email(required) Public email address of the user.
    # @option options [Integer] :size(optional) Single pixel dimension (since images are squares). Only used for avatar lookups at Gravatar or at the configured Libravatar server.
    # @return <Gitlab::ObjectifiedHash>
    def avatar(options = {})
      get('/avatar', query: options)
    end
  end
end