yweather 0.0.1

data/README.md

@@ -0,0 +1,109 @@
+# Yweather
+
+## Overview
+
+This is a rewrite of Walter Korman's <shaper@fatgoose.com>
+[yahoo-weather](http://rubyforge.org/projects/yahoo-weather) gem.
+
+The aim of this port/rewrite is to add proper specs, better test-coverage and active
+maintenance. I have ported much of Walter's original intent and LICENSE, and thank him for
+his contribution.  My initial motivation is to send Prowl notifications to my iPad, iPhone,
+iPod whenever hazardous weather is coming.
+
+Yweather provides an object-oriented Ruby interface to the Yahoo! Weather XML RSS feed
+detailed at [http://developer.yahoo.com/weather](http://developer.yahoo.com/weather).
+
+People care a lot about the weather. This may seem ironic given they can just glance out
+the window. However, we can all understand a fascination with details and forecasting.
+
+Log the weather information to your database! Graph it to your heart's content! Write a
+widget that emails the weather to your cell phone every five minutes with a link to your
+friend's PayPal account to deposit money if the weather's sunny and you both bet that it
+would be rainy. And the fun doesn't have to stop there.
+
+Source code is at [http://github.com/midwire/yweather](http://github.com/midwire/yweather).
+
+NOTE: This library was updated as of December 2009 to use a new WOEID-based lookup
+interface. Yahoo has deprecated the older non-WOEID-based lookup API. The archived page
+with the deprecated API details is at:
+
+[http://developer.yahoo.com/weather/archive.html](http://developer.yahoo.com/weather/archive.html)
+
+## Installation
+
+    gem install yweather
+
+## Usage
+
+A simple example program:
+
+    #!/usr/bin/env ruby
+    require "yweather"
+    require "colorize"
+
+    zipcode = ARGV.shift
+    if zipcode.nil?
+      puts ">>> Usage: yweather zipcode"
+      exit
+    end
+
+    client = Yweather::Client.new
+    response = client.get_response_for_zipcode(zipcode)
+
+    # TODO: Use a ~/.yweather YAML file to determine format of output
+
+    print <<edoc
+    #{response.title.yellow}
+     #{response.condition.temp} degrees
+     #{response.condition.text}
+    edoc
+
+    puts "Wind:".yellow
+    response.wind_conditions.each_pair do |key, value|
+      puts " #{key}: #{value}"
+    end
+
+    puts "Atmosphere:".yellow
+    response.atmospheric_conditions.each_pair do |key, value|
+      puts " #{key}: #{value}"
+    end
+
+
+Produces output as:
+
+    Conditions for Beverly Hills, CA at 10:51 am PST
+     61 degrees
+     Fair
+    Wind:
+     chill: 61°
+     direction: 0°
+     speed: 0 mph
+    Atmosphere:
+     humidity: 23%
+     visibility: 10 mi
+     pressure: steady at 30.18in
+
+There is a variety of detailed weather information in other attributes of the Yweather::Response object.
+
+## License
+
+This library is provided via the GNU LGPL license at http://www.gnu.org/licenses/lgpl.html.
+
+## Author
+
+Copyright 2006 - 2009, Walter Korman <shaper@fatgoose.com>,
+http://lemurware.blogspot.com.
+
+Copyright 2012, Chris Blackburn <chris you-know-what-goes-here m and-here blackburn@gmail and-here com>,
+http://midwire.github.com
+
+Thanks to Walter Korman for the initial hack.
+
+## Notes
+
+Pull requests are appreciated.  Please use feature/branches or hotfix/branches and add specs for your changes.
+
+## ToDo
+
+* Use a ~/.yweather YAML file, or some other templating scheme, to determine format of output when running the binary.
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+spec_tasks = Dir['spec/*/'].map { |d| File.basename(d) }
+
+spec_tasks.each do |folder|
+  RSpec::Core::RakeTask.new("spec:#{folder}") do |t|
+    t.pattern = "./spec/#{folder}/**/*_spec.rb"
+    t.rspec_opts = %w(-fs --color)
+  end
+end
+
+desc "Run complete application spec suite"
+task 'spec' => spec_tasks.map { |f| "spec:#{f}" }

data/bin/yweather

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require "yweather"
+require "colorize"
+
+zipcode = ARGV.shift
+if zipcode.nil?
+  puts ">>> Usage: yweather zipcode"
+  exit
+end
+
+client = Yweather::Client.new
+response = client.get_response_for_zipcode(zipcode)
+
+# TODO: Use a ~/.yweather YAML file to determine format of output
+
+print <<edoc
+#{response.title.yellow}
+ #{response.condition.temp} degrees
+ #{response.condition.text}
+edoc
+
+puts "Wind:".yellow
+response.wind_conditions.each_pair do |key, value|
+  puts " #{key}: #{value}"
+end
+
+puts "Atmosphere:".yellow
+response.atmospheric_conditions.each_pair do |key, value|
+  puts " #{key}: #{value}"
+end

data/lib/yweather.rb

@@ -0,0 +1,22 @@
+require 'time'
+require 'cgi'
+require 'rest-client'
+require 'yql'
+require 'active_support/core_ext'
+require 'json'
+require "yweather/utils"
+require "yweather/version"
+require "yweather/client"
+require "yweather/response"
+require "yweather/astronomy"
+require "yweather/atmosphere"
+require "yweather/location"
+require "yweather/wind"
+require "yweather/units"
+require "yweather/image"
+require "yweather/condition"
+require "yweather/forecast"
+
+module Yweather
+  class YweatherException < RuntimeError; end
+end

data/lib/yweather/astronomy.rb

@@ -0,0 +1,12 @@
+module Yweather
+  class Astronomy
+    attr_reader :sunrise
+    attr_reader :sunset
+    
+    def initialize(data)
+      @sunrise = data[:sunrise]
+      @sunset = data[:sunset]
+    end
+    
+  end
+end

data/lib/yweather/atmosphere.rb

@@ -0,0 +1,34 @@
+module Yweather
+  class Atmosphere
+    
+    class Barometer
+      STEADY = 'steady'
+      RISING = 'rising'
+      FALLING = 'falling'
+
+      # lists all possible barometer constants
+      ALL = [ STEADY, RISING, FALLING ]
+    end
+    
+    attr_reader :humidity
+    attr_reader :visibility
+    attr_reader :pressure
+    attr_reader :barometer
+    
+    def initialize(data)
+      @humidity = data[:humidity].to_i
+      @visibility = data[:visibility].to_i
+      @pressure = data[:pressure].to_f
+      @barometer = nil
+      case data[:rising].to_i
+      when 0
+        @barometer = Barometer::STEADY
+      when 1
+        @barometer = Barometer::RISING
+      when 2
+        @barometer = Barometer::FALLING
+      end
+    end
+    
+  end
+end

data/lib/yweather/client.rb

@@ -0,0 +1,80 @@
+module Yweather
+  class Client
+    @@BASE_URL = "http://weather.yahooapis.com/forecastrss"
+    attr_reader :response
+
+    def initialize
+      @response = nil
+    end
+
+    def get_feed_for_zipcode(zipcode, options = {})
+      woeid = woeid_from_zipcode(zipcode)
+      get_feed_for_woeid(woeid, options)
+    end
+
+    def get_feed_for_woeid(woeid, options = {})
+      units = options[:units] || 'f'
+      format = options[:format] || :json
+      url = build_url(woeid, units)
+      get(url, format)
+    end
+
+    def get_response_for_woeid(woeid, options = {})
+      units = options[:units] || 'f'
+      format = options[:format] || :hash
+      url = build_url(woeid, units)
+      hash = get(url, format)
+      @response = Response.new(woeid, nil, url, hash)
+    end
+    
+    def get_response_for_zipcode(zipcode, options = {})
+      units = options[:units] || 'f'
+      format = options[:format] || :hash
+      woeid = woeid_from_zipcode(zipcode)
+      url = build_url(woeid, units)
+      hash = get(url, format)
+      @response = Response.new(woeid, zipcode, url, hash)
+    end
+
+    ##################################################
+    private
+    
+      def build_url(woeid, units)
+        "#{@@BASE_URL}?w=#{CGI.escape(woeid.to_s)}&u=#{CGI.escape(units)}"
+      end
+    
+      def woeid_from_zipcode(zipcode)
+        yql = Yql::Client.new
+        query = Yql::QueryBuilder.new 'geo.places'
+        query.select = 'woeid'
+        query.conditions = "text = '#{zipcode}, usa'"
+        yql.query = query
+        yql.format = 'json'
+        response = yql.get
+        h = ::HashWithIndifferentAccess.new(::JSON::parse(response.body))
+        if h[:query][:results][:place].is_a?(Array)
+          raise YweatherException, "Cannot determine WOEID from the ZIPCODE [#{zipcode}]"
+          return
+        end
+        h[:query][:results][:place][:woeid]
+      end
+
+      def get(url, format)
+        response = RestClient.get(url)
+        if response.body =~ /Error/
+          hash = ::HashWithIndifferentAccess.new(Hash.from_xml(response.body))
+          item = hash[:rss][:channel][:item]
+          raise YweatherException, "#{hash[:rss][:channel][:title]} :: #{item[:title]} :: #{item[:description]}"
+          return
+        end
+        if format == :xml
+          response.body
+        elsif format == :json
+          Hash.from_xml(response.body).to_json
+        elsif format == :hash
+          ::HashWithIndifferentAccess.new(Hash.from_xml(response.body))
+        end
+      end
+
+  end
+end

data/lib/yweather/condition.rb

@@ -0,0 +1,71 @@
+module Yweather
+  class Condition
+    include Yweather::Utils
+
+    CODES = {
+      0	  => "tornado",
+      1	  => "tropical storm",
+      2	  => "hurricane",
+      3	  => "severe thunderstorms",
+      4	  => "thunderstorms",
+      5	  => "mixed rain and snow",
+      6	  => "mixed rain and sleet",
+      7	  => "mixed snow and sleet",
+      8	  => "freezing drizzle",
+      9	  => "drizzle",
+      10	=> "freezing rain",
+      11	=> "showers",
+      12	=> "showers",
+      13	=> "snow flurries",
+      14	=> "light snow showers",
+      15	=> "blowing snow",
+      16	=> "snow",
+      17	=> "hail",
+      18	=> "sleet",
+      19	=> "dust",
+      20	=> "foggy",
+      21	=> "haze",
+      22	=> "smoky",
+      23	=> "blustery",
+      24	=> "windy",
+      25	=> "cold",
+      26	=> "cloudy",
+      27	=> "mostly cloudy (night)",
+      28	=> "mostly cloudy (day)",
+      29	=> "partly cloudy (night)",
+      30	=> "partly cloudy (day)",
+      31	=> "clear (night)",
+      32	=> "sunny",
+      33	=> "fair (night)",
+      34	=> "fair (day)",
+      35	=> "mixed rain and hail",
+      36	=> "hot",
+      37	=> "isolated thunderstorms",
+      38	=> "scattered thunderstorms",
+      39	=> "scattered thunderstorms",
+      40	=> "scattered showers",
+      41	=> "heavy snow",
+      42	=> "scattered snow showers",
+      43	=> "heavy snow",
+      44	=> "partly cloudy",
+      45	=> "thundershowers",
+      46	=> "snow showers",
+      47	=> "isolated thundershowers",
+      3200 => "not available"
+    }
+        
+    # the Yahoo! Weather condition code, as detailed at http://developer.yahoo.com/weather.
+    attr_reader :code
+    attr_reader :date
+    attr_reader :temp
+    attr_reader :text
+
+    def initialize(data)
+      @code = data[:code].to_i
+      @date = parse_time(data[:date])
+      @temp = data[:temp].to_i
+      @text = data[:text]
+    end
+    
+  end
+end

data/lib/yweather/forecast.rb

@@ -0,0 +1,22 @@
+module Yweather
+  class Forecast
+    include Yweather::Utils
+    
+    attr_reader :day
+    attr_reader :date
+    attr_reader :low
+    attr_reader :high
+    attr_reader :text
+    attr_reader :code
+
+    def initialize (data)
+      @day = data[:day]
+      @date = parse_time(data[:date])
+      @low = data[:low].to_i
+      @high = data[:high].to_i
+      @text = data[:text]
+      @code = data[:code].to_i
+    end
+    
+  end
+end

data/lib/yweather/image.rb

@@ -0,0 +1,19 @@
+module Yweather
+  class Image
+    
+    attr_reader :height
+    attr_reader :link
+    attr_reader :title
+    attr_reader :url
+    attr_reader :width
+
+    def initialize (data)
+      @title = data[:title]
+      @link = data[:link]
+      @url = data[:url]
+      @height = data[:height]
+      @width = data[:width]
+    end
+
+  end
+end

data/lib/yweather/location.rb

@@ -0,0 +1,15 @@
+module Yweather
+  class Location
+    
+    attr_reader :city
+    attr_reader :country
+    attr_reader :region
+
+    def initialize(data)
+      @city = data[:city]
+      @country = data[:country]
+      @region = data[:region]
+    end
+    
+  end
+end

data/lib/yweather/response.rb

@@ -0,0 +1,87 @@
+# encoding: ascii-8bit
+module Yweather
+  class Response
+    attr_accessor :astronomy
+    attr_accessor :atmosphere
+    attr_accessor :condition
+    attr_accessor :description
+    attr_accessor :forecasts
+    attr_accessor :image
+    attr_accessor :latitude
+    attr_accessor :location
+    attr_accessor :longitude
+    attr_accessor :page_url
+    attr_accessor :request_location
+    attr_accessor :request_url
+    attr_accessor :title
+    attr_accessor :units
+    attr_accessor :wind
+    
+    def initialize(woeid, zipcode, url, hash)
+      if hash[:rss][:channel][:title] =~ /Error/
+        item = hash[:rss][:channel][:item]
+        raise YweatherException, "#{hash[:rss][:channel][:title]} :: #{item[:title]} :: #{item[:description]}"
+        return
+      end
+      
+      @astronomy = Astronomy.new(hash[:rss][:channel][:astronomy])
+      @atmosphere = Atmosphere.new(hash[:rss][:channel][:atmosphere])
+      @location = Location.new(hash[:rss][:channel][:location])
+      @wind = Wind.new(hash[:rss][:channel][:wind])
+      @units = Units.new(hash[:rss][:channel][:units])
+      @image = Image.new(hash[:rss][:channel][:image])
+      
+      item = hash[:rss][:channel][:item]
+      @condition = Condition.new(item[:condition])
+      @forecasts = []
+      item[:forecast].each do |forecast|
+        @forecasts << Forecast.new(forecast)
+      end
+      @latitude = item[:lat]
+      @longitude = item[:long]
+      @page_url = item[:link]
+      @title = item[:title]
+      @description = item[:description]
+    end
+    
+    def atmospheric_conditions(options = {})
+      pressure = (@atmosphere.barometer == "steady") ? 
+        "#{@atmosphere.barometer} at #{@atmosphere.pressure}#{@units.pressure}" : 
+        "#{@atmosphere.pressure}#{@units.pressure} and #{@atmosphere.barometer}"
+
+      h = ::HashWithIndifferentAccess.new({
+        :humidity => "#{@atmosphere.humidity}%",
+        :visibility => "#{@atmosphere.visibility} #{@units.distance}",
+        :pressure => "#{pressure}"
+      })
+
+      return_content(h, options[:format])
+    end
+    
+    def wind_conditions(options = {})
+      # chill: wind chill in degrees (integer)
+      # direction: wind direction, in degrees (integer)
+      # speed: wind speed, in the units specified in the speed attribute of the yweather:units element (mph or kph). (integer)
+      h = ::HashWithIndifferentAccess.new({
+        :chill => "#{@wind.chill}°",
+        :direction => "#{@wind.direction}°",
+        :speed => "#{@wind.speed} #{@units.speed}"
+      })
+      return_content(h, options[:format])
+    end
+
+    ##################################################
+    private
+
+      def return_content(hash, format)
+        if format == :json
+          hash.to_json
+        elsif format == :xml
+          hash.to_xml
+        else
+          hash
+        end
+      end    
+
+  end
+end