weather-sage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 390dc567cf5a2696830a36bd2a6a27020a2310721a95f69530ccbd0688c06d28
+  data.tar.gz: 9fc5165689410c41763750e06b5590452294f2588880cb2f027dbe98191e0be6
+SHA512:
+  metadata.gz: b23545938bb233191fb042f1cb7d45c098332421dbfb53c6fae126f5a3ef8f6543d75c16d4537582222e519e7da320fc11abbcaadaeed0f7fd4fcb31f83cdefc
+  data.tar.gz: 1541a3ef620d4667e45fe513f95f61e891ff259ab0309c4286ca709498eca8bca2972d9ede59e0587bd51dbacb9403c9ebdff1d491af33320f58400fae619c9f

data/README.md

@@ -0,0 +1,88 @@
+Weather Sage
+============
+Ruby library and command-line tool to get the weather forecast and
+current weather observations for an address.
+
+Uses the [Census Bureau Geocoding API][census-api] to geocode street
+addresses, and the [National Weather Service Weather API][weather-api]
+to get weather forecasts and current weather observations.
+
+Here's an example of using the command-line tool to get the current
+weather forecast for the address "1600 pennsylvania ave nw, washington
+dc":
+
+```
+> bin/weather-sage forecast '1600 pennsylvania ave nw washington dc'
+address,name,temperature,temperature_unit,wind_speed,wind_direction,short_forecast
+1600 pennsylvania ave washington dc,Today,97,F,7 mph,SW,Scattered Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Tonight,76,F,2 to 7 mph,SW,Scattered Showers And Thunderstorms then Mostly Cloudy
+1600 pennsylvania ave washington dc,Tuesday,94,F,6 mph,E,Slight Chance Rain Showers then Chance Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Tuesday Night,75,F,2 to 6 mph,S,Chance Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Wednesday,94,F,3 to 9 mph,SW,Chance Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Wednesday Night,76,F,5 to 8 mph,SW,Chance Showers And Thunderstorms
+...
+```
+
+Installation
+------------
+Install via [RubyGems][]:
+
+```
+# install weather-sage
+> sudo gem install weather-sage
+```
+
+Examples
+--------
+**Get weather forecast for an address:**
+```
+# get weather forecast for address
+> bin/weather-sage forecast '1600 pennsylvania ave washington dc'
+address,name,temperature,temperature_unit,wind_speed,wind_direction,short_forecast
+1600 pennsylvania ave washington dc,Today,97,F,7 mph,SW,Scattered Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Tonight,76,F,2 to 7 mph,SW,Scattered Showers And Thunderstorms then Mostly Cloudy
+1600 pennsylvania ave washington dc,Tuesday,94,F,6 mph,E,Slight Chance Rain Showers then Chance Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Tuesday Night,75,F,2 to 6 mph,S,Chance Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Wednesday,94,F,3 to 9 mph,SW,Chance Showers And Thunderstorms
+1600 pennsylvania ave washington dc,Wednesday Night,76,F,5 to 8 mph,SW,Chance Showers And Thunderstorms
+...
+```
+
+**Get current observations from nearest weather station:**
+```
+# get current observations from nearest weather station
+> weather-sage now '1600 pennsylvania ave washington dc'
+address,name,type,value,unit,quality_control
+1600 pennsylvania ave washington dc,timestamp,time,2019-08-19T06:52:00+00:00
+1600 pennsylvania ave washington dc,textDescription,text,Mostly Cloudy
+1600 pennsylvania ave washington dc,temperature,value,26.700000000000045,unit:degC,qc:V
+1600 pennsylvania ave washington dc,relativeHumidity,value,81.65039907186703,unit:percent,qc:C
+...
+```
+
+Commands
+--------
+Available commands in command-line interface.
+
+* `forecast`: Get weather forecast for address.
+* `geocode`: Geocode address.
+* `help`: List commands.
+* `hourly`: Get hourly weather forecast for address.
+* `now`: Get current weather from station closest to address.
+* `stations`: List weather stations near address.
+
+Environment Variables
+---------------------
+The command-line tool can be configured via the following environment
+variables:
+
+* `WEATHER_SAGE_LOG_LEVEL`: Log level. One of: `fatal`, `error`,
+  `warning`, `info`, `debug`). Defaults to `warn`.
+* `WEATHER_SAGE_LOG_PATH`: Path to log file. Defaults to standard error.
+* `WEATHER_SAGE_CACHE_PATH`: Path to HTTP cache. Defaults to
+  `~/.config/weather-sage/http-cache.pstore`.
+
+  [ruby]: https://ruby-lang.org/ "Ruby programming language"
+  [rubygems]: https://rubygems.org/ "Ruby package manager"
+  [weather-api]: https://api.weather.gov/ "national Weather Service (NWS) Weather API"
+  [census-api]: https://geocoding.geo.census.gov/geocoder/ "Census Bureau Geocoding API"

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake/testtask'
+require 'rdoc/task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+RDoc::Task.new :docs do |t|
+  t.main = "lib/weather-sage.rb"
+  t.rdoc_files.include('lib/*.rb')
+  t.rdoc_dir = 'docs'
+  # t.options << "--all"
+end
+
+desc "Run tests"
+task default: :test

