ghuls-lib 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93492def48a9670b6caff212c59072b83b2a997d
-  data.tar.gz: 55c789087aac45e5129afb58a3c23d86d30fa5a2
+  metadata.gz: 67ca5effd388bccc1045323ba0a05507c566f682
+  data.tar.gz: b93f7737533f3ac78d65fa01502d55cee400f7b0
 SHA512:
-  metadata.gz: c029fe48c3b090f01281db001e8a9f06ffa81d0d64b6cb03d9290c7b236eb91b3ad82b1cde6f9704c254fe76ec56b5feb42f9c2acbb9190eed4b5e9f016c7ace
-  data.tar.gz: 260c39163dd22118e2452ad92c5cc7df268102ccbeebce91ef0efcba7fe95d11afdaa0621c79ab8a32fad182fd890c84c8790c49b289a3d3de4c73ed24f90ff5
+  metadata.gz: d0057082b97bed7d49c6c6d75a67c9bd351b30430d0b332f6a38f63de3dd7b8a1750a4ebaf3ad6b48ff11fc40271247180c7299cb18da752f14f67592e374f95
+  data.tar.gz: 0a138e32b0fdc2eff4486742bfab2acb45684cab1deeba9007ff74bff35b840e2e0eb14277f24a0835dbbb89dd00a786d58e7aaa298fa344bd9aaab61299fef1

data/lib/ghuls/lib.rb

@@ -45,6 +45,20 @@ module GHULS
       true
     end
 
+    # Gets the username and checks if it exists in the process.
+    # @param userid [Fixnum] The user ID.
+    # @param github [Octokit::Client] See #user_exists?
+    # @return [String] The username
+    # @return [Boolean] False if it does not exist.
+    def self.get_user_and_check(userid, github)
+      begin
+        username = github.user(userid)
+      rescue Octokit::NotFound
+        return false
+      end
+      username[:login]
+    end
+
     # Returns the repos in the user's organizations that they have actually
     #   contributed to.
     # @param username [String] See #user_exists?
@@ -72,9 +86,9 @@ module GHULS
       true_repos
     end
 
-    # Gets the langauges and their bytes for the :user.
-    # @param username [String] The username to get info for.
-    # @param github [OctoKit::Client] The instance of Octokit::Client.
+    # Gets the langauges and their bytes for the user.
+    # @param username [String] See #user_exists?
+    # @param github [Octokit::Client] See #user_exists?
     # @return [Hash] The languages and their bytes, as formatted as
     #   { :Ruby => 129890, :CoffeeScript => 5970 }
     def self.get_user_langs(username, github)
@@ -95,6 +109,10 @@ module GHULS
       langs
     end
 
+    # Gets the languages and their bytes for the user's organizations.
+    # @param username [String] See #user_exists?
+    # @param github [Octokit::Client] See #user_exists?
+    # @return [Hash] See #get_user_langs
     def self.get_org_langs(username, github)
       org_repos = get_org_repos(username, github)
       langs = {}
@@ -133,6 +151,10 @@ module GHULS
       end
     end
 
+    # Gets the percentages for each language in a hash.
+    # @param langs [Hash] The language hash obtained by the get_langs methods.
+    # @return [Hash] The language percentages formatted as
+    #   { Ruby: 50%, CoffeeScript: 50% }
     def self.get_language_percentages(langs)
       total = 0
       langs.each { |_, b| total += b }
@@ -144,6 +166,11 @@ module GHULS
       lang_percents
     end
 
+    # Performs the main analysis of the user's organizations.
+    # @param username [String] See #user_exists?
+    # @param github [Octokit::Client] See #user_exists?
+    # @return [Hash] See #get_language_percentages
+    # @return [Boolean] False if user_exists? returns false.
     def self.analyze_orgs(username, github)
       if user_exists?(username, github)
         langs = get_org_langs(username, github)
@@ -154,6 +181,11 @@ module GHULS
       end
     end
 
+    # Performs the main analysis of the user.
+    # @param username [String] See #user_exists?
+    # @param github [Octokit::Client] See #user_exists?
+    # @return [Hash] See #analyze_orgs
+    # @return [Boolean] See #analyze_orgs
     def self.analyze_user(username, github)
       if user_exists?(username, github)
         langs = get_user_langs(username, github)
@@ -165,14 +197,22 @@ module GHULS
     end
 
     using StringUtility
+    # Gets a random GitHub user that actually has data to analyze.
+    #   Must always get a user that exists and has repositories, so it will
+    #   go through a loop infinitely until it gets one. Uses the GitHub Search
+    #   to find the maximum number of users, which may not be the best way to do
+    #   it. However, none of the documented GitHub APIs show that we can get the
+    #   total number of GitHub users.
+    # @param github [Octokit::Client] See #user_exists?
+    # @return [String] A random username.
     def self.get_random_user(github)
       source = open('https://github.com/search?utf8=%E2%9C%93&q=repos%3A%3E-1' \
                     '&type=Users&ref=searchresults').read
-      has_repos = false
-      while has_repos == false
+      continue = false
+      while continue == false
         userid = rand(source[/Showing (.*?) available users/, 1].to_i_separated)
-        user = github.user(userid)[:login]
-        has_repos = true unless get_user_langs(user, github).empty?
+        user = get_user_and_check(userid, github)
+        continue = true if user != false && !get_user_langs(user, github).empty?
       end
       user
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghuls-lib
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Eli Foster
@@ -69,3 +69,4 @@ signing_key:
 specification_version: 4
 summary: The library used for and by the GHULS applications.
 test_files: []
+has_rdoc: