bgg 1.0.0

data/spec/bgg_search_spec.rb

@@ -0,0 +1,84 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Bgg::Search do
+  describe 'class method' do
+    describe 'query' do
+      it 'throws an ArgumentError when an empty string is passed in' do
+        expect{ Bgg::Search.query('') }.to raise_error(ArgumentError)
+      end
+
+      it 'throws an ArgumentError when a non-string is passed in' do
+        expect{ Bgg::Search.query(Object.new) }.to raise_error(ArgumentError)
+      end
+
+      it 'returns an empty array when a search has no results' do
+        response_file = 'sample_data/search?query=yyyyyyy'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/search'
+
+        stub_request(:any, request_url).
+          with(query: {query: 'yyyyyyy'}).
+          to_return(body: File.open(response_file), status: 200)
+
+        search_results = Bgg::Search.query('yyyyyyy')
+
+        expect( search_results      ).to be_instance_of(Array)
+        expect( search_results.size ).to eq(0)
+      end
+
+      it 'creates an object for a collection that exists' do
+        response_file = 'sample_data/search?query=Burgun'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/search'
+
+        stub_request(:any, request_url).
+          with(query: {query: 'Burgun'}).
+          to_return(body: File.open(response_file), status: 200)
+
+        search_results = Bgg::Search.query('Burgun')
+
+        expect( search_results      ).to be_instance_of(Array)
+        expect( search_results.size ).to eq(11)
+
+        expect( search_results.first      ).to be_instance_of(Bgg::Search::Result)
+        expect( search_results.first.name ).to eq('The Castles of Burgundy')
+      end
+    end
+
+    describe 'exact_query' do
+      it 'throws an ArgumentError when an empty string is passed in' do
+        expect{ Bgg::Search.exact_query('') }.to raise_error(ArgumentError)
+      end
+
+      it 'throws an ArgumentError when a non-string is passed in' do
+        expect{ Bgg::Search.exact_query(Object.new) }.to raise_error(ArgumentError)
+      end
+
+      it 'returns nil when a search has no results' do
+        response_file = 'sample_data/search?query=Burgun&exact=1'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/search'
+
+        stub_request(:any, request_url).
+          with(query: {query: 'Burgun', exact: 1}).
+          to_return(body: File.open(response_file), status: 200)
+
+        search_results = Bgg::Search.exact_query('Burgun')
+
+        expect( search_results ).to eq(nil)
+      end
+
+      it 'returns a single result for a result that exists' do
+        response_file = 'sample_data/search?query=The+Castles+of+Burgundy&exact=1'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/search'
+
+        stub_request(:any, request_url).
+          with(query: {query: 'The Castles of Burgundy', exact: 1}).
+          to_return(body: File.open(response_file), status: 200)
+
+        search_result = Bgg::Search.exact_query('The Castles of Burgundy')
+
+        expect( search_result      ).to be_instance_of(Bgg::Search::Result)
+        expect( search_result.name ).to eq('The Castles of Burgundy')
+      end
+    end
+  end
+end

