national_parks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd06358a0ed346b7a761882c570db552d70ba539
+  data.tar.gz: 5969c934578fba14638edda648dde33cd7f6cf8b
+SHA512:
+  metadata.gz: d205bbce6b572d486b8a6b911f685d7da1dafe33796a0bb5e30d097136b31805b087b4087f7e7c9b76db77f7d481a06d707a1f8d041226fda38d9322578767a5
+  data.tar.gz: 55af8d0a7e14b8ce7047b18b6c60ccaf00401688602a94457a50f79722b5739e36de4f05e3774faea161e0513e690a2c0a919546516efd46d45d51ca986309dd

data/.gitignore

@@ -0,0 +1,50 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

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 jarrel.delottinville@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in national_parks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jarrel deLottinville
+
+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,29 @@
+# NationalParks
+
+This CLI gem provides a list and details of national parks by state or territory as provided by the U.S. National Park Service website.
+
+## Installation
+
+	$ gem install national_parks
+
+## Usage
+
+Type the following command in your computer's terminal and follow the on-screen prompts.
+
+	$ national_parks
+
+## 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/Jdville03/national-parks-cli-gem. 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](http://opensource.org/licenses/MIT).
+

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,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "national_parks"
+
+# 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
+
+# reload changed files in irb session
+def reload!
+  load_all "./lib/national_parks"
+end
+
+require "irb"
+IRB.start(__FILE__)

data/bin/national_parks

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/national_parks"
+
+NationalParks::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/national_parks.rb

@@ -0,0 +1,16 @@
+# environment file
+
+require "open-uri"
+require "nokogiri"
+require "pry"
+require "require_all"
+require "colorize"
+require "terminal-table"
+
+require_relative "./national_parks/version"
+require_relative "./national_parks/cli"
+require_relative "./national_parks/scraper"
+require_relative "./national_parks/state"
+require_relative "./national_parks/park"
+
+class InvalidType < StandardError; end

data/lib/national_parks/cli.rb

@@ -0,0 +1,83 @@
+class NationalParks::CLI
+	
+  def initialize
+    welcome
+    NationalParks::Scraper.scrape_find_park_page
+  end
+
+  def call
+    list_states
+    state_selection
+    list_parks
+    menu
+  end
+
+  def welcome
+    system("clear")
+    puts " ----------------------------------------"
+    puts "|                                         |"
+    puts "|        Welcome to National Parks        |"
+    puts "|                                         |"
+    puts " ----------------------------------------"
+    puts "\nFind information about the national parks located in any of the U.S. states or territories"
+  end
+
+  def list_states
+    # states/territories displayed in table format with 2 columns
+    all_rows = []
+    row = []
+    NationalParks::State.all.each.with_index(1) do |state, index|
+      row = [] if index.odd?
+      row << "#{index}. #{state.name}"
+      all_rows << row if index.even? || index == NationalParks::State.all.length
+    end
+    table = Terminal::Table.new :title => "U.S. States and Territories", :rows => all_rows
+    puts "\n#{table}"
+  end
+
+  def state_selection
+    puts "\nSelect a state or territory by " + "number".underline + " or " + "name".underline + ":"
+    state_input = gets.strip
+    if state_input.to_i.between?(1, NationalParks::State.all.length)
+      @state = NationalParks::State.find_state(state_input)
+    elsif NationalParks::State.find_state_by_name(state_input)
+      @state = NationalParks::State.find_state_by_name(state_input)
+    else
+      puts "Invalid entry.".colorize(:red)
+      state_selection
+    end
+  end
+
+  def list_parks
+    NationalParks::Scraper.scrape_state_page(@state) if @state.parks.empty? # conditional modifier to prevent redundant scraping and instantiation of state's park objects if that state was previously selected by the user
+    system("clear")
+    puts "\nNational Parks in #{@state.name}:"
+    @state.parks.each.with_index(1) do |park, index|
+      sleep(0.25)
+      puts "\n----------------------------------------------".colorize(:green)
+      puts "#{index}. #{park.name}".colorize(:blue)
+      puts ""
+      puts "Type:         #{park.type}" if park.type
+      puts "Location:     #{park.location}" if park.location
+      puts "Description:  #{park.description}"
+    end
+  end
+
+  def menu
+    puts "\nTo see more information in your web browser for a national park in #{@state.name}, enter the " + "number".underline + " of the park.\nType " + "list".underline +  " to see the states and territories again or type " + "exit".underline + "."
+    input = gets.strip
+    if input.to_i.between?(1, @state.parks.length)
+      system("open #{@state.find_park(input).more_info_url}")
+      menu
+    elsif input.downcase == "list"
+      system("clear")
+      call
+    elsif input.downcase == "exit"
+      puts "\nGet out and enjoy the national parks! Goodbye!\n".colorize(:green)
+    else
+      puts "\nInvalid entry.".colorize(:red)
+      menu
+    end
+  end		
+
+end

data/lib/national_parks/park.rb

@@ -0,0 +1,21 @@
+class NationalParks::Park
+
+  attr_accessor :type, :name, :location, :description, :more_info_url
+  attr_reader :state # belongs to state object interface
+
+  def initialize(park_attribute_hash = nil)
+    if park_attribute_hash
+      park_attribute_hash.each{|key, value| self.send("#{key}=", value)}
+    end
+  end
+
+  def state=(state) # belongs to state object interface
+    if !state.is_a?(NationalParks::State)
+      raise InvalidType, "#{state.class} received, State expected"
+    else
+      @state = state
+      state.add_park(self) unless state.parks.include?(self)
+    end
+  end
+
+end

