bbc_weather 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 917180090c503d03f9d5b0431f6d445034f54766
+  data.tar.gz: 4477139c89d314359f4b453400bf23d7d11f9ac6
+SHA512:
+  metadata.gz: 935321055d6017ecc7094e31a595e29b997895a0996f7c7451fc171716d78ca07885aac5c264b82b610b9e0ecc15c0262784673e9518e17ce2ca1dc35643579d
+  data.tar.gz: 45beeea7cb1aa564982bddc13f7d824974b206c12ef05141ebe5e61480e8f94fa781ce24aac1b53b2e88ef7f256872037536e1c55d9554c656e57e74ac499d15

data/lib/bbc_weather.rb

@@ -0,0 +1,105 @@
+require 'nokogiri'
+require 'net/http'
+require 'json'
+require 'weather_result'
+
+class BBCWeather
+  $temp_unit = "c"
+  $speed_unit = "mph"
+
+  def self.city(city_id)
+    result = {}
+
+    if city_id.is_a?(Integer) || city_id =~ /^[0-9]+$/
+      begin
+        result = get_weather_from_bbc_url("http://www.bbc.co.uk/weather/en/#{city_id}")
+      rescue ArgumentError => e
+        if e.to_s[/404/]
+          raise ArgumentError, "City ID: #{city_id} not found"
+        end
+        raise
+      end
+    else
+      # Convert string location to integer city code
+      city_ids = BBCWeather.get_city_id(city_id)
+
+      if city_ids.length == 0
+        raise ArgumentError, "City ID: '#{city_id}' could not be located"
+      elsif city_ids.length > 1
+        raise ArgumentError, "City ID: '#{city_id}' returned more than one matching city (#{city_ids}). Please refine your search term"
+      else
+        # Recursive call using integer city code
+        return BBCWeather.city(city_ids[0]["id"])
+      end
+    end
+    return result
+  end
+
+  def self.get_city_id(city_name)
+    city_name_d = city_name.downcase
+    city_ids = JSON.parse(Net::HTTP.get(URI("http://www.bbc.co.uk/locator/default/en-GB/autocomplete.json?search=#{city_name_d}&filter=international")))
+    city_id = city_ids.select {|a| a["fullName"].downcase.eql?(city_name_d) || a["fullName"].downcase.eql?("#{city_name_d}, #{city_name_d}") || a["fullName"].downcase.eql?("#{city_name_d}, #{city_name_d} city") }
+
+    city_id.empty? ? (return city_ids) : (return city_id)
+  end
+
+  def self.get_weather_from_bbc_url(url)
+    html = {}
+    html[:main] = Nokogiri::HTML(Net::HTTP.get(URI(url)))
+
+    if html[:main].css("title")[0].children[0].text[/not found/i]
+      raise ArgumentError, "The given URL returned a 404 error. Please check the city ID and try again"
+    end
+
+    lock = Mutex.new
+    connections = []
+    html[:main].css("div.daily-window > ul > li > a").each do |day|
+       connections << Thread.new {
+         day_url = day.attributes["data-ajax-href"].value
+         day_html = Nokogiri::HTML(Net::HTTP.get(URI("http://www.bbc.co.uk#{day_url}")))
+         lock.synchronize {
+           html[day_url[/[0-9]+$/].to_i] = day_html
+         }
+       }
+    end
+    connections.each {|conn| conn.join}
+
+    return WeatherResult.new(html)
+  end
+
+  def self.set_units(*units)
+    curr_units = self.units
+    count = {:temp => 0, :speed => 0}
+
+    units.each do |u|
+      if u == "c" || u == "celcius"
+        $temp_unit = "c"
+        count[:temp] += 1
+      elsif u == "f" || u == "fahrenheit"
+        $temp_unit = "f"
+        count[:temp] += 1
+      elsif u == "kph" || u == "km/h"
+        $speed_unit = "kph"
+        count[:speed] += 1
+      elsif u == "mph"
+        $speed_unit = "mph"
+        count[:speed] += 1
+      else
+        $temp_unit = curr_units[0]
+        $speed_unit = curr_units[1]
+        raise ArgumentError, "'#{u}' is not a recognised unit of speed/temperature. Unit must be either 'c' or 'f' (celcius or fahrenheit), or 'kph' or 'mph' (kilometers per hour or miles per hour). Units have not been changed"
+      end
+    end
+    if count[:temp] > 1 || count[:speed] > 1
+      $temp_unit = curr_units[0]
+      $speed_unit = curr_units[1]
+      raise ArgumentError, "Cannot pass in two units of the same type (i.e. #set_units('kph', 'mph')). Units have not been changed"
+    end
+
+    return [$temp_unit, $speed_unit]
+  end
+
+  def self.units
+    return [$temp_unit, $speed_unit]
+  end
+end

