weather_alert_mbj 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9536c7dba0d236238ad5fb074dd698724df522f9a4e812254776c4f8281cbaeb
+  data.tar.gz: b119b746f99c87d23d50bb7fecaecc8b3e05b596a8c655fa84df53d3cba68630
+SHA512:
+  metadata.gz: 8cf12ea369c56a235999204809f3b1e857e55a645d8025c281cfaf6f24bbd193138dadfa09853afef2316c02bdc56584667190e2d99839cc6ec7dd9c5fb8930c
+  data.tar.gz: 4b6161d6efd1eb45d9c3a24775ff03c1308c52e015b39c9485f1386f97300d8c3c3e1711a38d6d1f7d9efda26cf8d021470f5cf5b996224984d4e749c1779ace

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in weather_alert_mbj.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Marcus Jun'
+
+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,42 @@
+# WeatherAlertMbj
+
+This gem uses webscraping to get National Weather Service weather alerts by state. See https://alerts.weather.gov/
+
+## Installation
+
+(You can clone or download the code from https://github.com/marcusjun/weather-alert-mbj-cli-app)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weather_alert_mbj'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weather_alert_mbj
+
+
+## Usage
+
+Run the executable in bin/weather-alert-mbj with the following command
+
+  ```$ ./bin/weather-alert-mbj```
+
+## 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/marcusjun/weather_alert_mbj.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+#Both require statements below work
+#require "weather_alert_mbj"
+require_relative '../lib/weather_alert_mbj'
+
+# 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"
+
+puts "  Welcome to the Weather Alert Sandbox  ".colorize(:color => :blue, :background => :light_white)
+
+IRB.start(__FILE__)

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/weather-alert-mbj

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+#Both require statements below work
+#require './lib/weather_alert_mbj'
+require_relative '../lib/weather_alert_mbj'
+
+#require "bundler/setup"
+#require "weather_alert_mbj"
+
+WeatherAlertMbj::CLI.new.call

data/lib/weather_alert_mbj.rb

@@ -0,0 +1,14 @@
+require 'open-uri'
+require 'pry'
+require 'nokogiri'
+require 'colorize'
+
+#require "weather_alert_mbj/version"
+require_relative "./weather_alert_mbj/version"
+
+#module WeatherAlertMbj
+  # Your code goes here...
+#end
+
+require_relative './weather_alert_mbj/alert'
+require_relative './weather_alert_mbj/cli'

data/lib/weather_alert_mbj/cli.rb

@@ -0,0 +1,199 @@
+class WeatherAlertMbj::CLI
+
+  STATE_CODES={
+    "al" => "Alabama",
+    "ak" => "Alaska",
+    "az" => "Arizona",
+    "ar" => "Arkansas",
+    "ca" => "California",
+    "co" => "Colorado",
+    "ct" => "Connecticut",
+    "de" => "Delware",
+    "dc" => "District of Columbia",
+    "fl" => "Florida",
+    "ga" => "Georgia",
+    "hi" => "Hawaii",
+    "id" => "Idaho",
+    "il" => "Illinois",
+    "in" => "Indiana",
+    "ia" => "Iowa",
+    "ks" => "Kansas",
+    "ky" => "Kentucky",
+    "la" => "Louisiana",
+    "me" => "Maine",
+    "md" => "Maryland",
+    "ma" => "Massachusetts",
+    "mi" => "Michigan",
+    "mn" => "Minnesota",
+    "ms" => "Mississippi",
+    "mo" => "Missouri",
+    "mt" => "Montana",
+    "ne" => "Nebraska",
+    "nv" => "Nevada",
+    "nh" => "New Hampshire",
+    "nj" => "New Jersey",
+    "nm" => "New Mexico",
+    "ny" => "New York",
+    "nc" => "North Carolina",
+    "nd" => "North Dakota",
+    "oh" => "Ohio",
+    "ok" => "Oklahoma",
+    "or" => "Oregon",
+    "pa" => "Pennsylvania",
+    "ri" => "Rhode Island",
+    "sc" => "South Carolina",
+    "sd" => "South Dakota",
+    "tn" => "Tennessee",
+    "tx" => "Texas",
+    "us" => "United States",
+    "ut" => "Utah",
+    "vt" => "Vermont",
+    "va" => "Virginia",
+    "wa" => "Washington",
+    "wv" => "West Virginia",
+    "wi" => "Wisconsin",
+    "wy" => "Wyoming",
+    #US territories and other
+    "as" => "American Samoa",
+    "gu" => "Guam",
+    "mp" => "Northern Mariana Islands",
+    "pr" => "Puerto Rico",
+    "vi" => "U.S. Virgin Islands",
+    "um" => "U.S. Minor Outlying Islands"
+  }
+
+
+  def call
+    line_break
+    puts "\nWelcome to Weather Alert.".colorize(:color => :blue)
+
+    get_state_and_its_alerts
+    goodbye
+  end
+
+  def get_state_and_its_alerts
+
+    state_input = ""
+
+    while state_input.downcase != "exit"
+      puts "\nPlease enter the two-letter code for the US state or territory\nyou wish to get weather alerts for.".colorize(:color => :green)
+      puts "  For example, CA = California and TX = Texas"
+      puts "  Or type 'Exit' to quit Weather Alert."
+
+      state_input = gets.strip.downcase
+
+      #Conditional statement that ensures user input is a valid state code or valid state name
+      if STATE_CODES.keys.include?(state_input) || STATE_CODES.any? {|state_code,state_name| state_name.downcase == state_input}
+
+        #If user inputs full name of state (California) rather than its code (CA)
+        #then the following code assigns state_input to the state code.
+        STATE_CODES.each {|state_code,state_name| state_input = STATE_CODES.key(state_name) if state_input == state_name.downcase}
+
+        puts "\nLoading data for " + "#{STATE_CODES[state_input]}".colorize(:color => :blue) + "..."
+        puts "(It may take up to 1 minute to retrieve data.)"
+        line_break
+
+        @state_alerts = WeatherAlertMbj::Alert.create_alerts(state_input)
+
+        get_and_display_alert_details
+
+      elsif state_input.downcase != "exit"
+        line_break
+        puts "\n  Please double check the code you entered.  ".colorize(:color => :light_white, :background => :red)#(:color => :red)
+        line_break
+      end
+
+    end
+  end
+
+  def get_and_display_alert_details
+    display_alerts
+
+    menu_input = ""
+
+    while menu_input.downcase != "exit"
+
+      if @state_alerts[0].name == "There are no active watches, warnings or advisories"
+
+        #If a state has no weather alerts, then menu_input is set to "exit"
+        #because there are no alerts to get more details on.
+        menu_input = "exit"
+        line_break
+
+      else
+        line_break
+        puts "\nPlease enter the number (from 1 - #{@state_alerts.length}) of the alert for more details.".colorize(:color => :green)
+        puts "  Or type 'List' to see a list of alerts."
+        puts "  Or type 'Exit' to return to the previous menu."
+        line_break
+
+        menu_input = gets.strip.downcase
+
+        if menu_input.downcase == "list"
+          display_alerts
+
+        #elsif menu_input.to_i <= @state_alerts.length && menu_input.to_i > 0
+        elsif menu_input.to_i.between?(1,@state_alerts.length)
+
+          selected_alert = @state_alerts[menu_input.to_i-1]
+
+          #Displays the details of an alert including its
+          #name, state, urgency (if immediate), description, instructions and urls.
+
+          puts "\nAlert ##{menu_input}: #{selected_alert.name} (#{STATE_CODES[selected_alert.state]})".colorize(:color => :blue)
+
+          puts "Urgency: #{selected_alert.urgency}".colorize(:color => :red) if selected_alert.urgency.downcase == "immediate"
+
+          puts "\nDescription:".colorize(:color => :blue)
+          puts "#{selected_alert.description}"
+
+          #puts instructions if the alert's attribute, instructions is not an empty string
+          puts "\nInstructions:".colorize(:color => :blue) unless selected_alert.instructions == ""
+          puts "#{selected_alert.instructions}" unless selected_alert.instructions == ""
+
+          puts "\nFor more info, please see".colorize(:color => :blue)
+          puts "#{selected_alert.state_url}"
+          puts "#{selected_alert.alert_url}"
+
+        elsif menu_input != "exit"
+          puts "\n  Please double check the number you entered.  ".colorize(:color => :light_white, :background => :red)
+        end
+      end
+    end
+  end
+
+
+  def display_alerts
+
+    @state_alerts.each_with_index do |alert,index|
+
+      selected_state = STATE_CODES[alert.state]
+
+      if alert.name == "There are no active watches, warnings or advisories"
+        puts "\n  Currently, #{alert.name.downcase} for #{selected_state}.".colorize(:color => :blue)
+
+      else
+        puts "\nAlert ##{index+1}: #{alert.name} (#{selected_state})".colorize(:color => :blue)
+
+        #Alerts with an "immediate" urgency have the text, "immediate" in red.
+        if alert.urgency.downcase == "immediate"
+          puts "  Urgency: #{alert.urgency}".colorize(:color => :red)
+        else
+          puts "  Urgency: #{alert.urgency}"
+        end
+
+        puts "  Areas: #{alert.areas_affected}"
+        puts "  Date: #{alert.date}"
+      end
+    end
+  end
+
+  def goodbye
+    puts "\nThanks for using Weather Alert. Goodbye.".colorize(:color => :blue)
+    puts "  For more weather alerts, please visit https://alerts.weather.gov/\n".colorize(:color => :blue)
+  end
+
+  def line_break
+    puts "\n-------------------------------------------------------------------------------------".colorize(:color => :light_white)
+  end
+end

data/lib/weather_alert_mbj/version.rb

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

data/weather_alert_mbj.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "weather_alert_mbj/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "weather_alert_mbj"
+  spec.version       = WeatherAlertMbj::VERSION
+  spec.authors       = ["Marcus Jun"]
+  spec.email         = [""]
+
+  spec.summary       = "This gem uses webscraping to get National Weather Service weather alerts by state. See https://alerts.weather.gov/"
+    #%q{TODO: Write a short summary, because RubyGems requires one.}
+  spec.description   = "The user enters a US state or territory and the gem returns a list of weather alerts. Then user can choose a weather alert to see more details."
+    #%q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/marcusjun/weather-alert-mbj-cli-app"
+    #"TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # My modifications below
+  #spec.add_development_dependency "pry"
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "colorize", "~> 0.8.1"
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: weather_alert_mbj
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcus Jun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: The user enters a US state or territory and the gem returns a list of
+  weather alerts. Then user can choose a weather alert to see more details.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/weather-alert-mbj
+- lib/weather_alert_mbj.rb
+- lib/weather_alert_mbj/cli.rb
+- lib/weather_alert_mbj/version.rb
+- weather_alert_mbj.gemspec
+homepage: https://github.com/marcusjun/weather-alert-mbj-cli-app
+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.7.7
+signing_key: 
+specification_version: 4
+summary: This gem uses webscraping to get National Weather Service weather alerts
+  by state. See https://alerts.weather.gov/
+test_files: []