tea_shopper 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 621092287bb9081fb013b75011e01e05682560c24e05de32f0850af2d155b43f
+  data.tar.gz: bd6be1d7ec7d2ba68e7b159c68eb79cfa892de0543b6fb064a6351d3e0bf20c1
+SHA512:
+  metadata.gz: 0db8a83db852036c5d09c2414eb8c75d92b8a752a07fe0f15ff6f4dc5420e33d0e433ed52b61ef453ec95c867b93693266e923bcdcc6c87d1564cd1aadc0bb34
+  data.tar.gz: 26680cc506c864b823c73301a66006cbc4ea039c3bcbdce1d150b6d23fe9ef2bc68e982518ab2077d311ce576b7b370805dd87dc44acc51dad8aa864e01095a1

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

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 aaron.parkening@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,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tea_shopper.gemspec
+gemspec
+
+# Default gems
+gem "colorize"
+gem "nokogiri", "~> 1.6"
+
+# Development gems
+group :development do
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    tea_shopper (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  colorize
+  nokogiri (~> 1.6)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tea_shopper!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Aaron Parkening
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 aparkening
+
+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/PROCESS.md

@@ -0,0 +1,185 @@
+# My Gem Development Process
+
+1. Plan gem, imagine interface
+
+- Welcome to Tea Shopper! There are many teas to choose from. Choose a way to explore from the list below:
+		- Type
+		- Country of origin
+		- Flavor
+		
+-> "Type" chosen    
+		Type
+		We have eight main tea categories to choose from. Select from the list below to explore available teas.
+		- Green
+		- White
+		- Yellow
+		- Oolong
+		- Black
+		- Pu-er
+		- Rooibos
+		- Herbal 
+
+    -> "Green" chosen
+			[General description (scraped from Virtuous Tea?)]
+      [Ordering and selection text in single module/method]
+
+			"The teas below are ordered alphabetically. 			
+			Type a specific tea name to learn more about its flavors, steeping instructions, description, and where to buy it."
+			
+		
+	-> "Country" chosen
+  	Country of origin
+		Select from the tea-producing countries below to explore available teas.
+		- China
+		- Japan
+		- Taiwan
+		- [other scraped countries]
+		
+			-> "China" chosen
+			[General description?]
+      [Ordering and selection text in single module/method]
+
+			"The teas below are ordered alphabetically. 			
+			Type a specific tea name to learn more about its flavors, steeping instructions, description, and where to buy it."
+		
+				
+	-> "Flavor" selected
+    Select from the flavor profiles below to explore available teas.
+		- Fruity
+		- Vegetal
+		- [other screaped categories]
+		
+			-> "Fruity" selected
+			[General description?]
+      [Ordering and selection text in single module/method]
+
+			"The teas below are ordered alphabetically. 			
+			Type a specific tea name to learn more about its flavors, steeping instructions, description, and where to buy it."
+		
+	-> Specific tea view
+		[Tea object]
+		- Title (w/ tea type)
+		- Tea shop (w/ url)
+		- Price per oz (w/ stock)
+		- Flavors
+		- Steep instructions
+		- Number of infusions (if exist)
+		- Full description
+		- Ingredients (if exist)
+
+
+2. Outline project structure
+  Bin:
+    Run
+    Console 
+  Config:
+    Environment
+  Lib:
+    CLI interaction file
+    Scraper classes
+    Tea class
+  Rspec:
+    Spec files (if exist)
+  Rakefile
+  Gemfile
+  
+  Build initial structure via Bundler: https://bundler.io/v2.0/guides/creating_gem.html
+    `$ bundle gem tea_shopper`
+
+
+3. Push project to Github, since Bundler creates Github repo.
+
+
+4. Start with run file and interface file
+  Run: 
+    bin/tea_shopper
+      - view permissions of file
+      `ls -lah`
+      - add execute permissions
+      `chmod +x tea_shopper` 
+
+    Start interface instance/CLI controller: `TeaShopper::CLI.new.run`
+	  
+  Interface:
+    `lib/cli.rb`
+    a) `puts "hello world"` to verify working correctly
+	  b) Stub run method to welcome user and list core methods that will run
+    c) Stub menu method to give user initial menu and take input
+
+
+5. Stub remaining interface
+  a) Hardcode to show display details
+  b) Replace each section with dynamic code.
+
+  - Create submenus
+	- Create Tea class
+	- Scrape first site: Song Tea & Ceramics
+  - Create tea display filters for:
+    - Type
+    [Removed] Region
+    [Removed] Flavors
+    [Removed] Price
+  - Display Tea object categories in Type menu
+  - Display selected Tea object
+    - Screencast code along
+	    - Find screencast tool
+	    - Record screencast
+  - Refactor to split primary and secondary scrapes
+  [Removed] Display Tea objects in Region menus
+  [Removed] Display Tea objects in Flavors menus
+
+
+6. Run program and tweak
+  - Improve error handling and responding to edge cases
+  - Refactor to remove duplicated work and separate concerns
+  - Clean up tea_shopper.gemspec for production
+  - Refactor for gem best practices (module names, file locations, etc.)
+
+
+7. Update Readme to include installation, about, etc., following pattern in https://gist.github.com/PurpleBooth/109311bb0361f32d87a2
+  - Update Code_of_Conduct.md
+
+
+8. Run Bundler release (https://bundler.io/v2.0/guides/creating_gem.html) to move into production mode and push to github.
+
+
+9. Record demonstration w/ narration
+
+
+10. Write blog post about process
+
+
+11. Submit Flatiron checklist
+
+
+12. Upload gem after 1:1 code review
+
+
+## Stretch goals:
+
+[done!] Type 'exit' any time to leave program
+
+[done!] Allow user to type tea name or number from list
+
+3. Scrape more sites:
+    - Dobra
+      1. 8 index pages: https://www.dobratea.com/
+      div#second-menu ul#menu-second-nav-header li (don't get accessories)
+      - Get second page if not "showing all" results: https://www.dobratea.com/category/green/page/2/
+      2. Detail pages:
+      https://www.dobratea.com/product/assam-brahmaputra/
+
+    - Smith - https://www.smithtea.com/collections/all-tea?sort_by=title-ascending
+
+    Perhaps in the future
+    - Virtuous
+    - Harney
+    - Happy Lucky's
+    - TeaSource
+    - Tea Spot
+
+  - Refactor Tea instantiaton for multiple scrapers
+
+4. Pagination of long lists
+
+5. Write rspec tests

data/README.md

@@ -0,0 +1,45 @@
+# Tea Shopper
+
+ Tea Shopper is a command line interface that scrapes tea data from the web and allows users to compare teas by name, price per ounce, and tea shop. When the user chooses a tea, it displays specific details, such as purchase URL, flavors, region, and description.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+    gem 'tea_shopper'
+```
+
+And then execute:
+```
+    $ bundle
+```
+
+Or install it yourself as:
+```
+    $ gem install tea_shopper
+```
+## Usage
+
+Type the code below and follow the prompts to find your next great tea.
+```
+    $ bin/tea_shopper
+```
+<img src="/assets/Tea_Shopper-welcome.png" alt="Tea Shopper welcome screen" />
+
+## 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/aparkening/tea_shopper. 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 TeaShopper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aparkening/tea_shopper/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/bin/console

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "tea_shopper"
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# Reload to grab newest class info
+def reload!
+  load 'bin/console'
+  # load_all "./lib"
+end
+
+##### Testing Methods #####
+
+# Test initial Tea object build 
+def test_build
+  # Build tea array from inititial scrape and create Tea objects
+  tea_array = TeaShopper::SongScraper.new.scrape_teas
+  TeaShopper::Tea.create_from_collection(tea_array)
+  
+  # View array
+  TeaShopper::Tea.all
+end
+
+# Add all attributes to array
+def test_attributes
+  TeaShopper::Tea.all.each do |tea|
+    attributes = TeaShopper::SongScraper.new.scrape_profile_page(tea.url)
+    tea.add_tea_attributes(attributes)
+  end
+
+  # View array
+  TeaShopper::Tea.all
+end
+
+# Show full tea array 
+def all_tea
+  TeaShopper::Tea.all
+end
+
+# To reactivate: 
+  # 1. Change cli.rb def display_tea to def display_tea(tea)
+  # 2. Change cli.rb self.display_tea to self.display_tea(@selected_tea)
+  # 3. Change cli.rb :category and :selected_tea to attr_accessor
+# # Display specific detail page
+# def test_detail
+#   tea = TeaShopper::Tea.all.find{|obj| obj.name == "Snow Jasmine"}
+#   TeaShopper::CLI.new.display_tea(tea)
+# end
+
+# # Break detail page
+# def no_detail
+#   tea = "Snow Jasmine"
+#   TeaShopper::CLI.new.display_tea(tea)
+# end
+
+require "irb"
+puts "\nWelcome to your new CLI Environment"
+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/tea_shopper

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/tea_shopper'
+app = TeaShopper::CLI.new
+app.run

data/config/environment.rb

@@ -0,0 +1,9 @@
+require 'open-uri'
+
+require "bundler/setup"
+Bundler.require(:default, :development)
+
+require_relative '../lib/tea_shopper/version'
+require_relative '../lib/song_scraper'
+require_relative '../lib/tea'
+require_relative '../lib/cli'

data/lib/cli.rb

@@ -0,0 +1,262 @@
+class TeaShopper::CLI
+# Present data and get input from user
+
+  attr_reader :category, :selected_tea
+
+##### Controller #####
+  def run
+    self.welcome
+
+    # Make initial tea objects
+    self.make_teas
+
+    # Start process of selecting a tea category and tea
+    self.find_teas
+  end
+
+
+##### Build Tea Objects #####
+  # Create initial Tea objects
+  def make_teas
+    puts "We're pulling today's tea categories from the web. This may take a few moments...\n"
+    tea_array = TeaShopper::SongScraper.new.scrape_teas
+    TeaShopper::Tea.create_from_collection(tea_array)
+  end
+
+  # Add additional attributes to Tea objects from scraped profile pages
+  def add_scraped_attributes(tea_array)
+    self.separator
+    
+    # Include note for potentially long scrape time
+    puts "We're pulling today's teas from the web. This may take a few moments...\n"
+
+    # Only add attributes to teas we need to display. Scrape from category array, not full Tea.all array.
+    tea_array.each do |tea|
+      attributes = TeaShopper::SongScraper.new.scrape_profile_page(tea.url)
+      tea.add_tea_attributes(attributes)
+    end
+  end
+
+
+##### Find Teas #####
+  # Set and show category, tea list, and tea selection
+  def find_teas
+
+    # Display categories, get selection
+    self.display_categories
+
+    # Show list of teas, get tea selection
+    self.display_list if @category
+
+    # Display tea profile
+    self.display_tea if @selected_tea
+  end
+
+  # Display menu for tea type, set @category
+  def display_categories
+
+    # Display title and instructions
+    self.section_title("Main Menu")    
+    self.main_instructions
+
+    # Display today's tea types, get input
+    TeaShopper::Tea.types.each { |obj| puts "- #{obj.capitalize}".colorize(:light_blue)}
+    puts "\n"
+    input = gets.strip.downcase
+    
+    # If input is exit, return with nil @category
+    if self.exit?(input) 
+      @category = nil
+      return self.goodbye
+    # Shortcut: if input is "black", set category to "black/red"
+    elsif input.include?("black")
+      @category = "black/red"
+    # Error check: if input isn't a current tea type, set to "black/red"
+    elsif TeaShopper::Tea.types.none?{|obj| obj == input}
+      puts "\nHmmm, we don't recognize that type of tea, so we'll show our favorite: Black/red teas..."
+      @category = "black/red"
+    else
+      @category = input
+    end
+  end
+
+  # Display ordered list of teas (alphabetically sorted), set @selected_tea
+  def display_list
+    # Assign teas to display
+    teas = TeaShopper::Tea.teas_by_type(@category)
+
+    # If user didn't already view this tea type, scrape profile attributes
+    self.add_scraped_attributes(teas) if TeaShopper::Tea.no_description?(@category)
+    
+    # Display title and instructions
+    title = @category.capitalize + " Tea"
+    self.section_title(title)    
+    self.list_instructions
+
+    # Repeat list and selection process until valid input received
+    until !@selected_tea.nil?
+
+      # Display ordered list of teas and get input
+      self.num_list(teas)
+      puts "\n"
+      input = gets.strip.downcase
+
+      # If input is a number, check for range and find tea by index
+      if self.convert_to_index(input).between?(0,teas.length-1)
+        @selected_tea = teas[self.convert_to_index(input)]
+      # Else return tea if name exists
+      elsif TeaShopper::Tea.find_by_name(input, teas)
+        @selected_tea = TeaShopper::Tea.find_by_name(input, teas)
+      # If exit, set @selected_tea nil, send goodbye
+      elsif self.exit?(input) 
+        @selected_tea = nil
+        return self.goodbye
+      else
+        self.separator
+        puts "We don't recognize that tea, so we'll show the list again...\n\n"
+        self.list_instructions
+      end
+    end
+  end
+
+  # Take in name of tea, find tea object, display all details
+  def display_tea
+    tea = @selected_tea
+
+    # Name
+    title = "#{tea.name} (#{tea.type} tea)"
+    
+    # self.section_title(title)
+    self.separator 
+    puts title.colorize(:green)
+    puts tea.url.colorize(:light_blue)
+    puts "\n"
+    
+    # Out of stock warning
+    puts "Oh no! It's #{tea.stock}!\n".colorize(:red) if tea.stock != ""
+
+    # Shop name and price
+    puts "Shop:" + "     #{tea.shop_name}".colorize(:light_blue)
+    puts "Price:" + "    $#{tea.price} for #{tea.size} grams (#{tea.price_per_oz} per oz.)".colorize(:light_blue) if tea.price != "Sold Out"
+
+    # Region, harvest, flavors
+    puts "Region:" + "   #{tea.region}".colorize(:light_blue)
+    puts "Harvest:" + "  #{tea.date}".colorize(:light_blue)
+    puts "Flavors:" + "  #{tea.flavors}\n".colorize(:light_blue)
+
+    # # Description
+    # puts tea.description 
+    # puts "\n"
+    description_displayed = nil
+
+    # Display next steps, get input
+    until @selected_tea.nil?
+      puts "What now? Choose:"
+      puts "- D to view this tea's (potentially long) description".colorize(:light_blue) if description_displayed.nil?
+      self.b_m_x_menu
+      
+      input = gets.strip.downcase
+    
+      # If D, display description
+      if input == "d" && description_displayed.nil?
+        desc_title = tea.name + " Description:".colorize(:green)
+        self.section_title(desc_title)
+        puts tea.description 
+        # puts "\n" + tea.instructions.colorize(:light_blue)
+        # puts tea.detailed_instructions
+        puts "\n"
+        description_displayed = "yes"
+      else 
+        # Reset @selected_tea to nil
+        @selected_tea = nil
+      end
+    end
+
+    # Open in browser, go to menu, or say goodbye
+    case input
+      when "b"
+        self.open_browser(tea.url)
+        puts "\nThe tea should now be up in your browser. We'll go back to the main menu to select more teas..."
+        return self.find_teas
+      when "m"
+        return self.find_teas
+      else
+        puts "\nWe don't recognize that selection, so we'll exit..." if !exit?(input)
+        return self.goodbye
+    end
+  end
+
+
+##### Logic Helpers #####
+
+  # Convert input into array index
+  def convert_to_index(input)
+    return input.to_i - 1
+  end
+
+  # Check if input is exit
+  def exit?(input)
+    input.downcase == "x" || input.downcase == "exit"
+  end
+
+
+##### Display Helpers #####
+
+  # Welcome message
+  def welcome
+    self.section_title("Welcome to Tea Shopper!")
+  end
+
+  # Goodbye message
+  def goodbye
+    self.separator
+    puts "\nThanks for stopping by. Happy tea drinking!\n\n"
+  end
+
+  # Main menu instructions
+  def main_instructions
+    puts "Choose a category below to find your next great tea:\n(Or type 'X' to exit)"
+    puts "\n"
+  end
+
+  # Submenu instructions
+  def list_instructions
+    puts "Choose a number or tea name from the list below get the details.\n(Or type 'X' to exit)"
+    puts "\n"
+  end
+  
+  # Display B, M, X menu items
+  def b_m_x_menu
+    puts "- B to visit this tea's URL".colorize(:light_blue)
+    puts "- M to start again at the main menu".colorize(:light_blue)
+    puts "- X to exit".colorize(:light_blue)
+    puts "\n"
+  end
+
+  # Section separator
+  def separator
+    puts "\n----------\n\n"
+  end
+
+  # Title for section, including separator
+  def section_title(title)
+    self.separator 
+    puts title.colorize(:green) + "\n\n"
+  end
+
+  # Display numbered list from array input. Replace price per oz with sold out as needed.
+  def num_list(array)
+    printer = ""
+    array.each.with_index(1) do |obj, index| 
+      printer = "#{index}. #{obj.name} (".colorize(:light_blue)
+      obj.price_per_oz == "Sold Out"? printer << "Sold Out".colorize(:red) : printer << "$#{obj.price_per_oz} per oz.".colorize(:light_blue)
+      printer << ", #{obj.shop_name})".colorize(:light_blue)
+      puts printer
+    end
+  end
+
+  # Open URL in browser
+  def open_browser(url)
+		system("open '#{url}'")
+	end
+end

data/lib/song_scraper.rb

@@ -0,0 +1,128 @@
+class TeaShopper::SongScraper
+
+  # Path definitions
+  BASE_URL = "https://songtea.com"
+  INDEX_URL = BASE_URL + "/pages/tea-by-type"
+  # TEST_PROFILE_URL = BASE_URL + "/collections/oolong-tea/products/dragon-phoenix-tender-heart"
+
+#####
+  # 1. Scrape teas from Song Teas by Type page: https://songtea.com/pages/tea-by-type
+  # Example return values:
+  # {
+  #   :name=>"Aged Baozhong, 1960s", 
+  #   :type=>"aged", 
+  #   :shop_name=>"Song Tea & Ceramics", 
+  #   :url=>"/collections/aged-tea/products/aged-baozhong-1960s", 
+  #   :stock=>""
+  # }
+  def scrape_teas
+    teas = []
+
+    # Store html, get tea profile container
+    doc = Nokogiri::HTML(open(INDEX_URL))
+    tea_types = doc.css("div.product-section")
+
+    # Get shop name from meta tag
+    shop_name = ""
+    doc.css('meta').each { |meta| shop_name = meta.attr("content") if meta.attr("property") == "og:site_name" }
+
+    # Iterate through tea types, then iterate through teas to create tea hash
+    tea_types.each do |type|       
+      type.css(".grid__item a.grid-link").each do |tea|
+        
+      # Replace "red" tea type with "black/red", to remove user confusion
+      tea_type = type.attr("id").split("/").last.split("-").first 
+      tea_type = "black/red" if tea_type == "red"
+      
+      # If tea is out of stock, store in hash
+      tea.css("span.badge").text.include?("Sold Out")?stock = "sold out" : stock = ""
+
+      # Add tea hash to array
+      teas <<
+      {
+        :name => tea.css("p.grid-link__title").text,
+        :type => tea_type,
+        :shop_name => shop_name,
+        :url => BASE_URL + tea.attr("href"),
+        :stock => stock
+      }
+      end
+    end
+
+    # Return array
+    return teas
+  end
+
+#####
+  # 2. Scrape individual tea pages, such as https://songtea.com/collections/oolong-tea/products/dragon-phoenix-tender-heart
+  # Example return values:
+  # self.scrape_profile_page(profile_url)
+  # {
+  #   :size=>30.0, 
+  #   :price=>19.0, 
+  #   :price_per_oz=>20.10618, 
+  #   :flavors=>"Notes of orchid, spruce, and ghee.", 
+  #   :date=>"2019", 
+  #   :region=>"Taiwan", 
+  ### Removed for now
+  #   :detailed_instructions=>"This tea accommodates a range of brew styles...", 
+  #   :instructions=>"Brew: 6 grams・150 ml・203° F・2 min", 
+  ####
+  #   :description=>"2019 marks our first year offering this oolong from Taiwan’s Dragon Phoenix Gorge. The cooler temperatures and mist-shrouded gardens of this region product tea with clarity, aromatics, and texture.\nDragon Phoenix Tender Heart is produced by a small farm operated by the Zhang family..."
+  # }
+  def scrape_profile_page(profile_url)
+    profile = {}
+
+    # Store html document
+    doc = Nokogiri::HTML(open(profile_url))
+    container = doc.css("div#ProductSection div.product-single")
+    
+    # Get first selection from size and price select list
+    size_price = container.css("form#AddToCartForm option").first.text.strip.split(" - ")
+
+    # Get size, remove g, convert to float
+    size = size_price.first[/\d+/].to_f
+    profile[:size] = size
+
+    # Get price, grab digits and decimal, convert to float. If price is 0.0, replace with "Sold Out".
+    price = size_price.last[/\d+./].to_f
+    price = "Sold Out" if price == 0.0
+    profile[:price] = price
+
+    # Calculate price per oz from initial price and size.
+    # 30g size * 0.035274 conversion * price
+    # If price is sold out, set to price_per_oz, as well.
+    if price.is_a?(String)
+      price_per_oz = price
+      profile[:price_per_oz] = price_per_oz
+    else 
+      price_per_oz = size * 0.035274 * price
+      profile[:price_per_oz] = price_per_oz.round(2)
+    end
+
+    # Gather all description paragraphs and separate into flavors, date, region. (And instructions and detailed instructions for future.)
+    desc_array = container.css("div.product-description p").collect { |p| p.text }
+
+    # Flavors
+    profile[:flavors] = desc_array.shift
+     
+    # Remove second paragraph and separate into region and date
+    region_year = desc_array.shift.split("・")
+    profile[:date] = region_year[1]
+
+    # Region. Grab text after "from" until the end
+    profile[:region] = region_year.first[/(?<=from ).*/]
+ 
+    # Future: when separating steep instructions, activate:
+      # Steep instructions
+      # Get detailed instructions first
+      # profile[:detailed_instructions] = desc_array.pop
+      # Get summary instructions next
+      # profile[:instructions] = desc_array.pop
+    
+    # Full description
+    profile[:description] = desc_array.join("\n\n")
+
+    return profile
+  end
+end

data/lib/tea.rb

@@ -0,0 +1,64 @@
+class TeaShopper::Tea 
+
+  attr_accessor :name, :type, :shop_name, :url, :stock, :size, :price, :price_per_oz, :flavors, :region, :date, :description
+  
+  @@all = []
+
+  # Initialize multiple attributes with send
+  def initialize(attributes)
+    attributes.each {|key, value| self.send(("#{key}="), value)}
+    @@all << self
+  end
+
+  # Create tea instances from hashes inside tea_array
+  def self.create_from_collection(tea_array)
+    tea_array.each do |tea|
+      tea = TeaShopper::Tea.new({
+        :name => tea[:name],
+        :type => tea[:type],
+        :shop_name => tea[:shop_name],
+        :url => tea[:url],
+        :stock => tea[:stock]  
+      })
+      # Future: reinstate :region => tea[:region],
+    end
+  end
+
+  # Add profile page hash attributes to Tea objects
+  def add_tea_attributes(attributes_hash)
+    attributes_hash.each {|key, value| self.send(("#{key}="), value)}
+    return self
+  end
+
+  # @@all Teas reader
+  def self.all
+    return @@all
+  end
+
+  # Reset the @@all array
+  def self.reset_all
+    self.all.clear
+  end
+
+  # Find tea object by name
+  def self.find_by_name(name, array)
+    array.find{|obj| obj.name.downcase == name.downcase}
+  end
+
+  # Return true if sample description doesn't exist for tea in input type
+  def self.no_description?(type)
+    self.teas_by_type(type).select{|obj| obj.description}.sample.nil?
+  end
+
+  # Return array of tea types
+  def self.types
+    self.all.collect { |tea| tea.type }.uniq.sort
+  end
+
+  # Return array of teas for type
+  def self.teas_by_type(type)
+    teas = self.all.collect { |obj| obj if obj.type == type }.compact
+    # teas.sort_by { |tea| tea.price_per_oz}  # for sorting by price, rather than alphabetical
+    teas.sort_by { |tea| tea.name}
+  end
+end

data/lib/tea_shopper.rb

@@ -0,0 +1,4 @@
+module TeaShopper
+end
+
+require_relative '../config/environment'

data/lib/tea_shopper/version.rb

@@ -0,0 +1,3 @@
+module TeaShopper
+  VERSION = "0.3.0"
+end

data/tea_shopper.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tea_shopper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tea_shopper"
+  spec.version       = TeaShopper::VERSION
+  spec.authors       = ["aparkening"]
+  spec.email         = ["aaron.parkening@gmail.com"]
+
+  spec.summary       = "Tea Shopper helps you shop for your next great tea."
+  spec.description   = " Tea Shopper is a command line interface that scrapes tea data from the web and allows users to compare teas by name, price per ounce, and tea shop. When the user chooses a tea, it displays specific details, such as purchase URL, flavors, region, and description. Check out a short demonstration video. at https://www.loom.com/share/5d3cc369d7c243d4af5e665206b39a75."
+  spec.homepage      = "https://github.com/aparkening/tea_shopper"
+  spec.license       = "MIT"
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir          = "bin"
+  spec.executables     = ["tea_shopper"]
+  spec.require_paths   = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: tea_shopper
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- aparkening
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: " Tea Shopper is a command line interface that scrapes tea data from
+  the web and allows users to compare teas by name, price per ounce, and tea shop.
+  When the user chooses a tea, it displays specific details, such as purchase URL,
+  flavors, region, and description. Check out a short demonstration video. at https://www.loom.com/share/5d3cc369d7c243d4af5e665206b39a75."
+email:
+- aaron.parkening@gmail.com
+executables:
+- tea_shopper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- PROCESS.md
+- README.md
+- Rakefile
+- assets/Tea_Shopper-welcome.png
+- bin/console
+- bin/setup
+- bin/tea_shopper
+- config/environment.rb
+- lib/cli.rb
+- lib/song_scraper.rb
+- lib/tea.rb
+- lib/tea_shopper.rb
+- lib/tea_shopper/version.rb
+- tea_shopper.gemspec
+homepage: https://github.com/aparkening/tea_shopper
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Tea Shopper helps you shop for your next great tea.
+test_files: []