libri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d79aa3d997e7e6ed2c2945fc80aea3d1f1e37d8976a635e79294b251d189d982
+  data.tar.gz: 663f6e582d3adabb4560e87ac43fa412c9258732184c0518e8fd0aa93172f30f
+SHA512:
+  metadata.gz: 0f8bc3bddf573b861c6daad5a2adebe7d051651b6dce5883fc621a2157a71c9109022db0e814fdaf6a8fb53e08db62e1095206312d0bd01c007700ac3881b706
+  data.tar.gz: bf63b6f543f81fcca7e694d41a961acd74d3e862778231238ee94ef336054ba61e79e2fbc5483a5916619eba57b6feb9a35be17ca6e892cdb3130aa19bdc1694

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

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 <github email address>. 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/#{repo_name}" }
+
+# Specify your gem's dependencies in libri.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    libri (0.1.0)
+      colorize
+      nokogiri (~> 1.8.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    gem-release (2.0.1)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.3)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      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.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  gem-release
+  libri!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 <github username>
+
+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,30 @@
+# Libri
+
+This gem is made with the purpose of retrieving detailed information about various book awards shortlist for 2017 — 2018. All data is scraped from Barnes & Noble's website.
+
+## Installation
+
+You can install this gem via `gem install libri` on your terminal. The `libri` CLI will be installed and you can run `libri` on the terimnal to get a list of notable book awards and a list of shortlisted books available on the B&N website, as well as details and excerpts from the books.
+
+
+## Usage
+
+After installation, run the gem in your CLI by executing `libri`. Make sure to have installed all the required gems beforehand (pry, nokogiri, and open-air), otherwise the command would return error.
+
+## 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/<github username>/libri. 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 Libri project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/<github username>/libri/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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "libri"
+
+# 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/libri

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "libri"
+
+Libri::CLI.new.call

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/lib/libri.rb

@@ -0,0 +1,10 @@
+require 'open-uri'
+require 'nokogiri'
+require 'colorize'
+require 'pry'
+
+require_relative './libri/version'
+require_relative './libri/cli'
+require_relative './libri/awards.rb'
+require_relative './libri/books.rb'
+require_relative './libri/book.rb'

data/lib/libri/awards.rb

@@ -0,0 +1,28 @@
+class Libri::Awards
+    attr_accessor :name, :url
+    
+    def self.all
+        self.scrape_barnes_noble
+    end
+
+    def self.scrape_barnes_noble
+        html = "https://www.barnesandnoble.com/b/books/awards/_/N-29Z8q8Z1d6q"
+        awards_page = Nokogiri::HTML(open(html))
+
+        # awards.name = awards_page.css("ul#sidebar-section-0 li a").text
+        # awards.url = awards_page.css("ul#sidebar-section-0 li a").attribute("href").value
+
+        awards_array = []
+        awards = {}
+
+        awards_page.css("ul#sidebar-section-0 li a").take(15).each { |award|
+            awards = {
+                :name => award.text.chomp,
+                :url => "https://www.barnesandnoble.com" + award.attribute("href").value
+            }
+            awards_array << awards
+        }
+        awards_array
+    end
+
+end

data/lib/libri/book.rb

@@ -0,0 +1,31 @@
+class Libri::Book
+    attr_accessor :title_by_author, :about_author, :availability, :blurbs_and_plot, :url, :excerpt, :related_books, :book
+
+    def self.scrape_book(book)
+        html = book[:url]
+        book_page = Nokogiri::HTML(open(html))
+        info_section = book_page.css("div.tabpanel")
+
+        related_books_hash = {}
+
+        book_info_hash = {
+            :title_by_author => info_section.css("div#productInfoOverview div.mb-m").text,
+            :blurbs_and_plot => info_section.css("div#productInfoOverview p").map(&:text).join("\n").strip,
+            :about_author => info_section.css("div#MeetTheAuthor div.text--medium").text.strip,
+            :excerpt => info_section.xpath("//div[@class='read-an-excerpt']/p[not(@class) and position()<7]").map(&:text).join("\n"),
+            # :related_books => book_page.css("div.product-shelf-info").each { |book|
+            #     related_books_hash = {
+            #         :title => book.css("div.product-shelf-title").text.strip,
+            #         :author => book.css("div.product-shelf-author").text.strip,
+            #         :url => "https://www.barnesandnoble.com" + book.css("a").attribute("href").value
+            #     }
+            # },
+            :availability => book_page.css("button#pdp-marketplace-btn").text.strip,
+            :url => book[:url]
+        }
+
+        book_info_hash.delete_if { |key, val| val.to_s.strip.empty? }
+
+    end
+
+end

data/lib/libri/books.rb

