BoardGameGem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a86f9c4a37fe7b3836e74fef82739dabe3e6c24b
+  data.tar.gz: 6ae5089ea0641f2ead913e8da289c58d8ef43c6c
+SHA512:
+  metadata.gz: fc569af1eaafe2cea670ab293108f6bdf75f5934be1404932402a6fb2f81406fb86416cc80ca76c8cfafb41fc0e2438c91bd13b09643b14a8214ee9c65a32581
+  data.tar.gz: 2e16c83787fbc3d37c2ec2f374430db7aa6d73d0237f43ef797df66f2f1e1340a76ac6d2b806018b9cce16462863c6c83f0c4251f3710c37a4abe67247e9b8c3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jakeroussel@mac.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in boardgamegem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jake Roussel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Boardgamegem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/boardgamegem`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'boardgamegem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install boardgamegem
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/boardgamegem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "boardgamegem"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/boardgamegem.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boardgamegem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "BoardGameGem"
+  spec.version       = BoardGameGem::VERSION
+  spec.authors       = ["Jake Roussel"]
+  spec.email         = ["jakeroussel@mac.com"]
+
+  spec.summary       = %q{Provides a Ruby interface to the BoardGameGeek API}
+  spec.homepage      = "http://www.github.com/acceptableice/boardgamegem"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/bgg_base.rb

@@ -0,0 +1,65 @@
+module BoardGameGem
+	class BGGBase
+		def initialize(xml)
+			@xml = xml
+		end
+
+		def to_s
+			return instance_variables.map{|ivar| "#{ivar} => #{instance_variable_get ivar}" }
+		end
+
+		protected
+
+		def get_value(path, key = nil)
+			item = @xml.at_css(path)
+			if item.nil?
+				return nil
+			end
+			if key.nil?
+				return item.content
+			else
+				return item[key]
+			end
+		end
+
+		def get_values(path, key = nil)
+			results = []
+			@xml.css(path).each do |item|
+				if key.nil?
+					results.push(item.content)
+				else
+					results.push(item[key])
+				end
+			end
+			return results
+		end
+
+		def get_boolean(path, key = nil)
+			return get_integer(path, key) == 1 rescue nil
+		end
+
+		def get_integer(path, key = nil)
+			return get_value(path, key).to_i rescue nil
+		end
+
+		def get_integers(path, key = nil)
+			return get_values(path, key).map {|x| x.to_i } rescue nil
+		end
+
+		def get_string(path, key = nil)
+			return get_value(path, key).to_s rescue nil
+		end
+
+		def get_strings(path, key = nil)
+			return get_values(path, key).map {|x| x.to_s } rescue nil
+		end
+
+		def get_float(path, key = nil)
+			return get_value(path, key).to_f rescue nil
+		end
+
+		def get_datetime(path, key)
+			return DateTime.strptime(get_string(path, key), '%F %T')
+		end
+	end
+end

data/lib/bgg_collection.rb

@@ -0,0 +1,48 @@
+module BoardGameGem
+	class BGGCollection < BGGBase
+
+		attr_reader :count, :items
+
+		def initialize(xml)
+			super
+			@count = get_integer("items", "totalitems")
+			@items = []
+			@xml.css("item").each do |item|
+				@items.push(BGGCollectionItem.new(item))
+			end
+		end
+
+		def get_owned
+			return filter_by(:own)
+		end
+
+		def get_previously_owned
+			return filter_by(:prev_owned)
+		end
+
+		def get_wants
+			return filter_by(:want)
+		end
+
+		def get_want_to_play
+			return filter_by(:want_to_play)
+		end
+
+		def get_want_to_buy
+			return filter_by(:want_to_buy)
+		end
+
+		def get_wishlist
+			return filter_by(:wishlist)
+		end
+
+		def get_preordered
+			return filter_by(:preordered)
+		end
+		private
+
+		def filter_by(key)
+			return @items.select { |x| x.status[key] }
+		end
+	end
+end

data/lib/bgg_collection_item.rb

@@ -0,0 +1,33 @@
+module BoardGameGem
+	class BGGCollectionItem < BGGBase
+
+		attr_reader :id, :type, :name, :year_published, :image, :thumbnail, :num_players, :status, :num_plays
+
+		def initialize(xml)
+			super
+			@id = xml["objectid"].to_i
+			@type = xml["subtype"]
+			@name = get_string("name")
+			@year_published = get_string("yearpublished")
+			@image = get_string("image")
+			@thumbnail = get_string("thumbnail")
+			@num_players = get_string("numplayers")
+			@status = {
+				:own => get_boolean("status", "own"),
+				:prev_owned => get_boolean("status", "prevowned"),
+				:for_trade => get_boolean("status", "fortrade"),
+				:want => get_boolean("status", "want"),
+				:want_to_play => get_boolean("status", "wanttoplay"),
+				:want_to_buy => get_boolean("status", "wanttobuy"),
+				:wishlist => get_boolean("status", "wishlist"),
+				:preordered => get_boolean("status", "preordered"),
+				:last_modified => get_datetime("status", "lastmodified")
+			}
+			@num_plays = get_integer("numplays")
+		end
+
+		def to_item(statistics = false)
+			return BoardGameGem.get_item(@id, statistics)
+		end
+	end
+end

data/lib/bgg_family.rb

@@ -0,0 +1,16 @@
+module BoardGameGem
+	class BGGFamily < BGGBase
+
+		attr_reader :id, :thumbnail, :image, :name, :alternate_names, :description
+
+		def initialize(xml)
+			super
+			@id = get_integer("item", "id")
+			@thumbnail = get_string("thumbnail")
+			@image = get_string("image")
+			@name = get_string("name[type='primary']", "value")
+			@alternate_names = get_strings("name[type='alternate']", "value")
+			@description = get_string("description")
+		end
+	end
+end

data/lib/bgg_item.rb

@@ -0,0 +1,49 @@
+module BoardGameGem
+	class BGGItem < BGGBase
+
+		attr_reader :id, :type, :thumbnail, :name, :description, :year_published, :min_players, :max_players,
+			:playing_time, :min_playing_time, :max_playing_time, :statistics
+
+		def initialize(xml)
+			super
+			@id = get_integer("item", "id")
+			@type = get_string("item", "type")
+			@thumbnail = get_string("thumbnail")
+			@name = get_string("name[type='primary']", "value")
+			@alternate_names = get_strings("name[type='alternate']", "value")
+			@description = get_string("description")
+			@year_published = get_integer("yearpublished", "value")
+			@min_players = get_integer("minplayers", "value")
+			@max_players = get_integer("maxplayers", "value")
+			@playing_time = get_integer("playingtime", "value")
+			@min_playing_time = get_integer("minplaytime", "value")
+			@max_playing_time = get_integer("maxplaytime", "value")
+			@statistics = nil
+			if !@xml.at_css("statistics").nil?
+				@statistics = {}
+				@statistics[:user_ratings] = get_integer("usersrated", "value")
+				@statistics[:average] = get_float("average", "value")
+				@statistics[:bayes] = get_float("bayesaverage", "value")
+				@statistics[:ranks] = []
+				@xml.css("rank").each do |rank|
+					rank_data = {}
+					rank_data[:type] = rank["type"]
+					rank_data[:name] = rank["name"]
+					rank_data[:value] = rank["value"].to_i
+					rank_data[:bayes] = rank["bayesaverage"].to_f
+					@statistics[:ranks].push(rank_data)
+				end
+				@statistics[:stddev] = get_float("stddev", "value")
+				@statistics[:median] = get_float("median", "value")
+				@statistics[:owned] = get_integer("owned", "value")
+				@statistics[:trading] = get_integer("trading", "value")
+				@statistics[:wanting] = get_integer("wanting", "value")
+				@statistics[:wishing] = get_integer("wishing", "value")
+				@statistics[:num_comments] = get_integer("numcomments", "value")
+				@statistics[:num_weights] = get_integer("numweights", "value")
+				@statistics[:average_weight] = get_integer("averageweight", "value")
+			end
+			
+		end
+	end
+end

data/lib/bgg_search_result.rb

@@ -0,0 +1,18 @@
+module BoardGameGem
+	class BGGSearchResult < BGGBase
+
+		attr_reader :id, :type, :name, :year_published
+		
+		def initialize(xml)
+			super
+			@id = xml["id"].to_i
+			@type = xml["type"]
+			@name = get_string("name", "value")
+			@year_published = get_string("yearpublished", "value")
+		end
+
+		def to_item(statistics = false)
+			return BoardGameGem.get_item(@id, statistics)
+		end
+	end
+end

data/lib/bgg_user.rb

@@ -0,0 +1,21 @@
+module BoardGameGem
+	class BGGUser < BGGBase
+
+		attr_reader :id, :name, :avatar, :year_registered, :last_login, :state, :trade_rating
+
+		def initialize(xml)
+			super
+			@id = get_integer("user", "id")
+			@name = get_string("user", "name")
+			@avatar = get_string("avatarlink", "value")
+			@year_registered = get_integer("yearregistered", "value")
+			@last_login = get_string("lastlogin", "value")
+			@state = get_string("stateorprovince", "value")
+			@trade_rating = get_integer("traderating", "value")
+		end
+
+		def get_collection
+			return BoardGameGem.get_collection(@name)
+		end
+	end
+end

data/lib/boardgamegem/version.rb

@@ -0,0 +1,3 @@
+module BoardGameGem
+  VERSION = "0.1.0"
+end

data/lib/boardgamegem.rb

@@ -0,0 +1,67 @@
+require 'nokogiri'
+require 'open-uri'
+
+module BoardGameGem
+	API_ROOT = "http://www.boardgamegeek.com/xmlapi2"
+	MAX_ATTEMPTS = 10
+
+	def BoardGameGem.get_item(id, statistics = false, options = {})
+		options[:id] = id
+		options[:stats] = statistics ? 1 : 0
+		return BGGItem.new(BoardGameGem.request_xml("thing", options))
+	end
+
+	def BoardGameGem.get_family(id, options = {})
+		options[:id] = id
+		return BGGFamily.new(BoardGameGem.request_xml("family", options))
+	end
+
+	def BoardGameGem.get_user(username, options = {})
+		options[:name] = username
+		return BGGUser.new(BoardGameGem.request_xml("user", options))
+	end
+
+	def BoardGameGem.get_collection(username, options = {})
+		options[:username] = username
+		return BGGCollection.new(BoardGameGem.request_xml("collection", options))
+	end
+
+	def BoardGameGem.search(query, options = {})
+		options[:query] = query
+		xml = BoardGameGem.request_xml("search", options)
+		return {
+			:total => xml["total"].to_i,
+			:items => xml.css("item").map { |x| BGGSearchResult.new(x) }
+		}
+	end
+
+	private
+
+	def BoardGameGem.request_xml(method, hash, attempt = 0)
+		params = BoardGameGem.hash_to_uri(hash)
+		open("#{API_ROOT}/#{method}?#{params}") do |file|
+			if file.status == 202
+				if attempt < MAX_ATTEMPTS
+					sleep 0.05
+					BoardGameGem.request_xml(method, hash, attempt + 1)
+				else
+					return nil
+				end
+			else
+				Nokogiri::XML(file.read)
+			end
+		end
+	end
+
+	def BoardGameGem.hash_to_uri(hash)
+		return hash.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+	end
+end
+
+require 'bgg_base'
+require 'bgg_item'
+require 'bgg_family'
+require 'bgg_user'
+require 'bgg_collection'
+require 'bgg_collection_item'
+require 'bgg_search_result'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: BoardGameGem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jake Roussel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- jakeroussel@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- boardgamegem.gemspec
+- lib/bgg_base.rb
+- lib/bgg_collection.rb
+- lib/bgg_collection_item.rb
+- lib/bgg_family.rb
+- lib/bgg_item.rb
+- lib/bgg_search_result.rb
+- lib/bgg_user.rb
+- lib/boardgamegem.rb
+- lib/boardgamegem/version.rb
+homepage: http://www.github.com/acceptableice/boardgamegem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides a Ruby interface to the BoardGameGeek API
+test_files: []