top-travel-destinations-cli-gem 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5036bbbcbaf0a47d15138a37cb69273ae54db8f9
+  data.tar.gz: dafe335ea4e7e6642ff14cfa926a96b8891d5b26
+SHA512:
+  metadata.gz: 8f9a939f583ee148ec3d9b5690a8484fc6bf775b2ea114fd209a3d329498dc1b5a38389c322c8206e429689a59830e1187c3dbb3e58c84bcb61a4c9434e04580
+  data.tar.gz: 488631ce9bf33e88bb4e8e56e98f687ca84a2d1b9933d49c150d1275f9efb56f4a4956bc7885a15e55359e4d10bfb83120fab57c936c9fe4e55c5803d43b0060

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at antonio.g.david@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Antonio David
+
+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,44 @@
+# TopTravelDestinations
+
+Welcome to the Top Travel Destinations CLI gem! This gem was inspired by a love for traveling the world and learning about new cultures and experiences. The gem uses information from the TripAdvisor Travelers' Choice Destinations website (http://www.tripadvisor.com/TravelersChoice-Destinations) to provide you with easy-access to two levels of information: (1) the regions of the world; and (2) the top destinations of that region, as provided by TripAdvisor.  The world is your oyster. Safe travels and thank you for using the Top Travel Destinations CLI gem.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'top-travel-destinations-cli-gem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install top-travel-destinations-cli-gem
+
+## Usage
+
+The Top Travel Destinations CLI gem has simple instructions:
+1) At the "Here are the Regions of the World" prompt, enter an alphanumeric number (i.e., 1-9) to select a region.
+2) The gem will automatically generate the Top Travel Destinations for that region.
+3) After viewing Top Destinations for one region, either enter:
+    (a)'list' to return to the list of regions;
+    (b) 'exit' to leave the gem.
+
+## 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/[USERNAME]/top_travel_destinations. 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "top_travel_destinations"
+
+# 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

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-travel-destinations

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../config/environment'
+
+TopTravelDestinations::CLI.new.call

data/config/environment.rb

@@ -0,0 +1,8 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+
+require_relative "../lib/top_travel_destinations/version"
+require_relative '../lib/top_travel_destinations/cli'
+require_relative '../lib/top_travel_destinations/scraper'
+require_relative '../lib/top_travel_destinations/region'

data/lib/top_travel_destinations/cli.rb

@@ -0,0 +1,92 @@
+class TopTravelDestinations::CLI
+  BASE_URL = "http://www.tripadvisor.com/TravelersChoice-Destinations"
+
+  def call
+    welcome_screen
+    make_regions
+    add_destinations_to_regions
+    list_regions
+    select_region
+  end
+
+  def welcome_screen
+    puts "\n"
+    puts "Welcome to Top Travel Destinations"
+    puts "\n"
+    puts "          .-'';'-."
+    puts "        ,'   <_,-.`."
+    puts "       /)   ,--,_>\\_\\ "
+    puts "      |'   (      \\_ |"
+    puts "      |_    `-.    / |"
+    puts "       \\`-.   ;  _(`/"
+    puts "        `.(    \\/ ,'"
+    puts "          `-....-'"
+  end
+
+  def make_regions
+    region_array = TopTravelDestinations::Scraper.scrape_regions_array(BASE_URL)
+    TopTravelDestinations::Region.create_from_array(region_array)
+  end
+
+  def add_destinations_to_regions
+    TopTravelDestinations::Region.all.each do |region|
+      destinations_array = TopTravelDestinations::Scraper.scrape_destinations_array(region.region_url)
+      region.create_attribute_from_array(destinations_array)
+    end
+  end
+
+  def list_regions
+    puts "\n"
+    puts "Here are the Regions of the World:"
+    TopTravelDestinations::Region.all.each_with_index do |region, index|
+      puts "#{index+1}. #{region.name}"
+    end
+  end
+
+  def select_region
+    input = nil
+    while input != "exit"
+      puts "\n"
+      puts "Enter the number of the region for which you would like the Top Travel Destinations."
+      puts "Enter 'list' to see the regions again, or type 'exit'."
+      input = gets.strip.downcase 
+      if (1..TopTravelDestinations::Region.all.count).to_a.include?(input.to_i)
+        index_value = input.to_i-1
+        show_top_destinations(index_value)
+      elsif input == "list"
+        list_regions
+      elsif input == "exit"
+        goodbye
+      else
+        puts "\n"
+        puts "Please input a valid command."
+      end #end case
+    end #end while loop
+  end #end method
+
+  def show_top_destinations(index_value)
+    puts "\n"
+    puts "The Top Destinations For the #{TopTravelDestinations::Region.all[index_value].name} region are:"
+    counter = 1
+    TopTravelDestinations::Region.all[index_value].destinations.each do |destination|
+      puts "#{counter}. #{destination}"
+      counter +=1
+    end
+  end
+
+  def goodbye
+    puts "\n"
+    puts "                       The World is your oyster." 
+    puts "               Thanks for using Top Travel Destinations!" 
+    puts <<-DOC
+ _________________________          _____
+|                         \\          \\ * \\__      _____
+|   Safe                   \\__________\\   \\/_______\\___\\_____________
+|   Travels!               /          < /_/   .....................  `-.
+|_________________________/            `-----------,----,--------------'
+                                                 _/____/
+    
+    DOC
+  end
+
+end

