github-info 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 124fffa9bc672725f7995619fb8580aeb1b80b7889c841d98ae4f18130c967dd
+  data.tar.gz: e78bd7ac08a59812a0213a03c5df361dc14f82a9dbd6578d6a581140ca4d6713
+SHA512:
+  metadata.gz: af3dff3b1e9d3d94a1298a04ed2359eb1881c0d83d52d24d848b14823b5a5119c16d5d7257ae10cd9956a37b64096c117208abdd619957339a9e892e4116757d
+  data.tar.gz: 0dac35484b556983d2996dd9d12cd3b668d3475834d442dfc2a5177b374c6f14ac476faf966382c64679ed264dbe0e7a0a670334adf571035f84ca3cf5b0ce05

data/.gitignore

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

data/Gemfile

@@ -0,0 +1 @@
+source "https://rubygems.org"

data/Gemfile.lock

@@ -0,0 +1,11 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 'Brandon Weaver'
+
+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::Info
+
+This gem provides commands which are used to retrieve and output information from a github profile.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github-info'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github-info
+
+## Usage
+
+This CLI gem provides the following commands:
+  help
+  git: [profile]
+    name
+    contributions
+    repos
+    history: [repository_index]
+
+A [profile] is the username of a github profile.
+      e.g. BrandonMWeaver
+
+A [repository_index] is identified by the number to the left-hand side of a repository as listed by the output of repos.
+      e.g. 1
+
+help -> Provides a list of available commands and their usage.
+git: [profile] -> Retrieves information from a github profile.
+  name -> Outputs the name of the user if one is provided.
+  contributions -> Outputs the contributions commited by the user within the last year.
+  repos -> Outputs an indexed list of the user's repositories.
+  history: [repository_index] -> Outputs a list of a repository's commit history
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/BrandonMWeaver/github-info.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github-info"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/github-info

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/github-info"
+
+GithubInfo::CLI.new.call

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/github-info.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github-info/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-info"
+  spec.version       = GithubInfo::VERSION
+  spec.authors       = ["'Brandon Weaver'"]
+  spec.email         = ["'a7xncob@gmail.com'"]
+  
+  spec.summary       = "This gem provides commands which are used to retrieve and output information from a github profile."
+  spec.homepage      = "https://github.com/BrandonMWeaver/github-info"
+  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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/github-info.rb

@@ -0,0 +1,4 @@
+require_relative "github-info/version"
+require_relative "github-info/cli"
+require_relative "github-info/github"
+require_relative "github-info/scraper"

data/lib/github-info/cli.rb

@@ -0,0 +1,60 @@
+class GithubInfo::CLI
+  def call
+    menu
+  end
+  
+  private
+  
+  def menu
+    commands = ["name", "contributions", "repos", "history"]
+    github_name = ""
+    
+    loop do
+      puts "command:"
+      input = gets.strip
+      
+      if input.split(':')[0].downcase == "git"
+        begin
+        github_name = input.split(':')[1].split(' ')[0]
+        @github = GithubInfo::Github.new(github_name)
+        puts "github acquired"
+        rescue OpenURI::HTTPError
+          puts "github not found"
+        rescue NoMethodError
+          puts "github not provided"
+        end
+      
+      elsif input.downcase == "help"
+        GithubInfo::Github.print_help
+      
+      elsif input.downcase == "name" && @github
+        @github.print_name
+      
+      elsif input.downcase == "contributions" && @github
+        @github.print_contributions
+      
+      elsif input.downcase == "repos" && @github
+        @github.print_repos
+      
+      elsif input.split(':')[0].downcase == "history" && @github
+        begin
+        index = input.split(':')[1].split(' ')[0].to_i - 1
+        @github.print_commit_history(index)
+        rescue OpenURI::HTTPError
+          puts "repository not found"
+        rescue NoMethodError
+          puts "repository not found"
+        end
+      
+      elsif input.downcase == "exit"
+        break
+        
+      elsif commands.include?(input.split(':')[0].downcase)
+        puts "command currently unavailable"
+      
+      else
+        puts "unknown command"
+      end
+    end
+  end
+end

data/lib/github-info/github.rb

