openweathermap 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd453edace6d8f420b9c4a51a2188948f20bd99d6d970f0b8f8055253e0ebe85
-  data.tar.gz: d43facbee93b3ed35e3a470bfe1991fd69baf47a2123d186e1667bc59508f101
+  metadata.gz: 24880aa7d52ef082b5c90c142860c91bf01b048778d323120d0d5d025b93b635
+  data.tar.gz: 4f8898e0f90e45c4559dc173ec7ac9be559fb2f150ecfb974b080764ae4b28f5
 SHA512:
-  metadata.gz: bd07a4c30e0d54e62832dd1b4946b5fd4ab5e9140e8b40a267400a61baf4b20c8f280f17775ec0ed85aab74448797bfbfc2c0e2495f87befac6698b6133be130
-  data.tar.gz: 3304c7b36ac316fdb80d32bf141279e62f281bf651a38c30396b34a27b10afd976b73a2e3754f86ad1ac4970109a64a3c8d7febe06047cfc027b2d29f0e6bba0
+  metadata.gz: 61c8986000ca55f3da322a837f483e30360e06ce87f0286f7d2755eb91a3b5ac9ae1eefa0dac7fb212700450dfb3068a06bd2b62f1799ccc4c7541ee38484b46
+  data.tar.gz: 8b5d1e5a0c06d59874e604d192c7b234e279bcad94a3c54dc85bedc2c04fb31ed43eac9621350b014179a894e5921c23b8ba5a215b287525d3fa040a7432d8fc

data/lib/openweathermap.rb

@@ -1,9 +1,99 @@
+# frozen_string_literal: true
+
 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'
+
+module OpenWeatherMap
+
+  ##
+  # All the constants needed for the library
+
+  module Constants
+
+    ##
+    # URL of the OpenWeatherMap API
+
+    API_URL = 'https://api.openweathermap.org'
+
+    ##
+    # Accepted types of unit
+
+    UNITS = %w(default metric imperial)
+
+    ##
+    # Accepted locales
+
+    LANGS = %w(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
+
+  ##
+  # Base exception for the OpenWeatherMap library
+
+  class Exception < StandardError
+  end
+
+  ##
+  # Exceptions that can be thrown by the library
+
+  module Exceptions
+
+    ##
+    # Exception to handle unknown lang
+
+    class UnknownLang < OpenWeatherMap::Exception
+    end
+
+    ##
+    # Exception to handle unknown units
+
+    class UnknownUnits < OpenWeatherMap::Exception
+    end
+
+    ##
+    # Exception to handle unknown location
+
+    class UnknownLocation < OpenWeatherMap::Exception
+    end
+
+    ##
+    # Exception to tell that the API key isn't authorized
+
+    class Unauthorized < OpenWeatherMap::Exception
+    end
+
+    ##
+    # Exception to handle data error
+
+    class DataError < OpenWeatherMap::Exception
+    end
+
+  end
+end

data/lib/openweathermap/api.rb

@@ -1,12 +1,23 @@
+# frozen_string_literal: true
+
 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
+    ##
+    # The default lang to use across the program
+    # @return [String]
+
+    attr_reader :lang
 
+    ##
+    # The default unit system to use across the program
+    # @return [String]
+
+    attr_reader :units
+
+    ##
     # Initialize the API object
     #
     # @param api_key [String] your OpenWeatherMap's API key
@@ -20,29 +31,33 @@ module OpenWeatherMap
     #   - 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)
+
+    def initialize(api_key, lang = 'en', units = 'default')
       @api_key = api_key
 
-      raise OpenWeatherMap::Exceptions::UnknownLang, "[owm-ruby] error : unknown lang #{lang}" unless OpenWeatherMap::Constants::LANGS.include? lang
+      raise OpenWeatherMap::Exceptions::UnknownLang, "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
+      raise OpenWeatherMap::Exceptions::UnknownUnits, "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)
+    #   - Integer : search by city ID (refer to http://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
@@ -51,6 +66,7 @@ module OpenWeatherMap
     #   - 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)
@@ -58,11 +74,13 @@ module OpenWeatherMap
 
     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
@@ -79,16 +97,12 @@ module OpenWeatherMap
       }
       params.merge! options
 
-      url = "#{OpenWeatherMap::Constants::API_URL}/#{url}?"
-
-      params.each do |key, value|
-        url += "#{key}=#{value}&"
-      end
+      url = "#{OpenWeatherMap::Constants::API_URL}/#{url}?#{URI.encode_www_form(params)}"
 
       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}"
+      when 401 then raise OpenWeatherMap::Exceptions::Unauthorized, "unauthorized key. API message : #{response.message}"
+      when 404 then raise OpenWeatherMap::Exceptions::UnknownLocation, "unknown location. API message : #{location}"
       else response.body
       end
     end

data/lib/openweathermap/classes.rb

@@ -1,21 +1,35 @@
+# frozen_string_literal: true
+
 module OpenWeatherMap
-  # Represents a city
+
+  ##
+  # Class representing 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)
@@ -23,85 +37,127 @@ module OpenWeatherMap
     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
+    ##
+    # @return [String] Main weather conditions 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')]
+      @emoji = OpenWeatherMap::Constants::CONDITION_CODE[data['weather'][0]['icon'].tr('n', 'd')]
       @temperature = data['main']['temp']
       @temp_min = data['main']['temp_min'].to_f
       @temp_max = data['main']['temp_max'].to_f

data/lib/openweathermap/current-weather.rb

@@ -1,17 +1,33 @@
+# frozen_string_literal: true
+
 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)
+      begin
+        data = JSON.parse(data)
+      rescue JSON::JSONError => e
+        raise OpenWeatherMap::Exceptions::DataError, "error while parsing data : #{e}"
+      end
       @city = OpenWeatherMap::City.new(data['name'], data['coord']['lon'], data['coord']['lat'], data['sys']['country'])
       @weather_conditions = OpenWeatherMap::WeatherConditions.new(data)
     end

data/lib/openweathermap/forecast.rb

@@ -1,17 +1,33 @@
+# frozen_string_literal: true
+
 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)
+      begin
+        data = JSON.parse(data)
+      rescue JSON::JSONError => e
+        raise OpenWeatherMap::Exceptions::DataError, "error while parsing data : #{e}"
+      end
       @city = OpenWeatherMap::City.new(data['city']['name'], data['city']['coord']['lon'], data['city']['coord']['lat'], data['city']['country'])
       @forecast = []
       data['list'].each do |element|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openweathermap
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Exybore
@@ -20,8 +20,6 @@ files:
 - 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:

data/lib/openweathermap/data/constants.rb

@@ -1,31 +0,0 @@
-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 = %w(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

@@ -1,19 +0,0 @@
-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