goodreads-books 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e1b1a9e5fb954dad3a7677af78b522a95f6fcbddf4b9d762273361400f7d0b0
+  data.tar.gz: d8c0304c8b443208b591e9abdb2ad906bcb2afecf2b12a8a409561421e1a0eea
+SHA512:
+  metadata.gz: 78d5ec945a11ba692ed363281243d73cb6918269619e9a8b8b2d80c338e7e21f9875cce15d12bc45ae02a217596c6633fe20125df05f99860c78e7eb2f8c0afb
+  data.tar.gz: b3ca162e6398e94bbba4000fb32cfca6b2080e0efe77adb10427edfb0e099b5cc89ead21f4eddc7cb31ac748af07c6b990a0c24adcaa1d0f0e338f3a01bcdf7d

data/bin/goodreads-books

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

data/config/environment.rb

@@ -0,0 +1,9 @@
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+require 'pry'
+
+require_relative '../lib/goodreads_books/version'
+require_relative '../lib/goodreads_books/cli'
+require_relative '../lib/goodreads_books/scraper'
+require_relative '../lib/goodreads_books/book'

data/lib/goodreads_books.rb

@@ -0,0 +1,5 @@
+require_relative '../config/environment'
+
+module GoodreadsBooks
+  # Your code goes here...
+end

data/lib/goodreads_books/book.rb

@@ -0,0 +1,70 @@
+class GoodreadsBooks::Book
+  attr_accessor :awards_year, :category, :title, :author, :vote, :description, :cate_url, :url
+
+  BASE_URL = "https://www.goodreads.com"
+
+  @@all = []
+
+  def initialize(attributes)
+    attributes.each do |attr_name, attr_value|
+      self.send("#{attr_name}=", attr_value)
+    end
+  end #-- initialize --
+
+  def self.new_from_web_page(book_hash)
+    book = new(book_hash)
+    book.save
+  end #-- self.new_from_web_page --
+
+  def self.all
+    @@all
+  end #-- self.all --
+
+  def save
+    self.class.all << self
+  end #-- save --
+
+  def self.all_by_year(awards_year)
+    all.select { |book| book.awards_year == awards_year }
+  end #-- find_by_year --
+
+  def author
+    get_book_details if !@author
+    @author
+  end #-- author --
+
+  def vote
+    get_book_details if !@vote
+    @vote
+  end #-- vote --
+
+  def description
+    get_book_details if !@description
+    @description
+  end #-- description --
+
+  def url
+    get_book_details if !@url
+    @url
+  end #-- url --
+
+  def get_book_details
+    # Next level of scraping (get details of winner book within each category_url)
+    book_doc = Nokogiri::HTML(open(self.cate_url))
+
+    self.vote = book_doc.css(".gcaRightContainer .gcaWinnerHeader").text.split(" ")[1]
+    self.author = book_doc.css(".gcaRightContainer h3 .gcaAuthor a.authorName").text
+    self.url = "#{BASE_URL}#{book_doc.css(".gcaRightContainer h3 a.winningTitle").attr("href").text}"
+    self.description = book_doc.css(".gcaRightContainer .readable.stacked").text.strip
+
+    #binding.pry
+  end #-- get_book_details --
+
+  def self.populate_book_details(award_year)
+    all_by_year(awards_year).each do |book|
+      book.get_book_details
+    end
+    #binding.pry
+  end #-- self.populate_book_details --
+
+end

data/lib/goodreads_books/cli.rb

