ghuls-lib 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66fe2c59dbfe6e9bf324abceeb1d32eaf7daac5f
-  data.tar.gz: ae13f00717de31600da2be126b4ea7707386d03a
+  metadata.gz: 91d1a894139f17e933e802fd1d27f59e1a0b82a4
+  data.tar.gz: c56fc6748fe1d35005202c4491d5dd176ed19381
 SHA512:
-  metadata.gz: da4a4f104136d2de84ad1af06a13b062b6b93b8e37688bd966aabc97f03958c3dd8f17a8d49d427bf3700d388dad29db886dd2097b3b6ed73d43fc536abb9c68
-  data.tar.gz: d08f33c6133e10f197a5b295998a1d49e4311047a5727e60513786a6a8e88c7ad79d26b1f897e917dd5be491cd9d7328834d08fde9d4e4dd36cf21a4ee7f097e
+  metadata.gz: bd4a495f647029cc917e9e22728730a573a4e8b2ecc7e20753bca93db80d08678a2cd67336f6be5d6b2efdfc5fd56f12d175a6991d671151ed86a7bebe7a8f8e
+  data.tar.gz: 44f297bff0cacaf26e4ff4ddbbfd4bea4a34f525b089d3a93a38e4f5a9251cc5538bf8d7867c2ae0cdcae1d0b110d6245101c6ce04ace05cf261c106bd460234

data/lib/ghuls/lib.rb

@@ -32,37 +32,24 @@ module GHULS
       full.at(full.index(single) + 1)
     end
 
-    # Gets whether or not the user exists.
-    # @param username [String] The user to check
-    # @param github [Octokit::Client] The instance of Octokit to use.
-    # @return [Boolean] True if it does, false if it doesn't.
-    def self.user_exists?(username, github)
-      begin
-        github.user(username)
-      rescue Octokit::NotFound
-        return false
-      end
-      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
+    # @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 [Boolean] False if it does not exist.
-    def self.get_user_and_check(userid, github)
+    def self.get_user_and_check(user, github)
       begin
-        username = github.user(userid)
+        user_full = github.user(user)
       rescue Octokit::NotFound
         return false
       end
-      username[:login]
+      { username: user_full[:login], avatar: user_full[:avatar_url] }
     end
 
     # Returns the repos in the user's organizations that they have actually
     #   contributed to.
-    # @param username [String] See #user_exists?
-    # @param github [Octokit::Client] See #user_exists?
+    # @param username [String] See #get_user_and_check
+    # @param github [Octokit::Client] See #get_user_and_check
     # @return [Array] All the repository full names that the user has
     #   contributed to.
     def self.get_org_repos(username, github)
@@ -90,8 +77,8 @@ module GHULS
     end
 
     # Gets the langauges and their bytes for the user.
-    # @param username [String] See #user_exists?
-    # @param github [Octokit::Client] See #user_exists?
+    # @param username [String] See #get_user_and_check
+    # @param github [Octokit::Client] See #get_user_and_check
     # @return [Hash] The languages and their bytes, as formatted as
     #   { :Ruby => 129890, :CoffeeScript => 5970 }
     def self.get_user_langs(username, github)
@@ -113,8 +100,8 @@ module GHULS
     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?
+    # @param username [String] See #get_user_and_check
+    # @param github [Octokit::Client] See #get_user_and_check
     # @return [Hash] See #get_user_langs
     def self.get_org_langs(username, github)
       org_repos = get_org_repos(username, github)
@@ -170,12 +157,12 @@ module GHULS
     end
 
     # Performs the main analysis of the user's organizations.
-    # @param username [String] See #user_exists?
-    # @param github [Octokit::Client] See #user_exists?
+    # @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 user_exists? returns false.
+    # @return [Boolean] False if get_user_and_check returns false.
     def self.analyze_orgs(username, github)
-      if user_exists?(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)
@@ -185,12 +172,12 @@ module GHULS
     end
 
     # Performs the main analysis of the user.
-    # @param username [String] See #user_exists?
-    # @param github [Octokit::Client] See #user_exists?
+    # @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
     def self.analyze_user(username, github)
-      if user_exists?(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)
@@ -206,7 +193,7 @@ module GHULS
     #   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?
+    # @param github [Octokit::Client] See #get_user_and_check
     # @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' \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghuls-lib
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit