openproject/lib/api/v3/principals/principal_representer_factory.rb

#-- encoding: UTF-8

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
# See docs/COPYRIGHT.rdoc for more details.
#++

module API
  module V3
    module Principals
      class PrincipalRepresenterFactory
        ##
        # Create the appropriate subclass representer
        # for each principal entity
        def self.create(model, **args)
          representer_class(model)
            .create(model, **args)
        end

        def self.representer_class(model)
          case model
          when User
            ::API::V3::Users::UserRepresenter
          when Group
            ::API::V3::Groups::GroupRepresenter
          when PlaceholderUser
            ::API::V3::PlaceholderUsers::PlaceholderUserRepresenter
          else
            raise ArgumentError, "Missing concrete principal representer for #{model}"
          end
        end

        def self.create_link_lambda(name, getter: "#{name}_id")
          ->(*) {
            v3_path = API::V3::Principals::PrincipalRepresenterFactory.v3_path(represented.send(name))

            instance_exec(&self.class.associated_resource_default_link(name,
                                                                       v3_path: v3_path,
                                                                       skip_link: -> { false },
                                                                       title_attribute: :name,
                                                                       getter: getter))
          }
        end

        def self.create_setter_lambda(name, property_name: name, namespaces: %i(groups users placeholder_users))
          ->(fragment:, **) {
            ::API::Decorators::LinkObject
              .new(represented,
                   property_name: property_name,
                   namespace: namespaces,
                   getter: :"#{name}_id",
                   setter: :"#{name}_id=")
              .from_hash(fragment)
          }
        end

        def self.create_getter_lambda(name)
          ->(*) {
            next unless embed_links

            instance = represented.send(name)
            next if instance.nil?

            ::API::V3::Principals::PrincipalRepresenterFactory
              .create(represented.send(name), current_user: current_user)
          }
        end

        def self.v3_path(instance)
          case instance
          when User
            :user
          when Group
            :group
          when PlaceholderUser
            :placeholder_user
          when NilClass
            # Fall back to user for unknown principal
            # since we do not have a principal route.
            :user
          else
            raise "undefined subclass for #{instance}"
          end
        end
      end
    end
  end
end