• Nicole Cordes's avatar
    Generate valid json for hooks · b7a31a4b
    Nicole Cordes authored
    It seems that ruby can handle 'nil' value but other json processors
    (like PHP) throw an error. This is always generated for empty arrays.
    b7a31a4b
push_data_builder.rb 2.56 KB
module Gitlab
  class PushDataBuilder
    class << self
      # Produce a hash of post-receive data
      #
      # data = {
      #   before: String,
      #   after: String,
      #   ref: String,
      #   user_id: String,
      #   user_name: String,
      #   user_email: String
      #   project_id: String,
      #   repository: {
      #     name: String,
      #     url: String,
      #     description: String,
      #     homepage: String,
      #   },
      #   commits: Array,
      #   total_commits_count: Fixnum
      # }
      #
      def build(project, user, oldrev, newrev, ref, commits = [])
        # Total commits count
        commits_count = commits.size

        # Get latest 20 commits ASC
        commits_limited = commits.last(20)

        # Hash to be passed as post_receive_data
        data = {
          object_kind: "push",
          before: oldrev,
          after: newrev,
          ref: ref,
          checkout_sha: checkout_sha(project.repository, newrev, ref),
          user_id: user.id,
          user_name: user.name,
          user_email: user.email,
          project_id: project.id,
          repository: {
            name: project.name,
            url: project.url_to_repo,
            description: project.description,
            homepage: project.web_url,
            git_http_url: project.http_url_to_repo,
            git_ssh_url: project.ssh_url_to_repo,
            visibility_level: project.visibility_level
          },
          commits: [],
          total_commits_count: commits_count
        }

        # For performance purposes maximum 20 latest commits
        # will be passed as post receive hook data.
        commits_limited.each do |commit|
          data[:commits] << commit.hook_attrs(project)
        end

        data[:commits] = "" if data[:commits].count == 0
        data
      end

      # This method provide a sample data generated with
      # existing project and commits to test web hooks
      def build_sample(project, user)
        commits = project.repository.commits(project.default_branch, nil, 3)
        build(project, user, commits.last.id, commits.first.id, "refs/heads/#{project.default_branch}", commits)
      end

      def checkout_sha(repository, newrev, ref)
        if newrev != Gitlab::Git::BLANK_SHA && ref.start_with?('refs/tags/')
          tag_name = Gitlab::Git.extract_ref_name(ref)
          tag = repository.find_tag(tag_name)

          if tag
            commit = repository.commit(tag.target)
            commit.try(:sha)
          end
        else
          newrev
        end
      end
    end
  end
end