weathercom 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a1cd129b393ad377eee8ab97d03889911468403c697df53e513e8fc6fb8feb7
+  data.tar.gz: 70f9251e341bf65aeef8a718e6e57a7628f6e1491c3c3487b3a80e049fc1c2f9
+SHA512:
+  metadata.gz: 68303cb4b06e1b9c6d359ff489b56b1914de287e8b28b6f134c11da873e1da917af7fdbd9ee1fd5c70db347a3cb142a3ce8c80ba31effc32db17314e6402369a
+  data.tar.gz: 3a2d5409025765ed4e2217dc7daa9ffe7ebc273928bb1742a30c7d9bfc0f62decf5725bae6f3ae4df0223eb8d2f81d02e69536788ea34dce5b4b4b768da0213d

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2018 Oleg Pudeyev
+
+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,7 @@
+# Weathercom
+
+Ruby client for weather.com / wunderground API.
+
+## License
+
+MIT

data/lib/weathercom.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'faraday'
+
+require 'weathercom/client'
+require 'weathercom/location'
+require 'weathercom/metadata'
+require 'weathercom/geocoded_location'
+require 'weathercom/forecast_methods'
+require 'weathercom/day_part_forecast'
+require 'weathercom/daily_forecast'
+require 'weathercom/hourly_forecast'
+require 'weathercom/wwir_forecast'
+require 'weathercom/observation'

data/lib/weathercom/client.rb

@@ -0,0 +1,159 @@
+module Weathercom
+
+class Client
+  class ApiError < StandardError
+    def initialize(message, status: nil)
+      super(message)
+      @status = status
+    end
+
+    attr_reader :status
+  end
+
+  class ApiKeyScrapeError < StandardError
+  end
+
+  def initialize(api_key: nil, cache: nil)
+    @configured_api_key = api_key
+    @cache = cache
+    @connection ||= Faraday.new("https://api.weather.com") do |f|
+      f.request :url_encoded
+      #f.response :detailed_logger
+      f.adapter Faraday.default_adapter
+      f.headers['user-agent'] = 'Mozilla/5.0 (Compatible)'
+    end
+    if api_key.nil?
+      @api_key = cache.get('weathercom:api_key')
+    end
+  end
+
+  attr_reader :configured_api_key
+  attr_reader :connection
+
+  def api_key
+    configured_api_key or begin
+      @api_key ||= scrape_api_key
+      if @cache
+        @cache.set('weathercom:api_key', @api_key)
+      end
+      @api_key
+    end
+  end
+
+  private def clear_api_key
+    @api_key = nil
+    if @cache
+      @cache.set('weathercom:api_key', nil)
+    end
+  end
+
+  def get_json(url)
+    request_json(:get, url)
+  end
+
+  def get_json_with_cache(url)
+    request_json_with_cache(:get, url)
+  end
+
+  def request_json(meth, url)
+    attempt = 1
+    loop do
+      if url.include?('?')
+        full_url = "#{url}&apiKey=#{URI.encode(api_key)}"
+      else
+        full_url = "#{url}?apiKey=#{URI.encode(api_key)}"
+      end
+
+      response = connection.send(meth) do |req|
+        req.url(full_url)
+      end
+      if response.status == 401 && configured_api_key.nil? && attempt == 1
+        clear_api_key
+        attempt += 1
+        next
+      end
+      unless response.status == 200
+        error = nil
+        begin
+          error = JSON.parse(response.body)['error']
+        rescue
+        end
+        msg = "Weathercom #{meth.to_s.upcase} #{url} failed: #{response.status}"
+        if error
+          msg += ": #{error}"
+        end
+        raise ApiError.new(msg, status: response.status)
+      end
+      return JSON.parse(response.body)
+    end
+  end
+
+  def request_json_with_cache(meth, url)
+    cache_key = "weathercom:#{meth}:#{url}"
+    if @cache && (data = @cache.get(cache_key))
+      if data.key?('metadata') && data['metadata'].key?('expire_time_gmt') &&
+        data['metadata']['expire_time_gmt'] > Time.now.to_i
+      then
+        return data
+      end
+      @cache.set(cache_key, nil)
+    end
+
+    request_json(meth, url).tap do |data|
+      if @cache
+        @cache.set(cache_key, data)
+      end
+    end
+  end
+
+  # endpoints
+
+  def geocode(query, ttl: nil)
+    if @cache && ttl
+      cache_key = "weathercom:geocode:#{query}"
+      result = @cache.get(cache_key)
+      if result && result['expires_at'] && result['expires_at'] > Time.now.to_i
+        return GeocodedLocation.new(result['location'], self)
+      end
+    end
+
+    payload = raw_geocode(query)
+
+    if @cache && ttl
+      @cache.set(cache_key, 'expires_at' => Time.now.to_i + ttl, 'location' => payload)
+    end
+
+    GeocodedLocation.new(payload, self)
+  end
+
+  def location(lat, lng)
+    Location.new(lat, lng, self)
+  end
+
+  private
+
+  API_KEY_URL = "https://www.wunderground.com/weather/us/ny/new-york"
+
+  def scrape_api_key
+    resp = connection.get(API_KEY_URL)
+    if resp.status != 200
+      raise ApiKeyScrapeError, "Non-200 status while scraping API key: #{resp.status}"
+    end
+
+    unless resp.body =~ /apiKey=([a-zA-Z0-9]{10,})/
+      raise ApiKeyScrapeError, "Could not locate API key in response"
+    end
+
+    $1
+  end
+
+  def raw_geocode(query)
+    url = "/v3/location/search?language=EN&query=#{URI.encode(query)}&format=json"
+    payload = get_json(url)
+    payload = Hash[payload['location'].map do |key, values|
+      [key, values.first]
+    end]
+  end
+end
+
+end

