weather_usa 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6c3b86625407a23251757879aa5751cf17315820ae781d9974ccd50a88e227b
+  data.tar.gz: 35d54d72f74778ee487562ff5e4e806ddd772e4d31707d898452e0557f44cf9c
+SHA512:
+  metadata.gz: e3e17cb66d094eec50dbf854031874eef1d934f9f860ca50042d15b76e189d5a89c828991d9966f46f6a6d97f206f3607a25fe61fda2c00fd1c86eac63ab762b
+  data.tar.gz: c8d7f0f7d8c21d54bbda724a45a966a612aecb36c25b2d83e8a2e96d0c3ac7ab951f5f87a66b54fa381ec35f0dc4dafd4aef36366621888ec25e74e059d00392

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at micahmccallum@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in weather_usa.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    weather_usa (0.1.0)
+      colorize (~> 0.8.0)
+      geocoder (~> 1.6.0)
+      json-ld (~> 3.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    geocoder (1.6.3)
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    htmlentities (4.3.4)
+    json-canonicalization (0.2.0)
+    json-ld (3.1.4)
+      htmlentities (~> 4.3)
+      json-canonicalization (~> 0.2)
+      link_header (~> 0.0, >= 0.0.8)
+      multi_json (~> 1.14)
+      rack (~> 2.0)
+      rdf (~> 3.1)
+    link_header (0.0.8)
+    method_source (1.0.0)
+    multi_json (1.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.2)
+    rake (12.3.3)
+    rdf (3.1.1)
+      hamster (~> 3.0)
+      link_header (~> 0.0, >= 0.0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry (~> 0.13.0)
+  rake (~> 12.0)
+  rspec (~> 3.9.0)
+  weather_usa!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Micah McCallum
+
+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,49 @@
+# WeatherUsa
+
+WeatherUsa is a gem that with a zip code or a city and state combination returns the weather information from the weather.gov API for the United States of America and displays the formatted information to the console. After the initial search, current conditions are shown, along with any weather alerts.  There are also options for seeing more detailed forecasts or searching for another location.  Try it out!
+Please note:  At times there are issues with the API servers' response and at this time I have not included any way to handle these.  This will be looked at in a future release.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weather_usa'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install weather_usa
+
+## Usage
+
+From the command-line just type
+
+    $ weather_usa
+
+to start the program.
+
+After starting the program, just follow the onscreen menu; it is very self-guided.
+
+## 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]/weather_usa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/weather_usa/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WeatherUsa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/weather_usa/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "weather_usa"
+
+# 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 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+

data/bin/weather_usa

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

data/lib/weather_usa.rb

@@ -0,0 +1,18 @@
+require "geocoder"
+require "open-uri"
+require "json/ld"
+require "colorize"
+
+require "weather_usa/version"
+require "weather_usa/cli"
+require "weather_usa/scraper"
+require "weather_usa/weather"
+require "weather_usa/geocode"
+
+
+
+
+module WeatherUsa
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/weather_usa/cli.rb

@@ -0,0 +1,185 @@
+class WeatherUsa::CLI
+
+  BASE_PATH = "https://api.weather.gov/"
+  
+  def call
+    system "clear"
+    self.greeting
+    self.new_location    
+  end
+
+  def new_location
+    Weather.clear_all
+    self.ask_for_new_location    
+    @input = gets.strip
+    self.get_weather_information
+    system "clear"
+    self.display_current_conditions
+    self.display_alert
+    self.options    
+  end
+
+  def greeting
+    puts
+    puts 
+    puts "        *** Welcome to Weather USA! ***".blue    
+  end
+
+  def ask_for_new_location 
+    puts     
+    puts "  Please enter a geographic location in the United States.".blue
+    puts "      (This can be a zip code or a city and state)".blue
+    puts
+    print "    >>  ".green  
+  end
+
+  def goodbye
+    puts
+    puts
+    puts "  *** Thank you for using Weather USA. ***".blue
+    puts
+    puts
+    exit
+  end
+
+  def options
+    puts
+    puts "    What would you like to do? (Please select an option.)".blue
+    puts
+    puts "        1) See a detailed forecast for the current location.".blue
+    puts
+    puts "        2) See an extended forecast.".blue
+    puts
+    puts "        3) Choose a different location.".blue
+    puts
+    puts "        4) Exit the program.".blue
+    puts
+    print "    >>  ".green
+    option = gets.strip.to_s
+    system "clear"
+    case option
+    when "1"
+      self.display_detailed_forecast
+      self.options
+    when "2"
+      self.display_extended_forecast
+      self.options
+    when "3"      
+      self.new_location
+    when "4"
+      self.goodbye
+    else
+      self.options
+    end
+  end 
+
+  def display_current_conditions
+    right_now = self.current_conditions
+    right_now.current[:wind_speed] != nil ? wind_speed = meters_to_miles(right_now.current[:wind_speed]).round(0) : wind_speed = "N/A"
+    right_now.current[:temperature] != nil ? temperature = to_fahr(right_now.current[:temperature]) : temperature = "N/A"
+    puts "    Weather forecast for ".blue + "#{@location.name}".green + ":".blue
+    puts "    Current observations at: ".blue + "#{right_now.current[:station_name]}".green + ",".blue
+    puts "        the current temperature is ".blue + "#{temperature}".green + ",".blue
+    puts "        the current wind speed is ".blue + "#{wind_speed} mph".green + " from the ".blue + 
+                  "#{wind_direction_from_degrees(right_now.current[:wind_direction])}".green + ".".blue
+    puts "        Expected conditions: ".blue + "#{right_now.short_forecast}.".green
+  end
+
+  def display_alert
+    if current_conditions.current[:alert_headline]
+      puts "    Current alert:  ".red + "#{current_conditions.current[:alert_headline]}.".yellow
+      puts
+      puts "    Do you want to see a detailed description of the alert? (y/n)".blue
+      puts
+      print "    >>  ".green
+      input = gets.strip.downcase
+      puts
+      if input == "y"
+        system "clear"
+        current_conditions.current[:alert_description].split("\n").each do |line|
+          puts "    #{line}".yellow
+        end
+        puts
+      end
+    end    
+  end
+
+  def display_detailed_forecast    
+    puts
+    puts
+    puts "    Weather forecast for ".blue + "#{@location.name}".green + ":".blue
+    current_conditions.detailed_forecast.split(".").each do |line|
+      puts "    #{line}.".green
+    end    
+  end
+
+  def display_extended_forecast
+    Weather.all.each_with_index do |period, index|
+      period.is_daytime ? am_pm = "High" : am_pm = "Low"
+      if index < 8
+        puts "    #{period.name}".green
+        puts "        #{period.short_forecast}".green
+        puts "        #{am_pm} temperature: ".blue + "#{period.temperature}".green
+      end   
+    end
+  end  
+
+  def get_weather_information
+    self.get_location
+    self.scrape_weather_site
+    self.create_weather_objects_from_array        
+  end
+
+  def get_location
+    @location = Geocode.get_geocode(@input)
+  end 
+
+  def scrape_weather_site
+    @weather_array = Scraper.scrape_weather_dot_gov(BASE_PATH, @location)
+  end
+
+  def create_weather_objects_from_array    
+    @weather_array.each do |period|
+      Weather.new(period)
+    end 
+  end
+
+  def current_conditions
+    Weather.all[0]
+  end
+
+  def to_fahr(number)
+    ((number * 9) / 5 + 32).round(0) 
+  end
+
+  def meters_to_miles(number)
+    (number * 2.23694).round(0)
+  end
+
+  def wind_direction_from_degrees(degrees)
+    case degrees    
+    when 0..22.5
+      "N"
+    when 22.6..67.5
+      "NE"
+    when 67.6..112.5
+      "E"
+    when 112.6..157.5
+      "SE"
+    when 157.6..202.5
+      "S"
+    when 202.6..247.5
+      "SW"
+    when 247.6..292.5
+      "W"
+    when 292.6..337.5
+      "NW"
+    when 337.6..360
+      "N"
+    else
+      "N/A"
+    end
+  end  
+  
+end
+

data/lib/weather_usa/geocode.rb

@@ -0,0 +1,25 @@
+class Geocode
+  attr_reader :latitude, :longitude, :name
+
+  def initialize(result)
+    location = result.find {|obj| obj.data["address"]["country_code"] == "us"} 
+    @name = location.data["display_name"]
+    @latitude = location.data["lat"]
+    @longitude = location.data["lon"]    
+  end
+
+  def self.get_geocode(search_term)
+    result = Geocoder.search(search_term)
+    if !(result.find {|obj| obj.data["address"]["country_code"] == "us"})
+      puts
+      puts "    Please enter a valid search.".red
+      puts
+      print "    >>  ".green
+      input = gets.strip
+      self.get_geocode(input)
+    else
+      Geocode.new(result)
+    end   
+  end
+
+end

data/lib/weather_usa/scraper.rb

@@ -0,0 +1,53 @@
+
+class Scraper
+  
+  def self.scrape_weather_dot_gov(url, location)
+    
+    weather_array = []
+    current = {}
+    base_url = url + "points/#{location.latitude},#{location.longitude}"
+    station_url = base_url + "/stations"
+    forecast_url = base_url + "/forecast"
+    station_doc = Scraper::get_doc(station_url)
+    station_id = station_doc["features"].first["properties"]["stationIdentifier"]
+    station_name = station_doc["features"].first["properties"]["name"]
+    current_url = url + "stations/#{station_id}/observations/latest"
+    current_doc = Scraper::get_doc(current_url)
+    current[:weather_description] = current_doc["properties"]["textDescription"]
+    current[:temperature] = current_doc["properties"]["temperature"]["value"]
+    current[:wind_speed] = current_doc["properties"]["windSpeed"]["value"]
+    current[:wind_direction] = current_doc["properties"]["windDirection"]["value"]
+    current[:station_name] = station_name
+    zone_doc = Scraper::get_doc(base_url)
+    zone_id = zone_doc["properties"]["forecastZone"].split("/").last
+    alert_url  = url + "alerts/active/zone/#{zone_id}"
+    alerts = Scraper::get_doc(alert_url)
+    
+    if alerts["features"].count > 0
+      current[:alert_headline] = alerts["features"][0]["properties"]["headline"]
+      current[:alert_description] = alerts["features"][0]["properties"]["description"]
+    end
+    
+    forecast_doc = Scraper::get_doc(forecast_url) 
+    periods = forecast_doc["properties"]["periods"]  
+    periods.each do |period|
+      weather_period = {}
+      weather_period[:number] = period["number"]
+      weather_period[:name] = period["name"]
+      weather_period[:temperature] = period["temperature"]
+      weather_period[:wind_speed] = period["windSpeed"]
+      weather_period[:wind_direction] = period["windDirection"]
+      weather_period[:short_forecast] = period["shortForecast"]
+      weather_period[:detailed_forecast] = period["detailedForecast"]
+      weather_period[:is_daytime] = period["isDaytime"]     
+      weather_array << weather_period    
+    end    
+    weather_array[0][:current] = current    
+    weather_array
+  end
+
+  def self.get_doc(url)
+    JSON.load(URI.open(url))       
+  end  
+
+end

data/lib/weather_usa/version.rb

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

data/lib/weather_usa/weather.rb

@@ -0,0 +1,22 @@
+class Weather
+  attr_accessor :number, :name, :temperature, :wind_speed, :wind_direction,
+                 :short_forecast, :detailed_forecast, :current, :is_daytime
+
+  @@all = []
+
+  def initialize(weather_hash)
+    weather_hash.each do |k, v|
+      self.send "#{k}=", v         
+    end    
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.clear_all
+    @@all = []
+  end
+  
+end

data/weather_usa.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/weather_usa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "weather_usa"
+  spec.version       = WeatherUsa::VERSION
+  spec.authors       = ["Micah McCallum"]
+  spec.email         = ["micahmccallum@outlook.com"]
+
+  spec.summary       = "A gem to pull weather information from weather.gov"
+  spec.homepage      = "https://github.com/micahmccallum/weather_usa.git"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/micahmccallum/weather_usa.git"
+  spec.metadata["changelog_uri"] = "https://github.com/micahmccallum/weather_usa.git"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git. 
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["weather_usa"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "geocoder", "~> 1.6.0"
+  spec.add_dependency "json-ld", "~> 3.1.0"
+  spec.add_dependency "colorize", "~> 0.8.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: weather_usa
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Micah McCallum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: json-ld
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: 
+email:
+- micahmccallum@outlook.com
+executables:
+- weather_usa
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/weather_usa
+- flowchart.pdf
+- lib/weather_usa.rb
+- lib/weather_usa/cli.rb
+- lib/weather_usa/geocode.rb
+- lib/weather_usa/scraper.rb
+- lib/weather_usa/version.rb
+- lib/weather_usa/weather.rb
+- weather_usa.gemspec
+homepage: https://github.com/micahmccallum/weather_usa.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/micahmccallum/weather_usa.git
+  source_code_uri: https://github.com/micahmccallum/weather_usa.git
+  changelog_uri: https://github.com/micahmccallum/weather_usa.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A gem to pull weather information from weather.gov
+test_files: []