kag 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.rake_tasks~

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gem 'httparty', '~>0.8.3'
+
+group :test do
+  gem 'rake'
+  gem 'webmock', '>=1.8.6'
+  gem 'vcr', '>=2.1.1'
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    crack (0.3.1)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.3.2)
+    multi_xml (0.4.4)
+    rake (0.9.2.2)
+    vcr (2.1.1)
+    webmock (1.8.6)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty (~> 0.8.3)
+  rake
+  vcr (>= 2.1.1)
+  webmock (>= 1.8.6)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Kyrylo Silin
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source distribution.

data/README.md

@@ -0,0 +1,47 @@
+KAG
+===
+
+* [https://github.com/kyrylo/ruby-kag/][rkag]
+
+Description
+-----------
+
+This is [King Arthur's Gold][kag] API wrapper implemented in Ruby language.
+
+Features
+--------
+
+* Ability to retrieve information about player (nick, role and so on)
+* Ability to retrieve player's avatar on [KAG forums][kagf]
+
+Installation
+------------
+
+    gem install ruby-kag
+
+Synopsis
+--------
+
+``` ruby
+require 'kag'
+
+player = KAG::Player.new('prostosuper')
+
+# Get small avatar of player prostosuper
+player.avatar.small
+
+# Force request to API to refresh player's small avatar
+player.avatar.small(true)
+
+# Get all information about player
+player.info
+```
+
+License
+-------
+
+The project uses Zlib License. See LICENSE file for more information.
+
+[rkag]: https://github.com/kyrylo/ruby-kag/ "Home page"
+[kag]: http://kag2d.com/
+[kagf]: https://forum.kag2d.com/

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/kag/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/kag.gemspec

@@ -0,0 +1,31 @@
+require './lib/kag/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'kag'
+  s.version      = KAG::VERSION
+  s.date         = Time.now.strftime('%Y-%m-%d')
+  s.summary      = "King Arthur's Gold (KAG) game API wrapper written in Ruby."
+  s.author       = 'Kyrylo Silin'
+  s.email        = 'kyrylosilin@gmail.com'
+  s.homepage     = 'https://github.com/kyrylo/ruby-kag'
+  s.license      = 'zlib'
+
+  s.require_path = 'lib'
+  s.files        = `git ls-files`.split "\n"
+  s.test_files   = `git ls-files -- spec`.split "\n"
+
+  s.extra_rdoc_files = %W{README.md LICENSE}
+  s.rdoc_options     = ["--charset=UTF-8"]
+
+  s.add_runtime_dependency     'httparty', '~>0.8.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'webmock',  '>=1.8.6'
+  s.add_development_dependency 'vcr',      '>=2.1.1'
+
+  s.required_ruby_version = '~>1.9'
+
+  s.description  = <<description
+    Ruby implementation of King Arthur's Gold (aka KAG) Application Programming
+    Interface (aka API).
+description
+end

data/lib/kag.rb

@@ -0,0 +1,4 @@
+require_relative 'kag/kag'
+require_relative 'kag/version'
+require_relative 'kag/player'
+require_relative 'kag/avatar'

data/lib/kag/avatar.rb

@@ -0,0 +1,115 @@
+module KAG
+  # https://wiki.kag2d.com/wiki/Avatar_URL
+  class Player::Avatar
+    # Public: Initialize a new avatar.
+    #
+    # nick - The case-insensitive name of the avatar owner.
+    def initialize(nick)
+      @nick = nick
+    end
+
+    # Public: Retrieve avatar information about KAG player.
+    #
+    # force - The flag which enables/disables caching of the avatars. Being
+    #         equal to true, disables caching and resend GET request to KAG API
+    #         endpoint (default: false).
+    #
+    # Returns Hash with avatar sizes of the player or Hash with statusMessage,
+    # if the player doesn't exist.
+    def sizes(force = false)
+      if force
+        @sizes = get_avatar
+      else
+        @sizes ||= get_avatar
+      end
+    end
+
+    # Internal: Intercepts all method calls on instances of this class, that
+    # aren't defined here. If the called method coincides with one of the valid
+    # methods, then it gets the value of that Hash pair from @sizes Hash. If
+    # the parameter true was provided, then the method performs a request
+    # directly to API rather than to cache.
+    #
+    # force - If equals to true, then request an avatar from API. If false, then
+    #         use avatar from cache (default: false).
+    #
+    # Examples
+    #
+    #   avatar.foo_bar_baz
+    #   # => NoMethodError
+    #   avatar.small
+    #   # => "https://forum.kag2d.com/data/avatars/s/0/231.jpg"
+    #
+    #   # From cache.
+    #   avatar.small
+    #   # => "https://forum.kag2d.com/data/avatars/s/0/231.jpg"
+    #
+    #   # Refresh cache.
+    #   avatar.small(true)
+    #   # => "https://forum.kag2d.com/data/avatars/s/0/231.jpg"
+    #
+    #   # Attempt to get an avatar of nonexistent player.
+    #   nonexistent_avatar = KAG::Player::Avatar.new('foobarbazbaz')
+    #   nonexistent_avatar.small
+    #   # => {"statusMessage"=>"Player not found"}
+    #
+    # Returns the value of the method call on self.
+    # Raises NoMethodError, if the given method doesn't exist.
+    def method_missing(m, *args, &block)
+      valid_method = [:small, :medium, :large].find { |size| size === m }
+
+      if valid_method
+        if args[0] === true
+          send("get_#{m}_avatar")
+        else
+          sizes.fetch(m.to_s) { sizes }
+        end
+      else
+        super
+      end
+    end
+
+    protected
+
+    # Internal: Send GET request to the KAG API endpoint in order to get
+    # player's avatars (small, medium, large).
+    #
+    # Returns Hash with the information about avatars or Hash with
+    # statusMessage, telling, that player doesn't exist, if there is no KAG
+    # player with given nick.
+    def get_avatar
+      KAG.get "/player/#@nick/avatar"
+    end
+
+    # Internal: Send GET request to the KAG API endpoint in order to get
+    # player's small avatar.
+    #
+    # Returns Hash with the information about avatars or Hash with
+    # statusMessage, telling, that player doesn't exist, if there is no KAG
+    # player with given nick.
+    def get_small_avatar
+      KAG.get "/player/#@nick/avatar/s"
+    end
+
+    # Internal: Send GET request to the KAG API endpoint in order to get
+    # player's medium avatar.
+    #
+    # Returns Hash with the information about avatars or Hash with
+    # statusMessage, telling, that player doesn't exist, if there is no KAG
+    # player with given nick.
+    def get_medium_avatar
+      KAG.get "/player/#@nick/avatar/m"
+    end
+
+    # Internal: Send GET request to the KAG API endpoint in order to get
+    # player's large avatar.
+    #
+    # Returns Hash with the information about avatars or Hash with
+    # statusMessage, telling, that player doesn't exist, if there is no KAG
+    # player with given nick.
+    def get_large_avatar
+      KAG.get "/player/#@nick/avatar/l"
+    end
+
+  end
+end

data/lib/kag/kag.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+module KAG
+  include HTTParty
+
+  # Internal: KAG API URI (JAFAs all the way!)
+  API = 'http://api.kag2d.com'
+
+  base_uri API
+end

data/lib/kag/player.rb

@@ -0,0 +1,174 @@
+module KAG
+  # https://wiki.kag2d.com/wiki/Player_Info
+  class Player
+    # Public: Returns the String name of the player.
+    attr_reader :nick
+
+    # Public: Returns the KAG::Player::Avatar object.
+    attr_reader :avatar
+
+    # Public: Initialize a new player.
+    #
+    # nick - The case-insensitive name of the player in King Arthur's Gold game.
+    def initialize(nick)
+      @nick   = nick
+      @avatar = Avatar.new(nick)
+    end
+
+    # Public: Retrieve information about KAG player.
+    #
+    # force - The flag which enables/disables caching of the info. Being equal
+    #         to true, disables caching and resend GET request to KAG API
+    #         endpoint (default: false).
+    #
+    # Examples
+    #
+    #   player.info
+    #   player.info(true) # Disable cached info
+    #
+    # Returns Hash with info about player or Hash with statusMessage, if the
+    # player doesn't exist..
+    def info(force = false)
+      if force
+        @info = get_info
+      else
+        @info ||= get_info
+      end
+    end
+
+    # Public: Get the status of the player.
+    #
+    # Examples
+    #
+    #   player.active?
+    #   # => false
+    #
+    # Returns true or false.
+    def active?
+      info['active']
+    end
+
+    # Public: Get the username of the player.
+    #
+    # Examples
+    #
+    #   player.username
+    #   # => 'prostosuper'
+    #
+    #   # Please, note, that KAG::Player#username is not alias for
+    #   # KAG::Player#nick. KAG::Player#username is the name, which is given by
+    #   # KAG API and Player#nick is an attribute of your object. Feel the
+    #   # difference:
+    #   # player = KAG::Player.new('flieslikeabrick')
+    #   # player.username
+    #   # => 'FliesLikeABrick'
+    #   # player.nick
+    #   # => 'flieslikeabrick'
+    #
+    # Returns String with containing name of the user in game.
+    def username
+      info['username']
+    end
+
+    # Public: Get the ban status of the player.
+    #
+    # Examples
+    #
+    #   player.banned?
+    #   # => true
+    #
+    # Returns true or false.
+    def banned?
+      info['banned']
+    end
+
+    # Public: Get the role of the player.
+    #
+    # readable - The Boolean flag, which describes how the return value should
+    #            be represented (either machine-readable format or
+    #            human-readable) (default: false).
+    #
+    # Examples
+    #
+    #   # Machine-readable role.
+    #   player.role
+    #   # => 4
+    #
+    #   # Human-readable role.
+    #   player.role(true)
+    #   # => 'team member'
+    #
+    # Returns Integer, representing role of the player or String, if readable
+    # flag was used.
+    def role(readable = false)
+      role = info['role']
+
+      if readable
+        case role
+        when 0 then 'normal'
+        when 1 then 'developer'
+        when 2 then 'guard'
+        when 4 then 'team member'
+        when 5 then 'tester'
+        end
+      else
+        role
+      end
+    end
+
+    # Public: Check for account type of the player. Owners of gold account
+    # bought the game.
+    #
+    # Examples
+    #
+    #   player.gold?
+    #   # => false
+    #
+    # Returns true if the player has gold account or false otherwise.
+    def gold?
+      info['gold']
+    end
+
+    # Public: Get the ban expiration date if user was banned. This field is
+    # appears only for banned users.
+    #
+    # Examples
+    #
+    #   player.ban_expiration
+    #   # => #<DateTime: 2022-03-02T09:09:53+00:00 ((2459641j,32993s,0n),+0s,2299161j)>
+    #
+    # Returns DateTime object, which has ban expiration date of the player or
+    # nil, if the player has no active bans.
+    def ban_expiration
+      ban_expiration_date = info['banExpiration']
+      DateTime.parse ban_expiration_date if ban_expiration_date
+    end
+
+    # Public: Get the ban reason if user was banned. This field is appears only
+    # for banned users.
+    #
+    # Examples
+    #
+    #   player.ban_reason
+    #   # => 'Speedhacking'
+    #
+    # Returns String object, which represents description of the ban if any bans
+    # are active.
+    def ban_reason
+      info['banReason']
+    end
+
+    protected
+
+    # Internal: Send GET request to the KAG API endpoint in order to get the
+    # information about KAG player.
+    #
+    # Returns Hash with the information about player or Hash with statusMessage,
+    # telling, that player doesn't exist, if there is no KAG player with given
+    # nick.
+    def get_info
+      KAG.get "/player/#@nick/info"
+    end
+
+  end
+end