data/lib/weathercom/daily_forecast.rb

@@ -0,0 +1,45 @@
+module Weathercom
+
+class DailyForecast
+  include ForecastMethods
+
+  def initialize(info, metadata)
+    @info = info.dup.freeze
+    @metadata = metadata
+  end
+
+  attr_reader :metadata
+
+  %w(expire_time_gmt fcst_valid fcst_valid_local
+    num dow night
+    max_temp min_temp
+    torcon stormcon
+    blurb blurb_author narrative
+    qualifier_code qualifier
+    qpf snow_qpf snow_range snow_phrase snow_code
+    lunar_phase_day lunar_phase_code sunrise sunset moonrise moonset
+  ).each do |m|
+    define_method(m) do
+      @info[m]
+    end
+  end
+
+  alias :start_timestamp :fcst_valid
+  alias :expire_timestamp :expire_time_gmt
+
+  def day_forecast
+    @day_forecast ||= if @info.key?('day')
+      DayPartForecast.new(@info['day'])
+    else
+      nil
+    end
+  end
+
+  def night_forecast
+    @night_forecast ||= DayPartForecast.new(@info['night'])
+  end
+
+
+end
+
+end

data/lib/weathercom/day_part_forecast.rb

@@ -0,0 +1,45 @@
+module Weathercom
+
+class DayPartForecast
+
+  def initialize(info)
+    @info = info.dup.freeze
+  end
+
+  %w(
+    fcst_valid fcst_valid_local
+    day_ind thunder_enum
+    daypart_name long_daypart_name alt_daypart_name
+    thunder_enum_phrase
+    num temp hi wc rh icon_extd icon_code wxman
+    phrase_12char phrase_22char phrase_32char
+    subphrase_pt1 subphrase_pt2 subphrase_pt3
+    pop precip_type
+    wspd wdir wdir_cardinal
+    clds
+    pop_phrase temp_phrase accumulation_phrase wind_phrase
+    shortcast narrative
+    qpf snow_qpf
+    snow_range snow_phrase snow_code
+    vocal_key qualifier_code qualifier
+    uv_index_raw uv_index uv_warning uv_desc
+    golf_index golf_category
+  ).each do |m|
+    define_method(m) do
+      @info[m]
+    end
+  end
+
+  alias :start_timestamp :fcst_valid
+  alias :precip_probability :pop
+  alias :phrase :phrase_32char
+
+  # Narrative without the temperature and wind speed, which is available
+  # via other attributes
+  def cut_narrative
+    narrative.sub(/\..*/, '')
+  end
+
+end
+
+end

