nj_fishing_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e356ea8f39961e1408a44ea10732a0eb3371ebb4a7aa2e713fcab52b66110696
+  data.tar.gz: 434bc3239956db9d331fc7d5a8625515ce2aa4686280679747b9d2cb6c157b9f
+SHA512:
+  metadata.gz: 4d0d2768db32b678f15cfc7884a055ec4d7ca551d5e33860601c36687dfae319180cae1ed6e89be1f91cf2024d232682a52de83e40e2a4218c40de3147dc48c4
+  data.tar.gz: 2a5e531980bb798a9db8a5b242b350d629cbaf5bfc5e7c3a6fb15ef12ed31098e3c0eadb147c1fcd589385525ea34d3ca5aa89da8a6773be7950d816df15f624

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 <github email address>. 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 nj_fishing_report.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    nj_fishing_report (0.1.0)
+
+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)
+  nj_fishing_report!
+  nokogiri
+  pry
+  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 <github username>
+
+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/NOTES.md

@@ -0,0 +1,15 @@
+How to build a CLI gem
+
+1. Plan your gem, imagine your interface
+2. Start with the project structure - google
+3. Start with the entry point - the file run
+4. Force that to build the CLI interface
+5. Stub out the interface
+6. Start making things real
+7. Discover objects.
+8. Program
+
+- Greet user
+- Present user with menu and asks for user input to choose either a list from the menu or exit
+- If list, present with list and an option to choose an item from the list
+- If exit, give a farewell message and quit program

data/README.md