data/bin/weather-sage

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/weather-sage'
+
+# run command-line interface
+WeatherSage::CLI.run($0, ARGV)

data/lib/weather-sage.rb

@@ -0,0 +1,25 @@
+#
+# Get weather forecast and current weather for address.
+#
+# Wrapper around the following APIs:
+#
+# * National Weather Service Weather API (https://api.weather.gov/)
+# * Census Bureau Geocoder API (https://geocoding.geo.census.gov/geocoder/)
+#
+module WeatherSage
+  #
+  # Release version.
+  #
+  VERSION = '0.1.0'
+
+  # :nodoc:
+  LIB_DIR = File.join(__dir__, 'weather-sage').freeze
+
+  autoload :CacheEntry, File.join(LIB_DIR, 'cache-entry.rb')
+  autoload :Cache, File.join(LIB_DIR, 'cache.rb')
+  autoload :HTTP, File.join(LIB_DIR, 'http.rb')
+  autoload :Context, File.join(LIB_DIR, 'context.rb')
+  autoload :Census, File.join(LIB_DIR, 'census.rb')
+  autoload :Weather, File.join(LIB_DIR, 'weather.rb')
+  autoload :CLI, File.join(LIB_DIR, 'cli.rb')
+end

data/license.txt

@@ -0,0 +1,20 @@
+Copyright 2019 Paul Duncan
+
+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/test/make-csvs.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# TODO: move to rake task
+ADDR='7309 carol ln falls church va 22042'
+
+bin/weather-sage hourly -f "$ADDR" > hourly-full.csv
+bin/weather-sage hourly -b "$ADDR" > hourly-brief.csv
+bin/weather-sage forecast -b "$ADDR" > forecast-brief.csv
+bin/weather-sage forecast -f "$ADDR" > forecast-full.csv
+bin/weather-sage now "$ADDR" > now.csv

data/test/test-cache.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+require 'fileutils'
+require_relative '../lib/weather-sage'
+
+class TestWeatherSageCache < Minitest::Test
+  def setup
+    # create temporary directory that is removed on exit
+    @dir = Dir.mktmpdir('test-cache')
+    at_exit { FileUtils.rm_r(@dir) }
+
+    # build absolute path to backing store for cache
+    path = File.join(@dir, 'cache.pstore')
+
+    # create cache instance
+    @cache = WeatherSage::Cache.new(path)
+  end
+
+  def test_new
+    # build absolute path to backing store for cache
+    path = File.join(@dir, 'test-new.pstore')
+
+    # asset that cache is not nil
+    assert WeatherSage::Cache.new(path)
+  end
+
+  def test_set
+    key, want = 'test_set', 'bar'
+    assert_equal want, @cache.set(key, want)
+  end
+
+  def test_get
+    # set value
+    key, want = 'test_get', 'bar'
+    @cache.set(key, want)
+
+    # get value, test result
+    got = @cache.get(key)
+    assert_equal want, got
+  end
+
+  def test_key?
+    key, want = 'test_key?', 'bar'
+    @cache.set(key, want)
+    assert @cache.key?(key)
+  end
+
+  def test_set_timeout
+    key, want, timeout = 'test_set_timeout', 'bar', 10
+
+    # set long timeout, then get result before expiration
+    @cache.set(key, want, timeout)
+    assert_equal want, @cache.get(key)
+  end
+
+  def test_set_timeout_expired
+    key, want, timeout = 'test_set_timeout_expired', 'bar', 0.1
+
+    # set short timeout, then wait for it to pass
+    @cache.set(key, want, timeout)
+    sleep(timeout + 1)
+
+    assert_nil @cache.get(key)
+  end
+end

