nyt_cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f4a6bc1fbeca17aa27b79b06823dbe3aa81f9a11ed80ff59e45564087366769
+  data.tar.gz: 4e8173dde9120de295dfa70b813bbaa7167e612bfd03b70446a7c3a02e96e4fa
+SHA512:
+  metadata.gz: b9374eb53872a5703351d42a86959a7c766f741726874a8a8e09923f165769cca2094728ed07acff2d0e8f81c4f4ef7d7250cf1a9b70d9ebbe45ce9138bb72d5
+  data.tar.gz: 8f65a5fcbf1472e0e13ed5eede66ccba8d66f58c0989de3d2efdc8f2d83b8be2aeca015079449028514fce052aeff6e6f9df86d97ea4e87a148b041c2a0faf38

data/.gitignore

@@ -0,0 +1 @@
+.env

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nyt_cli.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"
+
+# gem "nyt_cli"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    nyt_cli (0.1.0)
+      colorize
+      launchy
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  nyt_cli!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 alliecaton
+
+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) 2021 Allie
+
+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,40 @@
+# NytCli
+
+Welcome to the New York Times Fiction Bestsellers CLI gem! In this application, you are able to view the NYT bestselling fiction books for a given date, view more information about the books on the list for each date, and save books that interest you to a collection. 
+
+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/nyt_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+<!-- Add this line to your application's Gemfile:
+
+```ruby
+gem 'nyt_cli'
+``` -->
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nyt_cli
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 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]/nyt_cli.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nyt_cli"
+
+# 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/nyt-books

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby 
+require './lib/nyt_cli'
+
+NytCli::Cli.new.start

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/nyt_cli.rb

@@ -0,0 +1,21 @@
+# environment
+
+require 'date'
+require 'time'
+require 'colorize'
+require 'dotenv/load'
+require 'pry'
+require 'launchy'
+require 'open-uri'
+require 'net/http'
+require 'json'
+require_relative "nyt_cli/version"
+require_relative './nyt_cli/cli.rb'
+require_relative './nyt_cli/book.rb'
+require_relative './nyt_cli/api.rb'
+
+
+
+# puts String.colors
+# puts String.modes
+# puts String.color_samples

data/lib/nyt_cli/api.rb

@@ -0,0 +1,28 @@
+class NytCli::Api
+
+    attr_accessor :date
+
+    def initialize(date)
+        @date = date
+        create_book
+    end
+
+    ## Calls on the API with the date initialized
+    def get
+        url = "https://api.nytimes.com/svc/books/v3/lists/#{@date}/combined-print-and-e-book-fiction.json?api-key=#{ENV["API_KEY"]}"
+        uri = URI.parse(url)
+        response = Net::HTTP.get_response(uri)
+        response_hash = JSON.parse(response.body)
+        response_hash["results"]["books"]
+    end
+
+
+    ## Creates a book using a hash of relevant attributes
+    def create_book
+        get.each do |book|
+            new_book = NytCli::Book.new(book)
+        end
+    end
+
+end 
+

data/lib/nyt_cli/book.rb

@@ -0,0 +1,58 @@
+class NytCli::Book
+
+    attr_accessor :title, :author, :rank, :description, :buy_links
+
+    @@all = [] ## All book instances
+    @@all_selected = [] ## All book instances that the user has viewed
+    @@saved = [] ## Books user has saved to their session collection
+
+    ## Initializes book with only specified keys of a hash-- possibly add where to buy later
+    def initialize(hash)
+        @title = title
+        @author = author
+        # @description = description
+        hash.each do |key,value| 
+            if key == "title" 
+                self.send(("#{key}="), value)
+            elsif key == "rank"
+                self.send(("#{key}="), value)
+            elsif key == "author"
+                self.send(("#{key}="), value)
+            elsif key == "description"
+                self.send(("#{key}="), value)
+            elsif key == "buy_links"
+                self.send(("#{key}="), value)
+            end
+        end
+        save
+    end 
+
+    def save 
+        @@all << self
+    end
+
+    def self.all
+        @@all
+    end
+    
+    def self.all_viewed
+        @@all_selected
+    end
+
+    def self.collection
+        @@saved
+    end
+
+    def self.find_by_title(title)
+        @@all.find do |book|
+            if book.title == title
+                book
+            end
+        end
+    end
+    
+    def self.reset!
+        @@all.clear
+    end
+
+end

data/lib/nyt_cli/cli.rb

