fishbans 1.1.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06f227a174210eb010e8dd19316428c6a990ba25
-  data.tar.gz: 6526c7c298b8cb1b23682278380b5aa3b6e839f0
+  metadata.gz: 8afd3ab3a10bb5c4fd3749df793ec8a329ba8750
+  data.tar.gz: 239ee72e8c6559c1484d5beff351529876024841
 SHA512:
-  metadata.gz: c29b2241ddd6d93e094b0dfa96e7bf198f55b3530886c68c0301c1ddf5e5ea0908b4c10eacca16ccedcca6005299460c8f5d64ebd14128a04272a0535d3bc952
-  data.tar.gz: 389eaa3a1001a38eff9a3c4c18261444336abbdb4bb5948346e27428187605b1434bb03c6cc60cb2ac98d7a0e6f927bebdfc77241f3a6c1950598ae5174dcd9c
+  metadata.gz: 0edc84dbb944088d4fe827c44787acc37cccf27b2ee0650ea8c70630745bba5ebac3b3e380344876c93fbd3d0b96c635153b4a284960a45495259fdff455b3ff
+  data.tar.gz: 00f6bf0aea58828100e87bafa8fffee4c0ee47782390f27ccfe5a1fdb634b7ccfba4f6e1deb099c42169ff09716ca4e3986f01330d50a87a9b76054e29e0f760

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
+## Version 2
+### Version 2.0.0
+* The `services` array is now a constant as `Fishbans::SERVICES`.
+* Error strings are no longer returned from methods, but thrown as RuntimeErrors.
+* `parse_generic_ban_result` no longer returns a hash of arrays, but a hash of hashes. See the docs for more details.
+* Update to Ruby 2.4.0: `Fixnum` -> `Integer` in documentation.
+
 ## Version 1
 ### Version 1.1.4
 * Remove a couple unnecessary things from the PlayerSkins and BlockEngine (is_a? check and downcase).

data/lib/block_engine.rb

@@ -6,10 +6,11 @@ module Fishbans
     # Gets a block image by its ID and Metadata. Unfortunately it uses the old
     #   block IDs rather than the new ones, so you have to memorize those
     #   pesky integers.
-    # @param id [Fixnum] The (outdated) block ID number.
-    # @param metadata [Fixnum] The metadata, if any, for the block.
+    # @param id [Integer] The (outdated) block ID number.
+    # @param metadata [Integer] The metadata, if any, for the block.
     # @param size [Fixnum] The size of the image to get.
     # @return [ChunkyPNG::Image] The ChunkyPNG instance of that block image.
+    # @raise see #get
     def get_block(id, metadata = nil, size = 42)
       url = "http://blocks.fishbans.com/#{id}"
       url += "-#{metadata}" unless metadata.nil?
@@ -25,9 +26,10 @@ module Fishbans
     # @param three [Boolean] Whether to get a three-dimensional monster image.
     #   The three-dimensional image is of the full monster, while the
     #   two-dimensional image is just its head.
-    # @param size [Fixnum] The size of the image (width) to get. For 3D images
+    # @param size [Integer] The size of the image (width) to get. For 3D images
     #   this will not be perfect just by nature of the API.
     # @return [ChunkyPNG::Image] The ChunkyPNG instance of that monster image.
+    # @raise see #get
     def get_monster(id, three = false, size = 42)
       id = id.to_s
       url = 'http://blocks.fishbans.com'

data/lib/fishbans.rb

@@ -9,7 +9,7 @@ module Fishbans
 
   extend self
   @client = HTTPClient.new
