crowder_news 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c7c01afae8c729c166ca6c2f4808b6feb1d102064fab4a1a60a96f96625c4c1
+  data.tar.gz: dd54e58e3566e519099e7de310a4f995f435659f27447909ef09b50f5b2989b8
+SHA512:
+  metadata.gz: b80232cfef1c3ca331a44d622ce580c7f45f05ede69417f6f42dc4aee1bf2bb877d6d029742feb2ef6986cce62610cb138ef8ae862a523b29cbf4e032200a4d6
+  data.tar.gz: d538cc90f09fbea96819fbdaec7978f3bbdac4fa49e1d5340ca786e08c98a6ec437d2aaba19737dba8c3120a53a66d37b76a346f5c0a6bfb408b63faf1e76d91

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 'raustin.melchior@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in crowder_news.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    crowder_news (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  crowder_news!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Richard Melchior'
+
+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,38 @@
+# CrowderNews
+
+Welcome to CrowderNews! Crowder news is a gem that scrapes the LouderWithCrowder website for news articles and allows you to view recent and feature articles. The CLI is simple with concise instruction and is very easy to use!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crowder_news'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crowder_news
+
+## Usage
+
+1. Start the program using "./bin/crowder_news".
+2. Choose which mode you would like the list to use.
+3. Choose an article from the list.
+4. Follow the prompts to move between menus and articles
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/'Sillhouette'/crowder_news. 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 CrowderNews project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'Sillhouette'/crowder_news/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 "crowder_news"
+
+# 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

