TopBoardGames 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 168c90ae5157371ea054ec69c197874af0b9aec0
+  data.tar.gz: a86a9415f9b2d2d10da0aff72f963019ba535c00
+SHA512:
+  metadata.gz: 4e374b182a45697c588f6ffcd5610a73bcb1ea0ca4db35d72498e3269f61706d0bd3abec56b0df30b157401f06efa8790633766357ad64dcdbbc5aa79097f063
+  data.tar.gz: 5c975ec302061a33c986cc1dcce5a8c86b737faf89229d47320ce232f4a07849c44ab3d64356d77275f60563dfe079cae9a66d2fa6f85f0807aa5805b09a4200

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jsesteves91@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in TopBoardGames.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 johanesteves
+
+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 @@
+# TopBoardGames
+
+Welcome to the Top BoardGames Gem. This gem will allow you to view the current top 100 boardgames on <strong>BoardGameGeek.com</strong>. You will be not only view the top 100, but also view more detailed information about a particular boardgame.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'TopBoardGames'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install TopBoardGames
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/johanesteves/TopBoardGames. 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).
+
+## Code of Conduct
+
+Everyone interacting in the TopBoardGames project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/johanesteves/TopBoardGames/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TopBoardGames.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "TopBoardGames/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "TopBoardGames"
+  spec.version       = TopBoardGames::VERSION
+  spec.authors       = ["johanesteves"]
+  spec.email         = ["jsesteves91@gmail.com"]
+
+  spec.summary       = "Returns list of top 100 boardgames from www.boardgamegeek.com"
+  spec.description   = "Returns list of top 100 boardgames from www.boardgamegeek.com, also allows to get boardgame description"
+  spec.homepage      = "https://github.com/johanesteves"
+  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)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "nokogiri"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "TopBoardGames"
+
+# 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(__FILE__)

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/bin/top-boardgames

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+#require "TopBoardGames"
+require_relative '../lib/TopBoardGames'
+
+TopBoardGames::CLI.new.cal

data/lib/TopBoardGames.rb

@@ -0,0 +1,10 @@
+require 'nokogiri'
+require 'pry'
+require 'open-uri'
+
+require_relative "./TopBoardGames/version"
+require_relative "./TopBoardGames/cli"
+require_relative "./TopBoardGames/game"
+require_relative "./TopBoardGames/scraper"
+
+

data/lib/TopBoardGames/cli.rb

@@ -0,0 +1,73 @@
+class TopBoardGames::CLI
+
+  def call
+    TopBoardGames::Scraper.new.make_boardgames
+    start
+  end
+
+  def start
+    puts "", "Greetings! Here you will be able to see a list of the top 100 boardgames", ""
+    game_list
+    nav_menu
+  end
+
+  def list_boardgames(input)
+    @boardgames = TopBoardGames::Game.all
+    @boardgames[input].each do |game|
+      puts "#{game.rank}.".ljust(5)+"#{game.title}"
+    end
+  end
+
+  def game_list
+    puts " (1)       (2)       (3)       (4)       (5)"
+    puts "01-20 --- 21-40 --- 41-60 --- 61-80 --- 81-100"
+    puts "","Enter the list you would like to see:"
+    input  = gets.strip.downcase
+    inputs = {1 => [1,20], 2 => [21, 40], 3 => [41, 60], 4 => [61, 80], 5 => [81,100]}
+
+    if input.to_i > 0
+      puts "","TOP BOARDGAMES: #{inputs[input.to_i][0]}-#{inputs[input.to_i][1]}"
+      puts "========================================================="
+      list_boardgames((inputs[input.to_i][0])-1..(inputs[input.to_i][1])-1) # list_boardgames(0..19)
+      puts "========================================================="
+      puts "", "Enter boardgame number you wish to view", "Enter '[m]enu' to return the main menu", "Enter '[e]xit' to quit program" ,"" ,"Enter your selection:"
+    end
+    #abort("Goodbye!!") if ["exit", "e"].include?(input)
+  end
+
+
+  def nav_menu
+    input = nil
+    until ["exit", "e"].include?(input)
+      input = gets.strip.downcase
+      if ["menu", "m"].include?(input)
+        game_list
+      elsif input.to_i >0
+        display_game_description(@boardgames[input.to_i-1])
+      elsif ["exit", "e"].include?(input)
+        puts "", "Goodbye!!"
+      else
+        puts "You have entered an invalid input"
+      end
+    end
+  end
+
+  def display_game_description(game)
+    puts "", "More information about:", "========================================================="
+    puts game.title.upcase
+    puts "========================================================="
+    puts "Overall Rank:       #{game.rank}"
+    puts "Average Rating:     #{game.avg_rating}"
+    puts "Weight (Out of 5):  #{game.weight.to_f.round(2)}"
+    if game.min_playtime == game.max_playtime
+      puts "Estimated Playtime: #{game.min_playtime} mins"
+    else
+      puts "Estimated Playtime: #{game.min_playtime} - #{game.max_playtime} mins"
+    end
+    puts "Recommended Age:    #{game.min_age}+"
+    puts "", "Description:"
+    puts game.description, ""
+    puts "========================================================="
+    puts "", "Enter boardgame number you wish to view", "Enter '[m]enu' to return the main menu", "Enter '[e]xit' to quit program" ,"" ,"Enter your selection:"
+  end
+end