data/test/test-census-geocoder.rb

@@ -0,0 +1,49 @@
+require 'fileutils'
+require 'logger'
+require 'minitest/autorun'
+require_relative '../lib/weather-sage'
+require_relative './test-helpers'
+
+class TestWeatherSageCensusGeocoder < Minitest::Test
+  #
+  # Test addresses.
+  #
+  TESTS = [{
+    text: '2565 van buren st eugene or 97405',
+    want: [-123.109825, 44.03039],
+  }, {
+    text: '1600 pennsylvania ave nw washington dc',
+    want: [-77.03535, 38.898754],
+  }, {
+    text: '3150 fairview park dr falls church va 22042',
+    want: [-77.216194, 38.859795],
+  }]
+
+  def setup
+    # cache test context
+    @ctx = WeatherSage::Tests.get_test_context
+
+    # create and save geocoder
+    @geocoder = WeatherSage::Census::Geocoder.new(@ctx)
+  end
+
+  def test_new
+    # create new geocoder
+    assert WeatherSage::Census::Geocoder.new(@ctx)
+  end
+
+  def test_run
+    # assert that geocoder can geocode a single address
+    assert @geocoder.run(TESTS.first[:text])
+  end
+
+  def test_results
+    TESTS.each do |test|
+      # geocode address, get first result
+      pt = @geocoder.run(test[:text]).first.point
+
+      assert_in_delta pt.x, test[:want][0]
+      assert_in_delta pt.y, test[:want][1]
+    end
+  end
+end

data/test/test-helpers.rb

@@ -0,0 +1,24 @@
+module WeatherSage::Tests
+  def self.get_test_context
+    unless @ctx
+      # create temporary directory that is removed on exit
+      @dir = Dir.mktmpdir('test-weather-sage')
+      at_exit { FileUtils.rm_r(@dir) }
+
+      # build absolute path to backing store for cache
+      cache_path = File.join(@dir, 'cache.pstore')
+
+      # create null logger
+      log = ::Logger.new('/dev/null')
+
+      # create cache instance
+      cache = WeatherSage::HTTP::Cache.new(cache_path, log)
+
+      # create and save context
+      @ctx = WeatherSage::Context.new(log, cache)
+    end
+
+    # return cached context
+    @ctx
+  end
+end

data/test/test-http-cache.rb