@@ -0,0 +1,216 @@
+class NytCli::Cli
+
+@@emojis= ["🚨", "📚", "👋"]
+
+    ## Kickstarts the CLI 
+
+    def start
+        call
+        ask_input
+    end
+
+    def call
+        puts "\n\n#{@@emojis[1]} Welcome to the New York Times Bestseller List CLI. Within this CLI, you will be able to view the books on the NYT Bestselling Fiction list for a given date. #{@@emojis[1]} \n\n".cyan.bold.center(100)
+    end
+
+    ## Asks for initial user input
+    def ask_input 
+        puts "\n\nPlease choose an option by entering a number:\n\n"
+        puts "[1]  ".yellow + "Get fiction bestsellers list for a given date"
+        puts "[2]  ".yellow + "View your saved books"
+        puts "[3]  ".yellow + "Exit the application\n\n"
+        input = gets.chomp.downcase.strip
+
+        case input 
+        when "1"
+            get_date
+        when "2"
+            puts "\n"
+            view_saved
+        when "3"
+            puts "Goodbye! #{@@emojis[2]}"
+            sleep(1)
+            exit! 
+        else
+            puts "\n#{@@emojis[0]} Please enter the number that corresponds with what you would like to do. #{@@emojis[0]}\n".red
+            sleep(1)
+            ask_input
+        end
+    end
+
+    ## Get user date they would like to view 
+    def get_date
+        puts "\nThe first published online NYT Bestsellers list was on 2011-02-13.\nTo get started, please enter a date (YYYY-MM-DD):\n".yellow
+        date = gets.chomp
+        if valid_date?(date) && valid_timeframe?(date)
+            create_api_and_book(date)
+        end
+    end
+
+    ## Checks if date is real and in the correct format
+    def valid_date?(date)
+        Date.valid_date? *"#{Date.strptime(date,"%Y-%m-%d")}".split('-').map(&:to_i) 
+        rescue 
+            puts "\n#{@@emojis[0]} Oops! That input is invalid. Please input a valid date using YYYY-MM-DD #{@@emojis[0]}\n".red
+            sleep(1)
+            get_date
+    end
+
+    ## Checks to make sure the date is between the NYT start date, and the current date
+    def valid_timeframe?(date)
+        new_date = Time.new(date.split("-")[0].to_i, date.split("-")[1].to_i, date.split("-")[2].to_i)
+        nyt_start_date = Time.new(2011, 2, 13)
+        if new_date <= Time.now && new_date >= nyt_start_date
+            true
+        else
+            puts "\n#{@@emojis[0]} Oops! That input is invalid. Make sure your date falls between now and 2011-02-13 #{@@emojis[0]}\n".red
+            sleep(1)
+            get_date
+        end
+    end
+
+    ## creates the new API call, initialized with validated input date. Once called, asks user for input
+    def create_api_and_book(date)
+        NytCli::Book.reset!
+        api= NytCli::Api.new(date)
+        ask
+    end
+
+    ## Asks user what they want to do 
+    def ask
+        puts "\n\nHere are the best selling books for that date. Choose a book to view more information.\n  ".yellow
+        list_books
+        puts "\nPlease enter the number that corresponds to the book you would like to view\n".yellow
+        num = gets.chomp.to_i
+        puts "\n"
+        if num.between?(1,NytCli::Book.all.count)
+            show_book(num)
+        else
+            puts "#{@@emojis[0]} Please input a valid number #{@@emojis[0]}"
+            sleep(1)
+            ask
+        end
+    end
+
+    ## List all books
+    def list_books
+        NytCli::Book.all.each.with_index(1) do |book,index|
+            puts "[#{index}]  ".green + "#{book.title.downcase.split(/ |\_|\-/).map(&:capitalize).join(" ")} - #{book.author}".white
+        end
+    end
+
+    ## View saved collection for session if your collection count is greater than 0
+    def view_saved
+        if  NytCli::Book.collection.count != 0
+             NytCli::Book.collection.uniq.each.with_index(1) do |book,index|
+                puts "[#{index}]  ".green + "#{book.title.downcase.split(/ |\_|\-/).map(&:capitalize).join(" ")} - #{book.author}".white
+             end
+            collection_options
+        else 
+            puts "\n#{@@emojis[0]} You have no saved books #{@@emojis[0]}\n\n"
+            sleep(1)
+            ask_input
+        end
+    end
+
+    def collection_options
+        puts "\n\nIf you would like more information on any of your saved books, input the number associated with the book you would like to view"
+        num = gets.chomp.to_i
+        if num.between?(1,NytCli::Book.collection.count)
+            show_from_collection(num)
+        end
+    end
+
+    ## Show individual chosen book from collection 
+    def show_from_collection(num)
+        chosen_book = NytCli::Book.collection[num - 1]
+        NytCli::Book.all_viewed << chosen_book
+        puts "Title: ".blue + "#{chosen_book.title.downcase.split(/ |\_|\-/).map(&:capitalize).join(" ")} \n" + "Author: ".blue + "#{chosen_book.author}" + " \nRank: ".blue + "#{chosen_book.rank}" + " \nDescription: ".blue + "#{chosen_book.description}\n\n"
+        from_collection_menu
+    end 
+
+    def from_collection_menu
+        puts "What would you like to do? Please input a number\n\n"
+        puts "[1]  ".yellow + "Return to your collection"
+        puts "[2]  ".yellow + "Buy book"
+        puts "[3]  ".yellow + "Return to main menu"
+        puts "[4]  ".yellow + "Exit the application\n\n"
+        input = gets.chomp.downcase.strip
+
+        case input 
+        when "1"
+            view_saved
+        when "2"
+            buy_book(NytCli::Book.all_viewed.last.title)
+        when "3"
+            ask_input
+        when "4"
+            puts "Goodbye! #{@@emojis[2]}"
+            sleep(1)
+            exit! 
+        else
+            puts "\n #{@@emojis[0]} Please enter the number that corresponds with what you would like to do. #{@@emojis[0]}\n".red
+            sleep(1)
+            from_collection_menu
+        end
+    end
+
+    ## Shows attributes of individaul book after selected by user, saves the user choice into class array @@all_selected for easy access
+    def show_book(num)
+        chosen_book = NytCli::Book.all[num - 1]
+        NytCli::Book.all_viewed << chosen_book
+        puts "Title: ".blue + "#{chosen_book.title.downcase.split(/ |\_|\-/).map(&:capitalize).join(" ")} \n" + "Author: ".blue + "#{chosen_book.author}" + " \nRank: ".blue + "#{chosen_book.rank}" + " \nDescription: ".blue + "#{chosen_book.description}\n\n"
+        indiv_book_menu
+    end
+
+    ## Menu choices for individual book 
+    def indiv_book_menu
+        puts "What would you like to do? Please input a number\n\n"
+        puts "[1]  ".yellow + "Select another book from the list"
+        puts "[2]  ".yellow + "Buy book"
+        puts "[3]  ".yellow + "Add book to session collection"
+        puts "[4]  ".yellow + "Return to main menu"
+        puts "[5]  ".yellow + "Exit the application\n\n"
+        input = gets.chomp.downcase.strip
+
+        case input 
+        when "1"
+            self.ask
+        when "2"
+            buy_book(NytCli::Book.all_viewed.last.title)
+        when "3"
+            add_to_collection
+        when "4"
+            ask_input
+        when "5"
+            puts "Goodbye! #{@@emojis[2]}"
+            sleep(1)
+            exit! 
+        else
+            puts "\ #{@@emojis[0]} Please enter the number that corresponds with what you would like to do. #{@@emojis[0]}\n".red
+            sleep(1)
+            indiv_book_menu
+        end
+    end
+
+    ## Links out to a B&N link for selected book 
+    def buy_book(title)
+        current_book = NytCli::Book.find_by_title (title)
+        current_book.buy_links.each do |shop|
+            if shop["url"].include? "barnes"
+                Launchy.open(shop["url"])
+                self.ask_input
+            end 
+        end 
+    end
+
+    ## Adds book to collection for the session 
+    def add_to_collection
+        NytCli::Book.collection << NytCli::Book.all_viewed.last
+        puts "\nYou've added " + "#{NytCli::Book.all_viewed.last.title.downcase.split(/ |\_|\-/).map(&:capitalize).join(" ")} ".blue + "to your saved collection for the session.\n\n"
+        sleep(1)
+        self.ask_input
+    end
+
+
+end

