weather_jp 1.0.4 → 2.0.0

data/lib/weather_jp/city.rb

@@ -0,0 +1,52 @@
+module WeatherJp
+  # @attr_reader [String] name
+  class City
+    # Canonical key names for attributes.
+    KEYS = %i(name full_name code latitude longitude)
+
+    attr_reader :name
+
+    # @param [String] name
+    # @param [Hash] attrs
+    def initialize(name, attrs = {})
+      @name = name
+      @attrs = attrs
+    end
+
+    # @return [String]
+    def full_name
+      @attrs['weatherlocationname']
+    end
+
+    # i.e. 'JAXX0085'
+    # @return [String]
+    def code
+      if str = @attrs['weatherlocationcode']
+        str.split(':').last
+      else
+        nil
+      end
+    end
+    alias_method :area_code, :code
+    alias_method :location_code, :code
+
+    # @return [Float]
+    def latitude
+      @attrs['lat'].try(:to_f)
+    end
+    alias_method :lat, :latitude
+
+    # @return [Float]
+    def longitude
+      @attrs['long'].try(:to_f)
+    end
+    alias_method :long, :longitude
+
+    alias_method :to_s, :name
+
+    # @return [Hash]
+    def to_hash
+      Hash[KEYS.map {|k| [k, public_send(k)] }]
+    end
+  end
+end

data/lib/weather_jp/day_weather.rb

@@ -1,51 +1,137 @@
-# -*- coding:utf-8 -*-
-
 module WeatherJp
-  class Weather
-    class DayWeather
-      include Enumerable
+  # @attr_reader [WeatherJp::City] city
+  # @attr_reader [Integer] date_code Current is 0, today is 1, tomorrow is 2
+  class DayWeather
+    extend Forwardable
 
-      def initialize(weathers, city_name, day)
-        @weather = weathers[day]
-        @city_name = city_name
-      end
+    # Canonical key names for attributes.
+    KEYS = %i(text high low rain date date_text date_code city_name city)
 
-      attr_reader :city_name
+    attr_reader :city, :date_code
 
-      def to_hash
-        @weather
-      end
+    # @param [Hash] attrs
+    # @param [WeatherJp::City] city
+    # @param [Integer] date_code
+    def initialize(attrs, city, date_code)
+      @attrs = attrs
+      @city = city
+      @date_code = date_code
+    end
 
-      def each
-        @weather.each {|_k, v| yield v }
-      end
+    # @return [String]
+    def city_name
+      city.name
+    end
 
-      def each_pair
-        @weather.each_pair {|k,v| yield k, v }
-      end
+    # Sky status. i.e. 'sunny' or '晴れ'.
+    # @return [String]
+    def text
+      @attrs['skytext'] || @attrs['skytextday']
+    end
 
-      def inspect
-        word = "\#<DayWeather:@city_name = #{city_name}, "
-        word << "@day=#{day}, @forecast=#{forecast}, "
-        word << "@max_temp=#{max_temp}, @min_temp=#{min_temp}, "
-        word << "@rain=#{rain}>"
-        word
-      end
+    # @return [Integer, nil]
+    def high
+      get('high').try(:to_i)
+    end
 
-      def to_s
-        word = "#{city_name}の"
-        word << "#{day}の天気は"
-        word << "#{forecast} "
-        word << "最高気温#{max_temp}度 " if max_temp
-        word << "最低気温#{min_temp}度 " if min_temp
-        word << "降水確率は#{rain}% " if rain
-        word << "です。"
-        word
-      end
+    # @return [Integer, nil]
+    def low
+      get('low').try(:to_i)
+    end
 
-      def method_missing(key)
-        @weather[key]
+    # @return [Integer, nil]
+    def precip
+      get('precip').try(:to_i)
+    end
+
+    # Only available for current weather.
+    # @return [Integer, nil]
+    def temperature
+      get('temperature').try(:to_i)
+    end
+
+    # Only available for current weather.
+    # @return [Integer, nil]
+    def wind_speed
+      get('windspeed').try(:to_i)
+    end
+
+    # Only available for current weather.
+    # i.e. '風向: 北北西 / 風速: 20 マイル'
+    # @return [String, nil]
+    def wind_text
+      get('winddisplay')
+    end
+
+    # @return [Date, nil]
+    def date
+      raw_date ? Date.parse(raw_date) : nil
+    end
+
+    # Japanese date text from current day.
+    # @return [String, nil]
+    def date_text
+      case date_code
+      when -1
+        "今"
+      when 0
+        "今日"
+      when 1
+        "明日"
+      when 2
+        "明後日"
+      else
+        "#{date_code}日後"
       end
     end