@@ -0,0 +1,43 @@
+# NjFishingReport
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nj_fishing_report`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nj_fishing_report'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nj_fishing_report
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/<github username>/nj_fishing_report. 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 NjFishingReport project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/<github username>/nj_fishing_report/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 "nj_fishing_report"
+
+# 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/nj_fishing_report

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../lib/nj_fishing_report.rb"
+
+NjFishingReport::CLI.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/lib/nj_fishing_report.rb

@@ -0,0 +1,9 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+
+require_relative "../lib/nj_fishing_report/version"
+require_relative "../lib/nj_fishing_report/cli"
+require_relative "../lib/nj_fishing_report/fishing_location"
+require_relative "../lib/nj_fishing_report/fishing_report"
+require_relative "../lib/nj_fishing_report/scraper"

data/lib/nj_fishing_report/cli.rb

@@ -0,0 +1,123 @@
+
+class NjFishingReport::CLI
+
+  def call
+    greeting
+    create_fishing_location_and_report
+    run_program_interface
+  end
+
+  def greeting
+    puts " "
+    puts " "
+    puts "Welcome to the New Jersey Fishing Report CLI"
+    puts " "
+    puts " "
+    puts "Loading...."
+    puts " "
+    puts " "
+  end
+
+  def run_program_interface
+    loop do
+      puts "-----------------------------------------"
+      puts " "
+      puts "For a list of fishing spots, enter 'list'"
+      puts " "
+      puts "-----------------------------------------"
+      puts " "
+      puts "To quit, enter 'exit'"
+      puts " "
+      puts "-----------------------------------------"
+      puts " "
+      puts "What would you like to do?"
+      puts " "
+      puts " "
+      input = gets.strip.downcase
+      puts " "
+      puts " "
+
+      if input == 'exit'
+        goodbye
+        break
+      elsif input == 'list'
+        list_fishing_locations
+        fishing_report
+      else
+        puts "+++++++++++++++++++++++++++"
+        puts "+++++++++++++++++++++++++++"
+        puts " "
+        puts "Please type a valid entry"
+        puts " "
+        puts "+++++++++++++++++++++++++++"
+        puts "+++++++++++++++++++++++++++"
+        puts " "
+        puts " "
+        sleep(2)
+      end
+    end
+  end
+
+  def create_fishing_location_and_report
+    NjFishingReport::Scraper.scrape_fishing_location
+    NjFishingReport::Scraper.scrape_fishing_report
+  end
+
+  def list_fishing_locations
+    puts "-----------------------------------------"
+    puts " "
+    puts " "
+    puts "*Fishing Locations in NJ*"
+    puts " "
+    puts " "
+    NjFishingReport::Fishing_Location.all.each_with_index do |location, index|
+      puts "#{index + 1}. #{location.name}"
+      puts " "
+    end
+  end
+
+  def fishing_report
+    puts " "
+    puts "Please input a number, or enter 'exit' to return to the main menu."
+    puts " "
+    puts " "
+    input = gets.strip.downcase
+    puts " "
+    puts " "
+    loop do
+      if input == "exit"
+        break
+      elsif input.to_i < 1 || input.to_i > NjFishingReport::Fishing_Location.all.length
+        puts "That is not a valid entry. Please input a number between 1 and #{NjFishingReport::Fishing_Location.all.length}, or type 'exit'"
+        puts " "
+        puts " "
+        input = gets.strip.downcase
+      else
+        puts "********************************"
+        puts "Fishing Report for #{NjFishingReport::Fishing_Location.all[input.to_i-1].name}:"
+        puts "********************************"
+        puts " "
+        puts NjFishingReport::Fishing_Report.all[input.to_i-1].report
+        puts " "
+        sleep(2)
+        break
+      end
+    end
+  end
+
+  def goodbye
+    puts "-----------------------------------------"
+    puts " "
+    puts " "
+    puts "Happy Fishing!"
+    puts " "
+    puts "Give a man a fish, and you feed him for a day."
+    puts "Teach a man to fish, and you feed him for a lifetime."
+    puts "- Unidentified Wise Man"
+    puts " "
+    puts " "
+    puts "-----------------------------------------"
+    puts " "
+    puts " "
+  end
+end

data/lib/nj_fishing_report/fishing_location.rb

@@ -0,0 +1,20 @@
+
+class NjFishingReport::Fishing_Location
+
+  attr_accessor :name, :fishing_report, :url
+  @@all = []
+
+  def initialize(name)
+    @name = name
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.find_by_name(name)
+    self.all.detect {|instance| instance.name == name}
+  end
+
+end

data/lib/nj_fishing_report/fishing_report.rb

@@ -0,0 +1,15 @@
+class NjFishingReport::Fishing_Report
+
+  attr_accessor :report, :fishing_location
+  @@all = []
+
+  def initialize(report)
+    @report = report
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/nj_fishing_report/scraper.rb

@@ -0,0 +1,48 @@
+
+class NjFishingReport::Scraper
+
+BASE_PATH = "http://www.fishingreportsnow.com/New_Jersey_Fishing_Reports_Pro.cfm/reg/7"
+
+  def self.scrape_fishing_location
+
+    doc = Nokogiri::HTML(open(BASE_PATH))
+
+    fishing_locations = []
+
+    doc.css("td.reportstext a").each do |potential_location|
+      if potential_location.attribute("href").value[0,30] == "New_Jersey_Fishing_Reports_Pro" && potential_location.text != "Last Week's Report"
+        fishing_locations << potential_location
+      end
+    end
+
+    fishing_locations.each do |location|
+      fishing_location = location.text
+       fishing_location = NjFishingReport::Fishing_Location.new(location.text)
+      fishing_location.url = "http://www.fishingreportsnow.com/" + location.attribute("href").value
+    end
+  end
+
+
+  def self.scrape_fishing_report
+
+    NjFishingReport::Fishing_Location.all.each do |location|
+
+      doc = Nokogiri::HTML(open(location.url))
+
+      doc.css("td.reportstext").each do |scraping_only_if_fishing_report|
+        if scraping_only_if_fishing_report.attribute("align").value == "left"
+
+          instance_of_fishing_report = NjFishingReport::Fishing_Report.new(scraping_only_if_fishing_report.text.strip)
+
+          instance_of_fishing_report.fishing_location = NjFishingReport::Fishing_Location.all.detect {|instance| instance.name == location.name}
+
+          instance_of_fishing_location = NjFishingReport::Fishing_Location.all.detect {|instance| instance.name == location.name}
+
+          instance_of_fishing_location.fishing_report = instance_of_fishing_report
+
+        end
+      end
+    end
+  end
+
+end

data/lib/nj_fishing_report/version.rb

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

data/nj_fishing_report.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nj_fishing_report/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nj_fishing_report"
+  spec.version       = NjFishingReport::VERSION
+  spec.authors       = ["David Kim"]
+  spec.email         = ["davidjkim810@gmail.com"]
+
+  spec.summary       = %q{"This gem allows users to view fishing reports in NJ"}
+  spec.description   = %q{View the most recent fishing reports in New Jersey. Select a location on the list of popular fishing locations and receive a report.}
+  spec.homepage      = "https://github.com/davidjkim810/nj_fishing_report"
+  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://github.com/davidjkim810/nj_fishing_report"
+  # 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", ">= 0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "nokogiri", ">= 0"
+end

data/spec.md

@@ -0,0 +1,16 @@
+# Specifications for the CLI Assessment
+
+Specs:
+
+- [x] Have a CLI for interfacing with the application
+
+The #call method hosts all the other methods that allow the CLI to run. #greeting welcomes the user. #create_fishing_location_and_report calls the method that scrapes information. #run_program_interface pulls up a main menu that is interactive via user input. From the #run_program_interface a user can choose to see the list of fishing locations or quit the program. Finally, within the #run_program_interface is the #goodbye method that prints a good bye message upon program termination.
+
+
+- [X] Pull data from an external source
+
+I have created a BASE_PATH that pulls up a New Jersey Fishing Report website. The two scraping methods use Nokogiri and Open URI to scrape relevant information from the website--and one level deep in the website(fishing_report is one level deep).
+
+- [X] Implement both list and detail views
+
+I have implemented the list view by allowing users to select the list of fishing locations from the main menu. If the user choose to view the list, there is a list of updated fishing locations. Further, by selecting the number of an individual fishing location the user can see the details of that selection. In this case, the details are the actual fishing report of the individual fishing location.

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: nj_fishing_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Kim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-04 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: 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: nokogiri
+  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'
+description: View the most recent fishing reports in New Jersey. Select a location
+  on the list of popular fishing locations and receive a report.
+email:
+- davidjkim810@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/console
+- bin/nj_fishing_report
+- bin/setup
+- lib/nj_fishing_report.rb
+- lib/nj_fishing_report/cli.rb
+- lib/nj_fishing_report/fishing_location.rb
+- lib/nj_fishing_report/fishing_report.rb
+- lib/nj_fishing_report/scraper.rb
+- lib/nj_fishing_report/version.rb
+- nj_fishing_report.gemspec
+- spec.md
+homepage: https://github.com/davidjkim810/nj_fishing_report
+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.4
+signing_key: 
+specification_version: 4
+summary: '"This gem allows users to view fishing reports in NJ"'
+test_files: []