wercker-bundle-update-pr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f343168a816e643e6b2c3f342d04275105814303
+  data.tar.gz: 9e64ff09b58c1f401b99448aa6eb371027fcb86f
+SHA512:
+  metadata.gz: 573a5d056941830658976115b8c6be8111f28fec9bec7208be673ddc6aa8c40a8b5f96708b500ff539498ec430cf94714e4f811092a7e8ca18caf5ccdf2620c7
+  data.tar.gz: 15f6b302f1bd30df01c6fa1ed29da5a04f9fd8e6f08f98e6be2664a642155dc57f56aed814038e8a0946c53cc5cfa12594b47da00fb02a3426a15b9ba5e6f68c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hirofumi Wakasugi
+
+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,88 @@
+# wercker-bundle-update-pr
+
+This is an automation script to bundle update and send pull request via Wercker's Trigger Build API. By requesting trigger build to Wercker with an environment variable which instruct wercker.yml to execute this script, bundle update is invoked, then commit changes and send pull request to GitHub repository if there some changes exist.
+
+(Both concept and implementaion are strongly based on [circleci-bundle-update-pr](https://github.com/masutaka/circleci-bundle-update-pr). Thnaks to [masutaka](https://github.com/masutaka))
+
+## Installation
+
+``` text
+$ gem install wercker-bundle-update-pr
+```
+
+## Usage
+
+### Prerequisites
+
+The application on which you want to execute `bundle update` automatically must be on a Wercker CI.
+
+### Getting GitHub Personal access token
+
+A GitHub personal access token is required for sending GitHub pull request. Go to your account's settings page and obtain a personal access token.
+
+### Getting Werkcer personal token
+
+A Wercker personal token is required for invoking Trigger Build API. Go to your account's settings page and obtain a personal token.
+
+### Wercker application configuration
+
+In the application's setting page:
+
+1. Generate SSH key named "wercker_github_ci_key" in "SSH Keys" for pushing changes to GitHub
+1. Register the above generated key to GitHub SSH keys in Personal settings (note a fingerprint shown along with a key like `41:98:4b:7f:ae:...`)
+1. In "Environment variables", add `GITHUB_ACCESS_TOKEN` with a GitHub personal access token (**Make sure you mark it "protected" otherwise it will be shown in logs**)
+1. In "Environment variables", add `WERCKER_GITHUB_CI_KEY` as SSH key pair and select "wercker_github_ci_key"
+
+### Configure wercker.yml
+
+Add the following 2 steps under `steps` to access GitHub via SSH:
+
+```yaml
+    - add-ssh-key:
+        keyname: WERCKER_GITHUB_CI_KEY
+        fingerprint: 15:59:4b:7c:59:d6:a1:00:0e:91:5a:0d:71:73:d8:7d
+
+    - add-to-known_hosts:
+        hostname: github.com
+```
+
+then add this step as well.
+
+``` yaml
+    - script:
+        code: |
+          if [ -z "${BUNDLE_UPDATE}" ] ; then
+            ls >/dev/null 2>&1
+          else
+            gem update bundler --no-document
+            gem install wercker-bundle-update-pr
+            wercker-bundle-update-pr 5t111111 baenej@gmail.com
+          fi
+```
+
+Do not forget `git commit` and `git push` these changes.
+
+### Fire Trigger build API
+
+Now all set to fire Trigger build API.
+
+``` text
+$ curl -H 'Content-Type: application/json' -H "Authorization: Bearer <wercker personal token>" -X POST -d '{"applicationId": "<wercker application id>", "branch":"master", "message":"bundle update via trigger build", "envVars":[{"key":"BUNDLE_UPDATE","value":"true"}]}' https://app.wercker.com/api/v3/builds
+```
+
+You have to replace `<wercker personal token>` with your Wercker personal access token, and replace `<wercker application id>` which you can find in the URL of your wercker application.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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]/wercker-bundle-update-pr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/exe/wercker-bundle-update-pr

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# Usage:
+# ruby wercker-bundle-update-pr username (optional) email (optional) branches (optional)
+# Example:
+# ruby wercker-bundle-update-pr alice alice@example.com develop
+
+require 'wercker_bundle_update_pr'
+
+WerckerBundleUpdatePr.run(username: ARGV.shift,
+                          email: ARGV.shift,
+                          branches: ARGV.empty? ? ['master'] : ARGV)

data/lib/wercker_bundle_update_pr.rb

@@ -0,0 +1,73 @@
+require "wercker_bundle_update_pr/version"
+require 'octokit'
+require 'compare_linker'
+
+# An automation script to `bundle update` and send pull request via Wercker's Trigger Build API
+module WerckerBundleUpdatePr
+  # Main process
+  # @param [String] username username for Git commitment
+  # @param [String] email email for Git commitment
+  # @param [Array] branches list of target branches
+  def self.run(username: nil, email: nil, branches: ['master'])
+    raise '$WERCKER_GIT_OWNER not set' unless ENV['WERCKER_GIT_OWNER']
+    raise '$WERCKER_GIT_REPOSITORY not set' unless ENV['WERCKER_GIT_REPOSITORY']
+    raise '$GITHUB_ACCESS_TOKEN not set' unless ENV['GITHUB_ACCESS_TOKEN']
+
+    username ||= client.user.login
+    email ||= "#{username}@users.noreply.github.com"
+
+    return unless bundle_update?(branches)
+
+    repository = "#{ENV['WERCKER_GIT_OWNER']}/#{ENV['WERCKER_GIT_REPOSITORY']}"
+    now = Time.now
+    branch = "bundle-update-#{now.strftime('%Y%m%d%H%M%S')}"
+
+    create_branch(username, email, branch)
+    pull_request = create_pull_request(repository, branch, now)
+    add_compare_linker_comment(repository, pull_request[:number])
+  end
+
+  def self.bundle_update?(branches)
+    return false unless branches.include?(ENV['WERCKER_GIT_BRANCH'])
+
+    raise "Failed to run `bundle update`" unless system("bundle update")
+    `git status -sb 2> /dev/null`.include?("Gemfile.lock")
+  end
+  private_class_method :bundle_update?
+
+  def self.create_branch(username, email, branch)
+    `git config user.name #{username}`
+    `git config user.email #{email}`
+    `git checkout -b #{branch}`
+    `git add Gemfile.lock`
+    `git commit -m'bundle update'`
+    `git push origin #{branch}`
+  end
+  private_class_method :create_branch
+
+  def self.create_pull_request(repository, branch, now)
+    title = "bundle update at #{now.strftime('%Y-%m-%d %H:%M:%S %Z')}"
+    body = "Auto generated by [Wercker](#{ENV['WERCKER_APPLICATION_URL']})"
+    client.create_pull_request(repository, ENV['WERCKER_GIT_BRANCH'], branch, title, body)
+  end
+  private_class_method :create_pull_request
+
+  def self.add_compare_linker_comment(repository, pr_number)
+    ENV["OCTOKIT_ACCESS_TOKEN"] = ENV["GITHUB_ACCESS_TOKEN"]
+    compare_linker = CompareLinker.new(repository, pr_number)
+    compare_linker.formatter = CompareLinker::Formatter::Markdown.new
+
+    comment = <<-EOC
+#{compare_linker.make_compare_links.to_a.join("\n")}
+Powered by [compare_linker](https://rubygems.org/gems/compare_linker)
+          EOC
+
+    compare_linker.add_comment(repository, pr_number, comment)
+  end
+  private_class_method :add_compare_linker_comment
+
+  def self.client
+    Octokit::Client.new(access_token: ENV["GITHUB_ACCESS_TOKEN"])
+  end
+  private_class_method :client
+end

data/lib/wercker_bundle_update_pr/version.rb

@@ -0,0 +1,3 @@
+module WerckerBundleUpdatePr
+  VERSION = '0.1.0'
+end

data/wercker-bundle-update-pr.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wercker_bundle_update_pr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wercker-bundle-update-pr"
+  spec.version       = WerckerBundleUpdatePr::VERSION
+  spec.authors       = ["Hirofumi Wakasugi"]
+  spec.email         = ["baenej@gmail.com"]
+
+  spec.summary       = %q{An automation script to bundle update and send pull request via Wercker's Trigger Build API}
+  spec.description   = %q{By requesting trigger build to Wercker with an environment variable which instruct wercker.yml to execute this script, bundle update is invoked, then commit changes and send pull request to GitHub repository if there some changes exist.}
+  spec.homepage      = "https://github.com/5t111111/wercker-bundle-update-pr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "octokit", "~> 4.3"
+  spec.add_runtime_dependency "compare_linker", "~> 1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: wercker-bundle-update-pr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hirofumi Wakasugi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: compare_linker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: By requesting trigger build to Wercker with an environment variable which
+  instruct wercker.yml to execute this script, bundle update is invoked, then commit
+  changes and send pull request to GitHub repository if there some changes exist.
+email:
+- baenej@gmail.com
+executables:
+- wercker-bundle-update-pr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/wercker-bundle-update-pr
+- lib/wercker_bundle_update_pr.rb
+- lib/wercker_bundle_update_pr/version.rb
+- wercker-bundle-update-pr.gemspec
+homepage: https://github.com/5t111111/wercker-bundle-update-pr
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: An automation script to bundle update and send pull request via Wercker's
+  Trigger Build API
+test_files: []