fav_language 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d33b67c8a53086172cfd5b5056465e9123b193cb
+  data.tar.gz: b5ce800c0bab8898c7e92cce1a02d2550809455d
+SHA512:
+  metadata.gz: 23675df6b94cb6cd528ba6a803fa962ef6ecf536765d4240277a1f2383297f43480cb4c826c998018ea40a0a967599e796ca6171ef51d445795fde9ab24e51ea
+  data.tar.gz: 227855d528a9695effd6f80ea0a9d4bef58ac1b9452b44d800fa3f1bb8257ba4352a512427965a13677c6c5c5d8d9931477ae2566db3618e34b59e49380afba9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tadas Tamosauskas
+
+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,83 @@
+# FavLanguage
+
+This is a gem written as a part of a coding challenge. Given a GitHub username it tries to guess the user's favourite programming language.
+
+The criteria used is the amount of bytes written in each language in all public owned repos of the user (omits forked repos).
+
+## Installation
+
+NB: It is not pushed to rubygems yet
+
+This gem requires ruby >= 2.1
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fav_language'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fav_language
+
+## Using the binary
+
+The gem has a command line interface. If you have the gem installed:
+
+```
+fav_lang -h
+```
+
+Example:
+```
+fav_lang -u tadast
+> JavaScript: 418357 bytes written
+```
+
+If you have the repo cloned, you can do the above, just append `bundle exec exe/` e.g. `bundle exec exe/fav_lang -u tadast`
+
+## Using the library
+
+```ruby
+require 'fav_language'
+fav_stats = FavLanguage::Detector.new(username: 'tadast').favourite_languages
+# returns an array of objects that have two properties: weight and language
+# it is an array in case the user has two equally favourite languages
+fav_stats.size
+> 1
+fav_stats.first.language
+> "JavaScript"
+fav_stats.first.weight
+> 353577 # bytes commited in this language
+```
+
+## API rate limits
+
+GitHub limits the number of requests you can make to the API. To increase this number you may want to get an oauth token. You can follow the instructions [on the github_api gem readme](https://github.com/peter-murach/github#3-authentication) to get the token. Then you can pass in the token value via the command line
+
+```
+fav_lang -u tadast -t <token>
+```
+
+or as an argument
+
+```ruby
+fav_stats = FavLanguage::Detector.new(username: 'tadast', token: "<token>")
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fav_language/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fav_language"
+
+options = {}
+optparse = OptionParser.new do |opts|
+  opts.on('-u', '--username username', String, 'GitHub username') { |o| options[:username] = o }
+  opts.on('-t', '--token token', String, 'GitHub auth token to increase rate limit. https://github.com/peter-murach/github#3-authentication') { |o| options[:token] = o }
+end.parse!
+
+begin
+  FavLanguage::Detector.new(options).print
+rescue ArgumentError => e
+  puts e.message
+  abort("see 'fav_lang -h' for usage")
+end
+

data/fav_language.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fav_language/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fav_language"
+  spec.version       = FavLanguage::VERSION
+  spec.authors       = ["Tadas Tamosauskas"]
+  spec.email         = ["tadas@pdfcv.com"]
+
+  spec.summary       = %q{Guess the favourite language of a github user}
+  spec.description   = %q{Guesses the favourite language of a github username by looking at the amount of code committed to the owned public repos}
+  spec.homepage      = "https://github.com/tadast/fav_language"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "github_api", "~> 0.12"
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0"
+end

data/lib/fav_language.rb

@@ -0,0 +1,9 @@
+require "fav_language/version"
+require "fav_language/detector"
+require "fav_language/language_stats"
+require "fav_language/repo_list"
+require "fav_language/repo"
+
+module FavLanguage
+
+end

data/lib/fav_language/detector.rb

@@ -0,0 +1,35 @@
+module FavLanguage
+  class Detector
+    def initialize(username:, token: nil, stats_class: LanguageStats)
+      @username = username
+      @token = token
+      @stats_class = stats_class
+    end
+
+    def print
+      message = favourite_languages.map do |weighted_language|
+        "#{weighted_language.language}: #{weighted_language.weight} bytes written"
+      end.join("\n")
+      puts message
+    end
+
+    def favourite_languages
+      max_weight = weighted_languages.map(&:weight).max
+      weighted_languages.select{ |lww| lww.weight == max_weight }
+    end
+
+  private
+    attr_reader :username, :token
+
+    def weighted_languages
+      validate_username
+      @weighted_languages ||= @stats_class.new(username: username, token: token).fetch
+    end
+
+    def validate_username
+      if username.to_s.size == 0
+        raise "Please provide GitHub username"
+      end
+    end
+  end
+end

data/lib/fav_language/language_stats.rb

@@ -0,0 +1,26 @@
+module FavLanguage
+  class LanguageStats
+    def initialize(username:, token: nil, repo_list_class: RepoList)
+      @username = username
+      @token = token
+      @repo_list_class = repo_list_class
+    end
+
+    def fetch
+      language_stats.group_by(&:language).map do |language, stats|
+        OpenStruct.new(language: language, weight: stats.inject(0){ |sum, next_one| sum + next_one.bytes })
+      end
+    end
+
+  private
+    attr_reader :username, :token
+
+    def language_stats
+      @repo_list_class.new(github: github, username: username).language_stats
+    end
+
+    def github
+      @github ||= Github.new(oauth_token: token || ENV['GH_AUTH_TOKEN'])
+    end
+  end
+end

data/lib/fav_language/repo.rb

@@ -0,0 +1,18 @@
+require 'github_api'
+
+module FavLanguage
+  class Repo
+    attr_reader :github
+
+    def initialize(raw, github:)
+      @raw = raw
+      @github = github
+    end
+
+    def language_stats
+      github.get_request(@raw['languages_url']).body.to_h.map do |language, bytes|
+        OpenStruct.new(language: language, bytes: bytes.to_i)
+      end
+    end
+  end
+end

data/lib/fav_language/repo_list.rb

@@ -0,0 +1,25 @@
+require 'github_api'
+
+module FavLanguage
+  class RepoList
+    attr_reader :github, :username
+
+    def initialize(github:, username:)
+      @github = github
+      @username = username
+    end
+
+    def fetch
+      @repos ||= github.repos
+                  .list(user: username, auto_pagination: true)
+                  .reject{ |r| r["fork"] }
+                  .map{ |r| Repo.new(r, github: github) }
+    end
+
+    def language_stats
+      fetch.flat_map do |repo|
+        repo.language_stats
+      end
+    end
+  end
+end

data/lib/fav_language/version.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: fav_language
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tadas Tamosauskas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: 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'
+description: Guesses the favourite language of a github username by looking at the
+  amount of code committed to the owned public repos
+email:
+- tadas@pdfcv.com
+executables:
+- fav_lang
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fav_lang
+- fav_language.gemspec
+- lib/fav_language.rb
+- lib/fav_language/detector.rb
+- lib/fav_language/language_stats.rb
+- lib/fav_language/repo.rb
+- lib/fav_language/repo_list.rb
+- lib/fav_language/version.rb
+homepage: https://github.com/tadast/fav_language
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Guess the favourite language of a github user
+test_files: []