swole-news 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 664c1d6976da01027ac6e56b945e29db1aad1705a3da2cc362aeaabe1b3da133
+  data.tar.gz: 55c4705bfa18370ebc317271bad7a2c79cbb94ffb6a9058e3bb08d9a4653e602
+SHA512:
+  metadata.gz: ef1818bea05accf9cf9e80f0158bc83decdee66e176e903c8fb9d6a6aa921d1d966f2c0945472de9004f0092f12aee9b29d7a68e880c826d26cc08c2cfa3436e
+  data.tar.gz: 55835180e32227e4772002683c35af080c84047335ccf41c30d441c24027f7c744cead41ac04ee51629989619fac7c3406184737187174057bba4040fb38d984

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 'kriti.rai@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,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    swole-news (0.1.0)
+      colorize
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    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)
+  pry
+  rake (~> 10.0)
+  rspec
+  swole-news!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Kriti Rai'
+
+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,43 @@
+# SwoleNews
+The swole-news CLI gem scrapes the latest workout articles from www.bodybuilding.com and provides end-users with the list of articles from which they can access specific workouts.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swole-news'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swole-news
+
+## Usage
+
+In the terminal type:
+
+    $ swole-news
+
+## 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/'kriti-rai'/swole-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 SwoleNews project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'kriti-rai'/swole-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,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+# require "swole-news"
+require "swole-news.rb"
+
+# 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/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/bin/swole-news

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require './lib/swole-news'
+CLI.new.call

data/lib/swole-news.rb

@@ -0,0 +1,10 @@
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+
+
+require_relative "./swole-news/version"
+require_relative "./swole-news/CLI"
+require_relative "./swole-news/article"
+require_relative "./swole-news/scraper"
+require_relative "./swole-news/workout"

data/lib/swole-news/CLI.rb

@@ -0,0 +1,124 @@
+class CLI
+
+  def call
+    puts"            ||                             ||".colorize(:red)
+    puts"          ||||||                         ||||||".colorize(:red)
+    puts"=========||||||||=======".colorize(:red)+"SWOLENEWS".colorize(:color => :black, :background => :light_blue).underline+"=======||||||||=========".colorize(:red)
+    puts"          ||||||                         ||||||".colorize(:red)
+    puts"            ||                             ||".colorize(:red)
+    puts ""
+    puts "Tired of your old workout routine? Need some guidance or something new? Look no further!".colorize(:green)
+    sleep(1.5)
+    puts "SwoleNews has got your back!".colorize(:green)
+    sleep(1.5)
+    puts ""
+    puts "Here is what's latest in workout.".colorize(:color => :blue).underline
+    puts ""
+    make_articles
+    list_articles
+    sleep(1)
+    action
+    sleep(1)
+    goodbye
+  end
+
+  def make_articles
+    scraped_articles = Scraper.scrape_page
+    Article.create_from_collection(scraped_articles)
+    @articles = Article.all
+    @articles
+  end
+
+  def list_articles
+    @articles.each.with_index(1) do |article, i|
+      puts "#{i}.".colorize(:blue)+ " #{article.title}".colorize(:red) + " * #{article.read_time} *"
+      puts "--------------------------------------------------------------------------------------------------------".colorize(:green)
+    end
+  end
+
+  def view_articles(input)
+    puts ""
+    sleep(1)
+    puts "Viewing article no.#{input}".colorize(:blue)
+    puts ""
+    puts "== == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == =="
+    sleep(1.5)
+    puts "#{@article.title}".colorize(:red) + " * #{@article.read_time} *"
+    puts "#{@article.description}...".colorize(:yellow)
+    puts "To read more go to:".colorize(:green) + " #{@article.url}".colorize(:blue)
+    puts "== == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == =="
+    puts ""
+    sleep(1)
+  end
+
+  def list_workouts
+    sleep(1)
+    puts "Now listing the workouts...".colorize(:blue)
+    puts "---------------------------".colorize (:yellow)
+    sleep(1.5)
+    @article.workouts.each.with_index(1) do |workout, i|
+      puts "#{i}. #{workout.title}".upcase.colorize(:blue)
+      puts "**#{workout.definition}**".colorize(:yellow)
+    end
+  end
+
+  def view_workouts
+    input = nil
+      while input != "exit"
+        puts "Would you like to view the workouts listed inside the article?".colorize(:green)
+        puts "If yes, please type 'yes' or 'menu' to go back to the main menu or 'exit' to exit.".colorize(:green)
+        input = gets.strip.downcase
+          if input == "yes"
+            list_workouts
+            repeat
+            break
+          elsif input == "menu"
+            list_articles
+            action
+            break
+          elsif input == "exit"
+            break
+          else
+            puts "Not sure what you typed.".colorize(:red)
+          end
+      end
+  end
+
+  def repeat
+    input = nil
+      while input != "exit"
+        puts "Please type 'menu' to go back to the main menu or 'exit' to exit".colorize(:green)
+        input = gets.strip.downcase
+          if input == "menu"
+            list_articles
+            action
+            break
+          elsif input == "exit"
+            break
+          end
+      end
+   end
+
+  def action
+    input = nil
+      while input != "exit"
+        puts "Please enter a number from the list to view the article or enter 'exit' to exit".colorize(:green)
+        input = gets.strip.downcase
+          if input =~ /^-?[0-9]+$/ && input.to_i.between?(1, @articles.size)
+            @article = @articles[input.to_i - 1]
+            view_articles(input)
+            view_workouts
+            break
+          elsif input == "exit"
+            break
+          else
+            puts "Either the number you entered is out of range or is not recognized by the system.".colorize(:red)
+          end
+      end
+  end
+
+  def goodbye
+    puts "Keep up the good work and stay swole! See you soon!".colorize(:yellow)
+  end
+
+end