data/lib/weathercom/forecast_methods.rb

@@ -0,0 +1,15 @@
+module Weathercom
+
+module ForecastMethods
+
+  def wc_class
+    @info['class']
+  end
+
+  def expires_at
+    @expires_at ||= Time.at(expire_time_gmt)
+  end
+
+end
+
+end

data/lib/weathercom/geocoded_location.rb

@@ -0,0 +1,25 @@
+module Weathercom
+
+class GeocodedLocation < Location
+  def initialize(info, client)
+    info = info.dup
+    super(info.delete('latitude'), info.delete('longitude'), client)
+    @info = info.freeze
+  end
+
+  %w(address admin_district admin_district_code city country country_code
+    display_name iana_time_zone locale neighborhood place_id postal_code
+    postal_key disputed_area loc_id location_category pws_id type
+  ).each do |m|
+    key = m.gsub(/_(\w)/) { |match| $1.upcase }
+    define_method(m) do
+      @info[key]
+    end
+  end
+
+  alias :state_name :admin_district
+  alias :state_abbr :admin_district_code
+  alias :zipcode :postal_code
+end
+
+end

data/lib/weathercom/hourly_forecast.rb

@@ -0,0 +1,36 @@
+module Weathercom
+
+class HourlyForecast
+  include ForecastMethods
+
+  def initialize(info, metadata)
+    @info = info.dup.freeze
+    @metadata = metadata
+  end
+
+  attr_reader :metadata
+
+  %w(
+    expire_time_gmt fcst_valid fcst_valid_local
+    num day_ind dow
+    temp feels_like dewpt pop precip_type severity
+    hi wc qpf snow_qpf rh wspd wdir wdir_cardinal gust clds vis mslp
+    uv_index_raw uv_index uv_warning uv_desc golf_index golf_category
+    icon_extd wxman icon_code
+    phrase_12char phrase_22char phrase_32char
+    subphrase_pt1 subphrase_pt2 subphrase_pt3
+  ).each do |m|
+    define_method(m) do
+      @info[m]
+    end
+  end
+
+  alias :start_timestamp :fcst_valid
+  alias :expire_timestamp :expire_time_gmt
+
+  alias :precip_probability :pop
+  alias :phrase :phrase_32char
+
+end
+
+end

data/lib/weathercom/location.rb

@@ -0,0 +1,59 @@
+module Weathercom
+
+class Location
+  def initialize(lat, lng, client)
+    @lat, @lng, @client = lat, lng, client
+  end
+
+  attr_reader :lat
+  attr_reader :lng
+  attr_reader :client
+
+  def current_observation
+    payload = client.get_json_with_cache("#{url_prefix}/observations/current.json")
+    Observation.new(payload['observation'], Metadata.new(payload['metadata']))
+  end
+
+  def daily_forecasts_5
+    payload = client.get_json_with_cache("#{url_prefix}/forecast/daily/5day.json?#{query}")
+    payload['forecasts'].map do |info|
+      DailyForecast.new(info, Metadata.new(payload['metadata']))
+    end
+  end
+
+  def daily_forecasts_10
+    payload = client.get_json_with_cache("#{url_prefix}/forecast/daily/10day.json?#{query}")
+    payload['forecasts'].map do |info|
+      DailyForecast.new(info, Metadata.new(payload['metadata']))
+    end
+  end
+
+  alias :daily_forecasts :daily_forecasts_10
+
+  def hourly_forecasts_240
+    payload = client.get_json_with_cache("#{url_prefix}/forecast/hourly/240hour.json?#{query}")
+    payload['forecasts'].map do |info|
+      HourlyForecast.new(info, Metadata.new(payload['metadata']))
+    end
+  end
+
+  alias :hourly_forecasts :hourly_forecasts_240
+
+  # When Will It Rain Forecast
+  def wwir_forecast
+    payload = client.get_json_with_cache("#{url_prefix}/forecast/wwir.json?#{query}")
+    WwirForecast.new(payload['forecast'], Metadata.new(payload['metadata']))
+  end
+
+  private
+
+  def url_prefix
+    "/v1/geocode/#{URI.encode(lat.to_s)}/#{URI.encode(lng.to_s)}"
+  end
+
+  def query
+    "units=e"
+  end
+end
+
+end

