weather_jp 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4992900d6163c74063fc1434e7ab0a08cc972c9
-  data.tar.gz: 592b2ac4cd43a52cde680f3416c59a73fd88b80f
+  metadata.gz: 88a46156ea60f987d673c2040bd87524a787b34a
+  data.tar.gz: cc561056b3ee51d0e175eadf8f228e875e3ee9ab
 SHA512:
-  metadata.gz: 37f838fd46bdeb49ec6980cdf67194d5711904acd656a2ba0bff179c63d8fc16579e6d8e7d4af53c9296df5af0fad50d2cb65f094fa694c361ff1fff672b2429
-  data.tar.gz: e328c8712472a997cc4a466e7d7d563964469ebec89f0c07fa56028c75923ea2addd881b25f757198cf1c974c492f55c3abe9f517d2f514b3e6797948117c3c8
+  metadata.gz: be3cb9d733a173cd41e077d525acca595f03e64722fa6cf700bd22c9e5f2941ac9196b0752cf7415d67d0ef1436526f736aa88f1df042643c707591e113f13c5
+  data.tar.gz: 0acb01fb7aa2d9031fb0c98267b93f98a84de529516943493354bcd8fd943bc118203ddee7aa64c0ec1c7d382acc0f813256bf2d888b8d11e2fb6c7def750c96

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 1.9.3
-  - 1.9.2
-notifications:
-  email: false
+  - "2.0"
+  - "2.1"
+  - "2.2"

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+## 2.0.0
+- `WeatherJp::City` now available. You can get latitude/longitude of the city.
+- `WeatherJp::Weather#current`. The current weather is a little bit differrnt from day weather forecast.
+  - have: `temperature`, `wind_speed`, `wind_text`
+  - not have: `precip`, `high`, `low`.
+- `WeatherJp::Weather#each` now contains the `DayWeather` object which represents current weather status. If you do not want current weather status, use `each_without_current` or `except_current` method.
+- Remove `customize_to_s` method. This feature will be re-added as configurable procedure.
+- Remove option from `WeatherJp.get`. If you use these option, use `WeatherJp::Weather#for`.
+- Some deprecations for method names.
+
+## 1.0.4
+Bug fixes
+
+- Rain probability and tempratures are returned as Fixnum. [Sho Hashimoto - @shokai]
+- Can handle tempratures below zero. [Sho Hashimoto - @shokai]
+
+## 1.0.0
+- Add parse method to WeatherJp
+- see READEME for more description

data/README.md

@@ -1,11 +1,20 @@
-# weather_jp [![Build Status](https://secure.travis-ci.org/taiki45/weather_jp.png)](http://travis-ci.org/taiki45/weather_jp)
-Japan weather info API wrapper.
+# weather_jp [![Build Status](https://travis-ci.org/taiki45/weather_jp.svg?branch=master)](https://travis-ci.org/taiki45/weather_jp) [![Coverage Status](https://coveralls.io/repos/taiki45/weather_jp/badge.svg?branch=master)](https://coveralls.io/r/taiki45/weather_jp?branch=master) [![Code Climate](https://codeclimate.com/github/taiki45/weather_jp/badges/gpa.svg)](https://codeclimate.com/github/taiki45/weather_jp) [![Gem Version](https://badge.fury.io/rb/weather_jp.svg)](http://badge.fury.io/rb/weather_jp)
+Japan weather infomation API wrapper. Fetch Japan weather status or forecast as Ruby object easily.
 
-Fetch Japan weather info as Ruby object easily.
+## V2 upgrade guides
+The backend server returns differrnt contents from before. So V1 is not working. Please update to V2.
 
-http://taiki45.github.com/weather_jp
+And V2 contains some of new features, deprecations and removales.
 