data/lib/nyt_cli/version.rb

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

data/nyt_cli.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/nyt_cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nyt_cli"
+  spec.version       = NytCli::VERSION
+  spec.authors       = ["Allie Caton"]
+  spec.email         = ["alliecaton3@gmail.com"]
+
+  spec.summary       = "Get a list of all the NYT Bestseller Ficition books for a given date, and get more information about each book."
+  spec.homepage      = "https://github.com/alliecaton/nyt_bestsellers_CLI"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/alliecaton/nyt_bestsellers_CLI"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "colorize"
+  spec.add_dependency "launchy"
+
+
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: nyt_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Allie Caton
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  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:
+email:
+- alliecaton3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/nyt-books
+- bin/setup
+- lib/nyt_cli.rb
+- lib/nyt_cli/api.rb
+- lib/nyt_cli/book.rb
+- lib/nyt_cli/cli.rb
+- lib/nyt_cli/version.rb
+- nyt_cli.gemspec
+- pkg/nyt_cli-0.1.0.gem
+homepage: https://github.com/alliecaton/nyt_bestsellers_CLI
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/alliecaton/nyt_bestsellers_CLI
+  source_code_uri: https://github.com/alliecaton/nyt_bestsellers_CLI
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Get a list of all the NYT Bestseller Ficition books for a given date, and
+  get more information about each book.
+test_files: []