furik 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7607630ca7a12e7710d5fc11a42b3d47d23ff324
+  data.tar.gz: 536c2f12b203df54ea3b3d3926513cfb7cd65da9
+SHA512:
+  metadata.gz: 84bbbddb50d9f27427afb81540bff60d3c09ca2466748c04300990a0bf1ed47e119fa034cdb95b4545453c1da42bd63e65396aca5b718b2474aab6d28a17ec30
+  data.tar.gz: 8f167bf7418a8304b29285a998d844c5faea8b429190efe324a0b1e8e1cad6384ec657114f037590daf617952d2f202d9fe88aa9bf6110abf39c56d9a46c5b7f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,42 @@
+# Furik
+
+Furik is summary generator for your GitHub activities.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install furik
+
+## Usage
+
+You can show GitHub activity while one day.
+
+    $ furik activity
+
+If you want to show GitHub and GitHub Enterprise activities, You need to add `-l` option to `furik` command.
+
+    $ furik activity -l
+
+furik supports to store authentication via Pit. You are asked GitHub (and GitHub Enterprise) token from furik.
+
+Pit sotred your token to `~/.pit/default.yaml` by default. You can confirm or modify this yaml.
+
+```sh
+% cat ~/.pit/default.yaml
+---
+github.com:
+  access_token: your_token
+your.github-enterpise.host:
+  access_token: your_enterprise_token
+furik:
+  github_enterprise_host: your.github-enterpise.host
+```
+
+## 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. Run `bundle exec furik` to use the gem in this directory, ignoring other installed copies of this gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pepabo/furik.

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 "furik"
+
+# 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

data/bin/setup

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

data/exe/furik

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'furik/cli'
+
+Furik::Cli.start

data/furik.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'furik/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "furik"
+  spec.version       = Furik::VERSION
+  spec.authors       = ["linyows", "SHIBATA Hiroshi"]
+  spec.email         = ["linyows@gmail.com", "hsbt@ruby-lang.org"]
+
+  spec.summary       = %q{A summary generator of GitHub activity for retrospective.}
+  spec.description   = %q{A summary generator of GitHub activity for retrospective.}
+  spec.homepage      = "https://github.com/pepabo/furik"
+
+  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_dependency 'octokit', '~> 4.1.1'
+  spec.add_dependency 'pit', '~> 0.0.7'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/furik.rb

@@ -0,0 +1,50 @@
+require 'octokit'
+require 'furik/core_ext/string'
+require 'furik/configurable'
+require 'furik/pull_requests'
+require 'furik/events'
+require "furik/version"
+
+module Furik
+  class << self
+    def gh_client
+      Octokit::Client.new Configurable.github_octokit_options
+    end
+
+    def ghe_client
+      Octokit::Client.new Configurable.github_enterprise_octokit_options
+    end
+
+    def events_with_grouping(gh: true, ghe: true, from: nil, to: nil, &block)
+      events = []
+
+      if gh
+        gh_events = Events.new(gh_client).events_with_grouping(from, to, &block)
+        events.concat gh_events if gh_events.is_a?(Array)
+      end
+
+      if ghe
+        ghe_events = Events.new(ghe_client).events_with_grouping(from, to, &block)
+        events.concat ghe_events if ghe_events.is_a?(Array)
+      end
+
+      events
+    end
+
+    def pull_requests(gh: true, ghe: true, &block)
+      pulls = []
+
+      if gh
+        gh_pulls = PullRequests.new(gh_client).all(&block)
+        pulls.concat gh_pulls if gh_pulls.is_a?(Array)
+      end
+
+      if ghe
+        ghe_pulls = PullRequests.new(ghe_client).all(&block)
+        pulls.concat ghe_pulls if ghe_pulls.is_a?(Array)
+      end
+
+      pulls
+    end
+  end
+end

data/lib/furik/cli.rb

