board-game-gem 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc068b33bb86956486f67fd7361578490a65ccb8
-  data.tar.gz: 630af575a044c82480b02fe8cfa8e3d0ca9d889d
+  metadata.gz: d084e0f7625cd38c06127158de1f1c32ae833992
+  data.tar.gz: 48f6aa31a49d6ae62ab5daf4580447a5b2108f33
 SHA512:
-  metadata.gz: dfb84f9b20fe3ec8326402e5374f6cd0861efb887ddc6effe1ce4b3de664a9160216613f1cf266bfc947b223680dccebfe82a0767cf471100c22b9bb47dab609
-  data.tar.gz: 1a3abbffb70a69dcfd56de1792f121657abe45cf2635d7b38a5f5e60ec48145caba4d7fc02180505318e18fb0141b131d0ad7fa1bad27f6615989a149b07c4af
+  metadata.gz: 8f674af38a2287eca67f0a2975a13a66a7abdba71eddc77df98c9921e94680338a6c69b822c3b5d60a0bf918cc617627512395d5c8aea78f73324dd06ec225e0
+  data.tar.gz: 7633aead387e96650ce34dbc3e83127a5cb0d5c39b2863fa514cf71c2019f38012379921b80589f5b2a5051691e3c4a0f4fd1f529e5518a0c240b9dec03f1797

data/README.md

@@ -25,25 +25,29 @@ The `options` argument is a hash which allows any other parameter. For example,
 
 ---
 
-`get_item(id, [statistics], [options])`: Retreive a specific item from BGG by ID. Within the BGG API, this is called a 'thing' rather than an 'item'. If an item with that ID is not found, `nil` is returned.
+`get_item(id, [statistics], [api] [options])`: Retreive a specific item from BGG by ID. Within the BGG API, this is called a 'thing' rather than an 'item'. If an item with that ID is not found, `nil` is returned.
 
-If `statistics` is true, averages, weights, and rankings will be retrieved as well. By default, `statistics` is false.
+If `statistics` is true, averages, weights, and rankings will be retrieved as well. By default, `statistics` is false and `api` is 2.
 
 `get_item` returns a `BGGItem` object, which has the following attributes:
-`:id, :type, :thumbnail, :name, :description, :year_published, :min_players, :max_players,
-:playing_time, :min_playing_time, :max_playing_time, :statistics`. 
+`id, api, type, thumbnail, name, alternate_names, description, year_published, min_players, max_players,
+playing_time, min_playing_time, max_playing_time, statistics`. If `api` is 1, `alternate_names` will always be `nil`.
 
-`:statistics` is a hash, with the following keys: `:user_ratings, :average, :bayes, :ranks, :stddev, :median, :owned, :trading, :wanted, :wishing, :num_comments, :num_weights, :average_weight`. Within this, `:ranks` is an array, containing hashes with the following keys: `:type, :name, :friendly_name, :value, :bayes`.
+`statistics` is a hash, with the following keys: `:user_ratings, :average, :bayes, :ranks, :stddev, :median, :owned, :trading, :wanted, :wishing, :num_comments, :num_weights, :average_weight`. Within this, `:ranks` is an array, containing hashes with the following keys: `:type, :name, :friendly_name, :value, :bayes`.
+
+`get_items(ids, [statistics], [api], [options])` exists as well, which is functionally equivelent to `get_item`, except it takes
+an array of IDs and returns an array of `BGGItem` objects. `get_items` should be used when making many requests in succession,
+as it makes one HTTP request for the batch.
 
 ---
 
-`get_family(id, [options])`: Retrieves information on a data family. Returns a `BGGFamily` object, which has the following attributes: `:id, :thumbnail, :image, :name, :alternate_names, :description`. Within this, `:alternate_names` is an array of strings. If a family with that ID is not found, `nil` is returned.
+`get_family(id, [options])`: Retrieves information on a data family. Returns a `BGGFamily` object, which has the following attributes: `id, thumbnail, image, name, alternate_names, description`. Within this, `alternate_names` is an array of strings. If a family with that ID is not found, `nil` is returned.
 
 ---
 
 `get_user(username, [options])`: Retreives information on a specific user by name. If a user with that name does not exist, `nil` is returned.
 
