60f5068a-f9b4-46e9-98a4-717f91830714

Committed 03 Nov 2025 06:36PM UTC coverage: 91.4%. Remained the same

Build # 60f5068a-f9b4-46e9-98a4-717f91830714

Build Type

Pull #2137

circleci

Committed by

JaymeeH

Commit Message

update system specs

Pull Request Pull Request #2137: I2105 request header

Run Details

2827 of 3093 relevant lines covered (91.4%)

485.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/app/services/princeton_users.rb

# frozen_string_literal: true
class PrincetonUsers
  CHARS_AND_NUMS =  ('a'..'z').to_a + (0..9).to_a + ['-']
  RDSS_DEVELOPERS = %w[bs3097 jrg5 cac9 hc8719 rl3667 kl37 pp9425 jh6441].freeze

  class << self


    # Returns a list of Users that match the given query
    def user_list_query(query)
      tokens = query.downcase.strip.split(/[^a-zA-Z\d]/).compact_blank
      return [] if tokens.count == 0
      if (tokens.count == 1)
        # if I have a single token I might be trying a uid search, so put all the uid matches at the top
        uid_query(tokens[0]) | name_query(tokens)
      else
        name_query(tokens)
      end.map{|user| { uid: user.uid, name: user.display_name, display_name: user.display_name_safe } }
    end

    def uid_query(token)
      order_sql = User.sanitize_sql_for_order("LENGTH(uid)-LENGTH('#{token}')")
      search_token = User.sanitize_sql_like(token)+'%'
      User.where("(uid like ?)",search_token).order(Arel.sql(order_sql)).order(:uid)
    end

    def name_query(tokens)
      tokens.inject(User.all) do |partial_query, token|
        search_token = '%'+User.sanitize_sql_like(token)+'%'
        partial_query.where("(LOWER(display_name) like ?) OR (LOWER(uid) like ?)", search_token, search_token)
      end.order(:given_name).order(:family_name)
    end

    def load_rdss_developers
      RDSS_DEVELOPERS.each do |netid|
        create_user_from_ldap_by_uid(netid)
        rescue TigerData::LdapError
        raise TigerData::LdapError, "Unable to create user from LDAP. Are you connected to VPN?"
      end
    end

    # Creates users from LDAP data, starting with the given uid prefix.
    def create_users_from_ldap(current_uid_start: "", ldap_connection: default_ldap_connection)
      CHARS_AND_NUMS.each do |char|
        filter =(~ Net::LDAP::Filter.eq( "pustatus", "guest" )) & Net::LDAP::Filter.eq("uid", "#{current_uid_start}#{char}*")
        people = ldap_connection.search(filter:, attributes: [:pudisplayname, :givenname, :sn, :uid, :edupersonprincipalname]);
        if ldap_connection.get_operation_result.message == "Success"
          people.each{|person| user_from_ldap(person)}
        else
          create_users_from_ldap(current_uid_start: "#{current_uid_start}#{char}", ldap_connection:)
        end
      end
    end

    def create_user_from_ldap_by_uid(uid, ldap_connection: default_ldap_connection)
      filter = Net::LDAP::Filter.eq('uid', uid)
      person = ldap_connection.search(filter:, attributes: [:pudisplayname, :givenname, :sn, :uid, :edupersonprincipalname]);
      raise TigerData::LdapError, "More than one user matches supplied uid: #{uid}" if person.length > 1
      raise TigerData::LdapError, "No user with uid #{uid} found" if person.empty?
      user_from_ldap(person.first)
    end

  # Creates or updates a User from an LDAP entry.
  # @param ldap_person [Net::LDAP::Entry] an LDAP entry representing a person
  # @return [User, nil] the created or updated User, or nil if the LDAP entry is missing a edupersonprincipalname
    def user_from_ldap(ldap_person)
      return if check_for_malformed_ldap_entries(ldap_person)
      uid = ldap_person[:uid].first.downcase
      current_entries = User.where(uid:)
      if current_entries.empty?
        User.create(uid: , display_name: ldap_person[:pudisplayname].first,
                    family_name: ldap_person[:sn].first, given_name: ldap_person[:givenname].first,
                    email: ldap_person[:edupersonprincipalname].first, provider: "cas")
      else
        user = current_entries.first
        if user.display_name.blank?
          user.display_name = ldap_person[:pudisplayname].first
          user.family_name = ldap_person[:sn].first
          user.given_name = ldap_person[:givenname].first
          user.provider = "cas"
          user.save
        end
        user
      end
    end

    # If any required LDAP fields are missing, return true
    # @param ldap_person [Net::LDAP::Entry] an LDAP entry representing a person
    # @return [Boolean] true if the LDAP entry is missing required fields, false otherwise
    def check_for_malformed_ldap_entries(ldap_person)
      uid_blank = ldap_person[:uid].blank?
      edupersonprincipalname_blank = ldap_person[:edupersonprincipalname].blank?
      malformed = uid_blank || edupersonprincipalname_blank
      malformed
    end

    def default_ldap_connection
      @default_ldap_connection ||= Net::LDAP.new host: "ldap.princeton.edu", base: "o=Princeton University,c=US", port: 636,
                                                  encryption: {
                                                    method: :simple_tls,
                                                    tls_options: OpenSSL::SSL::SSLContext::DEFAULT_PARAMS
                                                  }
    end
  end
end

