hub_store 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97df8ac363de159068fcaed6d97775965aac3b7a62e0d306df1d2535b3dd5e7d
+  data.tar.gz: b89c4e5ebe4c0658f9fcfdf0f0de61bf585b070560f4e709817180ffc72b6fef
+SHA512:
+  metadata.gz: a087117ba86485c70612ac5bf22a6c383976fb51c360b817803b063fa398673df1879e924b4cbadb24118d971e372d4fd26c308228ac729d907093b512124391
+  data.tar.gz: b15235ea2df9efc3c7f4f445662fe6e6d03073a35e71ce8830dd0a2a606957dbaddc7121769ee57ec2e57ec887b42d7bcac366cec33b1381c68eb1e9e93e0426

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+/db
+*.csv
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.17.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 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. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hub_store.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,56 @@
+# Hub Store
+
+Save raw pull request and review metadata from GitHub for metrics
+analysis etc.
+
+
+## Usage
+
+### Using inside an app
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hub_store"
+```
+
+Then:
+
+```ruby
+REPOS = "balvig/hub_store,balvig/hub_link"
+
+HubStore::Importer.new(repos: REPOS, start_date: 4.weeks.ago).run
+# => Imports pull request and review data to a local sqlite DB
+
+HubStore::Exporter.new(resource: PullRequest).run
+# => Exports pull request data from sqlite DB to `pull_requests.csv`
+
+HubStore::Exporter.new(resource: Review).run
+# => Exports review data from sqlite DB to `reviews.csv`
+```
+
+### Using from command line
+
+```bash
+gem install hub_store
+OCTOKIT_ACCESS_TOKEN=<token> hub_store <github_organization/repo_name>
+# Exports 2 years worth of PRs/Reviews to csv files.
+# Subsequent runs resume from last updated_at
+```
+
+## 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]/hub_store. 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 HubStore project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hub_store/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 "hub_store"
+
+# 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/exe/hub_store

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "hub_store"
+require "hub_store/cli"
+
+HubStore::Cli.run(ARGV)

data/hub_store.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hub_store/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hub_store"
+  spec.version       = HubStore::VERSION
+  spec.authors       = ["Jens Balvig"]
+  spec.email         = ["jens@balvig.com"]
+
+  spec.summary       = %q{Downloads PR/Review info CSV files}
+  spec.homepage      = "https://balvig.com"
+  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   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "activerecord"
+  spec.add_dependency "dotenv"
+  spec.add_dependency "hub_link"
+  spec.add_dependency "sqlite3"
+end

data/lib/hub_store/cli.rb

@@ -0,0 +1,43 @@
+module HubStore
+  class Cli
+    def self.run(*args)
+      new(*args).run
+    end
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      import_data
+      export_csv
+    end
+
+    private
+
+      attr_reader :argv
+
+      def start_date
+        PullRequest.order(updated_at: :desc).limit(1).pluck(:updated_at).first
+      end
+
+      def import_data
+        Importer.new(repos: repo_names, start_date: start_date).run
+      end
+
+      def export_csv
+        [PullRequest, Review].each do |resource|
+          Exporter.new(resource: resource).run
+        end
+      end
+
+      def repo_names
+        argv[0].presence || stop
+      end
+
+      def stop
+        puts "\nUsage: OCTOKIT_ACCESS_TOKEN=<token> #{$0} <github_org/repo_name>"
+        exit
+      end
+  end
+end

data/lib/hub_store/exporter.rb

@@ -0,0 +1,40 @@
+require "csv"
+require "hub_store/insert"
+require "hub_store/pull_request"
+require "hub_store/review"
+
+module HubStore
+  class Exporter
+    def initialize(resource:)
+      @resource = resource
+    end
+
+    def run
+      export_csv
+    end
+
+    private
+
+      attr_reader :resource
+
+      def export_csv
+        CSV.open(csv_file_name, "w", write_headers: true, headers: columns) do |csv|
+          resource.find_each do |record|
+            csv << record.attributes.values
+          end
+        end
+      end
+
+    private
+
+      attr_accessor :records, :columns
+
+      def csv_file_name
+        resource.to_s.demodulize.pluralize.underscore + ".csv"
+      end
+
+      def columns
+        @_columns ||= resource.columns.map(&:name)
+      end
+  end
+end

data/lib/hub_store/importer.rb

@@ -0,0 +1,44 @@
+require "hub_link"
+require "hub_store/insert"
+require "hub_store/pull_request"
+require "hub_store/review"
+
+module HubStore
+  class Importer
+    def initialize(repos:, start_date: nil)
+      @repos = repos
+      @start_date = start_date || 2.years.ago
+    end
+
+    def run
+      stream.in_batches do |batch|
+        import_prs(batch.pull_requests)
+        import_reviews(batch.reviews)
+      end
+    end
+
+    private
+
+      attr_reader :repos, :start_date
+
+      def import_prs(rows)
+        rows.each do |row|
+          Insert.new(row: row, target: PullRequest).run
+        end
+
+        puts "Imported #{PullRequest.count} PRs so far"
+      end
+
+      def import_reviews(rows)
+        rows.each do |row|
+          Insert.new(row: row, target: Review).run
+        end
+
+        puts "Imported #{Review.count} reviews so far"
+      end
+
+      def stream
+        @_stream ||= HubLink::Stream.new(repos, start_date: start_date)
+      end
+  end
+end

data/lib/hub_store/insert.rb

@@ -0,0 +1,38 @@
+module HubStore
+  class Insert
+    def initialize(row:, target:)
+      @row = row
+      @target = target
+    end
+
+    def run
+      record.update! importable_attributes
+    rescue ActiveRecord::RecordNotUnique
+      Rails.logger.warn "Skipping duplicate record ##{row[:id]}"
+    end
+
+    private
+
+      def record
+        target.find_or_initialize_by(id: id)
+      end
+
+      def id
+        row[:id]
+      end
+
+      def importable_attributes
+        normalized_attributes.slice(*target_columns)
+      end
+
+      def normalized_attributes
+        row.transform_keys { |key| key.to_s.chomp("?") }
+      end
+
+      def target_columns
+        target.columns.map(&:name)
+      end
+
+      attr_reader :row, :target
+  end
+end

data/lib/hub_store/pull_request.rb

@@ -0,0 +1,6 @@
+require "active_record"
+
+module HubStore
+  class PullRequest < ActiveRecord::Base
+  end
+end

data/lib/hub_store/review.rb

@@ -0,0 +1,6 @@
+require "active_record"
+
+module HubStore
+  class Review < ActiveRecord::Base
+  end
+end

data/lib/hub_store/version.rb

@@ -0,0 +1,3 @@
+module HubStore
+  VERSION = "0.2.0"
+end

data/lib/hub_store.rb

@@ -0,0 +1,38 @@
+require "dotenv/load"
+require "hub_store/version"
+require "hub_store/importer"
+require "hub_store/exporter"
+
+module HubStore
+  class Error < StandardError; end
+
+	# Set up a database that resides in RAM
+	ActiveRecord::Base.establish_connection(
+		adapter: "sqlite3",
+		database: "db/hub_store"
+	)
+
+	# Set up database tables and columns
+	ActiveRecord::Schema.define do
+    unless ActiveRecord::Base.connection.table_exists?("pull_requests")
+      create_table "pull_requests", force: :cascade do |t|
+        t.string "submitter"
+        t.string "labels"
+        t.datetime "closed_at"
+        t.datetime "created_at", null: false
+        t.datetime "updated_at", null: false
+      end
+    end
+
+    unless ActiveRecord::Base.connection.table_exists?("reviews")
+      create_table "reviews", force: :cascade do |t|
+        t.bigint "pull_request_id"
+        t.datetime "submitted_at"
+        t.string "reviewer"
+        t.boolean "approval"
+        t.datetime "created_at", null: false
+        t.datetime "updated_at", null: false
+      end
+    end
+	end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: hub_store
+version: !ruby/object:Gem::Version
+  version: 0.2.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: bundler
+  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'
+- !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: activerecord
+  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: hub_link
+  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: sqlite3
+  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'
+description: 
+email:
+- jens@balvig.com
+executables:
+- hub_store
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/hub_store
+- hub_store.gemspec
+- lib/hub_store.rb
+- lib/hub_store/cli.rb
+- lib/hub_store/exporter.rb
+- lib/hub_store/importer.rb
+- lib/hub_store/insert.rb
+- lib/hub_store/pull_request.rb
+- lib/hub_store/review.rb
+- lib/hub_store/version.rb
+homepage: https://balvig.com
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Downloads PR/Review info CSV files
+test_files: []