weatheruby 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0283bd7d80946986810371b2c1741cf1b3f1aae
-  data.tar.gz: f585d3e0608e1570ccb6a6a860dd28bc743bf3bd
+  metadata.gz: 4df1b7c19c8e24f493a06d5e6d2e1a9e171d367f
+  data.tar.gz: b2bd0127cdbba81ef3fecf12948eafa3b598229d
 SHA512:
-  metadata.gz: 58e8d51797597fed248965638dabae7ca2c7fadbab3b9165bc32fb640b4ecda62d03acfd791ed8a7be45f1ce744e1358fb1c4d52483921e80a95a6e5ae2131e0
-  data.tar.gz: bf73efcea967133048b018e1210592030144c4db4033ff4a5d02869410a4ff63959fa05dd34fb53e7adc586d412983388d7ccc3ec5eb908fa082fbe1558b61fb
+  metadata.gz: 0864852867eed9f0f47ba5b67324e47fc725fef086d99e3ccc2b87369bd68d7bc3c992e4a2767a875ed21d5af2009f27b63a83583c10b283e41e608090a82f13
+  data.tar.gz: e4d13673968de97a6ce69e2c4b72659b000513fa7de5f0aee4f898ee4190484cfc46002b999674c2ce97375516a035594d2ba0ed471cd39a07d7bee79720722b

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 ## Version 0
+### Version 0.5.0
+* Add support for all Weather Underground Planner APIs.
+
 ### Version 0.4.2
 * No longer fails with an ArgumentError if the CLI is passed no arguments. Instead it outputs the usage information, so that it is actually a useful thing.
 

data/bin/weatheruby

@@ -8,6 +8,12 @@ require 'rainbow'
 require 'string-utility'
 require_relative '../lib/weatheruby'
 
