openweathermap 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a01ee11d2636128cb6c2cced0e2ac2f3e6fa3261
+  data.tar.gz: f3112253de1b74d72f9a6a38351d8939f0ae8970
+SHA512:
+  metadata.gz: 67dc078f85400f220e81f79f3a1908d4a60e780970efee7044c1d72b968dd28c888e51c40f6e65841a1546f4beb7f984d43d7fb67b10c579cf76f2c8f5321022
+  data.tar.gz: 053f6ff4af3da00089d1c3fc600c84fecffe991b5fff7cf9b5a013f92c52e6c75c1c9a8c6835c19e9084f6732c10f2787578bf1b267303e22f78fbcb9b641b85

data/lib/openweathermap.rb

@@ -0,0 +1,9 @@
+require 'net/http'
+require 'json'
+
+require 'openweathermap/data/constants'
+require 'openweathermap/data/exceptions'
+require 'openweathermap/classes'
+require 'openweathermap/current-weather'
+require 'openweathermap/forecast'
+require 'openweathermap/api'

data/lib/openweathermap/api.rb

@@ -0,0 +1,96 @@
+module OpenWeatherMap
+  # The main API class.
+  class API
+    # @return [String] Default lang to use
+    attr_accessor :lang
+    
+    # @return [String] Default units to use
+    attr_accessor :units
+
+    # Initialize the API object
+    #
+    # @param api_key [String] your OpenWeatherMap's API key
+    #   For further information, go to https://openweathermap.org/price
+    # @param lang [String] the default lang
+    #   Refer to OpenWeatherMap::Constants::LANGS for accepted values
+    # @param units [String] the units system to use
+    #   Accepted values : 
+    #   - none (temperatures in Kelvin)
+    #   - metric (temperatures in Celsius)
+    #   - imperial (temperatures in Fahrenheit)
+    # @raise [OpenWeatherMap::Exceptions::UnknownLang] if the selected lang is not unknown
+    # @raise [OpenWeatherMap::Exceptions::UnknownUnits] if the selected units is not unknown
+    def initialize(api_key, lang = 'en', units = nil)
+      @api_key = api_key
+
+      raise OpenWeatherMap::Exceptions::UnknownLang, "[owm-ruby] error : unknown lang #{lang}" unless OpenWeatherMap::Constants::LANGS.include? lang
+      @lang = lang
+
+      raise OpenWeatherMap::Exceptions::UnknownUnits, "[owm-ruby] error : unknown units #{units}" unless OpenWeatherMap::Constants::UNITS.include? units
+      @units = units
+    end
+
+    # Get current weather at a specific location.
+    #
+    # @param location [String, Integer, Array] the location
+    #   Can be one of this type :
+    #   - String : search by city name
+    #   - Integer : search by city ID (refer to bulk.openweathermap.org/sample/city.list.json.gz)
+    #   - Array : search by coordinates (format : [lon, lat])
+    # @return [OpenWeatherMap::CurrentWeather] requested data
+    def current(location)
+      data = make_request(OpenWeatherMap::Constants::URLS[:current], location)
+      OpenWeatherMap::CurrentWeather.new(data)
+    end
+
+    # Get weather forecast for a specific location.
+    #
+    # @param location [String, Integer, Array] the location
+    #   Can be one of this type :
+    #   - String : search by city name
+    #   - Integer : search by city ID (refer to bulk.openweathermap.org/sample/city.list.json.gz)
+    #   - Array : search by coordinates (format : [lon, lat])
+    # @return [OpenWeatherMap::Forecast] requested data
+    def forecast(location)
+      data = make_request(OpenWeatherMap::Constants::URLS[:forecast], location)
+      OpenWeatherMap::Forecast.new(data)
+    end
+
+    private
+
+    # Make a request to the OpenWeatherMap API.
+    #
+    # @param url [String] The endpoint to reach
+    # @param options [Hash] mixed options
+    # @return [String] request's body
+    def make_request(url, location)
+      options = {}
+      options[:q] = location if location.is_a? String
+      options[:id] = location if location.is_a? Integer
+      if location.is_a? Array
+        options[:lon] = location[0]
+        options[:lat] = location[1]
+      end
+
+      params = {
+        apikey: @api_key,
+        lang: @lang,
+        units: @units
+      }
+      params.merge! options
+
+      url = "#{OpenWeatherMap::Constants::API_URL}/#{url}?"
+
+      params.each do |key, value|
+        url += "#{key}=#{value}&"
+      end
+
+      response = Net::HTTP.get_response(URI(url))
+      case response.code.to_i
+      when 401 then raise OpenWeatherMap::Exceptions::Unauthorized, "[openweathermap] error : unauthorized key. API message : #{response.message}"
+      when 404 then raise OpenWeatherMap::Exceptions::UnknownLocation, "[openweathermap] error : unknown location. API message : #{location}"
+      else response.body
+      end
+    end
+  end
+end