data/bin/crowder_news

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require './lib/crowder_news'
+
+CLI.new.initiate

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/crowder_news.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "crowder_news/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "crowder_news"
+  spec.version       = CrowderNews::VERSION
+  spec.authors       = ["'Richard Melchior'"]
+  spec.email         = ["'raustin.melchior@gmail.com'"]
+
+  spec.summary       = %q{News article scraper from www.louderwithcrowder.com}
+  spec.description   = %q{Scrapes recent and featured articles from www.louderwithcrowder.com}
+  spec.homepage      = "https://github.com/Sillhouette/crowder_news-cli-app"
+  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"
+  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   = ["crowder_news"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "nokogiri"
+end

data/lib/crowder_news/article.rb

@@ -0,0 +1,64 @@
+##
+# => Handles Article object creation
+##
+class Article
+  # => Accessors for article details
+  attr_accessor :title, :link, :excerpt, :type, :author, :date, :body, :youtube_links
+
+  # => Set each of our Class arrays to a blank array
+  @@all = []
+  @@recents = []
+  @@featured = []
+
+  ##
+  # => Creates new Article objects
+  ##
+  def initialize(article_hash)
+    @title = article_hash[:title]
+    @link = article_hash[:link]
+    @excerpt = article_hash[:excerpt]
+    @type = article_hash[:type]
+
+    if @type.downcase == "recent"
+      @@recents << self
+    elsif @type.downcase == "featured"
+      @@featured << self
+    end
+    @@all << self;
+  end
+
+  ##
+  # => Creates articles from a hash of article information
+  ##
+  def self.create_from_collection(articles_array)
+    articles_array.each { |hash|
+      self.new(hash)
+    }
+  end
+
+  ##
+  # => Adds the additional details to our Article object
+  ##
+  def add_details(details_hash)
+    @author = details_hash[:author]
+    @date = details_hash[:date]
+    @body = details_hash[:body]
+    @youtube_links = details_hash[:youtube_links]
+  end
+
+  # => Getter returns all of our article objects
+  def self.all
+    @@all;
+  end
+
+  # => Getter returns all of our recent articles
+  def self.recents
+    @@recents
+  end
+
+  # => Getter returns all of our featured articles
+  def self.featured
+    @@featured
+  end
+
+end

data/lib/crowder_news/cli.rb

@@ -0,0 +1,110 @@
+##
+# => Handles all interfacing with our user
+##
+class CLI
+  # => Articles array accessor
+  attr_accessor :articles
+
+  # => Intiates the program, scrapes the website and welcomes the user
+  def initiate
+    Scraper.initiate_scrape
+    puts "Welcome to Today on Crowder!"
+    list_articles
+  end
+
+  ##
+  # => Lists the articles according to the user's preferences
+  ##
+  def list_articles
+    input = nil
+    choices = 'Choose one: recent, featured, or both. To exit type "exit".'
+    puts choices
+    input = gets.strip.downcase
+    puts ""
+    if input == "recent"
+      puts "Recent Articles: "
+      @articles = Article.recents
+      display_list(@articles)
+      menu
+    elsif input == "featured"
+      puts "Featured Articles: "
+      @articles = Article.featured
+      display_list(@articles)
+      menu
+    elsif input == "both"
+      puts "All articles: "
+      @articles = Article.all
+      display_list(@articles)
+      menu
+    elsif input == "exit"
+      goodbye
+    else
+      list_articles
+    end
+
+  end
+
+  ##
+  # => Displays a list of articles for the user
+  ##
+  def display_list(articles)
+    articles.each.with_index(1) do |article, index|
+      puts "#{index}. #{article.title}"
+      if(article.excerpt != "")
+        puts "\t#{article.excerpt[0...98]}..."
+      end
+    end
+    puts ""
+  end
+
+  ##
+  # => Gives the user the options to view articles, switch lists, or exit the program
+  ##
+  def menu
+    input = nil
+    puts "Enter the number of the article you want to see, type list to list the articles again or type exit: "
+    input = gets.strip.downcase
+    if input.to_i > 0 && input.to_i < @articles.length + 1
+      article = @articles[input.to_i - 1]
+      display_article(article)
+    elsif input == "list"
+      list_articles
+    elsif input == "exit"
+      goodbye
+    else
+      puts "Please make a valid selection."
+      menu
+    end
+  end
+
+  ##
+  # => Displays all of the article information for the user to read
+  ##
+  def display_article(article)
+    input = nil
+    puts "\n#{article.title}"
+    puts "\nAuthor: #{article.author} on #{article.date}: "
+    puts "\n\t#{article.body}"
+    if article.youtube_links
+      puts "\nYoutube Links:"
+      article.youtube_links.each{ |link|
+        puts link
+      }
+    end
+    puts 'Press any key to find another article or "exit" to exit.'
+    input = gets.strip.downcase
+    if input == "exit"
+      goodbye
+    else
+      list_articles
+    end
+  end
+
+  ##
+  # => Tells the user goodbye and exits program
+  ##
+  def goodbye
+    puts "\nSee you next time!"
+  end
+
+end

data/lib/crowder_news/scraper.rb

@@ -0,0 +1,75 @@
+##
+# => Scraper scrapes the articles from the front page of www.louderwithcrowder.com
+#    Scrapes the data from each article to be displayed to the user via CLI
+##
+class Scraper
+
+  @@url = "https://www.louderwithcrowder.com"
+
+  ##
+  # => This method iniates the scrape from our website
+  ##
+  def self.initiate_scrape
+    Article.create_from_collection(self.scrape_featured)
+    Article.create_from_collection(self.scrape_recent)
+    Article.all.each {|article|
+      details = self.scrape_details(article.link)
+      article.add_details(details)
+    }
+  end
+
+  ##
+  # => Scrapes the featured articles from LwC
+  ##
+  def self.scrape_featured
+    doc = Nokogiri::HTML(open(@@url))
+    articles = []
+    doc.css("div.lwc-featured").each {|featured_article|
+      featured_article.css(".featured-box").each { |box|
+        title = box.css("h3.featured-title a").text
+        link = box.css("h3.featured-title a").attribute("href").value
+        excerpt = box.css("p.lwc-excerpt").text
+        type = "Featured"
+        articles << {:title => title, :link => link, :excerpt => excerpt, :type => type}
+      }
+    }
+    articles
+  end
+
+  ##
+  # => Scrapes the recent articles from LwC
+  ##
+  def self.scrape_recent
+    doc = Nokogiri::HTML(open(@@url))
+    articles = []
+    doc.css("div.lwc-recent").each {|article|
+      article.css(".recent-box").each { |box|
+        title = box.css("h3.recent-title a").text
+        link = box.css("h3.recent-title a").attribute("href").value
+        type = "Recent"
+        excerpt = ""
+        articles << {:title => title, :link => link, :excerpt => excerpt, :type => type}
+      }
+    }
+    articles
+  end
+
+  ##
+  # => Pulls the articles details from each article url so we can complete out Article objects
+  ##
+  def self.scrape_details(article_url)
+    doc = Nokogiri::HTML(open(article_url))
+    
+    article_info = {}
+
+    article_info[:author] = doc.css("h2 span.lwc-author").text
+    article_info[:date] = doc.css("h2 span.lwc-date").text
+    article_info[:body] = doc.css("p").text
+    article_info[:youtube_links] = []
+    doc.css("div.fluid-width-video-wrapper").each { |wrapper|
+      article_info[:youtube_links] << wrapper.css("iframe").attribute("src").value
+    }
+    article_info
+  end
+
+end

data/lib/crowder_news/version.rb

@@ -0,0 +1,3 @@
+module CrowderNews
+  VERSION = "0.1.3"
+end

data/lib/crowder_news.rb

@@ -0,0 +1,8 @@
+require 'nokogiri'
+require 'pry'
+require 'open-uri'
+
+require_relative "./crowder_news/version"
+require_relative './crowder_news/cli'
+require_relative './crowder_news/article'
+require_relative './crowder_news/scraper'

data/notes.md

@@ -0,0 +1,24 @@
+Command line interface for news stories
+
+User types news
+
+Show a list of news stories
+News story 1
+News story 2
+
+Which story would you like to see?
+
+Scraping Louderwithcrowder.com
+
+Scraping the landing page for each news story
+
+
+What is an article?
+
+an article has a title
+an article has a date
+an article has an author
+an article has a body
+an article can contain images
+an article can contain videos
+an article has a URL

data/spec.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application - The CLI is build out of the cli.rb file and controls the entire application
+- [x] Pull data from an external source - The data pulling is done in scraper.rb and pulls the articles from the frontpage of the website and the details from each article page thereafter.
+- [x] Implement both list and detail views - There is an option to list out each of the articles in three different lists, recent, featured, and both. After you choose a list mode you are able to pick an article and get a detailed view of the information in that article.

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: crowder_news
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- "'Richard Melchior'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-13 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: 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'
+description: Scrapes recent and featured articles from www.louderwithcrowder.com
+email:
+- "'raustin.melchior@gmail.com'"
+executables:
+- crowder_news
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/crowder_news
+- bin/setup
+- crowder_news.gemspec
+- lib/crowder_news.rb
+- lib/crowder_news/article.rb
+- lib/crowder_news/cli.rb
+- lib/crowder_news/scraper.rb
+- lib/crowder_news/version.rb
+- notes.md
+- spec.md
+homepage: https://github.com/Sillhouette/crowder_news-cli-app
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: News article scraper from www.louderwithcrowder.com
+test_files: []