gitsheet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f8d5e460c2b28208e31e32355ead94f9403a30d
+  data.tar.gz: 826011497a63d519d40f38da56a0871c1fdbddc8
+SHA512:
+  metadata.gz: 3066c0369ecdc76667cc2c31efe5788d0439c631deb5159a0215b1e182c85b15441bb7af7c1712c6b494f6646515029d2cb593f12d9700b2bccac8833270c835
+  data.tar.gz: 0a1999ca57f59fc9b38549f2700db8086196899382f97f138724d16f212a2cfff639d40dcf023edf68af0b085ac253c2137baf1222762c5c9f8efc58f25d4593

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hbbb
+
+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,109 @@
+# Gitsheet
+
+Gitsheet is a command line utility designed to fetch/parse/format GitHub API data. 
+Primary use cases include analytics and report-generating. 
+
+Gitsheet requests are authenticated using your Github credentials. As such, the results of all queries are limited to the permissions 
+of your Github account.
+
+## Installation
+
+Clone the repository:
+
+```bash
+$ git clone ssh@github.com/vervewireless/gitsheet.git
+$ cd gitsheet/
+```
+
+Mac OSX Users should have a system version of Ruby installed:
+
+```bash
+$ ruby -v
+```
+
+Install Bundler:
+
+```bash
+$ gem install bundler
+```
+
+Install Gitsheet dependencies:
+
+```bash
+$ bundle install
+```
+
+## Configuration
+
+Place `bin/gitsheet` in your `$PATH` to be able to run the command globally:
+
+```bash
+$ cp gitsheet/bin/gitsheet usr/bin
+```
+
+It is helpful to create aliases in your `.bashrc` file for common operations:
+
+```bash
+# .bashrc
+alias report_git_repos='gitsheet repos -u maiyln -o vervewireless'
+alias report_git_users='gitsheet users -u maiyln -o vervewireless'
+```
+
+## Usage
+
+Synopsis:
+
+```bash
+$ gitsheet [type] -u [username] -p [password] -o [organization] -f [format]
+```
+Arguments:
+
+`type`  is the data type to fetch. Can be either 'repos' or 'users'.
+
+`-o` the GitHub organization to search within eg: 'vervewireless'
+
+## Output
+
+By default, gitsheet outputs raw csv data to stdout. This is useful because you can pass the output to various shell commands.
+
+Write to a file:
+
+```bash
+$ gitsheet ... > report.csv
+```
+
+Keyword search through results:
+
+```bash
+$ gitsheet ... | grep [keyword]
+```
+
+
+## Examples
+
+Get all repositories in an organization:
+
+```bash
+$ gitsheet repos -u testuser -p secret -o vervewireless
+```
+
+Get all members of an organization:
+
+```bash
+$ gitsheet users -u testuser -p secret -o vervewireless
+```
+
+Get all repositories and write output to a .csv file:
+
+```bash
+$ gitsheet repos -u testuser -p secret -o vervewireless -f csv > report.csv
+```
+
+## TODO
+
+Here are the next steps for Gitsheet
+  - Add unit tests
+  - Leverage Ruby gem to handle command line argument parsing, control flow etc.
+  - Better error handling
+  - More informative error messages
+  - A much better name!

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'io/console'
+require 'gitsheet'
+require 'formatter'
+
+# Print help text
+if ARGV[0] == '--help' or ARGV[0] == '-h'
+  help_text = %q(usage: gitsheet <command> [<args>]
+
+  Some gitsheet commands are:
+    repos    fetch all Github repositories within an organization
+    users    fetch all Github users belonging to an organization
+
+  Examples
+    gitsheet repos -u hbbb -o vervewireless -f csv
+    gitsheet users -u hbbb -o vervewireless -f csv
+  )
+
+  $stdout.puts help_text
+  Process.exit!(true)
+end
+
+# Prompt for password
+$stderr.print 'Password: '
+$stderr.flush
+password = $stdin.noecho(&:gets).chomp
+$stderr.puts ''
+
+# Parse arguments
+report_type = ARGV.shift
+arguments = Hash[*ARGV]
+
+# Validate input
+if !arguments['-u'] || !password || !arguments['-o'] || !arguments['-f']
+  puts 'Must provide username, password, organization and format'
+  Process.exit!(false)
+end
+
+
+# Initialize GitHub connection
+client = Gitsheet.new(arguments['-u'], password, arguments['-o'])
+
+# Request Github
+begin
+  github_results = client.send(report_type)
+rescue => e
+  $stderr.puts "GitHub communication error: #{e.message}"
+  Process.exit!(false)
+end
+
+# Format Results
+begin
+  formatted_results = Formatter.format(github_results, arguments['-f'])
+rescue => e
+  $stderr.puts "A formatting error occured: #{e.message}"
+  Process.exit!(false)
+end
+
+$stdout.puts formatted_results
+Process.exit!(true)

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/gitsheet.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitsheet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitsheet"
+  spec.version       = Gitsheet::VERSION
+  spec.authors       = ["Hbbb"]
+  spec.email         = ["h.borges10592@gmail.com"]
+ 
+  spec.summary       = %q{Github API command line tool.}
+  spec.description   = %q{Gitsheet is a small command line utility to quickly gather user and repository data from Github's API.}
+  spec.homepage      = "https://github.com/Hbbb/gitx"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["gitsheet"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/formatter.rb

@@ -0,0 +1,31 @@
+require 'csv'
+require 'pp'
+require 'json'
+
+
+module Formatter
+  def self.format(data, type = 'csv')
+    if !['csv', 'json', 'pretty_print'].include?(type)
+      raise 'Formatter: invalid format'
+    end
+
+    self.send(type.to_sym, data)
+  end
+
+  private
+
+  def self.csv(data)
+    CSV.generate do |csv|
+      csv << data.first.to_h.keys
+
+      data.each do |d|
+        csv << d.to_h.values
+      end
+    end
+  end
+
+  def self.json(data)
+    JSON.generate(data)
+  end
+
+end

data/lib/gitsheet.rb

@@ -0,0 +1,82 @@
+require 'rest-client'
+require 'gitsheet/version'
+require 'gitsheet/pagelinks'
+
+class Gitsheet
+  def initialize(username, password, organization)
+    @auth = "#{username}:#{password}"
+    @org = organization
+  end
+
+  def repos
+    repos = self.fetch_repos
+    self.add_commits repos
+  end
+
+  def users
+    users = self.fetch_users({per_page: 100})
+  end
+
+  def count_repos
+    self.fetch_repos.size
+  end
+
+  def count_users
+    self.fetch_users({per_page: 100}).size
+  end
+
+  def add_commits(repos)
+    repos.each do |r|
+      $stderr.print "#{r['name']}"
+
+      sleep(1)
+      $stderr.print '...'
+
+      r['latest_commit'] = self.latest_commit(r['name'])
+
+      $stderr.puts '✔︎'
+    end
+  end
+
+  def latest_commit(repo)
+    commits = self.fetch_commits(repo)
+    commits.first['commit']['author']['date']
+  end
+
+  def fetch_repos(options = {})
+    url = "https://#{@auth}@api.github.com/orgs/#{@org}/repos"
+    repos = []
+
+    # Initial request
+    response = self.fetch(url, {per_page: 100})
+    page_header = response.headers[:link]
+    repos.concat JSON.parse(response)
+
+    # Parse page headers
+    pages = PageLinks.new page_header
+    return repos if pages.none?
+
+    # Fetch additional pages
+    2.upto(pages.last) do |page|
+      sleep(1)
+      repos.concat JSON.parse(self.fetch(url, {per_page: 100, page: page}))
+    end
+
+    repos
+  end
+
+  def fetch_users(options = {})
+    url = "https://#{@auth}@api.github.com/orgs/#{@org}/members"
+    JSON.parse self.fetch(url, options)
+  end
+
+  def fetch_commits(repo, options = {})
+    url = "https://#{@auth}@api.github.com/repos/#{@org}/#{repo}/commits"
+    options.merge!(per_page: 1)
+    JSON.parse self.fetch(url, options)
+  end
+
+  def fetch(url, params = {})
+    RestClient.get url, {:params => params}
+  end
+end

data/lib/gitsheet/pagelinks.rb

@@ -0,0 +1,50 @@
+
+class PageLinks
+
+  SPLIT_LINKS = ','
+  SPLIT_LINK = ';'
+
+  def initialize(link)
+    @links = {}
+
+    link.split(PageLinks::SPLIT_LINKS).each do |link|
+      section = link.split PageLinks::SPLIT_LINK
+
+      raise 'Page Links could not be split on ;' if section.length < 2
+
+      page_number = section[0].slice(section[0].length - 2, 1)
+      page_relation = section[1].gsub(/rel="(.*)"/, '\1').lstrip
+
+      @links[page_relation] = page_number
+    end
+  end
+
+  def next
+    @links['next'].to_i
+  end
+
+  def prev
+    @links['prev'].to_i
+  end
+
+  def first
+    @links['first'].to_i
+  end
+
+  def last
+    @links['last'].to_i
+  end
+
+  def next?
+    !!@links['next']
+  end
+
+  def prev?
+    !!@links['prev']
+  end
+
+  def none?
+    @links.empty?
+  end
+
+end

data/lib/gitsheet/version.rb

@@ -0,0 +1,3 @@
+class Gitsheet
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: gitsheet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hbbb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: rspec
+  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: rspec-mocks
+  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: webmock
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: pry-byebug
+  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: Gitsheet is a small command line utility to quickly gather user and repository
+  data from Github's API.
+email:
+- h.borges10592@gmail.com
+executables:
+- gitsheet
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gitsheet
+- bin/setup
+- gitsheet.gemspec
+- lib/formatter.rb
+- lib/gitsheet.rb
+- lib/gitsheet/pagelinks.rb
+- lib/gitsheet/version.rb
+homepage: https://github.com/Hbbb/gitx
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Github API command line tool.
+test_files: []
+has_rdoc: