github-calendar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 856e63c23cb5514fbc7977cbb20c65b0e4124c7f
+  data.tar.gz: 09737875de871692c12bceb518d5d9f7c8f86311
+SHA512:
+  metadata.gz: 50c57e384c669352a51e2a69d6cdb23972135d7fc2ef7799a6efe9ba99c6f212a496479a693f09f4e4bbdc34cf5d3bc86b1bb2fda8fe986a59ecff52f95de455
+  data.tar.gz: 854848db35f10e0ead23a74e28b286fd78b10809abf77daae168d14ef81667d21c1ec97bc5bfb73289a05b7543f6c139636c2d8e853dde0b65e823df08eec131

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+## Version 1
+### Version 1.0.0
+* Initial release.

data/lib/github/calendar.rb

@@ -0,0 +1,166 @@
+require 'open-uri'
+require 'nokogiri'
+require 'string-utility'
+require_relative 'exceptions'
+
+module GitHub
+  module Calendar
+    extend self
+    using StringUtility
+
+    # Gets the total number of contributions for the past year.
+    # @param user [String] The username to get this data for.
+    # @return [Int] An integer value of their total contributions this year.
+    def get_total_year(user)
+      source = get_page_source(user)
+      string = source.css('span.contrib-number')[0].text
+      string.to_i_separated
+    end
+
+    # Gets the longest contribution streak (in days) that the user has had.
+    # @param user [String] See #get_total_year
+    # @return [Int] The user's longest contribution streak in days.
+    def get_longest_streak(user)
+      source = get_page_source(user)
+      string = source.css('span.contrib-number')[1].text
+      string.to_i_separated
+    end
+
+    # Gets the current contribution streak (in days) that the user is in.
+    # @param user [String] See #get_total_year
+    # @return [Int] The user's current contribution streak in days.
+    def get_current_streak(user)
+      source = get_page_source(user)
+      string = source.css('span.contrib-number')[2].text
+      string.to_i_separated
+    end
+
+    # Gets the weekly contribution count for the past year.
+    # @param user [String] See #get_total_year
+    # @return [Hash] How many contributions they have done each week. Example:
+    # { 0: 0, 1: 8, etc. }
+    def get_weekly(user)
+      weeks = get_calendar(user)
+      ret = {}
+      count = 0
+      weeks[1..-1].each do |k|
+        data = 0
+        capture = k.to_s.scan(/data-count=\"(.*?)\"/)
+        capture[1..-1].each do |ints|
+          data += ints[0].to_i
+        end
+        ret[count] = data
+        count += 1
+      end
+      ret
+    end
+
+    # Gets the daily contribution count for the past year.
+    # @param user [String] See #get_total_year
+    # @return [Hash] How many contributions they have performed each day. See
+    # #get_weekly
+    def get_daily(user)
+      weeks = get_calendar(user)
+      ret = {}
+      count = 0
+      weeks[1..-1].each do |k|
+        capture = k.to_s.scan(/data-count=\"(.*?)\"/)
+        capture[1..-1].each do |i|
+          ret[count] = i[0].to_i
+          count += 1
+        end
+      end
+      ret
+    end
+
+    # Gets the monthly contribution count for the past year.
+    # @param user [String] See #get_total_year
+    # @return [Hash] How many contributions they have performed each month.
+    # Months are listed as their string integers, e.g., 01 is January and
+    # 12 is December.
+    def get_monthly(user)
+      weeks = get_calendar(user)
+      ret = {
+        '01' => 0,
+        '02' => 0,
+        '03' => 0,
+        '04' => 0,
+        '05' => 0,
+        '06' => 0,
+        '07' => 0,
+        '08' => 0,
+        '09' => 0,
+        '10' => 0,
+        '11' => 0,
+        '12' => 0
+      }
+      weeks[1..-1].each do |k|
+        date = k.to_s.scan(/data-date=\".*-(.*?)-/)
+        capture = k.to_s.scan(/data-count=\"(.*?)\"/)
+        capture[1..-1].each do |i|
+          ret[date[0][0]] += i[0].to_i
+        end
+      end
+      ret
+    end
+
+    # Gets the average weekly number of contributions by the user.
+    # @param user [String] See #get_total_year
+    # @return [Int] The average number of contributions.
+    def get_average_week(user)
+      weekly = get_weekly(user)
+      get_average(weekly)
+    end
+
+    # Gets the average daily number of contributions by the user.
+    # @param user [String] See #get_total_year
+    # @return [Int] See #get_average_week
+    def get_average_day(user)
+      daily = get_daily(user)
+      get_average(daily)
+    end
+
+    # Gets the average monthly number of contributions by the user.
+    # @param user [String] See #get_total_year
+    # @return [Int] See #get_average_week
+    def get_average_month(user)
+      monthly = get_monthly(user)
+      get_average(monthly)
+    end
+
+    private
+
+    # Gets the parsed HTML source for the user profile.
+    # @param user [String] See #get_total_year
+    # @return [Nokogiri::HTML::Document] The parsed HTML for the user page
+    # @raise [UserNotFoundException] If the user is not found.
+    def get_page_source(user)
+      begin
+        Nokogiri::HTML(open("https://github.com/#{user}"), &:noblanks)
+      rescue OpenURI::HTTPError
+        raise GitHub::Exceptions::UserNotFoundException.new(user)
+      end
+    end
+
+    # Gets the parsed calendar HTML source for the user profile.
+    # @param user [String] See #get_total_year
+    # @return [Nokogiri::XML::NodeSet] The NodeSet for all the g's in the
+    # calendar. Consider this as an array of all the weeks. In iteration,
+    # you will probably want to skip the first, as it is the total yearly.
+    # @return [Nil] See #get_total_year
+    def get_calendar(user)
+      source = get_page_source(user)
+      source.css('svg.js-calendar-graph-svg g')
+    end
+
+    # Gets an average for all the integer values in a hash.
+    # @param [Hash] The hash to get the average for.
+    # @return [Int] The average of the values.
+    def get_average(hash)
+      hash_max = hash.length
+      hash_total = 0
+      hash.each { |_, v| hash_total += v }
+      hash_total / hash_max
+    end
+  end
+end

data/lib/github/exceptions.rb

@@ -0,0 +1,10 @@
+module GitHub
+  module Exceptions
+    class UserNotFoundException < StandardError
+      attr_reader :message
+      def initialize(user)
+        @message = "The user, #{user}, could not be found."
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: github-calendar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eli Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+- !ruby/object:Gem::Dependency
+  name: string-utility
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: A library that allows for quick HTML parsing of GitHub user profile contribution
+  calendars. This project is part of the GitHub User Language Statistics project.
+email: elifosterwy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- lib/github/calendar.rb
+- lib/github/exceptions.rb
+homepage: https://github.com/ghuls-apps/github-calendar-api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Getting GitHub user profile calendar data through HTML parsing.
+test_files: []
+has_rdoc: