gitlab-username_bot_identifier 0.0.0 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61448d4b39f857c6cf407db135cbd4878fade66d4b553be2061cb120387f4cc7
-  data.tar.gz: 86f4f01c85e9e55978618cbbcd284e8ec0392b81e0fa8c8644336d711ab33424
+  metadata.gz: cf9f063618ac152d43990861d48e25559d661d60f1d6d86203750f34a86519ec
+  data.tar.gz: e2935cb8583d27c6b123b19cc946ebd0cdd57f260fc1ee802cd1cff0418c1574
 SHA512:
-  metadata.gz: efd118e83d9b89224227f2fb30cc246d9ca47607648fd12f4d78e0328ea32f5bd9e0d85154240aaefdfe539dd00341d7d26bfd9bd274158eb1e958fcd49e2445
-  data.tar.gz: 5f0ea73dc0b6c5f8c7c2b9d68f1d5bb4eed338942b45ad5c2ef58ded3e0341f6a0403cc37b09e3a5bd2f3784a2c19f90e167c8fa8c6870d35ecacfd6918210ad
+  metadata.gz: b305f1d4806fe5b91aa96707cba751a1d464fadc0900f2a506f2745b9e7975b7837e374bd1d1034fc0b3246ae2fdb5d61c8754ddeb3698c7fd969da4143495c0
+  data.tar.gz: 514df816a4c5c365d072ef50a2801df7acb9a39fbf439f7ee42963fa5eda9f318ca24216a7d8b0935ee2225f617096ec7df56fbcb81f7ad9f4bcfdc8befae4f2

data/lib/gitlab/username_bot_identifier.rb

@@ -1,10 +1,77 @@
 # frozen_string_literal: true
 
-require_relative "username_bot_identifier/version"
-
 module Gitlab
-  module UsernameBotIdentifier
-    class Error < StandardError; end
-    raise "Reserved for GitLab"
+  # Determines whether a GitLab username appears to be a bot based on known patterns
+  class UsernameBotIdentifier
+    KNOWN_GITLAB_COM_BOT_USERNAMES = %w[
+      employment-bot
+      gitlab-bot
+      gitlab-dependency-bot
+      gitlab-dependency-update-bot
+      gitlab-infra-mgmt-bot
+      gitlab-jh-bot
+      gitlab-qa
+      gitlab-release-tools-bot
+      kubitus-bot
+      GitLabReviewerRecommenderBot
+      Taucher2003-Bot
+      mr-bot
+      ops-gitlab-net
+      GitLab-Llm-Bot
+      codeowner-maintainer-or-manager
+      gitlab-crowdin-bot
+    ].freeze
+
+    # Automatically assigned to orphan records (e.g. when a user is deleted)
+    GHOST_ACCOUNT = 'ghost1'
+
+    # Can be spoofed (e.g. someone can register project_1_bot, project_2_bot_abc123)
+    PROJECT_ACCESS_TOKEN_REGEX = /^project_\d+_bot_?\w*$/.freeze
+    GROUP_ACCESS_TOKEN_REGEX = /^group_\d+_bot_?\w*$/.freeze
+
+    # Used as best practive by GitLab team members when creating "service accounts"
+    SERVICE_ACCOUNT_REGEX = /^gl-service-[-\w]+$/.freeze
+
+    def initialize(username)
+      @username = username
+    end
+
+    def known_bot?
+      KNOWN_GITLAB_COM_BOT_USERNAMES.include?(@username)
+    end
+
+    def ghost?
+      @username == GHOST_ACCOUNT
+    end
+
+    def service_account?
+      @username.match?(SERVICE_ACCOUNT_REGEX)
+    end
+
+    def project_access_token?
+      @username.match?(PROJECT_ACCESS_TOKEN_REGEX)
+    end
+
+    def group_access_token?
+      @username.match?(GROUP_ACCESS_TOKEN_REGEX)
+    end
+
+    def project_or_group_access_token?
+      project_access_token? ||
+        group_access_token?
+    end
+
+    def bot?
+      known_bot? ||
+        service_account? ||
+        project_or_group_access_token?
+    end
+
+    def ignorable_account?
+      known_bot? ||
+        ghost? ||
+        service_account? ||
+        project_or_group_access_token?
+    end
   end
 end

metadata

@@ -1,37 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-username_bot_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: '1.0'
 platform: ruby
 authors:
-- Contributor Success
-autorequire:
-bindir: exe
+- Lee Tickett
+autorequire: 
+bindir: bin
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies: []
-description: Parse GitLab usernames to determine whether they appear to be bots.
+description: 
 email:
-- engineering@gitlab.com
+- ltickett@gitlab.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- README.md
-- Rakefile
-- gitlab-username_bot_identifier.gemspec
 - lib/gitlab/username_bot_identifier.rb
-- lib/gitlab/username_bot_identifier/version.rb
-- sig/gitlab/username_bot_identifier.rbs
 homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-username-bot-identifier
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-username-bot-identifier
   source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-username-bot-identifier
-  changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-username-bot-identifier
-post_install_message:
+  changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-username-bot-identifier/-/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -46,8 +41,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Parse GitLab usernames to determine whether they appear to be bots.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/README.md

@@ -1,31 +0,0 @@
-# Gitlab::UsernameBotIdentifier
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlab/username_bot_identifier`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlab-username_bot_identifier.

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/gitlab-username_bot_identifier.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/gitlab/username_bot_identifier/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "gitlab-username_bot_identifier"
-  spec.version = Gitlab::UsernameBotIdentifier::VERSION
-  spec.authors = ["Contributor Success"]
-  spec.email = ["engineering@gitlab.com"]
-
-  spec.summary = "Parse GitLab usernames to determine whether they appear to be bots."
-  spec.description = "Parse GitLab usernames to determine whether they appear to be bots."
-  spec.homepage = "https://gitlab.com/gitlab-org/ruby/gems/gitlab-username-bot-identifier"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end

data/lib/gitlab/username_bot_identifier/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module UsernameBotIdentifier
-    VERSION = "0.0.0"
-  end
-end

data/sig/gitlab/username_bot_identifier.rbs

@@ -1,6 +0,0 @@
-module Gitlab
-  module UsernameBotIdentifier
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end