-https://rubygems.org/gems/weather_jp
+- `WeatherJp::City` now available. You can get latitude/longitude of the city.
+- `WeatherJp::Weather#current`. The current weather is a little bit differrnt from day weather forecast.
+  - have: `temperature`, `wind_speed`, `wind_text`
+  - not have: `precip`, `high`, `low`.
+- `WeatherJp::Weather#each` now contains the `DayWeather` object which represents current weather status. If you do not want current weather status, use `each_without_current` or `except_current` method.
+- Remove `customize_to_s` method. This feature will be re-added as configurable procedure.
+- Remove option from `WeatherJp.get`. If you use these option, use `WeatherJp::Weather#for`.
+
+See deprecations at [API document page](http://rubydoc.info/gems/weather_jp/).
 
 ## Installation
 
@@ -27,7 +36,6 @@ Or install it yourself as:
 # creat weather object in differrnt ways
 tokyo = WeatherJp.get :tokyo
 akiba = WeatherJp.get "秋葉原"
-abuja = WeatherJp::Weather.new("アブジャ")
 tsuyama = WeatherJp.get "津山"
 
 # get weather info as String
@@ -35,53 +43,42 @@ tokyo.today.to_s
   #=> can be "東京都 東京の天気は曇りのち晴れ、最高気温34度...etc"
 
 # or your have unparsed string
-WeatherJp.parse("今日のうどん県の天気教えて下され〜〜").to_s
+WeatherJp.parse("今日の香川県の天気教えて下さい").to_s
   #=> "香川県 高松の今日の天気は曇のち晴れ 最高気温25度 最低気温17度 降水確率は20% です。"
 
 # to get weather info in differrnt ways
-akiba.get_weather(4) #=> <#DayWeather object>
-tokyo.today.forecast #=> can be "晴れ"
-tokyo.get_weather(:tomorrow).rain
+tokyo.today.text #=> can be "晴れ"
+tokyo.tomorrow.precip #=> can be 10
 akiba.day_after_tomorrow.to_s
-WeatherJp.get(:tokyo, :today).forecast
 
-# use Weather object
+# yields DayWeather object
 tokyo.each do |w|
   puts w.city_name
-  puts w.day
-  puts w.forecast
-  puts w.max_temp
-  puts w.min_temp
-  puts w.rain
-  w.each_pair {|k,v| puts k, v }
+  puts w.date
+  puts w.date_text
+  puts w.text
+  puts w.high
+  puts w.low
+  puts w.precip
 end
 
-akiba.map {|w| [w.day, w.forecast] }
+# You can use WeatherJp::City object
+tokyo.city => WeatherJp::City
+[tokyo.city.longitude, tokyo.city.latitude]
+
+akiba.map {|w| [w.date_text, w.text] }
 
 # or use as simple Array or Hash
 tokyo.to_a
+akiba.weathers
 tsuyama.each {|w| p w.to_hash }
-akiba.day_weathers
-
-# you can cutomize DayWeather#to_s method
-WeatherJp.get(:tokyo).today.to_s #=> "東京 東京都の天気は晴れ....etc"
-
-WeatherJp.customize_to_s do
-  word = "#{day}の#{city_name}は#{forecast} "
-  word << "最高気温は#{max_temp} " if max_temp
-  word << "最低気温は#{min_temp} " if min_temp
-  word << "降水確率は#{rain}%" if rain
-  word << "でし"
-  word
-end
-
-WeatherJp.get(:tokyo).today.to_s #=> "本日の東京 東京都は晴れ...."
-
 ```
 
+See more detail in [API document page](http://rubydoc.info/gems/weather_jp/).
+
 ## Requires
 
-Ruby >= 1.9.2
+Ruby >= 2.0.0
 
 ## Documents
 

data/Rakefile

@@ -12,7 +12,7 @@ end
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |task|
-  task.rspec_opts = ["-c", "-fs"]
+  task.rspec_opts = ["-c", "-fd"]
 end
 
 task :default => :spec

data/lib/weather_jp.rb

@@ -1,201 +1,36 @@
-# -*- coding:utf-8 -*-
+require 'forwardable'
+require 'nokogiri'
+require 'open-uri'
+require 'uri'
+
+require 'active_support'
+require 'active_support/core_ext/object'
+require 'rack'
+
+require 'weather_jp/city'
+require 'weather_jp/weather'
 require 'weather_jp/day_weather'
+require 'weather_jp/adapter'
+require 'weather_jp/request_parser'
 require 'weather_jp/version'
-require 'uri'
-require 'open-uri'
-require 'rss'
-require 'nokogiri'
 
 module WeatherJp
   class WeatherJpError < StandardError; end
+  class ServiceUnavailable < WeatherJpError; end
 
   class << self
-    def get(city_name, option = nil)
-      if option
-        Weather.new(city_name).get_weather(option)
-      else
-        Weather.new(city_name)
-      end
-    end
-
-    def customize_to_s(&code)
-      Weather::DayWeather.class_eval do
-        define_method(:to_s, &code)
-      end
-    end
-
-    def parse(str)
-      if day_and_city = parser(str)
-        WeatherJp.get(day_and_city[:city]).get_weather(day_and_city[:day])
-      end
-    end
-
-    def parser(str)
-      if str =~ /((?<city>.*)の
-          (?<day>今日|きょう|今|いま|明日|あした|明後日|あさって|３日後|４日後|3日後|4日後)
-          の(天気|てんき).*) |
-          ((?<day>今日|きょう|今|いま|明日|あした|明後日|あさって|３日後|４日後|3日後|4日後)の
-          (?<city>.*)の(天気|てんき))
-      /ux
-        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日後|３日後/u
-          day = 3
-        when /4日後|４日後/u
-          day = 4
-        else
-          raise WeatherJpError, "Can't parse given String"
-        end
-        {day: day, city: data[:city]}
-      else
-        nil
-      end
-    end
-  end
-
-  class Weather
-    include Enumerable
-
-    def initialize(city_name)
-      @area_code, @city_name, @weathers = Wrapper.get(city_name)
-      @day_weathers = Array.new(@weathers.size) do |n| 
-        DayWeather.new(@weathers,@city_name, n)
-      end
-    end
-
-    attr_reader :city_name, :area_code, :day_weathers
-
-    def to_hash
-      @weathers
-    end
-
-    alias to_a to_hash
-
-    def each
-      @day_weathers.each do |i|
-        yield i
-      end
-      self
-    end
-
-    def get_weather(day = 0)
-      begin
-        day = day.to_sym if day.class == String
-        case day
-        when :today
-          day = 0
-        when :tomorrow
-          day = 1
-        when :day_after_tomorrow
-          day = 2
-        end
-        raise WeatherJpError if @day_weathers[day] == nil
-        @day_weathers[day]
-      rescue
-        raise WeatherJpError,
-          "unvaild argument '#{day}' for get_weather"
-      end
-    end
-
-    %w(today tomorrow day_after_tomorrow).each do |s|
-      define_method(s.to_sym) do
-        get_weather(s)
-      end
-    end
-  end
-
-  module Wrapper
-    class << self
-      def get(city_name)
-        area_code, city_name = get_area_code(city_name.to_s)
-        weathers = set_weathers(parse_rss(get_rss(area_code)))
-        [area_code, city_name, weathers]
-      end
-
-      def get_area_code(city_name)
-        get_xml city_name do |xml|
-          parse_xml xml
-        end
-      end
-
-      def get_xml(city_name)
-        result = []
-        open(URI.encode("http://weather.service.msn.com/" +
-          "find.aspx?outputview=search&weadegreetype=C&culture=ja-JP&" +
-          "weasearchstr=#{city_name}")) do |xml|
-          result = yield xml
-        end
-        result
-      end
-
-      def parse_xml(xml)
-        doc = Nokogiri::XML(xml)
-        begin 
-          code =
-            doc.xpath('//weather').attr('weatherlocationcode').value
-          full_name = 
-            doc.xpath('//weather').attr('weatherlocationname').value
-        rescue
-          raise WeatherJpError, "Cant't parse XML"
-        end
-        [code.slice(3..-1), full_name]
-      end
-
-      def get_rss(area_code)
-        begin
-          uri = URI.parse(
-            "http://weather.jp.msn.com/" +
-            "RSS.aspx?wealocations=wc:#{area_code}&" +
-            "weadegreetype=C&culture=ja-JP"
-          )
-          RSS::Parser.parse(uri, false)
-        rescue
-          raise WeatherJpError,
-            "the MSN weather sever may be downed, or got invaild city code"
-        end
-      end
-
-      def parse_rss(rss)
-        str = rss.channel.item(0).description
-        data = remove_html_tag(str).split(/%/)
-        data.pop
-        data.map {|i| i.delete!('"') }
-      end
-
-      def remove_html_tag(str)
-        str.gsub(/<(\"[^\"]*\"|'[^']*'|[^'\">])*>/,'""')
-      end
-
-      def set_weathers(raw_data)
-        weathers = Array.new
-        begin
-          raw_data.each do |i|
-            h = Hash.new
-            h[:day] = i.slice(/(.*?):\s+(.*?)\./, 1)
-            h[:forecast] = i.slice(/(.*?):\s+(.*?)\./, 2)
-            h[:max_temp] = i.slice(/(最高).*?(-?\d+)/u, 2)
-            h[:min_temp] = i.slice(/(最低).*?(-?\d+)/u, 2)
-            h[:rain] = i.slice(/(降水確率).*?(\d+)/u, 2)
-            [:max_temp, :min_temp, :rain].each do |j|
-              h[j] = h[j].to_i if h[j]
-            end
-            if h[:day].match /の天気/u
-              h[:day] = h[:day].slice /(.*)の天気/u, 1
-            end
-            weathers << h
-          end
-          weathers
-        rescue NameError
-          raise WeatherJpError,
-            "the MSN weather sever may be downed, or something wrong"
-        end
+    # @param [String] city_name
+    # @return [WeatherJp::Weather, nil]
+    def get(city_name)
+      Adapter.get(city_name)
+    end
+
+    # Request like '明日の東京の天気教えて'.
+    # @param [String] query
+    # @return [WeatherJp::Weather, nil]
+    def parse(query)
+      if request = RequestParser.parser(query)
+        get(request.city).get_weather(request.day)
       end
     end
   end

data/lib/weather_jp/adapter.rb

@@ -0,0 +1,89 @@
+require 'rack/utils'
+
+module WeatherJp
+  class Adapter
+    class << self
+      # Returns nil when not found weather forecasts.
+      # @param [String] city_name
+      # @return [WeatherJp::Weather, nil]
+      def get(city_name)
+        new(city_name).get
+      end
+    end
+
+    BASE_URL = 'http://weather.service.msn.com/'
+    ACTION = 'data.aspx'
+    LANG = 'ja-JP'
+    SCALE = 'C'
+
+    attr_reader :name
+
+    def initialize(city_name)
+      @name = city_name
+    end
+
+    def get
+      weather_node ? weather : nil
+    end
+
+    def build_weather(attrs, day_weathers)
+    end
+
+    def weather
+      Weather.new(city, day_weathers)
+    end
+
+    def day_weathers
+      day_weather_nodes.each_with_index.map do |n, i|
+        attrs = Hash[n.attributes.map {|k, v| [k, v.value] }]
+        DayWeather.new(attrs, city, i - 1)
+      end
+    end
+
+    def day_weather_nodes
+      xml.xpath('/weatherdata/weather/*[attribute::skytextday or attribute::skytext]')
+    end
+
+    # Ruby 2.0.0 version has no `Nokogiri::XML::Element#to_h`.
+    def city
+      @city ||= begin
+        attrs = Hash[weather_node.attributes.map {|k, v| [k, v.value]}]
+        City.new(attrs['weathercityname'], attrs)
+      end
+    end
+
+    def weather_node
+       @weather_node ||= xml.xpath('/weatherdata/weather').first
+    end
+
+    def xml
+      @xml ||= Nokogiri::XML.parse(xml_str)
+    end
+
+    def xml_str
+      @xml_str ||= Reader.read(url)
+    end
+
+    def url
+      "#{BASE_URL}#{ACTION}?#{Rack::Utils.build_query(params)}"
+    end
+
+    def params
+      {
+        weadegreetype: SCALE,
+        culture: LANG,
+        weasearchstr: name,
+      }
+    end
+
+    module Reader
+      class << self
+        def read(url)
+          open(url).read
+        rescue OpenURI::HTTPError => e
+          raise ServiceUnavailable.new("status=#{e.message[0..-2]}")
+        end
+      end
+    end
+  end
+end