hub_link 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93ee43fb3a227d9cf2d717bbfc4a0360322fc7fb
+  data.tar.gz: 996bee5b052dcc20175d5f5b44c0b6b990574bb6
+SHA512:
+  metadata.gz: 6f1a78064fbb51df76882b32a2365340d89848bb366a1de9adb6b16a15e8f61076b4e37a26c3ad2d8b40a507b65564dea4462e0539d620e2db2b38c302f5740f
+  data.tar.gz: 587a65a67cf82553d22b84a12145681da1fe4e7e03a3b44a03185d20272aaa748c9b1f139d12db6e8cc67f102ba7192a2c00c04cf921a3084e5864676e9e419f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+*.csv
+/tmp
+!/tmp/.gitkeep
+.env
+.ruby-version

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jens@balvig.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jens Balvig
+
+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,37 @@
+# Hub Link
+
+When you just want the loop through all the raw pull request and review data from GitHub
+(for exporting metrics f.ex).
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+ ```ruby
+ gem "hub_store"
+```
+
+Then you can do:
+
+```ruby
+REPOS = "balvig/hub_link,balvig/hub_store"
+
+stream = HubLink::Stream.new(REPOS, start_date: 3.months.ago)
+
+stream.in_batches do |batch|
+  batch.prs # => [{ id: 34, merge_time: 6400, ... }]
+  batch.reviews # => [{ id: 54, reviewer: "balvig", approval: true, ... }]
+  batch.review_requests # => [{ id: 74, reviewer: "balvig", ... }]
+end
+```
+
+Hub Link will loop through the API in batches of 2 weeks at a time.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/balvig/hub_link. 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 => :test

data/bin/console

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

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hub_link/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hub_link"
+  spec.version       = HubLink::VERSION
+  spec.authors       = ["Jens Balvig"]
+  spec.email         = ["jens@balvig.com"]
+
+  spec.summary       = %q{Fetch raw data from GitHub for metrics}
+  spec.homepage      = "https://github.com/balvig/hub_link"
+  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_dependency "activesupport"
+  spec.add_dependency "dotenv"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "faraday-detailed_logger"
+  spec.add_dependency "octokit"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

data/lib/hub_link/api/.review_request.rb

@@ -0,0 +1,14 @@
+module Mergometer
+  class ReviewRequest
+    attr_reader :created_at, :user
+
+    def initialize(created_at:, user:)
+      @created_at = created_at
+      @user = user
+    end
+
+    def reviewer
+      user.login
+    end
+  end
+end

data/lib/hub_link/api/pull_request.rb

@@ -0,0 +1,107 @@
+require "octokit"
+require "hub_link/core_ext/float"
+require "hub_link/api/review"
+require "hub_link/api/review_request"
+require "hub_link/slicer"
+
+module HubLink
+  module Api
+    class PullRequest < SimpleDelegator
+      def self.search(filter)
+        Octokit.search_issues(filter).items.map { |item| new(item) }
+      end
+
+      def submitter
+        user.login
+      end
+
+      def reviews
+        @_reviews ||= fetch_reviews
+      end
+
+      def review_requests
+        @_review_requests ||= fetch_review_requests
+      end
+
+      def additions
+        extended_data.additions
+      end
+
+      def body_size
+        body.to_s.size
+      end
+
+      def merge_time
+        return unless merged?
+
+        (closed_at - created_at).in_hours
+      end
+
+      def time_to_first_review
+        return if first_review.blank?
+
+        (first_review.submitted_at - created_at).in_hours
+      end
+
+      def approval_time
+        return if first_approval.blank?
+
+        (first_approval.submitted_at - created_at).in_hours
+      end
+
+      def straight_approval?
+        reviews.all?(&:approval?)
+      end
+
+      def review_count
+        reviews.size
+      end
+
+      def repo
+        extended_data.base.repo.full_name
+      end
+
+      def labels
+        @_labels ||= Octokit.labels_for_issue(repo, number).map(&:name).join(", ")
+      end
+
+      def to_h
+        Slicer.new(self, columns: %i(id number created_at closed_at approval_time time_to_first_review merge_time body_size additions review_count submitter straight_approval? labels repo)).to_h
+      end
+
+      private
+
+        def merged?
+          closed_at.present?
+        end
+
+        def fetch_review_requests
+          requests = Octokit.pull_request_review_requests(repo, number)
+
+          requests.users.compact.map do |user|
+            ReviewRequest.new(id: id, created_at: created_at, user: user)
+          end
+        end
+
+        def fetch_reviews
+          Octokit.pull_request_reviews(repo, number).map do |data|
+            data.pull_request_id = id
+            data.number = number
+            Review.new(data)
+          end.reject(&:invalid?)
+        end
+
+        def first_approval
+          reviews.find(&:approval?)
+        end
+
+        def first_review
+          reviews.first
+        end
+
+        def extended_data
+          @_extended_data ||= Octokit.get(pull_request.url)
+        end
+    end
+  end
+end

data/lib/hub_link/api/review.rb

