kag 0.0.1

data/spec/fixtures/kag_cassettes/normal.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.kag2d.com/player/prostosuper/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 301
+      message: Moved Permanently
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Thu, 26 Apr 2012 12:26:50 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Location:
+      - https://api.kag2d.com/player/prostosuper/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 26 Apr 2012 12:26:45 GMT
+- request:
+    method: get
+    uri: https://api.kag2d.com/player/prostosuper/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Thu, 26 Apr 2012 12:26:50 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"active": true, "username": "prostosuper", "banned": false, "role":
+        0, "gold": true}'
+    http_version: 
+  recorded_at: Thu, 26 Apr 2012 12:26:46 GMT
+recorded_with: VCR 2.1.1

data/spec/fixtures/kag_cassettes/player.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.kag2d.com/player/prostosuper/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 301
+      message: Moved Permanently
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Fri, 27 Apr 2012 09:24:12 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Location:
+      - https://api.kag2d.com/player/prostosuper/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Fri, 27 Apr 2012 09:24:06 GMT
+- request:
+    method: get
+    uri: https://api.kag2d.com/player/prostosuper/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Fri, 27 Apr 2012 09:24:12 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"active": true, "username": "prostosuper", "banned": false, "role":
+        0, "gold": true}'
+    http_version: 
+  recorded_at: Fri, 27 Apr 2012 09:24:06 GMT
+recorded_with: VCR 2.1.1

data/spec/fixtures/kag_cassettes/team_member.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.kag2d.com/player/flieslikeabrick/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 301
+      message: Moved Permanently
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Thu, 26 Apr 2012 12:26:51 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Location:
+      - https://api.kag2d.com/player/flieslikeabrick/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 26 Apr 2012 12:26:46 GMT
+- request:
+    method: get
+    uri: https://api.kag2d.com/player/flieslikeabrick/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Thu, 26 Apr 2012 12:26:52 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"active": true, "username": "FliesLikeABrick", "banned": false,
+        "role": 4, "gold": true}'
+    http_version: 
+  recorded_at: Thu, 26 Apr 2012 12:26:47 GMT
+recorded_with: VCR 2.1.1

data/spec/fixtures/kag_cassettes/tester.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.kag2d.com/player/incarnum/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 301
+      message: Moved Permanently
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Thu, 26 Apr 2012 12:26:52 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Location:
+      - https://api.kag2d.com/player/incarnum/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 26 Apr 2012 12:26:47 GMT
+- request:
+    method: get
+    uri: https://api.kag2d.com/player/incarnum/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.0.5
+      Date:
+      - Thu, 26 Apr 2012 12:26:53 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"active": true, "username": "incarnum", "banned": false, "role":
+        5, "gold": true}'
+    http_version: 
+  recorded_at: Thu, 26 Apr 2012 12:26:48 GMT
+recorded_with: VCR 2.1.1

data/spec/lib/kag/avatar_spec.rb

