canvas-lms/lib/api/v1/collaborator.rb

#
# Copyright (C) 2011 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

module Api::V1::Collaborator
  include Api::V1::Json

  def collaborator_json(collaborator, current_user, session, options = {})
    includes = options[:include] || []
    api_json(collaborator, current_user, session, :only => %w{id}).tap do |hash|
      hash['type'] = collaborator.group_id.present? ? 'group' : 'user'
      hash['name'] = collaborator.user.try(:sortable_name) ||
        collaborator.group.try(:name)
      hash['collaborator_id'] = collaborator.user.try(:id) ||
        collaborator.group.id

      if includes.include?('collaborator_lti_id')
        hash['collaborator_lti_id'] = collaborator.user ? Lti::Asset.opaque_identifier_for(collaborator.user) :
          Lti::Asset.opaque_identifier_for(collaborator.group)
      end

      if includes.include?('avatar_image_url')
        hash['avatar_image_url'] = collaborator.user.try(:avatar_image_url)
      end
    end
  end
end