@@ -0,0 +1,68 @@
+class GithubInfo::Github
+  def initialize(github_name)
+    scraper = GithubInfo::Scraper.new(github_name)
+    @name = scraper.github_info[:user_info][:name]
+    @contributions = scraper.github_info[:user_info][:contributions]
+    @repositories = scraper.github_info[:repositories]
+  end
+  
+  def self.print_help
+    puts "\tgit: [profile]"
+    puts "\t  Retrieves information from a github profile.\n\n"
+    puts "\tname"
+    puts "\t  Outputs the name of the user if one is provided.\n\n"
+    puts "\tcontributions"
+    puts "\t  Outputs the contributions commited by the user within the last year.\n\n"
+    puts "\trepos"
+    puts "\t  Outputs an indexed list of the user's repositories.\n\n"
+    puts "\thistory: [repository_index]"
+    puts "\t  Outputs a list of a repository's commit history.\n\n"
+  end
+  
+  def print_name
+    if @name != ""
+      puts @name
+    else
+      puts "name unavailable"
+    end
+  end
+  
+  def print_contributions
+    puts "#{@contributions} contributions in the last year"
+  end
+  
+  def print_repos
+    if @repositories.size != 0
+      i = 0
+      puts "repositories:"
+      @repositories.each { |repository|
+        print "\t"
+        print '0' if i < 9
+        puts "#{i += 1}. #{repository[:name]}"
+      }
+    else
+      puts "no repositories"
+    end
+  end
+  
+  def print_commit_history(index)
+    commit_history = GithubInfo::Scraper.get_commit_history(@repositories[index][:href])
+    
+    puts "commit history:"
+    commit_history.each { |commit|
+      print "\t"
+      print "#{format_date(commit[:date])}: "
+      puts commit[:description]
+    }
+  end
+  
+  private
+  
+  def format_date(date)
+    if date.split(' ')[1].split(',')[0].to_i < 10
+      date_pieces = date.split(' ')
+      date = "#{date_pieces[0]} 0#{date_pieces[1]} #{date_pieces[2]}"
+    end
+    return date
+  end
+end

data/lib/github-info/scraper.rb

@@ -0,0 +1,49 @@
+require "nokogiri"
+require "open-uri"
+
+class GithubInfo::Scraper
+  attr_reader :github_info
+  
+  def initialize(github_name)
+    @github_name = github_name
+    @github_info = {
+      user_info: get_user_info,
+      repositories: get_repositories
+    }
+  end
+  
+  def self.get_commit_history(relative_path)
+    commit_history = []
+    document = Nokogiri::HTML(open("https://github.com#{relative_path}/commits/master"))
+    document.css("div.table-list-cell").each { |commit|
+      if commit.css("p a.message.js-navigation-open").text != ""
+        commit_hash = {
+          description: commit.css("p a.message.js-navigation-open").text,
+          date: commit.css("relative-time.no-wrap").text
+        }
+        commit_history << commit_hash
+      end
+    }
+    return commit_history
+  end
+  
+  private
+  
+  def get_user_info
+    user_info = {}
+    document = Nokogiri::HTML(open("https://github.com/#{@github_name}"))
+    user_info[:name] = document.css("span.p-name.vcard-fullname.d-block.overflow-hidden").text
+    user_info[:contributions] = document.css("h2.f4.text-normal.mb-2")[1].text.split(' ')[0]
+    return user_info
+  end
+  
+  def get_repositories
+    document = Nokogiri::HTML(open("https://github.com/#{@github_name}?tab=repositories"))
+    repositories = document.css("div.d-inline-block.mb-1 h3 a")
+    repositories.each { |repository|
+      repository[:name] = repository.text.split(' ')[0]
+      repository[:href] = repository.attr("href")
+    }
+    return repositories
+  end
+end

data/lib/github-info/version.rb

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: github-info
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Brandon Weaver'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+description: 
+email:
+- "'a7xncob@gmail.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/github-info
+- bin/setup
+- github-info.gemspec
+- lib/github-info.rb
+- lib/github-info/cli.rb
+- lib/github-info/github.rb
+- lib/github-info/scraper.rb
+- lib/github-info/version.rb
+homepage: https://github.com/BrandonMWeaver/github-info
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: This gem provides commands which are used to retrieve and output information
+  from a github profile.
+test_files: []