@@ -0,0 +1,95 @@
+class GoodreadsBooks::CLI
+
+  # This application only works for year 2010 to current year - 1.
+  # Goodreads Choice Awards Winner 2009 page setup differs from 2010 onwards.
+  BASE_YEAR = 2010
+  END_YEAR = Time.now.year - 1
+
+  def initialize
+    @@choice_awards = nil
+  end
+
+  def call
+    system "clear"
+    puts ""
+    puts "---------- Welcome to Goodreads Choice Awards Books ----------"
+    puts "           ----------------------------------------"
+    puts ""
+
+    load_choice_awards
+
+    main_menu
+  end #-- call --
+
+  def load_choice_awards(awards_year = nil)
+    if awards_year == nil
+      puts "Loading The Latest Winners of Goodreads Choice Awards Books..."
+    else
+      puts "Loading The Winners of #{awards_year} Goodreads Choice Awards Books..."
+    end
+
+    @choice_awards = GoodreadsBooks::Scraper.find_or_create_by_year(awards_year)
+
+    @book_count = GoodreadsBooks::Book.all_by_year(@choice_awards.awards_year).count
+  end #-- load_choice_awards --
+
+  def main_menu
+    system "clear"
+
+    input = nil
+    while input != "exit"
+      list_books
+
+      puts ""
+      puts "Enter a number to view details of the book, or select another Choice Awards year (2010 onwards)."
+      puts "Type 'exit' to end the application."
+      input = gets.strip
+
+      if input.downcase == "exit"
+        break
+      elsif input.to_i.between?(1, @book_count)
+        book = GoodreadsBooks::Book.all_by_year(@choice_awards.awards_year)[input.to_i - 1]
+        view_book(book)
+      elsif input.to_i.between?(BASE_YEAR, END_YEAR)
+
+        load_choice_awards(input.to_i)
+      else
+        puts ""
+        puts "Please enter a number between 1 and #{@book_count} or a valid Choice Awards year".colorize(:red)
+      end
+    end
+
+    puts ""
+    puts "Thank you for using Goodreads Choice Awards Books."
+  end #-- main_menu --
+
+  def list_books
+    puts ""
+    puts "---------- #{@choice_awards.awards_year} Goodreads Choice Awards Books ----------"
+    puts ""
+
+    GoodreadsBooks::Book.all_by_year(@choice_awards.awards_year).each.with_index(1) do |book, index|
+      puts "#{index}. #{book.category} - #{book.title}"
+    end
+  end #-- display_books --
+
+  def view_book(book)
+    puts ""
+    puts "---------- #{@choice_awards.awards_year} BEST #{book.category.upcase} Winner ----------"
+    puts ""
+    puts "Title:        #{book.title}"
+    puts "Author:       #{book.author}"
+    puts "Votes:        #{book.vote}"
+    puts ""
+    puts "       --- Overview ---"
+    puts "#{book.description}"
+
+    puts ""
+    puts "Would you like to visit Goodreads website to view this book? Enter Y or N".colorize(:green)
+    input = gets.strip.downcase
+
+    if input.downcase == "y"
+      system("open #{book.url}")
+    end
+  end #-- view_book --
+end

data/lib/goodreads_books/scraper.rb

@@ -0,0 +1,77 @@
+class GoodreadsBooks::Scraper
+  attr_accessor :awards_year, :main_url
+
+  BASE_URL = "https://www.goodreads.com"
+  PAGE_URL = "/choiceawards"
+
+  @@all = []
+
+  def initialize(awards_year = nil)
+    @awards_year = awards_year
+  end #-- initialize --
+
+  def self.all
+    @@all
+  end #-- self.all --
+
+  def save
+    self.class.all << self
+  end #-- save --
+
+  def self.find_or_create_by_year(awards_year = nil)
+    if !(choice_awards = find_by_year(awards_year))
+       choice_awards = create(awards_year)
+       choice_awards.scrape_books
+    end
+    find_by_year(choice_awards.awards_year)
+  end #-- self.find_or_create_by_year --
+
+  def self.find_by_year(awards_year = nil)
+    all.detect { |r| r.awards_year == awards_year }
+  end #-- self.find_by_year --
+
+  def self.create(awards_year = nil)
+    #choice_awards = new(awards_year)
+    #choice_awards.save
+    choice_awards = new(awards_year).tap { |s| s.save }
+
+    # if awards_year is missing from the url,
+    # goodreads.com defaults to latest choice awards
+    # /best-books-#{latest awards year}"
+    if awards_year == nil
+      choice_awards.main_url = "#{BASE_URL}#{PAGE_URL}"
+      doc = Nokogiri::HTML(open(choice_awards.main_url))
+      choice_awards.awards_year = doc.css("head title").text.split(" ")[2].to_i
+    else
+      choice_awards.main_url = "#{BASE_URL}#{PAGE_URL}/best-books-#{awards_year}"
+      choice_awards.awards_year = awards_year
+    end
+
+    choice_awards # return instance of scraper
+  end #-- self.create --
+
+  def scrape_books
+    doc = Nokogiri::HTML(open(@main_url))
+
+    # Category winners page
+    doc.css(".category.clearFix").each do |category|
+      cate_name = category.css("h4").text
+      cate_url = category.css("a").attr("href").text
+      cate_title = category.css("img").attr("alt").text
+      # cate_book_id = category.css("input")[2].attr("value") # don't need to keep book_id
+
+      # for each winner element, assemble the book_details hash
+      book_details = {
+        :awards_year => @awards_year,
+        :category => cate_name,
+        :title => cate_title,
+        :cate_url => "#{BASE_URL}#{cate_url}"
+      }
+
+      GoodreadsBooks::Book.new_from_web_page(book_details)
+    end
+
+    #binding.pry
+  end #-- scrape_books --
+
+end

data/lib/goodreads_books/version.rb

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: goodreads-books
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ni Chia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-04 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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: Goodreads CLI gem is a command line application that lists the yearly
+  Goodreads Choice Awards Winning Books.
+email:
+- nichia@gmail.com
+executables:
+- goodreads-books
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/goodreads-books
+- config/environment.rb
+- lib/goodreads_books.rb
+- lib/goodreads_books/book.rb
+- lib/goodreads_books/cli.rb
+- lib/goodreads_books/scraper.rb
+- lib/goodreads_books/version.rb
+homepage: https://github.com/nichia/goodreads_books.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/goodreads_books
+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.6
+signing_key: 
+specification_version: 4
+summary: Goodreads Choice Awards Books
+test_files: []