npr_cli_news_reader 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da71f6df65e63af78bf564427c36a4c603061489a952ac62ef2246681314a0da
-  data.tar.gz: 424b403cfb52c5565c9b5dc21df9a4ae6a4a68c927d4f1c6e1d767543f2a97b5
+  metadata.gz: a6bc48b3aa6d5410a0a6bd8ceab34c05615646322a0e7d3e63b2871d9ba44d9f
+  data.tar.gz: caa3b3ca9ae015d245156380ae3eb7c01086b08eedb2fae0808590db80e1299e
 SHA512:
-  metadata.gz: e2affc610e2be4c98577ab38872f7c3185e87268202d60fdc72d01bb7df46135c690dd64173487e7f7e53341eeadfd7df60d3439a7bbe137c2cc8c3e3c199d35
-  data.tar.gz: 249f6bccc02c1e7a03ed522f07ee6758e5db7a05a899e89b3806788f0d7886796f3146cd1174d195eb419c73b6eab358764d4ca14cc498a434d9494488382810
+  metadata.gz: 24e3a943d90ad23e31097b7764b73b20731db83bc987871ac4711788b65458d4d16b54dc177f73cbcbcd57321b7f8873a906dbcb9ced69e05e06b6fa23a9e1cf
+  data.tar.gz: 57fa73b4db9f2990b6ae13d2cd204e15af1b94799f0b52e602f7bde9c34a1790bfacf12f64225290a3aeb8145796795e16aad48d9f05156ef3b4b069e5132976

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    npr_cli_news_reader (0.1.6)
+    npr_cli_news_reader (0.2.0)
       nokogiri
       rainbow
 

data/README.md

@@ -23,6 +23,7 @@ Or install it yourself as:
 In Terminal enter once installed:
 
   irb
+  > require 'npr_cli_news_reader'
   > NprCliNewsReader::Run.start
   
 This command will start up the CLI application

data/bin/npr_cli_news_reader

@@ -2,6 +2,7 @@
 
 require_relative "../lib/npr_cli_news_reader"
 
+NprCliNewsReader::CLI.new.call
 
 
 

data/lib/npr_cli_news_reader.rb

@@ -1,11 +1,12 @@
-require_relative './npr_cli_news_reader/version'
-require_relative './npr_cli_news_reader/article'
-require_relative './npr_cli_news_reader/cli'
-require_relative './npr_cli_news_reader/run'
-require_relative'./npr_cli_news_reader/scraper'
 require 'open-uri'
 require 'nokogiri'
 require 'rainbow'
+require 'pry'
+require_relative './npr_cli_news_reader/version'
+require_relative './npr_cli_news_reader/article'
+require_relative'./npr_cli_news_reader/scraper'
+require_relative './npr_cli_news_reader/cli'
+
 
 
 module NprCliNewsReader

data/lib/npr_cli_news_reader/article.rb

@@ -1,6 +1,6 @@
 class NprCliNewsReader::Article
   
-  attr_accessor :category, :title, :short_description, :full_article, :article_url
+  attr_accessor :category, :title, :teaser, :full_article, :article_url, :author, :date
   
   @@all = []
   
@@ -13,22 +13,12 @@ class NprCliNewsReader::Article
     @@all
   end
   
-  def self.find_by_category(filter)
-    self.all.detect {|article| article.category == filter}
+  def add_full_article(full_article)
+    self.full_article = full_article
   end
   
-  def self.find_or_create_articles(filter)
-    if self.find_by_category(filter) == nil
-      NprCliNewsReader::Scraper.get_articles("/sections/#{filter}")
-    else
-      self.sort_articles(filter)
-    end
+  def self.sort_articles_by_category(filter)
+    self.all.select {|article| article.category == filter.downcase}
   end
   
-  def self.sort_articles(filter)
-    self.all.select {|article| article.category == filter}
-  end
-  
-  
-  
 end

data/lib/npr_cli_news_reader/cli.rb

@@ -1,25 +1,35 @@
 class NprCliNewsReader::CLI 
   
-  attr_accessor :done, :selected_category
-  
-  @sorted_articles = []
+  attr_accessor :selected_category
   
   def initialize
     @categories = ["National", "World", "Politics", "Business", "Health", "Science", "Technology", "Race & Culture"]
-    @done = false
   end
   
-  def greeting
-    puts
-    puts "--------Hello fellow fact finder!--------"
-    puts
-    puts "---Welcome to the NPR CLI News Reader----"
-    puts
+  def call
+    greet_user
+    present_categories
+    handle_category_input
+    handle_article_selection
+  end  
+  
+  def greet_user
+    puts Rainbow("Hello fellow fact finder...").bright
+    puts Rainbow("Welcome to the Npr Cli News Reader.").bright.fg(:green)
+    puts "--------------------"
+    sleep(1.5)
   end
   
