halliday_wine_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7d4c1e7d25c0d49b9077750422bee6a4ceb7e553d20e3320a94f6c4f47e13ee
+  data.tar.gz: 60deb9d1493b2d3d5b8f2904dec632640131ba3d15887be50413e9e7f3979941
+SHA512:
+  metadata.gz: 65b150b8c0db408c79415cecc4815299bdb7527667d1e8ebc2763dffef4e4e66f497e2ed6bb9956d59b06e2a5af6632d4763effebb5d9c0a9b488ad1245731b2
+  data.tar.gz: 714cc1a702b1d82ada23ae6ea4fdb299074660d3cf35e3a5a6d7dec929c1c9f124f381cd661740565549bfebca2b61ad0738b6a8f16ab80eda6f8334fd162e01

data/.gitignore

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

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 'remmy.lauren@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/remclay/halliday_wine_list" }
+
+# Specify your gem's dependencies in halliday_wine_list.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    halliday_wine_list (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  halliday_wine_list!
+  pry
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Remmy Clay and Contributors
+
+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 @@
+# HallidayWineList
+
+This Ruby gem provides a CLI to view the red and white wines selected as part of the James Halliday Top 100 Wines of 2017. Users can select to view all wines, or view wines via category.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'halliday_wine_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install halliday_wine_list
+
+## Usage
+
+Run halliday_wine_list after installing the gem
+
+## 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/'remclay'/halliday_wine_list. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HallidayWineList project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'remclay'/halliday_wine_list/blob/master/CODE_OF_CONDUCT.md).

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 "./config/environment"
+
+# 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/halliday_wine_list

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative '../config/environment'
+
+HallidayWineList::CLI.new.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/config/environment.rb

@@ -0,0 +1,9 @@
+require 'open-uri'
+require 'nokogiri'
+#require 'pry'
+
+require_relative '../lib/halliday_wine_list/version'
+require_relative '../lib/halliday_wine_list/cli'
+require_relative '../lib/halliday_wine_list/category'
+require_relative '../lib/halliday_wine_list/wine'
+require_relative '../lib/halliday_wine_list/scraper'

data/halliday_wine_list.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "halliday_wine_list/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "halliday_wine_list"
+  spec.version       = HallidayWineList::VERSION
+  spec.authors       = ["'Remmy Clay'"]
+  spec.email         = ["'remmy.lauren@gmail.com'"]
+
+  spec.summary       = "A gem that displays the red and white wines in the James Halliday Top 100 Wines of 2017."
+  spec.description   = "A gem that retreives all red and white wines selected in the James Halliday Top 100 Wines of 2017 and displays those wines via category or lists all selections."
+  spec.homepage      = "https://github.com/remclay/halliday_wine_list"
+  #Update to gem's website or public repo URL here.
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+  #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   << "halliday_wine_list"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nokogiri"
+
+end

data/lib/halliday_wine_list/category.rb

@@ -0,0 +1,37 @@
+class HallidayWineList::Category
+
+  attr_reader :name, :url
+
+  @@all_categories = []
+
+  def self.all_categories
+    @@all_categories
+  end
+
+  def self.print_categories
+    @@all_categories.each.with_index(1) {|c, i| puts "#{i} - #{c.name}"}
+  end
+
+  def initialize(name= nil, url= nil)
+    @wines = []
+    @name = name
+    @url = url
+    @@all_categories << self
+  end
+
+  def self.new_from_scraper(name, url)
+    self.new(name, url)
+  end
+
+  def self.create_categories
+    HallidayWineList::Scraper.new.scrape_categories
+  end
+
+  def add_wine(wine)
+    @wines << wine
+  end
+
+  def print_wines
+    @wines.each.with_index(1) {|w, i| puts "#{i} #{w.winery} - #{w.variety} - #{w.location}."}
+  end
+end

data/lib/halliday_wine_list/cli.rb