-  @services = [
+  SERVICES = [
     'mcbouncer',
     'minebans',
     'glizer',
@@ -19,136 +19,109 @@ module Fishbans
 
   # Gets all bans on a user.
   # @param username [String] The username to check.
-  # @return [Hash/Nil/String] Either a hash of arrays containing information on
-  #   the user's bans, or nil if they aren't banned. An error string if the
-  #   request failed.
+  # @return see #parse_generic_ban_result
+  # @raise see #get
   def get_all_bans(username)
     response = get("http://api.fishbans.com/bans/#{username}")
-    if response.is_a?(String)
-      return response
-    else
-      return parse_generic_ban_result(response)
-    end
+    parse_generic_ban_result(response)
   end
 
   # Gets all bans for a given service for a user.
   # @param username [String] The username to check.
-  # @param service [String] The service to check. Can be any of the values in
-  #   the @services array.
-  # @return [Hash/Nil/Boolean/String] False if the service is not an accepted
-  #   value. A hash of arrays containing information on the user's bans, or nil
-  #   if they aren't banned. An error string if the request failed.
+  # @param service [String] The service to check. Can be any of the values in the SERVICES array.
+  # @return [Boolean] False if the service is not an accepted value.
+  # @return [Hash<String, String>] Key: Minecraft server; value: reason
+  # @raise see #get
   def get_ban_service(username, service)
-    service = service.downcase
+    service.downcase!
 
-    if @services.include? service
+    if SERVICES.include? service
       response = get("http://api.fishbans.com/bans/#{username}/#{service}")
-      if response.is_a?(String)
-        return response
-      else
-        return parse_generic_ban_result(response)
-      end
+      parse_generic_ban_result(response)[service]
     else
-      return false
+      false
     end
   end
 
   # Gets the total number of bans that the user has.
   # @param username [String] The username to check.
-  # @return [Int/String] The number of bans the user has. An error string if the
-  #   request failed.
+  # @return [Integer] The number of bans the user has.
+  # @raise see #get
   def get_total_bans(username)
     response = get("http://api.fishbans.com/stats/#{username}")
-    if response.is_a?(String)
-      return response
-    else
-      return response['stats']['totalbans']
-    end
+    response['stats']['totalbans']
   end
 
   # Gets the total number of bans by service that the user has.
   # @param username [String] The username to check.
   # @param service [String] The service to check. Can be any of the values in
-  #   the @services array.
-  # @return [Int/Boolean/String] False if the service is not an accepted value.
-  #   An int containing the number of bans the user has in the given service. An
-  #   error string if the request failed.
+  #   the SERVICES array.
+  # @return [Boolean] False if the service is not an accepted value.
+  # @return [Integer] The number of bans the user has in the given service. See SERVICES for valid services.
+  # @raise see #get
   def get_total_bans_service(username, service)
-    if @services.include?(service)
+    service.downcase!
+
+    if SERVICES.include?(service)
       # Note that the /service part is not necessary, but it slightly improves
       #   performance of the API.
       response = get("http://api.fishbans.com/stats/#{username}/#{service}")
-      if response.is_a?(String)
-        return response
-      else
-        return response['stats']['service'][service]
-      end
+      response['stats']['service'][service]
     else
-      return false
+      false
     end
   end
 
   # Gets the Minecraft UUID for the user.
   # @param username [String] The username to get the ID for.
-  # @return [String] The user's UUID. An error string if the request failed.
+  # @return [String] The user's UUID.
+  # @raise see #get
   def get_userid(username)
     response = get("http://api.fishbans.com/uuid/#{username}")
-    if response.is_a?(String)
-      return response
-    else
-      return response['uuid']
-    end
+    response['uuid']
   end
 
   # Gets username history for the user.
   # @param username [String] The username to get history for.
-  # @return [Array/String] Array of strings containing old usernames. An error
-  #   string if the request failed.
+  # @return [Array<String>] Array of strings containing old usernames.
+  # @raise see #get
   def get_username_history(username)
     response = get("http://api.fishbans.com/history/#{username}")
-    if response.is_a?(String)
-      return response
-    else
-      return response['data']['history']
-    end
+    response['data']['history']
   end
 
   private
 
   # Performs a basic GET request.
   # @param url [String] The URL to get.
-  # @param do_json [Boolean] Whether to parse the JSON.
-  # @return [JSON/String] The parsed JSON of the response, or the error string.
+  # @param do_json [Boolean] Whether to parse the JSON before returning.
+  # @return [Hash] The parsed JSON of the response, if do_json is true.
+  # @return [HTTP::Message] Unparsed response, if do_json is false.
+  # @raise [RuntimeError] An error if the request is not successful.
   def get(url, do_json = true)
     url = URI.encode(url)
     uri = URI.parse(url)
     response = @client.get(uri)
-    return response if do_json == false
+    return response unless do_json
     json = JSON.parse(response.body)
-    if json['success']
-      return json
-    else
-      return json['error']
-    end
+    return json if json['success']
+    fail json['error']
   end
 
-  # Parses a basic ban result into a formatted hash.
+  # Parses a basic ban result into a formatted hash. This assumes it is not an errored response.
   # @param response [JSON] The response to parse.
-  # @return [Hash/Nil] Nil if there are no bans in the response, or a hash of
-  #   arrays containing the user's bans.
+  # @return [Hash<String, Hash<String, String>>] Service (see SERVICES) is the key; value is a hash with
+  #   server as the key, and the reason as the value. Empty hash if there are no bans.
   def parse_generic_ban_result(response)
     ret = {}
-    response['bans']['service'].each do |b, i|
-      next if i['bans'] == 0
-      i['ban_info'].each do |s, r|
-        ret[b] = [
-          i['bans'],
-          { s => r }
-        ]
+    response['bans']['service'].each do |service, info|
+      next if info['bans'] == 0
+      ret[service] = {}
+      info['ban_info'].each do |server, reason|
+        ret[service][server] = reason
       end
     end
 
-    return nil if ret.empty?
     ret
   end
 end

data/lib/player_skins.rb

@@ -5,24 +5,27 @@ module Fishbans
   module PlayerSkins
     # Gets the image for the front face of the player head.
     # @param username [String] The username to get the head of.
-    # @param size [Fixnum] The width of the image to get.
+    # @param size [Integer] The width of the image to get.
     # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance of that head.
+    # @raise see #get
     def get_player_head(username, size = 100)
       get_player_image(username, 'helm', size)
     end
 
     # Gets the image for the entire front of the player.
     # @param username [String] See #get_player_head.
-    # @param size [Fixnum] See #get_player_head.
+    # @param size [Integer] See #get_player_head.
     # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance of that front.
+    # @raise see #get
     def get_player_front(username, size = 100)
       get_player_image(username, 'player', size)
     end
 
     # Gets the image for the player's raw skin.
     # @param username [String] See #get_player_head.
-    # @param size [Fixnum] See #get_player_head.
+    # @param size [Integer] See #get_player_head.
     # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance of that skin.
+    # @raise see #get
     def get_player_skin(username, size = 64)
       get_player_image(username, 'skin', size)
     end
@@ -33,8 +36,9 @@ module Fishbans
     # @param username [String] See #get_player_head.
     # @param type [String] The type of image to get. Can be 'helm', 'player', or
     #   'skin' as defined by the Fishbans Player Skins API.
-    # @param size [Fixnum] See #get_player_head.
+    # @param size [Integer] See #get_player_head.
     # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance for the params.
+    # @raise see #get
     def get_player_image(username, type, size)
       url = "http://i.fishbans.com/#{type}/#{username}/#{size}"
       response = get(url, false)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fishbans
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -71,9 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for accessing the Fishbans Minecraft API.
 test_files: []
-has_rdoc: