trail-info-cli-gem 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fef9aa1f241f91d727392ab65b466ce9084d481
+  data.tar.gz: d065f1ee17fd6526d7241641072812152f2a7bb3
+SHA512:
+  metadata.gz: 1dd13ce0f70ae05b205d183d1b177ff325fc39f9dd9eb1c3e57fc95974f52b2b965dbc96f1583d122a4d35a999321fa2f6cf1e39c9e35b72ce3c0bb4388275ec
+  data.tar.gz: 7724396ab642b5dfa0680fb31d9d58b33c45e2b89934665951f0958862f51fa0724223e28967077a4df2d47f4c3f284dd67b9719ffd14802fe9052590f972307

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trail_info.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Traci7822
+
+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,39 @@
+# TrailInfo
+
+This TrailInfo CLI GEM is programmed to allow the user to select a state and then display available trails in that state from TrailLink.com. Users are then able to select a trail from that list to see further details about the trail. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trail_info'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trail_info
+
+## Usage
+
+To use TrailInfo, run ./bin/trail_info in your terminal. A list of states will be displayed, select one by number and hit enter to bring up trails in that state. When the trail list populates, enter a trail number and hit enter to see further details on the selected trail. Use menu commands to navigate back to the start. 
+
+## 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/Traci7822/trail_info.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "trail_info"
+
+
+require "irb"
+IRB.start

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/trail_info

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+
+require_relative "../lib/trail_info"
+
+
+TrailInfo::CLI.new.call
+
+

data/lib/trail_info.rb

@@ -0,0 +1,9 @@
+require_relative "trail_info/version"
+require_relative 'trail_info/CLI'
+require_relative 'trail_info/trail'
+require_relative 'trail_info/states'
+require_relative 'trail_info/scraper'
+require 'Nokogiri'
+require 'open-uri'
+
+

data/lib/trail_info/CLI.rb

@@ -0,0 +1,87 @@
+class TrailInfo::CLI
+
+  @@STATE_NAMES = {AL: 'ALABAMA',
+  AK: 'ALASKA','AZ'=>'ARIZONA','AR'=>'ARKANSAS','CA'=>'CALIFORNIA','CO'=>'COLORADO','CT'=>'CONNECTICUT',
+  'DE'=>'DELAWARE','DC'=>'DISTRICT OF COLUMBIA','FL'=>'FLORIDA','GA'=>'GEORGIA','HI'=>'HAWAII','ID'=>'IDAHO',
+  'IL'=>'ILLINOIS','IN'=>'INDIANA','IA'=>'IOWA', 'KS'=>'KANSAS', 'KY'=>'KENTUCKY', 'LA'=>'LOUISIANA', 'ME'=>'MAINE',
+  'MD'=>'MARYLAND', 'MA'=>'MASSACHUSETTS', 'MI'=>'MICHIGAN', 'MN'=>'MINNESOTA', 'MS'=>'MISSISSIPPI', 'MO'=>'MISSOURI',
+  'MT'=>'MONTANA', 'NE'=>'NEBRASKA', 'NV'=>'NEVADA', 'NH'=>'NEW HAMPSHIRE', 'NJ'=>'NEW JERSEY', 'NM'=>'NEW MEXICO',
+  'NY'=>'NEW YORK', 'NC'=>'NORTH CAROLINA', 'ND'=>'NORTH DAKOTA', 'OH'=>'OHIO', 'OK'=>'OKLAHOMA', 'OR'=>'OREGON', 
+  'PA'=>'PENNSYLVANIA', 'RI'=>'RHODE ISLAND', 'SC'=>'SOUTH CAROLINA', 'SD'=>'SOUTH DAKOTA', 'TN'=>'TENNESSEE', 
+  'TX'=>'TEXAS', 'UT'=>'UTAH', 'VT'=>'VERMONT', 'VA'=>'VIRGINIA', 'WA'=>'WASHINGTON', 'WV'=>'WEST VIRGINIA', 
+  'WI'=>'WISCONSIN', 'WY'=>'WYOMING'}  
+
+  def call
+    puts "Welcome to Trail Finder!"
+    menu  
+  end
+
+  def menu
+    puts "Enter which state number you'd like to find a trail in and press enter or type 'exit' to exit the program.\n\n" 
+    list_states
+  end
+
+  def list_states
+    @@STATE_NAMES.each.with_index(1) do |state_name, index|
+      puts "#{index}. #{state_name[1]}"
+    end
+    state_input
+  end
+
+  def state_input #allows user to select which state to view trails in
+    selection = gets.strip.downcase
+    list_trails(selection)
+  end
+
+  def list_trails(state_number) #checks input to determine whether to list trails or exit
+    if state_number.to_i.between?(1, 51)
+      initiate_trails_report(state_number.to_i)
+    elsif 
+      state_number == "exit"
+      exit 
+    else
+      puts "Please enter a valid number between 1 - 51."
+      state_input
+    end
+  end
+
+  def initiate_trails_report(state_number) #Writes state selection, initiates new state instance, lists states trails
+    puts "You've selected #{state_number}. #{@@STATE_NAMES.values[state_number - 1]}. Here are the available trails in #{@@STATE_NAMES[state_number]} according to TrailLink.com. This may take a moment to load.\n \n"
+    initiate_state(state_number)
+    list_trails_report
+  end
+  
+  def initiate_state(state_number) #creates new state instance
+    TrailInfo::State.new(@@STATE_NAMES.values[state_number - 1], @@STATE_NAMES.keys[state_number - 1])
+  end
+
+  def list_trails_report #populates trail list for selected state and asks for input for more details, reset, or exit
+    TrailInfo::State.trail_list
+    puts "\nPlease select a trail number to see more details, enter 'reset' to go back to the main menu, or 'exit' to exit the program."
+    exit_input
+  end
+
+  def exit_input #takes user input and displays trail description, returns user to previous menus, or exits
+    @trail_array = TrailInfo::State.all
+    max_trail_number = @trail_array[0].trails.length
+    input = gets.strip.downcase
+    @trail_number = input.to_i
+    if input.to_i.between?(1, max_trail_number)
+      trail_description(@trail_array, @trail_number)
+    else
+      if input == 'back' ? list_trails_report : if input == "reset" ? TrailInfo::State.clear_all && call : (input == "exit" ? exit : (puts "I'm sorry, I don't understand. Please try again." && exit_input))
+      end
+      end
+    end
+  end
+
+  def trail_description(trail_array, trail_number) #Writes detailed trail information and asks for user input
+    trail = trail_array[0].trails[trail_number]
+    puts "#{trail.name} | Length: #{trail.length} | Surface: #{trail.surface}|"
+    puts "#{trail.synopsis}"
+    puts "\nFor more information visit: #{trail.url}"
+    puts "\nEnter 'back' to return to the list of trails, 'reset' to go back to the main menu, or 'exit' to exit the program."
+    exit_input
+  end
+end
+

