top_songs 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0d46decbaa8da838760f21f529a6976bd5202c8108d0e5cc6047f64bbedbd51
+  data.tar.gz: 5cbea5e1abc7e32d887af104a4bcf909d591abec9656a81693396edf73fa43dd
+SHA512:
+  metadata.gz: 9291547efb1383f29f2f2ca4b9777eee38837356864fb8f412d1d958983beb8dc9ba600a2938588babbe7f0b2c23abc3b4087af823f466f27e1fa3cca4254c42
+  data.tar.gz: b0c5ea34343dc7e16f0536d3cf1e48a88510678f90cb09f991d1973f0606f600c6bb31fefa4f641e3c973bf70452d67a7d099d2ae0c51214711cf9d25536e5b8

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 'read.musik@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 top_songs.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    top_songs (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)
+  pry
+  rake (~> 10.0)
+  top_songs!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Antonio Reid
+
+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,41 @@
+# TopSongs
+
+This is a Ruby Gem, which provides a CLI to view a user selected number of top songs based on the billboard.com 'hot-100' chart.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'top_songs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install top_songs
+
+## Usage
+
+Type $ top_songs and follow prompts. 
+
+## 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/'AReid987'/top_songs. 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 TopSongs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'AReid987'/top_songs/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 "top_songs"
+
+# 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/top_songs

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "top_songs"
+
+TopSongs::CLI.new.call

data/lib/top_songs.rb

@@ -0,0 +1,9 @@
+require "open-uri"
+require "nokogiri"
+require "pry"
+
+
+require_relative "./top_songs/version"
+require_relative "./top_songs/song"
+require_relative "./top_songs/cli"
+require_relative "./top_songs/song_scraper"

data/lib/top_songs/cli.rb

@@ -0,0 +1,63 @@
+class TopSongs::CLI
+
+  @@song_number = nil
+
+  def self.song_number
+    @@song_number
+  end
+
+  def call
+    TopSongs::Song.all_songs.clear
+    puts "How many top songs would you like to see? (enter 1 - 100)"
+    @@song_number = gets.strip.to_i
+
+    puts "Today's top #{@@song_number} songs:"
+
+    TopSongs::SongScraper.new.make_songs
+    list_songs
+    print_song
+  end
+
+  def list_songs
+    @songs = TopSongs::Song.all_songs
+    @songs.each do |song|
+      puts "#{song.number}. #{song.name}"
+    end
+  end
+
+  def print_song
+    input = nil
+    while input != "exit"
+      puts "Enter the number of the song you'd like more info on, type list to relist songs or type exit:"
+
+      input = gets.strip
+
+      if input.to_i > 0 && @songs.length >= input.to_i
+        the_song = @songs[input.to_i - 1]
+        puts "#{the_song.number}. #{the_song.artist} - #{the_song.name} - #{the_song.last_week} "
+      elsif input == "list"
+        list_songs
+      elsif input == "exit"
+        goodbye
+      else
+        puts "Invalid entry..."
+      end
+    end
+  end
+
+  def goodbye
+    puts "Would you like to try a different number of songs? (y/n)"
+
+    input = gets.strip.downcase
+
+    if input == 'y' || input == 'yes'
+      call
+    elsif input = 'n' || input == 'no'
+      puts "Thanks! Goodbye."
+    else
+      puts "Invalid entry, please enter y or n..."
+    end
+
+  end
+
+end

data/lib/top_songs/song.rb

@@ -0,0 +1,21 @@
+class TopSongs::Song
+
+  attr_accessor :number, :name, :artist, :last_week
+
+  @@all_songs = []
+
+  def self.all_songs
+    @@all_songs
+  end
+
+  def self.create_songs(song)
+      new_song = TopSongs::Song.new
+      new_song.name = song.css("h2.chart-row__song").text
+      new_song.artist = song.css(".chart-row__artist").text.strip
+      new_song.number = song.css("span.chart-row__current-week").text
+      new_song.last_week = song.css("span.chart-row__last-week").text
+
+      @@all_songs << new_song
+  end
+
+end

data/lib/top_songs/song_scraper.rb

@@ -0,0 +1,19 @@
+class TopSongs::SongScraper
+
+  def open_page
+    Nokogiri::HTML(open("https://www.billboard.com/charts/hot-100")) #open page
+  end
+
+  def scrape_songs 
+    self.open_page.css("div.chart-row__main-display")
+  end
+
+  def make_songs
+    scrape_songs.each do |song|
+      if TopSongs::Song.all_songs.length <= TopSongs::CLI.song_number - 1
+        TopSongs::Song.create_songs(song)
+      end
+    end
+  end
+
+end

data/lib/top_songs/version.rb

@@ -0,0 +1,3 @@
+module TopSongs
+  VERSION = "0.0.0"
+end

data/spec.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application #CLI accepts user input do determine how many songs to scrape, and then lists those song name. Next it asks if user would like more info on a particular song and also provides the option to relist songs again. Finally, a user can exit and then, optionally choose to list a different number of songs.
+- [x] Pull data from an external source #data is scraped from the billboard top 100 list using Nokogiri and open-uri
+- [x] Implement both list and detail views #the number of songs chose is first listed and further details can be displayed based on user input. 

data/top_songs.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "top_songs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "top_songs"
+  spec.version       = TopSongs::VERSION
+  spec.authors       = ["'Antonio Reid'"]
+  spec.email         = ["'read.musik@gmail.com'"]
+
+  spec.summary       = %q{Top Songs}
+  spec.description   = %q{List top songs and get more info on desired songs.}
+  spec.homepage      = "https://github.com/AReid987/top_songs"
+  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"] = "'http://www.rubygems.com'"
+  #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 "pry"
+
+  spec.add_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: top_songs
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- "'Antonio Reid'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-24 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: List top songs and get more info on desired songs.
+email:
+- "'read.musik@gmail.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/top_songs
+- lib/top_songs.rb
+- lib/top_songs/cli.rb
+- lib/top_songs/song.rb
+- lib/top_songs/song_scraper.rb
+- lib/top_songs/version.rb
+- spec.md
+- top_songs-0.1.0.gem
+- top_songs.gemspec
+homepage: https://github.com/AReid987/top_songs
+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: Top Songs
+test_files: []