fishbans 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e807ff54ca15ada567d8e13f472c8b4f31f46700
+  data.tar.gz: 984f4a9bf3a8f6b01be9110c5ecda6f4cfb6f31c
+SHA512:
+  metadata.gz: f99d58c22d1b7ff441b9bb23fef758cd2a1bf8ae69fe92d122fee37e63cc9ff3959661f0445e11f19705b6381d1bc2918728a287fca115d193054cbbc0d12f13
+  data.tar.gz: eb9b80e8ac26b4555c8e0acfc46331e4c85875b9525540399460b13e47914856a95cb100acb230aa8ba16c9e2056827c40d52c0588e04ecd6419fd6b7b77bece

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+## Version 1
+### Version 1.0.0
+* Initial version with all APIs documented on the Fishbans API Docs.

data/lib/fishbans.rb

@@ -0,0 +1,145 @@
+require 'httpclient'
+require 'json'
+
+module Fishbans
+  extend self
+  @client = HTTPClient.new
+  @services = [
+    'mcbouncer',
+    'minebans',
+    'glizer',
+    'mcblockit',
+    'mcbans'
+  ]
+
+  # 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.
+  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
+  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.
+  def get_ban_service(username, service)
+    service = service.downcase
+
+    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
+    else
+      return 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.
+  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
+  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.
+  def get_total_bans_service(username, service)
+    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
+    else
+      return 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.
+  def get_userid(username)
+    response = get("http://api.fishbans.com/uuid/#{username}")
+    if response.is_a?(String)
+      return response
+    else
+      return response['uuid']
+    end
+  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.
+  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
+  end
+
+  private
+  # Performs a basic GET request.
+  # @param url [String] The URL to get.
+  # @return [JSON/String] The parsed JSON of the response, or the error string.
+  def get(url)
+    url = URI.encode(url)
+    uri = URI.parse(url)
+    response = @client.get(uri)
+    if response['success']
+      return JSON.parse(response.body)
+    else
+      return response['error']
+    end
+  end
+
+  # Parses a basic ban result into a formatted hash.
+  # @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.
+  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 }
+        ]
+      end
+    end
+
+    return nil if ret.empty?
+    return ret
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: fishbans
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eli Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Accessing the Fishbans Minecraft API through HTTPClient. Has methods
+  for all Fishban APIs.
+email: elifosterwy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- lib/fishbans.rb
+homepage: https://github.com/elifoster/fishbans-rb
+licenses:
+- CC-BY-NC-ND-4.0
+metadata:
+  issue_tracker: https://github.com/elifoster/fishbans-rb/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for accessing the Fishbans Minecraft API.
+test_files: []