weatheruby 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec55f6012d626daf9b8c87842dcfbec4b7849be4
-  data.tar.gz: b297fd400ecc7360f5251603e37ab15b0ea81bab
+  metadata.gz: 026ed072be84b5a96eb75c83db822615c325cd08
+  data.tar.gz: 5e4f4279b2b2504db4c55967ac5dcbe94efadcaf
 SHA512:
-  metadata.gz: a552b0e80f9a8f30a803cd48946ee5f14e30de402dd780f12e67c29926cfdcb1c603f0284792608c1f788a958adb0d1f611a2e679ad6fafddb3e3f142bf778fe
-  data.tar.gz: 525bd9d12e22a924839e19fc10e885475521189513c169274dcabc9b2067db0f9b4e53506a1351e126836aed099c9a6545af159eafd25e37a31d640e484a09c7
+  metadata.gz: 4d0a962683862297071511012d7f8ecffb74aabdf47b84d8797241986aaa84d04ae9f2f0ef0d421397efcd7b90c740115fe6c8a65d4a268ae7baf11be43b96ed
+  data.tar.gz: 2c6f8f5202a725bf698c0eb02bff7ccf71bb94cd77088cc53131773d6f9b413f77d2ad2303630987483e9c2460b50595b9041ad661ed0bc258f99ce9a680a9c6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 ## Version 0
+### Version 0.6.0
+* Error handling is much more generic now, with a single WeatherError which gets its message from the Weather 
+Underground API. With this is also the removal of the `verbose` option. Lastly, no method will return an error 
+silently, but actually `fail` with the WeatherError.
+* `language_key` is now an attribute accessor.
+
 ### Version 0.5.3
 * Update to HTTPClient 2.8
 * Use pessimistic version requirements, and actually add version requirements for Rainbow and StringUtility.

data/LICENSE.md

@@ -0,0 +1,25 @@
+# The MIT License (MIT)
+
+Copyright © 2016 Eli Foster
+
+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/bin/weatheruby

