bgg 1.0.0

data/spec/bgg_collection_item_spec.rb

@@ -0,0 +1,259 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Bgg::Collection::Item do
+  let(:item_data) { {'objecttype'=>'thing',
+                     'objectid'=>'70512',
+                     'subtype'=>'boardgame',
+                     'collid'=>'11455824',
+                     'name'=>[{'sortindex'=>'1', 'content'=>'Luna'}],
+                     'yearpublished'=>['2010'],
+                     'image'=>['http://cf.geekdo-images.com/images/pic802342.jpg'],
+                     'thumbnail'=>['http://cf.geekdo-images.com/images/pic802342_t.jpg'],
+                     'status'=>[{'own'=>'1', 'prevowned'=>'0', 'fortrade'=>'0', 'want'=>'0', 'wanttoplay'=>'0', 'wanttobuy'=>'0', "wishlist"=>'0', 'preordered'=>'0', 'lastmodified'=>'2007-02-18 21:20:51'}], 'numplays'=>['7'], 'comment'=>['Never played.']} }
+
+  let(:item) { Bgg::Collection::Item.new(item_data) }
+
+  describe '.id' do
+    it 'exists' do
+      expect( item ).to respond_to(:id)
+    end
+
+    it 'returns correct value' do
+      expect( item.id ).to eq(70512)
+    end
+  end
+
+  describe '.name' do
+    it 'exists' do
+      expect( item ).to respond_to(:name)
+    end
+
+    it 'returns the correct value' do
+      expect( item.name ).to eq('Luna')
+    end
+  end
+
+  describe '.collection_id' do
+    it 'exists' do
+      expect( item ).to respond_to(:collection_id)
+    end
+
+    it 'returns the correct value' do
+      expect( item.collection_id ).to eq(11455824)
+    end
+  end
+
+  describe '.owned?' do
+    it 'exists' do
+      expect( item ).to respond_to(:owned?)
+    end
+
+    it 'returns true when own == 1' do
+      item_data['status'][0]['own'] = '1'
+      expect( item.owned? ).to eq(true)
+    end
+
+    it 'returns true when want == 0' do
+      item_data['status'][0]['own'] = '0'
+      expect( item.owned? ).to eq(false)
+    end
+  end
+
+  describe '.wanted?' do
+    it 'exists' do
+      expect( item ).to respond_to(:wanted?)
+    end
+
+    it 'returns true when want == 0' do
+      item_data['status'][0]['want'] = '0'
+      expect( item.wanted? ).to eq(false)
+    end
+
+    it 'returns true when want == 1' do
+      item_data['status'][0]['want'] = '1'
+      expect( item.wanted? ).to eq(true)
+    end
+  end
+
+  describe '.for_trade?' do
+    it 'exists' do
+      expect( item ).to respond_to(:for_trade?)
+    end
+
+    it 'returns false when fortrade == 0' do
+      item_data['status'][0]['fortrade'] = '0'
+      expect( item.for_trade? ).to eq(false)
+    end
+
+    it 'returns true when fortrade == 1' do
+      item_data['status'][0]['fortrade'] = '1'
+      expect( item.for_trade? ).to eq(true)
+    end
+  end
+
+  describe '.played?' do
+    it 'exists' do
+      expect( item ).to respond_to(:played?)
+    end
+
+    it 'returns true when play_count > 0' do
+      item_data['numplays'][0] = '7'
+      expect( item.played? ).to eq(true)
+    end
+
+    it 'returns false when play_count == 0' do
+      item_data['numplays'][0] = '0'
+      expect( item.played? ).to eq(false)
+    end
+  end
+
+  describe '.want_to_buy?' do
+    it 'exists' do
+      expect( item ).to respond_to(:want_to_buy?)
+    end
+
+    it 'returns true when wanttobuy == 1' do
+      item_data['status'][0]['wanttobuy'] = '1'
+      expect( item.want_to_buy? ).to eq(true)
+    end
+
+    it 'returns false when wanttobuy == 0' do
+      item_data['status'][0]['wanttobuy'] = '0'
+      expect( item.want_to_buy? ).to eq(false)
+    end
+  end
+
+  describe '.preordered?' do
+    it 'exists' do
+      expect( item ).to respond_to(:preordered?)
+    end
+
+    it 'returns true when preordered == 1' do
+      item_data['status'][0]['preordered'] = '1'
+      expect( item.preordered? ).to eq(true)
+    end
+
+    it 'returns false when preordered == 0' do
+      item_data['status'][0]['preordered'] = '0'
+      expect( item.preordered? ).to eq(false)
+    end
+  end
+
+  describe '.want_to_play?' do
+    it 'exists' do
+      expect( item ).to respond_to(:want_to_play?)
+    end
+
+    it 'returns true when wanttoplay == 1' do
+      item_data['status'][0]['wanttoplay'] = '1'
+      expect( item.want_to_play? ).to eq(true)
+    end
+
+    it 'returns false when wanttoplay == 0' do
+      item_data['status'][0]['wanttoplay'] = '0'
+      expect( item.want_to_play? ).to eq(false)
+    end
+  end
+
+  describe '.published?' do
+    it 'exists' do
+      expect( item ).to respond_to(:published?)
+    end
+
+    it 'returns true when yearpublished exists' do
+      expect( item.published? ).to eq(true)
+    end
+
+    it 'returns false when yearpublished does not exist' do
+      item_data.delete('yearpublished')
+      expect( item.published? ).to eq(false)
+    end
+  end
+
+  describe '.type' do
+    it 'exists' do
+      expect( item ).to respond_to(:type)
+    end
+
+    it 'returns boardgame when it is a boardgame' do
+      expect( item.type ).to eq('boardgame')
+    end
+  end
+
+  describe '.play_count' do
+    it 'exists' do
+      expect( item ).to respond_to(:play_count)
+    end
+
+    it 'returns the correct value' do
+      expect( item.play_count ).to eq(7)
+    end
+  end
+
+  describe '.year_published' do
+    it 'exists' do
+      expect( item ).to respond_to(:year_published)
+    end
+
+    it 'returns the correct value' do
+      expect( item.year_published ).to eq(2010)
+    end
+
+    it 'returns 0 if it is not published' do
+      item_data.delete('yearpublished')
+      expect( item.year_published ).to eq(0)
+    end
+  end
+
+  describe '.thumbnail' do
+    it 'exists' do
+      expect( item ).to respond_to(:thumbnail)
+    end
+
+    it 'returns the correct value' do
+      expect( item.thumbnail ).to eq('http://cf.geekdo-images.com/images/pic802342_t.jpg')
+    end
+  end
+
+  describe '.image' do
+    it 'exists' do
+      expect( item ).to respond_to(:image)
+    end
+
+    it 'returns the correct value' do
+      expect( item.image ).to eq('http://cf.geekdo-images.com/images/pic802342.jpg')
+    end
+  end
+
+  describe '.comment' do
+    it 'exists' do
+      expect( item ).to respond_to(:comment)
+    end
+
+    it 'returns the correct value' do
+      expect( item.comment ).to eq('Never played.')
+    end
+  end
+
+  describe '.game' do
+    it 'exists' do
+      expect( item ).to respond_to(:game)
+    end
+
+    it 'returns a Bgg::Game object corresponding to the entry' do
+      response_file = 'sample_data/thing?id=70512&type=boardgame'
+      request_url = 'http://www.boardgamegeek.com/xmlapi2/thing'
+
+      stub_request(:any, request_url).
+        with(query: {id: 70512, type: 'boardgame'}).
+        to_return(body: File.open(response_file), status: 200)
+
+      game = item.game
+
+      expect( game ).to be_instance_of(Bgg::Game)
+      expect( game.name ).to eq('Luna')
+      expect( game.designers ).to eq(['Stefan Feld'])
+    end
+  end
+end

