deploy_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 505e79f62c93e38a1f840405eafeb09f8395d58f4008ccc13a5a5e29897a0809
+  data.tar.gz: b9fb74c7829de958cd8f126b88ac89e50c13b5e4591362f0017b00bfbbbcae88
+SHA512:
+  metadata.gz: 6eb0bb8d8f2deac5676e329b01ffdda3b07eaa6682f8ed013c73769a3b34ac4e660c4258f5f6fa8d2bc3f4aaa019c2991f3a831da218c701be36bb9be72f073b
+  data.tar.gz: 61cd4cce678119e687c2691942e21344b98a830e028df7acf3d7d8bc662c588c01a6b66615c9ac5e818a78ed3bbb9b55de8b8609885bbe48620c199e28f4d1db

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rpriebe@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,93 @@
+# DeployLog
+
+Get all Github pull requests for a specific timeframe, or search by title/branch name.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deploy_log'
+```
+
+And then execute:
+
+> $ bundle
+
+Or install it yourself as:
+> $ gem install deploy_log
+
+## Usage
+
+First, make sure your Github username and a [personal access token](https://github.com/settings/tokens) are setup as follows:
+
+```bash
+export GITHUB_USER="octocat"
+export GITHUB_TOKEN="someRandomStringHere"
+```
+
+Search in any valid date range.
+
+```bash
+$ deploy_log my/repo --start=2019-06-11 --end=2019-06-12
+
+# My PR title (https://github.com/my/repo/pull/1)
+#  - Created by octocat
+#  - Branch: my_branch
+#  - Merged by octocat on 11/6/2019 @ 04:13:35pm
+#  - Changes: https://github.com/my/repo/pull/1.diff
+#
+# ============================================================
+# 1 PR(s) merged from 2019-06-11 00:00:00 -0600 to 2019-06-12 00:00:00 -0600
+# ============================================================
+```
+
+Search by PR name.
+
+```bash
+$ deploy_log my/repo --title="My PR title"
+
+# My PR title (https://github.com/my/repo/pull/1)
+#  - Created by octocat
+#  - Branch: my_branch
+#  - Merged by octocat on 11/6/2019 @ 04:13:35pm
+#  - Changes: https://github.com/my/repo/pull/1.diff
+#
+# ============================================================
+# 1 PR(s) matched
+# ============================================================
+```
+
+Find a PR by branch name.
+
+```bash
+$ deploy_log my/repo --branch="my_branch"
+
+# My PR title (https://github.com/my/repo/pull/1)
+#  - Created by octocat
+#  - Branch: my_branch
+#  - Merged by octocat on 11/6/2019 @ 04:13:35pm
+#  - Changes: https://github.com/my/repo/pull/1.diff
+#
+# ============================================================
+# 1 PR(s) matched
+# ============================================================
+```
+
+## 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]/deploy_log. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DeployLog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/deploy_log/blob/master/CODE_OF_CONDUCT.md).

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 => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deploy_log"
+
+# 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/deploy_log.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deploy_log/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "deploy_log"
+  spec.version       = DeployLog::VERSION
+  spec.authors       = ["Ryan Priebe"]
+  spec.email         = ["rpriebe@me.com"]
+
+  spec.summary       = "Find out what pull requests are merged within a specific timeframe, or search by PR title or branch name"
+  spec.description   = "That's prety much it"
+  spec.homepage      = "https://github.com/aapis/deploy_log"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = 'deploy_log'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'notifaction', '~> 0.4.4'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_runtime_dependency 'octokit', '~> 4.0'
+end

data/exe/deploy_log

@@ -0,0 +1,39 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'notifaction'
+require 'octokit'
+require 'optionparser'
+require 'time'
+require 'deploy_log'
+
+start, finish, title, branch = nil
+
+OptionParser.new do |opt|
+  opt.on('-s', '--start=START', 'Start of date range') do |time|
+    start = Time.parse(time)
+  end
+
+  opt.on('-e', '--end=END', 'End of date range') do |time|
+    finish = Time.parse(time)
+  end
+
+  opt.on('-t', '--title=TITLE', 'Title of the PR you want') do |ti|
+    title = ti
+  end
+
+  opt.on('-b', '--branch=BRANCH', 'Name of the branch you want') do |br|
+    branch = br
+  end
+
+  opt.on('-v', '--version', 'Prints version information') do
+    puts DeployLog::VERSION
+    exit
+  end
+end.parse!
+
+model = GithubDeploys.new
+model.merged_between(start, finish) if start && finish
+model.pr_title(title) if title
+model.pr_for_branch(branch) if branch
+model.merged_today if title.nil? && branch.nil? && start.nil? && finish.nil?

data/lib/deploy_log/github_deploys.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class GithubDeploys
+  def initialize
+    @github = GithubHelper.new(ARGV.first)
+  end
+
+  def merged_between(start, finish)
+    unless start && finish
+      Notify.error("Start and end dates (--start= and --end=) are required")
+    end
+
+    @github.pulls_in_timeframe(start, finish)
+  end
+
+  def merged_today
+    start = Date.today.to_time # 12:00AM this morning
+    finish = Date.today.to_time + (24 * 60 * 60) - 1 # 11:59PM tonight
+
+    @github.pulls_in_timeframe(start, finish)
+  end
+
+  def merged_on(start)
+    unless start
+      Notify.error("Start date (--start=) is required")
+    end
+
+    finish = start + 24 * 60 * 60 - 1
+
+    @github.pulls_in_timeframe(start, finish)
+  end
+
+  def pr_title(title)
+    @github.search_pulls_by(title, :title)
+  end
+
+  def pr_for_branch(branch)
+    @github.search_pulls_by(branch, :ref)
+  end
+end

data/lib/deploy_log/github_helper.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+
+class GithubHelper
+  def initialize(user_repo)
+    @client = Octokit::Client.new(login: ENV['GITHUB_USER'], password: ENV['GITHUB_TOKEN'])
+    @repo_location = user_repo
+  end
+
+  def pulls_in_timeframe(date_start = nil, date_end = nil)
+    @client.auto_paginate = true
+    list = @client.pull_requests(@repo_location,
+      state: :closed,
+      per_page: 500,
+      sort: 'long-running'
+    )
+
+    pr_format_str = "%s (%s)\n - Created by %s\n - Branch: %s\n - Merged by %s on %s\n - Changes: %s\n\n"
+    prs_covered = 0
+
+    File.open('/tmp/github-deploys.log', 'w+') do |f|
+      list.each do |pr|
+        next unless (date_start..date_end).cover? pr.merged_at
+
+        prs_covered += 1
+
+        f.write(
+          sprintf(
+            pr_format_str,
+            pr.title,
+            pr.html_url,
+            pr.user.login,
+            pr.head.ref,
+            user_who_merged(pr.number),
+            formatted_time(pr.merged_at),
+            pr.diff_url
+          )
+        )
+      end
+
+      f.write("============================================================\n#{prs_covered} PR(s) merged from #{date_start} to #{date_end}\n============================================================\n")
+    end
+
+    return Notify.warning("No pull requests have been merged in the requested date range (#{date_start} - #{date_end})") if prs_covered.zero?
+
+    system('cat /tmp/github-deploys.log')
+  end
+
+  def search_pulls_by(value, field = :title)
+    list = @client.pull_requests(@repo_location,
+      :state => :all,
+      :per_page => 100
+      )
+    pr_format_str = "%s (%s)\n - Created by %s\n - Branch: %s\n - Changes: %s\n\n"
+    prs_covered = 0
+
+    File.open('/tmp/github-deploys.log', 'w+') do |f|
+      list.each do |pr|
+        next unless nested_hash_value(pr, field).match?(/#{value}\b/)
+
+        prs_covered += 1
+
+        f.write(
+          sprintf(
+            pr_format_str,
+            pr.title,
+            pr.html_url,
+            pr.user.login,
+            pr.head.ref,
+            pr.diff_url
+          )
+        )
+      end
+
+      f.write("============================================================\n#{prs_covered} PR(s) matched\n============================================================\n")
+    end
+
+    return Notify.warning("No pull requests match the requested term (#{value})") if prs_covered.zero?
+
+    system('cat /tmp/github-deploys.log')
+  end
+
+  private
+
+  def user_who_merged(pr_number)
+    pr = @client.pull_request(@repo_location, pr_number)
+    pr.merged_by.login
+  end
+
+  def formatted_time(time, correct_utc = false)
+    time = Time.now if time.nil?
+    time = time.localtime if correct_utc
+    time.strftime('%e/%-m/%Y @ %I:%M:%S%P')
+  end
+
+  def nested_hash_value(obj, key)
+    if obj.respond_to?(:key?) && obj.key?(key)
+      obj[key]
+    elsif obj.respond_to?(:each)
+      r = nil
+      obj.find{ |*a| r=nested_hash_value(a.last,key) }
+      r
+    end
+  end
+end

data/lib/deploy_log/version.rb

@@ -0,0 +1,3 @@
+module DeployLog
+  VERSION = "0.1.0"
+end

data/lib/deploy_log.rb

@@ -0,0 +1,7 @@
+require 'deploy_log/version'
+require 'deploy_log/github_helper'
+require 'deploy_log/github_deploys'
+
+module DeployLog
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: deploy_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Priebe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: notifaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+- !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'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: That's prety much it
+email:
+- rpriebe@me.com
+executables:
+- deploy_log
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deploy_log.gemspec
+- exe/deploy_log
+- lib/deploy_log.rb
+- lib/deploy_log/github_deploys.rb
+- lib/deploy_log/github_helper.rb
+- lib/deploy_log/version.rb
+homepage: https://github.com/aapis/deploy_log
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Find out what pull requests are merged within a specific timeframe, or search
+  by PR title or branch name
+test_files: []