npr_cli_news_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0282b5253c821956490204a4adf96a3f885e4704a29f24c5a3b727f587606ede'
+  data.tar.gz: 0c39ac6ce0f78180f918516a021a53b12c68424ced4feb289dca848c0bae2f54
+SHA512:
+  metadata.gz: 5e667fdd0f7f01947aa464738464ead24113fcf83a514341e7d40ab8c8be8087fd5b81c398cf40162f20f1aaa39deee9ecb7a2956f2077a4b2b946ae6590ea4d
+  data.tar.gz: d5a4690e13a8455aa6787d0ac23d55a46ff4012ccce8c02da0d3e5736496c6857b0c3ce70561f21a9e4d11019d3cbc9cf43273474b2a56e5b957c90ecfd77584

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 'bballwiz4@gmail.com'. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in npr_cli_news_reader.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    npr_cli_news_reader (0.1.0)
+      nokogiri
+      rainbow
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  npr_cli_news_reader!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 'Jake Garcia'
+
+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,46 @@
+# NprCliNewsReader
+
+This Gem allows a user to choose from a list of news categories. The ClI then displays the articles from npr.org that are under the selected category. Then the user can select a specific article. Once an article is selected then the full article will be displayed. Once the user gets to the end of the article they have a choice to exit the program or return to the category selection.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'npr_cli_news_reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install npr_cli_news_reader
+
+## Usage
+
+In Terminal enter:
+
+  ruby -Ilib ./bin/npr_cli_news_reader
+  
+This command will start up the CLI application
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/'jGarcia4444'/npr_cli_news_reader. 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 NprCliNewsReader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'jGarcia4444'/npr_cli_news_reader/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/npr_cli_news_reader"
+
+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
+
+

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/npr_cli_news_reader/article.rb

@@ -0,0 +1,34 @@
+class NprCliNewsReader::Article
+  
+  attr_accessor :category, :title, :short_description, :full_article, :article_url
+  
+  @@all = []
+  
+  def initialize(article_attributes)
+    article_attributes.each { |k, v| self.send("#{k}=", v.strip) }
+    @@all << self
+  end
+  
+  def self.all 
+    @@all
+  end
+  
+  def self.find_by_category(filter)
+    self.all.detect {|article| article.category == filter}
+  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
+  end
+  
+  def self.sort_articles(filter)
+    self.all.select {|article| article.category == filter}
+  end
+  
+  
+  
+end

data/lib/npr_cli_news_reader/cli.rb

@@ -0,0 +1,84 @@
+class NprCliNewsReader::CLI 
+  
+  attr_accessor :done, :selected_category
+  
+  @sorted_articles = []
+  
+  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
+  end
+  
+  def display_article_categories
+    puts "----Article Categories----"
+    @categories.each_with_index {|category, i| puts "#{i + 1}.) #{Rainbow(category).bright}"}
+  end
+  
+  def valid_input?(user_input, collection)
+    if user_input.to_i > 0 && user_input.to_i <= collection.size
+      return true
+    else
+      return false
+    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
+  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 "-------------------"
+    end
+  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)
+    end
+  end
+  
+  def display_selected_article(article)
+    puts '-------------------'
+    puts Rainbow(article.title).bright
+    article.full_article.each { |text| puts "#{text}\n"}
+    puts '(END)'
+  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
+    end
+  end
+  
+  
+end

data/lib/npr_cli_news_reader/scraper.rb

@@ -0,0 +1,35 @@
+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
+  
+  #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)
+    end
+  end
+  
+  def self.get_full_article(article_url)
+    html = open(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
+  end
+  
+end

data/lib/npr_cli_news_reader/version.rb

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

data/lib/npr_cli_news_reader.rb

@@ -0,0 +1,12 @@
+require_relative "./npr_cli_news_reader/version"
+require_relative "./npr_cli_news_reader/cli"
+require_relative "./npr_cli_news_reader/scraper"
+require_relative "./npr_cli_news_reader/article"
+require 'open-uri'
+require 'nokogiri'
+require 'rainbow'
+
+module NprCliNewsReader
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/npr_cli_news_reader.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "npr_cli_news_reader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "npr_cli_news_reader"
+  spec.version       = NprCliNewsReader::VERSION
+  spec.authors       = ["'Jake Garcia'"]
+  spec.email         = ["'bballwiz4@gmail.com'"]
+
+  spec.summary       = %q{"A CLI that allows users to read news articles from npr.org."}
+  spec.description   = %q{"This Gem allows a user to choose from a list of news categories. The ClI then displays the articles from npr.org that are under the selected category. Then the user can select a specific article. Once an article is selected then the full article will be displayed. Once the user gets to the end of the article they have a choice to exit the program or return to the category selection."}
+  spec.homepage      = "https://github.com/jgarcia4444/npr_cli_news_reader.git"
+  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"] = 'https://RubyGems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/jgarcia4444/npr_cli_news_reader.git"
+    spec.metadata["changelog_uri"] = "https://github.com/jgarcia4444/npr_cli_news_reader.git"
+  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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "rainbow"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: npr_cli_news_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Jake Garcia'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 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: rainbow
+  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: '"This Gem allows a user to choose from a list of news categories. The
+  ClI then displays the articles from npr.org that are under the selected category.
+  Then the user can select a specific article. Once an article is selected then the
+  full article will be displayed. Once the user gets to the end of the article they
+  have a choice to exit the program or return to the category selection."'
+email:
+- "'bballwiz4@gmail.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/npr_cli_news_reader
+- bin/setup
+- 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/scraper.rb
+- lib/npr_cli_news_reader/version.rb
+- npr_cli_news_reader.gemspec
+homepage: https://github.com/jgarcia4444/npr_cli_news_reader.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://RubyGems.org
+  homepage_uri: https://github.com/jgarcia4444/npr_cli_news_reader.git
+  source_code_uri: https://github.com/jgarcia4444/npr_cli_news_reader.git
+  changelog_uri: https://github.com/jgarcia4444/npr_cli_news_reader.git
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: '"A CLI that allows users to read news articles from npr.org."'
+test_files: []