@@ -0,0 +1,23 @@
+class Libri::Books
+    attr_accessor :award, :url
+
+    def self.scrape_award(award)
+        html = award[:url]
+        books_page = Nokogiri::HTML(open(html))
+
+        books_array = []
+        books = {}
+
+        books_page.css("div.product-shelf-info").take(20).each { |book|
+            books = {
+                :title => book.css("div.product-shelf-title").text.strip,
+                :author => book.css("div.product-shelf-author").text.strip,
+                :url => "https://www.barnesandnoble.com" + book.css("a").attribute("href").value
+            } 
+
+            books_array << books
+        }
+        books_array
+    end
+end
+

data/lib/libri/cli.rb

@@ -0,0 +1,84 @@
+class Libri::CLI
+    attr_accessor :awards, :name, :book, :url
+
+    def call
+        puts "’Tis some visitor, tapping at my chamber door—".blue
+        puts "Have you come to indulge in my trophies?".blue
+        puts "Well, well..".blue
+        puts "Welcome to Libri, a chamber full of literary wonders.".blue
+        puts "Do come inside, this will take a few moments..".blue
+        list_awards
+        leave
+    end
+
+    def list_awards
+        @awards_array = Libri::Awards.all
+        @awards_array.each.with_index(1) { |award, i|
+            puts "#{i}. #{award[:name]}"
+        }
+        puts "Which award would you like to explore?".blue
+
+        menu_awards
+    end
+
+    def list_books(award)
+        @books_array = Libri::Books.scrape_award(award)
+        @books_array.each.with_index(1) { |book, i|
+            puts "#{i}. #{book[:title]} #{book[:author]}. #{book[:rating]}"
+        }
+        puts "Which book would you like to know more about?".blue
+
+        menu_books(award)
+    end
+
+    def list_details(book)
+        @book_info_hash = Libri::Book.scrape_book(book)
+        @book_info_hash.each { |key, val|
+            puts "#{key.upcase}".red
+            puts "#{val}"
+        }
+    end
+
+    def menu_awards
+        input = STDIN.gets.strip.downcase
+    
+        if input.to_i > 0
+            award = @awards_array[input.to_i - 1]
+            list_books(award)
+        elsif input == "list awards"
+            list_awards
+        elsif input == "exit"
+            nil
+        else
+            puts "The raven croaked, 'Please try again.'".red
+            list_awards
+        end
+    end
+
+    def menu_books(award)
+        input = STDIN.gets.strip.downcase
+    
+        if input.to_i > 0
+            book = @books_array[input.to_i - 1]
+            list_details(book)
+            puts "---------------------------------------------------"
+            puts "To list the books of the same award again, type list books.".blue
+            puts "To list all the awards again, type list awards".blue
+            menu_books(award)            
+        elsif input == "list books"
+            list_books(award)
+        elsif input == "list awards"
+            list_awards
+        elsif input == "exit"
+            nil
+        else
+            puts "The raven croaked, 'Please try again.'".red
+            list_books(award)
+        end
+    end
+
+    def leave
+        puts "Nevermore!".blue
+    end
+
+end

data/lib/libri/version.rb

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

data/libri.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "libri/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "libri"
+  spec.version       = Libri::VERSION
+  spec.authors       = ["jouissances"]
+  spec.email         = ["janicedarikho@gmail.com"]
+
+  spec.summary       = %q{CLI for retrieving info about certain award-shortlisted books}
+  spec.description   = %q{Scrapes the Barnes & Noble website (https://www.barnesandnoble.com/) and provides a CLI for viewing various book awards, the respective shortlisted books, as well as details about each book.}
+  spec.homepage      = "https://rubygems.org"
+  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
+
+  # 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        = "bin"
+  spec.executables   = ["libri"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "gem-release"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "nokogiri", "~> 1.8.3"
+  spec.add_dependency "colorize"
+end

data/spec.md

@@ -0,0 +1,7 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+- [ ] Pull data from an external source
+- [ ] Implement both list and detail views
+

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: libri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jouissances
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-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: '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: gem-release
+  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: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !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: Scrapes the Barnes & Noble website (https://www.barnesandnoble.com/)
+  and provides a CLI for viewing various book awards, the respective shortlisted books,
+  as well as details about each book.
+email:
+- janicedarikho@gmail.com
+executables:
+- libri
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/libri
+- bin/setup
+- lib/.DS_Store
+- lib/libri.rb
+- lib/libri/.DS_Store
+- lib/libri/awards.rb
+- lib/libri/book.rb
+- lib/libri/books.rb
+- lib/libri/cli.rb
+- lib/libri/version.rb
+- libri.gemspec
+- spec.md
+homepage: https://rubygems.org
+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.7
+signing_key: 
+specification_version: 4
+summary: CLI for retrieving info about certain award-shortlisted books
+test_files: []