summaryrefslogtreecommitdiff
path: root/lib/gitlab/github_import/representation/protected_branch.rb
blob: eb9dd3bc24763b4b6d0177d39c11a150d3162372 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# frozen_string_literal: true

module Gitlab
  module GithubImport
    module Representation
      class ProtectedBranch
        include ToHash
        include ExposeAttribute

        attr_reader :attributes

        expose_attribute :id, :allow_force_pushes, :required_conversation_resolution, :required_signatures,
                         :required_pull_request_reviews, :require_code_owner_reviews, :allowed_to_push_users

        # Builds a Branch Protection info from a GitHub API response.
        # Resource structure details:
        # https://docs.github.com/en/rest/branches/branch-protection#get-branch-protection
        # branch_protection - An instance of `Hash` containing the protection details.
        def self.from_api_response(branch_protection, _additional_object_data = {})
          branch_name = branch_protection[:url].match(%r{/branches/(\S{1,255})/protection$})[1]

          allowed_to_push_users = branch_protection.dig(:required_pull_request_reviews,
                                                        :bypass_pull_request_allowances,
                                                        :users)
          allowed_to_push_users &&= allowed_to_push_users.map do |u|
            Representation::User.from_api_response(u)
          end
          hash = {
            id: branch_name,
            allow_force_pushes: branch_protection.dig(:allow_force_pushes, :enabled),
            required_conversation_resolution: branch_protection.dig(:required_conversation_resolution, :enabled),
            required_signatures: branch_protection.dig(:required_signatures, :enabled),
            required_pull_request_reviews: branch_protection[:required_pull_request_reviews].present?,
            require_code_owner_reviews: branch_protection.dig(:required_pull_request_reviews,
                                                              :require_code_owner_reviews).present?,
            allowed_to_push_users: allowed_to_push_users.to_a
          }

          new(hash)
        end

        # Builds a new Protection using a Hash that was built from a JSON payload.
        def self.from_json_hash(raw_hash)
          hash = Representation.symbolize_hash(raw_hash)

          hash[:allowed_to_push_users].map! do |u|
            Representation::User.from_json_hash(u)
          end

          new(hash)
        end

        # attributes - A Hash containing the raw Protection details. The keys of this
        #              Hash (and any nested hashes) must be symbols.
        def initialize(attributes)
          @attributes = attributes
        end

        def github_identifiers
          { id: id }
        end
      end
    end
  end
end