github_favorite_language 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 437ba989c8bc8ebb3526acbfcdad3fec0ff07cf3
+  data.tar.gz: 0fcd07bd693590b670bbf73e63a457e4452fd902
+SHA512:
+  metadata.gz: e0bdb00281020b4b85ed6334bffb0d3b996acffdbaa3fa8909c607c1d91cc06406c213dd230292dc4b629c26c7e2697a8b7e0ae14dfa837750d71ff7a09df4de
+  data.tar.gz: 44594fbfdf4262baf8276eea1d9357bed08e4130c48ce3aefad70cf9397bc18f8ce91af2d862f15fb0dac436d2b01e0abf08fdb994d76eabb2da1650247a3920

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.4

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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_favorite_language.gemspec
+gemspec
+
+gem "coveralls", require: false

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    ["spec/#{m[1]}_spec.rb", "spec/integration/#{m[1]}_integration_spec.rb"]
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Viktor Fonic
+
+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,72 @@
+# Github Favorite Language
+
+[![Build Status](https://travis-ci.org/vfonic/github_favorite_language.svg)](https://travis-ci.org/vfonic/github_favorite_language)
+[![Dependency Status](https://gemnasium.com/vfonic/github_favorite_language.svg)](https://gemnasium.com/vfonic/github_favorite_language)
+[![Coverage Status](https://coveralls.io/repos/vfonic/github_favorite_language/badge.svg)](https://coveralls.io/r/vfonic/github_favorite_language)
+[![Code Climate](https://codeclimate.com/github/vfonic/github_favorite_language/badges/gpa.svg)](https://codeclimate.com/github/vfonic/github_favorite_language)
+
+Find out any GitHub user's favorite programming language!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'github_favorite_language'
+```
+
+And then execute:
+
+```bash
+  $ bundle
+```
+
+Or install it yourself as:
+
+```bash
+  $ gem install github_favorite_language
+```
+
+## Usage
+
+The gem comes with the command line tool, but can be also called inside the ruby code.
+
+
+Example:
+
+Bash:
+
+```bash
+    $ github_favorite_language vfonic
+```
+
+Ruby:
+
+```ruby
+  require 'github_favorite_language'
+
+  puts GithubFavoriteLanguage.new(username: 'vfonic').favorite_language
+```
+
+Or:
+
+```ruby
+  require 'github_favorite_language'
+
+  GithubFavoriteLanguage.new(username: 'vfonic').print_favorite_language
+```
+
+This will fetch vfonic repos and return the name of the main language of most repositories.
+For GitHub documentation refer to: [https://developer.github.com/v3/](https://developer.github.com/v3/)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. 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 fix an issue, update the version number in `version.rb`, and then create a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Find out any GitHub user's favorite programming language
+
+Example:
+    github_favorite_language vfonic
+
+    This will fetch vfonic user repos and return the name of the language
+    with most bytes of code written.
+    For GitHub documentation refer to: https://developer.github.com/v3/

data/bin/console

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

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

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/github_favorite_language

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'github_favorite_language'
+
+if ARGV.empty? && $stdin.tty?
+  GithubFavoriteLanguage.print_usage
+else
+  username = ARGV.first || STDIN.read
+  puts GithubFavoriteLanguage.new(username: username).print_favorite_language
+end

data/github_favorite_language.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_favorite_language/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_favorite_language"
+  spec.version       = GithubFavoriteLanguage::VERSION
+  spec.authors       = ["Viktor Fonic"]
+  spec.email         = ["viktor.fonic@gmail.com"]
+
+  spec.summary       = "Find out any GitHub user's favorite language!"
+  spec.homepage      = "https://github.com/vfonic/github_favorite_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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.3.0'
+end

data/lib/errors.rb

@@ -0,0 +1,16 @@
+module JsonApiClient
+  class Error < StandardError
+    attr_reader :headers
+    
+    def initialize(headers:, message:)
+      super(message)
+      @headers = headers
+    end
+  end
+
+  # Raised when API returns a 404 Not Found
+  class NotFound < Error; end
+
+  # Raised when API returns a 403 Forbidden with ratelimit remaining zero
+  class RateLimitExceeded < Error; end
+end

data/lib/github_api.rb

@@ -0,0 +1,10 @@
+require 'json_api_client'
+
+class GithubAPI
+  GITHUB_API_URL = 'https://api.github.com'.freeze
+
+  def repos(user:)
+    repos = JsonApiClient.fetch_all_pages(url: GITHUB_API_URL + "/users/#{user}/repos")
+    repos.select{ |repo| repo["owner"]["login"] == user } unless repos.nil?
+  end 
+end

data/lib/github_favorite_language.rb

@@ -0,0 +1,57 @@
+require 'github_api'
+
+class GithubFavoriteLanguage
+  def initialize(username:)
+    @username = username.strip
+    raise UsernameWhitespaceOrEmpty if @username.empty?
+    @github_api = GithubAPI.new
+  end
+
+  def favorite_language
+    repos = @github_api.repos(user: @username)
+
+    languages = Hash.new(0)
+    repos.map do |repo|
+      languages[repo["language"]] += repo["size"] unless repo["language"].nil? || repo["language"].empty?
+    end
+    
+    languages.max_by { |lang, size| size }.first unless languages.empty?
+  end
+
+  def print_favorite_language
+    begin
+      language = favorite_language if language.nil?
+
+      unless language.nil?
+        print_message(message: "#{@username}'s favorite language is: #{language}")
+      else
+        print_no_public_repos
+      end
+    rescue JsonApiClient::NotFound
+      print_username_not_found
+    rescue JsonApiClient::Error, JsonApiClient::RateLimitExceeded => e
+      print_message(message: e.message)
+    end
+  end
+
+  def self.print_usage
+    puts File.read('USAGE')
+  end
+
+  private
+
+    def print_message(message:)
+      puts message
+    end
+
+    def print_no_public_repos
+      puts "Couldn't determine #{@username}'s favorite language."
+      puts "Check if #{@username} has public repos with code in them."
+    end
+
+    def print_username_not_found
+      puts "User #{@username} not found. Check the username is correct."
+    end
+end
+
+class UsernameWhitespaceOrEmpty < StandardError; end

data/lib/github_favorite_language/version.rb

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

data/lib/json_api_client.rb

@@ -0,0 +1,89 @@
+# use OpenURI with caution:
+# http://sakurity.com/blog/2015/02/28/openuri.htmlrequire 'open-uri'
+require 'open-uri'
+require 'json'
+require 'errors'
+
+# TODO: conform to JSON API spec v1.0
+# http://jsonapi.org
+module JsonApiClient
+  # Fetches all pages for the given url.
+  # Information about pagination is provided in the Link header of an API call.
+  # http://tools.ietf.org/html/rfc5988
+  # Example:
+  # Link: <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=2>; rel="next"
+  #   <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=34>; rel="last"
+  #
+  # Returns JSON parsed response body
+  def JsonApiClient.fetch_all_pages(url:)
+    headers, body = fetch_page(url: url)
+
+    return nil if headers.nil? || body.nil?
+
+    resources = JSON.parse(body)
+    while url = next_page(headers: headers) do
+      headers, body = fetch_page(url: url)
+      resources << JSON.parse(body)
+    end
+
+    resources
+  end
+
+  # Fetches a single page for the given url.
+  #
+  # Returns a header, body pair of response
+  def JsonApiClient.fetch_page(url:)
+    begin
+      res = open(URI(url))
+      [res.meta, res.read]
+    rescue OpenURI::HTTPError => e
+      process_error e
+    end
+  end
+
+  # Abstract OpenURI::HTTPErrors so we can:
+  # - provide more information
+  # - replace it later if needed
+  #
+  # Raises new error containing any additional valuable information.
+  def JsonApiClient.process_error(error)
+    headers = error.io.meta
+    if error.message == '404 Not Found'
+      raise JsonApiClient::NotFound.new(headers: headers, message: 'Not Found')
+    elsif error.message == '403 Forbidden'
+      # Rate Limit Remaining examples: http://stackoverflow.com/a/16022625
+      ratelimit_remaining = headers["x-ratelimit-userremaining"] ||
+                            headers["x-ratelimit-remaining"] ||
+                            headers["x-rate-limit-remaining"]
+      
+      if ratelimit_remaining.to_i == 0
+        ratelimit_reset = headers["x-ratelimit-reset"] ||
+                          headers["x-rate-limit-reset"] ||
+                          headers["x-ratelimit-userreset"]
+        message = 'Rate limit exceeded.'
+
+        if ratelimit_reset
+          ratelimit_reset_time = Time.at(ratelimit_reset.to_i)
+          message += " Try again after #{ratelimit_reset_time}."
+        end
+        api_error = JsonApiClient::RateLimitExceeded.new(headers: headers,
+                                                         message: message)
+        raise api_error
+      end
+    end
+    
+    raise JsonApiClient::Error.new(headers: headers, message: error.message)
+  end
+
+  # Finds next page from 'Link' response header
+  #
+  # Returns a url of next page
+  def JsonApiClient.next_page(headers:)
+    link = (headers["Link"] || "").split(', ').map do |link|
+      href, name = link.match(/<(.*?)>; rel="(\w+)"/).captures
+      return href if name == 'next'
+    end
+
+    nil
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: github_favorite_language
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viktor Fonic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-01 00:00:00.000000000 Z
+dependencies:
+- !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: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: 
+email:
+- viktor.fonic@gmail.com
+executables:
+- github_favorite_language
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- USAGE
+- bin/console
+- bin/rake
+- bin/setup
+- exe/github_favorite_language
+- github_favorite_language.gemspec
+- lib/errors.rb
+- lib/github_api.rb
+- lib/github_favorite_language.rb
+- lib/github_favorite_language/version.rb
+- lib/json_api_client.rb
+homepage: https://github.com/vfonic/github_favorite_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.4.6
+signing_key: 
+specification_version: 4
+summary: Find out any GitHub user's favorite language!
+test_files: []