data/lib/trail_info/rate.rb

@@ -0,0 +1,6 @@
+class TrailInfo::Rate 
+
+  attr_acessor :rating 
+
+
+end

data/lib/trail_info/scraper.rb

@@ -0,0 +1,58 @@
+class TrailInfo::Scraper
+
+  def self.create_trails(state_code) #Initiates state scrape
+    scrape_state_guides(state_code)
+  end
+
+  def self.scrape_state_guides(state_code) #Scrapes state site, collects and returns trail information
+    @state_scrape = Nokogiri::HTML(open("http://www.traillink.com/stateactivity/#{state_code}-hiking-trails.aspx"))
+    scrape_attributes
+    @trail_array
+  end
+
+  def self.scrape_attributes #Scrapes trail attributes and collects to trail_array
+    @trail_array = []
+    @state_scrape.css(".activityTrail").css(".trailmeta").each do |state_scrape|
+      scrape_trail_attributes(state_scrape)
+      @trail_array << @new_trail
+    end
+  end
+
+  def self.scrape_trail_attributes(state_scrape) #Scrapes trail details
+    @new_trail = {}
+    @new_trail["synopsis"] = scrape_synopsis(state_scrape)
+    @new_trail["name"] = scrape_trail_name(state_scrape)
+    @new_trail["url"] = scrape_url(state_scrape)
+    state_scrape.css("p").each do |trail_section|
+      scrape_trail_length_and_surface(trail_section)
+      @new_trail
+    end
+  end
+
+  def self.scrape_trail_name(state_scrape) #Scrapes trail name
+    state_scrape.css("a").text.split.join(" ") unless state_scrape.css("a").text.split.join(" ") == ""
+  end
+
+  def self.scrape_trail_length_and_surface(trail_section) #Scrapes trail length and surface information
+    if trail_section.text.include?("miles") ? @new_trail["length"] = [trail_section.text.split[3], trail_section.text.split[4]].join(" ") : @new_trail["length"] = ""
+    end
+
+    if trail_section.text.include?("Surface:")
+      if trail_section.text.split[7] == nil ? @new_trail["surface"] = trail_section.text.split[6] : @new_trail["surface"] = [trail_section.text.split[6], trail_section.text.split[7].gsub(/,/, "")].join(" ")
+      end
+    else
+      @new_trail["surface"] = ""
+    end
+    @new_trail
+  end
+
+  def self.scrape_synopsis(state_scrape) #Scrapes trail synopsis
+    @state_synopsis = state_scrape.css(".synopsis").text.strip
+  end
+
+  def self.scrape_url(state_scrape) #Scrapes trail url
+    path = state_scrape.css("a").attribute("href").value
+    state_url = "http://www.traillink.com#{path}"
+  end
+
+end

