national-parks 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 840c57c5e7632027655b30e4d05b67ea670ab9846e16806ef154c1624251e96d
+  data.tar.gz: 4f18556e0550688bfbc1177e862654aaa7e67a48ad7b2f08079a277876733256
+SHA512:
+  metadata.gz: fd7fce833b81c41d18a572e08cd516bffb3e5872fab9a786024a07df3fa60683471b714f2a9847b4fa829e3da3eb83ecc6e86d2b49088d1110dd274d0647eeca
+  data.tar.gz: da6fb59f10c6a7d063b4486d6a95d7ae8e1390f58ef29124ac5c0836bba3776da4939189c78fda8b0bf0f5d430287b47f842f59822f413f412d9d7d3e934fe62

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 brennan@heislercreative.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 national_parks.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    national-parks (0.1.5)
+      colorize
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rake (10.4.2)
+    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)
+  national-parks!
+  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 heislercreative
+
+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,52 @@
+# NationalParks
+
+This gem allows the user to access the National Park Service's "Find a Park" via a CLI and presents a complete list of US states and territories, along with their associated national parks and monuments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'national-parks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install national_parks
+
+## Usage
+
+1) Run `national-parks`
+2) Follow the CLI prompts:
+
+      • Select a state by its list number to view its parks and monuments
+
+      • Select a national park or monument by its list number to view its details
+
+      • Type 'states' to return to the states menu
+
+      • Type 'parks' to return to the parks menu
+
+      • Type 'exit' at any time to exit the CLI
+
+## 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/heislercreative/national-parks-cli. 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 NationalParks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/heislercreative/national-parks-cli/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 "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
+
+require "irb"
+IRB.start(__FILE__)

data/bin/national-parks

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+#require './lib/national_parks'
+# ^^ change to:
+require "bundler/setup"
+require "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,7 @@
+require "open-uri"
+require "nokogiri"
+
+require_relative "./national_parks/version"
+require_relative "./national_parks/CLI"
+require_relative "./national_parks/state"
+require_relative "./national_parks/park"

data/lib/national_parks/CLI.rb

@@ -0,0 +1,108 @@
+# CLI Controller
+require 'colorize'
+
+class NationalParks::CLI
+  BASE_PATH = "https://www.nps.gov"
+
+  # Basic Run #
+  def call
+    welcome
+    NationalParks::State.scrape_states
+    list_states
+  end
+
+
+  # Greetings #
+  def welcome
+    puts ""
+    puts "                                      /\\ ".colorize(:green)
+    puts "                                     //\\\\".colorize(:green)
+    puts "Welcome to the National Park Service!" + " ||".colorize(:black)
+    sleep(1)
+  end
+
+  def goodbye
+    puts ""
+    puts "  Hope to see you again soon!"
+    puts ""
+    exit
+  end
+
+
+  # State Methods #
+  def list_states
+    @states = NationalParks::State.all
+    puts ""
+    @states.each.with_index(1) {|state, i| puts " #{i}. #{state.name}"}
+    state_menu
+  end
+
+  def state_menu
+    puts "Please pick a US state or territory by number."
+    puts "  - Type 'exit' to leave."
+    input = nil
+
+    while input != "exit"
+      input = gets.strip.downcase
+
+      if input.to_i > 0 && input.to_i <= @states.length
+        @state_i = input.to_i-1
+        list_parks(@state_i)
+      elsif input == "exit"
+        goodbye
+      else
+        puts "Please select a valid state or territory."
+      end
+    end
+  end
+
+
+  # Park Methods #
+  def list_parks(choice)
+    @chosen_state = BASE_PATH + @states[choice].url
+
+    puts ""
+    puts "==".colorize(:green) + "#{NationalParks::Park.state_name(@chosen_state)}" + "==".colorize(:green)
+    @parks = NationalParks::Park.all(@chosen_state)
+    @parks.each.with_index(1) {|park, i| puts " #{i}. #{park.name}"}
+    park_menu
+  end
+
+  def park_menu
+    puts "Please pick a park or monument by number for more information."
+    puts "  - Type 'states' to return to the states list."
+    puts "  - Type 'exit' to leave."
+
+    input = nil
+    while input != "exit"
+      input = gets.strip.downcase
+
+      if input.to_i > 0 && input.to_i <= @parks.length
+        @i = input.to_i-1
+        display_parks
+      elsif input == "parks"
+        list_parks(@state_i)
+      elsif input == "states"
+        list_states
+      elsif input == "exit"
+        goodbye
+      else
+        puts "Please select a valid park or monument."
+      end
+    end
+  end
+
+  def display_parks
+    puts ""
+    puts "==================================================".colorize(:yellow)
+    puts ""
+    puts "#{@parks[@i].name.upcase} #{@parks[@i].type.upcase}"
+    puts "-#{@parks[@i].location}-"
+    puts "#{@parks[@i].description}"
+    puts ""
+    puts "  - Type 'parks' to return to the parks list."
+    puts "  - Type 'states' to return to the states list."
+    puts "  - Type 'exit' to leave"
+  end
+
+end