data/lib/top_travel_destinations/region.rb

@@ -0,0 +1,32 @@
+class TopTravelDestinations::Region
+
+  attr_accessor :name, :region_url, :destinations 
+
+  @@all = [] 
+
+  def initialize(region_hash)
+    self.create_attributes_from_hash(region_hash)
+    self.class.all << self
+  end
+
+  def self.create_from_array(region_array)
+    region_array.each do |region_hash|
+      TopTravelDestinations::Region.new(region_hash)
+    end
+  end
+
+  def create_attributes_from_hash(region_hash)
+    region_hash.each do |key, value|
+      self.send(("#{key}="), value)
+    end
+  end
+
+  def create_attribute_from_array(destinations_array)
+    self.destinations = destinations_array
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/top_travel_destinations/scraper.rb

@@ -0,0 +1,33 @@
+class TopTravelDestinations::Scraper
+
+  def self.scrape_regions_array(index_url)
+    html = open(index_url)
+    doc = Nokogiri::HTML(html)
+
+    region_array = []
+
+    doc.search("#tcRegions .tocContainer a").each do |regionnode|
+      name = regionnode.text
+      sub_url = regionnode.attribute("href").value
+      region_array << {
+        :name => name,
+        :region_url => "http://www.tripadvisor.com#{sub_url}"
+      }
+    end #end iterator
+    region_array
+  end #end method
+
+  def self.scrape_destinations_array(profile_url)
+    html = open(profile_url)
+    doc = Nokogiri::HTML(html)
+
+    destinations_array = []
+
+    doc.search("div.winnerName div.mainName a").each do |destination|
+      name = destination.text
+      destinations_array << name
+    end#end iterator
+    destinations_array
+  end
+
+end #end Class

data/lib/top_travel_destinations/version.rb

@@ -0,0 +1,3 @@
+module TopTravelDestinations
+  VERSION = "1.0.0"
+end

data/top_travel_destinations.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'top_travel_destinations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "top-travel-destinations-cli-gem"
+  spec.version       = TopTravelDestinations::VERSION
+  spec.authors       = ["Antonio David"]
+  spec.email         = ["antonio.david.us@gmail.com"]
+
+  spec.summary       = %q{Top travel destinations by region of the world.}
+  spec.description   = %q{Top travel destinations by region of the world, according to TripAdvisor.}
+  spec.homepage      = "https://github.com/agdavid/top-travel-destinations-cli-gem"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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.bindir        = "exe"
+  spec.executables   = ["top-travel-destinations"]
+  #spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "lib/top_travel_destinations"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "nokogiri", "~> 0"
+  spec.add_development_dependency "pry", "~> 0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: top-travel-destinations-cli-gem
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Antonio David
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Top travel destinations by region of the world, according to TripAdvisor.
+email:
+- antonio.david.us@gmail.com
+executables:
+- top-travel-destinations
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/top-travel-destinations
+- config/environment.rb
+- lib/top_travel_destinations/cli.rb
+- lib/top_travel_destinations/region.rb
+- lib/top_travel_destinations/scraper.rb
+- lib/top_travel_destinations/version.rb
+- top_travel_destinations.gemspec
+homepage: https://github.com/agdavid/top-travel-destinations-cli-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/top_travel_destinations
+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.8
+signing_key: 
+specification_version: 4
+summary: Top travel destinations by region of the world.
+test_files: []