@@ -0,0 +1,133 @@
+require_relative '../../spec_helper'
+
+describe KAG::Player::Avatar do
+
+  describe 'GET avatar info' do
+    let (:avatar) { KAG::Player::Avatar.new('prostosuper') }
+
+    before do
+      VCR.insert_cassette 'avatar', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it 'records the fixture' do
+      KAG.get('/player/prostosuper/avatar')
+    end
+
+    it 'must have the sizes method' do
+      avatar.must_respond_to :sizes
+    end
+
+    it 'must parse the API response from JSON to Hash' do
+      avatar.sizes.must_be_instance_of Hash
+    end
+
+    it 'must perform request and get the small avatar URL' do
+      avatar.sizes['small'].must_equal 'https://forum.kag2d.com/data/avatars/s/0/231.jpg'
+    end
+
+    it 'must perform request and get the medium avatar URL' do
+      avatar.sizes['medium'].must_equal 'https://forum.kag2d.com/data/avatars/m/0/231.jpg'
+    end
+
+    it 'must perform request and get the large avatar URL' do
+      avatar.sizes['large'].must_equal 'https://forum.kag2d.com/data/avatars/l/0/231.jpg'
+    end
+
+    describe 'GET specific avatar sizes' do
+
+      describe 'small size' do
+        before do
+          VCR.insert_cassette 'avatar_s', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          KAG.get('/player/prostosuper/avatar/s')
+        end
+
+        it 'must retrieve only small avatar size' do
+          avatar.small.must_equal 'https://forum.kag2d.com/data/avatars/s/0/231.jpg'
+        end
+      end
+
+      describe 'medium size' do
+        before do
+          VCR.insert_cassette 'avatar_m', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          KAG.get('/player/prostosuper/avatar/m')
+        end
+
+        it 'must retrieve only medium avatar size' do
+          avatar.medium.must_equal 'https://forum.kag2d.com/data/avatars/m/0/231.jpg'
+        end
+      end
+
+      describe 'large size' do
+        before do
+          VCR.insert_cassette 'avatar_l', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          KAG.get('/player/prostosuper/avatar/l')
+        end
+
+        it 'must retrieve only large avatar size' do
+          avatar.large.must_equal 'https://forum.kag2d.com/data/avatars/l/0/231.jpg'
+        end
+      end
+
+    end # GET specific sizes
+
+    describe 'nonexistent avatar nick' do
+      let (:avatar) { KAG::Player::Avatar.new('foobarbazbaz') }
+
+      it 'must return statusMessage telling that player not found' do
+        not_found_message = 'Player not found'
+
+        avatar.small['statusMessage'].must_equal  not_found_message
+        avatar.medium['statusMessage'].must_equal not_found_message
+        avatar.large['statusMessage'].must_equal  not_found_message
+        avatar.sizes['statusMessage'].must_equal  not_found_message
+
+        avatar.sizes['small'].must_be_nil
+        avatar.sizes['medium'].must_be_nil
+        avatar.sizes['large'].must_be_nil
+      end
+    end
+
+    describe 'caching' do
+      before do
+        avatar.sizes
+        stub_request(:any, /api.kag2d.com/).to_timeout
+      end
+
+      it 'must cache sizes' do
+        avatar.sizes.must_be_instance_of Hash
+      end
+
+      it 'must refresh sizes if forced' do
+        lambda { avatar.sizes(true) }.must_raise Timeout::Error
+      end
+    end
+
+
+  end # GET avatar info
+
+end

data/spec/lib/kag/kag_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../spec_helper'
+
+describe KAG do
+
+  describe 'default attributes' do
+    it 'must include HTTPparty methods' do
+      KAG.must_include HTTParty
+    end
+
+    it 'must have the base URL set to the KAG API' do
+      KAG.base_uri.must_equal 'http://api.kag2d.com'
+    end
+  end
+
+end

data/spec/lib/kag/player_spec.rb

