meteoalarm 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a490f0eebfac5e80820deff7876c1c95b7e3f019db42d0555429b3faef70b151
+  data.tar.gz: 40d97474871812e4440552232ff9ed90382c3de65490405cf53152f643adced2
+SHA512:
+  metadata.gz: d86da58dcf511eb67398ae1ee66930d2dedfa329daea254471d2545b95d419183032ca0a4f88069b9516f79539ed16112a8d76d9e56a58327a5b86e0d77208ea
+  data.tar.gz: 166d72c0d5939a1f94eb47f1b9cd1fc8fd6426ec4f9c23a2380a8ea90f3c50c45df60339c14607fdb5ccfd37bc68b282f738d318c9da7a3c328aed92d148806a

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## [Unreleased]
+
+## [0.1.2] - 2024-01-13
+
+- Changed the approach for handling expired alarms.
+- Introduced a new feature enabling the filtering of alarms scheduled for the future.
+
+## [0.1.1] - 2024-01-12
+
+- Resolved problems related to the pathway to country files.
+
+## [0.1.0] - 2024-01-12
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in meteoalarm.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+group :test do
+  gem "webmock"
+  gem "timecop"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    meteoalarm (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
+    docile (1.4.0)
+    hashdiff (1.1.0)
+    minitest (5.20.0)
+    public_suffix (5.0.4)
+    rake (13.1.0)
+    rexml (3.2.6)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    timecop (0.9.8)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  meteoalarm!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  simplecov
+  timecop
+  webmock
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Em Jov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Meteoalarm
+
+Meteoalarm serves as an API wrapper for [meteoalarm.org](https://meteoalarm.org/en/live/), a platform delivering hydrometeorological warnings across the European region. This gem simplifies the process of retrieving warnings based on country, specific coordinates or area, along with a few additional options.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'meteoalarm'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it directly:
+
+```bash
+gem install meteoalarm
+```
+
+## Usage
+
+```ruby
+require 'meteoalarm'
+
+# Get alarms for a specific country by its ISO 3166-1 A-2 code
+Meteoalarm::Client.alarms('FR', **options) # Example: France
+```
+
+#### Options
+
+- `:latitude` and `:longitude`: Check alarms for a specific coordinates.
+- `:area`: Check alarms for a specific area.
+- `:active_now`: Check currently active alarms.
+- `:date`: Check alarms by date.
+- `:expired`: Include expired alarms.
+
+#### Examples
+
+```ruby
+require 'meteoalarm'
+
+# Check alarms by coordinates
+Meteoalarm::Client.alarms('FR', latitude: 48.84307, longitude: 2.33662)
+
+# Check alarms by area
+Meteoalarm::Client.alarms('FR', area: 'Paris')
+
+# Check currently active alarms
+Meteoalarm::Client.alarms('FR', active_now: true)
+
+# Check alarms by date
+Meteoalarm::Client.alarms('FR', date: Date.new(2024, 1, 21))
+
+# Include expired alarms
+Meteoalarm::Client.alarms('FR', expired: true)
+
+# Or combine the options
+Meteoalarm::Client.alarms('FR', area: 'Paris', active_now: true)
+```
+
+## Rake tasks
+
+To incorporate Meteoalarm rake tasks into your project, include the following code in your `Rakefile`:
+```ruby
+require 'meteoalarm'
+
+spec = Gem::Specification.find_by_name 'meteoalarm'
+Dir.glob("#{spec.gem_dir}/lib/meteoalarm/tasks/*.rake").each { |f| import f }
+```
+By adding this code, you will gain access to the following rake tasks:
+```
+rake meteoalarm:countries
+    List all countries in Meteoalarm system
+
+rake meteoalarm:areas
+    List all areas of given COUNTRY_CODE in Meteoalarm system
+```
+
+## Contributing
+
+Your contributions are welcome and appreciated. If you find issues or have improvements, feel free to open an issue or submit a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+Dir.glob("lib/meteoalarm/tasks/**/*.rake").each { |f| import f }
+
+task default: :test