-  def display_article_categories
-    puts "----Article Categories----"
-    @categories.each_with_index {|category, i| puts "#{i + 1}.) #{Rainbow(category).bright}"}
+  def present_categories
+    puts Rainbow("Categories").bright
+    puts "--------------------"
+    @categories.each_with_index do |category, i|
+      if i.even?
+        puts Rainbow("#{i + 1}). #{category}").bright
+      else
+        puts Rainbow("#{i + 1}). #{category}").bright.fg(:green)
+      end
+    end
   end
   
   def valid_input?(user_input, collection)
@@ -30,55 +40,75 @@ class NprCliNewsReader::CLI
     end
   end
   
-  def handle_category_input(user_input)
-    if valid_input?(user_input, @categories)
-      categories_index = user_input.to_i - 1
-      @selected_category = @categories[categories_index].downcase
-      NprCliNewsReader::Article.find_or_create_articles(@selected_category)
-      @sorted_articles = NprCliNewsReader::Article.sort_articles(@selected_category)
-      display_articles
-    end
+  def format_teaser(teaser_string)
+    formatted_teaser = teaser_string.split(/\A.+[\u0095]\s/)[1]
+    formatted_teaser
   end
   
-  def display_articles
-    puts "----- #{Rainbow(@sorted_articles.first.category.capitalize).bright} Category -----"
-    @sorted_articles.each_with_index do |article, i|
-      sleep(0.5)
-      puts "#{i + 1}). #{Rainbow(article.title).bright}"
-      puts "#{article.short_description}"
-      puts "-------------------"
+  def handle_category_input
+    puts Rainbow("Which Category would you like to see articles for?").bright
+    puts "Use the numbers associated with the categories."
+    category_input = gets.strip
+    while !valid_input?(category_input, @categories)
+      puts "Sorry, the input received is not valid to select a category"
+      puts "Please enter a number 1-#{@categories.size}:"
+      category_input = gets.strip  
     end
+    @selected_category = @categories[category_input.to_i - 1].downcase
+    puts Rainbow("#{@selected_category.capitalize} Category").bright
+    puts "--------------------"
+    NprCliNewsReader::Scraper.scrape_articles_for_category(@selected_category)
+    display_category_articles
   end
   
-  def handle_article_input(user_input)
-    if valid_input?(user_input, @sorted_articles)
-      article_index = user_input.to_i - 1
-      selected_article = @sorted_articles[article_index]
-      puts 'Loading...'
-      full_article = NprCliNewsReader::Scraper.get_full_article(selected_article.article_url)
-      selected_article.full_article = full_article
-      sleep(2)
-      display_selected_article(selected_article)
+  def display_category_articles
+    NprCliNewsReader::Article.sort_articles_by_category(@selected_category).each_with_index do |article, i|
+      formatted_teaser = format_teaser(article.teaser)
+      if i % 2 == 0
+        puts Rainbow("#{i + 1}").bright + ")." + Rainbow(" #{article.title}").bright
+        puts
+        puts Rainbow("#{formatted_teaser}")
+        puts
+        puts "--------------------"
+        puts
+      else
+        puts Rainbow("#{i + 1}). #{article.title}").bright.fg(:green)
+        puts
+        puts Rainbow("#{formatted_teaser}").fg(:green)
+        puts
+        puts "--------------------"
+        puts
+      end
     end
   end
   
-  def display_selected_article(article)
-    puts '-------------------'
-    puts Rainbow(article.title).bright
-    article.full_article.each { |text| puts "#{text}\n"}
-    puts '(END)'
+  def handle_article_selection
+    sorted_articles = NprCliNewsReader::Article.sort_articles_by_category(@selected_category)
+    puts Rainbow("Which article would you like to see the full article for?").bright
+    puts "Use the numbers associated with the articles."
+    article_input = gets.strip
+    while !valid_input?(article_input, sorted_articles)
+      puts "Sorry, the input received is not valid to select an article"
+      puts "Please enter a number 1-#{sorted_articles.size}:"
+      article_input = gets.strip
+    end
+    article = sorted_articles[article_input.to_i - 1]
+    NprCliNewsReader::Scraper.scrape_full_article(article)
+    display_full_article(article)
   end
   
-  def restart_or_exit(user_input)
-    if user_input == 'home' 
-      puts "Redisplaying categories"
-      sleep(1)
-    elsif user_input == 'exit'
-      puts "Thanks for using NPR CLI News Reader."
-      puts "Goodbye!"  
-      @done = true
+  def display_full_article(article)
+    puts Rainbow("#{article.title}").bright
+    puts "--------------------"
+    article.full_article.each do |paragraph_node| 
+      puts "\t#{paragraph_node.text}"
+      puts "--------------------"
+    end
+    puts Rainbow("Would you like to see the article on your default web browse? (y/n):").bright
+    user_input = gets.strip
+    if ["yes, y"].include?(user_input.downcase)
+      system("open #{article.article_url}")
     end
   end
   
