kdnuggets_roundup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0482a6416c7bf1a135a52332ef66d7c90a66160
+  data.tar.gz: 1d82da742169ee579e80149fbbcef94436807e9c
+SHA512:
+  metadata.gz: f3516ee91a728e9e1c64dd4c94a1dbe31f9f75a423e39d868154dcd9569e7c91a2f79b29c62bd84f0b2391311d65e533e8905be436591866a0a8787ca951ecfc
+  data.tar.gz: 3069281008b350597b43f987a6ca43440f85edd428a039d95713f2638ac58b1f1a06bac8c41933b589ac3addd64903415b4a33b641d98dd310bd350e57b31661

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.3.3
+before_install: gem install bundler -v 1.16.1

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 emily.jirles@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 knuggets_roundup.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    kdnuggets_roundup (0.1.0)
+      nokogiri (~> 1.8, >= 1.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    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.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)
+  kdnuggets_roundup!
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jirles
+
+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,45 @@
+# KnuggetsRoundup
+
+Kdnuggets Roundup is a command-line interface gem that delivers the top articles from [Kdnuggets] (https://www.kdnuggets.com/) directly to your terminal. See the rankings, read excerpts, and, if something catches your eye, open the article in your browser.  
+
+Kdnuggets is a leading website in Data Science, Business Analytics, Big Data, Data Mining, and Machine Learning. It's [award-winning coverage](https://www.kdnuggets.com/about/index.html) is viewed by over 500,000 unique monthly visitors, and over 200,000 subscribers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kdnuggets_roundup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kdnuggets_roundup
+
+## Usage
+
+After initiating the program you'll be guided by menu prompts. Don't worry if you misspell a command! The CLI will prompt you again.
+
+To exit the program, navigate back to the main menu and type 'quit'.
+
+## 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/Jirles/kdnuggets-roundup. 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 KnuggetsRoundup project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Jirles/kdnuggets-roundup/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 "kdnuggets_roundup"
+
+# 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/kdnuggets

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kdnuggets_roundup"
+
+KdnuggetsRoundup::RoundupCLI.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/kdnuggets_roundup.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kdnuggets_roundup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kdnuggets_roundup"
+  spec.version       = KdnuggetsRoundup::VERSION
+  spec.authors       = ["Jirles"]
+  spec.email         = ["emily.jirles@gmail.com"]
+
+  spec.summary       = %q{Get last week's top data science articles from KDnuggets.com. Yee haw!}
+  spec.homepage      = "https://github.com/Jirles/kdnuggets-roundup"
+  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
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'
+end

data/lib/article.rb

@@ -0,0 +1,42 @@
+class KdnuggetsRoundup::Article
+
+  attr_accessor :title, :author, :tags, :url, :summary, :excerpt, :popular, :shared
+  @@all = []
+
+  def initialize(title, url)
+    @title = title
+    @url = url
+    @popular = false
+    @shared = false
+    @@all << self
+  end
+
+  def assign_attributes(attribute_hash)
+    attribute_hash.each{|k, v| self.send("#{k}=", v)}
+  end
+
+  def self.find_by_title(title)
+    all.detect{|story| story.title == title}
+  end
+
+  def add_to_popular
+    @popular = true
+  end
+
+  def add_to_shared
+    @shared = true
+  end
+
+  def self.popular
+    all.select{|a| a.popular}
+  end
+
+  def self.shared
+    all.select{|a| a.shared}
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/datawrassler.rb

@@ -0,0 +1,51 @@
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+
+class KdnuggetsRoundup::DataWrassler
+  #web scraper class
+
+  BASE_URL = 'https://www.kdnuggets.com'
+  TOP_STORIES_PATH = '/news/top-stories.html'
+
+  def wrassle_top_stories #=> Note there are 7 stories in both most popular and most shared each week
+    doc = Nokogiri::HTML(open(BASE_URL + TOP_STORIES_PATH))
+    stories = doc.css('ol.three_ol li')
+    counter = 0
+    stories.each do |story|
+      counter += 1
+      url = BASE_URL + story.css('a').attribute('href').text
+      title = story.css('b').text
+      if KdnuggetsRoundup::Article.find_by_title(title) #=> there are always 14 stories, but there are often duplicates
+        article = KdnuggetsRoundup::Article.find_by_title(title)
+      else
+        article = KdnuggetsRoundup::Article.new(title, url)
+        article.assign_attributes(wrassle_article_attributes(url))
+      end
+      counter < 8 ? article.add_to_popular : article.add_to_shared #=> top stories shows the 7 most popular and 7 most shared articles
+    end
+  end
+
+  def wrassle_article_attributes(article_url)
+    #helper method to be called inside wrassle_top_stories
+    doc = Nokogiri::HTML(open(article_url))
+    tags = doc.css('div.tag-data a')
+    tags = tags.collect{|tag| tag.text}
+    summary = doc.css('p.excerpt').text
+    author = doc.css('#post- b').text.match(/\S*\s\S*[[:punct:]]/)[0].gsub(/[0-9[[:punct:]]]/, '')
+    article = doc.css('p, ol, ul')
+    counter = 0
+    excerpt = []
+    article.each do |paragraph|
+      counter += 1
+      if counter < 3 #=> first two elements are normally bylines or other fluff
+        next
+      elsif counter > 8 #=> ensures only 5 elements make it through
+        break
+      end
+      excerpt << paragraph.text
+    end
+    #excerpt = excerpt.delete_if{|x| x ==''}
+    {author: author, tags: tags, summary: summary, excerpt: excerpt}
+  end
+end

data/lib/kdnuggets_roundup.rb

@@ -0,0 +1,174 @@
+require "kdnuggets_roundup/version"
+require "datawrassler"
+require "article"
+
+module KdnuggetsRoundup
+
+  class RoundupCLI
+    #formatting methods
+    def breakline_space_only
+      puts ""
+    end
+
+    def breakline_title
+      puts ". . ."
+      breakline_space_only
+    end
+
+    def gun_graphic
+      puts ' \\\__________'
+      puts " |    ______-/   ---------------------------------------- =>"
+      puts " / { }"
+      puts "/__/"
+    end
+
+    #article / collection display methods
+
+    def list(collection)
+      collection.each_with_index do |article, i|
+        puts "#{i + 1}. #{article.title}"
+      end
+    end
+
+    def display_article(article)
+      puts <<-DOC
+      #{article.title}
+      By: #{article.author}
+      Tags: #{article.tags.dup.join(', ')}
+
+      Summary
+      -------
+      #{article.summary}
+      DOC
+    end
+
+    def display_rankings
+      puts "Most Popular"
+      list(KdnuggetsRoundup::Article.popular)
+      puts ""
+      puts "Most Shared"
+      list(KdnuggetsRoundup::Article.shared)
+      puts ""
+    end
+
+    def read_excerpt(article)
+      article.excerpt.each do |paragraph|
+        puts paragraph
+      end
+    end
+
+    def call
+      breakline_space_only
+      puts "Howdy, stranger!"
+      breakline_title
+      puts "The Kdnuggets Roundup is your source for the top articles in data science, as curated by KDnuggets.com."
+      puts "Let's see what we can wrassle up..."
+      KdnuggetsRoundup::DataWrassler.new.wrassle_top_stories
+      main_menu
+    end
+
+    def main_menu
+      input = nil
+      while input != 'quit'
+        breakline_title
+        puts "Pick yer poison, friend."
+        breakline_space_only
+        puts "Choose:"
+        puts "'rank' to see the articles ranked by most popular and most shared,"
+        puts "'article' to look more closely at a particular article, or"
+        puts "'quit' to exit the program."
+        gun_graphic
+        input = gets.chomp.downcase
+        breakline_space_only
+        case input
+        when "rank"
+          display_rankings
+        when "article"
+          article_selection_menu
+        when 'quit'
+          break
+        else
+          puts "Sorry, partner. Didn't catch that."
+        end
+      end
+      puts "Time to be hittin' th' ol' dusty trail..."
+      puts "* * * * * * * * * * * * *"
+      puts breakline_space_only
+    end
+
+    #submenu methods
+    def article_selection_menu
+      breakline_space_only
+      avail_choices = (1..KdnuggetsRoundup::Article.all.count).collect{ |num| num.to_s }
+      input = nil
+      while input != 'menu'
+        breakline_title
+        list(KdnuggetsRoundup::Article.all)
+        breakline_space_only
+        puts "Enter an article number and I'll lasso it up for ya."
+        breakline_space_only
+        puts "You can also choose:"
+        puts "'rank' to see the articles ranked by most popular and most shared, or "
+        puts "'menu' to return to the main menu."
+        gun_graphic
+        input = gets.chomp.downcase
+        breakline_space_only
+        if avail_choices.include?(input)
+          puts "Here's that article you asked for:"
+          breakline_space_only
+          chosen_article = KdnuggetsRoundup::Article.all[input.to_i - 1]
+          display_article(chosen_article)
+          article_selection_submenu(chosen_article)
+        elsif input == "rank"
+          rank_submenu
+        elsif input == "menu"
+          break
+        else
+          puts "Sorry, partner. Didn't catch that."
+        end
+      end
+    end
+
+    def rank_submenu
+      input = nil
+      until input == 'menu'
+        breakline_title
+        display_rankings
+        puts "When you're ready to return to the article menu, type 'menu'."
+        gun_graphic
+        input = gets.chomp.downcase
+      end
+    end
+
+    def article_selection_submenu(chosen_article)
+      input = nil
+      while input != 'other'
+        breakline_title
+        puts "Like what you see?"
+        breakline_space_only
+        puts "Choose:"
+        puts "'ex' to read an excerpt from the original article,"
+        puts "'www' to navigate to the original article in your browser,"
+        puts "'menu' to return to the article selection menu."
+        gun_graphic
+        input = gets.chomp.downcase
+        breakline_space_only
+        case input
+        when 'ex'
+          read_excerpt(chosen_article)
+        when 'www'
+          puts "Hold on to yer britches, we're headed to the World Wide Web!"
+          system("open " + chosen_article.url)
+        when 'menu'
+          break #=> breaks out to submenu
+        else
+          puts "Sorry, partner. Didn't catch that."
+        end
+      end
+    end
+
+  end
+
+
+
+end

data/lib/kdnuggets_roundup/version.rb

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

data/spec.md

@@ -0,0 +1,15 @@
+# Specifications for the CLI Assessment
+
+Specs:
+
+[X] Have a CLI for interfacing with the application
+
+    * application has multiple menus that ask for input and provide the user with the appropriate input.
+
+[X] Pull data from an external source
+
+    * pulls data from [kdnuggets.com](https://www.kdnuggets.com/) to show the last week's top articles in the field of data science, machine learning, AI, and others. 
+
+[X] Implement both list and detail views
+   
+    * the user can choose to list all of the articles, see them ranked by most popular and most shared, or choose to look at the details of a particular article.

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: kdnuggets_roundup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jirles
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-14 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: 
+email:
+- emily.jirles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/kdnuggets
+- bin/setup
+- kdnuggets_roundup.gemspec
+- lib/article.rb
+- lib/datawrassler.rb
+- lib/kdnuggets_roundup.rb
+- lib/kdnuggets_roundup/version.rb
+- spec.md
+homepage: https://github.com/Jirles/kdnuggets-roundup
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Get last week's top data science articles from KDnuggets.com. Yee haw!
+test_files: []