travel_inspiration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfe7ba8370b2d514764a0196e7e4e9c446ea4f8e
+  data.tar.gz: f6f4fac6110c68edb2a3caedca119c3fe61707fd
+SHA512:
+  metadata.gz: 4fc90d0d7d388d8b0dcb8b132f4352cded375555cb3d8895e048f3da8bc3b2076735937727b5dd939b31660972ac2fc384d7012b4fc3a7da479d6ac2ad181a68
+  data.tar.gz: bc4654aecb1453e769aabd857678bb9d3fa0f365c90135c32998e6cf053b25e1f90785374d4283d1c9cf226cb4131e8259a5e7ef010a97402bdc52b4355b6a9f

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 travel_inspiration.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lisa Huang
+
+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,30 @@
+# Travel Inspiration
+
+This Ruby Gem provides a CLI to view 12 travel inspiration themes, sourced from [Lonely Planet](https://www.lonelyplanet.com/) website. Users can choose a theme and view the top 6 destinations, and drill-down to see more details of each destination. 
+
+## Installation
+You can install this gem by typing the following prompt in terminal:
+
+```gem install travel_inspiration```
+
+The ```travel_inspiration``` CLI will be installed and you can run ```inspire_me``` to get a list of travel inspiration themes right in your command line.
+
+## Usage
+
+Run: ```inspire_me``` after installing the gem.
+
+## 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/[USERNAME]/travel_inspiration.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://github.com/dannyd4315/worlds-best-restaurants-cli-gem/blob/master/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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "travel_inspiration"
+
+# 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/inspire_me

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

@@ -0,0 +1,8 @@
+require 'open-uri'
+require 'nokogiri'
+require 'pry'
+
+require "travel_inspiration/version"
+require "travel_inspiration/themes"
+require "travel_inspiration/cli"
+

data/lib/travel_inspiration/cli.rb

@@ -0,0 +1,92 @@
+require 'pry'
+require_relative 'themes.rb'
+require_relative 'destinations.rb'
+require_relative 'country.rb'
+require 'colorize'
+require 'readline'
+
+module TravelInspiration
+    class CLI
+        
+        def start
+            list_themes
+        end
+
+        def list_themes
+            puts "Hello! Which travel inspiration will you like to explore for your next trip?".green.bold
+            puts "\nPlease select a theme from 1 - 12".blue.bold
+            theme_arr = TravelInspiration::Theme.list_theme_names
+            puts  theme_arr.map.with_index{|theme, index|
+                "\t#{index+1}. #{theme.name}"
+            }
+            puts "--------------------------------------------".black.on_white #horizontal divider
+            select_theme(theme_arr)
+        end
+
+        def select_theme(theme_arr)
+            input = nil
+
+            while true # user_input != "exit"
+                input = Readline.readline("Select theme 🛣 ", true).strip
+
+                goodbye if input.downcase === "exit"
+                input = input.to_i 
+
+                if input > 0 && input < 13
+                    puts "--------------------------------------------".black.on_white #horizontal divider
+                    theme_name = theme_arr[input-1].name.strip
+                    puts "Here are the top 6 destinations for #{theme_name.upcase}\n".green.bold
+                    list_destinations(theme_name)
+                else
+                    puts "That selection is not valid. Please select a theme from 1 - 12, or type exit."
+                end
+            end
+        end
+
+        def list_destinations(theme_name)
+            puts "Please select a destination from 1 - 6".blue.bold
+            country_arr = TravelInspiration::Destination.list_destination_names(theme_name)
+
+            puts country_arr.map.with_index{|d, index|
+                "\t#{index+1}. #{d.name}, #{d.continent}"
+                }
+            puts "--------------------------------------------".black.on_white #horizontal divider
+            select_country(country_arr)
+        end
+
+        def select_country(country_arr)
+            user_input = nil
+            while true # user_input != "exit"
+                user_input = Readline.readline("Select country 🗺 ", true).strip
+
+                goodbye if user_input.downcase === "exit"
+
+                country_choice = user_input.to_i 
+
+                if country_choice > 0 && country_choice < 7
+                    puts "--------------------------------------------".black.on_white #horizontal divider
+                  
+                    #select country = array[country_choice]
+                    chosen_country = country_arr[country_choice-1].name.upcase
+
+                    puts "Here's some information about #{chosen_country}, and the best time to travel there!".green.bold
+                    country_details(chosen_country)
+                else
+                    puts "That selection is not valid. Please select a country from 1-6, or type exit."
+                end
+            end
+        end
+
+        def country_details(chosen_country)
+            country = TravelInspiration::Country.new(chosen_country)
+            puts country.country_info        
+        end
+
+        def goodbye
+            puts "\nFarewell, traveler! May the wind take you somewhere new!".red.on_white.bold
+            exit
+        end
+    end
+end
+
+puts TravelInspiration::CLI.new.start

data/lib/travel_inspiration/country.rb

@@ -0,0 +1,67 @@
+require 'nokogiri'
+require 'open-uri'
+require_relative 'themes.rb'
+require_relative 'destinations.rb'
+
+module TravelInspiration
+    class Country
+        attr_accessor :name, :url, :high_season, :low_season, :best_visit_season, :summary_quote, :details
+ 
+        def initialize(name)
+            @name = name
+        end    
+
+        def country_info
+            scrape_season #set seasonality information
+            scrape_info #set country name, summary_quote and details
+
+            puts "\t#{@best_visit_season}!
+                  #{@high_season}\n
+                  #{@low_season}\n"
+            puts "#{@summary_quote}".blue.on_yellow
+            puts @details
+        end
+
+        #scrape country information
+        def scrape_info
+            doc = Nokogiri::HTML(open(url))
+
+            info_url = doc.search("#introduction article.love-letter a").attr("href").text
+            info_page = Nokogiri::HTML(open(info_url))
+
+            @summary_quote = info_page.search("div.copy--body p.copy--feature").text
+            
+            subtitles = info_page.search("div.copy--body h2").to_a
+            subtitles = subtitles.map {|s| s.text}
+
+            descriptions = info_page.search("div.copy--body p.copy--body").to_a
+            descriptions = descriptions.map {|d| d.text}
+            descriptions.reject!{|item|
+                item.downcase.end_with?("writer")
+            }
+
+            @details = subtitles.map.with_index{|title, index|
+                 "\n" + title.upcase + "\n" + descriptions[index] + "\n"
+            }
+        end
+
+        #scrape best time to visit from Country/weather website
+        def scrape_season
+            doc = Nokogiri::HTML(open(url))
+            
+            seasonality_url = doc.search("#survival-guide ul li:nth-child(2) a").attr("href").text #get country weather url
+            weather_pg = Nokogiri::HTML(open(seasonality_url))
+            
+            #get high, low, and best time to visit information
+            @high_season = weather_pg.search("div.card--page__content p:nth-child(1)").text
+            @low_season = weather_pg.search("div.card--page__content p:nth-child(5)").first.text
+
+            shoulder_season = weather_pg.search("div.card--page__content p:nth-child(3)").first.text
+            @best_visit_season = "Best time to visit " + shoulder_season[16..-1]
+        end
+
+        def url
+            "https://www.lonelyplanet.com/" + @name.downcase.sub(" ", "-") 
+        end
+    end
+end

data/lib/travel_inspiration/destinations.rb

@@ -0,0 +1,31 @@
+require 'nokogiri'
+require 'open-uri'
+
+module TravelInspiration
+    class Destination
+        attr_accessor :name, :continent, :url
+        
+        def self.list_destination_names(theme_name)
+            self.scrape_destinations(theme_name)
+        end
+
+        #scrape data using URL
+        def self.scrape_destinations(theme_name)
+            list = []
+
+            url = TravelInspiration::Theme.url_for_theme_name(theme_name)
+            doc = Nokogiri::HTML(open(url))
+            destinations = doc.search('div.SightsList-wrap a') #selects 6 destinations 
+            
+            destinations.map.with_index{ |destination, index|
+                new_destination = TravelInspiration::Destination.new #create destination instance
+                new_destination.name = destination.css('h5').text
+                new_destination.continent = destination.css('p').text
+                new_destination.url = destination.attr("href")
+                list[index] = new_destination
+            } 
+            list.sort_by! {|obj| [obj.continent, obj.name]}
+            list
+        end
+    end
+end

data/lib/travel_inspiration/themes.rb

@@ -0,0 +1,31 @@
+require 'nokogiri'
+require 'open-uri'
+
+module TravelInspiration
+    class Theme
+        attr_accessor :name, :url
+
+        def self.list_theme_names
+            self.scrape_themes
+        end
+
+        def self.scrape_themes
+            themes_list = []
+            doc = Nokogiri::HTML(open("https://www.lonelyplanet.com/"))
+            themes = doc.search('div.slick-track a.slick-slide') #selects carousel slides
+            themes.each_with_index{|theme, index|
+                if index < 12 then
+                    new_theme = TravelInspiration::Theme.new #create theme instance
+                    new_theme.name = theme.css("p").text     #assign theme name
+                    new_theme.url = theme.attr("href")       #assign theme url for destination #scraping
+                    themes_list[index] = new_theme
+                end
+            }
+            themes_list
+        end
+
+        def self.url_for_theme_name(theme_name)
+            "https://www.lonelyplanet.com/#{theme_name.downcase.sub(" ", "-")}/"
+        end
+    end
+end

data/lib/travel_inspiration/version.rb

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

data/travel_inspiration.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "travel_inspiration/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "travel_inspiration"
+  spec.version       = TravelInspiration::VERSION
+  spec.authors       = ["Lisa Huang"]
+  spec.email         = ["lisa.yc.huang@gmail.com"]
+
+  spec.summary       = %q{"A ruby gem to view travel inspiration by themes"}
+  spec.description   = %q{"A ruby gem to view Lonely Planet travel inspiration by themes. You will learn about the top 6 destinations!"}
+  spec.homepage      = "https://github.com/lisaychuang/travel_inspiration_gem"
+  spec.license       = "MIT"
+
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_dependency "nokogiri", "~> 1.8"
+  spec.add_dependency "colorize", "~> 0.8.1"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: travel_inspiration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lisa Huang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: '"A ruby gem to view Lonely Planet travel inspiration by themes. You
+  will learn about the top 6 destinations!"'
+email:
+- lisa.yc.huang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/inspire_me
+- bin/setup
+- lib/travel_inspiration.rb
+- lib/travel_inspiration/cli.rb
+- lib/travel_inspiration/country.rb
+- lib/travel_inspiration/destinations.rb
+- lib/travel_inspiration/themes.rb
+- lib/travel_inspiration/version.rb
+- travel_inspiration.gemspec
+homepage: https://github.com/lisaychuang/travel_inspiration_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.10
+signing_key: 
+specification_version: 4
+summary: '"A ruby gem to view travel inspiration by themes"'
+test_files: []