github_commit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1aba9e53e7a3cb374904d4ab5df1f56bafbfca2101e4392e66925180b813bb0
+  data.tar.gz: a5c9b4c5f323b5053aee094394b96896dd86804690f2758b64e8d3f91d8d9671
+SHA512:
+  metadata.gz: b0969e1f6d79c6d44d742d4890372c27bb22251ebfd6869f04c3a3ab440fee9dbabc229e4a7cc3cd79e24028e367cad5789c221f564b86c25edbe4fe2464fbeb
+  data.tar.gz: d8ab17c36008d74b5fe9932bc40fbd39e97fece3b05263f4110e9a57805e30da75ded0db5bb72b963485dfb06dbafef6ffb95153933b57c50a27d62b708d6e27

data/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: bundle-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: bundle
+    - run: bundle install --jobs 4 --retry 3 --deployment
+    - run: bundle exec rspec
+    - run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+coverage
+github_commit-*
+tmp
+vendor

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_gem:
+  rubocop-govuk:
+    - config/default.yml
+    - config/rake.yml
+    - config/rspec.yml
+
+inherit_mode:
+  merge:
+    - Exclude

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:2.7.2
+
+RUN apt-get update -qq && apt-get install -y build-essential \
+  software-properties-common
+
+RUN apt-get clean
+
+# Install GitHub CLI
+RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-key C99B11DEB97541F0
+RUN apt-add-repository https://cli.github.com/packages
+RUN apt update
+RUN apt install gh
+
+RUN gem install github_commit octokit
+ADD . /
+WORKDIR /opt/resource

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    github_commit (0.1.0)
+      octokit (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    brakeman (4.10.0)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    docile (1.3.3)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
+    octokit (4.19.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    regexp_parser (2.0.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.87.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    rubocop-govuk (3.17.2)
+      rubocop (= 0.87.1)
+      rubocop-ast (= 0.8.0)
+      rubocop-rails (= 2.8.1)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 1.42.0)
+    rubocop-rails (2.8.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.87.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    simplecov (0.20.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  brakeman (~> 4.10)
+  github_commit!
+  rspec (~> 3.0)
+  rubocop (~> 0.87)
+  rubocop-govuk (~> 3.17)
+  simplecov (~> 0.20)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,71 @@
+# Concourse GitHub Commit Resource
+
+A Concourse resource type for GitHub commits.
+
+The `in` step creates a directory `.github` containing several files:
+
+* `ref` contains the sha of the commit
+* `author` contains the name of the committer from GitHub's API
+* `message` contains the commit message from GitHub's API
+* `state` contains the current combined status of the commit, if any
+* `repo` contains the pulled repository checked out at the specified commit
+* `combined_status` contains the full `combined_status` JSON from GitHub's API
+* `commit` contains the full `commit` JSON from GitHub's API
+
+## Usage
+
+The following example runs tests for every new commit, and updates the status
+for a check on a GitHub commit (pending, and then success/failure/error).
+
+```yaml
+resource_types:
+  - name: github-commit
+    type: registry-image
+    source:
+      repository: govuk/github-commit
+
+resources:
+  - name: commit
+    type: github-commit
+    source:
+      repository: alphagov/frontend
+      access_token: ((github_access_token))
+      path: commit # relative path to the commit, must match the resource name.
+
+jobs:
+  - name: run-tests
+    plan:
+    - get: github-commit
+      trigger: true
+    - put: github-commit
+      params:
+        context: run-tests # corresponds to GitHub Status API context field
+        status: pending # puts a pending status on the GitHub commit
+    - task: run-tests
+      file: repo/run-tests.yml
+    on_success:
+      put: commit
+      params: {status: success, context: run-tests} # puts a success status on the GitHub commit
+    on_failure:
+      put: commit
+      params: {status: failure, context: run-tests}
+    on_abort:
+      put: commit
+      params: {status: error, context: run-tests}
+    on_error:
+      put: commit
+      params: {status: error, context: run-tests}
+```
+
+## `get`
+
+Options:
+
+```
+collaborators_only: Only `verified` commits from collaborators
+```
+
+## Development
+
+The output of this project is a container image pushed to DockerHub, for use
+in Concourse pipelines as a Resource Type.

data/bin/check

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'github_commit'
+require 'json'
+require 'octokit'
+
+input = JSON.load($stdin.read, nil, { symbolize_names: true, create_additions: false })
+
+repo = input.dig(:source, :repository)
+access_token = input.dig(:source, :access_token)
+sha = input.dig(:version, :ref)
+
+service = GithubCommit::CommitsFetcher.new(
+  client: Octokit::Client.new(access_token: access_token),
+  repo: repo,
+)
+
+puts service.commits(sha: sha).to_json

data/bin/in

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'github_commit'
+require 'json'
+require 'octokit'
+
+dir, *_ = ARGV
+
+Dir.mkdir(dir) unless File.exists?(dir)
+
+input = JSON.load($stdin.read, nil, { symbolize_names: true, create_additions: false })
+repo = input.dig(:source, :repository)
+access_token = input.dig(:source, :access_token)
+sha = input.dig(:version, :ref)
+
+service = GithubCommit::CommitFetcher.new(
+  client: Octokit::Client.new(access_token: access_token),
+  repo: repo,
+)
+
+writer = GithubCommit::CommitWriter.new(
+  commit: service.fetch_commit(sha: sha),
+  status: service.fetch_status(sha: sha),
+  dir: dir
+)
+
+writer.write_commit!
+
+`git clone https://github.com/#{repo}.git #{dir}/repo`
+`cd #{dir}/repo && git checkout #{sha}`
+
+puts writer.metadata.to_json

data/bin/out

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require 'github_commit'
+require 'json'
+require 'octokit'
+
+$stdout = STDERR
+
+dir, *_ = ARGV
+
+input = JSON.load($stdin.read, nil, { symbolize_names: true, create_additions: false })
+
+path = input.dig(:source, :path)
+unless path
+  puts "[Error] path must be provided on Concourse Resource Type source"
+  exit 1
+end
+
+sha_file = "#{dir}/#{path}/ref"
+access_token = input.dig(:source, :access_token)
+state = input.dig(:params, :status)
+repository = input.dig(:source, :repository)
+
+unless access_token && File.exists?(sha_file) && state && repository
+  missing = []
+  missing << :access_token unless access_token && !access_token.empty?
+  missing << :sha unless File.exists?(sha_file)
+  missing << :state unless state && !state.empty?
+  missing << :repository unless repository && !repository.empty?
+
+  puts("[Error] Missing params: #{ missing.join(', ') }")
+
+  exit 1
+end
+
+sha = File.read(sha_file)
+author = File.read("#{dir}/#{path}/author")
+message = File.read("#{dir}/#{path}/message")
+
+updater = GithubCommit::StatusUpdater.new(
+  client: Octokit::Client.new(access_token: access_token),
+  repo: repository,
+  sha: sha,
+)
+
+def parse_target_url(provided_target)
+  return provided_target if provided_target
+  if ENV.key?("ATC_EXTERNAL_URL")
+    return "#{ENV["ATC_EXTERNAL_URL"]}/teams/#{ENV["BUILD_TEAM_NAME"]}/pipelines/#{ENV["BUILD_PIPELINE_NAME"]}/jobs/#{ENV["BUILD_JOB_NAME"]}/builds/#{ENV["BUILD_NAME"]}"
+  end
+  nil
+end
+
+updater.update_status(
+  status: state,
+  context: input.dig(:params, :context) || "Concourse",
+  target_url: parse_target_url(input.dig(:params, :target_url)),
+  description: input.dig(:params, :description),
+)
+
+output = {
+  version: { ref: sha },
+  metadata: [
+    { name: "author", value: author },
+    { name: "message", value: message },
+    { name: "status", value: state },
+    { name: "commit", value: sha },
+  ]
+}
+
+$stdout = STDOUT
+
+puts output.to_json

data/github_commit.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github_commit"
+
+Gem::Specification.new do |gem|
+  gem.name          = "github_commit"
+  gem.version       = GithubCommit::VERSION
+  gem.authors       = ["GOV.UK Dev"]
+  gem.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
+  gem.summary       = "Gem for GitHub commits as a Concourse Resource Type"
+  gem.description   = "Gem for GitHub commits as a Concourse Resource Type"
+  gem.homepage      = "https://github.com/alphagov/github-commit"
+  gem.license       = "OGL-UK-3.0"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = `git ls-files -z -- bin/*`.split("\x0").map { |f| File.basename(f) }
+  gem.test_files    = `git ls-files -z -- {spec}/*`.split("\x0")
+  gem.require_paths = %w[lib]
+
+  gem.add_runtime_dependency "octokit", "~> 4.2"
+
+  gem.add_development_dependency "brakeman", "~> 4.10"
+  gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency "rubocop", "~> 0.87"
+  gem.add_development_dependency "rubocop-govuk", "~> 3.17"
+  gem.add_development_dependency "simplecov", "~> 0.20"
+end

data/lib/github_commit.rb

@@ -0,0 +1,8 @@
+require_relative "./github_commit/commit_fetcher"
+require_relative "./github_commit/commits_fetcher"
+require_relative "./github_commit/commit_writer"
+require_relative "./github_commit/status_updater"
+
+module GithubCommit
+  VERSION = "0.1.0".freeze
+end

data/lib/github_commit/commit_fetcher.rb

@@ -0,0 +1,20 @@
+module GithubCommit
+  class CommitFetcher
+    def initialize(repo:, client: Octokit::Client.new)
+      @client = client
+      @repo = repo
+    end
+
+    def fetch_commit(sha:)
+      client.commit(repo, sha)
+    end
+
+    def fetch_status(sha:)
+      client.status(repo, sha)
+    end
+
+  private
+
+    attr_reader :client, :repo
+  end
+end

data/lib/github_commit/commit_writer.rb

@@ -0,0 +1,34 @@
+module GithubCommit
+  class CommitWriter
+    def initialize(commit:, status:, dir:)
+      @commit = commit
+      @status = status
+      @dir = dir
+    end
+
+    def write_commit!
+      File.open("#{dir}/ref", "w") { |f| f.write commit.sha }
+      File.open("#{dir}/state", "w") { |f| f.write status.state }
+      File.open("#{dir}/combined_status", "w") { |f| f.write status.to_h.to_json }
+      File.open("#{dir}/commit", "w") { |f| f.write commit.to_h.to_json }
+      File.open("#{dir}/author", "w") { |f| f.write commit.commit.author.name }
+      File.open("#{dir}/message", "w") { |f| f.write commit.commit.message }
+    end
+
+    def metadata
+      {
+        version: { ref: commit.sha },
+        metadata: [
+          { name: "author", value: commit.commit.author.name },
+          { name: "message", value: commit.commit.message },
+          { name: "status", value: status.state },
+          { name: "commit", value: commit.sha },
+        ],
+      }
+    end
+
+  private
+
+    attr_reader :commit, :status, :dir
+  end
+end

data/lib/github_commit/commits_fetcher.rb

@@ -0,0 +1,37 @@
+module GithubCommit
+  class CommitsFetcher
+    def initialize(repo:, client: Octokit::Client.new)
+      @client = client
+      @repo = repo
+    end
+
+    def commits(sha: nil)
+      branch_commits = client.branches(repo).map do |branch|
+        client.commits(repo, { sha: branch.commit.sha, per_page: 15 })
+          .map do |c|
+            {
+              date: c.commit.committer.date,
+              sha: c.sha,
+            }
+          end
+      end
+
+      commits = branch_commits.flatten
+        .uniq { |c| c.dig(:sha) }
+        .sort { |a, b| b.dig(:date) <=> a.dig(:date) }
+        .map { |s| { ref: s.dig(:sha) } }
+
+      return [commits.first] unless sha
+
+      index = commits.index({ ref: sha })
+      index = 1 if index == commits.count - 1
+      output = commits[0..index]
+
+      output.reverse
+    end
+
+  private
+
+    attr_reader :client, :repo, :sha
+  end
+end

data/lib/github_commit/status_updater.rb

@@ -0,0 +1,23 @@
+module GithubCommit
+  class StatusUpdater
+    def initialize(repo:, sha:, client: Octokit::Client.new)
+      @client = client
+      @repo = repo
+      @sha = sha
+    end
+
+    def update_status(status:, context: nil, target_url: nil, description: nil)
+      options = {
+        context: context,
+        target_url: target_url,
+        description: description,
+      }.compact
+
+      client.create_status(repo, sha, status, options)
+    end
+
+  private
+
+    attr_reader :client, :repo, :sha
+  end
+end

data/spec/lib/github_commit/commit_fetcher_spec.rb

@@ -0,0 +1,33 @@
+require "github_commit/commit_fetcher"
+
+describe GithubCommit::CommitFetcher do
+  it "can be initialized" do
+    expect { described_class.new(client: nil, repo: nil) }.not_to raise_error
+  end
+
+  context "with authorized client" do
+    subject(:fetcher) { described_class.new(client: client, repo: repo) }
+
+    let(:repo) { "alphagov/example" }
+    let(:sha) { "123" }
+    let(:client) { instance_double("Octokit::Client") }
+
+    describe "#fetch_commit" do
+      let(:commit) { { sha: sha } }
+
+      it "fetches a commit" do
+        expect(client).to receive(:commit).with(repo, sha).and_return(commit)
+        expect(fetcher.fetch_commit(sha: sha)).to eq(commit)
+      end
+    end
+
+    describe "#fetch_status" do
+      let(:status) { { sha: sha, state: "success" } }
+
+      it "fetches a status for a commit" do
+        expect(client).to receive(:status).with(repo, sha).and_return(status)
+        expect(fetcher.fetch_status(sha: sha)).to eq(status)
+      end
+    end
+  end
+end

data/spec/lib/github_commit/commit_writer_spec.rb

@@ -0,0 +1,74 @@
+require "github_commit/commit_writer"
+require "tmpdir"
+
+describe GithubCommit::CommitWriter do
+  attr_reader :temp_dir
+
+  around do |example|
+    dir = Dir.mktmpdir
+    begin
+      @temp_dir = dir
+      example.run
+    ensure
+      FileUtils.remove_entry dir
+    end
+  end
+
+  # rubocop:disable RSpec/VerifiedDoubles
+  let(:status) do
+    double("Sawyer::Resource",
+           state: commit_state,
+           to_h: { state: commit_state })
+  end
+  let(:commit) do
+    double("Sawyer::Resource",
+           sha: sha,
+           to_h: { sha: sha },
+           commit: double("Sawyer::Resource",
+                          author: double("Sawyer::Resource",
+                                         name: commit_author),
+                          message: commit_msg))
+  end
+  # rubocop:enable RSpec/VerifiedDoubles
+  let(:commit_state) { "pending" }
+  let(:commit_msg) { "Add tests" }
+  let(:commit_author) { "Harry Potter" }
+  let(:sha) { "123" }
+
+  it "can be initialized" do
+    expect { described_class.new(commit: nil, status: nil, dir: nil) }.not_to raise_error
+  end
+
+  describe "#write_commit!" do
+    subject(:writer) { described_class.new(commit: commit, status: status, dir: dir) }
+
+    let(:dir) { temp_dir }
+
+    it "writes out files to the directory" do
+      expect(Dir.exist?(temp_dir)).to be true
+      writer.write_commit!
+      expect(File.read("#{dir}/ref")).to eq(sha)
+      expect(File.read("#{dir}/state")).to eq(commit_state)
+      expect(File.read("#{dir}/combined_status")).to eq("{\"state\":\"pending\"}")
+      expect(File.read("#{dir}/commit")).to eq("{\"sha\":\"123\"}")
+      expect(File.read("#{dir}/author")).to eq(commit_author)
+      expect(File.read("#{dir}/message")).to eq(commit_msg)
+    end
+  end
+
+  describe "#metadata" do
+    subject(:writer) { described_class.new(commit: commit, status: status, dir: "dir") }
+
+    it "returns a hash" do
+      expect(writer.metadata).to eq({
+        version: { ref: sha },
+        metadata: [
+          { name: "author", value: commit_author },
+          { name: "message", value: commit_msg },
+          { name: "status", value: commit_state },
+          { name: "commit", value: sha },
+        ],
+      })
+    end
+  end
+end

data/spec/lib/github_commit/commits_fetcher_spec.rb

@@ -0,0 +1,75 @@
+require "github_commit/commits_fetcher"
+
+describe GithubCommit::CommitsFetcher do
+  it "can be initialized" do
+    expect { described_class.new(client: nil, repo: nil) }.not_to raise_error
+  end
+
+  context "with authorized client" do
+    let(:fetcher) { described_class.new(client: client, repo: repo) }
+
+    let(:repo) { "alphagov/example" }
+    let(:sha1) { "123" }
+    let(:sha2) { "456" }
+    let(:sha3) { "789" }
+
+    let(:client) { instance_double("Octokit::Client") }
+
+    describe "#commits" do
+      let(:commit1) do
+        # rubocop:disable RSpec/VerifiedDoubles
+        double("Sawyer::Resource",
+               sha: sha1,
+               commit: double("Sawyer::Resource",
+                              committer: double("Sawyer::Resource", date: Time.parse("2018-12-25"))))
+      end
+      let(:commit2) do
+        double("Sawyer::Resource",
+               sha: sha2,
+               commit: double("Sawyer::Resource",
+                              committer: double("Sawyer::Resource", date: Time.parse("2020-12-25"))))
+      end
+      let(:commit3) do
+        double("Sawyer::Resource",
+               sha: sha3,
+               commit: double("Sawyer::Resource",
+                              committer: double("Sawyer::Resource", date: Time.parse("2019-12-25"))))
+      end
+      let(:branches) do
+        [
+          double("Sawyer::Resource",
+                 commit: double("Sawyer::Resource",
+                                sha: sha1)),
+          double("Sawyer::Resource",
+                 commit: double("Sawyer::Resource",
+                                sha: sha2)),
+          double("Sawyer::Resource",
+                 commit: double("Sawyer::Resource",
+                                sha: sha3)),
+          # rubocop:enable RSpec/VerifiedDoubles
+        ]
+      end
+
+      context "when a commit hash is provided" do
+        it "fetches the succeeding commits in reverse chronological order" do
+          expect_calls
+          expect(fetcher.commits(sha: sha1)).to eq([{ ref: sha3 }, { ref: sha2 }])
+        end
+      end
+
+      context "when a commit hash is not provided" do
+        it "returns the most recent commit" do
+          expect_calls
+          expect(fetcher.commits).to eq([{ ref: sha2 }])
+        end
+      end
+
+      def expect_calls
+        expect(client).to receive(:branches).with(repo).and_return(branches)
+        expect(client).to receive(:commits).with(repo, { sha: sha1, per_page: 15 }).and_return([commit1])
+        expect(client).to receive(:commits).with(repo, { sha: sha2, per_page: 15 }).and_return([commit2])
+        expect(client).to receive(:commits).with(repo, { sha: sha3, per_page: 15 }).and_return([commit3])
+      end
+    end
+  end
+end

data/spec/lib/github_commit/status_updater_spec.rb

@@ -0,0 +1,39 @@
+require "github_commit/status_updater"
+
+describe GithubCommit::StatusUpdater do
+  it "can be initialized" do
+    expect { described_class.new(client: nil, repo: nil, sha: nil) }.not_to raise_error
+  end
+
+  describe "#update_status" do
+    subject(:updater) { described_class.new(client: client, repo: repo, sha: sha) }
+
+    let(:client) { instance_double("Octokit::Client") }
+    let(:repo) { "alphagov/example" }
+    let(:sha) { "123" }
+    let(:title) { "Concourse" }
+    let(:target_url) { "https://example.org" }
+    let(:description) { "The Concourse pipeline is running..." }
+    let(:status) { "pending" }
+
+    it "updates the status for a commit" do
+      expect(client).to receive(:create_status).with(
+        repo,
+        sha,
+        status,
+        {
+          context: title,
+          target_url: target_url,
+          description: description,
+        },
+      )
+
+      updater.update_status(
+        status: status,
+        context: title,
+        target_url: target_url,
+        description: description,
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,104 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+
+require "simplecov"
+SimpleCov.start { add_filter "/spec/" }
+
+$LOAD_PATH << File.expand_path("..", __dir__)
+$LOAD_PATH << File.expand_path("../lib", __dir__)
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: github_commit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GOV.UK Dev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.87'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.87'
+- !ruby/object:Gem::Dependency
+  name: rubocop-govuk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.17'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: Gem for GitHub commits as a Concourse Resource Type
+email:
+- govuk-dev@digital.cabinet-office.gov.uk
+executables:
+- check
+- in
+- out
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/check
+- bin/in
+- bin/out
+- github_commit.gemspec
+- lib/github_commit.rb
+- lib/github_commit/commit_fetcher.rb
+- lib/github_commit/commit_writer.rb
+- lib/github_commit/commits_fetcher.rb
+- lib/github_commit/status_updater.rb
+- spec/bin/check_spec.rb
+- spec/bin/in_spec.rb
+- spec/bin/out_spec.rb
+- spec/lib/github_commit/commit_fetcher_spec.rb
+- spec/lib/github_commit/commit_writer_spec.rb
+- spec/lib/github_commit/commits_fetcher_spec.rb
+- spec/lib/github_commit/status_updater_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alphagov/github-commit
+licenses:
+- OGL-UK-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Gem for GitHub commits as a Concourse Resource Type
+test_files: []