@@ -0,0 +1,112 @@
+require "furik"
+require 'thor'
+
+module Furik
+  class Cli < Thor
+    desc 'pulls', 'show pull requests'
+    method_option :gh, type: :boolean, aliases: '-g', default: true
+    method_option :ghe, type: :boolean, aliases: '-l'
+    method_option :start_date, type: :string, aliases: '-s'
+    method_option :end_date, type: :string, aliases: '-e'
+    def pulls
+      start_date = Date.parse(options[:start_date]) if options[:start_date]
+      end_date = Date.parse(options[:end_date]) if options[:end_date]
+
+      puts "Pull Requests#{" (#{start_date}...#{end_date})" if start_date && end_date}"
+      puts '-'
+      puts ''
+
+      Furik.pull_requests(gh: options[:gh], ghe: options[:ghe]) do |repo, issues|
+        if issues && !issues.empty?
+          string_issues = issues.each.with_object('') do |issue, memo|
+            date = issue.created_at.localtime.to_date
+
+            next if start_date && date < start_date
+            next if end_date && date > end_date
+
+            memo << "- [#{issue.number} #{issue.state}](#{issue.html_url}):"
+            memo << " #{issue.title}"
+            memo << " (#{issue.body.plain.cut})" if issue.body && !issue.body.empty?
+            memo << " #{issue.created_at.localtime.to_date}\n"
+          end
+
+          unless string_issues == ''
+            puts "### #{repo}"
+            puts ''
+            puts string_issues
+            puts ''
+          end
+        end
+      end
+    end
+
+    desc 'activity', 'show activity'
+    method_option :gh, type: :boolean, aliases: '-g', default: true
+    method_option :ghe, type: :boolean, aliases: '-l'
+    method_option :since, type: :numeric, aliases: '-d', default: 0
+    method_option :from, type: :string, aliases: '-f', default: Date.today.to_s
+    method_option :to, type: :string, aliases: '-t', default: Date.today.to_s
+    def activity
+      from = Date.parse(options[:from])
+      to   = Date.parse(options[:to])
+      since = options[:since]
+
+      diff = (to - from).to_i
+      diff.zero? ? from -= since : since = diff
+
+      period = case since
+      when 999 then 'All'
+      when 0 then "Today's"
+      else "#{since + 1}days"
+      end
+      puts "#{period} Activities"
+      puts '-'
+      puts ''
+
+      Furik.events_with_grouping(gh: options[:gh], ghe: options[:ghe], from: from, to: to) do |repo, events|
+        puts "### #{repo}"
+        puts ''
+
+        events.sort_by(&:type).reverse.each_with_object({ keys: [] }) do |event, memo|
+
+          payload_type = event.type.
+          gsub('Event', '').
+          gsub(/.*Comment/, 'Comment').
+          gsub('Issues', 'Issue').
+          underscore
+          payload = event.payload.send(:"#{payload_type}")
+          type = payload_type.dup
+
+          title = case event.type
+          when 'IssueCommentEvent'
+            "#{payload.body.plain.cut} (#{event.payload.issue.title.cut(30)})"
+          when 'CommitCommentEvent'
+            payload.body.plain.cut
+          when 'IssuesEvent'
+            type = "#{event.payload.action}_#{type}"
+            payload.title.plain.cut
+          when 'PullRequestReviewCommentEvent'
+            type = 'comment'
+            if event.payload.pull_request.respond_to?(:title)
+              "#{payload.body.plain.cut} (#{event.payload.pull_request.title.cut(30)})"
+            else
+              payload.body.plain.cut
+            end
+          else
+            payload.title.plain.cut
+          end
+
+          link = payload.html_url
+          key = "#{type}-#{link}"
+
+          next if memo[:keys].include?(key)
+          memo[:keys] << key
+
+          puts "- [#{type}](#{link}): #{title}"
+        end
+
+        puts ''
+      end
+    end
+  end
+end

data/lib/furik/configurable.rb

@@ -0,0 +1,67 @@
+require 'yaml'
+require 'pit'
+
+module Furik
+  module Configurable
+    class << self
+      def hub_config_path
+        ENV['HUB_CONFIG_PATH'] || "#{Dir.home}/.config/hub"
+      end
+
+      def token_generate_path
+        '/settings/tokens/new'
+      end
+
+      def token_by_hub(host = 'github.com')
+        hub_config = YAML.load_file hub_config_path
+        if !hub_config[host].nil? && !hub_config[host].empty?
+          hub_config[host].last['oauth_token']
+        end
+      end
+
+      def token_by_pit(host = 'github.com')
+        Pit.get(host, require: {
+          'access_token' => "#{host} Access Token? (https://#{host}#{token_generate_path})"
+        })['access_token']
+      end
+
+      def github_access_token
+        token_by_hub || token_by_pit
+      end
+
+      def github_enterprise_host
+        ENV['GITHUB_ENTERPRISE_HOST'] || github_enterprise_host_by_pit
+      end
+
+      def github_enterprise_host_by_pit
+        Pit.get('furik', require: {
+          'github_enterprise_host' => 'Github:Enterprise Host?(ex: your.domain.com)'
+        })['github_enterprise_host']
+      end
+
+      def github_enterprise_access_token
+        token_by_hub(github_enterprise_host) || token_by_pit(github_enterprise_host)
+      end
+
+      def default_octokit_options
+        {
+          auto_paginate: true,
+          per_page: 100
+        }
+      end
+
+      def github_octokit_options
+        default_octokit_options.merge(
+          access_token: github_access_token
+        )
+      end
+
+      def github_enterprise_octokit_options
+        default_octokit_options.merge(
+          access_token: github_enterprise_access_token,
+          api_endpoint: "https://#{github_enterprise_host}/api/v3/"
+        )
+      end
+    end
+  end
+end

data/lib/furik/core_ext/string.rb

@@ -0,0 +1,27 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr('-', '_').
+      downcase
+  end
+
+  def plain
+    self.gsub("\r\n", ' ').gsub(/[\s\-_=]{2,}/, ' ').strip
+  end
+
+  def cut(size = 50, options = {})
+    text = self.dup
+    options[:omission] ||= '...'
+    chars = ''
+    current_size = 0
+    text.each_char do |c|
+      current_size += c =~ /^[ -~｡-ﾟ]*$/ ? 1 : 2
+      break if current_size > size
+      chars << c
+    end
+    chars << options[:omission] if current_size > size
+    chars.to_s
+  end
+end

data/lib/furik/events.rb

@@ -0,0 +1,31 @@
+module Furik
+  class Events
+    def initialize(client)
+      @client = client
+      @login = client.login
+    end
+
+    def events_with_grouping(from, to, &block)
+      @client.user_events(@login).each.with_object({}) { |event, memo|
+        if event && aggressives.include?(event.type)
+          if from <= event.created_at.localtime.to_date && event.created_at.localtime.to_date <= to
+            memo[event.repo.name] ||= []
+            memo[event.repo.name] << event
+          end
+        end
+      }.each do |repo, events|
+        block.call(repo, events) if block
+      end
+    end
+
+    def aggressives
+      %w(
+        IssuesEvent
+        PullRequestEvent
+        PullRequestReviewCommentEvent
+        IssueCommentEvent
+        CommitCommentEvent
+      )
+    end
+  end
+end

data/lib/furik/pull_requests.rb

@@ -0,0 +1,87 @@
+require 'octokit'
+
+module Furik
+  class PullRequests
+    def initialize(client)
+      @client = client
+      @login = client.login
+    end
+
+    def request_manager
+      limit = @client.rate_limit
+      if !limit.limit.zero? && limit.remaining.zero?
+        puts "Oops! #{limit}"
+        sleep limit.resets_in
+      end
+    # No rate limit for white listed users
+    rescue Octokit::NotFound
+    end
+
+    def all(&block)
+      @block = block
+      @all || all!
+    end
+
+    def all!
+      @all = all_repo_names.each.with_object([]) do |repo_name, memo|
+        pulls = pull_requests(repo_name)
+        memo.concat pulls if pulls.is_a?(Array)
+        request_manager
+      end
+    end
+
+    def org_name_from(repo_name)
+      repo_name.split('/').first
+    end
+
+    # Use the issues api so specify the creator
+    def pull_requests(repo_name)
+      org_name = org_name_from(repo_name)
+
+      unless @block
+        if @org_name == org_name
+          print '-'
+        else
+          puts ''
+          print "#{org_name} -"
+          @org_name = org_name
+        end
+      end
+
+      issues = @client.issues(repo_name, creator: @login, state: 'open').
+        select { |issue| issue.pull_request }
+      issues.concat @client.issues(repo_name, creator: @login, state: 'closed').
+        select { |issue| issue.pull_request }
+
+      @block.call(repo_name, issues) if @block
+
+      issues
+    rescue Octokit::ClientError
+    rescue => e
+      puts e
+    end
+
+    def all_repo_names
+      names = self.user_repo_names
+      names.concat self.orgs_repo_names
+    end
+
+    def user_repo_names
+      @client.repos(@login).map(&:full_name)
+    end
+
+    def user_orgs_names
+      @client.orgs(@login).map(&:login)
+    end
+
+    def org_repo_names(org_name)
+      @client.org_repos(org_name).map(&:full_name)
+    end
+
+    def orgs_repo_names
+      user_orgs_names.each_with_object([]) do |org_name, memo|
+        memo.concat org_repo_names(org_name)
+      end
+    end
+  end
+end

data/lib/furik/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: furik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- linyows
+- SHIBATA Hiroshi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-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.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: pit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A summary generator of GitHub activity for retrospective.
+email:
+- linyows@gmail.com
+- hsbt@ruby-lang.org
+executables:
+- furik
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/furik
+- furik.gemspec
+- lib/furik.rb
+- lib/furik/cli.rb
+- lib/furik/configurable.rb
+- lib/furik/core_ext/string.rb
+- lib/furik/events.rb
+- lib/furik/pull_requests.rb
+- lib/furik/version.rb
+homepage: https://github.com/pepabo/furik
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: A summary generator of GitHub activity for retrospective.
+test_files: []