breathe_in 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e600df3235dc0b4b8236ecc7de2b4d5d1b5857e0
+  data.tar.gz: f7deae9f7d4ddce9b6c63d1ce8640a8a48358a1f
+SHA512:
+  metadata.gz: e3973d6f42a3c62330ad33335f906f17b4e9f65f31e4383103d504f512fafb31bd616cb1cf453ca540fff406d26a08dced9ea02743b1506038421306b4164136
+  data.tar.gz: 5f0672a788a09006b1280a261d89304ec75f0255b001bad82df4326af4125559a3610e1584e94fe9f18fb658da7df9535910b402977760e18912c204d6d45a85

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 eric-an
+
+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,38 @@
+# BreatheIn
+
+Use this gem to find out the Air Quality Index (AQI) value for any zipcode in United States and see how clean or polluted the air is in your city. Data provided by AirNow.gov.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'breathe_in'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install breathe_in
+
+## Usage
+
+Run `breathe_in` and follow the prompts.
+
+## 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).
+
+## License
+
+MIT License. Copyright 2016 Eric An.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eric-an/breathe_in.
+

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "breathe_in"
+
+BreatheIn::CLI.new.run

data/bin/console

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

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'breathe_in/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'breathe_in'
+  spec.version       = BreatheIn::VERSION
+  spec.authors       = ['eric-an']
+  spec.email         = ['erican@me.com']
+
+  spec.summary       = %q{AQI scraper gem}
+  spec.description   = %q{Check the air quality index (AQI) for a zipcode.}
+  spec.homepage      = "https://github.com/eric-an/breathe-in"
+  spec.license       = 'MIT'
+  spec.executables << 'breathe_in'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nokogiri"
+end

data/config/environment.rb

@@ -0,0 +1,7 @@
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+
+require_relative "../lib/breathe_in/scraper"
+require_relative "../lib/breathe_in/city"
+require_relative "../lib/breathe_in/cli"

data/lib/breathe_in/city.rb

@@ -0,0 +1,23 @@
+class BreatheIn::City
+  attr_accessor :city_name, :zipcode, :today_high, :today_index, :last_update_time, :last_update_value, :last_update_index
+
+  @@cities = []
+
+  def initialize(city_hash={})
+    city_hash.each { |key, value| self.send(("#{key}="), value) }
+    @@cities << self
+  end
+
+  def add_city_air_quality(air_quality_hash)
+    air_quality_hash.each { |key, value| self.send(("#{key}="), value) }
+    self
+  end
+
+  def self.cities
+    @@cities
+  end
+
+  def self.reset
+    @@cities.clear
+  end
+end

data/lib/breathe_in/cli.rb