data/lib/swole-news/article.rb

@@ -0,0 +1,28 @@
+class Article
+  attr_accessor :title, :url, :workouts, :read_time, :description
+
+  @@all = []
+
+  def initialize(article_hash)
+    article_hash.each {|k,v| self.send("#{k}=", v)}
+    @@all << self
+  end
+
+  def self.create_from_collection(article_array)
+    article_array.map{|article_hash|self.new(article_hash)}
+    self.add_workouts
+  end
+
+  def self.add_workouts
+    @@all.map do |article|
+      scraped_workouts = Scraper.scrape_workouts(article.url)
+      article.workouts = Workout.create_from_collection(scraped_workouts)
+      article.workouts.each {|workout| workout.article = article}
+    end
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/swole-news/scraper.rb

@@ -0,0 +1,36 @@
+class Scraper
+
+  def self.scrape_page
+    article_array = []
+
+    doc = Nokogiri::HTML(open('https://www.bodybuilding.com/category/workouts'))
+
+    doc.css(".cms-article-list--article.col.col-1").map do |article|
+      article_hash = {
+        :title => article.search("h3.title").text,
+        :url => article.search("a").attribute('href').to_s,
+        :read_time => article.search(".bb-read-time__time").text,
+        :description => article.search("span.description").text
+        }
+        article_array << article_hash
+      end
+    article_array
+  end
+
+  def self.scrape_workouts(article_url)
+    workout_array = []
+
+    article = Nokogiri::HTML(open(article_url))
+    wrapper = article.search(".cms-article-list__content--wrapper")
+
+    wrapper.search(".cms-article-list__content--container .cms-article-list__content").each do |container|
+        workout_hash = {
+          :title => container.search(".cms-article-workout__exercise--title").text,
+          :definition => container.search(".cms-article-workout__sets--definition span").text.strip
+          }
+        workout_array << workout_hash
+      end
+    workout_array
+  end
+
+end

data/lib/swole-news/version.rb

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

data/lib/swole-news/workout.rb

@@ -0,0 +1,19 @@
+class Workout
+  attr_accessor :title, :definition, :article
+
+  @@all =[]
+
+  def initialize(workout_hash)
+    workout_hash.each {|k,v| self.send("#{k}=",v)}
+    @@all << self
+  end
+
+  def self.create_from_collection(workout_array)
+    workout_array.map {|workout_hash| self.new(workout_hash)}
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/spec.md

@@ -0,0 +1,14 @@
+Specifications for the CLI Assessment
+Specs:
+
+ [X] Have a CLI for interfacing with the application
+
+ My CLI interface resides in the CLI.rb file that outlines how the user will be prompted for an input in various scenarios. It calls in various helper methods to create articles, view and list the articles and the workouts, and an exit option to quit the program.
+
+ [X]Pull data from an external source
+
+    My Scraper class extracts a list of articles and workouts inside from http://bodybuilding.com/category/workouts using various css selectors and returns arrays of those elements that are hashes.
+
+ [X]Implement both list and detail views
+
+    The users are provided with a list of articles that consists of the title of an article and read-time. After choosing an article, the viewer will get to see the same info alongside a brief description of the article and a URL. The viewer will then get an option to view the workouts listed inside the article, which then consists of a number of workouts.

data/swole-news.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "swole-news/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "swole-news"
+  spec.version       = SwoleNews::VERSION
+  spec.authors       = ["'Kriti Rai'"]
+  spec.email         = ["'kriti.rai@gmail.com'"]
+
+  spec.summary       = "Pulls up the latest articles in workouts"
+  spec.homepage      = "https://github.com/kriti-rai/swole-news"
+  spec.license       = "MIT"
+
+  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"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "colorize"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: swole-news
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Kriti Rai'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-15 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 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'
+description: 
+email:
+- "'kriti.rai@gmail.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/swole-news
+- lib/swole-news.rb
+- lib/swole-news/CLI.rb
+- lib/swole-news/article.rb
+- lib/swole-news/scraper.rb
+- lib/swole-news/version.rb
+- lib/swole-news/workout.rb
+- spec.md
+- swole-news.gemspec
+homepage: https://github.com/kriti-rai/swole-news
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key: 
+specification_version: 4
+summary: Pulls up the latest articles in workouts
+test_files: []