kagerator 1.0.0 → 1.0.1

data/README.md

@@ -7,9 +7,25 @@ Consumes the KAG API.
 <pre>
 require 'kagerator'
 
+# player info
 player = Kagerator.player("splittingred")
 puts player[:playerInfo][:status]
 
+# server info
 server = Kagerator.server("74.91.114.49",50301)
 puts server[:serverStatus][:description]
+
+# server list
+servers = Kagerator.servers({:empty => 0,:full => 0})
+servers[:serverList].each do |server|
+  puts server[:serverName]+'<br />'
+end
 </pre>
+
+## Info
+
+Written by Shaun McCormick
+
+Uses RestClient, SymbolTable and JSON gems, with RSpec for testing
+
+Released under the GPLv2 or later License: http://www.gnu.org/licenses/gpl-2.0.html

data/lib/kagerator/request.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__)+'/response'
 
 module Kagerator
   include RestClient
+  API_URL = 'https://api.kag2d.com/'
 
   class Request
     def self.execute(args, &block)
@@ -21,7 +22,7 @@ module Kagerator
     end
 
     def execute &block
-      response = ::RestClient.send(@method,'https://api.kag2d.com/'+@url)
+      response = ::RestClient.send(@method,API_URL+@url)
       if block_given?
         block.call(response, self, & block)
       end

data/lib/kagerator/version.rb

@@ -1,4 +1,4 @@
 module Kagerator
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   def self.version; VERSION; end
 end

data/lib/kagerator.rb

@@ -1,6 +1,15 @@
 require File.dirname(__FILE__) + '/kagerator/request'
-
+##
+# The main Kagerator class for consumption
+#
 module Kagerator
+  ##
+  # Get a player information
+  #
+  # @param [String] name The username of the player
+  # @param [Boolean] load_avatar Whether or not to add the avatar to the data loaded. Makes another HTTP request to the API
+  # @return [SymbolTable] A hash of the player data
+  #
   def self.player(name,load_avatar = true)
     player = Kagerator::Request.execute({
       :url => "player/#{name}/status",
@@ -24,15 +33,32 @@ module Kagerator
   end
 
   ##
-  # @TODO: filtering with args
+  # Get a list of servers, filtered by any arguments
+  #
+  # @param [Hash] args A hash of arguments to filter with
+  # @return [SymbolTable] An array of hashes of results
+  #
   def self.servers(args = {})
+    qs = ''
+    if args.class == Hash or args.class == SymbolTable
+      args.each do |k,v|
+        qs += '/'+k.to_s+'/'+v.to_s
+      end
+    end
     servers = Kagerator::Request.execute({
-      :url => "servers/connectable/1",
+      :url => "servers/connectable/1"+qs,
       :method => :get
     })
     servers.from_json
   end
 
+  ##
+  # Get information about a specific server
+  #
+  # @param [String] ip The IP address of the server, in ipv4 or ipv6 format
+  # @param [String|Integer] port The port of the server
+  # @return [SymbolTable] A hash of the server variables
+  #
   def self.server(ip,port = 50301)
     server = Kagerator::Request.execute({
       :url => "server/ip/#{ip}/port/#{port}/status",

metadata

@@ -2,7 +2,7 @@
 name: kagerator
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Shaun McCormick