weatheruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4bc5408dc72cef114956f54043208d345fe2c91
+  data.tar.gz: 48a16aefd779d173f68164dd9b342e746988e9a4
+SHA512:
+  metadata.gz: ee9e13401e525b4f375c1c720c502318aa46382b328f0b64729cef3a120542539212b43f47ffcee4a721d84defdfb7673642b24fcae206e1fa42dbbc8ad4ce32
+  data.tar.gz: bbe710d088da26c738f6cb2a38ac902899fdbf2c06a3ace9570fa4c4a1b8a6560671d13e5196184956d5b2877259562c463c90039e6f83befd205d5ac6ea2ff6

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+## Version 0
+### Version 0.1.0
+* Intial version. Includes #conditions, #moon_phase, and #alerts.

data/lib/weather/actions.rb

@@ -0,0 +1,81 @@
+module Weather
+  module Actions
+    # Gets alert information for a location.
+    # @param location [String] The place to get the alert data for.
+    # @return [Hash/Nil] Nil if there are no alerts, or a hash of arrays
+    #   containing relevant data if not. Each array in the hash contains
+    #   information for a different alert.
+    def alerts(location)
+      response = get('alerts', location)
+      if response['alerts'].nil?
+        return nil
+      else
+        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
+      end
+
+      ret
+    end
+
+    # Gets the current moon phase of the location.
+    # @param location [String] The place to get the phase for.
+    # @return [Hash] 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.
+    def moon_phase(location)
+      response = get('astronomy', location)
+      ret = {}
+      ret[:age] = response['moon_phase']['ageOfMoon'].to_i
+      ret[:illumination] = response['moon_phase']['percentIlluminated'].to_i
+
+      ret
+    end
+
+    # Gets weahter conditions for the location.
+    # @param location [String] The place to get the weather report for.
+    # @return [Hash] A hash containing strings of relevant weather information.
+    def conditions(location)
+      response = get('conditions', location)
+      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
+
+  end
+end

data/lib/weatheruby.rb

@@ -0,0 +1,45 @@
+require 'httpclient'
+require 'json'
+require_relative 'weather/actions'
+
+class Weatheruby
+  include Weather::Actions
+
+  # Creates a new instance of Weatheruby.
+  # @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_bestfct [Boolean] Whether to use BestForecast.
+  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
+
+    @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.
+  # @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.
+  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/" \
+          "#{location}.json"
+    url = URI.encode(url)
+    uri = URI.parse(url)
+    res = @client.get(uri)
+
+    if autoparse
+      return JSON.parse(res.body)
+    else
+      return res
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: weatheruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eli Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Accessing the Weather Underground API through HTTPClient.
+email: elifosterwy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- lib/weather/actions.rb
+- lib/weatheruby.rb
+homepage: https://github.com/elifoster/weatheruby
+licenses:
+- CC-BY-NC-ND-4.0
+metadata:
+  issue_tracker: https://github.com/elifoster/weatheruby/issues
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for accessing the Weather Underground API.
+test_files: []