+
+    # @return [String]
+    def to_s
+      word ="#{date_text}の"
+      word << "#{city_name}の天気は"
+      word << "#{text}"
+      word << ", 最高気温#{high}度" if high
+      word << ", 最低気温#{low}度" if low
+      word << ", 降水確率は#{precip}%" if precip
+      word << "です。"
+      word
+    end
+
+    # Same as {Hash#each}
+    def_delegators :each, :to_hash
+
+    # @return [Hash]
+    def to_hash
+      h = Hash[KEYS.map {|k| [k, public_send(k)] }]
+      h[:city] = h[:city].to_hash
+      h
+    end
+
+    # @deprecated Use {#high}
+    alias_method :max_temp, :high
+
+    # @deprecated Use {#low}
+    alias_method :min_temp, :low
+
+    # @deprecated Use {#text}
+    alias_method :forecast, :text
+
+    # @deprecated Use {#date_text}
+    alias_method :day, :date_text
+
+    # @deprecated Use {#precip}
+    alias_method :rain, :precip
+
+    private
+
+    # Convert empty string to nil
+    def get(key)
+      @attrs[key].present? ? @attrs[key] : nil
+    end
+
+    # @return [String]
+    def raw_date
+      get('date')
+    end
   end
 end

data/lib/weather_jp/request_parser.rb

