open_weather_raoni 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e4255f726b518acaead55e8cd40e44b6466a954182da3af26274643953bb00a
+  data.tar.gz: 3643cae5e9b4157e82e7d1d0a02cfd40f35df4315534b12cc43aa3a271b569e2
+SHA512:
+  metadata.gz: ed3a6fcefffb1727b6d160721d6acb1978226d798e5162376933a9c98fd33e75ac01a4642c7a85570c51caead307a6efbadb605a013ea0c9aa26e10d48c4ecce
+  data.tar.gz: c5fad6ea6bc710d912cf50d179aa0173f1b39b862652308aebaa8e81992113f342647b4794ff25e5717641288b5a472ae1495e3dcae984c2565d9e0d5802eb88

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in open_weather_raoni.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    open_weather_raoni (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
+    json (2.5.1)
+    minitest (5.14.4)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rexml (3.2.4)
+    webmock (3.12.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  json (~> 2.5.1)
+  minitest (~> 5.0)
+  open_weather_raoni!
+  rake (~> 13.0)
+  webmock (~> 3.12.0)
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Raoni Renosto Coelho
+
+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,72 @@
+# OpenWeatherRaoni
+
+This gem has two features:
+- Retrieve the current forecast for a given city
+- Retrieve the next 5 days forecast for a given city.
+
+This gem uses the Open Weather Map API (https://openweathermap.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_weather_raoni'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install open_weather_raoni
+
+## Usage
+
+```ruby
+require "open_weather_raoni/open_weather_map_api"
+```
+
+```ruby
+open_weather_api = OpenWeatherRaoni::OpenWeatherMapApi.new #your_open_weather_map_key
+```
+
+Get a city current weather:
+```ruby
+forecast = open_weather_api.current_weather "pato branco,BR"
+
+puts forecast[:temperature]
+puts forecast[:weather]
+```
+
+Get a city next 5 days forecast:
+```ruby
+result = open_weather_api.next_five_days_forecast "pato branco,BR"
+
+result[:list].each do |forecast|
+    puts forecast[:temperature_average]
+    puts forecast[:date]
+end
+```
+
+Handling API errors:
+```ruby
+if result[:error]
+    puts result[:message]
+end
+```
+
+## 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 the created tag, 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/raonirenosto/open-weather-gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "open_weather_raoni"
+
+# 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/open_weather_raoni.rb

@@ -0,0 +1,5 @@
+require_relative "open_weather_raoni/version"
+require "open_weather_raoni/open_weather_map_api"
+
+module OpenWeatherRaoni
+end

data/lib/open_weather_raoni/open_weather_map_api.rb

@@ -0,0 +1,134 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require "json"
+
+module OpenWeatherRaoni
+  class OpenWeatherApiError < StandardError; 
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  class OpenWeatherMapApi
+
+    def initialize key
+      @api_key = key
+      @api_link = "https://community-open-weather-map.p.rapidapi.com"
+    end
+
+    def next_five_days_forecast city 
+      response = ""
+      begin
+        response = api_five_day_weather city
+      rescue OpenWeatherRaoni::OpenWeatherApiError => e
+        e.inspect
+        return {
+          :error => true,
+          :message => e.message
+        }
+      end
+      forecasts = response["list"]
+      parse_five_days_result forecasts
+    end
+
+    def current_weather city
+      response = ""
+      begin
+        response = api_current_weather city
+      rescue OpenWeatherApiError => e
+        return {
+          :error => true,
+          :message => e.message
+        }
+      end
+      parse_current_weather response
+    end
+
+    def api_current_weather city
+      endpoint = "/weather"
+      city_param = "?q=#{city}"
+      unit_param = "&units=metric"
+      language = "&lang=pt_br"
+      composed_url = @api_link + endpoint + city_param + unit_param + language
+
+      call_open_weather_api composed_url
+    end
+
+    def api_five_day_weather city
+      endpoint = "/forecast"
+      city_param = "?q=#{city}"
+      unit_param = "&units=metric"
+      composed_url = @api_link + endpoint + city_param + unit_param
+
+      call_open_weather_api composed_url
+    end
+
+    def call_open_weather_api composed_url
+      url = URI(composed_url)
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      request = Net::HTTP::Get.new(url)
+      request["x-rapidapi-key"] = @api_key
+      request["x-rapidapi-host"] = 'community-open-weather-map.p.rapidapi.com'
+      
+      response = http.request(request)
+
+      body = ""
+      if response.code != "500"
+        body = JSON.parse(response.read_body)
+        if response.code != "200"
+          raise OpenWeatherRaoni::OpenWeatherApiError.new body["message"]
+        end
+      else
+        raise OpenWeatherRaoni::OpenWeatherApiError.new "Could not reach server"
+      end
+  
+      return body
+    end
+
+   
+    def parse_current_weather response
+      return {
+        :error => false,
+        :temperature => response["main"]["temp"],
+        :weather => response["weather"][0]["description"]
+      }
+    end
+
+    def parse_five_days_result list
+      forecasts = []
+
+      grouped_list =  list.group_by { |g| g["dt_txt"].split[0] }
+      
+      # ignore today
+      if (grouped_list.size > 5)
+        grouped_list.shift
+      end
+      
+      grouped_list.each do |date, list|
+        temperature_average = calculate_temperature_average list
+        forecast_hash = {
+          :temperature_average => temperature_average,
+          :date => date
+        }
+        forecasts << forecast_hash
+      end
+
+      response = {
+        :error => false,
+        :list => forecasts
+      }
+
+      return response
+    end
+
+    def calculate_temperature_average list
+      temperature_sum = list.sum {|item| item["main"]["temp"]}
+      return (temperature_sum / list.size).floor(2)
+    end
+  end
+end

data/lib/open_weather_raoni/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenWeatherRaoni
+  VERSION = "0.1.0"
+end

data/open_weather_raoni.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/open_weather_raoni/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_weather_raoni"
+  spec.version       = OpenWeatherRaoni::VERSION
+  spec.authors       = ["Raoni Renosto Coelho"]
+  spec.email         = ["raonicoelho@gmail.com"]
+
+  spec.summary       = "Connect to OpenWeatherMap SDK, get a city current temperature, and for the next 5 days"
+  spec.homepage      = "https://github.com/raonirenosto/open-weather-gem"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/raonirenosto/open-weather-gem"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "json", "~> 2.5.1"
+  spec.add_development_dependency "webmock", "~> 3.12.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: open_weather_raoni
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raoni Renosto Coelho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+description: 
+email:
+- raonicoelho@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/open_weather_raoni.rb
+- lib/open_weather_raoni/open_weather_map_api.rb
+- lib/open_weather_raoni/version.rb
+- open_weather_raoni.gemspec
+homepage: https://github.com/raonirenosto/open-weather-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/raonirenosto/open-weather-gem
+  source_code_uri: https://github.com/raonirenosto/open-weather-gem
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Connect to OpenWeatherMap SDK, get a city current temperature, and for the
+  next 5 days
+test_files: []