data/lib/day.rb

@@ -0,0 +1,118 @@
+require 'timeslot'
+require 'date'
+
+class Day
+  attr_accessor :date, :sunrise, :sunset, :timeslots, :nextday_timeslots
+
+  def initialize(day_html, date)
+    @timeslots = Array.new
+    nextday_timeslot_index = nil
+
+    @date = Date.parse(date)
+    @sunrise = day_html.css("span.sunrise")[0].children[0].text[/\d{2}:\d{2}/]
+    @sunset = day_html.css("span.sunset")[0].children[0].text[/\d{2}:\d{2}/]
+
+###
+### START LOOPS
+###
+    # Get times for each TimeSlot
+    day_html.css("table.weather tr.time > th.value").each_with_index do |times_html, i|
+      nextday_timeslot_index = i if times_html.attributes["class"].value.include?("next-day") && !nextday_timeslot_index
+
+      # Sort out Timeslot time
+      ts = TimeSlot.new
+      time = "#{times_html.css("span[class='hour']").text}:#{times_html.css("span[class='mins']").text}"
+      ts.time = DateTime.parse("#{@date}T#{time}")
+      ts.time += 1 if nextday_timeslot_index
+
+      # Sort out prev and next Timeslots
+      unless @timeslots[-1].nil?
+        ts.prev = @timeslots[-1]
+        @timeslots[-1].next = ts
+      end
+
+      @timeslots.push(ts)
+    end
+
+    # Get weather conditions for each TimeSlot
+    day_html.css("table.weather tr.weather-type > td img").each_with_index do |conditions_html, i|
+      @timeslots[i].conditions = conditions_html.attributes["title"].value
+      @timeslots[i].icon_url = conditions_html.attributes["src"].value
+    end
+
+    # Get temperature for each TimeSlot
+    day_html.css("table.weather tr.temperature > td span[data-unit='c']").each_with_index do |temperature_html, i|
+      @timeslots[i].temperature = temperature_html.children[0].text.to_i
+    end
+
+    # Get wind details for each TimeSlot
+    day_html.css("table.weather tr.windspeed > td > span.wind").each_with_index do |wind_html, i|
+      wind_data = wind_html.attributes["data-tooltip-mph"].value
+      @timeslots[i].wind_speed = wind_data[/\d+/].to_i
+      @timeslots[i].wind_direction = wind_data.gsub(/[^A-Z]/, "")
+    end
+
+    # Get humidity for each TimeSlot
+    day_html.css("table.weather tr.humidity > td.value").each_with_index do |humidity_html, i|
+      @timeslots[i].humidity = humidity_html.children[0].text[/\d+/].to_i
+    end
+
+    # Get visibility for each TimeSlot
+    day_html.css("table.weather tr.visibility > td.value abbr").each_with_index do |visibility_html, i|
+      @timeslots[i].visibility = visibility_html.attributes["title"].value
+    end
+
+    # Get pressure for each TimeSlot
+    day_html.css("table.weather tr.pressure > td.value").each_with_index do |pressure_html, i|
+      @timeslots[i].pressure = pressure_html.children[0].text[/\d+/].to_i # In Millibars
+    end
+###
+### END LOOPS
+###
+    # Shift any timeslots after midnight into the nextday_timeslots
+    @nextday_timeslots = @timeslots.slice!(nextday_timeslot_index, @timeslots.length-nextday_timeslot_index)
+  end
+
+  def high
+    @timeslots.max_by {|ts| ts.temperature}.temperature
+  end
+
+  def low
+    @timeslots.min_by {|ts| ts.temperature}.temperature
+  end
+
+  def timeslot(i)
+    return nil unless i.is_a?(Integer)
+    @timeslots[i]
+  end
+
+  def at(time)
+    if time.is_a?(DateTime) || time.is_a?(Time) || (time.is_a?(String) && time =~ /\d{2}:\d{2}/ && time[0..1].to_i >= 0 && time[0..1].to_i <= 23 && time[2..3].to_i >= 0 && time[2..3].to_i <= 59)
+      curr_slot = @timeslots[0]
+      time = "#{@date}T#{time}" if time.is_a?(String)
+      search_time = DateTime.parse(time.to_s).strftime("%s").to_i
+      curr_slot_time = curr_slot.time.strftime("%s").to_i
+
+      curr_diff = (search_time - curr_slot_time).abs
+
+      loop do
+        if search_time > curr_slot_time
+          if !curr_slot.next.nil? && (curr_slot.next.time.strftime("%s").to_i - search_time).abs < curr_diff
+            curr_slot = curr_slot.next
+            curr_diff = (search_time - curr_slot.time.strftime("%s").to_i).abs
+          else
+            return curr_slot
+          end
+        elsif search_time <= curr_slot_time
+          if !curr_slot.prev.nil? && ((curr_slot.prev.time-1).strftime("%s").to_i - search_time).abs < curr_diff
+            return curr_slot.prev
+          else
+            return curr_slot
+          end
+        end
+      end
+    else
+      raise ArgumentError, "Time must be in the format 'HH:MM' (00-23) i.e. '23:45' or as a DateTime/Time object"
+    end
+  end
+end

