github_contributions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0d33817df8b9fe32cc09fc6ec8d9a390d976ddaceb4a6aaca9c2697f1a9ba59
+  data.tar.gz: a4f89cd9967862b119a203d2e92e7c779a99d4eee96b82de6854d0b706b41359
+SHA512:
+  metadata.gz: 700395833c364f7c5e721f86793f7c9db4e64d31f41e9b374435a25a22686b005150dfb776161a958946db60aaeb1a84b7e0042ad9849cc243223424b9c84311
+  data.tar.gz: 0b615dfae4dbe0868e18f21c3aabd694e8ce52a51e6e1e56750c895099f9afae1ffee994ad7f119053c2f07206baa72b3cfe0ae7e618bfb453db7a47626a159f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Kevin Jalbert
+
+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,56 @@
+# GitHub Contributions
+
+> Ever wanted to know where you (or someone else) are making contributions on GitHub?
+
+Your GitHub profile shows you the [Contributions Calendar](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile#contributions-calendar) and [Contribution activity](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile#contribution-activity), which both provide great visualizations and details covering contributions of the following:
+
+  - creating/closing issues
+  - creating/closing/merging/reviewing pull requests
+  - creating repositories
+  - authoring commits on the main branch of repositories
+  - starting/answering discussions
+
+I personally wanted to track comments on issues and pull requests as I felt they were a good indication of contributions. It sometimes isn't uncommon for a lot of discussions to happen on issues or even a pull request.
+
+I am a fan of [Obsidian](https://obsidian.md/) right now to track my day at work. Recording these contributions in GitHub makes it simple to recall what I did in previous days/weeks. This is even more important if you have a [_BragDoc_](https://jvns.ca/blog/brag-documents/). As Obsidian uses Markdown, that is the primary format that this tool is built for.
+
+## Install
+
+```bash
+gem install github_contributions
+```
+
+You need a GitHub Personal Access Token in your ENVs as `GITHUB_ACCESS_TOKEN` for this gem to work.
+
+## Usage
+
+```bash
+# Show me contributions for 'kevinjalbert' for today
+github_contributions -a "kevinjalbert"
+
+# Show me contributions for 'kevinjalbert' for today only in the 'shopify' org
+github_contributions -a "kevinjalbert" -o "shopify"
+
+# Show me contributions for 'kevinjalbert' in the last week
+github_contributions -a "kevinjalbert" -s "last week"
+
+# Show me contributions for 'kevinjalbert' for the week before last
+github_contributions -a "kevinjalbert" -s "two weeks ago" -e "one week ago"
+
+# Show me contributions for 'kevinjalbert' for only yesterday
+github_contributions -a "kevinjalbert" -s "yesterday" -e "yesterday"
+
+# Help
+github_contributions -h
+```
+
+Contributions are grouped by their pull request or issue in order of creation time. This ends up producing a rather detailed list of where contributions were made in the specified time frame. Links are present to easily allow you to jump directly to the contribution. Everything is displayed in Markdown, ready to be copy/pasted where desired. The following is an example of what the output looks like:
+
+- [Support function in `message` expectation in `t.throws` / `t.throwsAsync`](https://github.com/avajs/ava/issues/2978) by [sindresorhus](https://github.com/sindresorhus)
+  - [Issue Opened at 2022-02-26 08:42:19 UTC](https://github.com/avajs/ava/issues/2978)
+  - [IssueComment Created at 2022-02-26 08:43:12 UTC](https://github.com/avajs/ava/issues/2978#issuecomment-1051842838)
+- [Use `for..of` loop](https://github.com/sindresorhus/string-width/pull/40) by [fisker](https://github.com/fisker)
+  - [PullRequestReviewComment Created at 2022-02-28 08:18:52 UTC](https://github.com/sindresorhus/string-width/pull/40#discussion_r815662489)
+  - [PullRequestReview Created at 2022-02-28 08:18:52 UTC](https://github.com/sindresorhus/string-width/pull/40#pullrequestreview-894766255)
+  - [PullRequest Closed at 2022-02-28 08:20:12 UTC](https://github.com/sindresorhus/string-width/pull/40)
+  - [IssueComment Created at 2022-02-28 08:20:16 UTC](https://github.com/sindresorhus/string-width/pull/40#issuecomment-1054001902)

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+
+desc <<~TEXT
+Task to run the gem during developing.
+
+This doesn't require the gem to be installed.
+
+rake dev [options]
+rake dev -a "kevinjalbert" -s "last week"
+TEXT
+task :dev do
+  require "pry"
+  require "./lib/github_contributions"
+
+  GithubContributions.run(ARGV[1..-1])
+
+  # Needed, or rake will try to continue and 'parse' tasks from the args
+  exit
+end

data/bin/github_contributions

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "github_contributions"
+
+GithubContributions.run(ARGV)

data/github_contributions.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github_contributions/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_contributions"
+  spec.version       = GithubContributions::VERSION
+  spec.authors       = ["Kevin Jalbert"]
+  spec.email         = ["kevin.j.jalbert@gmail.com"]
+  spec.summary       = "Gem that provides can fetch your GitHub contributions and output them"
+  spec.description   = "Gem that provides can fetch your GitHub contributions and output them"
+  spec.homepage      = "https://github.com/kevinjalbert/github_contributions"
+  spec.license       = "MIT"
+
+  spec.files         = Dir["**/*"]
+  spec.test_files    = Dir["{test,spec,features}/**/*"]
+  spec.executables   = Dir["bin/*"].map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", ">= 2.3"
+  spec.add_dependency "chronic", ">= 0.10"
+  spec.add_dependency "octokit", ">= 4.22"
+  spec.add_dependency "hashie", ">= 5.0"
+  spec.add_dependency "activesupport", ">= 7.0"
+
+  spec.add_development_dependency "rake", ">= 13.0"
+
+  spec.required_ruby_version = ">= 2.7"
+end

data/lib/github_contributions/contribution_grouper.rb

@@ -0,0 +1,24 @@
+module GithubContributions
+  module ContributionGrouper
+    class << self
+      # @param events [Event]
+      # @return Hash<GithubObject, [Event]>
+      def by_issue_or_pull_request(events)
+        grouped_events = {}
+
+        events.each do |event|
+          if event.respond_to?(:pull_request)
+            grouped_events[event.pull_request] = [] unless grouped_events.key?(event.pull_request)
+            grouped_events[event.pull_request] << event
+          end
+          if event.respond_to?(:issue)
+            grouped_events[event.issue] = [] unless grouped_events.key?(event.issue)
+            grouped_events[event.issue] << event
+          end
+        end
+
+        grouped_events
+      end
+    end
+  end
+end

data/lib/github_contributions/errors.rb

@@ -0,0 +1,7 @@
+module GithubContributions
+  class Exception < StandardError; end
+  class MissingAuthor < GithubContributions::Exception; end
+  class MissingGithubAcessToken < GithubContributions::Exception; end
+  class TimeParseError < GithubContributions::Exception; end
+  class StartDateOutOfRange < GithubContributions::Exception; end
+end

data/lib/github_contributions/event.rb

@@ -0,0 +1,32 @@
+module GithubContributions
+  class Event
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def payload
+    end
+
+    def org
+      data.org&.login
+    end
+
+    def actor
+      GithubObjects::User.new(data.actor)
+    end
+
+    def created_at
+      data.created_at
+    end
+
+    def action
+      data.payload.action.titleize
+    end
+
+    def name
+      self.class.name.demodulize.sub("Event", "").singularize
+    end
+  end
+end

data/lib/github_contributions/events/issue_comment_event.rb

@@ -0,0 +1,19 @@
+module GithubContributions
+  module Events
+    class IssueCommentEvent < Event
+      def payload
+        comment
+      end
+
+      def comment
+        @comment ||= GithubObjects::Comment.new(data.payload.comment)
+      end
+
+      # Note a pull request comment is classifed as an 'issue' although there is
+      # a `pull_request` attribute in the payload that could be used to id one
+      def issue
+        @issue ||= GithubObjects::Issue.new(data.payload.issue)
+      end
+    end
+  end
+end

data/lib/github_contributions/events/issues_event.rb

@@ -0,0 +1,13 @@
+module GithubContributions
+  module Events
+    class IssuesEvent < Event
+      def payload
+        issue
+      end
+
+      def issue
+        @issue ||= GithubObjects::Issue.new(data.payload.issue)
+      end
+    end
+  end
+end

data/lib/github_contributions/events/pull_request_event.rb

@@ -0,0 +1,13 @@
+module GithubContributions
+  module Events
+    class PullRequestEvent < Event
+      def payload
+        pull_request
+      end
+
+      def pull_request
+        @pull_request ||= GithubObjects::PullRequest.new(data.payload.pull_request)
+      end
+    end
+  end
+end

data/lib/github_contributions/events/pull_request_review_comment_event.rb

@@ -0,0 +1,17 @@
+module GithubContributions
+  module Events
+    class PullRequestReviewCommentEvent < Event
+      def payload
+        comment
+      end
+
+      def comment
+        @comment ||= GithubObjects::Comment.new(data.payload.comment)
+      end
+
+      def pull_request
+        @pull_request ||= GithubObjects::PullRequest.new(data.payload.pull_request)
+      end
+    end
+  end
+end

data/lib/github_contributions/events/pull_request_review_event.rb

@@ -0,0 +1,17 @@
+module GithubContributions
+  module Events
+    class PullRequestReviewEvent < Event
+      def payload
+        review
+      end
+
+      def review
+        @review ||= GithubObjects::Review.new(data.payload.review)
+      end
+
+      def pull_request
+        @pull_request ||= GithubObjects::PullRequest.new(data.payload.pull_request)
+      end
+    end
+  end
+end

data/lib/github_contributions/github_object.rb

@@ -0,0 +1,24 @@
+module GithubContributions
+  # call these payloads?
+  class GithubObject
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def user
+      GithubObjects::User.new(data.user)
+    end
+
+    # ContributionGrouper uses these objects as keys in a hash
+    # We need to define the `hash` and `eql?` so they work correctly
+    def eql?(other)
+      hash == other.hash
+    end
+
+    def hash
+      data.html_url.hash
+    end
+  end
+end

data/lib/github_contributions/github_objects/comment.rb

@@ -0,0 +1,6 @@
+module GithubContributions
+  module GithubObjects
+    class Comment < GithubObject
+    end
+  end
+end

data/lib/github_contributions/github_objects/issue.rb

@@ -0,0 +1,6 @@
+module GithubContributions
+  module GithubObjects
+    class Issue < GithubObject
+    end
+  end
+end

data/lib/github_contributions/github_objects/pull_request.rb

@@ -0,0 +1,6 @@
+module GithubContributions
+  module GithubObjects
+    class PullRequest < GithubObject
+    end
+  end
+end

data/lib/github_contributions/github_objects/review.rb

@@ -0,0 +1,6 @@
+module GithubContributions
+  module GithubObjects
+    class Review < GithubObject
+    end
+  end
+end

data/lib/github_contributions/github_objects/user.rb

@@ -0,0 +1,10 @@
+module GithubContributions
+  module GithubObjects
+    class User < GithubObject
+      def initialize(data)
+        super(data)
+        @data[:html_url] = "https://github.com/#{data.login}" if @data.html_url.nil?
+      end
+    end
+  end
+end

data/lib/github_contributions/markdown_presenter.rb

@@ -0,0 +1,30 @@
+module GithubContributions
+  module MarkdownPresenter
+    class << self
+      # @param grouped_events Hash<GithubObject, [Event]>
+      def output(grouped_events)
+        puts title
+        grouped_events.each_pair do |issue, events|
+          puts issue_or_pull_request(issue)
+          events.each do |event|
+            puts event(event)
+          end
+        end
+      end
+
+      private
+
+      def title
+        "# GitHub Contributions"
+      end
+
+      def issue_or_pull_request(issue)
+        "- [#{issue.data.title.strip}](#{issue.data.html_url}) by [#{issue.user.data.login}](#{issue.user.data.html_url})"
+      end
+
+      def event(event)
+        "  - [#{event.name} #{event.action} at #{event.created_at}](#{event.payload.data.html_url})"
+      end
+    end
+  end
+end

data/lib/github_contributions/option_handler.rb

@@ -0,0 +1,45 @@
+module GithubContributions
+  module OptionHandler
+    def self.parse_options(args)
+      options = OpenStruct.new(
+        author: nil,
+        org: nil,
+        start_date: Time.current.at_beginning_of_day,
+        end_date: Time.current.at_end_of_day
+      )
+
+      OptionParser.new do |opts|
+        opts.banner = <<~TEXT
+          Usage: github_contributions [options]
+          You need a GitHub Personal Access Token in your ENVs as GITHUB_ACCESS_TOKEN for this to work.
+          Dates are specified using natual language (via chronic gem).
+          The GitHub's Events API only returns the last 300 events, and the filtering is client-side.
+        TEXT
+        opts.version = VERSION
+        opts.on "-a", "--author STRING", String, "The author of the contributions" do |value|
+          options.author = value
+        end
+        opts.on "-o", "--org STRING", String, "Filter contributions by the organization they belong in (optional)" do |value|
+          options.org = value
+        end
+        opts.on "-s", "--start_date STRING", String, "Filter contributions to be after the beginning of the specified day (defaults to today)" do |value|
+          options.start_date = Chronic.parse(value)&.at_beginning_of_day
+        end
+        opts.on "-e", "--end_date STRING", String, "Filter contributions to be before the end of the specified day (defaults to today)" do |value|
+          options.end_date = Chronic.parse(value)&.at_end_of_day
+        end
+      end.parse!
+
+      raise(TimeParseError, "The end date could not be properly parsed") if options.end_date.nil?
+      raise(TimeParseError, "The start date could not be properly parsed") if options.start_date.nil?
+      raise(StartDateOutOfRange, "The start date must be within 90 day from today") unless options.start_date.between?(90.days.ago, Time.current.at_end_of_day)
+      raise(MissingAuthor, "No author was supplied in arguments (use -a <author>)") if options.author.blank?
+      raise(MissingGithubAcessToken, "GitHub Personal Access Token was not found (should be an ENV as GITHUB_ACCESS_TOKEN") if ENV["GITHUB_ACCESS_TOKEN"].nil?
+
+      options
+    rescue GithubContributions::Exception => e
+      puts e.message
+      exit
+    end
+  end
+end

data/lib/github_contributions/version.rb

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

data/lib/github_contributions.rb

@@ -0,0 +1,53 @@
+require "active_support/all"
+require "chronic"
+require "ostruct"
+require "optparse"
+require "octokit"
+require "hashie"
+require "digest"
+
+Dir.glob(File.dirname(__FILE__) + '/github_contributions/**/*.rb') { |file| require file  }
+
+module GithubContributions
+  class << self
+    def run(args)
+      options = OptionHandler.parse_options(args)
+
+      puts "Searching between #{options.start_date.to_formatted_s(:long_ordinal)} and #{options.end_date.to_formatted_s(:long_ordinal)}..."
+
+      client = Octokit::Client.new(access_token: ENV["GITHUB_ACCESS_TOKEN"])
+      client.auto_paginate = true
+
+      results = client.user_events(options.author)
+
+      contribution_count = results.size
+      filtered_contribution_count = 0
+      events = results.map do |result|
+        result.include(Hashie::Mash)
+
+        begin
+          event = "GithubContributions::Events::#{result.type}".constantize.new(result)
+        rescue
+          # TODO: I'd want this one, just don't have an example of it yet
+          # binding.pry if result.type == "CommitCommentEvent"
+          next
+        end
+
+        next unless event.created_at.between?(options.start_date, options.end_date)
+
+        if options.org
+          next unless event.org == options.org
+        end
+
+        filtered_contribution_count += 1
+        event
+      end.compact.reverse
+
+      puts "Found #{filtered_contribution_count}/#{contribution_count} contributions using search filters"
+      puts ""
+
+      grouped_events = ContributionGrouper.by_issue_or_pull_request(events)
+      MarkdownPresenter.output(grouped_events)
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: github_contributions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Jalbert
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.22'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Gem that provides can fetch your GitHub contributions and output them
+email:
+- kevin.j.jalbert@gmail.com
+executables:
+- github_contributions
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/github_contributions
+- github_contributions.gemspec
+- lib/github_contributions.rb
+- lib/github_contributions/contribution_grouper.rb
+- lib/github_contributions/errors.rb
+- lib/github_contributions/event.rb
+- lib/github_contributions/events/issue_comment_event.rb
+- lib/github_contributions/events/issues_event.rb
+- lib/github_contributions/events/pull_request_event.rb
+- lib/github_contributions/events/pull_request_review_comment_event.rb
+- lib/github_contributions/events/pull_request_review_event.rb
+- lib/github_contributions/github_object.rb
+- lib/github_contributions/github_objects/comment.rb
+- lib/github_contributions/github_objects/issue.rb
+- lib/github_contributions/github_objects/pull_request.rb
+- lib/github_contributions/github_objects/review.rb
+- lib/github_contributions/github_objects/user.rb
+- lib/github_contributions/markdown_presenter.rb
+- lib/github_contributions/option_handler.rb
+- lib/github_contributions/version.rb
+- pkg/github_contributions-0.1.0.gem
+homepage: https://github.com/kevinjalbert/github_contributions
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Gem that provides can fetch your GitHub contributions and output them
+test_files: []