@@ -0,0 +1,126 @@
+class BreatheIn::CLI
+
+  @@zipcode = nil
+
+  def self.zipcode
+    @@zipcode
+  end
+
+  def run
+    puts "*Data provided courtesy of AirNow.gov*"
+    puts "How safe it is to breathe today?"
+    puts ""
+    get_information
+    check_site_availability
+    menu
+  end
+
+  def get_information
+    get_zipcode
+    scrape_data
+    if BreatheIn::Scraper.city_name == nil
+      puts "That zipcode is not recognized by Air.gov."
+      get_information
+    else
+      new_city = BreatheIn::City.new({zipcode: self.class.zipcode})
+      assign_attributes(new_city)
+      display_information
+    end
+  end
+
+  def check_site_availability
+    if BreatheIn::Scraper.under_maintenance
+      disclaimer = <<-Ruby
+        ***AirNow.gov undergoes maintenance from midnight to 4am EST. 
+        If information is currently unavailable, please try again later.***
+        Ruby
+      puts disclaimer
+    end
+  end
+
+  def menu
+    input = nil
+
+    while input != 3
+      puts ""
+      puts "1. Learn more about the AQI values and the ranges."
+      puts "2. Choose another zipcode."
+      puts "3. Exit."
+      puts "Please make a selection:"
+      puts ""
+      
+      input = gets.strip.to_i
+      case input
+        when 1
+          BreatheIn::Scraper.AQI_range_information
+        when 2
+          BreatheIn::City.reset
+          get_information
+          check_site_availability
+        when 3
+          puts "Breathe safely!"
+        else
+          puts "Please choose 1, 2, or 3."
+      end
+    end
+  end
+
+  def get_zipcode
+    input = ""
+    until input.match(/\b\d{5}\b/)
+      puts "Please enter a valid zipcode and wait a few seconds:"
+      puts ""
+      input = gets.strip
+    end
+    @@zipcode = input.to_s.rjust(5, '0')
+  end
+
+  def scrape_data
+    BreatheIn::Scraper.scraped_page(self.class.zipcode)
+  end
+
+  def assign_attributes(new_city)
+    attributes = BreatheIn::Scraper.city_air_quality
+
+    attributes[:today_high] = "Data currently unavailable." if !attributes.has_key?(:today_high)
+    attributes[:today_index] = "Data currently unavailable." if !attributes.has_key?(:today_index)
+    attributes[:last_update_value] = "Data currently unavailable." if !attributes.has_key?(:last_update_value)
+    attributes[:last_update_time] = "Data currently unavailable." if !attributes.has_key?(:last_update_time)
+    attributes[:last_update_index] = "Data currently unavailable." if !attributes.has_key?(:last_update_index)  
+
+    city_info_hash = new_city.add_city_air_quality(attributes)
+  end
+
+  def display_information
+    BreatheIn::City.cities.each do |city|
+      puts "---------------------"
+      puts "City/Area: #{city.city_name}, Zipcode: #{city.zipcode}"
+      puts "---------------------"
+      puts "Today's High AQI: #{city.today_high}"
+      puts "Today's Index: #{city.today_index}"
+      health_description(city.today_high) if city.today_high.is_a?(Integer)
+      puts "---------------------"
+      puts "Last #{city.last_update_time}"
+      puts "Current AQI: #{city.last_update_value}"
+      puts "Current Index: #{city.last_update_index}"
+      health_description(city.last_update_value) if city.last_update_value.is_a?(Integer) 
+       puts "---------------------"      
+    end
+  end
+
+  def health_description(level)
+      if level.between?(0,50)
+        puts "#{BreatheIn::Scraper.index_good}"
+      elsif level.between?(51,100)
+        puts "#{BreatheIn::Scraper.index_moderate}"
+      elsif level.between?(100,150)
+        puts "#{BreatheIn::Scraper.index_sensitive}"
+      elsif level.between?(151,200)
+        puts "#{BreatheIn::Scraper.index_unhealthy}"
+      elsif level.between?(201,300)
+        puts "#{BreatheIn::Scraper.index_very_unhealthy}"
+      elsif level.between?(301,500)
+        puts "#{BreatheIn::Scraper.index_hazardous}"   
+      end
+  end
+end

data/lib/breathe_in/scraper.rb

