github_merge_sign 0.1.0.test1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 965d192be559837d1c33bf0446c061fe8710c7de
+  data.tar.gz: c2e14563d0dcfc71f026778f1034d8dc5f07ece0
+SHA512:
+  metadata.gz: 8cec48d6c868020d8ddfcdfa10fc17e027cab32a6b9d6a2b856ba41c662f2bae5a1f132079026a634c91522e9707b544a7d82ce3ef567b3d05a54cec54927f90
+  data.tar.gz: '05848c40cb6c49357222826c808200d342f4d1643240818cb6db03c51c91af0feff794bb8be22a76cc2500c34af8a4c72323d2e465c8dcf8fbb3fa2a64933bb0'

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+  - "2.3"
+  - "2.4"
+deploy:
+  provider: rubygems
+  api_key:
+    secure: L/mmeonwxNIiMqHs1o2gw47jJOXHFChTbBxfy3anW/TFi5EipybyBXrT7dikUqgzYpzVdiomLEvJjIeR0hlt3oBGaCddpGaXF/2keEeSpOB2xhpCZIIFnUN+5g3VgVHiU5yC1SeKZzxyoA1UocHl+q0wXAcmeHhKgNpVjp98MxwLGos85BkLbqiIx8PG5nM3QWF//uVm8tO0ISkGT0inuPfNa/OThHDyHdZ1a6AqpbZHecZm1yd9FE3KkwGTQMftKrrMh/Ttv6ACCS8b6fu2x9gO+JyslJNX0D+o3rirjEgfdJqXKNmEl4vCPrzx4mpuKSamvWVNtE4ZgCoM7c8f+qHbvSCC5FyXUqPYWqsGfYma1eqsV/yMtWZCCbrUHysWoMs6F5f3+JdBWajEM8BqkvGgCJTtGQLOj6HfbvXXfDyXkMiFU/kTuDaZRD4BAKy870THLpj51jDG0fpWGdUNJVUloF6o1tOqRARBNPXmrKMWCP1fjz5irXvX9wyZpaAwOTBkQLlLUHdDRcXcRiwY5dkxUhzBXB6OcOqRLYUuP/okrgaQghK7cGv7SD/0T3+Zwie6uFgkSn7kAxfWwUHGb74yO+MbIXvDxxhKHKBvPMKOraSDUrL8Uu98UD79Jdlgn70GD/xZS5hSe9Sbmg/Irn3BNu2fBA0eEyd0LwejG6w=
+  gem: github_merge_sign
+  on:
+    tags: true
+    # pin to a ruby version to prevent multiple publish attempts.
+    ruby: "2.4"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+* Initial version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_merge_sign.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Github Merge & Sign
+
+This is a tool to merge and GPG sign a github pull-request. This replicates the
+functionality of the Github merge button, adding GPG signing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github_merge_sign'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_merge_sign
+
+## Usage
+
+To merge a github PR first change directory to a local checkout of the repo,
+and then run (where N is the github PR number):
+
+    $ bundle exec github_merge_sign --pr N
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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`.
+
+This gem is versioned following [Semantic Versioning](http://semver.org/) as
+described in the [GDS rubygems
+styleguide](https://github.com/alphagov/styleguides/blob/master/rubygems.md#versioning).
+To release a new version, update the version number in
+`lib/github_merge_sign/version.rb`, update `CHANGELOG.md` and create a PR for
+this version change.
+
+Once this PR is merged, tag the merge commit with the version number, and push
+the tag. This will cause Travis to build and publish the gem to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alphagov/paas-github_merge_sign.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github_merge_sign"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/github_merge_sign

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "github_merge_sign"
+
+pr_number = 0
+option_parser = OptionParser.new do |opts|
+  opts.on('--pr   number', Integer) do |value|
+    pr_number = value
+  end
+end
+option_parser.parse!
+
+abort "Must specify PR number" unless pr_number > 0
+
+GithubMergeSign::PullRequest.new(pr_number).merge!

data/github_merge_sign.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_merge_sign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_merge_sign"
+  spec.version       = GithubMergeSign::VERSION
+  spec.authors       = ["Government Digital Service"]
+
+  spec.summary       = %q{Tool to merge and GPG sign a github PR.}
+  spec.description   = %q{Tool to merge and GPG sign a github PR. This replicates the functionality of the Github merge button, adding GPG signing.}
+  spec.homepage      = "https://github.com/alphagov/paas-github_merge_sign"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

data/lib/github_merge_sign.rb

@@ -0,0 +1,155 @@
+require 'json'
+require 'net/http'
+require 'uri'
+
+require "github_merge_sign/version"
+
+module GithubMergeSign
+  class PullRequest
+    BASE_URL = 'https://api.github.com/repos'.freeze
+
+    def initialize(pr_number)
+      @pr_number = pr_number
+    end
+
+    def repo
+      @repo ||= read_repo_from_git
+    end
+
+    def open?
+      details.fetch("state") == "open"
+    end
+
+    def mergeable?
+      !! details.fetch("mergeable")
+    end
+
+    def status_checks_passed?
+      status.fetch("state") == "success" || status.fetch("statuses").empty?
+    end
+
+    def external_pr?
+      details.fetch("base").fetch("repo").fetch("full_name") !=
+        details.fetch("head").fetch("repo").fetch("full_name")
+    end
+
+    def target_branch
+      details.fetch("base").fetch("ref")
+    end
+
+    def head_commit_id
+      details.fetch("head").fetch("sha")
+    end
+
+    def head_ref
+      details.fetch("head").fetch("ref")
+    end
+
+    def commit_message
+      <<-EOT
+Merge pull request ##{@pr_number} from #{details.fetch('head').fetch('user').fetch('login')}/#{head_ref}
+
+#{details.fetch('title')}
+      EOT
+    end
+
+    def merge!
+      raise "PR is not open" unless open?
+      raise "PR is not mergeable" unless mergeable?
+      raise "PR has not passed all status checks" unless status_checks_passed?
+
+      # Check working directorty is clean
+      unless Kernel.system('git diff --quiet --exit-code HEAD')
+        raise "Working directory is not clean. Aborting..."
+      end
+
+      info "Checking out and updating #{target_branch}"
+      execute_command("git checkout #{target_branch}")
+      execute_command("git pull --ff-only origin #{target_branch}")
+
+      if external_pr?
+        info "Fetching commits from PR #{@pr_number}"
+        execute_command("git fetch origin refs/pull/#{@pr_number}/head")
+      end
+
+      info "Merging PR with commit message:\n#{commit_message}"
+      execute_command('git', 'merge', '--no-ff', '-S', '-m', commit_message, head_commit_id)
+
+      info "Pushing to origin"
+      execute_command("git push origin #{target_branch}")
+
+      unless external_pr?
+        info "Deleting remote branch #{head_ref}"
+        execute_command("git push origin :#{head_ref}")
+      end
+
+      info "Done."
+    end
+
+    private
+
+    def read_repo_from_git
+      details = `git remote -v`
+      unless $?.success?
+        raise "Error reading git remotes: exit status #{$?.exitstatus}."
+      end
+      details.each_line do |line|
+        line.strip!
+        if line =~ /\Aorigin\t(\S+)\s+\(fetch\)\z/
+          url = $1
+          if url =~ /\A(?:https:\/\/|git@)github\.com[\/:](\S+?)(?:\.git)?\z/
+            return $1
+          end
+        end
+      end
+      raise "origin is not a Github URL"
+    end
+
+    def execute_command(*args)
+      unless Kernel.system(*args)
+        raise "Error: command '#{args.join(' ')}' exited #{$?.exitstatus}."
+      end
+    end
+
+    def details
+      @_details ||= get_json("#{BASE_URL}/#{repo}/pulls/#{@pr_number}")
+    end
+
+    def status
+      url = "#{BASE_URL}/#{repo}/commits/#{head_commit_id}/status"
+      @_status ||= get_json(url)
+    end
+
+    def get_json(url)
+      response = http_get(url)
+      if response.is_a?(Net::HTTPForbidden) && response.body =~ /API rate limit exceeded for/
+        raise "Github rate-limit exceeded. To avoid this create a Github API token with public access and put it in GITHUB_API_TOKEN env var."
+      end
+
+      unless response.is_a?(Net::HTTPSuccess)
+        raise "Failed to fetch PR details.\nGot #{response.code} fetching '#{url}':\n#{response.body}"
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def http_get(url)
+      uri = URI.parse(url)
+      if ENV["GITHUB_API_TOKEN"]
+        uri.query = [uri.query, "access_token=#{ENV['GITHUB_API_TOKEN']}"].compact.join('&')
+      end
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        request = Net::HTTP::Get.new(uri.request_uri)
+        return http.request(request)
+      end
+    end
+
+    def info(message)
+      if $stdout.isatty
+        puts "\e[36m#{message}\e[0m"
+      else
+        puts message
+      end
+    end
+  end
+end

data/lib/github_merge_sign/version.rb

@@ -0,0 +1,3 @@
+module GithubMergeSign
+  VERSION = "0.1.0.test1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: github_merge_sign
+version: !ruby/object:Gem::Version
+  version: 0.1.0.test1
+platform: ruby
+authors:
+- Government Digital Service
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: webmock
+  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'
+description: Tool to merge and GPG sign a github PR. This replicates the functionality
+  of the Github merge button, adding GPG signing.
+email: 
+executables:
+- github_merge_sign
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/github_merge_sign
+- github_merge_sign.gemspec
+- lib/github_merge_sign.rb
+- lib/github_merge_sign/version.rb
+homepage: https://github.com/alphagov/paas-github_merge_sign
+licenses:
+- MIT
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Tool to merge and GPG sign a github PR.
+test_files: []