data/spec/bgg_collection_spec.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Bgg::Collection do
+  describe 'find_by_username' do
+    it 'throws an ArgumentError when a number is passed in' do
+      expect{ Bgg::Collection.find_by_username(38383) }.to raise_error(ArgumentError)
+    end
+
+    it 'throws an ArgumentError when an empty string is passed in' do
+      expect{ Bgg::Collection.find_by_username('') }.to raise_error(ArgumentError)
+    end
+
+    it 'throws an ArgumentError when a string of only numbers is passed in' do
+      expect{ Bgg::Collection.find_by_username('38383') }.to raise_error(ArgumentError)
+    end
+
+    it 'throws an ArgumentError when a non-existent user is passed in' do
+      response_file = 'sample_data/collection?username=yyyyyyy'
+      request_url = 'http://www.boardgamegeek.com/xmlapi2/collection'
+
+      stub_request(:any, request_url).
+        with(query: {username: 'yyyyyyy'}).
+        to_return(body: File.open(response_file), status: 200)
+
+      expect{ Bgg::Collection.find_by_username('yyyyyyy')}.to raise_error(ArgumentError)
+    end
+
+    it 'creates an object for a collection that exists' do
+      response_file = 'sample_data/collection?username=texasjdl'
+      request_url = 'http://www.boardgamegeek.com/xmlapi2/collection'
+
+      stub_request(:any, request_url).
+        with(query: {username: 'texasjdl'}).
+        to_return(body: File.open(response_file), status: 200)
+
+      collection = Bgg::Collection.find_by_username('texasjdl')
+
+      expect( collection ).to be_a_kind_of(Bgg::Collection)
+      expect( collection.owned.first ).to be_instance_of(Bgg::Collection::Item)
+      expect( collection.owned.first.name ).to eq('& Cetera')
+    end
+  end
+
+  describe 'instance' do
+    let(:collection) { Bgg::Collection.find_by_username('texasjdl') }
+
+    before do
+      response_file = 'sample_data/collection?username=texasjdl'
+      request_url = 'http://www.boardgamegeek.com/xmlapi2/collection'
+
+      stub_request(:any, request_url).
+        with(query: {username: 'texasjdl'}).
+        to_return(body: File.open(response_file), status: 200)
+    end
+
+    it 'has boardgames' do
+      expect( collection.boardgames ).to be_instance_of(Array)
+      expect( collection.boardgames.first ).to be_instance_of(Bgg::Collection::Item)
+      expect( collection.boardgames.count).to eq(604)
+    end
+
+    it 'has boardgame_expansions' do
+      expect( collection.boardgame_expansions ).to be_instance_of(Array)
+      expect( collection.boardgame_expansions.first ).to be_instance_of(Bgg::Collection::Item)
+      expect( collection.boardgame_expansions.count).to eq(37)
+    end
+
+    it 'has played' do
+      expect( collection.played ).to be_instance_of(Array)
+      expect( collection.played.first ).to be_instance_of(Bgg::Collection::Item)
+      expect( collection.played.count).to eq(365)
+    end
+
+    it 'has size' do
+      expect( collection.size ).to eq(604)
+    end
+
+    it 'has count' do
+      expect( collection.count ).to eq(604)
+    end
+  end
+end