@@ -0,0 +1,258 @@
+require_relative '../../spec_helper'
+
+describe KAG::Player do
+
+  describe 'default instance attributes' do
+    let(:player) { KAG::Player.new('prostosuper') }
+
+    before do
+      VCR.insert_cassette 'avatar', :record => :none
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it 'must have an id attribute' do
+      player.must_respond_to :nick
+    end
+
+    it 'must have the right id' do
+      player.nick.must_equal 'prostosuper'
+    end
+
+    it 'must have avatar attribute' do
+      player.must_respond_to :avatar
+    end
+
+    it 'must have the right avatar' do
+      player.avatar.small.must_equal 'https://forum.kag2d.com/data/avatars/s/0/231.jpg'
+    end
+  end
+
+  describe 'GET info' do
+    let (:player) { KAG::Player.new('prostosuper') }
+
+    before do
+      VCR.insert_cassette 'player', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it 'records the fixture' do
+      KAG.get('/player/prostosuper/info')
+    end
+
+    it 'must have the info method' do
+      player.must_respond_to :info
+    end
+
+    it 'must parse the API response from JSON to Hash' do
+      player.info.must_be_instance_of Hash
+    end
+
+    it 'must perform the request and get the info' do
+      player.info['username'].must_equal 'prostosuper'
+    end
+
+    describe 'JSON player attributes' do
+      before do
+        player.info
+      end
+
+      it 'must return status of the player (active or not)' do
+        player.active?.must_equal true
+      end
+
+      it 'must return username of the player' do
+        player.username.must_equal 'prostosuper'
+      end
+
+      it 'must return ban status of the player (banned or not)' do
+        player.banned?.must_equal false
+      end
+
+      it 'must return account status (gold or not)' do
+        player.gold?.must_equal true
+      end
+
+      describe 'banned players' do
+        let (:banned_player) { KAG::Player.new('tiffou') }
+
+        before do
+          VCR.insert_cassette 'banned_player', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          KAG.get('/player/tiffou/info')
+        end
+
+        it 'must return DateTime for ban expiration date' do
+          banned_player.ban_expiration.must_be_instance_of DateTime
+        end
+
+        it 'must return ban expiration date' do
+          banned_player.ban_expiration.must_equal DateTime.parse('2022/03/02 09:09:53')
+        end
+
+        it 'must return String for ban reason' do
+          banned_player.ban_reason.must_be_instance_of String
+        end
+
+        it 'must return ban reason' do
+          banned_player.ban_reason.must_equal 'cheating - speedhack.'
+        end
+      end
+
+      describe 'roles' do
+
+        describe 'normal role' do
+          let(:normal) { KAG::Player.new('prostosuper') }
+
+          before do
+            VCR.insert_cassette 'normal', :record => :new_episodes
+          end
+
+          after do
+            VCR.eject_cassette
+          end
+
+          it 'records the fixture' do
+            KAG.get('/player/prostosuper/info')
+          end
+
+          it 'must return numeric role of the player' do
+            normal.role.must_equal 0
+          end
+
+          it 'must return human-readable role of the player' do
+            normal.role(true).must_equal 'normal'
+          end
+        end
+
+        describe 'developer role' do
+          let(:developer) { KAG::Player.new('mm') }
+
+          before do
+            VCR.insert_cassette 'developer', :record => :new_episodes
+          end
+
+          after do
+            VCR.eject_cassette
+          end
+
+          it 'records the fixture' do
+            KAG.get('/player/mm/info')
+          end
+
+          it 'must return numeric role of the player' do
+            developer.role.must_equal 1
+          end
+
+          it 'must return human-readable role of the player' do
+            developer.role(true).must_equal 'developer'
+          end
+        end
+
+        describe 'guard role' do
+          let(:guard) { KAG::Player.new('dnmr') }
+
+          before do
+            VCR.insert_cassette 'guard', :record => :new_episodes
+          end
+
+          after do
+            VCR.eject_cassette
+          end
+
+          it 'records the fixture' do
+            KAG.get('/player/dnmr/info')
+          end
+
+          it 'must return numeric role of the player' do
+            guard.role.must_equal 2
+          end
+
+          it 'must return human-readable role of the player' do
+            guard.role(true).must_equal 'guard'
+          end
+        end
+
+        # KAG Staff role is undecided:  https://wiki.kag2d.com/wiki/Role
+        # describe 'staff role' do
+        # end
+
+        describe 'team member role' do
+          let(:team_member) { KAG::Player.new('flieslikeabrick') }
+
+          before do
+            VCR.insert_cassette 'team_member', :record => :new_episodes
+          end
+
+          after do
+            VCR.eject_cassette
+          end
+
+          it 'records the fixture' do
+            KAG.get('/player/flieslikeabrick/info')
+          end
+
+          it 'must return numeric role of the player' do
+            team_member.role.must_equal 4
+          end
+
+          it 'must return human-readable role of the player' do
+            team_member.role(true).must_equal 'team member'
+          end
+        end
+
+        describe 'tester role' do
+          let(:tester) { KAG::Player.new('incarnum') }
+
+          before do
+            VCR.insert_cassette 'tester', :record => :new_episodes
+          end
+
+          after do
+            VCR.eject_cassette
+          end
+
+          it 'records the fixture' do
+            KAG.get('/player/incarnum/info')
+          end
+
+          it 'must return numeric role of the player' do
+            tester.role.must_equal 5
+          end
+
+          it 'must return human-readable role of the player' do
+            tester.role(true).must_equal 'tester'
+          end
+
+        end
+      end # roles
+    end # JSON player attributes
+
+    describe 'caching' do
+      before do
+        player.info
+        stub_request(:any, /api.kag2d.com/).to_timeout
+      end
+
+      it 'must cache the info' do
+        player.info.must_be_instance_of Hash
+      end
+
+      it 'must refresh the info if forced' do
+        lambda { player.info(true) }.must_raise Timeout::Error
+      end
+    end
+  end
+
+end