@@ -0,0 +1,92 @@
+class HallidayWineList::CLI
+
+  def start
+    puts ""
+    puts "James Halliday's Top Wines for 2017"
+    puts "--------------------------------------------"
+    puts "Retrieving all red and white varieties from the 2017 selection.."
+    collect_data
+    choose_category
+  end
+
+  def choose_category
+    categories = HallidayWineList::Category.all_categories
+    if categories.count == 0
+      site_error
+    else
+      puts ""
+      puts "Categories:"
+      list_categories
+      puts ""
+      puts "Select a category (1-#{categories.count}) to view the wines from that category, type 'list' to see all wines or type exit to leave."
+      @input = gets.strip.downcase
+      if users_choice >= 0 && users_choice < (categories.count)
+        puts ""
+        puts "Current selection: #{categories[users_choice].name}."
+        puts "--------------------------------------------"
+        print_category_wines
+      elsif @input == "exit"
+        goodbye
+      elsif @input == "list"
+        puts ""
+        puts "Current selection: all red and white wines from the 2017 selection."
+        puts "--------------------------------------------"
+        print_all_wines
+      else
+        puts ""
+        puts "Sorry, that input is not valid. Here are your options again."
+        choose_category
+      end
+      next_steps
+    end
+  end
+
+  def next_steps
+    puts ""
+    puts "--------------------------------------------"
+    puts "What would you like to do next? (1-2)"
+    puts "1 View main menu"
+    puts "2 Exit"
+    input = gets.strip.to_i
+    if input == 1
+      choose_category
+    elsif input == 2
+      goodbye
+    else
+      puts ""
+      puts "Sorry, that input is not valid. Please enter a valid input (1-2)."
+      next_steps
+    end
+  end
+
+  def site_error
+    puts ""
+    puts "We're sorry. There seems to be an issue with the James Halliday Top Wines 2017 website at this time. Please check back again later."
+    exit
+  end
+
+  def print_category_wines
+    HallidayWineList::Category.all_categories[users_choice].print_wines
+  end
+
+  def users_choice
+    @input.to_i - 1
+  end
+
+  def goodbye
+    puts "We hope you found a wine to your liking! Enjoy often, enjoy responsibly."
+    exit
+  end
+
+  def collect_data
+    HallidayWineList::Category.create_categories
+  end
+
+  def list_categories
+    HallidayWineList::Category.print_categories
+  end
+
+  def print_all_wines
+    HallidayWineList::Wine.print_wines
+  end
+end

data/lib/halliday_wine_list/scraper.rb

@@ -0,0 +1,26 @@
+class HallidayWineList::Scraper
+
+  def scrape_categories
+    doc = Nokogiri::HTML(open("https://www.winecompanion.com.au/wines/james-hallidays-top-100-wines-of-2017"))
+    doc.css("div.clearfix.bestofbest ul.listing-items h3.sub-title").each do |item|
+      name = item.css("a").text
+      @url = item.css("a").attr("href").value
+      if name.include?("red") || name.include?("white")
+        @current_category = HallidayWineList::Category.new_from_scraper(name, @url)
+        scrape_wines
+      end
+    end
+  end
+
+  def scrape_wines
+    category_url = "https://www.winecompanion.com.au" + "#{@url}"
+    doc = Nokogiri::HTML(open(category_url))
+    doc.css("div.clearfix ul.listing-items div.info").each do |item|
+      winery = item.css("p.winery").text
+      variety = item.css("p.variety").text
+      location = item.css("p.location").text
+      category = @current_category
+      HallidayWineList::Wine.new_from_scraper(winery, variety, location, category)
+    end
+  end
+end

data/lib/halliday_wine_list/version.rb

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

data/lib/halliday_wine_list/wine.rb

@@ -0,0 +1,28 @@
+class HallidayWineList::Wine
+
+  attr_accessor :category
+  attr_reader :winery, :variety, :location
+
+  @@all_wines = []
+
+  def self.all_wines
+    @@all_wines
+  end
+
+  def self.print_wines
+    @@all_wines.each.with_index(1) {|w, i| puts "#{i} #{w.winery} - #{w.variety} - #{w.location}."}
+  end
+
+  def initialize(winery= nil, variety= nil, location= nil, category)
+    @winery = winery
+    @variety = variety
+    @location = location
+    @@all_wines << self
+    self.category = category
+    category.add_wine(self)
+  end
+
+  def self.new_from_scraper(winery, variety, location, category)
+    self.new(winery, variety, location, category)
+  end
+end

data/lib/halliday_wine_list.rb

@@ -0,0 +1 @@
+require_relative '../config/environment'

data/spec.md

@@ -0,0 +1,11 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+      HallidayWineList::CLI class encapsulates the CLI. The CLI class displays messages to the user (including welcome message, main menu, next steps menu and farewell message), receives user input in response to those messages (via gets) and calls the method(s) applicable to the user input.
+
+- [x] Pull data from an external source
+      The HallidayWineList::Scraper class is responsible for scraping the 'Wine Companion' website to retrieve the applicable categories of red and white wines. Each category has a unique URL path, which is then used to scrape the wines within that category.
+
+- [x] Implement both list and detail views
+      The categories are displayed in a list (via HallidayWineList::Categories.print_categories). Once the user selects a category, or opts to view all wines, the applicable wines are displayed in detail (winery - variety} - location).

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: halliday_wine_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Remmy Clay'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that retreives all red and white wines selected in the James Halliday
+  Top 100 Wines of 2017 and displays those wines via category or lists all selections.
+email:
+- "'remmy.lauren@gmail.com'"
+executables:
+- halliday_wine_list
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/halliday_wine_list
+- bin/setup
+- config/environment.rb
+- halliday_wine_list.gemspec
+- lib/halliday_wine_list.rb
+- lib/halliday_wine_list/category.rb
+- lib/halliday_wine_list/cli.rb
+- lib/halliday_wine_list/scraper.rb
+- lib/halliday_wine_list/version.rb
+- lib/halliday_wine_list/wine.rb
+- spec.md
+homepage: https://github.com/remclay/halliday_wine_list
+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.7.4
+signing_key: 
+specification_version: 4
+summary: A gem that displays the red and white wines in the James Halliday Top 100
+  Wines of 2017.
+test_files: []