data/lib/openweathermap/classes.rb

@@ -0,0 +1,125 @@
+module OpenWeatherMap
+  # Represents a city
+  class City
+    # @return [String] City's name
+    attr_reader :name
+
+    # @return [Coordinates] City's coordinates
+    attr_reader :coordinates
+
+    # @return [String] Country in which the city is
+    attr_reader :country
+
+    # Create a new City object
+    #
+    # @param name [String] City's name
+    # @param lon [Float] Longitude of the city
+    # @param lat [Float] Latitude of the city
+    # @param country [String] Country in which the city is
+    def initialize(name, lon, lat, country)
+      @name = name
+      @coordinates = OpenWeatherMap::Coordinates.new(lon, lat)
+      @country = country
+    end
+  end
+
+  # Represents a location's coordinates
+  class Coordinates
+    # @return [Float] Longitude of the location
+    attr_reader :lon
+    
+    # @return [Float] Latitude of the location
+    attr_reader :lat
+
+    # Create a new Coordinates object
+    #
+    # @param lon [Float] Longitude of the location
+    # @param lat [Float] Latitude of the location
+    def initialize(lon, lat)
+      @lon = lon
+      @lat = lat
+    end
+  end
+
+  # Represents the weather conditions
+  class WeatherConditions
+    # @return [Time] time of the condition
+    attr_reader :time
+
+    # @return [String] Main weather contitions at the moment
+    attr_reader :main
+
+    # @return [String] Details of weather conditions
+    attr_reader :description
+
+    # @return [String] URL to conditions icon illustration
+    attr_reader :icon
+
+    # @return [String] Conditions illustrated by an emoji
+    attr_reader :emoji
+
+    # @return [Float] Temperature
+    attr_reader :temperature
+
+    # @return [Float] Minimum temperature at the moment (for large areas)
+    attr_reader :temp_min
+
+    # @return [Float] Maximum temperature at the moment (for large areas)
+    attr_reader :temp_max
+
+    # @return [Float] Atmospheric pressure in hPa
+    attr_reader :pressure
+
+    # @return [Float] Humidity percentage
+    attr_reader :humidity
+
+    # @return [Hash] Wind data. Keys : (symbols)
+    #   - speed : Wind speed (m/s or miles/hour)
+    #   - direction : Wind direction (meteorological degrees)
+    attr_reader :wind
+
+    # @return [Float] Clouds percentage
+    attr_reader :clouds
+
+    # @return [Hash, nil] Rain volume. Keys : (symbols)
+    #   - one_hour : Rain volume for the last 1 hour (mm)
+    #   - three_hours : Rain volume for the last 3 hours (mm)
+    # Can be nil if there is no rain
+    attr_reader :rain
+
+    # @return [Hash, nil] Snow volume. Keys : (symbols)
+    #   - one_hour : Snow volume for the last 1 hour (mm)
+    #   - three_hours : Snow volume for the last 3 hours (mm)
+    # Can be nil if there is no snow
+    attr_reader :snow
+
+    # Create a new WeatherConditions object.
+    #
+    # @param data [Hash] all the received data
+    def initialize(data)
+      @time = Time.at(data['dt'])
+      @main = data['weather'][0]['main']
+      @description = data['weather'][0]['description']
+      @icon = "https://openweathermap.org/img/w/#{data['weather'][0]['icon']}.png"
+      @emoji = OpenWeatherMap::Constants::CONDITION_CODE[data['weather'][0]['icon'].sub('n', 'd')]
+      @temperature = data['main']['temp']
+      @temp_min = data['main']['temp_min'].to_f
+      @temp_max = data['main']['temp_max'].to_f
+      @pressure = data['main']['pressure'].to_f
+      @humidity = data['main']['humidity'].to_f
+      @wind = {
+        speed: data['wind']['speed'],
+        direction: data['wind']['deg']
+      }
+      @clouds = data['clouds']['all'].to_f
+      @rain = data['rain'].nil? ? nil : {
+        one_hour: data['rain']['1h'],
+        three_hours: data['rain']['3h']
+      }
+      @snow = data['snow'].nil? ? nil : {
+        one_hour: data['snow']['1h'],
+        three_hours: data['snow']['3h']
+      }
+    end
+  end
+end

