UNESCO_World_Heritage_Sites 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa33705b055d141fdefd07cfa0fccacb3c592f19
+  data.tar.gz: ae261906bf5bd227e367239b110be2cc3f1e39fc
+SHA512:
+  metadata.gz: bb00b375080c4a692df1bdb01e286bc1678584368e0ce2053b0ae4a2dcd17c9f3335a4a52fae04dbb090808a9bd51f08cec325f1628af5144e1b237c26422d5e
+  data.tar.gz: 45239fe50042ddb11fd2901448b950cbabed9da52d2d76edd961e89d7439146841bb25e1463766e1ebb7add716d98a034cec45b8b9c0be5371db1d08d56b4dcf

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 matthewpaulmcgowan
+
+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 @@
+# UNESCOWorldHeritageSites
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/UNESCO_World_Heritage_Sites`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'UNESCO_World_Heritage_Sites'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install UNESCO_World_Heritage_Sites
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/UNESCO_World_Heritage_Sites/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/UNESCO_World_Heritage_Sites.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'UNESCO_World_Heritage_Sites/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "UNESCO_World_Heritage_Sites"
+  spec.version       = UNESCOWorldHeritageSites::VERSION
+  spec.authors       = ["Matthew McGowan"]
+  spec.email         = ["matthewpaulmcgowan@gmail.com"]
+
+  spec.summary       = %q{A CLI to search through UNESCO World Heritage Sites}
+  spec.description   = %q{Scrapes many pages throughout the whc.unesco.org website, organizes sites by country and allows the user to select which site they would like to learn more about.}
+  spec.homepage      = "https://github.com/matthewpaulmcgowan/UNESCO_World_Heritage_Sites_CLI_Data_Gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  
+  spec.add_dependency "nokogiri"
+end

data/bin/UNESCO_World_Heritage_Sites

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "UNESCO_World_Heritage_Sites"
+
+UNESCOWorldHeritageSites::CLI.new.call

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "UNESCO_World_Heritage_Sites"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/UNESCO_World_Heritage_Sites.rb

@@ -0,0 +1,12 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+
+require_relative "./UNESCO_World_Heritage_Sites/version"
+require_relative "./UNESCO_World_Heritage_Sites/cli"
+require_relative "./UNESCO_World_Heritage_Sites/scraper"
+require_relative "./UNESCO_World_Heritage_Sites/countries"
+require_relative "./UNESCO_World_Heritage_Sites/sites"
+require_relative "./UNESCO_World_Heritage_Sites/user_favorites"
+module UNESCOWorldHeritageSites
+end

data/lib/UNESCO_World_Heritage_Sites/cli.rb

@@ -0,0 +1,111 @@
+class UNESCOWorldHeritageSites::CLI
+  attr_accessor :input, :chosen_country, :site
+  
+  def call
+    introduction
+    call_country
+  end
+  
+  def introduction
+    puts "Hello, we are learning about UNESCO World Heritage Sites!"
+    puts "UNESCO, began their list of heritage sites in 1978 and now counts over 1100 from over 160 countries."
+    puts "The heritage sites are listed by country so please select the id of a country to begin to learn!"
+  end
+  
+  def call_country
+    UNESCOWorldHeritageSites::Countries.clear
+    UNESCOWorldHeritageSites::Sites.clear
+    UNESCOWorldHeritageSites::Scraper.scrape_main_page
+    UNESCOWorldHeritageSites::Countries.print_countries
+    puts ""
+    puts "Please select the id of the country you would like to search about"
+    @input=gets.strip
+    puts ""
+    response_checker(UNESCOWorldHeritageSites::Countries.number_of_countries)
+    @chosen_country=UNESCOWorldHeritageSites::Countries.find_country(@input)
+    @chosen_country.country_specific_sites
+    printing_sites
+  end
+  
+  def printing_sites
+    puts "These are the heritage sites of #{@chosen_country.name}."
+    UNESCOWorldHeritageSites::Sites.print_all_sites
+    puts ""
+    puts "Which site would you like to learn more about?"
+    @input=gets.strip
+    puts ""
+    response_checker(UNESCOWorldHeritageSites::Sites.number_of_sites)
+    @site=UNESCOWorldHeritageSites::Sites.find_site(@input)
+    @site.print_site_data
+    puts ""
+    puts "Would you like to add this site to your favorites?"
+    puts "Please enter 1 for yes or 2 for no."
+    @input=gets.strip
+    response_checker(2)
+    add_to_favorites
+    puts ""
+    puts "Enter the number of the option you would like from the list below."
+    puts "1: to look at the same country's heritage sites"
+    puts "2: to pick a new country"
+    puts "3: to print your favorite heritage sites"
+    puts "4: to exit"
+    @input=gets.strip
+    puts ""
+    response_checker(4)
+    if @input=="1"
+      printing_sites
+    elsif @input=="2"
+      call_country
+    elsif @input=="3"
+      UNESCOWorldHeritageSites::User_Favorites.print_favorites
+      puts ""
+      what_is_next_move
+    else
+      goodbye
+      abort
+    end
+  end
+  
+  def response_checker(high_limit) 
+    if !(@input.to_i>0)||!(@input.to_i<=high_limit)
+      puts "Please enter a valid response."
+      @input=gets.strip
+      puts ""
+      response_checker(high_limit)
+    end
+  end
+  
+  def add_to_favorites
+    if @input=="1"
+      UNESCOWorldHeritageSites::User_Favorites.save(@site)
+    end
+  end
+  
+  def what_is_next_move   
+    puts "Enter the number of the option you would like from the list below."
+    puts "1: to look at the same country's heritage sites"
+    puts "2: to pick a new country"
+    puts "3: to exit"
+    @input=gets.strip
+    puts ""
+    response_checker(3)
+    if @input=="1"
+      printing_sites
+    elsif @input=="2"
+      call_country
+    else
+      goodbye
+      abort
+    end
+  end
+  
+  def goodbye
+    puts "I hope you enjoyed yourself and learned something new!"
+    puts "All of this information was found throughout the whc.unesco.org website!"
+    puts "Have a swell day!"
+  end
+end
+#could have it so the user could enter something and a random number would be chosen, I think it would be easy to implement, 
+#but i'm not sure how to have the user select because right now all of the user input is number based, it can't be 0 because
+#all letters are transformed to 0 in the valididity check, i could have it be one greater than the largest number in the series,
+#but I don't really love that idea, so right now I will leave it out

data/lib/UNESCO_World_Heritage_Sites/countries.rb

@@ -0,0 +1,70 @@
+class UNESCOWorldHeritageSites::Countries
+  attr_accessor :id, :name, :url, :sites, :doc
+
+  @@all=[]
+
+  def initialize(id,name,url)
+    @id=id
+    @name=name
+    @url=url
+  end
+  
+  def save
+    @@all << self 
+  end
+  
+  def self.create_from_index(id,name,url)
+    new_country=UNESCOWorldHeritageSites::Countries.new(id,name,url)
+    new_country.save
+    new_country
+  end
+  
+  def scrape_countrys
+    @doc=Nokogiri::HTML(open(self.url))
+  end
+  
+  def country_specific_sites
+    scrape_countrys
+    @sites=[]
+    descriptors_array=[".cultural_danger>a",".cultural>a",".natural>a",".natural_danger>a",".mixed>a"]
+    descriptors_array.each do |descriptor|
+    @doc.css(descriptor).each do |site|
+      name=site.text
+      url="http://whc.unesco.org#{site.attr("href")}"
+      @sites << [name,url]
+                            end
+                             end
+    create_sites   #not sure if I should call the create_sites method here or to call it alone in the CLI method
+  end
+  
+  def create_sites
+    @sites.each_with_index do |site,i|
+    id=i+1
+    country=self.name
+    name=site[0]
+    url=site[1]
+    UNESCOWorldHeritageSites::Sites.create_from_country(id,country,name,url)
+                            end
+    return
+  end
+  
+  def self.find_country(id)
+    @@all.detect do |country|
+      country.id==id.to_i
+                end
+  end
+  
+  def self.print_countries
+    @@all.each do |country|
+        puts "#{country.id}. #{country.name}"
+            end
+  end
+  
+  def self.number_of_countries
+    @@all.length
+  end
+  
+  def self.clear
+    @@all=[]
+  end
+end

data/lib/UNESCO_World_Heritage_Sites/scraper.rb

@@ -0,0 +1,13 @@
+class UNESCOWorldHeritageSites::Scraper
+  def self.scrape_main_page
+    doc=Nokogiri::HTML(open("http://whc.unesco.org/en/list"))
+    doc.css("#acc>h4>a").each_with_index do |country,i|
+      name=country.text
+      url="http://whc.unesco.org#{country.attr("href")}"
+      index=i+1
+      UNESCOWorldHeritageSites::Countries.create_from_index(index,name,url)
+                         end
+  end
+end
+
+

data/lib/UNESCO_World_Heritage_Sites/sites.rb

@@ -0,0 +1,55 @@
+class UNESCOWorldHeritageSites::Sites
+  attr_accessor :id,:country, :name, :url, :doc
+  
+  @@all=[]
+  
+  def initialize(id,country,name,url)
+    @id=id
+    @country=country
+    @name=name
+    @url=url
+  end
+  
+  def save
+    @@all << self 
+  end
+  
+  def self.create_from_country(id,country,name,url)
+    new_site=UNESCOWorldHeritageSites::Sites.new(id,country,name,url)
+    new_site.save
+    new_site
+  end
+  
+  def self.print_all_sites
+    @@all.each do |site|
+      puts "#{site.id}. #{site.name}"
+                end
+  end
+  
+  def self.find_site(input_id)
+    @@all.detect do |site|
+      site.id==input_id.to_i
+                end
+  end 
+  
+  def scrape_sites
+    @doc=Nokogiri::HTML(open(url)) 
+  end
+  
+  def print_site_data
+    scrape_sites
+    overview=@doc.css("#contentdes_en>p").text
+    puts self.name
+    puts self.country
+    puts overview
+    puts self.url
+  end
+  
+  def self.number_of_sites
+    @@all.length
+  end
+  
+  def self.clear
+    @@all=[]
+  end
+end

data/lib/UNESCO_World_Heritage_Sites/user_favorites.rb

@@ -0,0 +1,19 @@
+class UNESCOWorldHeritageSites::User_Favorites
+  
+  @@all=[]
+  
+  def self.save(site)
+    @@all << site
+  end
+    
+  def self.print_favorites
+    puts "List of favorites!"
+    @@all.each_with_index do |site,i|
+      puts "#{i+1}. #{site.name}, #{site.country}"
+                          end
+  end
+  
+  def self.clear_favorites #this is not yet implemented, not sure when is a good time and I am already asking so many questions, don't want to constancly be asking if they want to clear favorites
+    @@all=[]
+  end
+end

data/lib/UNESCO_World_Heritage_Sites/version.rb

@@ -0,0 +1,3 @@
+module UNESCOWorldHeritageSites
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: UNESCO_World_Heritage_Sites
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthew McGowan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+  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'
+description: Scrapes many pages throughout the whc.unesco.org website, organizes sites
+  by country and allows the user to select which site they would like to learn more
+  about.
+email:
+- matthewpaulmcgowan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- UNESCO_World_Heritage_Sites.gemspec
+- bin/UNESCO_World_Heritage_Sites
+- bin/console
+- bin/setup
+- lib/UNESCO_World_Heritage_Sites.rb
+- lib/UNESCO_World_Heritage_Sites/cli.rb
+- lib/UNESCO_World_Heritage_Sites/countries.rb
+- lib/UNESCO_World_Heritage_Sites/scraper.rb
+- lib/UNESCO_World_Heritage_Sites/sites.rb
+- lib/UNESCO_World_Heritage_Sites/user_favorites.rb
+- lib/UNESCO_World_Heritage_Sites/version.rb
+homepage: https://github.com/matthewpaulmcgowan/UNESCO_World_Heritage_Sites_CLI_Data_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.6
+signing_key: 
+specification_version: 4
+summary: A CLI to search through UNESCO World Heritage Sites
+test_files: []