data/spec/bgg_user_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Bgg::User do
+  describe 'class method' do
+    describe 'find_by_id' do
+      it 'throws an ArgumentError when a non-integer is passed in' do
+        expect{ Bgg::User.find_by_id('string instead') }.to raise_error(ArgumentError)
+      end
+
+      it 'throws an ArgumentError when a non-positive integer is passed in' do
+        expect{ Bgg::User.find_by_id(0) }.to  raise_error(ArgumentError)
+        expect{ Bgg::User.find_by_id(-1) }.to raise_error(ArgumentError)
+      end
+
+      it 'creates an object for a user who exists' do
+        response_file = 'sample_data/user?name=texasjdl'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/user'
+
+        stub_request(:any, request_url).with(query: {id: 39488}).to_return(body: File.open(response_file), status: 200)
+        texasjdl = Bgg::User.find_by_id(39488)
+
+        expect( texasjdl ).to be_a_kind_of(Bgg::User)
+        expect( texasjdl.name ).to eq('texasjdl')
+      end
+
+      it 'throws an ArgumentError for a user who does not exist' do
+        response_file = 'sample_data/user?name=yyyyyyy'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/user'
+
+        stub_request(:any, request_url).with(query: {id: 39488}).to_return(body: File.open(response_file), status: 200)
+
+        expect{ Bgg::User.find_by_id(39488) }.to raise_error(ArgumentError, 'User does not exist')
+      end
+    end
+
+    describe 'find_by_name' do
+      it 'creates an object for a user who exists' do
+        response_file = 'sample_data/user?name=texasjdl'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/user'
+
+        stub_request(:any, request_url).with(query: {name: 'texasjdl'}).to_return(body: File.open(response_file), status: 200)
+        texasjdl = Bgg::User.find_by_name('texasjdl')
+
+        expect( texasjdl ).to be_a_kind_of(Object)
+        expect( texasjdl.name ).to eq('texasjdl')
+      end
+
+      it 'throws an ArgumentError for a user who does not exist' do
+        response_file = 'sample_data/user?name=yyyyyyy'
+        request_url = 'http://www.boardgamegeek.com/xmlapi2/user'
+
+        stub_request(:any, request_url).with(query: {name: 'yyyyyyy'}).to_return(body: File.open(response_file), status: 200)
+
+        expect{ Bgg::User.find_by_name('yyyyyyy') }.to raise_error(ArgumentError, 'User does not exist')
+      end
+    end
+
+    describe 'instance method' do
+      let(:response_file) { 'sample_data/user?name=texasjdl' }
+      let(:request_url)   { 'http://www.boardgamegeek.com/xmlapi2/user' }
+      let(:texasjdl)      { Bgg::User.find_by_id(39488) }
+
+      before do
+        stub_request(:any, request_url).
+          with(query: {id: 39488}).
+          to_return(body: File.open(response_file), status: 200)
+      end
+
+      describe '.play_count' do
+        it 'returns the number of plays when the user has plays' do
+          stub_request(:any, 'http://www.boardgamegeek.com/xmlapi2/plays').
+            with(query: {username: 'texasjdl', page: 1}).
+            to_return(body: File.open('sample_data/plays?username=texasjdl&page=1'), status: 200)
+
+          expect( texasjdl.play_count ).to eq(299)
+        end
+      end
+
+      describe 'collection' do
+        it 'returns the collection object representing the collection for the user' do
+          stub_request(:any, 'http://www.boardgamegeek.com/xmlapi2/collection').
+            with(query: {username: 'texasjdl'}).
+            to_return(body: File.open('sample_data/collection?username=texasjdl'), status: 200)
+
+          collection = texasjdl.collection
+
+          expect( collection ).to be_instance_of(Bgg::Collection)
+          expect( collection.owned.first ).to be_instance_of(Bgg::Collection::Item)
+          expect( collection.size ).to eq(604)
+        end
+      end
+
+      describe '.plays' do
+        it 'returns a Bgg::PlaysIterator' do
+          [1,2,3].each do |i|
+            stub_request(:any, 'http://www.boardgamegeek.com/xmlapi2/plays').
+              with(query: {username: 'texasjdl', page: i}).
+              to_return(body: File.open("sample_data/plays?username=texasjdl&page=#{i}"), status: 200)
+          end
+
+          plays = texasjdl.plays
+          first_play = plays.first
+
+          expect( plays ).to be_an_instance_of(Bgg::Plays::Iterator)
+          expect( first_play ).to be_an_instance_of(Bgg::Play)
+          expect( first_play.game_name ).to eq('Fauna')
+          expect( first_play.players.size ).to eq(5)
+          expect( first_play.players.first.name ).to eq('Ted')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+if ENV['COVERAGE'] == 'yes'
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'webmock/rspec'
+require 'rspec'
+require 'bgg'
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: bgg
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremiah Lee
+- Brett Hardin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Object-oriented interface for interacting with Boardgamegeek API
+email: jeremiah.lee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+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
+homepage: http://github.com/jemaihlee/bgg
+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.2.2
+signing_key: 
+specification_version: 4
+summary: object-oriented boardgamegeek api gem
+test_files: []