ghuls-lib 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91d1a894139f17e933e802fd1d27f59e1a0b82a4
-  data.tar.gz: c56fc6748fe1d35005202c4491d5dd176ed19381
+  metadata.gz: 610530e600dae4056abf96b5a94c286df2852d0f
+  data.tar.gz: 63ec7b6e63018a392d4323594434f8366df62b14
 SHA512:
-  metadata.gz: bd4a495f647029cc917e9e22728730a573a4e8b2ecc7e20753bca93db80d08678a2cd67336f6be5d6b2efdfc5fd56f12d175a6991d671151ed86a7bebe7a8f8e
-  data.tar.gz: 44f297bff0cacaf26e4ff4ddbbfd4bea4a34f525b089d3a93a38e4f5a9251cc5538bf8d7867c2ae0cdcae1d0b110d6245101c6ce04ace05cf261c106bd460234
+  metadata.gz: 6f416f5e54a83b37d113a7aa470727412043e012b9c238de28d62759347c65dd9dec0e9ad3499f39b538736fa0b65df74b0ea429dc8b0d6ad296667583582b8d
+  data.tar.gz: 59fd44b2b7007031a2d2e5c8585e1b243441a4ba43231711b0f9ce79d814ef372dcf2d0c2afbe76180b487609190664b8ed47db81b6c35513c7c80d154855616

data/lib/ghuls/lib.rb

@@ -32,10 +32,10 @@ module GHULS
       full.at(full.index(single) + 1)
     end
 
-    # Gets the username and checks if it exists in the process.
+    # Gets the user and checks if it exists in the process.
     # @param user [Any] The user ID or name.
     # @param github [Octokit::Client] The instance of Octokit::Client.
-    # @return [Hash] Data formatted as { username: username, avatar: url }
+    # @return [Hash] Their username and avatar URL.
     # @return [Boolean] False if it does not exist.
     def self.get_user_and_check(user, github)
       begin
@@ -43,7 +43,10 @@ module GHULS
       rescue Octokit::NotFound
         return false
       end
-      { username: user_full[:login], avatar: user_full[:avatar_url] }
+      {
+        username: user_full[:login],
+        avatar: user_full[:avatar_url]
+      }
     end
 
     # Returns the repos in the user's organizations that they have actually
@@ -160,30 +163,22 @@ module GHULS
     # @param username [String] See #get_user_and_check
     # @param github [Octokit::Client] See #get_user_and_check
     # @return [Hash] See #get_language_percentages
-    # @return [Boolean] False if get_user_and_check returns false.
+    # @return [Nil] If the user does not have any languages.
     def self.analyze_orgs(username, github)
-      if get_user_and_check(username, github) != false
-        langs = get_org_langs(username, github)
-        return false if langs.empty?
-        get_language_percentages(langs)
-      else
-        false
-      end
+      langs = get_org_langs(username, github)
+      return nil if langs.empty?
+      get_language_percentages(langs)
     end
 
     # Performs the main analysis of the user.
     # @param username [String] See #get_user_and_check
     # @param github [Octokit::Client] See #get_user_and_check
     # @return [Hash] See #analyze_orgs
-    # @return [Boolean] See #analyze_orgs
+    # @return [Nil] See #analyze_orgs
     def self.analyze_user(username, github)
-      if get_user_and_check(username, github) != false
-        langs = get_user_langs(username, github)
-        return false if langs.empty?
-        get_language_percentages(langs)
-      else
-        false
-      end
+      langs = get_user_langs(username, github)
+      return nil if langs.empty?
+      get_language_percentages(langs)
     end
 
     using StringUtility
@@ -194,7 +189,7 @@ module GHULS
     #   it. However, none of the documented GitHub APIs show that we can get the
     #   total number of GitHub users.
     # @param github [Octokit::Client] See #get_user_and_check
-    # @return [String] A random username.
+    # @return [Hash] See #get_user_and_check.
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghuls-lib
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Eli Foster