@@ -0,0 +1,37 @@
+module HubLink
+  module Api
+    class Review < SimpleDelegator
+      BOTS = %w(houndci-bot cookpad-devel)
+
+      def reviewer
+        user.login
+      end
+
+      def approval?
+        state == "APPROVED"
+      end
+
+      def invalid?
+        bot? || driveby? || draft?
+      end
+
+      def to_h
+        Slicer.new(self, columns: %i(id pull_request_id submitted_at reviewer approval?)).to_h
+      end
+
+      private
+
+        def bot?
+          BOTS.include?(user.login)
+        end
+
+        def driveby?
+          state == "COMMENTED"
+        end
+
+        def draft?
+          state == "PENDING"
+        end
+    end
+  end
+end

data/lib/hub_link/api/review_request.rb

@@ -0,0 +1,21 @@
+module HubLink
+  module Api
+    class ReviewRequest
+      attr_reader :created_at, :user, :id
+
+      def initialize(id:, created_at:, user:)
+        @id = id
+        @created_at = created_at
+        @user = user
+      end
+
+      def reviewer
+        user.login
+      end
+
+      def to_h
+        Slicer.new(self, columns: %i(id user created_at reviewer)).to_h
+      end
+    end
+  end
+end

data/lib/hub_link/batch.rb

@@ -0,0 +1,27 @@
+module HubLink
+  class Batch
+    def initialize(query)
+      @query = query
+    end
+
+    def pull_requests
+      results.map(&:to_h)
+    end
+
+    def reviews
+      results.flat_map(&:reviews).map(&:to_h)
+    end
+
+    def review_requests
+      results.flat_map(&:review_requests).map(&:to_h)
+    end
+
+    private
+
+      attr_reader :query
+
+      def results
+        @_results ||= Api::PullRequest.search(query)
+      end
+  end
+end

data/lib/hub_link/configuration.rb

@@ -0,0 +1,40 @@
+require "faraday/detailed_logger"
+require "faraday_middleware"
+require "active_support"
+
+module HubLink
+  class Configuration
+    def initialize(cache_time: 3600)
+      @cache_time = cache_time
+    end
+
+    def apply
+      Octokit.middleware = middleware
+      Octokit.auto_paginate = true
+    end
+
+    private
+
+      attr_reader :cache_time
+
+      def middleware
+        Faraday::RackBuilder.new do |builder|
+          builder.response :detailed_logger, logger
+          builder.response :caching, cache
+          builder.use Octokit::Response::RaiseError
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+      def cache
+        ActiveSupport::Cache::FileStore.new "tmp/cache", expires_in: cache_time
+      end
+
+      def logger
+        logger = Logger.new(STDOUT)
+        logger.formatter = ->(_, datetime, _, msg) { "#{datetime.to_s(:db)} - #{msg}\n" }
+        logger.level = Logger::INFO
+        logger
+      end
+  end
+end

data/lib/hub_link/core_ext/float.rb

@@ -0,0 +1,5 @@
+class Float
+  def in_hours
+    (self / 60 / 60).round
+  end
+end

data/lib/hub_link/slicer.rb

@@ -0,0 +1,18 @@
+module HubLink
+  class Slicer
+    def initialize(record, columns: [])
+      @record = record
+      @columns = columns
+    end
+
+    def to_h
+      columns.inject({}) do |result, column|
+        result.merge(column => record.public_send(column))
+      end
+    end
+
+    private
+
+      attr_reader :record, :columns
+  end
+end

data/lib/hub_link/stream.rb

@@ -0,0 +1,43 @@
+require "hub_link/api/pull_request"
+require "hub_link/batch"
+
+module HubLink
+  class Stream
+    GITHUB_BATCH_SIZE = 14
+
+    def initialize(repos, start_date: 64.weeks.ago)
+      @repos = repos.split(",")
+      @start_date = start_date.to_date
+    end
+
+    def in_batches(&block)
+      queries.each do |query|
+        yield Batch.new(query)
+      end
+    end
+
+    private
+
+      attr_accessor :repos, :start_date
+
+      def queries
+        start_date.step(end_date, GITHUB_BATCH_SIZE).map do |date|
+          "type:pr created:#{date}..#{date + GITHUB_BATCH_SIZE} #{repo_query}"
+        end
+      end
+
+      def end_date
+        Date.tomorrow
+      end
+
+      def repo_query
+        @_repo_query ||= build_repo_query
+      end
+
+      def build_repo_query
+        repos.map do |r|
+          "repo:#{r}"
+        end.join(" ")
+      end
+  end
+end

data/lib/hub_link/version.rb

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

data/lib/hub_link.rb

@@ -0,0 +1,8 @@
+require "dotenv/load"
+require "hub_link/configuration"
+require "hub_link/stream"
+require "hub_link/version"
+
+module HubLink
+  Configuration.new(cache_time: 72 * 3600).apply
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: hub_link
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jens Balvig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: dotenv
+  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: faraday_middleware
+  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: faraday-detailed_logger
+  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: octokit
+  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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- jens@balvig.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hub_link.gemspec
+- lib/hub_link.rb
+- lib/hub_link/api/.review_request.rb
+- lib/hub_link/api/pull_request.rb
+- lib/hub_link/api/review.rb
+- lib/hub_link/api/review_request.rb
+- lib/hub_link/batch.rb
+- lib/hub_link/configuration.rb
+- lib/hub_link/core_ext/float.rb
+- lib/hub_link/slicer.rb
+- lib/hub_link/stream.rb
+- lib/hub_link/version.rb
+- tmp/.gitkeep
+homepage: https://github.com/balvig/hub_link
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Fetch raw data from GitHub for metrics
+test_files: []