data/lib/timeslot.rb

@@ -0,0 +1,22 @@
+class TimeSlot
+  attr_accessor :time, :temperature, :humidity, :visibility, :pressure, :wind_speed, :wind_direction, :conditions, :icon_url, :next, :prev
+
+  def initialize
+  end
+
+  def temperature
+    if $temp_unit.eql?("c")
+      return @temperature
+    else
+      return ((@temperature * 9 / 5) + 32).round
+    end
+  end
+
+  def wind_speed
+    if $speed_unit.eql?("mph")
+      return @wind_speed
+    else
+      return (@wind_speed * 1.609344).round
+    end
+  end
+end

data/lib/weather_result.rb

@@ -0,0 +1,89 @@
+require 'nokogiri'
+require 'date'
+require 'day'
+require 'timeslot'
+
+class WeatherResult
+  attr_reader :location, :current_time, :current_temp, :current_humidity, :days
+  def initialize(html)
+    @location = html[:main].css("span.location-name")[0].children[0].text
+    @current_temp = html[:main].css("div.observationsRecord span.temperature-value")[0].children[0].text.to_i
+    @current_humidity = html[:main].css("div.observationsRecord p.humidity > span")[0].children[0].text[/\d+/].to_i  # In %
+
+    timezone = html[:main].css("div.ack > p")[1].children[0].text[/GMT[+-]\d{4}/]
+    @current_time = DateTime.now.new_offset(timezone).to_s
+
+    @days = []
+    nextday_timeslots = []
+
+    5.times do |i|
+      date = html[:main].css("div.daily-window > ul > li > a")[i].attributes["data-ajax-href"].value[/\d{4}-\d{2}-\d{2}/]
+      day = Day.new(html[i], date)
+
+      # Transfer 'yesterdays' next_day timeslots to today and link up next and prev links
+      unless nextday_timeslots.empty?
+        nextday_timeslots[-1].next = day.timeslots[0]
+        day.timeslots[0].prev = nextday_timeslots[-1]
+        day.timeslots = nextday_timeslots.concat(day.timeslots)
+      end
+      nextday_timeslots = day.nextday_timeslots.dup
+      day.nextday_timeslots.clear
+      @days.push day
+    end
+
+    @days.shift if @days[0].timeslots.empty?
+  end
+
+  # Returns today of the city location, _not_ today of the user
+  # i.e. a user in Canada wants the forecast for Auckland, New Zealand..
+  #  .today then refers to Auckland's today, which may well be one day ahead of Canada
+  def today
+    return @days[0]
+  end
+
+  def tomorrow
+    return @days[1]
+  end
+
+  def days_forward(i)
+    return nil unless i.is_a?(Integer)
+    return @days[i]
+  end
+
+  def on(day)
+    day = Date.parse(day) if day =~ /\d{4}-\d{2}-\d{2}/
+    if day.is_a?(String)
+      weekdays = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
+      day_temp = weekdays.select {|d| d.downcase.include?(day.downcase)}.first
+
+      raise ArgumentError, "'#{day}' is not a valid day" if day_temp.nil?
+      day = day_temp
+
+      7.times do |i|
+        if (Date.today + i).strftime("%A").eql?(day)
+          day = Date.today + i
+          break
+        end
+      end
+    elsif day.is_a?(DateTime)
+      day = Date.parse(day.to_s)
+    end
+
+    # day var is now a Date object
+
+    7.times do |i|
+      if !@days[i].nil? && @days[i].date.eql?(day)
+        return @days[i]
+      end
+    end
+    raise ArgumentError, "'#{day.to_s}' is not in the forecast range (#{@days.first.date.to_s} - #{@days.last.date.to_s})"
+  end
+
+  def current_temp
+    if $temp_unit.eql?("c")
+      return @current_temp
+    else
+      return ((@current_temp * 9 / 5) + 32).round
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: bbc_weather
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Guthrie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: A simple gem to grab the BBC weather forecast for any given city
+email: jamie.guthrie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bbc_weather.rb
+- lib/day.rb
+- lib/timeslot.rb
+- lib/weather_result.rb
+homepage: http://www.github.com/jguthrie100/bbc_weather
+licenses:
+- MIT
+metadata: {}
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Get the weather!
+test_files: []