data/lib/openweathermap/current-weather.rb

@@ -0,0 +1,19 @@
+module OpenWeatherMap
+  # Represents the current weather at a location
+  class CurrentWeather
+    # @return [OpenWeatherMap::WeatherConditions] Conditions at the moment
+    attr_reader :weather_conditions
+
+    # @return [OpenWeatherMap::City] Requested city's data
+    attr_reader :city
+    
+    # Create a new CurrentWeather object
+    #
+    # @param data [Hash] mixed data from the request
+    def initialize(data)
+      data = JSON.parse(data)
+      @city = OpenWeatherMap::City.new(data['name'], data['coord']['lon'], data['coord']['lat'], data['sys']['country'])
+      @weather_conditions = OpenWeatherMap::WeatherConditions.new(data)
+    end
+  end
+end

data/lib/openweathermap/data/constants.rb

@@ -0,0 +1,32 @@
+module OpenWeatherMap
+  module Constants
+    # URL of the OpenWeatherMap API
+    API_URL = 'https://api.openweathermap.org'
+
+    # Accepted types of unit
+    UNITS = [nil, 'metric', 'imperial']
+
+    # Accepted locales
+    LANGS = ['ar', 'bg', 'ca', 'cz', 'de', 'el', 'fa', 'fi', 'fr', 'gl', 'hr', 'hu', 'it', 'ja', 'kr', 'la',
+      'lt', 'mk', 'nl', 'pl', 'pt', 'ro', 'ru', 'se', 'sk', 'sl', 'es', 'tr', 'ua', 'vi', 'zh_cn', 'zh_tw' 'en']
+
+    # The different URLs 
+    URLS = {
+      current: '/data/2.5/weather',
+      forecast: '/data/2.5/forecast'
+    }
+
+    # All condition codes associated with emojis
+    CONDITION_CODE = {
+      '01d' => '☀',
+      '02d' => '⛅',
+      '03d' => '☁',
+      '04d' => '☁☁',
+      '09d' => '🌧',
+      '10d' => '🌦',
+      '11d' => '🌩',
+      '13d' => '🌨',
+      '50d' => '🌫',
+    }
+  end
+end

data/lib/openweathermap/data/exceptions.rb

@@ -0,0 +1,19 @@
+module OpenWeatherMap
+  module Exceptions
+    # Exception to handle unknown lang
+    class UnknownLang < StandardError
+    end
+
+    # Exception to handle unknown units
+    class UnknownUnits < StandardError
+    end
+
+    # Exception to handle unknown location
+    class UnknownLocation < StandardError
+    end
+
+    # Exception to tell that the API key isn't authorized
+    class Unauthorized < StandardError
+    end
+  end
+end

data/lib/openweathermap/forecast.rb

@@ -0,0 +1,22 @@
+module OpenWeatherMap
+  # Represents the forecast for a specific location
+  class Forecast
+    # @return [OpenWeatherMap::City] Requested city's data
+    attr_reader :city
+
+    # @return [Array<OpenWeatherMap::WeatherConditions>] Forecast for many days and hours
+    attr_reader :forecast
+
+    # Create a new Forecast object
+    #
+    # @param data [Hash] mixed data from the request
+    def initialize(data)
+      data = JSON.parse(data)
+      @city = OpenWeatherMap::City.new(data['city']['name'], data['city']['coord']['lon'], data['city']['coord']['lat'], data['city']['country'])
+      @forecast = []
+      data['list'].each do |element|
+        forecast << OpenWeatherMap::WeatherConditions.new(element)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: openweathermap
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Exybore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-16 00:00:00.000000000 Z
+dependencies: []
+description: An implementation to easily fetch the OpenWeatherMap API.
+email: exybore@becauseofprog.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/openweathermap.rb
+- lib/openweathermap/api.rb
+- lib/openweathermap/classes.rb
+- lib/openweathermap/current-weather.rb
+- lib/openweathermap/data/constants.rb
+- lib/openweathermap/data/exceptions.rb
+- lib/openweathermap/forecast.rb
+homepage: https://github.com/becauseofprog/openweathermap-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: "\U0001F310 Implementation of OpenWeatherMap API."
+test_files: []