book-deals 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34fdc31a4670da156d063ab13b38578277fee738
+  data.tar.gz: d02ca2fcd57e5e2d31da570456056adfaaaf2ed4
+SHA512:
+  metadata.gz: 3b498d4c80f321024064fba484769c96575ec660fa505fa0888413d6df9371eebcb60a351801c8f1d9622135982d23357fe2b808bc444bd168e234861bb47caf
+  data.tar.gz: 1201f07ec6d7305156ff4b6c1371ff2b5057e6fbcea289b9c5413af5cb73ca64ff6e615fc12fda82916b65319c46bf72f6a62cf7efb5c2b80c7894dfbd8e71f1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

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 book_deals.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Soumya Veer
+
+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 @@
+# BookDeals
+
+Displays the book deals from Goodreads website.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+
+gem 'book-deals'
+
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install book-deals
+
+## Usage
+
+To execute in Command Line User Interface, enter the command:
+
+```ruby
+
+$ book-deals
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/soumyaveer/book_deals-cli-gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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/book-deals

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "book_deals"
+
+BookDeals::Launcher.new.start

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "book_deals"
+
+# 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/book-deals.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "book_deals/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "book-deals"
+  spec.version       = BookDeals::VERSION
+  spec.authors       = ["Soumya Veer"]
+  spec.email         = ["veer.soumya@gmail.com"]
+
+  spec.summary       = %q{Finds and displays book deals from goodreads.}
+  spec.description   = %q{Finds and displays book deals from goodreads.}
+  spec.homepage      = ""
+  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.
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["book-deals"]
+  spec.require_paths = ["lib", "lib/book_deals"]
+
+  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_dependency "nokogiri"
+  spec.add_dependency "colorize"
+end

data/lib/book_deals/book.rb

@@ -0,0 +1,29 @@
+module BookDeals
+  # book on the deal
+
+  class Book
+    attr_accessor :title, :author, :description, :deal, :purchase_url, :categories
+
+    def initialize(deal, title, author, purchase_url, description = nil)
+      self.title = title
+      self.author = author
+      self.purchase_url = purchase_url
+      self.description = description
+      self.categories = []
+      self.deal = deal
+    end
+
+    def to_s
+      <<-DETAILS.gsub /^ */, ''
+      #{"Book Title:".colorize(:yellow)} #{self.title} \n
+      #{"Author:".colorize(:yellow)}  #{self.author} \n
+      #{"Description:".colorize(:yellow)} #{self.description} \n
+      #{"Deal Price:".colorize(:yellow)} #{self.deal.price} \n
+      #{"Original Price:".colorize(:yellow)} #{self.deal.original_price} \n
+      #{"Expires in:".colorize(:yellow)} #{self.deal.expires_in} \n
+      #{"This book can be purchased on:".colorize(:yellow)} #{self.purchase_url.colorize(:magenta)} \n
+      ==============================================================================
+      DETAILS
+    end
+  end
+end

data/lib/book_deals/category.rb

@@ -0,0 +1,18 @@
+module BookDeals
+  # category is a collection of books
+
+  class Category
+    attr_accessor :name, :url, :books
+
+    def add_book(book)
+      self.books << book
+      book.categories << self
+    end
+
+    def initialize(name, url)
+      self.name = name
+      self.url = url
+      self.books = []
+    end
+  end
+end

data/lib/book_deals/cli.rb

@@ -0,0 +1,16 @@
+module BookDeals
+  # manages program's input/output
+
+  class CLI
+    def ask
+      puts "\n"
+      self.say("Enter your selection:".colorize(:blue))
+      gets.chomp
+    end
+
+    def say(output)
+      puts "\n"
+      puts output
+    end
+  end
+end

data/lib/book_deals/deal.rb

@@ -0,0 +1,13 @@
+module BookDeals
+  # current deal on the book
+
+  class Deal
+    attr_accessor :price, :original_price, :expires_in
+
+    def initialize(price, original_price = nil, expires_in = nil)
+      self.price = price
+      self.original_price = original_price
+      self.expires_in = expires_in
+    end
+  end
+end

data/lib/book_deals/launcher.rb

@@ -0,0 +1,84 @@
+module BookDeals
+  # manages user interaction with the scraper
+
+  class Launcher
+    attr_accessor :input_output, :scraper
+
+    def does_user_wants_to_quit?
+      self.input_output.say "Do you want to continue viewing deals? (y/n)".colorize(:blue)
+      answer = self.input_output.ask
+      %w(n no exit).include?(answer.downcase)
+    end
+
+    def display_menu
+      self.input_output.say "Select a Category to see the deals:".colorize(:blue)
+      @categories = self.scraper.scrape_categories_from_home_page
+      @categories.each_with_index do |category, index|
+        category_number = index + 1
+        self.input_output.say "#{category_number}. #{category.name} (Press #{category_number} to see #{category.name})"
+      end
+    end
+
+    def display_deals
+      self.input_output.say "Deals for Category - #{@selected_category.name}".colorize(:green)
+      self.input_output.say "--------------------------------------".colorize(:green)
+      @selected_category.books.each do |book|
+        self.input_output.say book.to_s
+      end
+
+      self.display_total_book_deals_in_category
+    end
+
+    def display_total_book_deals_in_category
+      self.input_output.say "Total #{@selected_category.books.count} deal/deals found for category #{@selected_category.name}.".colorize(:green)
+      self.input_output.say "=============================================================================="
+    end
+
+    def greet_user
+      self.input_output.say "Welcome to BookDeals!!".colorize(:green)
+      self.input_output.say "=======================".colorize(:green)
+    end
+
+    def good_bye
+      self.input_output.say "Thank you for visiting BookDeals. Hope to see you soon. Goodbye!".colorize(:green)
+    end
+
+    def initialize(io = CLI.new, scraper = Scraper.new)
+      self.input_output = io
+      self.scraper = scraper
+      @categories = []
+
+      @selected_category = nil
+    end
+
+    def start
+      loop do
+        self.greet_user
+        self.display_menu
+        self.select_category
+        break if self.does_user_wants_to_quit?
+      end
+      self.good_bye
+    end
+
+    def select_category
+      category_choice = self.input_output.ask
+      number_of_categories = @categories.count
+      if category_choice.to_i.between?(1, number_of_categories)
+        category = @categories[category_choice.to_i - 1]
+
+        @selected_category = self.scraper.scrape_deals_from_category_page(category)
+        self.display_deals
+      else
+       self.wrong_choice_selection(number_of_categories)
+      end
+    end
+
+    def wrong_choice_selection(number_of_categories)
+      self.input_output.say "The category selected is not present!".colorize(:red)
+      self.input_output.say "Please select from options 1 to #{number_of_categories}:".colorize(:red)
+      self.display_menu
+      self.select_category
+    end
+  end
+end

data/lib/book_deals/scraper.rb

@@ -0,0 +1,60 @@
+module BookDeals
+  # builds models from goodreads
+
+  class Scraper
+    HOME_URL = "https://www.goodreads.com"
+    BOOK_DEALS_URL = HOME_URL + "/ebook-deals"
+    HOME_PAGE_HTML_ELEMENTS = ".gr-dealsCategoryExplorer .u-unstyledListItem li a"
+    CATEGORY_PAGE_HTML_ELEMENTS = ".gr-deals .visibleWide .gr-dealsList__listItem"
+    DEALS_HTML_ELEMENT_TITLE = ".gr-book__title"
+    DEALS_PURCHASE_URL_HTML_ELEMENTS = DEALS_HTML_ELEMENT_TITLE + " a"
+    DEALS_HTML_ELEMENT_AUTHOR = ".gr-book__author a"
+    DEALS_HTML_ELEMENT_CATEGORIES = ".gr-deal__tag"
+    DEALS_HTML_ELEMENT_DESCRIPTION = ".gr-deal__blurb"
+    DEALS_HTML_ELEMENT_DEAL_PRICE = ".gr-deal__price__deal"
+    DEALS_HTML_ELEMENT_ORIGINAL_PRICE = ".gr-deal__price__original strike"
+    DEALS_HTML_ELEMENT_DATETIME = ".gr-deal__expirationDate"
+
+    def get_book_deals_page
+      Nokogiri::HTML(open(BOOK_DEALS_URL))
+    end
+
+    def scrape_categories_from_home_page
+      all_category_html_elements = self.get_book_deals_page.css(HOME_PAGE_HTML_ELEMENTS)
+      category_html_elements = select_public_category_html_elements(all_category_html_elements)
+
+      category_html_elements.map do |html_element|
+        category_name = html_element.text
+        category_url = HOME_URL + html_element.attr("href")
+        Category.new(category_name, category_url)
+      end
+    end
+
+    def scrape_deals_from_category_page(category)
+      deals_html_doc = Nokogiri::HTML(open(category.url))
+      deals_html_elements = deals_html_doc.css(CATEGORY_PAGE_HTML_ELEMENTS)
+
+      deals_html_elements.each do |html_element|
+        price = html_element.css(DEALS_HTML_ELEMENT_DEAL_PRICE).text
+        original_price = html_element.css(DEALS_HTML_ELEMENT_ORIGINAL_PRICE).text
+        expires_in = html_element.css(DEALS_HTML_ELEMENT_DATETIME).text.split(" ").drop(2).join(" ")
+
+        deal = Deal.new(price, original_price, expires_in)
+        title = html_element.css(DEALS_HTML_ELEMENT_TITLE).text
+        purchase_url = HOME_URL + html_element.css(DEALS_PURCHASE_URL_HTML_ELEMENTS).attr("href")
+        author = html_element.css(DEALS_HTML_ELEMENT_AUTHOR).text
+        description = html_element.css(DEALS_HTML_ELEMENT_DESCRIPTION).text
+
+        book = Book.new(deal, title, author, purchase_url, description)
+        category.add_book(book)
+      end
+      category
+    end
+
+    private
+
+    def select_public_category_html_elements(all_category_html_elements)
+      all_category_html_elements.reject {|html_element| html_element.text == "Recommended for You"}
+    end
+  end
+end

data/lib/book_deals/version.rb

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

data/lib/book_deals.rb

@@ -0,0 +1,16 @@
+require "book_deals/version"
+require_relative "./book_deals/cli"
+require_relative "./book_deals/launcher"
+require_relative "./book_deals/scraper"
+require_relative "./book_deals/category"
+require_relative "./book_deals/book"
+require_relative "./book_deals/deal"
+require "colorize"
+require "nokogiri"
+require "open-uri"
+
+begin
+  require "pry"
+rescue LoadError
+  # ignore exception as in production environment
+end

data/spec.md

@@ -0,0 +1,21 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+    ##### Executable in `bin` folder.
+    1. created `book-deals` executable and called `Launcher` from it.
+    
+    ##### `CLI` and `Launcher` interact with user and application
+    1. In order to keep the code loosely coupled, I created two classes `CLI` and `Launcher`.
+    2. `CLI` - interacts with the user and asks to enter a choice or displays the required output.
+    3. `Launcher` - It is the starting point of the application. It interacts with `CLI` and the application and contains the logic from greeting the user to exiting the application. 
+   
+- [x] Pull data from an external source
+   ##### `Scraper` to extract data from Goodreads website.
+   1. `Scraper` extracts the data which is constructed into models by `Category`, `Book` and `Deal`.
+  
+   
+- [x] Implement both list and detail views
+  ##### `Scraper` scrapes data of each category and the book deals related to that category.
+  1. `Scraper` extracts the categories information from the `All Deals` page of Goodreads and displays to the user to select the category whose deals user wants to see.
+  2. After user selects the category he/she wants to view, it displays all the book deals related to the category and also displays the total number of deals found for the category in the end.

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: book-deals
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Soumya Veer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-10 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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: Finds and displays book deals from goodreads.
+email:
+- veer.soumya@gmail.com
+executables:
+- book-deals
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/book-deals
+- bin/console
+- bin/setup
+- book-deals.gemspec
+- lib/book_deals.rb
+- lib/book_deals/book.rb
+- lib/book_deals/category.rb
+- lib/book_deals/cli.rb
+- lib/book_deals/deal.rb
+- lib/book_deals/launcher.rb
+- lib/book_deals/scraper.rb
+- lib/book_deals/version.rb
+- spec.md
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/book_deals
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Finds and displays book deals from goodreads.
+test_files: []