@@ -0,0 +1,42 @@
+module WeatherJp
+  module RequestParser
+    class Request < Struct.new(:city, :day)
+    end
+
+    class << self
+      dates_regexp = "今日|きょう|明日|あした|明後日|あさって|今|いま|3日後|３日後|4日後|４日後"
+      RequestMatcher = /
+        (
+          (?<city>.*)の(?<day>#{dates_regexp})の(天気|てんき).*
+        )|(
+          (?<day>#{dates_regexp})の(?<city>.*)の(天気|てんき)
+        )
+      /ux
+
+      def parser(str)
+        if str =~ RequestMatcher
+          data = Regexp.last_match
+          day = data[:day]
+          case day
+          when /今日|きょう/u
+            day = :today
+          when /明日|あした/u
+            day = :tomorrow
+          when /明後日|あさって/u
+            day = :day_after_tomorrow
+          when /3日後|３日後/
+            day = 3
+          when /4日後|４日後/
+            day = 4
+          when /今|いま/
+            day = :current
+          end
+
+          Request.new(data[:city], day)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/weather_jp/version.rb

@@ -1,3 +1,3 @@
 module WeatherJp
-  VERSION = "1.0.4"
+  VERSION = "2.0.0"
 end

data/lib/weather_jp/weather.rb

@@ -0,0 +1,82 @@
+module WeatherJp
+  # @attr_reader [WeatherJp::City] city
+  # @attr_reader [Array<WeatherJp::DayWeather>] weathers
+  # @attr_reader [WeatherJp::DayWeather] current
+  # @attr_reader [WeatherJp::DayWeather] today
+  # @attr_reader [WeatherJp::DayWeather] tomorrow
+  # @attr_reader [WeatherJp::DayWeather] day_after_tomorrow
+  class Weather
+    class << self
+      private
+      # Define extra readers
+      def define_readers(*names)
+        names.each {|s| define_method(s) { self.for(s) } }
+      end
+    end
+
+    extend Forwardable
+    include Enumerable
+
+    define_readers :current, :today, :tomorrow, :day_after_tomorrow
+    attr_reader :city, :weathers
+    alias_method :day_weathers, :weathers
+    alias_method :to_a, :weathers
+
+    # @param [WeatherJp::City] city
+    # @param [Array<WeatherJp::DayWeather>] weathers
+    def initialize(city, weathers)
+      @city = city
+      @weathers = weathers
+    end
+
+    # @yield [WeatherJp::DayWeather]
+    # @return [WeatherJp::Weather]
+    def each(&block)
+      each_with_all(&block)
+    end
+
+    # @yield [WeatherJp::DayWeather]
+    # @return [WeatherJp::Weather]
+    def each_with_all
+      weathers.each {|i| yield i }
+      self
+    end
+
+    # @yield [WeatherJp::DayWeather]
+    # @return [WeatherJp::Weather]
+    def each_without_current
+      except_current.each {|i| yield i }
+      self
+    end
+
+    # Except current weather status.
+    # @return [Array<WeatherJp::DayWeather>]
+    def except_current
+      weathers.reject {|w| w.date_code == -1 }
+    end
+
+    # @param [String, Symbol, Integer] date
+    # @return [WeatherJp::DayWeather, nil]
+    def for(date)
+      case date
+      when Date
+        raise NotImplementedError
+      when :current
+        day = 0
+      when :today
+        day = 1
+      when :tomorrow
+        day = 2
+      when :day_after_tomorrow
+        day = 3
+      else
+        day = date + 1
+      end
+
+      weathers[day]
+    end
+
+    # @deprecated Use {#for}
+    alias_method :get_weather, :for
+  end
+end

data/spec/fixture/not_found.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><weatherdata xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />

data/spec/fixture/tokyo.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><weatherdata xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><weather weatherlocationcode="wc:JAXX0085" weatherlocationname="東京都 東京" zipcode="" weathercityname="東京" url="http://weather.jp.msn.com/local.aspx?wealocations=wc:JAXX0085&amp;q=%e6%9d%b1%e4%ba%ac%e9%83%bd+%e6%9d%b1%e4%ba%ac" imagerelativeurl="http://wst.s-msn.com/i/ja/" degreetype="F" provider="Foreca" attribution="提供 Foreca" attribution2="© Foreca" lat="35.6751957" long="139.7695956" timezone="9" alert="" entityid="33568" encodedlocationname="%e6%9d%b1%e4%ba%ac%e9%83%bd+%e6%9d%b1%e4%ba%ac"><current temperature="41" skycode="33" skytext="晴時々曇" date="2015-01-17" observationtime="19:30:00" observationpoint="Tokyo International Airport" feelslike="32" humidity="27" winddisplay="風向: 北北西 / 風速: 20 マイル" day="土曜日" shortday="土" windspeed="20" /><forecast low="" high="" skycodeday="27" jpskycode="81" skytextday="曇のち晴" date="2015-01-17" day="土曜日" shortday="土" precip="10" /><forecast low="34" high="52" skycodeday="32" jpskycode="32" skytextday="晴れ" date="2015-01-18" day="日曜日" shortday="日" precip="0" /><forecast low="32" high="55" skycodeday="30" jpskycode="48" skytextday="晴時々曇" date="2015-01-19" day="月曜日" shortday="月" precip="10" /><forecast low="37" high="50" skycodeday="30" jpskycode="48" skytextday="晴時々曇" date="2015-01-20" day="火曜日" shortday="火" precip="10" /><forecast low="34" high="46" skycodeday="26" jpskycode="26" skytextday="曇り" date="2015-01-21" day="水曜日" shortday="水" precip="40" /><toolbar timewindow="60" minversion="1.0.1965.0" /></weather></weatherdata>

data/spec/spec_helper.rb

@@ -1,38 +1,42 @@
-# -*- coding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../", __FILE__)
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'webmock/rspec'
+require 'pry'
 
-require 'nokogiri'
-require 'weather_jp'
-
-module WeatherJp::Wrapper
-  class << self
-    def get_area_code(city_name)
-      ["JAXX0085", 'tokyo']
-    end
+# Use RSpec context
+module Fixturable
+  def self.included(base)
+    base.extend ClassMethods
+  end
 
-    def get_rss(area_code)
-      get_dummy_rss
+  module ClassMethods
+    def set_fixture(name)
+      before do
+        allow(WeatherJp::Adapter::Reader).to receive(:read).
+          and_return(fixture_for(name))
+      end
     end
   end
-end
 
-def fixture_path
-  File.expand_path('../fixture/', __FILE__)
-end
+  # @return [String]
+  def fixture_for(name)
+    File.open(File.join(fixture_path, name)).read
+  end
 
-def get_dummy_rss
-  rss = ''
-  open(fixture_path + '/RSS.rss') do |file|
-    rss = RSS::Parser.parse(file.read)
+  def fixture_path
+    File.expand_path(File.join('..', 'fixture'), __FILE__)
   end
-  rss
 end
 
-def get_ny_rss
-  rss = ''
-  open fixture_path + '/ny.rss' do |file|
-    rss = RSS::Parser.parse file.read
-  end
-  rss
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/spec'
 end
+
+$:.unshift File.expand_path(File.join('..', '..', 'lib'), __FILE__)
+require 'weather_jp'

data/spec/weather_jp/adapter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe WeatherJp::Adapter do
+  describe '.get' do
+    include Fixturable
+
+    context 'when found' do
+      set_fixture 'tokyo.xml'
+      subject { described_class.get('tokyo') }
+      it { is_expected.to be_kind_of(WeatherJp::Weather) }
+    end
+
+    context 'when not found' do
+      set_fixture 'not_found.xml'
+      subject { described_class.get('no_found_city') }
+      it { is_expected.to be_nil }
+    end
+  end
+
+  describe WeatherJp::Adapter::Reader do
+    describe '.read' do
+      subject { described_class.read('http://example.com') }
+
+      context 'with valid condition' do
+        before { stub_request(:get, 'http://example.com') }
+        it { is_expected.to eq('') }
+      end
+
+      context 'with server down' do
+        before { stub_request(:get, 'http://example.com').to_return(status: 500) }
+        specify do
+          expect { subject }.to raise_error(WeatherJp::ServiceUnavailable, /500/)
+        end
+      end
+
+      context 'with server maintenance' do
+        before { stub_request(:get, 'http://example.com').to_return(status: 503) }
+        specify do
+          expect { subject }.to raise_error(WeatherJp::ServiceUnavailable, /503/)
+        end
+      end
+    end
+  end
+end