tropical 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620cccda1d355f7b62533133cdb0d00fbade67391fd5e9458227ab5d96db0e61
-  data.tar.gz: ea585a571761290cebc3d4c3e8b184a548cd2bdb727819259486b807af8ee172
+  metadata.gz: a02e1d2772e6ea9d2d5cfe3238daf51e7880e0e47aa4ea93b80bf06e99c86868
+  data.tar.gz: c9f2fb4a9d13e10a6bfd12eea9b1671190068a75f019ae8330782eea269d8c79
 SHA512:
-  metadata.gz: 73eb9c2b1f232d34e5abcfce441551b982f1db7756234725704dfa3969006c340cccd5bf19a48f81019ca7036e030944a3f399598902cc2283ce394fd885d6ef
-  data.tar.gz: 9ab9a9e3af21330494156356f0672e973d3f7adf687dc66520d54f7c59657fbd37ee48fc775b544851efc018e1725909e0435ae59298482d38638016c2bdfcb2
+  metadata.gz: 9e5cc4b58e8b16e6dfbfae6c4d575688bedca5ea6f32c789f49c55af29ddb9550ac4bdd2171aebfc15b245fe614c885392fecd8da31a944bc1db93a7ee12d4c9
+  data.tar.gz: f70a42ff3bd9092a81aa41e4842ec1b1af0416227d45de1561b6e0514af92604cc9bb56f7fdda88ee7f8466b1ee12c1d4c90a08e2740f5d6ff27126780aaa758

data/CODE_OF_CONDUCT.md

@@ -69,8 +69,6 @@ Community leaders will follow these Community Impact Guidelines in determining t
 
 **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,

data/Gemfile.lock

@@ -1,13 +1,24 @@
 PATH
   remote: .
   specs:
-    tropical (0.1.3)
+    tropical (0.1.8)
+      activesupport (~> 6.1.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.3)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
@@ -40,7 +51,10 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   x86_64-linux

data/README.md

@@ -1,18 +1,13 @@
 # Tropical
 
-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/tropical`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Gem to consultation weather forecast up to 5 days.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tropical'
-
-# or
-gem 'tropical', git: 'https://github.com/valterandrei/tropical', branch: 'main'
+gem 'tropical', '~> 0.1.8'
 ```
 
 And then execute:
@@ -21,7 +16,105 @@ And then execute:
 
 ## Usage
 
