hypixel-ruby 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6a5c37f9c63c528d5348682e7795d7e4f16a320
-  data.tar.gz: ee7abac1e63b907cc5cc23207548c3792df8b872
+SHA256:
+  metadata.gz: 098b28c3fac80807736392861e1ce69f0331962256a60f953acfb3c90157aabc
+  data.tar.gz: 32e7cff639ce3ba34ea580c39fd41f21cacda30ed97ef401633d12b5966618a5
 SHA512:
-  metadata.gz: 5fda54ce0e69d95038b56e77acd0e357a859101d8ad4c6b77c66df61346a968a7b36bd81b8eb77a65bea7fe742d271c89d30e4870c00a16c18f56795d6b55af7
-  data.tar.gz: 2cb07d34274996b7c3a20e7fd7983fe84cbeba02162b7f91f5cf64a2096d8850fc817c894ec22cbfe898100ad7660e688aaddbaa5725bdac31c4ecf1732a053b
+  metadata.gz: ecc973fbcda49edc6aca6aa8f82bf29eaf3cea2007dabac0310ac18ab10f557fbb77451afbfac17840e3813137ecc1b4438a273a15d176a37590a3d2c997bc92
+  data.tar.gz: f0dd0b79824fe32ba4634480dddb8897852c9e0ec194fa6523ebdb7e81f0e85aedffc65dceda9e77a235374334660fde962c0265b83a3a302d4eaa9bea4aa875

data/lib/hypixel-ruby.rb

@@ -1,15 +1,21 @@
 require 'open-uri'
 require 'json'
 
+# Base object for the api. Only create one for the entire build as it will one day keep track of your request limits. *All methods are avaible at https://github.com/HypixelDev/PublicAPI/tree/master/Documentation/methods, use arguments are parms.*
 class HypixelAPI
   
+  # Parses url to Rubyfiy the request, internal so you won't need to use it for much.
   def fetch(url)
     source = (open URI(url)).read
     return JSON.parse(source, :symbolize_names => true)
   end
+  
+  # Creates a new object with your API key. *If request are failing for you, remember to check your key.*
   def initialize(key)
     @key = key
   end
+  
+  # Builds a url from the request type and parameters. *Do not specify your key in the parameters.*
   def url(type, hash)
     url = "https://api.hypixel.net/"
     url << type.to_s
@@ -28,30 +34,37 @@ class HypixelAPI
 # ex: api.player( :uuid => "<uuid here>" )
 #
   
+  # Fetches boosters and their active times.
   def boosters(args={})
     fetch(url(:"boosters", args))
   end
   
+  # Finds a guild by name or player.
   def findguild(args={})
     fetch(url(:"findguild", args))
   end
   
+  # Refer to PublicAPI docs on this one.
   def friends(args={})
     fetch(url(:"friends", args))
   end
   
+  # Fetches guild data by id.
   def guild(args={})
     fetch(url(:"guild", args))
   end
   
+  # Fetches info about current status of API key.
   def key(args={})
     fetch(url(:"key", args))
   end
   
+  # Gets top players in each game.
   def leaderboards(args={})
     fetch(url(:"leaderboards", args))
   end
   
+  # Fetches player, recommended that you webscrape for uuid before finding them.
   def player(args={})
     fetch(url(:"player", args))
   end
@@ -60,8 +73,9 @@ class HypixelAPI
     fetch(url(:"session", args))
   end
   
+  # Gets info on bans/watchdog.
   def watchdogstats(args={})
     fetch(url(:"watchdogstats", args))
   end
   
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hypixel-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - PenguinOwl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies: []
 description: Coming Soon
 email: 
@@ -37,7 +37,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Barebones wrapper for hyixel stats