meteofrance-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a96c9b4dbcb764e45dc7fce12a2f489fe6b4dacf5330b9b99f8591f4b22f6d69
+  data.tar.gz: f93e722e8d8ae1b254b7d5efc810c13750b0a28f24e8687048e4a7b663c33d54
+SHA512:
+  metadata.gz: '08f85b1b61e3621db2eb3291d87b20db96f83952a64785b449244565e132ddab79d2a8807e291f6e0bc554dcf1d6dbf5122aae6a8a34153a08ee347de96a498b'
+  data.tar.gz: 34a511d89e9876b9f95c315043b5e3070df516004bac4f420f0aff7341eccaab914176df2b9a5b424e4f3f5db4068259f4b1c3e08f4042c1ca95520563b6e36d

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thomaskuntz67@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in meteofrance-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    meteofrance-api (0.1.0)
+      faraday (~> 2.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    minitest (5.15.0)
+    rake (10.5.0)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  meteofrance-api!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Thomas Kuntz
+
+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,43 @@
+# Meteofrance::Api
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/meteofrance_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'meteofrance-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install meteofrance-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/meteofrance-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Meteofrance::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/meteofrance-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "meteofrance/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/meteofrance_api/client.rb

@@ -0,0 +1,275 @@
+require "faraday"
+
+require "meteofrance_api/constants.rb"
+require "meteofrance_api/models"
+
+class MeteofranceApi::Client
+  def initialize(token = MeteofranceApi::Constants::API_TOKENS.first)
+    @token = token
+  end
+
+  def connection
+    @conn ||= Faraday.new(
+      url: MeteofranceApi::Constants::API_URL,
+      params: {token: @token },
+    )
+  end
+
+
+  #  Search the places (cities) linked to a query by name.
+
+  #  You can add GPS coordinates in parameter to search places arround a given
+  #  location.
+
+  #  Args:
+  #      search_query: A complete name, only a part of a name or a postal code (for
+  #          France only) corresponding to a city in the world.
+  #      latitude: Optional; Latitude in degree of a reference point to order
+  #          results. The nearest places first.
+  #      longitude: Optional; Longitude in degree of a reference point to order
+  #          results. The nearest places first.
+
+  #  Returns:
+  #      A list of places (Place instance) corresponding to the query.
+  def search_places(
+      search_query,
+      latitude: nil,
+      longitude: nil
+  )
+    # Construct the list of the GET parameters
+    params = {"q": search_query}
+    if !!latitude
+      params["lat"] = latitude
+    end
+    if !!longitude
+      params["lon"] = longitude
+    end
+
+    # Send the API resuest
+    resp = connection.get("/v2/places", params)
+    data = JSON.parse(resp.body)
+
+    places = data.map {|datum| MeteofranceApi::Place.new(datum)}
+
+    places
+  end
+
+  # Retrieve the weather forecast for a given GPS location.
+  #
+  # Results can be fetched in french or english according to the language parameter.
+  #
+  # Args:
+  #    latitude: Latitude in degree of the GPS point corresponding to the weather
+  #        forecast.
+  #    longitude: Longitude in degree of the GPS point corresponding to the weather
+  #        forecast.
+  #    language: Optional; If language is equal "fr" (default value) results will
+  #        be in French. All other value will give results in English.
+  #
+  # Returns:
+  #    A Forecast intance representing the hourly and daily weather forecast.
+  #
+  def get_forecast(
+    latitude,
+    longitude,
+    language = nil
+  )
+    language ||= "fr"
+
+    # Send the API request
+    resp = connection.get("/v2/forecast", {
+      lat: latitude,
+      lon: longitude,
+      lang: language
+    })
+
+
+    return MeteofranceApi::Forecast.new(JSON.parse(resp.body))
+  end
+
+  # Retrieve the weather forecast for a given Place instance.
+  #
+  # Results can be fetched in french or english according to the language parameter.
+
+  # Args:
+  #    place: Place class instance corresponding to a location.
+  #    language: Optional; If language is equal "fr" (default value) results will
+  #        be in French. All other value will give results in English.
+  #
+  # Returns:
+  #    A Forecast intance representing the hourly and daily weather forecast.
+  #
+  def get_forecast_for_place(
+    place,
+    language = nil
+  )
+    language ||= "fr"
+
+    return get_forecast(place.latitude, place.longitude, language)
+  end
+
+  # Retrieve the next 1 hour rain forecast for a given GPS the location.
+  # 
+  # Results can be fetched in french or english according to the language parameter.
+  # 
+  # Args:
+  #     latitude: Latitude in degree of the GPS point corresponding to the rain
+  #         forecast.
+  #     longitude: Longitude in degree of the GPS point corresponding to the rain
+  #         forecast.
+  #     language: Optional; If language is equal "fr" (default value) results will
+  #         be in French. All other value will give results in English.
+  # 
+  # Returns:
+  #     A Rain instance representing the next hour rain forecast.
+  # 
+  def get_rain(latitude, longitude, language = nil)
+    # TODO: add protection if no rain forecast for this position
+
+    language ||= "fr"
+
+    # Send the API request
+    resp = connection.get("/v2/rain", {
+      lat: latitude,
+      lon: longitude,
+      lang: language
+    })
+
+    return MeteofranceApi::Rain.new(JSON.parse(resp.body))
+  end
+
+  # Return the current weather phenomenons (or alerts) for a given domain.
+  #
+  # Args:
+  #     domain: could be `france` or any metropolitan France department numbers on
+  #         two digits. For some departments you can access an additional bulletin
+  #         for coastal phenomenons. To access it add `10` after the domain id
+  #         (example: `1310`).
+  #     depth: Optional; To be used with domain = 'france'. With depth = 0 the
+  #         results will show only natinal sum up of the weather alerts. If
+  #         depth = 1, you will have in addition, the bulletin for all metropolitan
+  #         France department and Andorre
+  #     with_costal_bulletin: Optional; If set to True (default is False), you can
+  #         get the basic bulletin and coastal bulletin merged.
+  # 
+  # Returns:
+  #     A warning.CurrentPhenomenons instance representing the weather alert
+  #     bulletin.
+  # 
+  def get_warning_current_phenomenons(domain, depth = 0, with_costal_bulletin = false)
+    # Send the API request
+    resp = connection.get("/v2/warning/currentphenomenons", {
+      domain: domain,
+      depth: depth
+    })
+
+    # Create object with API response
+    phenomenons = MeteofranceApi::Warning::Current.new(JSON.parse(resp.body))
+
+
+    # if user ask to have the coastal bulletin merged
+    if with_costal_bulletin
+      if MeteofranceApi::Constants::COASTAL_DEPARTMENTS.include?(domain)
+        resp = connection.get("/v2/warning/currentphenomenons", {
+          domain: domain + "10",
+        })
+        coastal_phenomenons = MeteofranceApi::Warning::Current.new(JSON.parse(resp.body))
+
+        phenomenons.merge_with_coastal_phenomenons!(coastal_phenomenons)
+      end
+    end
+
+    return phenomenons
+  end
+
+  # Retrieve a complete bulletin of the weather phenomenons for a given domain.
+  # 
+  # For a given domain we can access the maximum alert, a timelaps of the alert
+  # evolution for the next 24 hours, a list of alerts and other metadatas.
+  # 
+  # Args:
+  #     domain: could be `france` or any metropolitan France department numbers on
+  #         two digits. For some departments you can access an additional bulletin
+  #         for coastal phenomenons. To access it add `10` after the domain id
+  #         (example: `1310`).
+  #     with_costal_bulletin: Optional; If set to True (default is False), you can
+  #         get the basic bulletin and coastal bulletin merged.
+  # 
+  # Returns:
+  #     A warning.Full instance representing the complete weather alert bulletin.
+  # 
+  def get_warning_full(domain, with_costal_bulletin = false)
+    # TODO: add formatDate parameter
+
+    # Send the API request
+    resp = connection.get("/v2/warning/full", {
+      domain: domain,
+    })
+
+    # Create object with API response
+    full_phenomenons = MeteofranceApi::Warning::Full.new(JSON.parse(resp.body))
+
+    # if user ask to have the coastal bulletin merged
+    if with_costal_bulletin
+      if MeteofranceApi::Constants::COASTAL_DEPARTMENTS.include?(domain)
+        resp = connection.get("/v2/warning/full", {
+          domain: domain + 10,
+        })
+        coastal_full_phenomenons = MeteofranceApi::Warning::Full.new(JSON.parse(resp.body))
+
+        full_phenomenons.merge_with_coastal_phenomenons!(coastal_full_phenomenons)
+      end
+    end
+
+    return full_phenomenons
+  end
+
+  #  Retrieve the thumbnail URL of the weather phenomenons or alerts map.
+  #
+  #  Args:
+  #      domain: could be `france` or any metropolitan France department numbers on
+  #          two digits.
+  #
+  #  Returns:
+  #      The URL of the thumbnail representing the weather alert status.
+  #  
+  def get_warning_thumbnail(domain = "france")
+    # Return directly the URL of the gif image
+    [
+      "#{MeteofranceApi::Constants::API_URL}/warning/thumbnail",
+      "?",
+      URI.encode_www_form({ domain: domain, token: @token }),
+    ].join
+  end
+
+  #
+  #    Retrieve the picture of the day image URL & description.
+  #
+  #    Args:
+  #        domain: could be `france`
+  #
+  #    Returns:
+  #        An array of 2 objects: the image url, and the description
+  #
+  def get_picture_of_the_day(domain = "france")
+    params = {
+      domain: domain,
+      report_type: "observation",
+      report_subtype: "image du jour",
+    }
+
+    resp = connection.get(
+      "/v2/report",
+      params.merge(format: "txt")
+    )
+    image_description = resp.body
+
+    image_url = [
+      "#{MeteofranceApi::Constants::API_URL}/v2/report",
+      "?",
+      URI.encode_www_form(params.merge(format: "jpg", token: @token))
+    ].join
+
+    return [image_url, image_description]
+  end
+end

data/lib/meteofrance_api/constants.rb

@@ -0,0 +1,86 @@
+# Constants for Météo-France weather forecast python API.
+module MeteofranceApi::Constants
+  API_URL = "https://webservice.meteofrance.com"
+  API_TOKENS = [
+    # noqa: S105
+    "__Wj7dVSTjV9YGu1guveLyDq0g7S7TfTjaHBTPTpO0kj8__",
+    # noqa: B951
+    "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzRjdFOTVGOS04QjIxLTQwMDctOTFCQi0wQ0M3QjlBNTQxQzQiLCJjbGFzcyI6Im1vYmlsZSIsImlhdCI6MTYzNDg0NjM1Mi40NzU0MTE5fQ.F02c4y95-HqMsMbQeJ5Cx-qQ4LDJgaYwl47YsNvJM0E",
+  ]
+
+  # enums used in all Warning classes. First indice is 0
+  # Weather alert criticity
+  ALERT_COLORS_FR = [nil, "Vert", "Jaune", "Orange", "Rouge"]
+  ALERT_COLORS_EN = [nil, "Green", "Yellow", "Orange", "Red"]
+  ALERT_COLORS = {
+    fr: ALERT_COLORS_FR,
+    en: ALERT_COLORS_EN,
+  }
+
+  # Weather alert type
+  ALERT_TYPES_FR = [
+      nil,
+      "Vent violent",
+      "Pluie-inondation",
+      "Orages",
+      "Inondation",
+      "Neige-verglas",
+      "Canicule",
+      "Grand-froid",
+      "Avalanches",
+      "Vagues-submersion",
+  ]
+  ALERT_TYPES_EN = [
+      nil,
+      "Wind",
+      "Rain-Flood",
+      "Thunderstorms",
+      "Flood",
+      "Snow/Ice",
+      "Extreme high temperature",
+      "Extreme low temperature",
+      "Avalanches",
+      "Coastal Event",
+  ]
+  ALERT_TYPES = {
+    fr: ALERT_TYPES_FR,
+    en: ALERT_TYPES_EN,
+  }
+
+
+  # Valide departments list for weather alert bulletin
+  VALID_DEPARTMENTS = (1..95).to_a + [
+    "2A",
+    "2B",
+    "99",
+  ].map {|v| v.to_s.rjust(2, "0")}.sort
+
+  # Area code list for Coastal Departments
+  COASTAL_DEPARTMENTS = [
+      "06",
+      "11",
+      "13",
+      "14",
+      "17",
+      "22",
+      "29",
+      "2A",
+      "2B",
+      "30",
+      "33",
+      "34",
+      "35",
+      "40",
+      "44",
+      "50",
+      "56",
+      "59",
+      "62",
+      "64",
+      "66",
+      "76",
+      "80",
+      "83",
+      "85",
+  ]
+end