bgg 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caa780dfe0e92277f11577072e0f35275922d554
+  data.tar.gz: 942ae33daffac8ff1f1e9c1065047da0b7645da9
+SHA512:
+  metadata.gz: 1b218000c4ba5631437409596a676a807c390312b255a54c625bdc4a6d08729cdf34416af897fb7b69d2dbdeff55477a2ffc7892863620a956dc685cb67ba2ce
+  data.tar.gz: 23aed87b53e5c245a2f6b7672abdc1cf4ba4c5b9a4f26009345206fc7afb1df641832e82ab6f2e00ef8c3951591b280529d6cc6f8eb161f9f57d17e22074672d

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.travis.yml

@@ -0,0 +1,6 @@
+language: "ruby"
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+before_script: 'bundle'
+script: 'CODECLIMATE_REPO_TOKEN=187555d2e125f5add7c7150d4e529f7f872510808a16aaad4a62e5cc1c1eb53c bundle exec rake'

data/Gemfile

@@ -0,0 +1,20 @@
+source 'http://rubygems.org'
+gem 'httparty'
+gem 'xml-simple'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'bundler', '>= 1.0.0'
+  gem 'jeweler'
+  gem 'rdoc'
+  gem 'simplecov'
+  gem 'webmock'
+end
+
+group :test, :development do
+  gem 'codeclimate-test-reporter'
+	gem 'rake'
+	gem 'rspec'
+end
+

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    codeclimate-test-reporter (0.3.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    multi_json (1.3.2)
+    multi_xml (0.4.4)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    webmock (1.8.9)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    xml-simple (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  codeclimate-test-reporter
+  httparty
+  jeweler
+  rake
+  rdoc
+  rspec
+  simplecov
+  webmock
+  xml-simple

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Jeremiah Lee, Brett Hardin
+
+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,73 @@
+bgg gem [![Build Status](https://travis-ci.org/jemiahlee/bgg.svg)](https://travis-ci.org/jemiahlee/bgg) [![Code Climate](https://codeclimate.com/github/jemiahlee/bgg.png)](https://codeclimate.com/github/jemiahlee/bgg)
+===========
+
+An object-oriented API for interacting with the [boardgamegeek](http://boardgamegeek.com) [XML Version 2 API](http://boardgamegeek.com/wiki/page/BGG_XML_API2).
+
+This is based on a fork of earlier work I had done on
+[bgg-api](http://github.com/bhardin/bgg-api), along with Brett and a few
+other contributors.
+
+## Versions supported
+
+Please note that this code uses Ruby 1.9 hash syntax and thus does not
+support versions earlier than that.
+
+## Installing the Gem
+
+Do the following to install the  [bgg gem](http://rubygems.org/gems/bgg) Ruby Gem.
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem "bgg"
+```
+
+Then run `bundle install` from the command line:
+
+    bundle install
+
+## Using the Gem
+
+Require the gem at the top of any file you want to use.
+
+    require 'bgg'
+
+You can either use the low level basic api and then parse the XML document in a way that suits your needs,
+or you can use the specialized methods
+
+There are object types and subtypes for many of the APIs documented at
+[BGG_XML_API2](http://boardgamegeek.com/wiki/page/BGG_XML_API2), but not all of them are implemented.
+Everything around a user and their game collection should work, as well
+as generalized searching for board games.
+
+### Example
+
+Most of the documentation right now is in the specs. I will work on
+beefing this section up shortly.
+
+```ruby
+texasjdl = Bgg::User.find_by_id(39488)
+texasjdl.collection.played.each do |item|
+  puts "#{item.name} is #{item.owned? ? '' : 'not'} owned."
+end
+```
+
+
+Contributing to bgg
+-----------------------
+
+* Fork the project
+* Start a feature/bugfix branch
+* Test whatever you are committing. Ensure this test is a specification
+  of the behavior of the functionality, not just an error case or
+  success case.
+* Commit and push until you are happy with your contribution
+* Submit a pull request. Squash commits that should be squashed (it is
+  not necessary for you to have just one commit to your pull request,
+  but have each commit be a logical piece of work.)
+
+Copyright
+---------
+
+Copyright (c) 2014 [Jeremiah Lee](https://github.com/jemiahlee), [Brett Hardin](http://bretthard.in), and [Marcello Missiroli](https://github.com/piffy). See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require 'jeweler'
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+Jeweler::Tasks.new do |gem|
+  gem.name = 'bgg'
+  gem.homepage = 'http://github.com/jemaihlee/bgg'
+  gem.license = 'MIT'
+  gem.summary = 'object-oriented boardgamegeek api gem'
+  gem.description = 'Object-oriented interface for interacting with Boardgamegeek API'
+  gem.email = 'jeremiah.lee@gmail.com'
+  gem.authors = ['Jeremiah Lee', 'Brett Hardin']
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :coverage do
+  ENV['COVERAGE'] = 'yes'
+  Rake::Task['spec'].execute
+end
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bgg #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bgg.gemspec

@@ -0,0 +1,122 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: bgg 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "bgg"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Jeremiah Lee", "Brett Hardin"]
+  s.date = "2014-05-07"
+  s.description = "Object-oriented interface for interacting with Boardgamegeek API"
+  s.email = "jeremiah.lee@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bgg.gemspec",
+    "lib/bgg.rb",
+    "lib/bgg/collection.rb",
+    "lib/bgg/collection_item.rb",
+    "lib/bgg/game.rb",
+    "lib/bgg/play.rb",
+    "lib/bgg/plays.rb",
+    "lib/bgg/plays_iterator.rb",
+    "lib/bgg/search.rb",
+    "lib/bgg/search_result.rb",
+    "lib/bgg/user.rb",
+    "sample_data/collection?username=texasjdl",
+    "sample_data/collection?username=texasjdl&own=1&excludesubtype=boardgameexpansion",
+    "sample_data/collection?username=yyyyyyy",
+    "sample_data/hot?type=boardgame",
+    "sample_data/plays?pages=9999999999999&username=ryanmacg",
+    "sample_data/plays?username=beetss&page=1",
+    "sample_data/plays?username=ryanmacg",
+    "sample_data/plays?username=texasjdl&id=84876",
+    "sample_data/plays?username=texasjdl&id=84876&type=thing",
+    "sample_data/plays?username=texasjdl&page=1",
+    "sample_data/plays?username=texasjdl&page=2",
+    "sample_data/plays?username=texasjdl&page=3",
+    "sample_data/plays?username=yyyyyyy&page=1",
+    "sample_data/search?query=Burgun",
+    "sample_data/search?query=Burgun&exact=1",
+    "sample_data/search?query=Burgund&type=boardgame",
+    "sample_data/search?query=The+Castles+of+Burgundy&exact=1",
+    "sample_data/search?query=yyyyyyy",
+    "sample_data/thing?id=10000000&type=boardgame",
+    "sample_data/thing?id=29773&type=boardgame",
+    "sample_data/thing?id=70512&type=boardgame",
+    "sample_data/thing?id=84876&type=boardgame",
+    "sample_data/user?name=texasjdl",
+    "sample_data/user?name=yyyyyyy",
+    "spec/bgg_api_spec.rb",
+    "spec/bgg_collection_item_spec.rb",
+    "spec/bgg_collection_spec.rb",
+    "spec/bgg_game_spec.rb",
+    "spec/bgg_play_spec.rb",
+    "spec/bgg_plays_iterator_spec.rb",
+    "spec/bgg_plays_spec.rb",
+    "spec/bgg_search_result_spec.rb",
+    "spec/bgg_search_spec.rb",
+    "spec/bgg_user_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/jemaihlee/bgg"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "object-oriented boardgamegeek api gem"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/lib/bgg.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+require 'xmlsimple'
+
+# http://boardgamegeek.com/wiki/page/BGG_XML_API2#
+
+class BggApi
+  include HTTParty
+
+  METHODS = [
+    :collection,
+    :family,
+    :forum,
+    :forumlist,
+    :guild,
+    :hot,
+    :plays,
+    :search,
+    :thing,
+    :thread,
+    :user,
+  ].freeze
+
+  BASE_URI = 'http://www.boardgamegeek.com/xmlapi2'
+  OLD_URI  = 'http://www.boardgamegeek.com/xmlapi'
+
+  METHODS.each do |method|
+    define_singleton_method(method) do |params|
+      params ||= {}
+
+      url = BASE_URI + '/' + method.to_s
+      response = self.get(url, :query => params)
+
+      if response.code == 200
+        xml_data = response.body
+        XmlSimple.xml_in(xml_data)
+      else
+        raise "Received a #{response.code} at #{url} with #{params}"
+      end
+    end
+  end
+end
+
+
+require 'bgg/collection'
+require 'bgg/collection_item'
+require 'bgg/game'
+require 'bgg/play'
+require 'bgg/plays'
+require 'bgg/plays_iterator'
+require 'bgg/search'
+require 'bgg/search_result'
+require 'bgg/user'
+

data/lib/bgg/collection.rb

@@ -0,0 +1,58 @@
+module Bgg
+  class Collection
+    def self.find_by_username(username)
+      if username =~ /^\d*$/
+        # this is a sorta hokey restriction because there is probably nothing requiring
+        # users to have non-numeric usernames. I'm not sure that I've seen one though.
+        raise ArgumentError.new('username must not be empty or only digits!')
+      end
+
+      if username.is_a?(Integer)
+        raise ArgumentError.new('username must not be an Integer!')
+      end
+
+      collection_data = BggApi.collection({username: username})
+
+      unless collection_data.has_key?('item')
+        raise ArgumentError.new('User does not exist')
+      end
+
+      Bgg::Collection.new(collection_data)
+    end
+  end
+
+  class Collection
+    def initialize(collection_data)
+      @items = []
+
+      collection_data['item'].each do |item|
+        bgg_item = Bgg::Collection::Item.new(item)
+        @items.push(bgg_item)
+      end
+    end
+
+    def size
+      @items.size
+    end
+
+    def count
+      self.size
+    end
+
+    def owned
+      @items.select{ |item| item.owned? }
+    end
+
+    def boardgames
+      @items.select{ |item| item.type == 'boardgame' }
+    end
+
+    def boardgame_expansions
+      @items.select{ |item| item.name =~ /expansion/i }
+    end
+
+    def played
+      @items.select{ |item| item.played? }
+    end
+  end
+end