-  
 end

data/lib/npr_cli_news_reader/scraper.rb

@@ -1,35 +1,33 @@
 class NprCliNewsReader::Scraper
   
-  # Return an array of articles, all attributes set except for full_article
-  def self.get_articles(category_url)
-    html = open("https://www.npr.org#{category_url}")
-    doc = Nokogiri::HTML(html)
-    category = category_url.split("/")[2]
-    articles = doc.css("article.item")
-    self.get_and_set_article_attributes(articles, category)
-  end
+  @@base_url = "https://www.npr.org"
   
-  #loop over article_nodes grabbing the relevant data for the Article attributes
-  def self.get_and_set_article_attributes(article_nodes, category)
-    article_nodes.each do |article|
-      anchor_tag = article.css('.teaser a')
-      article_attributes = {
-        category: category,
-        title: article.css('.title').text,
-        short_description: article.css('.teaser').text,
-        article_url: anchor_tag.attribute('href').to_s
-      }
-      NprCliNewsReader::Article.new(article_attributes)
+  def self.scrape_articles_for_category(selected_category)
+    if NprCliNewsReader::Article.all.detect {|article| article.category == selected_category}
+      return
+    else
+      html = open("#{@@base_url}/sections/#{selected_category}")
+      doc = Nokogiri::HTML(html)
+      articles = doc.css('article.item')
+      articles.each do |article|
+        article_attributes = {
+          category: selected_category.downcase,
+          title: article.css('h2.title a').text.strip,
+          teaser: article.css('p.teaser a').text.strip,
+          article_url: article.css('h2.title a').attr('href').to_s.strip
+        }
+        NprCliNewsReader::Article.new(article_attributes)
+      end
     end
+    
   end
   
-  def self.get_full_article(article_url)
-    html = open(article_url)
+  def self.scrape_full_article(article)
+    html = open (article.article_url)
     doc = Nokogiri::HTML(html)
-    full_article_container = doc.css('#storytext')
-    content = full_article_container.css('p')
-    text_array = content.map {|p_element| p_element.text.strip}
-    text_array
+    # discard the first p tag
+    paragraphs = doc.css('#storytext > p')
+    article.full_article = paragraphs
   end
   
 end

data/lib/npr_cli_news_reader/version.rb

@@ -1,3 +1,3 @@
 module NprCliNewsReader
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/to_do_notes.md

@@ -0,0 +1,21 @@
+TO DO NOTES
+
+  - Once the article is read, give the user options
+    - exit the program
+    - go back to article selection
+    - go back to category selection
+  
+  - Another feature could be to add a clickable link at the bottom of 
+  the article that states if clicked it will take them to the article 
+  on the NPR website.
+
+  - Complete documentation for github
+    - description
+    - collaboration guidelines
+  
+  - Complete documentation and setup as Ruby gem on rubygems.org 
+    - possibly use a tool for documentation
+    - description
+    - usage
+    - installation process
+    

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: npr_cli_news_reader
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - "'Jake Garcia'"
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,10 +104,10 @@ files:
 - lib/npr_cli_news_reader.rb
 - lib/npr_cli_news_reader/article.rb
 - lib/npr_cli_news_reader/cli.rb
-- lib/npr_cli_news_reader/run.rb
 - lib/npr_cli_news_reader/scraper.rb
 - lib/npr_cli_news_reader/version.rb
 - npr_cli_news_reader.gemspec
+- to_do_notes.md
 homepage: https://github.com/jgarcia4444/npr_cli_news_reader.git
 licenses:
 - MIT

data/lib/npr_cli_news_reader/run.rb

@@ -1,21 +0,0 @@
-class NprCliNewsReader::Run
-  def self.start
-    cli = NprCliNewsReader::CLI.new
-    while !cli.done
-      cli.greeting
-      cli.display_article_categories
-      puts "Which category would you like to see news articles for?"
-      puts "(Enter the # associated with the category)"
-      category_input = gets.strip
-      cli.handle_category_input(category_input)
-      puts "Which article would you like to read?"
-      puts "(Enter the number associated with the article):"
-      selected_article = gets.strip
-      cli.handle_article_input(selected_article)
-      puts "Would you like to go back to the category selection or exit the program?"
-      puts "(enter home or exit)"
-      end_of_program_input = gets.strip.downcase
-      cli.restart_or_exit(end_of_program_input)
-    end
-  end  
-end