data/lib/TopBoardGames/game.rb

@@ -0,0 +1,52 @@
+class TopBoardGames::Game
+  attr_accessor :title, :rank, :url, :avg_rating, :game_id
+  @@all = []
+
+  def self.new_from_main_page(game_row)
+    title = game_row.css(".collection_objectname a").text
+    url = game_row.css(".collection_objectname a").attr("href").text
+    avg_rating = game_row.css(".collection_bggrating")[1].text.strip
+    game_id = url[/(\/\d*\/)/].gsub("/", "")
+    rank = game_row.css(".collection_rank").text.strip
+
+    self.new(title, rank, url, avg_rating, game_id)
+  end
+
+  def initialize(title = nil, rank = nil, url = nil, avg_rating = nil, game_id=nil)
+    @title = title
+    @rank = rank
+    @url = url
+    @avg_rating = avg_rating
+    @game_id = game_id
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def description
+    description_url = Nokogiri::HTML(open("https://boardgamegeek.com#{self.url}")).at("meta[name='description']")['content'].split("\n")
+    @description ||= (description_url[0] + " " +description_url[2])
+  end
+
+  def stats_url
+    Nokogiri::HTML(open("https://www.boardgamegeek.com/xmlapi2/thing?id=#{self.game_id}&stats=1"))
+  end
+
+  def weight
+    @weight ||=stats_url.search("averageweight").first['value']
+  end
+
+  def min_playtime
+    @min_playtime ||=stats_url.search("minplaytime").first['value']
+  end
+
+  def max_playtime
+    @max_playtime ||=stats_url.search("maxplaytime").first['value']
+  end
+
+  def min_age
+    @min_age||=stats_url.search("minage").first['value']
+  end
+end

data/lib/TopBoardGames/scraper.rb

@@ -0,0 +1,16 @@
+class TopBoardGames::Scraper
+
+  def get_main_page
+    #main_page will return the information the info for the list (ie. Rank, Title, etc)
+    Nokogiri::HTML(open("https://www.boardgamegeek.com/browse/boardgame"))
+  end
+
+  def scrape_topboardgames
+    self.get_main_page.css(".collection_table tr#row_")
+  end
+
+  def make_boardgames
+    #this will create new board games and iterate of the main_page
+    scrape_topboardgames.each {|row| TopBoardGames::Game.new_from_main_page(row)}
+  end
+end

data/lib/TopBoardGames/version.rb

@@ -0,0 +1,3 @@
+module TopBoardGames
+  VERSION = "0.5.0"
+end

data/spec.md

@@ -0,0 +1,7 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application => CLI interface allows users to view a list of top games along with allowing them to select a specific one to view more details
+- [X] Pull data from an external source => Data is coming from 3 different pages ("www.boardgamegeek.com) One source is the main page to get basic data, 2nd is to pull 2 "p" of descriptions, lastly 3rd source is from their XML API which was used to get more detailed information
+- [X] Implement both list and detail views => Users can view main list, (total of 20 on screen) or select the game they wish to view more about.
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: TopBoardGames
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- johanesteves
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: nokogiri
+  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: Returns list of top 100 boardgames from www.boardgamegeek.com, also allows
+  to get boardgame description
+email:
+- jsesteves91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TopBoardGames-0.1.0.gem
+- TopBoardGames-0.2.0.gem
+- TopBoardGames.gemspec
+- bin/console
+- bin/setup
+- bin/top-boardgames
+- lib/TopBoardGames.rb
+- lib/TopBoardGames/cli.rb
+- lib/TopBoardGames/game.rb
+- lib/TopBoardGames/scraper.rb
+- lib/TopBoardGames/version.rb
+- spec.md
+homepage: https://github.com/johanesteves
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Returns list of top 100 boardgames from www.boardgamegeek.com
+test_files: []