data/spec/bgg_game_spec.rb

@@ -0,0 +1,232 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Bgg::Game do
+  describe 'class method' do
+    describe 'find_by_id' do
+      it 'throws an ArgumentError when a non-integer is passed in' do
+        expect{ Bgg::Game.find_by_id('string instead') }.to raise_error(ArgumentError, 'invalid value for Integer(): "string instead"')
+      end
+
+      it 'throws an ArgumentError when a non-positive integer is passed in' do
+        expect{ Bgg::Game.find_by_id(0) }.to  raise_error(ArgumentError, 'game_id must be greater than 0!')
+        expect{ Bgg::Game.find_by_id(-1) }.to raise_error(ArgumentError, 'game_id must be greater than 0!')
+      end
+
+      it 'creates an object for a game that exists' do
+        response_file = 'sample_data/thing?id=84876&type=boardgame'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/thing'
+
+        stub_request(:any, request_url).with(query: {id: 84876, type: 'boardgame'}).to_return(body: File.open(response_file), status: 200)
+        burgund = Bgg::Game.find_by_id(84876)
+
+        expect( burgund ).to be_a_kind_of(Object)
+        expect( burgund.name ).to eq('The Castles of Burgundy')
+        expect( burgund.names ).to match_array(['The Castles of Burgundy', 'Les Châteaux de Bourgogne', 'Die Burgen von Burgund'])
+      end
+
+      it 'throws an ArgumentError for a game that does not exist' do
+        response_file = 'sample_data/thing?id=10000000&type=boardgame'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/thing'
+
+        stub_request(:any, request_url).with(query: {id: 10000000, type: 'boardgame'}).to_return(body: File.open(response_file), status: 200)
+
+        expect{ Bgg::Game.find_by_id(10000000) }.to raise_error(ArgumentError, 'Game does not exist')
+      end
+    end
+  end
+
+  describe 'instance' do
+    let(:burgund) { Bgg::Game.find_by_id(84876) }
+
+    before do
+      response_file = 'sample_data/thing?id=84876&type=boardgame'
+      request_url = 'http://www.boardgamegeek.com/xmlapi2/thing'
+
+      stub_request(:any, request_url).
+        with(query: {id: 84876, type: 'boardgame'}).
+        to_return(body: File.open(response_file), status: 200)
+    end
+
+    describe '.id' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:id)
+      end
+
+      it 'returns the BGG Thing id' do
+        expect( burgund.id ).to eq(84876)
+      end
+    end
+
+    describe '.name' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:name)
+      end
+
+      it 'returns the primary name' do
+        expect( burgund.name ).to eq('The Castles of Burgundy')
+      end
+    end
+
+    describe '.names' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:names)
+      end
+
+      it 'returns a list of all names -- primary and alternates' do
+        expect( burgund.names ).to match_array(['The Castles of Burgundy', 'Les Châteaux de Bourgogne', 'Die Burgen von Burgund'])
+      end
+    end
+
+    describe '.alternate_names' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:alternate_names)
+      end
+
+      it 'returns a list of the alternate/foreign names -- without the primary name' do
+        expect( burgund.alternate_names ).to match_array(['Les Châteaux de Bourgogne', 'Die Burgen von Burgund'])
+      end
+    end
+
+    describe '.artists' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:artists)
+      end
+
+      it 'returns a list of the game artists' do
+        expect( burgund.artists ).to match_array(['Harald Lieske', 'Julien Delval'])
+      end
+    end
+
+    describe '.description' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:description)
+      end
+
+      it 'returns the text description of the game' do
+        expect( burgund.description ).to match(/The game is set in the Burgundy region of High Medieval France\./)
+        expect( burgund.description.length ).to eq(1049)
+      end
+    end
+
+    describe '.designers' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:designers)
+      end
+
+      it 'returns a list of the designers' do
+        expect( burgund.designers ).to match_array(['Stefan Feld'])
+      end
+    end
+
+    describe '.image' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:image)
+      end
+
+      it 'returns a URL to an image for the game' do
+        expect( burgund.image ).to eq('http://cf.geekdo-images.com/images/pic1176894.jpg')
+      end
+    end
+
+    describe '.min_players' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:min_players)
+      end
+
+      it 'returns the minimum number of players' do
+        expect( burgund.min_players ).to eq(2)
+      end
+    end
+
+    describe '.max_players' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:max_players)
+      end
+
+      it 'returns the maximum number of players' do
+        expect( burgund.max_players ).to eq(4)
+      end
+    end
+
+    describe '.minimum_recommended_age' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:recommended_minimum_age)
+      end
+
+      it 'returns the recommended minimum age' do
+        expect( burgund.recommended_minimum_age ).to eq(12)
+      end
+    end
+
+    describe '.playing_time' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:playing_time)
+      end
+
+      it 'has playing_time' do
+        expect( burgund.playing_time ).to eq(90)
+      end
+    end
+
+    describe '.publishers' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:publishers)
+      end
+
+      it 'returns a list of publisher names' do
+        expect( burgund.publishers ).to match_array(['Ravensburger', 'alea'])
+      end
+    end
+
+    describe '.thumbnail' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:thumbnail)
+      end
+
+      it 'returns a URL to a thumbnail' do
+        expect( burgund.thumbnail ).to eq('http://cf.geekdo-images.com/images/pic1176894_t.jpg')
+      end
+    end
+
+    describe '.year_published' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:year_published)
+      end
+
+      it 'returns the only year published' do
+        expect( burgund.year_published ).to eq(2011)
+      end
+    end
+
+    describe '.mechanics' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:mechanics)
+      end
+
+      it 'returns the mechanisms used in the game' do
+        expect( burgund.mechanics ).to match_array(['Dice Rolling', 'Set Collection', 'Tile Placement'])
+      end
+    end
+
+    describe '.categories' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:categories)
+      end
+
+      it 'returns the minimum number of players' do
+        expect( burgund.categories ).to match_array(['Dice', 'Medieval', 'Territory Building'])
+      end
+    end
+
+    describe '.families' do
+      it 'exists' do
+        expect( burgund ).to respond_to(:families)
+      end
+
+      it 'returns the minimum number of players' do
+        expect( burgund.families ).to match_array(['Alea Big Box', 'Country: France'])
+      end
+    end
+  end
+end