org_lang_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a4cf6bd27b43b55926c9329267482e7ba1d2632
+  data.tar.gz: 52f1d991751eac4c4201d2fed5424d768d94bceb
+SHA512:
+  metadata.gz: f2efcd994f0717c49d2ab027be27851bb7f2422ecba0da97393389dfd3612881470d35af077f6bd10055d7588452e4b4d28fff1932b2c9d6e013a02c8203a5bd
+  data.tar.gz: e4a5fe7e20f732c026d04f5eb4bc7953f4317ea65d479109d06f073c31b50df99f16f97755fdcc1e4010067cb12fed68023acf563050f7c3823a400299a38f36

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0.pre.3

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 dimitrisiliascs@gmail.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in org_lang_stats.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Dimitris Ilias
+
+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,55 @@
+
+Org Lang Stats
+======  
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/b820cd0c3fe8775cd50d/maintainability)](https://codeclimate.com/github/Dimitris-Ilias/org_lang_stats/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b820cd0c3fe8775cd50d/test_coverage)](https://codeclimate.com/github/Dimitris-Ilias/org_lang_stats/test_coverage)
+
+
+## Overview
+Did you know Google's own public repos consist of 59% C code? Org Lang Stats is a cli tool that will let you find out the languages an organization uses in their repositories and their volume in bytes or percent values.
+
+## Dependancies
+To run org_lang_stats you will need:
+- Ruby 2.1 +
+
+## Installation
+
+        gem install org_lang_stats
+
+## Usage
+Basic usage:
+
+        org_lang_stats --org workable > workable.json
+ 
+Options:
+
+        --help               Show this message
+        --org string         Organization name as appeared on github (required)
+        --token string       Github Personal Access Token. (found at https://github.com/settings/developers)
+        --threads [1..100]   Adjusts the concurrency (default: 10)
+        --debug              If enabled, adds debug messages to the output (will not produce valid json)
+        --percent            If enabled, converts absolute values (bytes) to percent values
+
+Example with all options used:
+
+        org_lang_stats --org workable --threads 10 --token yourtokenhere --debug --percent
+
+## Authentication
+- No authentication required! However Github limits requests for non authenticated requests to only 60 per hour.
+Refresh your IP to reset the rate limit or input a --token.
+
+
+## Tests
+
+To run the tests:
+
+        bundle install
+        rake test
+
+A test coverage report will be generated by simplecov when the tests are run on folder **coverage**
+
+## TODO
+Add graphic representation using https://github.com/ankane/chartkick
+Use a framework like https://github.com/vcr/vcr to generate fixtures
+Use github's new GraphQL API

data/bin/console

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

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'org_lang_stats/my_opt_parser'
+require 'org_lang_stats/logging'
+require 'org_lang_stats'
+include Logging
+
+
+options = MyOptParser.new.options
+logger.enable if options[:debug]
+api = GithubApi.new(options[:token])
+output = OrgLangStats.proccess(api, options[:org], options[:threads], options[:percent])
+puts JSON.pretty_generate(output)

data/lib/org_lang_stats/github_api.rb

@@ -0,0 +1,82 @@
+require 'org_lang_stats/logging'
+require 'rest-client'
+require 'base64'
+require 'json'
+
+# This class is a basic GitHub API client library.
+# The only function that is exposed publically, get_all_pages, will auto-paginate
+# when needed and if not needeed will just return the hash payload.
+# Most failures that could happen while calling an api are also handled here.
+class GithubApi
+    include Logging
+
+    def initialize(token = nil)
+        @token = token
+        @params = { per_page: 100 }
+        @default_sleep = 10
+        @max_retries = 6
+    end
+
+    def auth_string
+        "Basic #{Base64.strict_encode64(':' + @token)}" if @token
+    end
+
+    def get_all_pages(url:, params: {}, all_pages: [])
+
+        response = get_page(url, params)
+        logger.debug "Url:#{url} returned succesfully!"
+
+        resp_body = JSON.parse(response)
+
+        return resp_body if resp_body.is_a?(Hash)
+        all_pages += resp_body
+
+        begin
+            next_url = get_next_url(response)
+            return get_all_pages(url: next_url, params: params, all_pages: all_pages)
+        rescue NoMethodError
+            # Ends the recursion
+            return all_pages
+        end
+    end
+
+    def get_page(url, params = {})
+        begin
+            tries ||= @max_retries
+            RestClient.get(url, params: @params.merge(params), Authorization: auth_string)
+        # Soft error codes
+        rescue RestClient::Forbidden, RestClient::Exceptions::OpenTimeout, Errno::ECONNRESET, SocketError => ex
+
+            rate_lim_reached(ex) if ex.class.name == 'RestClient::Forbidden'
+            sleep_with_msg(ex)
+            retry unless (tries -= 1).zero?
+            abort_max_retries
+        # Hard error codes
+        rescue RestClient::NotFound
+            abort "Url #{url} not found!"
+        end
+    end
+
+    def get_next_url(response)
+        response.headers[:link].split(',')
+                               .select { |link| link.include? 'rel="next"' }.first
+                               .split(';').first[/<(.+)>/, 1]
+    end
+
+    def sleep_with_msg(ex)
+        logger.debug "An error of type #{ex.class} happened, message is #{ex.message}"
+        logger.debug "Request will be retried in #{@default_sleep} seconds\n"
+        sleep @default_sleep
+    end
+
+    def rate_lim_reached(ex)
+        reset_in = ex.response.headers[:x_ratelimit_reset].to_i - Time.now.to_i
+        logger.debug "Rate limit reached! Limits will be reset in #{reset_in / 60} minutes"
+        logger.debug "Sleeping until then...Refresh your IP and rerun if you don't want to wait!"
+        sleep reset_in
+    end
+
+    def abort_max_retries
+        abort 'Max retries limit reached! Run in --debug mode for more info'
+    end
+end

data/lib/org_lang_stats/logging.rb

@@ -0,0 +1,23 @@
+require 'logger'
+
+
+module Logging
+    def self.logger
+        @logger ||= begin
+            maybe_logger = Logger.new(STDOUT)
+            maybe_logger.formatter = proc do |severity, datetime, _, msg|
+               "#{severity} - #{datetime.strftime('%H:%M:%S')} - #{msg}\n"
+            end
+            maybe_logger.level = Logger::ERROR
+            maybe_logger
+        end
+    end
+
+    def logger
+        Logging.logger
+    end
+
+    def enable
+        Logging.logger.level = Logger::DEBUG
+    end
+end

data/lib/org_lang_stats/my_opt_parser.rb

@@ -0,0 +1,32 @@
+require 'optparse'
+
+
+class MyOptParser
+    attr_reader :options
+
+    def initialize
+        @options = { org: nil, debug: false, threads: 10, token: nil, percent: false }
+        parse_options
+        validate_options
+    end
+
+    def parse_options
+
+        opt_parser = OptionParser.new do |opts|
+            opts.banner = "\nExample usage: org_lang_stats --org workable --threads 10 --token yourtokenhere --debug --percent\n\nOptions:"
+
+            opts.on('--org string', String, 'Organization name as appeared on github (required)') { |org| @options[:org] = org }
+            opts.on('--token string', String, 'Github Personal Access Token') { |token| @options[:token] = token }
+            opts.on('--threads [1..100]', Integer, 'Adjusts the concurrency (default: 10)') { |threads| @options[:threads] = threads }
+            opts.on('--debug', 'If enabled, adds debug messages to the output (will not produce valid json)') { @options[:debug] = true }
+            opts.on('--percent', 'If enabled, converts absolute values (bytes) to percent values') { @options[:percent] = true }
+        end
+
+        opt_parser.parse!
+    end
+
+    def validate_options
+        abort '--org option missing' if @options[:org].nil?
+        abort '--threads should be between 1 and 100' unless (1..100).cover?(@options[:threads])
+    end
+end

data/lib/org_lang_stats/thread_pool.rb

@@ -0,0 +1,22 @@
+require 'thread'
+
+
+class ThreadPool
+    def initialize(threads)
+        @pool = Queue.new
+        threads.times { @pool << 1 }
+        @workers = []
+    end
+
+    def run(&block)
+        @pool.pop
+        @workers << Thread.new do
+            block[]
+            @pool << 1
+        end
+    end
+
+    def join_workers
+        @workers.map(&:join)
+    end
+end

data/lib/org_lang_stats/version.rb

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

data/lib/org_lang_stats.rb

@@ -0,0 +1,73 @@
+require 'org_lang_stats/github_api'
+require 'org_lang_stats/thread_pool'
+
+# This class contains the business logic of the project.
+# It utilizes components such as the Logger, the Threadpool
+# and the api wrapper to put everything together
+class OrgLangStats
+    def self.proccess(api, org, threads, percent)
+        OrgLangStats.new(api, org).proccess(percent, threads)
+    end
+
+    def initialize(api, org)
+        @aggr = nil
+        @repos = nil
+        @api = api
+        @org = org
+    end
+
+    def proccess(percent, threads)
+        @repos = parallel_get_lang_stats(threads)
+        @aggr = calc_aggregate_stats
+        bytes_to_percent if percent
+        { @org => { 'aggregate_stats' => @aggr, 'repositories' => @repos } }
+    end
+
+    def parallel_get_lang_stats(threads)
+        result = {}
+        pool = ThreadPool.new threads
+
+        non_forked_repos.map do |repo|
+            pool.run do
+                repo_stats = @api.get_all_pages(url: repo['languages_url'])
+                result.merge! Hash[repo['name'], repo_stats]
+            end
+        end
+
+        pool.join_workers
+        result
+    end
+
+    def non_forked_repos
+        @api.get_all_pages(url: repos_url, params: { type: 'source' })
+    end
+
+    def repos_url
+        "https://api.github.com/orgs/#{@org}/repos"
+    end
+
+    def calc_aggregate_stats
+        @repos.values.each_with_object(Hash.new(0)) do |repo, hash|
+            repo.each { |lang, bytes| hash[lang] += bytes }
+        end
+    end
+
+    def bytes_to_percent
+        @repos = @repos.map do |r_name, stats|
+            Hash[r_name, hash_values_to_percent(stats)]
+        end.inject(:merge)
+
+        @aggr = hash_values_to_percent @aggr
+    end
+
+    def hash_values_to_percent(hash)
+        total = hash.values.inject(:+)
+        hash.map do |key, value|
+            Hash[key, num_to_percent(value, total)]
+        end.inject(:merge)
+    end
+
+    def num_to_percent(num, num_total)
+        (100.0 * num / num_total).round(1).to_s + '%'
+    end
+end

data/org_lang_stats.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "org_lang_stats/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "org_lang_stats"
+  spec.version       = OrgLangStats::VERSION
+  spec.authors       = ["Dimitris Ilias"]
+  spec.email         = ["dimitrisiliascs@gmail.com"]
+
+  spec.summary       = %q{Retrieves language stats from GitHub, for public repositories of an organization}
+  spec.homepage      = "https://github.com/Dimitris-Ilias/org_lang_stats"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  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 do |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.required_ruby_version = '>= 2.1'
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "webmock", "~> 3.3"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1"
+end

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: org_lang_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dimitris Ilias
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: 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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- dimitrisiliascs@gmail.com
+executables:
+- org_lang_stats
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- exe/org_lang_stats
+- lib/org_lang_stats.rb
+- lib/org_lang_stats/github_api.rb
+- lib/org_lang_stats/logging.rb
+- lib/org_lang_stats/my_opt_parser.rb
+- lib/org_lang_stats/thread_pool.rb
+- lib/org_lang_stats/version.rb
+- org_lang_stats.gemspec
+- rakefile
+homepage: https://github.com/Dimitris-Ilias/org_lang_stats
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Retrieves language stats from GitHub, for public repositories of an organization
+test_files: []