@@ -16,7 +16,6 @@ require_relative '../lib/weatheruby'
 
 @args = {
   help: false,
-  verbose: false,
   token: nil,
   location: nil,
   language: 'EN'
@@ -24,7 +23,6 @@ require_relative '../lib/weatheruby'
 
 usage = 'Usage: weatheruby [t] token [-l] [-j] languagecode [-v] [-h]'
 help = "-h, --help       Show helpful information about Weatheruby usage\n" \
-       "-v, --verbose    Output verbose errors\n" \
        "-t, --token      The token to log in as\n" \
        "-l, --location   The location to get weather data for\n" \
        '-j, --language   The language code to use'
@@ -34,7 +32,6 @@ ARGV.each do |arg|
   when '-t', '--token' then @args[:token] = ARGV.at(ARGV.index(arg) + 1)
   when '-h', '--help' then @args[:help] = true
   when '-l', '--location' then @args[:location] = ARGV.at(ARGV.index(arg) + 1)
-  when '-v', '--verbose' then @args[:verbose] = true
   when '-j', '--language' then @args[:language] = ARGV.at(ARGV.index(arg) + 1)
   end
 end
@@ -55,11 +52,7 @@ if @args[:token].nil? || @args[:location].nil?
   exit
 end
 
-client = Weatheruby.new(@args[:token],
-                        @args[:language],
-                        true,
-                        true,
-                        @args[:verbose])
+client = Weatheruby.new(@args[:token], @args[:language], true, true)
 
 conditions = client.conditions(@args[:location])
 moon = client.moon_phase(@args[:location])

data/lib/weather/actions.rb

@@ -7,28 +7,20 @@ module Weather
     #   information for a different alert.
     def alerts(location)
       response = get('alerts', location)
-      if response['response']['error'].nil?
-        ret = []
-        count = 0
-        response['alerts'].each do |a|
-          ret[count] = {
-            type: a['type'],
-            description: a['description'],
-            date: a['date'],
-            expires: a['expires'],
-            message: a['message']
-          }
-          count += 1
-        end
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
+      ret = []
+      count = 0
+      response['alerts'].each do |a|
+        ret[count] = {
+          type: a['type'],
+          description: a['description'],
+          date: a['date'],
+          expires: a['expires'],
+          message: a['message']
+        }
+        count += 1
       end
+
+      ret
     end
 
     # Gets the current moon phase of the location.
@@ -36,22 +28,13 @@ module Weather
     # @return [Hash/String] A hash of two integers for the moon phase
     #   information. The age key in the hash contains the moon's age in days,
     #   and the illumination key contains the percentage of how illuminated it
-    #   is. Returns the error type if verbose_errors is off, else the desc.
+    #   is.
     def moon_phase(location)
       response = get('astronomy', location)
-      if response['response']['error'].nil?
-        ret = {}
-        ret[:age] = response['moon_phase']['ageOfMoon'].to_i
-        ret[:illumination] = response['moon_phase']['percentIlluminated'].to_i
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
-      end
+      {
+        age: response['moon_phase']['ageOfMoon'].to_i,
+        illumination: response['moon_phase']['percentIlluminated'].to_i
+      }
     end
 
     # Gets weather conditions for the location.
@@ -59,43 +42,35 @@ module Weather
     # @return [Hash] A hash containing strings of relevant weather information.
     def conditions(location)
       response = get('conditions', location)
-      if response['response']['error'].nil?
-        current_observation = response['current_observation']
-        display_location = current_observation['display_location']
-
-        ret = {
-          full_name: display_location['full'],
-          city_name: display_location['city'],
-          state_abbreviation: display_location['state'],
-          state_name: display_location['state_name'],
-          country: display_location['country'],
-          zip_code: display_location['zip'].to_i,
-          updated: current_observation['observation_time'],
-          weather: current_observation['weather'],
-          formatted_temperature: current_observation['temperature_string'],
-          temperature_f: current_observation['temp_f'],
-          temperature_c: current_observation['temp_c'],
-          humidity: current_observation['relative_humidity'],
-          formatted_wind: current_observation['wind_string'],
-          wind_direction: current_observation['wind_dir'],
-          wind_degrees: current_observation['wind_degrees'],
-          wind_speed: current_observation['wind_mph'],
-          wind_gust_speed: current_observation['wind_gust_mph'].to_i,
-          formatted_feelslike: current_observation['feelslike_string'],
-          feelslike_f: current_observation['feelslike_f'].to_i,
-          feelslike_c: current_observation['feelslike_c'].to_i
-        }
-
-        ret[:humidity] = ret[:humidity].sub('%', '').to_i
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
-      end
+      current_observation = response['current_observation']
+      display_location = current_observation['display_location']
+
+      ret = {
+        full_name: display_location['full'],
+        city_name: display_location['city'],
+        state_abbreviation: display_location['state'],
+        state_name: display_location['state_name'],
+        country: display_location['country'],
+        zip_code: display_location['zip'].to_i,
+        updated: current_observation['observation_time'],
+        weather: current_observation['weather'],
+        formatted_temperature: current_observation['temperature_string'],
+        temperature_f: current_observation['temp_f'],
+        temperature_c: current_observation['temp_c'],
+        humidity: current_observation['relative_humidity'],
+        formatted_wind: current_observation['wind_string'],
+        wind_direction: current_observation['wind_dir'],
+        wind_degrees: current_observation['wind_degrees'],
+        wind_speed: current_observation['wind_mph'],
+        wind_gust_speed: current_observation['wind_gust_mph'].to_i,
+        formatted_feelslike: current_observation['feelslike_string'],
+        feelslike_f: current_observation['feelslike_f'].to_i,
+        feelslike_c: current_observation['feelslike_c'].to_i
+      }
+
+      ret[:humidity] = ret[:humidity].sub('%', '').to_i
+
+      ret
     end
 
     # Gets the record low for the location.
@@ -103,24 +78,13 @@ module Weather
     # @return [Hash] A hash containing a few integers of data.
     def record_low(location)
       response = get('almanac', location)
-
-      if response['response']['error'].nil?
-        ret = {
-          average_low_f: response['almanac']['temp_low']['normal']['F'].to_i,
-          average_low_c: response['almanac']['temp_low']['normal']['C'].to_i,
-          record_year: response['almanac']['temp_low']['recordyear'].to_i,
-          record_low_f: response['almanac']['temp_low']['record']['F'].to_i,
-          record_low_c: response['almanac']['temp_low']['record']['C'].to_i
-        }
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
-      end
+      {
+        average_low_f: response['almanac']['temp_low']['normal']['F'].to_i,
+        average_low_c: response['almanac']['temp_low']['normal']['C'].to_i,
+        record_year: response['almanac']['temp_low']['recordyear'].to_i,
+        record_low_f: response['almanac']['temp_low']['record']['F'].to_i,
+        record_low_c: response['almanac']['temp_low']['record']['C'].to_i
+      }
     end
 
     # Gets the record high for the location.
@@ -128,24 +92,13 @@ module Weather
     # @return [Hash] A hash containing a few integers of data.
     def record_high(location)
       response = get('almanac', location)
-
-      if response['response']['error'].nil?
-        ret = {
-          average_high_f: response['almanac']['temp_high']['normal']['F'].to_i,
-          average_high_c: response['almanac']['temp_high']['normal']['C'].to_i,
-          record_year: response['almanac']['temp_high']['recordyear'].to_i,
-          record_high_f: response['almanac']['temp_high']['record']['F'].to_i,
-          record_high_c: response['almanac']['temp_high']['record']['C'].to_i
-        }
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
-      end
+      {
+        average_high_f: response['almanac']['temp_high']['normal']['F'].to_i,
+        average_high_c: response['almanac']['temp_high']['normal']['C'].to_i,
+        record_year: response['almanac']['temp_high']['recordyear'].to_i,
+        record_high_f: response['almanac']['temp_high']['record']['F'].to_i,
+        record_high_c: response['almanac']['temp_high']['record']['C'].to_i
+      }
     end
 
     # Gets data for currently-happening hurricanes around the world.
@@ -154,31 +107,23 @@ module Weather
     def hurricane_data
       response = get('currenthurricane', 'view')
 
-      if response['response']['error'].nil?
-        ret = {}
-        response['currenthurricane'].each do |h|
-          ret[h['stormInfo']['stormName_Nice']] = {
-            name: h['stormInfo']['stormName'],
-            number: h['stormInfo']['stormNumber'],
-            category: h['Current']['Category'],
-            time: h['Current']['Time']['pretty'],
-            wind_speed_mph: h['Current']['WindSpeed']['Mph'],
-            wind_speed_kts: h['Current']['WindSpeed']['Kts'],
-            wind_speed_kph: h['Current']['WindSpeed']['Kph'],
-            gust_speed_mph: h['Current']['WindGust']['Mph'],
-            gust_speed_kts: h['Current']['WindGust']['Kts'],
-            gust_speed_kph: h['Current']['WindGust']['Kph']
-          }
-        end
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
+      ret = {}
+      response['currenthurricane'].each do |h|
+        ret[h['stormInfo']['stormName_Nice']] = {
+          name: h['stormInfo']['stormName'],
+          number: h['stormInfo']['stormNumber'],
+          category: h['Current']['Category'],
+          time: h['Current']['Time']['pretty'],
+          wind_speed_mph: h['Current']['WindSpeed']['Mph'],
+          wind_speed_kts: h['Current']['WindSpeed']['Kts'],
+          wind_speed_kph: h['Current']['WindSpeed']['Kph'],
+          gust_speed_mph: h['Current']['WindGust']['Mph'],
+          gust_speed_kts: h['Current']['WindGust']['Kts'],
+          gust_speed_kph: h['Current']['WindGust']['Kph']
+        }
       end
+
+      ret
     end
 
     # Gets the basic forecast information for the location. Only gets data
@@ -228,76 +173,60 @@ module Weather
 
     # Parses the simple forecast information.
     def parse_simple_forecast(response)
-      if response['response']['error'].nil?
-        ret = {}
+      ret = {}
 
-        response['forecast']['txt_forecast']['forecastday'].each do |f|
-          ret[f['period']] = {
-            weekday_name: f['title'],
-            text: f['fcttext'],
-            text_metric: f['fcttext_metric']
-          }
-        end
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
+      response['forecast']['txt_forecast']['forecastday'].each do |f|
+        ret[f['period']] = {
+          weekday_name: f['title'],
+          text: f['fcttext'],
+          text_metric: f['fcttext_metric']
+        }
       end
+
+      ret
     end
 
     # Parses the complex forecast information.
     def parse_complex_forecast(response)
-      if response['response']['error'].nil?
-        ret = {}
-
-        response['forecast']['simpleforecast']['forecastday'].each do |f|
-          ret[f['period'] - 1] = {
-            high_f: f['high']['fahrenheit'].to_i,
-            high_c: f['high']['celsius'].to_i,
-            low_f: f['low']['fahrenheit'].to_i,
-            low_c: f['low']['celsius'].to_i,
-            conditions: f['conditions'].to_i,
-            snow: {
-              snow_total_in: f['snow_allday']['in'],
-              snow_total_cm: f['snow_allday']['cm'],
-              snow_night_in: f['snow_night']['in'],
-              snow_night_cm: f['snow_night']['cm'],
-              snow_day_in: f['snow_day']['in'],
-              snow_day_cm: f['snow_day']['cm']
-            },
-            quantative_precipitation: {
-              qpf_total_in: f['qpf_allday']['in'],
-              qpf_total_cm: f['qpf_allday']['cm'],
-              qpf_night_in: f['qpf_night']['in'],
-              qpf_night_cm: f['qpf_night']['cm'],
-              qpf_day_in: f['qpf_day']['in'],
-              qpf_day_cm: f['qpf_day']['cm']
-            },
-            wind: {
-              average_mph: f['avewind']['mph'],
-              average_kph: f['avewind']['kph'],
-              average_dir: f['avewind']['dir'],
-              average_temp: f['avewind']['degrees'],
-              max_mph: f['maxwind']['mph'],
-              max_kph: f['maxwind']['kph'],
-              max_dir: f['maxwind']['dir'],
-              max_temp: f['maxwind']['degrees']
-            }
+      ret = {}
+
+      response['forecast']['simpleforecast']['forecastday'].each do |f|
+        ret[f['period'] - 1] = {
+          high_f: f['high']['fahrenheit'].to_i,
+          high_c: f['high']['celsius'].to_i,
+          low_f: f['low']['fahrenheit'].to_i,
+          low_c: f['low']['celsius'].to_i,
+          conditions: f['conditions'].to_i,
+          snow: {
+            snow_total_in: f['snow_allday']['in'],
+            snow_total_cm: f['snow_allday']['cm'],
+            snow_night_in: f['snow_night']['in'],
+            snow_night_cm: f['snow_night']['cm'],
+            snow_day_in: f['snow_day']['in'],
+            snow_day_cm: f['snow_day']['cm']
+          },
+          quantative_precipitation: {
+            qpf_total_in: f['qpf_allday']['in'],
+            qpf_total_cm: f['qpf_allday']['cm'],
+            qpf_night_in: f['qpf_night']['in'],
+            qpf_night_cm: f['qpf_night']['cm'],
+            qpf_day_in: f['qpf_day']['in'],
+            qpf_day_cm: f['qpf_day']['cm']
+          },
+          wind: {
+            average_mph: f['avewind']['mph'],
+            average_kph: f['avewind']['kph'],
+            average_dir: f['avewind']['dir'],
+            average_temp: f['avewind']['degrees'],
+            max_mph: f['maxwind']['mph'],
+            max_kph: f['maxwind']['kph'],
+            max_dir: f['maxwind']['dir'],
+            max_temp: f['maxwind']['degrees']
           }
-        end
-
-        ret
-      else
-        if @verbose_errors
-          return response['response']['error']['description']
-        else
-          return response['response']['error']['type']
-        end
+        }
       end
+
+      ret
     end
   end
 end

data/lib/weather/planner.rb

@@ -183,8 +183,6 @@ module Weather
     #   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']
 
@@ -242,7 +240,6 @@ module Weather
     # @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

data/lib/weatheruby.rb

@@ -2,38 +2,36 @@ require 'httpclient'
 require 'json'
 require_relative 'weather/actions'
 require_relative 'weather/planner'
-require_relative 'weather/exceptions'
 
 class Weatheruby
+  class WeatherError < StandardError; end
+
   include Weather::Actions
   include Weather::Planner
 
+  attr_accessor :language_key
+
   # Creates a new instance of Weatheruby.
-  # @param api_key [String] Your personal API key obtained on sign up for
-  #   Weather Underground.
+  # @param api_key [String] Your personal API key obtained on sign up for Weather Underground.
   # @param language [String] The language code you would like to use.
-  # @param use_pws [Boolean] Whether to use the Personal Weather Station
-  #   feature.
+  # @param use_pws [Boolean] Whether to use the Personal Weather Station feature.
   # @param use_bestfct [Boolean] Whether to use BestForecast.
-  # @param verbose_errors [Boolean] Whether to get verbose errors or not.
-  def initialize(api_key, language = 'EN', use_pws = true, use_bestfct = true,
-                 verbose_errors = false)
+  def initialize(api_key, language = 'EN', use_pws = true, use_bestfct = true)
     @api_key = api_key
     @language_key = language.upcase
     @use_pws = use_pws ? 1 : 0
     @use_bestfct = use_bestfct ? 1 : 0
-    @verbose_errors = verbose_errors
 
     @client = HTTPClient.new
   end
 
-  # Performs a generic HTTP GET request. This method should generally not be
-  #   used by a standard user, unless there is not a method for a particular
-  #   action/feature.
+  # Performs a generic HTTP GET request. This method should generally not be used by a standard user, unless there is
+  # not a method for a particular action/feature.
   # @param feature [String] The "feature" parameter defined by Wunderground.
   # @param location [String] The location of the query.
   # @param autoparse [Boolean] Whether to automatically parse the response.
-  # @return [JSON/HTTPMessage] Parsed JSON if true, or raw response if not.
+  # @return [Hash/HTTPMessage] Parsed JSON if autoparse is true, or raw response if not.
+  # @raise WeatherError if anything goes wrong with the API, or it returns too many results for us to handle.
   def get(feature, location, autoparse = true)
     url = "http://api.wunderground.com/api/#{@api_key}/#{feature}/lang:" \
           "#{@language_key}/pws:#{@use_pws}/bestfct:#{@use_bestfct}/q/" \
@@ -42,14 +40,14 @@ class Weatheruby
     uri = URI.parse(url)
     res = @client.get(uri)
     json = JSON.parse(res.body)
-    unless json['response']['results'].nil?
-      fail Weather::Exceptions::TooManyResultsError
+    if json['response'].key?('error')
+      fail(WeatherError, json['response']['error']['type'] + ': ' + json['response']['error']['description'].capitalize)
     end
-
-    if autoparse
-      return json
-    else
-      return res
+    if json['response'].key?('results')
+      fail(WeatherError, 'toomanyresults: Too many results were returned. Try narrowing your search.')
     end
+
+
+    autoparse ? json : res
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weatheruby
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -60,9 +60,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE.md
 - bin/weatheruby
 - lib/weather/actions.rb
-- lib/weather/exceptions.rb
 - lib/weather/planner.rb
 - lib/weatheruby.rb
 homepage: https://github.com/elifoster/weatheruby

data/lib/weather/exceptions.rb

@@ -1,10 +0,0 @@
-module Weather
-  module Exceptions
-    class TooManyResultsError < StandardError
-      def message
-        'There were too many locations given in the response. Please narrow ' \
-        'down your query.'
-      end
-    end
-  end
-end