data/lib/national_parks/scraper.rb

@@ -0,0 +1,34 @@
+class NationalParks::Scraper
+
+  BASE_PATH = "https://www.nps.gov"
+  @@state_names = []
+
+  def self.scrape_find_park_page # class method instantiates new state objects with parameter of hash of state attributes (:name, :url) scraped from NPS website
+    find_park_page ||= Nokogiri::HTML(open("https://www.nps.gov/findapark/index.htm"))
+    find_park_page.css("map#Map area").each do |state|
+      # condition to prevent instantiation of new state object if that state was already created (state is listed more than once in scraped data)
+      if !@@state_names.include?(state.attr("alt"))
+        @@state_names << state.attr("alt")
+        
+        state_attributes_hash = {name: state.attr("alt"), url: BASE_PATH + state.attr("href")}
+        NationalParks::State.new(state_attributes_hash)
+      end
+    end
+  end
+
+  def self.scrape_state_page(state) # class method adds new park objects to existing state object after instantiating new park objects with parameter of hash of park attributes (:type, :name, :location, :description, :more_info_url) scraped from NPS website
+    state_page ||= Nokogiri::HTML(open(state.url))
+    state_page.css("div.list_left").each do |park|
+      park_attributes_hash = {}
+      park_attributes_hash[:type] = park.css("h2").text.strip if park.css("h2").text.match(/\S/) # conditional modifier to account for some park listings not including :type attribute
+      park_attributes_hash[:name] = park.css("a").text.strip
+      park_attributes_hash[:location] = park.css("h4").text.strip.gsub(/\s{2,}/, " ") if park.css("h4").text.match(/\S/) # conditional modifier to account for some park listings not including :location attribute; #gsub required to clean up formatting in source code
+      park_attributes_hash[:description] = park.css("p").text.strip
+      park_attributes_hash[:more_info_url] = BASE_PATH + park.css("a").attr("href")
+
+      park = NationalParks::Park.new(park_attributes_hash)
+      state.add_park(park)		
+    end
+  end
+
+end

data/lib/national_parks/state.rb

@@ -0,0 +1,44 @@
+class NationalParks::State
+  
+  attr_accessor :name, :url
+
+  @@states = []
+
+  def initialize(state_attribute_hash = nil)
+    if state_attribute_hash
+      state_attribute_hash.each{|key, value| self.send("#{key}=", value)}
+    end
+    @parks = [] # has many park objects interface
+    @@states << self
+  end
+
+  def parks # has many park objects interface
+    @parks.dup.freeze.sort_by{|park| park.name} # park objects of each state object stored in alphabetical order by name
+  end
+
+  def add_park(park) # has many park objects interface
+    if !park.is_a?(NationalParks::Park)
+      raise InvalidType, "#{park.class} received, Park expected"
+    else
+      @parks << park unless @parks.include?(park)
+      park.state = self unless park.state == self
+    end
+  end
+
+  def find_park(id)
+    parks[id.to_i - 1]
+  end
+
+  def self.all
+    @@states.sort_by{|state| state.name} # state objects stored in alphabetical order by name
+  end
+
+  def self.find_state_by_name(name)
+    self.all.detect{|state| state.name.downcase == name.downcase}
+  end
+
+  def self.find_state(id)
+    self.all[id.to_i - 1]
+  end
+  
+end

data/lib/national_parks/version.rb

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

data/national_parks.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'national_parks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "national_parks"
+  spec.version       = NationalParks::VERSION
+  spec.date          = "2017-04-11"
+  spec.authors       = ["Jarrel deLottinville"]
+  spec.email         = ["jarrel.delottinville@gmail.com"]
+
+  spec.summary       = %q{National parks by U.S. state or territory.}
+  spec.description   = %q{List and details of national parks by state or territory as provided by the U.S. National Park Service website.}
+  spec.homepage      = "https://github.com/Jdville03/national-parks-cli-gem"
+  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'] = "TODO: Set to 'http://mygemserver.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.executables = ["national_parks"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "require_all"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "colorize"
+  spec.add_dependency "terminal-table"
+end

data/spec.md

@@ -0,0 +1,7 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [X] Have a CLI for interfacing with the application - The CLI allows user to select a state/territory by number or name from a list in order to view brief summaries of the national parks in that state/territory. The CLI then allows user to view more information on a specific park in the web browswer. The CLI also allows the user to search again for a different state/territory. 
+- [X] Pull data from an external source - Scraper class pulls data from U.S. National Park Service website.
+- [X] Implement both list and detail views - CLI class lists states/territories and provides more detail views of national parks within the selected state/territory.
+

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: national_parks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jarrel deLottinville
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  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'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  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 and details of national parks by state or territory as provided
+  by the U.S. National Park Service website.
+email:
+- jarrel.delottinville@gmail.com
+executables:
+- national_parks
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/national_parks
+- bin/setup
+- lib/national_parks.rb
+- lib/national_parks/cli.rb
+- lib/national_parks/park.rb
+- lib/national_parks/scraper.rb
+- lib/national_parks/state.rb
+- lib/national_parks/version.rb
+- national_parks.gemspec
+- spec.md
+homepage: https://github.com/Jdville03/national-parks-cli-gem
+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.6.11
+signing_key: 
+specification_version: 4
+summary: National parks by U.S. state or territory.
+test_files: []