-`get_user` returns a `BGGUser` object, which has the following attributes: `:id, :name, :avatar, :year_registered, :last_login, :state, :trade_rating`
+`get_user` returns a `BGGUser` object, which has the following attributes: `id, name, avatar, year_registered, last_login, state, trade_rating`
 
 #### Methods
 `get_collection`: Returns this user's collection, as if `BoardGameGem.get_collection` was called using this user's name.
@@ -71,17 +75,17 @@ The BGG API queues requests to retrieve a user's collection, returning a 202 sta
 
 #### BGGCollectionItem
 
-The BGG API returns a subset of an item's data when including it in a collection request. As a result, a `BGGCollectionItem` contains the following attributes: `:id, :type, :name, :year_published, :image, :thumbnail, :num_players, :status, :num_plays`. Within this, `:status` is a hash containing the following keys: `:own, :prev_owned, :for_trade, :want, :want_to_play, :want_to_buy, :wishlist, :preordered:, :last_modified`. 
+The BGG API returns a subset of an item's data when including it in a collection request. As a result, a `BGGCollectionItem` contains the following attributes: `id, type, name, year_published, image, thumbnail, num_players, status, num_plays`. Within this, `status` is a hash containing the following keys: `:own, :prev_owned, :for_trade, :want, :want_to_play, :want_to_buy, :wishlist, :preordered:, :last_modified`. 
 
 `BGGCollectionItem` contains one other method, `to_item([statistics])`, which returns the `BGGItem` version of this object.
 
 ---
 
-`search(query, [options])`: Performs a search request, returning any items which are like the query. Returns a hash with the keys `:total`, the number of items found in the search, and `:items`, an array of `BGGSearchResult` objects.
+`search(query, [options])`: Performs a search request, returning any items which are like the query. Returns a hash with the keys `total`, the number of items found in the search, and `items`, an array of `BGGSearchResult` objects.
 
 #### BGGSearchResult
 
-Much like `BGGCollectionItem`, `BGGSearchResult` is a subset of `BGGItem`, and contains the following attributes: `:id, :type, :name, :year_published`.
+Much like `BGGCollectionItem`, `BGGSearchResult` is a subset of `BGGItem`, and contains the following attributes: `id, type, name, year_published`.
 
 A `BGGItem` version of this object can be requested with `to_item([statistics])`.
 

data/lib/bgg_collection.rb

@@ -1,7 +1,7 @@
 module BoardGameGem
 	class BGGCollection < BGGBase
 
-		attr_reader :count, :items
+		attr_accessor :count, :items
 
 		def initialize(xml)
 			if !xml.nil?

data/lib/board-game-gem.rb

@@ -69,13 +69,13 @@ module BoardGameGem
 
 	def self.request_xml(method, hash, api = 2)
 		params = BoardGameGem.hash_to_uri(hash)
+		if api == 2
+			api_path = "#{API_2_ROOT}/#{method}?#{params}"
+		else
+			api_path = "#{API_1_ROOT}/#{method}/#{hash[:id]}?stats=#{hash[:stats] ? 1 : 0}"
+		end
+		p api_path
 		value = BoardGameGem.retryable(tries: MAX_ATTEMPTS, on: OpenURI::HTTPError) do
-			if api == 2
-				api_path = "#{API_2_ROOT}/#{method}?#{params}"
-			else
-				api_path = "#{API_1_ROOT}/#{method}/#{hash[:id]}?stats=#{hash[:stats] ? 1 : 0}"
-			end
-			p api_path
 			open(api_path) do |file|
 				if file.status[0] != "200"
 					sleep 0.05

data/lib/boardgamegem/version.rb

@@ -1,3 +1,3 @@
 module BoardGameGem
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/test.rb

@@ -1,8 +1,2 @@
 require_relative 'lib/board-game-gem'
-#p BoardGameGem.get_items([15944, 15955, 15956]).to_s
-
-p BoardGameGem.get_items([123260, 123265, 61001], true).map { |x| x.type }
-
-
-p BoardGameGem.get_item(123260, true)
-
+p BoardGameGem.get_collection("sos1", subtype: "boardgame,videogame,rpgitem").items.select { |x| x.type == "videogame" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: board-game-gem
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jake Roussel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake