gitget 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13ff7969ced6822f8fe9f7fc3ffc7eb7d3d2014e
+  data.tar.gz: d7cc0b2246a1abdfd0a386508837acb1f972d31c
+SHA512:
+  metadata.gz: 1057cbc488822fc8a68a4caa0902bb35534f3bb0a87e15cbaa6a117a7432e2294c5251ad358b55614a62a5a433cdb3766fde7db0c33ab04c9ecf25a24068d6ab
+  data.tar.gz: a1f4232617ef9d5a8f808709cd28850619fc54520020656ea155f3350454687466a0acf8ffcfea35844f9fef57b0e6f341d13efdd6c349250cf3ffd5dd219bb0

data/.gitignore

@@ -0,0 +1,7 @@
+config/*.yml
+spec/fixtures/*.yml
+spec/fixtures/*/*.yml
+results.yml
+github_response.yml
+coverage/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+branches:
+  only:
+    - master
+script: bundle exec rake spec
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    gitget (0.1.0)
+      http (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    ast (2.3.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    domain_name (0.5.20161021)
+      unf (>= 0.0.5, < 1.0.0)
+    erubis (2.7.0)
+    flay (2.8.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.4.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.4)
+    hashdiff (0.3.0)
+    http (2.0.3)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
+    json (2.0.2)
+    minitest (5.9.1)
+    minitest-rg (5.2.0)
+      minitest (~> 5.0)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    path_expander (1.0.0)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.3.0)
+    rubocop (0.43.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    ruby_parser (3.8.3)
+      sexp_processor (~> 4.1)
+    safe_yaml (1.0.4)
+    sexp_processor (4.7.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    unicode-display_width (1.1.1)
+    vcr (3.0.3)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flay (~> 2.8)
+  flog (~> 4.4)
+  gitget!
+  minitest (~> 5.9)
+  minitest-rg (~> 5.2)
+  rake (~> 11.3)
+  rubocop (~> 0.42)
+  simplecov (~> 0.12)
+  vcr (~> 3.0)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   1.13.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Rubeasts <https://github.com/Rubeasts>
+
+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,28 @@
+# gitget gem
+
+Gitget is a gem that specializes in getting developers and there repository data on Github.
+
+## Installation
+
+If you are working on a project, add this to your Gemfile: `gem 'gitget'`
+
+For ad hoc installation from command line:
+
+```$ gem install gitget```
+
+## Setup Github Credentials
+
+Please setup your your github personal API token https://github.com/settings/tokens
+
+## Usage
+
+Require Gitget gem in your code: `require 'gitget'`
+
+Supply your Github credentials to our library in one of two ways:
+- Setup environment variables: `ENV['GH_USERNAME']` and `ENV['GH_TOKEN']`
+- or, provide them directly to Gitget:
+
+```ruby
+Github::API.config = { username: ENV['GH_USERNAME'],
+                       token: ENV['GH_TOKEN'] }
+```

data/Rakefile

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'rake/testtask'
+
+task default: :spec
+
+namespace :credentials do
+  require 'yaml'
+
+  desc 'Export sample credentials from file to bash'
+  task :export do
+    credentials = YAML.load(File.read('config/github_credential.yml'))
+    puts 'Please run the following in bash:'
+    puts "export GH_USERNAME=#{credentials[:username]}"
+    puts "export GH_TOKEN=#{credentials[:token]}"
+  end
+end
+
+desc 'run tests'
+task :spec do
+  sh 'ruby spec/github_spec.rb'
+end
+
+desc 'delete cassette fixtures'
+task :wipe do
+  sh 'rm spec/fixtures/cassettes/*.yml' do |ok, _|
+    puts(ok ? 'Cassettes deleted' : 'No casseettes found')
+  end
+end
+
+namespace :quality do
+  desc 'run all quality checks'
+  task all: [:rubocop, :flog, :flay]
+
+  task :flog do
+    sh 'flog lib/'
+  end
+
+  task :flay do
+    sh 'flay lib/'
+  end
+
+  task :rubocop do
+    sh 'rubocop'
+  end
+end

data/bin/gitget

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w(.. lib))
+require 'gitget'
+
+developer_name = ARGV[0] || ENV['USERNAME']
+unless developer_name
+  puts 'USAGE: gitget [developer_username]'
+  exit(1)
+end
+
+developer = Github::Developer.find(username: developer_name)
+
+puts developer.name
+developer.repos.first(3).each.with_index do |repo, index|
+  print "#{index + 1}: "
+  puts 'Repo name: ' + repo.name.to_s
+  puts 'Repo ID: ' + repo.id.to_s
+  puts 'Number of watchers: ' + repo.watchers_count.to_s
+  puts 'Number of Issues: ' + repo.open_issues_count.to_s
+end

data/config/github_credential.yml.exemple

@@ -0,0 +1,6 @@
+# https://github.com/settings/tokens
+# you can find authg in fixtures/cassettes/github_api.yml
+---
+:username: 'XXX'
+:token: 'XXX'
+:auth: 'Basic xxxxxxxxx'

data/gitget.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'gitget/version'
+
+Gem::Specification.new do |s|
+  s.name        =  'gitget'
+  s.version     =  Github::VERSION
+
+  s.summary     =  'Gets public information about Github developers'
+  s.description =  'Extracts developer statistics'
+  s.authors     =  ['Renaud Jollet',
+                    'Nicholas Danks',
+                    'Sami Larrousi Tribek']
+  s.email       =  ['renaudjollet@neurow.org',
+                    'nicholasdanks@hotmail.com',
+                    'sami@slt.fr']
+
+  s.files       =  `git ls-files`.split("\n")
+  s.test_files  =  `git ls-files -- spec/*`.split("\n")
+  s.executables << 'gitget'
+
+  s.add_runtime_dependency 'http', '~> 2.0'
+
+  s.add_development_dependency 'minitest', '~> 5.9'
+  s.add_development_dependency 'minitest-rg', '~> 5.2'
+  s.add_development_dependency 'rake', '~> 11.3'
+  s.add_development_dependency 'vcr', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 2.1'
+  s.add_development_dependency 'simplecov', '~> 0.12'
+  s.add_development_dependency 'flog', '~> 4.4'
+  s.add_development_dependency 'flay', '~> 2.8'
+  s.add_development_dependency 'rubocop', '~> 0.42'
+  s.homepage    =  'https://github.com/Rubeasts/gitget'
+  s.license     =  'MIT'
+end

data/lib/gitget.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+files = Dir.glob(File.join(File.dirname(__FILE__), 'gitget/*.rb'))
+files.each { |lib| require_relative lib }

data/lib/gitget/github_api.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'http'
+require 'json'
+
+module  Github
+  # Service for all Github API call
+  class API
+    GITHUB_API_URL = 'https://api.github.com'
+
+    def self.config=(credentials)
+      @config&.update(credentials) || (@config = credentials)
+    end
+
+    def self.config
+      return @config if @config
+
+      @config = { username: ENV['GH_USERNAME'],
+                  token:    ENV['GH_TOKEN'] }
+    end
+
+    def self.user_info(username)
+      route = '/users/' + username
+      github_api_get(route)
+    end
+
+    def self.user_followers(username)
+      route = '/users/' + username + '/followers'
+      github_api_get(route)
+    end
+
+    def self.user_following(username)
+      route = '/users/' + username + '/following'
+      github_api_get(route)
+    end
+
+    def self.user_repos(username)
+      route = '/users/' + username + '/repos'
+      github_api_get(route)
+    end
+
+    def self.repo_stat(full_name, stat)
+      route = '/repos/' + full_name + '/stats/' + stat
+      github_api_get(route)
+    end
+
+    private_class_method
+
+    def self.github_api_get_http(url)
+      HTTP.basic_auth(user: config[:username], pass: config[:token]).get(url)
+    end
+
+    def self.github_api_wait_cache(url)
+      response = github_api_get_http(url)
+      while response.headers['Status'].split(' ').first == '202'
+        sleep(2)
+        response = github_api_get_http(url)
+      end
+      response
+    end
+
+    def self.github_api_get(route)
+      url = GITHUB_API_URL + route
+      response = github_api_wait_cache(url)
+      JSON.parse(response.to_s)
+    end
+  end
+end

data/lib/gitget/github_developer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module  Github
+  # Main class to set up a Github User
+  class Developer
+    attr_reader :name, :id, :public_repos, :followers, :following
+
+    def initialize(data:)
+      @name = data['login']
+      @id = data['id']
+      @public_repos = data['public_repos']
+    end
+
+    def repos
+      return @repos if @repos
+
+      @repos = Github::API.user_repos(@name).map do |repo_data|
+        Github::Repository.new(data: repo_data)
+      end
+    end
+
+    def followers
+      return @followers if @followers
+
+      @followers = Github::API.user_followers @name
+    end
+
+    def following
+      return @following if @following
+
+      @following = Github::API.user_following @name
+    end
+
+    def self.find(username:)
+      user_data = Github::API.user_info(username)
+      new(data: user_data)
+    end
+  end
+end

data/lib/gitget/github_repository.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module  Github
+  # Main class to set up a Github User
+  class Repository
+    attr_reader :id, :name, :full_name, :is_private, :is_fork, :created_at,
+                :updated_at, :pushed_at, :size, :stargazers_count,
+                :watchers_count, :has_issues, :has_downloads, :forks_count,
+                :open_issues_count, :forks, :open_issues, :watchers
+
+    def initialize(data: nil)
+      load_data(data)
+    end
+
+    def stats
+      return @stats if @stats
+
+      @stats = {}
+      %w(
+        contributors commit_activity code_frequency participation punch_card
+      ).each do |stat|
+        @stats[stat] = Github::API.repo_stat(@full_name, stat)
+      end
+    end
+
+    def load_data(repo_data)
+      @full_name = repo_data['full_name']
+      @is_private = repo_data['is_private']
+      @is_fork = repo_data['is_fork']
+      @created_at = repo_data['created_at']
+      @pushed_at = repo_data['pushed_at']
+      @size = repo_data['size']
+      @stargazers_count = repo_data['stargazers_count']
+      @watchers_count = repo_data['watchers_count']
+      @forks_count = repo_data['forks_count']
+      @open_issues_count = repo_data['open_issues_count']
+    end
+  end
+end

data/lib/gitget/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Github
+  VERSION = '0.1.0'
+end

data/spec/fixtures/README.md

@@ -0,0 +1,3 @@
+# Fixtures is use for testing
+
+It contains http response and result 

data/spec/github_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+describe 'Github specifications' do
+  VCR.configure do |c|
+    c.cassette_library_dir = CASSETTES_FOLDER
+    c.hook_into :webmock
+
+    c.filter_sensitive_data('<AUTH>') { ENV['GH_AUTH'] }
+  end
+
+  before do
+    VCR.insert_cassette CASSETTE_FILE, record: :new_episodes
+    @developer = Github::Developer.find(username: USERNAME)
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  it 'should be able to open a new Github Developer' do
+    @developer.name.length.must_be :>, 0
+  end
+
+  it 'should get the user id' do
+    @developer.id.must_be :>, 0
+  end
+
+  it 'should get the number of public repos' do
+    @developer.public_repos.must_be :>, 0
+  end
+
+  it 'should get the followers' do
+    @developer.followers.length.must_be :>, 0
+  end
+
+  it 'should get the following' do
+    @developer.following.length.must_be :>=, 0
+  end
+
+  it 'should get the repos' do
+    @developer.repos.length.must_be :>, 0
+  end
+
+  it 'should get the repo should have a full name' do
+    @developer.repos.first.full_name.must_be_instance_of String
+  end
+
+  it 'should get the repo should have stats' do
+    @developer.repos.first.stats.wont_be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/rg'
+require 'yaml'
+require 'vcr'
+require 'webmock'
+
+require_relative '../lib/gitget'
+
+FIXTURES_FOLDER = 'spec/fixtures'
+CASSETTES_FOLDER = "#{FIXTURES_FOLDER}/cassettes"
+CASSETTE_FILE = 'github_api'
+
+USERNAME = 'rjollet'
+
+if File.file?('config/github_credential.yml')
+  credentials = YAML.load(File.read('config/github_credential.yml'))
+  ENV['GH_USERNAME'] = credentials[:username]
+  ENV['GH_TOKEN'] = credentials[:token]
+  ENV['GH_AUTH'] = credentials[:auth]
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: gitget
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renaud Jollet
+- Nicholas Danks
+- Sami Larrousi Tribek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+description: Extracts developer statistics
+email:
+- renaudjollet@neurow.org
+- nicholasdanks@hotmail.com
+- sami@slt.fr
+executables:
+- gitget
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/gitget
+- config/github_credential.yml.exemple
+- gitget.gemspec
+- lib/gitget.rb
+- lib/gitget/github_api.rb
+- lib/gitget/github_developer.rb
+- lib/gitget/github_repository.rb
+- lib/gitget/version.rb
+- spec/fixtures/README.md
+- spec/github_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Rubeasts/gitget
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Gets public information about Github developers
+test_files:
+- spec/fixtures/README.md
+- spec/github_spec.rb
+- spec/spec_helper.rb