1	# frozen_string_literal: true
2	class PrincetonUsers	2✔
3	CHARS_AND_NUMS = ('a'..'z').to_a + (0..9).to_a + ['-']	2✔
4	RDSS_DEVELOPERS = %w[bs3097 jrg5 cac9 hc8719 rl3667 kl37 pp9425 jh6441].freeze	2✔
5
6	class << self	2✔
7
8
9	# Returns a list of Users that match the given query
10	def user_list_query(query)	2✔
11	tokens = query.downcase.strip.split(/[^a-zA-Z\d]/).compact_blank	26✔
12	return [] if tokens.count == 0	26✔
13	if (tokens.count == 1)	25✔
14	# if I have a single token I might be trying a uid search, so put all the uid matches at the top
15	uid_query(tokens[0]) \| name_query(tokens)	16✔
16	else
17	name_query(tokens)	9✔
18	end.map{\|user\| { uid: user.uid, name: user.display_name, display_name: user.display_name_safe } }	27✔
19	end
20
21	def uid_query(token)	2✔
22	order_sql = User.sanitize_sql_for_order("LENGTH(uid)-LENGTH('#{token}')")	16✔
23	search_token = User.sanitize_sql_like(token)+'%'	16✔
24	User.where("(uid like ?)",search_token).order(Arel.sql(order_sql)).order(:uid)	16✔
25	end
26
27	def name_query(tokens)	2✔
28	tokens.inject(User.all) do \|partial_query, token\|	25✔
29	search_token = '%'+User.sanitize_sql_like(token)+'%'	37✔
30	partial_query.where("(LOWER(display_name) like ?) OR (LOWER(uid) like ?)", search_token, search_token)	37✔
31	end.order(:given_name).order(:family_name)
32	end
33
34	def load_rdss_developers	2✔
35	RDSS_DEVELOPERS.each do \|netid\|	2✔
36	create_user_from_ldap_by_uid(netid)	9✔
37	rescue TigerData::LdapError
38	raise TigerData::LdapError, "Unable to create user from LDAP. Are you connected to VPN?"	1✔
39	end
40	end
41
42	# Creates users from LDAP data, starting with the given uid prefix.
43	def create_users_from_ldap(current_uid_start: "", ldap_connection: default_ldap_connection)	2✔
44	CHARS_AND_NUMS.each do \|char\|	5✔
45	filter =(~ Net::LDAP::Filter.eq( "pustatus", "guest" )) & Net::LDAP::Filter.eq("uid", "#{current_uid_start}#{char}*")	185✔
46	people = ldap_connection.search(filter:, attributes: [:pudisplayname, :givenname, :sn, :uid, :edupersonprincipalname]);	185✔
47	if ldap_connection.get_operation_result.message == "Success"	185✔
48	people.each{\|person\| user_from_ldap(person)}	188✔
49	else
50	create_users_from_ldap(current_uid_start: "#{current_uid_start}#{char}", ldap_connection:)	1✔
51	end
52	end
53	end
54
55	def create_user_from_ldap_by_uid(uid, ldap_connection: default_ldap_connection)	2✔
56	filter = Net::LDAP::Filter.eq('uid', uid)	8✔
57	person = ldap_connection.search(filter:, attributes: [:pudisplayname, :givenname, :sn, :uid, :edupersonprincipalname]);	8✔
58	raise TigerData::LdapError, "More than one user matches supplied uid: #{uid}" if person.length > 1	8✔
59	raise TigerData::LdapError, "No user with uid #{uid} found" if person.empty?	8✔
60	user_from_ldap(person.first)	8✔
61	end
62
63	# Creates or updates a User from an LDAP entry.
64	# @param ldap_person [Net::LDAP::Entry] an LDAP entry representing a person
65	# @return [User, nil] the created or updated User, or nil if the LDAP entry is missing a edupersonprincipalname
66	def user_from_ldap(ldap_person)	2✔
67	return if check_for_malformed_ldap_entries(ldap_person)	16✔
68	uid = ldap_person[:uid].first.downcase	13✔
69	current_entries = User.where(uid:)	13✔
70	if current_entries.empty?	13✔
71	User.create(uid: , display_name: ldap_person[:pudisplayname].first,	12✔
72	family_name: ldap_person[:sn].first, given_name: ldap_person[:givenname].first,
73	email: ldap_person[:edupersonprincipalname].first, provider: "cas")
74	else
75	user = current_entries.first	1✔
76	if user.display_name.blank?	1✔
77	user.display_name = ldap_person[:pudisplayname].first	1✔
78	user.family_name = ldap_person[:sn].first	1✔
79	user.given_name = ldap_person[:givenname].first	1✔
80	user.provider = "cas"	1✔
81	user.save	1✔
82	end
83	user	1✔
84	end
85	end
86
87	# If any required LDAP fields are missing, return true
88	# @param ldap_person [Net::LDAP::Entry] an LDAP entry representing a person
89	# @return [Boolean] true if the LDAP entry is missing required fields, false otherwise
90	def check_for_malformed_ldap_entries(ldap_person)	2✔
91	uid_blank = ldap_person[:uid].blank?	17✔
92	edupersonprincipalname_blank = ldap_person[:edupersonprincipalname].blank?	17✔
93	malformed = uid_blank \|\| edupersonprincipalname_blank	17✔
94	malformed	17✔
95	end
96
97	def default_ldap_connection	2✔
98	@default_ldap_connection \|\|= Net::LDAP.new host: "ldap.princeton.edu", base: "o=Princeton University,c=US", port: 636,	9✔
99	encryption: {
100	method: :simple_tls,
101	tls_options: OpenSSL::SSL::SSLContext::DEFAULT_PARAMS
102	}
103	end
104	end
105	end

pulibrary / tigerdata-app / 60f5068a-f9b4-46e9-98a4-717f91830714

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous