compare_supermarkets 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dfb65bfbef6bc53ed2b46dcb75a2f220e2808696e283872d2107b2355990841f
+  data.tar.gz: '08a3c207418b171c4ef45a962faec2a30eb5e27ee8e42058a0c76e611362cec8'
+SHA512:
+  metadata.gz: 95a927635dfba228799c2ae4c9f9bcd270a5f0cad7e3562f2cf5c9c6b0b8abffe0c74e12586dda1770a753b88fcc50a3cd7b52bdcde8f9172a2ef136adf59eda
+  data.tar.gz: bca1f45e957152491e021d27123307dd4ad94f130ecd586ddf6b8bb1c255a59e6f96991f0404c4e2949549c8a54e41fe54a4e8208adbcb639cff755a45534534

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in compare_supermarkets.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Justin Berger Howes
+
+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,39 @@
+# CompareSupermarkets
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/compare_supermarkets`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'compare_supermarkets'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install compare_supermarkets
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/compare_supermarkets.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/compare_supermarkets

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/compare_supermarkets'
+
+
+CompareSupermarkets::CLI.new.call

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/config/environment.rb

@@ -0,0 +1,13 @@
+require 'pry'
+require 'nokogiri'
+require 'watir'
+
+#gem install selenium-webdriver - required for watir to work
+#brew install --cask chromedriver - required for watir to work
+
+require_relative '../lib/compare_supermarkets/scraper'
+require_relative '../lib/compare_supermarkets/product'
+require_relative '../lib/compare_supermarkets/cli'
+require_relative '../lib/compare_supermarkets/version'
+
+Watir.default_timeout = 0

data/lib/compare_supermarkets/cli.rb

@@ -0,0 +1,276 @@
+class CompareSupermarkets::CLI
+    def call
+        puts ""
+        puts "Welcome to The Supermarket Comparer"
+        puts ""
+        puts "Type q at any time to exit."
+        puts ""
+        puts "Would you like to compare prices between Coles and Woolies? (Y/N)"
+        input = gets.strip.downcase
+        puts ""
+        if input == "y"
+            start
+        elsif input == "n"
+            puts ""
+            puts "No worries, have a good one!"
+            puts ""
+            exit
+        elsif input.empty?
+            invalid_input
+            call
+        elsif input == "q"
+            exit
+        else
+            invalid_input
+            call
+        end
+    end
+
+    def start
+        puts ""
+        puts "Great!"
+        puts "Please enter the name of the item you wish to compare"
+        input = gets.strip.downcase
+        puts ""
+        puts ""
+        puts "Thank you, we will now search for this product"
+        puts "This will open the browser, don't panic!"
+        puts ""
+        puts ""
+        puts ""
+        puts ""
+        self.search_supermarkets(input)
+        puts ""
+        puts ""
+        if CompareSupermarkets::Product.all_count > 10
+            puts ""
+            puts "Ooo, jeez, seems like we have a lot of results."
+            puts "We have #{CompareSupermarkets::Product.all_count} results for you."
+            puts "If you were a little more specific with your search"
+            puts "term, we would have less to sort through..."
+            puts ""
+            change_search_term
+        elsif CompareSupermarkets::Product.all_count == 0
+            puts ""
+            puts "Ohhh man! Doesn't seem like either supermarket carry"
+            puts "that product."
+            puts ""
+            change_search_term
+        else
+            puts ""
+            puts "Great! We have #{CompareSupermarkets::Product.all_count} items for you."
+            puts ""
+            puts ""
+            puts ""
+            how_to_display
+        end
+    end
+
+    def search_supermarkets(input)
+        CompareSupermarkets::Scraper.search_supermarkets(input)
+    end
+
+    def change_search_term
+        puts "Would you like to change your search term? (Y/N)"
+        input = gets.strip.downcase
+        if input == "y"
+            start
+        elsif input == "n"
+            puts ""
+            puts "No worries"
+            puts ""
+            if CompareSupermarkets::Product.all_count > 0
+                how_to_display
+            else
+                puts ""
+                puts "Have a great day!"
+                puts ""
+                exit
+            end
+        elsif input.empty?
+            invalid_input
+            change_search_term
+        elsif input == "q"
+            exit
+        else
+            invalid_input
+            change_search_term
+        end
+    end
+
+    def how_to_display
+        puts "How would you like your items displayed? (1-5)"
+        puts ""
+        puts "1 - First 10 Cheapest items"
+        puts ""
+        puts "2 - First 10 Most expensive items"
+        puts ""
+        puts "3 - All items"
+        puts ""
+        puts "4 - Only Coles items"
+        puts ""
+        puts "5 - Only Woolworths items"
+        puts ""
+        input = gets.strip
+        puts ""
+        if input == "1"
+            choice = CompareSupermarkets::Product.all_top_10_sorted_by_price
+            print_items(choice, "asc")
+        elsif input == "2"
+            choice = CompareSupermarkets::Product.all_top_10_sorted_by_price
+            print_items(choice, "desc")
+        elsif input == "3"
+            how_to_sort ? direction = "asc" : direction = "desc"
+            choice = CompareSupermarkets::Product.all_items_sorted_by_price
+            print_items(choice, direction)
+        elsif input == "4"
+            how_to_sort ? direction = "asc" : direction = "desc"
+            choice = CompareSupermarkets::Product.coles_sorted_by_price
+            print_items(choice, direction)
+        elsif input == "5"
+            how_to_sort ? direction = "asc" : direction = "desc"
+            choice = CompareSupermarkets::Product.woolworths_sorted_by_price
+            print_items(choice, direction)
+        elsif input == ""
+            invalid_input
+            how_to_display
+        elsif input == "q"
+            exit
+        else
+            invalid_input
+            how_to_display
+        end
+
+    end
+
+    def finished
+        puts ""
+        puts "Is this what you were looking for?(Y/N)"
+        input = gets.strip.downcase
+        if input == "y"
+            puts ""
+            puts "Great!"
+            anything_else
+        elsif input == "n"
+            puts ""
+            try_again
+        elsif input == ""
+            invalid_input
+            finished
+        elsif input == "q"
+            exit
+        else
+            invalid_input
+            finished
+        end
+    end
+
+    def try_again
+        puts "Oh damn, would you like to try something else? (Y/N)"
+        input = gets.strip.downcase
+        if input == "n"
+            puts ""
+            puts "I'm sorry we couldn't help you today. Have a wonderful day!"
+            puts ""
+            exit
+        elsif input == "y"
+            sort_or_compare
+        elsif input == "q"
+            exit
+        elsif input == ""
+            invalid_input
+            try_again
+        else
+            invalid_input
+        end
+    end
+
+    def sort_or_compare
+        puts ""
+        puts "Please pick from one of these options:"
+        puts ""
+        puts "1 - Change the which results you would like to see"
+        puts ""
+        puts "2 - Search for a new item"
+        input = gets.strip
+        if input == "1"
+            how_to_display
+        elsif input == "2"
+            CompareSupermarkets::Product.clear_all
+            start
+        elsif input == ""
+            invalid_input
+            sort_or_compare
+        else
+            invalid_input
+            sort_or_compare
+        end
+    end
+
+    def anything_else
+        puts "Can we help you compare anything else today? (Y/N)"
+        answer = gets.strip.downcase
+        if answer == "n"
+            puts ""
+            puts "Okay, thank you! Have a great day!"
+            puts ""
+            exit
+        elsif answer == "y"
+            start
+        else
+            invalid_input
+            anything_else
+        end
+    end
+
+    def invalid_input
+        puts ""
+        puts "Oh, I don't understand that input"
+        puts ""
+        puts "Please try again"
+    end
+
+    def how_to_sort
+        puts ""
+        puts "How would you like your results sorted?"
+        puts "1 - Cheapest to most expensive"
+        puts "2 - Most expensive to cheapest"
+        puts ""
+        input = gets.strip
+        if input == "1"
+            puts ""
+            puts "Okay! Here we go!"
+            puts ""
+            return true
+        elsif input == "2"
+            puts ""
+            puts "Okay! Here we go!"
+            puts ""
+            return false
+        elsif input == ""
+            puts ""
+            puts "Please enter a command"
+            how_to_sort
+        else
+            invalid_input
+            how_to_sort
+        end
+    end
+
+    def print_items(choice, direction)
+        direction == "asc" ? choice = choice : choice = choice.reverse
+        choice.each do |item|
+            p "Supermarket: #{item.supermarket}"
+            p "Item name: #{item.name}"
+            p "Item price: $#{item.dollar_value}.#{item.cent_value}"
+            p "Item unit size: #{item.unit_size}"
+            p item.price.empty? ? "Unit price: $#{item.dollar_value}.#{item.cent_value} / #{item.unit_size}" : "Unit price: $#{item.price}"
+            p "#{item.url}"
+            puts ""
+        end
+        puts ""
+        puts ""
+        finished
+    end
+
+end

data/lib/compare_supermarkets/product.rb

@@ -0,0 +1,81 @@
+class CompareSupermarkets::Product
+    attr_writer :price
+    attr_reader :supermarket, :name, :price, :unit_size, :url, :dollar_value, :cent_value
+
+    @@all = []
+    @@coles_all = []
+    @@woolworths_all = []
+
+    def initialize (supermarket = nil, name = nil, price=nil, unit_size = nil, url = nil, dollar_value=nil, cent_value=nil)
+        @supermarket = supermarket
+        @name = name
+        @price = price
+        @unit_size = unit_size
+        @dollar_value = dollar_value
+        @cent_value = cent_value
+        @url = @supermarket == "Coles" ? "https://shop.coles.com.au#{url}" : "https://www.woolworths.com.au#{url}"
+        @@all << self
+        if @supermarket == "Coles"
+            @@coles_all << self
+        else
+            @@woolworths_all << self
+        end
+    end
+
+    def self.all
+        @all
+    end
+
+    def self.all_count
+        @@all.count
+    end
+
+    def self.coles_new_from_search(product)
+        product_to_compare = self.new("Coles",
+            product.css(".product-name").text,
+            product.css(".package-price").text.delete_prefix('$').gsub('per', '/'),
+            product.css(".package-size.accessibility-inline").text,
+            product.css(".product-image-link").attribute('href'),
+            product.css(".dollar-value").text,
+            product.css(".cent-value").text.delete_prefix('.'))
+    end
+
+    def self.woolworths_new_from_search(product)
+        product_to_compare = self.new("Woolworths",
+            product.css(".shelfProductTile-descriptionLink").text,
+            product.css(".shelfProductTile-cupPrice.ng-star-inserted").text.delete_prefix(' $').chomp(" "),
+            product.css(".shelfProductTile-descriptionLink").text.split(" ").last,
+            product.css(".shelfProductTile-descriptionLink").attribute('href').value,
+            product.css(".price-dollars").text,
+            product.css(".price-cents").text)
+    end
+
+    def self.all_items_sorted_by_price
+        sorted = @@all.sort_by! do |s|
+            price_to_sort = s.dollar_value + '.' + s.cent_value
+            price_to_sort.to_f
+            end
+    end
+
+    def self.all_top_10_sorted_by_price
+        self.all_items_sorted_by_price.first(10)
+    end
+
+    def self.coles_sorted_by_price
+        @@coles_all.sort_by! do |s|
+        price_to_sort = s.dollar_value + '.' + s.cent_value
+        price_to_sort.to_f
+        end
+    end
+
+    def self.woolworths_sorted_by_price
+        @@woolworths_all.sort_by! do |s|
+            price_to_sort = s.dollar_value + '.' + s.cent_value
+            price_to_sort.to_f
+        end
+    end
+
+    def self.clear_all
+        @@all.clear
+    end
+end

data/lib/compare_supermarkets/scraper.rb

@@ -0,0 +1,59 @@
+class CompareSupermarkets::Scraper
+
+    attr_accessor :search_term
+
+    def initialize(search_term)
+        @search_term = search_term
+    end
+
+    def self.search_supermarkets(search_term)
+        self.search_coles_for(search_term)
+        self.search_woolworths_for(search_term)
+    end
+
+    def self.search_coles_for(search_term)
+        browser = Watir::Browser.new :chrome
+        browser.goto("https://shop.coles.com.au/a/national/everything/search/#{search_term}")
+        begin
+            coles_js_doc = browser.element(class: "products").wait_until(&:present?)
+        rescue
+            puts "Coles does not have this product"
+            puts ""
+            puts "Let's check Woolworths"
+            puts ""
+            puts ""
+        else
+            coles_products = Nokogiri::HTML(coles_js_doc.inner_html)
+            all_coles_products = coles_products.css(".product")
+            all_coles_products.each do |product|
+                if product.css(".product-name").text != ""
+                    CompareSupermarkets::Product.coles_new_from_search(product)
+                end
+            end
+        ensure
+            browser.close
+        end
+    end
+
+    def self.search_woolworths_for(search_term)
+        browser = Watir::Browser.new :chrome
+        browser.goto("https://www.woolworths.com.au/shop/search/products?searchTerm=#{search_term}")
+        begin
+            woolworths_js_doc = browser.element(class: "layoutWrapper").wait_until(&:present?)
+        rescue
+            puts "Woolworths does not have this product"
+        else
+            woolworths_products = Nokogiri::HTML(woolworths_js_doc.inner_html)
+            woolworths_all_products = woolworths_products.css(".shelfProductTile-content")
+            woolworths_all_products.each do |product|
+                if product.css(".shelfProductTile-descriptionLink").text != ""
+                    if product.css(".unavailableSection.width-full.ng-star-inserted").empty?
+                        CompareSupermarkets::Product.woolworths_new_from_search(product)
+                    end
+                end
+            end
+        ensure
+            browser.close
+        end
+    end
+end

data/lib/compare_supermarkets/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CompareSupermarkets
+  VERSION = "0.1.1"
+end

data/lib/compare_supermarkets.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module CompareSupermarkets
+  class Error < StandardError; end
+end
+require_relative "../config/environment"
+
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: compare_supermarkets
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Justin Berger Howes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.28
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.8
+- !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'
+description: Will search Woolworths and Coles online stores for prices based on an
+  input search parameter
+email:
+- howes.j.j@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/compare_supermarkets
+- bin/console
+- bin/setup
+- config/environment.rb
+- lib/compare_supermarkets.rb
+- lib/compare_supermarkets/cli.rb
+- lib/compare_supermarkets/product.rb
+- lib/compare_supermarkets/scraper.rb
+- lib/compare_supermarkets/version.rb
+homepage: http://rubygems.org/gems/compare_supermarkets
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://rubygems.org/gems/compare_supermarkets
+  source_code_uri: https://github.com/happymelonbox/ruby_portfolio_project_gem
+  changelog_uri: https://github.com/happymelonbox/ruby_portfolio_project_gem/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- config
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: Compare supermarket prices
+test_files: []