@@ -0,0 +1,134 @@
+class BreatheIn::Scraper
+    
+  @@air_quality_info = {}
+  @@scraped = nil
+
+  def self.air_quality
+    @@air_quality_info
+  end
+
+  def self.scraped_pg
+    @@scraped
+  end
+
+  def self.scraped_page(zipcode)
+    begin
+      @@scraped = Nokogiri::HTML(open("http://airnow.gov/?action=airnow.local_city&zipcode=#{zipcode}&submit=Go"))
+    rescue OpenURI::HTTPError => e
+        if e.message == '404 Not Found'
+          puts "The website is currently down. Pleaes try again later."
+        else
+          raise e
+        end
+    end
+  end  
+
+  def self.city_air_quality
+    city_name
+    today_high
+    index_level
+    current_conditions_time
+    current_conditions_value
+    current_conditions_index 
+    air_quality
+  end
+
+  def self.city_name
+    city = scraped_pg.css("#pageContent .ActiveCity")
+    #returns array of an object with attributes including city name
+    city.empty? ? nil : air_quality[:city_name] = city.text.strip
+  end
+
+  def self.today_high 
+    data = scraped_pg.css(".AQDataContent tr td .TblInvisible tr td")
+    #returns array of data numbers (today's high, tomorrow's high, particles, etc.)
+    data.empty? ? nil : air_quality[:today_high] = data[0].text.strip.to_i
+  end
+
+  def self.index_level 
+    quality = scraped_pg.css(".AQDataContent .AQILegendText")
+    #returns array of objects with attributes including quality
+    quality.empty? ? nil : air_quality[:today_index] = quality.first.text
+  end
+
+  def self.current_conditions_time
+    unformatted_info = scraped_pg.css(".AQData .AQDataSectionTitle .AQDataSectionTitle")
+    #returns array of objects with attributes of title and date information
+    current_info = unformatted_info.text.strip.split("\r\n                                       \t")
+    # => returns array ["Air Quality Index (AQI)", "observed at 19:00 PST"]
+    unformatted_info.empty? ? nil : air_quality[:last_update_time] = current_info[1]
+  end
+
+  def self.current_conditions_value 
+    current_value = scraped_pg.css(".AQDataSectionTitle .TblInvisible .TblInvisible td")
+    #returns array of an object with attributes including current condition value
+    current_value.empty? ? nil : air_quality[:last_update_value] = current_value.text.strip.to_i
+  end
+
+  def self.current_conditions_index 
+    current_index = scraped_pg.css(".AQDataSectionTitle .TblInvisible .AQDataLg")
+    #returns array of an object with attributes including current condition index
+    current_index.empty? ? nil : air_quality[:last_update_index] = current_index.text.strip
+  end
+
+  def self.index_good
+    print "Air quality is considered satisfactory, and air pollution poses little or no risk."
+  end
+
+  def self.index_moderate
+    print "Air quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people who are unusually sensitive to air pollution."
+  end
+
+  def self.index_sensitive
+    print "Members of sensitive groups may experience health effects. The general public is not likely to be affected."
+  end
+
+  def self.index_unhealthy
+    print "Everyone may begin to experience health effects; members of sensitive groups may experience more serious health effects."
+  end
+
+  def self.index_very_unhealthy
+    print "Health warnings of emergency conditions. The entire population is more likely to be affected."
+  end
+
+  def self.index_hazardous
+    print "Health alert: everyone may experience more serious health effects."
+  end
+
+  def self.AQI_range_information
+    information = <<-Ruby
+      The Air Quality Index (AQI) translates air quality data into an easily understandable number to identify how clean or polluted the outdoor air is, along with possible health effects. 
+      The U.S. Environmental Protection Agency, National Oceanic and Atmospheric Administration, National Park Service, tribal, state, and local agencies developed the AirNow system to provide the public with easy access to national air quality information. 
+
+      "Good" AQI is 0 - 50. 
+      Air quality is considered satisfactory, and air pollution poses little or no risk.
+      ***************************
+      "Moderate" AQI is 51 - 100. 
+      Air quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people. For example, people who are unusually sensitive to ozone may experience respiratory symptoms.
+      ***************************
+      "Unhealthy for Sensitive Groups" AQI is 101 - 150. 
+      Although general public is not likely to be affected at this AQI range, people with lung disease, older adults and children are at a greater risk from exposure to ozone, whereas persons with heart and lung disease, older adults and children are at greater risk from the presence of particles in the air. 
+      ***************************
+      "Unhealthy" AQI is 151 - 200. 
+      Everyone may begin to experience some adverse health effects, and members of the sensitive groups may experience more serious effects.
+      ***************************
+      "Very Unhealthy" AQI is 201 - 300. 
+      This would trigger a health alert signifying that everyone may experience more serious health effects.
+      ***************************
+      "Hazardous" AQI greater than 300. 
+      This would trigger a health warnings of emergency conditions. The entire population is more likely to be affected.
+      ***************************
+      All descriptions, information, and data are provided courtesy of AirNow.gov. Visit the website to learn more.
+    Ruby
+    puts information
+  end
+
+  def self.under_maintenance #returns true if under maintenance 
+    scraped_pg.css("#pageContent .TblInvisibleFixed tr p[style*='color:#F00;']").text.include?("maintenance")
+  end
+
+  # def self.unavailable_data #returns true if data is unavailable
+  #   phrase = scraped_pg.css(".TblInvisibleFixed .AQData tr td[valign*='top']").text
+  #   phrase.include?("Data Not Available")
+  # end
+end

data/lib/breathe_in/version.rb

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

data/lib/breathe_in.rb

@@ -0,0 +1,4 @@
+module BreatheIn
+end
+
+require_relative "../config/environment"

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: breathe_in
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- eric-an
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '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'
+- !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: Check the air quality index (AQI) for a zipcode.
+email:
+- erican@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/breathe_in
+- bin/console
+- bin/setup
+- breathe_in.gemspec
+- config/environment.rb
+- lib/breathe_in.rb
+- lib/breathe_in/city.rb
+- lib/breathe_in/cli.rb
+- lib/breathe_in/scraper.rb
+- lib/breathe_in/version.rb
+homepage: https://github.com/eric-an/breathe-in
+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: AQI scraper gem
+test_files: []