data/lib/trail_info/states.rb

@@ -0,0 +1,35 @@
+class TrailInfo::State
+
+  attr_accessor :name, :trails
+  @@all = []
+
+  def initialize(name, state_code) #Creates new state instance and initializes scraping and new trail instances
+    @name = name
+    @trails = []
+    TrailInfo::Scraper.create_trails(state_code).each do |trail|
+      @trails << TrailInfo::Trail.new(self, trail)
+    end
+    @@all << self
+  end
+
+  def self.all #returns all trails for state instance
+    @@all
+  end
+
+  def self.clear_all #clears trails for state instance
+    @@all.clear
+  end
+
+  def self.trail_list #Writes list of states trails
+    @trail_list = []
+    @@all[0].trails.each.with_index(1) do |trail, i| 
+      trail_description = "#{i}. #{trail.name} | Length: #{trail.length} | Surface: #{trail.surface}|"
+      puts trail_description
+      @trail_list << trail_description
+    end
+    @trail_list
+  end
+
+end
+
+

data/lib/trail_info/trail.rb

@@ -0,0 +1,22 @@
+class TrailInfo::Trail
+
+attr_accessor :name, :length, :surface, :state, :synopsis, :url
+
+@@all = []
+
+def initialize(state, trail_attributes) #Creates new trail instance
+  trail_attributes.each do |attribute_name, attribute_value|
+    self.send("#{attribute_name}=", attribute_value)
+  end
+  save
+end
+
+def save #saves trail instance
+  @@all << self
+end
+
+def self.all #returns all trail instances
+  @@all
+end
+
+end

data/lib/trail_info/version.rb

@@ -0,0 +1,3 @@
+module TrailInfo
+  VERSION = "0.1.4"
+end

data/notes

@@ -0,0 +1,24 @@
+
+http://www.traillink.com/stateactivity/al-hiking-trails.aspx
+
+Future ideas:
+  -find by name
+  -add all cities
+  -adds detail option for each trail
+
+for added searchability:
+  def self.print_all
+    all.each_with_index do |trail, index|
+      puts "#{i}. #{trail.name} | Length: #{trail.length} | Surface: #{trail.surface}|"
+    end
+  end
+
+  def self.trails_by_state(state)
+    trail_list = []
+    self.all.each do |trail|
+      if trail.state.name == selected_state.name
+        trail_list << trail
+     end
+    end
+  end
+

data/spec.md

@@ -0,0 +1,10 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application 
+      -bin file executes from terminal
+- [x] Pull data from an external source
+      -data is scraped with nokogiri from TrailLink.com
+- [x] Implement both list and detail views
+     -Selection of a state populates a trail list for that state, selection of a trail from that list populates details
+

data/trail_info.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trail_info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trail-info-cli-gem"
+  spec.version       = TrailInfo::VERSION
+  spec.authors       = ["Traci7822"]
+  spec.email         = ["tracir@gmail.com"]
+
+  spec.summary       = %q{short summary}
+  spec.description   = %q{longer description}
+  spec.homepage      = "https://github.com/Traci7822/trail-info-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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ["trail_info"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "nokogiri"
+  
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: trail-info-cli-gem
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Traci7822
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 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: longer description
+email:
+- tracir@gmail.com
+executables:
+- trail_info
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- 2016-08-13 13-49-01.mp4
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/trail_info
+- lib/trail_info.rb
+- lib/trail_info/CLI.rb
+- lib/trail_info/rate.rb
+- lib/trail_info/scraper.rb
+- lib/trail_info/states.rb
+- lib/trail_info/trail.rb
+- lib/trail_info/version.rb
+- notes
+- spec.md
+- trail_info-0.1.0.gem
+- trail_info.gemspec
+homepage: https://github.com/Traci7822/trail-info-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.4.5.1
+signing_key: 
+specification_version: 4
+summary: short summary
+test_files: []