-TODO: Write usage instructions here
+Ruby API
+```ruby
+tropical = Tropical::OpenWeatherMap.new(
+  {
+    appid: 'your_api_key', # required
+    q:     'São Paulo',    # required
+    lang:  'pt_br',        # optional
+    units: 'metric',       # optional
+    cnt:   '50'            # optional
+  }
+)
+```
+For more information about the params: [openweathermap](https://openweathermap.org/forecast5)
+
+Note: The `mode` param is not avaible.
+
+- City name
+```ruby
+tropical.city_name
+
+# => "São Paulo"
+```
+
+- Population
+```ruby
+tropical.population
+
+# => 10021295
+```
+
+- Country
+```ruby
+tropical.country
+
+# => "BR"
+```
+
+- Timezone
+```ruby
+tropical.timezone
+
+# => -3
+```
+
+- Current date
+```ruby
+tropical.current_date
+
+# => 2021-02-14 18:00:00 -0300
+```
+
+- Coord
+```ruby
+tropical.coord
+
+# => {:lat=>-23.5475, :lon=>-46.6361}
+```
+
+- Scale
+```ruby
+tropical.scale
+
+# => "°C"
+```
+
+- Current temperature
+```ruby
+tropical.current_temp
+
+# => 26.92
+```
+
+- Current weather
+```ruby
+tropical.current_weather
+
+# => "chuva moderada"
+```
+
+- Full sumary
+```ruby
+tropical.full_sumary
+
+# => "27°C e chuva moderada em São Paulo em 14/02. Média para os próximos dias: 26°C em 14/02, 26°C em 15/02, 26°C em 16/02, 26°C em 17/02, 25°C em 18/02 e 24°C em 19/02."
+```
+
+- Sumary current day
+```ruby
+tropical.sumary_current_day
+
+# => "27°C e chuva moderada em São Paulo em 14/02."
+```
+
+- Sumary days forecast
+```ruby
+tropical.sumary_days_forecast
+
+# => "26°C em 14/02, 26°C em 15/02, 26°C em 16/02, 26°C em 17/02, 25°C em 18/02 e 24°C em 19/02." 
+```
 
 ## Development
 

data/lib/tropical.rb

@@ -1,5 +1,7 @@
+require "active_support/all"
 require "date"
 require "json"
+require "i18n"
 require "net/http"
 require "uri"
 
@@ -7,34 +9,37 @@ module Tropical
   class OpenWeatherMap
     BASE_URL = "https://api.openweathermap.org/data/2.5/forecast?".freeze
 
-    attr_reader :data, :status
+    attr_reader :data, :params, :status
 
     def initialize(params)
-      request_params = build_request_params(params)
-      response       = post(request_params)
+      @params  = params
+      response = post(request_params)
 
       load_data(response)
     end
 
-    def average_temp_by_days
-      group_by_days = list.group_by { |item| item[:datetime].to_date }
-      days = []
+    def city_name
+      data["city"]["name"]
+    end
 
-      group_by_days.each do |day, temps|
-        average = temps.sum { |time| time[:temp] } / temps.length
+    def country
+      data["city"]["country"]
+    end
 
-        days << { day: day, average: average.round }
-      end
+    def population
+      data["city"]["population"]
+    end
 
-      days
+    def timezone
+      Time.at(data["city"]["timezone"]).zone.to_i
     end
 
-    def city
-      data["city"]["name"]
+    def coord
+      data["city"]["coord"].transform_keys(&:to_sym)
     end
 
     def current_date
-      list.first[:datetime]
+      list.first[:dt]
     end
 
     def current_temp
@@ -45,56 +50,49 @@ module Tropical
       list.first[:description]
     end
 
-    def list
-      data["list"].map do |list_item|
-        {
-          datetime: Time.at(list_item["dt"]),
-          temp: list_item["main"]["temp"],
-          description: list_item["weather"].first["description"]
-        }
-      end
+    def scale
+      units = params[:units]
+
+      return "°C" if units == "metric"
+      return "°F" if units == "imperial"
+
+      "°K"
+    end
+
+    def full_sumary
+      "#{sumary_current_day} "\
+      "Média para os próximos dias: "\
+      "#{sumary_days_forecast}"
+    end
+
+    def sumary_current_day
+      "#{current_temp.round}#{scale} e #{current_weather} em "\
+      "#{city_name} em #{current_date.strftime("%d/%m")}."
     end
 
-    def sumary
-      message = format_message
+    def sumary_days_forecast
+      list = average_temp_by_days.map do |x|
+        "#{x[:average]}#{scale} em #{x[:day].strftime("%d/%m")}"
+      end
 
-      "#{message.current_temp}°C e #{current_weather} em #{city} em #{message.current_date}. "\
-      "Média para os próximos dias: #{message.first_day_average}°C em #{message.first_day_date}, "\
-      "#{message.second_day_average}°C em #{message.second_day_date}, "\
-      "#{message.third_day_average}°C em #{message.third_day_date}, "\
-      "#{message.fourth_day_average}°C em #{message.fourth_day_date} "\
-      "e #{message.fifth_day_average}°C em #{message.fifth_day_date}."
+      "#{list.to_sentence(words_connector: ", ", last_word_connector: " e ")}."
     end
 
     private
 
-    def build_request_params(params)
+    def request_params
       link = ""
 
       params.each do |k, v|
-        link += "&#{k}=#{v}" if v.is_a?(String) && !v.empty?
+        next if k == :mode
+        next unless v.is_a?(String) && v.present?
+
+        link += "&#{k}=#{I18n.transliterate(v)}"
       end
 
       BASE_URL + link
     end
 
-    def format_message
-      OpenStruct.new(
-        current_temp: current_temp.round,
-        current_date: current_date.strftime("%d/%m"),
-        first_day_average: average_temp_by_days[0][:average],
-        first_day_date: average_temp_by_days[0][:day].strftime("%d/%m"),
-        second_day_average: average_temp_by_days[1][:average],
-        second_day_date: average_temp_by_days[1][:day].strftime("%d/%m"),
-        third_day_average: average_temp_by_days[2][:average],
-        third_day_date: average_temp_by_days[2][:day].strftime("%d/%m"),
-        fourth_day_average: average_temp_by_days[3][:average],
-        fourth_day_date: average_temp_by_days[3][:day].strftime("%d/%m"),
-        fifth_day_average: average_temp_by_days[4][:average],
-        fifth_day_date: average_temp_by_days[4][:day].strftime("%d/%m")
-      )
-    end
-
     def load_data(response)
       @status = response.code
       @data = case response
@@ -107,6 +105,29 @@ module Tropical
               end
     end
 
+    def average_temp_by_days
+      group_by_days = list.group_by { |item| item[:dt].to_date }
+      days = []
+
+      group_by_days.each do |day, temps|
+        average = temps.sum { |time| time[:temp] } / temps.length
+
+        days << { day: day, average: average.round }
+      end
+
+      days
+    end
+
+    def list
+      data["list"].map do |list_item|
+        {
+          dt: Time.at(list_item["dt"]),
+          temp: list_item["main"]["temp"],
+          description: list_item["weather"].first["description"]
+        }
+      end
+    end
+
     def post(request_params)
       url          = URI(request_params)
       http         = Net::HTTP.new(url.host, url.port)

data/lib/tropical/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tropical
-  VERSION = "0.1.3"
+  VERSION = "0.1.8"
 end

data/tropical.gemspec

@@ -27,8 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "activesupport", "~> 6.1.2.1"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tropical
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Valter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
-dependencies: []
+date: 2021-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.2.1
 description: Consultation weather forecast up to 5 days.
 email:
 - valterandrey@gmail.com