+# Planner not supported here because it will eventually get its own CLI. That
+# would be way too many API calls for a single app, when most of the info
+# provided by the Planner would not even be useful.
+# TODO Write the Planner CLI: weatheruby_planner or something.
+
+
 @args = {
   help: false,
   verbose: false,

data/lib/weather/planner.rb

@@ -0,0 +1,250 @@
+module Weather
+  module Planner
+    # Gets the chance of snow within the date range.
+    # @see #get_planner_response
+    def chance_of_snow(start_date, end_date, location)
+      get_chance_of('chanceofsnowday', start_date, end_date, location)
+    end
+
+    # Gets the chance of hail within the date range.
+    # @see #get_planner_response
+    def chance_of_hail(start_date, end_date, location)
+      get_chance_of('chanceofhailday', start_date, end_date, location)
+    end
+
+    # Gets the chance of temperatures above 0 C/32 F within the date range.
+    # @see #get_planner_response
+    def chance_of_not_freezing(start_date, end_date, location)
+      get_chance_of('tempoverfreezing', start_date, end_date, location)
+    end
+
+    # Gets the chance of temperatures below 0 C/32 F within the date range.
+    # @see #get_planner_response
+    def chance_of_freezing(start_date, end_date, location)
+      get_chance_of('tempbelowfreezing', start_date, end_date, location)
+    end
+
+    # Gets chance of sultry within the date range.
+    # @see #get_planner_response
+    def chance_of_sultry(start_date, end_date, location)
+      get_chance_of('chanceofsultryday', start_date, end_date, location)
+    end
+
+    # Gets the chance of a tornado within the date range.
+    # @see #get_planner_response
+    def chance_of_tornado(start_date, end_date, location)
+      get_chance_of('chanceoftornadoday', start_date, end_date, location)
+    end
+
+    # Gets the chance of snow on the ground within the date range.
+    # @see #get_planner_response
+    def chance_of_groundsnow(start_date, end_date, location)
+      get_chance_of('chanceofsnowonground', start_date, end_date, location)
+    end
+
+    # Gets the chance of thunderstorms within the date range.
+    # @see #get_planner_response
+    def chance_of_thunderstorms(start_date, end_date, location)
+      get_chance_of('chanceofthunderday', start_date, end_date, location)
+    end
+
+    # Gets the chance of temperatures above 32.2 C/90 F within the date range.
+    # @see #get_planner_response
+    def chance_of_heat(start_date, end_date, location)
+      get_chance_of('tempoverninety', start_date, end_date, location)
+    end
+
+    # Gets the chance of rain within the date range.
+    # @see #get_planner_response
+    def chance_of_rain(start_date, end_date, location)
+      get_chance_of('chanceofrainday', start_date, end_date, location)
+    end
+
+    # Gets the chance of precipitation within the date range.
+    # @see #get_planner_response
+    def chance_of_precipitation(start_date, end_date, location)
+      get_chance_of('chanceofprecip', start_date, end_date, location)
+    end
+
+    # Gets the chance of humidity within the date range.
+    # @see #get_planner_response
+    def chance_of_humid(start_date, end_date, location)
+      get_chance_of('chanceofhumidday', start_date, end_date, location)
+    end
+
+    # Gets the chance of fog within the date range.
+    # @see #get_planner_response
+    def chance_of_fog(start_date, end_date, location)
+      get_chance_of('chanceoffogday', start_date, end_date, location)
+    end
+
+    # Gets the chance of cloudy conditions within the date range.
+    # @see #get_planner_response
+    def chance_of_cloudy(start_date, end_date, location)
+      get_chance_of('chanceofcloudyday', start_date, end_date, location)
+    end
+
+    # Gets the chance of sunshine within the date range.
+    # @see #get_planner_response
+    def chance_of_sunny(start_date, end_date, location)
+      get_chance_of('chanceofsunnycloudyday', start_date, end_date, location)
+    end
+
+    # Gets the chance of partially cloudy conditions within the date range.
+    # @see #get_planner_response
+    def chance_of_partlycloudy(start_date, end_date, location)
+      get_chance_of('chanceofpartlycloudyday', start_date, end_date, location)
+    end
+
+    # Gets the chance of high winds within the date range.
+    # @see #get_planner_response
+    def chance_of_high_wind(start_date, end_date, location)
+      get_chance_of('chanceofwindyday', start_date, end_date, location)
+    end
+
+    # Gets the chance of a temperature of 15.5 C/60 F within the date range.
+    # @see #get_planner_response
+    def chance_of_warmth(start_date, end_date, location)
+      get_chance_of('tempoversixty', start_date, end_date, location)
+    end
+
+    # Gets the dewpoint highs and lows for the date range.
+    # @see #get_planner_response
+    # @return [Hash] Highs and lows minimum, average, and maximum for both
+    #   metric and imperial systems.
+    # @return [String] The error if possible.
+    def get_dewpoints(start_date, end_date, location)
+      response = get_planner_response(start_date, end_date, location)
+      return response['response']['error'] unless
+      response['response']['error'].nil?
+      highs = response['trip']['dewpoint_high']
+      lows = response['trip']['dewpoint_low']
+
+      {
+        high: {
+          imperial: {
+            minimum: highs['min']['F'].to_i,
+            maximum: highs['max']['F'].to_i,
+            average: highs['avg']['F'].to_i
+          },
+          metric: {
+            minimum: highs['min']['C'].to_i,
+            maximum: highs['max']['C'].to_i,
+            average: highs['avg']['C'].to_i
+          }
+        },
+        low: {
+          imperial: {
+            minimum: lows['min']['F'].to_i,
+            maximum: lows['max']['F'].to_i,
+            average: lows['avg']['F'].to_i
+          },
+          metric: {
+            minimum: lows['min']['C'].to_i,
+            maximum: lows['max']['C'].to_i,
+            average: lows['avg']['C'].to_i
+          }
+        }
+      }
+    end
+
+    # Gets the precipitation amounts (not chance) for the date range.
+    # @see #get_planner_response
+    # @return [Hash] Minimum, maximum, and average precipitation quantities for
+    #   the location in both inches and centimeters.
+    # @return [String] The error if possible.
+    def get_precipitation(start_date, end_date, location)
+      response = get_planner_response(start_date, end_date, location)
+      return response['response']['error'] unless
+        response['response']['error'].nil?
+      min = response['trip']['precip']['min']
+      avg = response['trip']['precip']['avg']
+      max = response['trip']['precip']['max']
+
+      {
+        minimum: {
+          inch: min['in'].to_i,
+          centimeter: min['cm'].to_i
+        },
+        maximum: {
+          inch: max['in'].to_i,
+          centimeter: max['cm'].to_i
+        },
+        average: {
+          inch: avg['in'].to_i,
+          centimeter: avg['cm'].to_i
+        }
+      }
+    end
+
+    # Gets the highs and lows for the date range.
+    # @see #get_planner_response
+    # @return [Hash] Highs and lows minimum, average, and maximum for both
+    #   metric and imperial systems.
+    def get_temperatures(start_date, end_date, location)
+      response = get_planner_response(start_date, end_date, location)
+      return response['response']['error'] unless
+        response['response']['error'].nil?
+      highs = response['trip']['temp_high']
+      lows = response['trip']['temp_low']
+
+      {
+        high: {
+          imperial: {
+            minimum: highs['min']['F'].to_i,
+            maximum: highs['max']['F'].to_i,
+            average: highs['avg']['F'].to_i
+          },
+          metric: {
+            minimum: highs['min']['C'].to_i,
+            maximum: highs['max']['C'].to_i,
+            average: highs['avg']['C'].to_i
+          }
+        },
+        low: {
+          imperial: {
+            minimum: lows['min']['F'].to_i,
+            maximum: lows['max']['F'].to_i,
+            average: lows['avg']['F'].to_i
+          },
+          metric: {
+            minimum: lows['min']['C'].to_i,
+            maximum: lows['max']['C'].to_i,
+            average: lows['avg']['C'].to_i
+          }
+        }
+      }
+    end
+
+    private
+
+    # Gets the full planner API response.
+    # @param start_date [DateTime] The date to start at. Only month and day
+    # actually matter.
+    # @param end_date [DateTime] The date to end at. Only month and day actually
+    # matter.
+    # @param location [String] The location to get the planner data for.
+    # @since 0.5.0
+    # @return [Hash] (see {Weatheruby#get #get})
+    def get_planner_response(start_date, end_date, location)
+      start = start_date.strftime('%m%d')
+      final = end_date.strftime('%m%d')
+      get("planner_#{start}#{final}", location)
+    end
+
+    # Gets the chance of any given string key in the chance_of hash returned by
+    # get_planner_response.
+    # @param subject [String] The chance_of hash's key.
+    # @param start_date [DateTime] (see {#get_planner_response})
+    # @param end_date [DateTime] (see {#get_planner_response})
+    # @param location [String] (see {#get_planner_response})
+    # @since 0.5.0
+    # @return [Fixnum] The chance of the subject happening.
+    def get_chance_of(subject, start_date, end_date, location)
+      response = get_planner_response(start_date, end_date, location)
+      return unless response['response']['error'].nil?
+
+      response['trip']['chance_of'][subject]['percentage'].to_i
+    end
+  end
+end

data/lib/weatheruby.rb

@@ -1,10 +1,12 @@
 require 'httpclient'
 require 'json'
 require_relative 'weather/actions'
+require_relative 'weather/planner'
 require_relative 'weather/exceptions'
 
 class Weatheruby
   include Weather::Actions
+  include Weather::Planner
 
   # Creates a new instance of Weatheruby.
   # @param api_key [String] Your personal API key obtained on sign up for

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weatheruby
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -63,6 +63,7 @@ files:
 - bin/weatheruby
 - lib/weather/actions.rb
 - lib/weather/exceptions.rb
+- lib/weather/planner.rb
 - lib/weatheruby.rb
 homepage: https://github.com/elifoster/weatheruby
 licenses: