sorah / eorzea_weather

EorzeaWeather: Eorzean weather forecast

Installation

Add this line to your application's Gemfile:

gem 'eorzea_weather'

And then execute:

$ bundle

Or install it yourself as:

$ gem install eorzea_weather

Usage

require 'eorzea_weather'

## Get single forecast
# Pick zone
forecast = EorzeaWeather.forecast(EorzeaWeather::Data::Zones::EurekaAnemos)
forecast = EorzeaWeather.forecast('Eureka Anemos')
forecast = EorzeaWeather.forecast('エウレカ:アネモス帯')
forecast = EorzeaWeather.forecast(:eureka_anemos)
# Specify date
forecast = EorzeaWeather.forecast(:eureka_anemos, Time.utc(2018,4,17,7,0,0))

## Using a forecast
# Weather
p weather
p forecast.weather
p forecast.start_time
p forecast.end_time
# Enumerate
p forecast.prev
p forecast.succ

## Upcoming and past
p EorzeaWeather.forecasts(:eureka_anemos)
p EorzeaWeather.history(:eureka_anemos)
# Need more?
p EorzeaWeather.forecasts(:eureka_anemos, count: 10)
p EorzeaWeather.history(:eureka_anemos, count: 10)

## Find next specific weather in a zone
p EorzeaWeather.find_next(:gales, :eureka_anemos)
p EorzeaWeather.find_next('暴風', :eureka_anemos)
p EorzeaWeather.find_next('Gales', :eureka_anemos)
# From specific time?
p EorzeaWeather.find_next(:gales, :eureka_anemos, time: Time.utc(2018,4,16,16,0,0))
# Need to dig more? (Default to 60 times, next 3 days in earth)
p EorzeaWeather.find_next(:gales, :eureka_anemos, max_attempts: 120)

## Find specific weather in zone
p EorzeaWeather.find(:gales, :eureka_anemos)
# From specific time?
p EorzeaWeather.find(:gales, :eureka_anemos, time: Time.utc(2018,4,16,16,0,0))
# Need to dig more? (Default to 60 times, next 3 days in earth)
p EorzeaWeather.find(:gales, :eureka_anemos, max_attempts: 120)

Localized string

p EorzeaWeather::Localizer.new(:zone, :eureka_anemos).to_h
p EorzeaWeather::Localizer.new(:zone, :eureka_anemos)[:en]
p EorzeaWeather::Localizer.new(:zone, :eureka_anemos)[:ja]

p EorzeaWeather::Localizer.new(:weather, :gales).to_h
p EorzeaWeather::Localizer.new(:weather, :gales)[:en]
p EorzeaWeather::Localizer.new(:weather, :gales)[:ja]

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sorah/eorzea_weather.

License

The gem is available as open source under the terms of the MIT License.

Credit

• Implementation idea based on
  • https://github.com/Rogueadyn/SaintCoinach/blob/f969b441584688c02dde2fadac548c4a5aaa3faa/SaintCoinach/Xiv/WeatherRate.cs
  • https://github.com/flowercartelet/eorzea-weather
• FINAL FANTASY is a registered trademark of Square Enix Holdings Co., Ltd.
  • FINAL FANTASY XIV (c) 2010-2018 SQUARE ENIX CO., LTD. All Rights Reserved.