data/lib/weathercom/metadata.rb

@@ -0,0 +1,26 @@
+module Weathercom
+
+class Metadata
+
+  def initialize(info)
+    @info = info.dup.freeze
+  end
+
+  %w(
+    language transaction_id version latitude longitude expire_time_gmt status_code
+  ).each do |m|
+    define_method(m) do
+      @info[m]
+    end
+  end
+
+  alias :lat :latitude
+  alias :lng :longitude
+
+  def expires_at
+    @expires_at ||= Time.at(expire_time_gmt)
+  end
+
+end
+
+end

data/lib/weathercom/observation.rb

@@ -0,0 +1,55 @@
+module Weathercom
+
+class Observation
+  include ForecastMethods
+
+  def initialize(info, metadata)
+    @info = info.dup.freeze
+    @metadata = metadata
+  end
+
+  attr_reader :metadata
+
+  %w(
+    expire_time_gmt obs_time obs_time_local
+    day_ind dow
+    obs_qualifier_code obs_qualifier_severity
+    ptend_code ptend_desc sky_cover clds
+    wdir wdir_cardinal
+    icon_code icon_extd wxman
+    sunrise sunset
+    uv_index uv_warning uv_desc
+    phrase_12char phrase_22char phrase_32char
+    vocal_key imperial
+  ).each do |m|
+    define_method(m) do
+      @info[m]
+    end
+  end
+
+  def sunrise_at
+    Time.parse(sunrise)
+  end
+
+  def sunset_at
+    Time.parse(sunset)
+  end
+
+  def day?
+    day_ind == 'Y'
+  end
+
+  %w(wspd gust vis mslp altimeter temp dewpt rh wc hi temp_change_24hour
+    temp_max_24hour temp_min_24hour pchange feels_like snow_1hour snow_6hour
+    snow_24hour snow_7day ceiling precip_1hour precip_6hour precip_24hour
+    precip_mtd precip_ytd precip_2day precip_3day precip_7day obs_qualifier_100char
+    obs_qualifier_50char obs_qualifier_32char
+  ).each do |m|
+    define_method(m) do
+      @info['imperial'][m]
+    end
+  end
+
+end
+
+end

data/lib/weathercom/wwir_forecast.rb

@@ -0,0 +1,25 @@
+module Weathercom
+
+class WwirForecast
+  include ForecastMethods
+
+  def initialize(info, metadata)
+    @info = info.dup.freeze
+    @metadata = metadata
+  end
+
+  attr_reader :metadata
+
+  %w(
+    expire_time_gmt fcst_valid fcst_valid_local
+    overall_type phrase terse_phrase phrase_template terse_phrase_template
+    precip_day precip_time_24hr precip_time_12hr precip_time_iso time_zone_abbrv
+  ).each do |m|
+    define_method(m) do
+      @info[m]
+    end
+  end
+
+end
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: weathercom
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oleg Pudeyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies: []
+description: Weather.com API client
+email: oleg@olegp.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/weathercom.rb
+- lib/weathercom/client.rb
+- lib/weathercom/daily_forecast.rb
+- lib/weathercom/day_part_forecast.rb
+- lib/weathercom/forecast_methods.rb
+- lib/weathercom/geocoded_location.rb
+- lib/weathercom/hourly_forecast.rb
+- lib/weathercom/location.rb
+- lib/weathercom/metadata.rb
+- lib/weathercom/observation.rb
+- lib/weathercom/wwir_forecast.rb
+homepage: https://github.com/p/weathercom
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Weather.com API client
+test_files: []