data/lib/national_parks/park.rb

@@ -0,0 +1,40 @@
+class NationalParks::Park
+  attr_accessor :name, :type, :location, :description
+    @@all = []
+
+  def initialize(name, type, location, description)
+    @name = name
+    @type = type
+    @location = location
+    @description = description
+  end
+
+  def self.state_name(state_url)
+    parks_page = Nokogiri::HTML(open(state_url)) #replace with interpolated state url
+    @state_name = parks_page.css("h1.page-title").text.upcase
+  end
+
+  def self.all(state_url)
+    #Scrape state parks page and return park names, types, locations, & descriptions
+
+    self.scrape_parks(state_url)
+  end
+
+  def self.scrape_parks(state_url)
+    parks_page = Nokogiri::HTML(open(state_url))
+
+    park_list = parks_page.css("div.col-md-9.col-sm-9.col-xs-12.table-cell.list_left")
+
+    park_list.each do |park|
+      park_type = park.css("h2").text
+      park_name = park.css("h3").text
+      park_location = park.css("h4").text
+      park_description = park.css("p").text
+      park = self.new(name = park_name, type = park_type, location = park_location, description = park_description)
+
+      @@all.find {|p| p.name == park.name} || @@all << park
+    end
+    @@all
+  end
+
+end

data/lib/national_parks/state.rb

@@ -0,0 +1,32 @@
+class NationalParks::State
+  attr_accessor :name, :url
+  @@states = []
+
+  def initialize(name, url)
+    @name = name
+    @url = url
+  end
+
+  def self.all
+    @@states
+  end
+
+  def self.scrape_states
+    #Scrape state index page and return state names & urls
+    states_page = Nokogiri::HTML(open("https://www.nps.gov/findapark/index.htm"))
+
+    state_list = states_page.css('area')
+    state_list.each do |state|
+      state_name = "#{state.attr("alt")}"
+      state_url = "#{state.attr("href")}"
+      state = self.new(name = state_name, url = state_url)
+
+      @@states << state
+    end
+
+  @@states.sort_by!{|s| s.name}
+  @@states.delete_at(4)  #Remove duplicate Arkansas entry
+  @@states
+  end
+
+end

data/lib/national_parks/version.rb

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

data/national_parks.gemspec

@@ -0,0 +1,38 @@
+
+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.authors       = ["Brennan Heisler"]
+  spec.email         = ["brennan@heislercreative.com"]
+
+  spec.summary       = %q{National parks}
+  spec.description   = %q{National parks by state, with location & description}
+  spec.homepage      = "http://heislercreative.com"
+  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        = "bin"
+  spec.executables   = ["national-parks"]
+  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_dependency "nokogiri"
+  spec.add_dependency "colorize"
+end

data/notes.md

@@ -0,0 +1,30 @@
+# National Parks CLI #
+
+"Welcome to the National Park Service!"
+"Please pick a US state or territory:"
+
+-- scrape state index page --
+1. Alabama
+2. Alaska
+
+- User input
+
+"Select a park to learn more:"
+
+-- scrape state page for names --
+1. Park 1
+2. Park 2
+
+"Type 'States' to see more states and territories."
+- User input
+
+-- scrape state page for details --
+
+Name (Type)
+
+-Location
+
+  Description
+
+"Type 'Parks' to see more parks."
+- User input

data/sandbox

@@ -0,0 +1,11 @@
+Hi! 👋
+
+You’ve opened the IDE Sandbox. 🎉
+
+This means that you launched the IDE from a lesson that isn't a lab, and
+while you’re in the IDE Sandbox the IDE WILL NOT save files or directories
+created here. 💨
+
+In other words, the “Sandbox” is just that: a temporary place to “play” with
+code. If you want to store anything created here, be sure to back it up to a
+repository on GitHub.

data/spec.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application --> Selects by number, navigates back to menus, and exits
+- [x] Pull data from an external source --> Scrapes National Park Service "Find a Park" site
+- [x] Implement both list and detail views --> Lists 2 levels (states & parks), diplays details for selected parks/monuments

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: national-parks
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Brennan Heisler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-18 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: 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: National parks by state, with location & description
+email:
+- brennan@heislercreative.com
+executables:
+- national-parks
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- 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/state.rb
+- lib/national_parks/version.rb
+- national_parks.gemspec
+- notes.md
+- sandbox
+- spec.md
+homepage: http://heislercreative.com
+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.7.6
+signing_key: 
+specification_version: 4
+summary: National parks
+test_files: []