@@ -0,0 +1,103 @@
+require 'minitest/autorun'
+require 'open-uri'
+require 'fileutils'
+require 'logger'
+require_relative '../lib/weather-sage'
+
+class TestWeatherSageHttpCache < Minitest::Test
+  #
+  # list of test urls
+  #
+  URLS = {
+    good: 'https://pablotron.org/',
+    bad: 'https://pablotron.org/does-not-exist',
+  }
+
+  def setup
+    # create temporary directory that is removed on exit
+    @dir = Dir.mktmpdir('test-http-cache')
+    at_exit { FileUtils.rm_r(@dir) }
+
+    # build absolute path to backing store for cache
+    path = File.join(@dir, 'cache.pstore')
+
+    # create null logger
+    @log = ::Logger.new('/dev/null')
+
+    # create cache instance
+    @cache = WeatherSage::HTTP::Cache.new(path, @log)
+  end
+
+  def test_new
+    # build absolute path to backing store for cache
+    path = File.join(@dir, 'test-new.pstore')
+
+    # asset that cache is not nil
+    assert WeatherSage::HTTP::Cache.new(path, @log)
+  end
+
+  def test_new_timeout
+    # build absolute path to backing store for cache
+    path = File.join(@dir, 'test-new-timeout.pstore')
+
+    # set timeout to one second
+    timeout = 1
+
+    # create cache with timeout
+    cache = WeatherSage::HTTP::Cache.new(path, @log, timeout)
+
+    # asset that timeout is saved
+    assert_equal timeout, cache.timeout
+  end
+
+  def test_new_timeout_expired
+    # build absolute path to backing store for cache
+    path = File.join(@dir, 'test-new-timeout.pstore')
+
+    # set timeout to one seconds
+    timeout = 1
+
+    # create cache with one second
+    cache = WeatherSage::HTTP::Cache.new(path, @log, timeout)
+
+    # get known good url
+    cache.get(URLS[:good])
+
+    # wait for entry to expire
+    sleep(timeout + 0.1)
+
+    # asset that entry is expired
+    assert !cache.key?(URLS[:good])
+  end
+
+  def test_get
+    # read URl directly
+    want = read_url(URLS[:good])
+
+    # get URL through cache
+    got = @cache.get(URLS[:good])
+
+    # test result
+    assert_equal want, got
+  end
+
+  def test_get_bad
+    assert_raises(WeatherSage::HTTP::Error) do
+      @cache.get(URLS[:bad])
+    end
+  end
+
+  private
+
+  #
+  # Read given URL.
+  #
+  # Note: currently forces UTF-8 encoding.
+  #
+  def read_url(url)
+    # open(url, 'rb') { |fh| fh.read }
+
+    # read contents of URL, force UTF-8 encoding
+    open(url, 'rb', encoding: 'UTF-8') { |fh| fh.read }
+  end
+end

data/test/test-weather-point.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+require 'logger'
+require 'minitest/autorun'
+require_relative '../lib/weather-sage'
+require_relative './test-helpers'
+
+class WeatherSage::Tests::TestWeatherPoint < Minitest::Test
+  #
+  # Test addresses.
+  #
+  TESTS = [{
+    id: '2565 van buren st eugene or 97405',
+    pt: [-123.109825, 44.03039],
+  }, {
+    id: '1600 pennsylvania ave nw washington dc',
+    pt: [-77.03535, 38.898754],
+  }, {
+    id: '3150 fairview park dr falls church va 22042',
+    pt: [-77.216194, 38.859795],
+  }]
+
+  def setup
+    # cache test context
+    @ctx = WeatherSage::Tests.get_test_context
+  end
+
+  def test_new
+    # create point from lat/long
+    x, y = TESTS.first[:pt]
+    assert WeatherSage::Weather::Point.new(@ctx, x, y)
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: weather-sage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Duncan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-18 00:00:00.000000000 Z
+dependencies: []
+description: "\n    Ruby library and command-line tool to get the weather forecast
+  and\n    current weather observations for an address.\n\n    Uses the Census Bureau
+  Geocoding API to geocode street addresses,\n    and the National Weather Service
+  Weather API to get weather\n    forecasts and current weather observations.\n  "
+email: pabs@pablotron.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/weather-sage
+- lib/weather-sage.rb
+- license.txt
+- test/make-csvs.sh
+- test/test-cache.rb
+- test/test-census-geocoder.rb
+- test/test-helpers.rb
+- test/test-http-cache.rb
+- test/test-weather-point.rb
+homepage: https://github.com/pablotron/weather-sage
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/pablotron/weather-sage/issues
+  documentation_uri: https://pablotron.github.io/weather-sage/
+  homepage_uri: https://github.com/pablotron/weather-sage
+  source_code_uri: https://github.com/pablotron/weather-sage
+  wiki_uri: https://github.com/pablotron/weather-sage/wiki
+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.6.2
+signing_key: 
+specification_version: 4
+summary: Get weather forecast for an address.
+test_files: []