weatherizableAPI 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc9813780b621ab04fe68a7aedfb1e5c652a6bc809d8ba740d34e86a32791341
+  data.tar.gz: 6b92b8ee68e397b1d331e9c74706ab2125d195ed837c27314415838a751ec3ed
+SHA512:
+  metadata.gz: 78a3a7731c5deff1f6ee3d4874bb7881bc64e8612f45a42a6a6f299af6894109dd0eceee3a90a3e50476c7d80cd3870cf8fac2b592927910d323a2e12d0aa898
+  data.tar.gz: 5424f25a4f15d6696f32f72bdeb815b50f1a1ba3fd5191778452ffbe9ebfa11c154064cd8675843f9272e780701ae7d32d62b84557f7773da6689489b13a1db2

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Ruby
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.11
+        bundle install
+        bundle exec rake
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+weatherizableAPI

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-02-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in weatherizableAPI.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem 'faraday'
+gem 'activemodel'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    weatherizableAPI (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.3)
+    multipart-post (2.1.1)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activemodel
+  faraday
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  weatherizableAPI!
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Hugo Silva
+
+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,56 @@
+# WeatherizableAPI
+
+This is a gem that aims to receive weather information according to the search options.
+
+The main feature is to receive a descriptive text containing the current temperature and the weather forecast for the next 5 days. So you can prepare yourself and not be caught off guard by weather changes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weatherizableAPI'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install weatherizableAPI
+
+## Usage
+
+First you need to create an account on [openweathermap](https://openweathermap.org/) and create an [API key](https://home.openweathermap.org/api_keys)
+
+```ruby
+require 'open_weather_api/messageable'
+
+params = {
+  q: 'São Paulo',
+  units:'metric', # metric for ºC, imperial for ºF
+  lang:'pt_br',
+  appid: 'YOUR_API_KEY'
+}
+messageable = OpenWeatherApi::Messageable.new(@params)
+messageable.prevision
+=> "20.5ºC e nublado em 2021-02-22. Média para os proximos dias: 33.1ºC em 2021-02-23, 33.4ºC em 2021-02-24, 30.9ºC em 2021-02-25, 29.6ºC em 2021-02-26, 6.6ºC em 2021-02-27,  "
+
+```
+
+###Note: In this release we only have answers in Brazilian Portuguese
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/weatherizableAPI. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/weatherizableAPI/blob/master/CODE_OF_CONDUCT.md).
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "weatherizableAPI"

data/lib/open_weather_api/forecast.rb

@@ -0,0 +1,52 @@
+require 'active_model'
+require 'date'
+
+module OpenWeatherApi
+  class Forecast
+    include ActiveModel::Serializers::JSON
+
+    attr_accessor :id, :params, :attributes, :cod, :message, :cnt, :list, :city, :main
+
+
+    def attributes=(hash)
+      hash.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def attributes
+      instance_values
+    end
+
+    def error?
+      true unless cod.eq "200"
+    end
+
+    def error
+      message
+    end
+
+    def split_day(date)
+      day = []
+      list.each do |item|
+        if convert_date(item['dt']) == date
+          day << item
+        end
+      end
+      day
+    end
+
+    def average_temperature(date)
+      temp = 0
+      split_day(date).each do |item|
+        temp += item['main']['temp']
+      end
+      (temp / split_day(Date.today).count).round(1)
+    end
+
+    def convert_date(timestamp)
+      Time.at(timestamp).to_date
+    end
+
+  end
+end

data/lib/open_weather_api/messageable.rb

@@ -0,0 +1,63 @@
+require 'active_model'
+require 'date'
+require 'open_weather_api/open_weather_api'
+
+module OpenWeatherApi
+  class Messageable
+    include ActiveModel::Serializers::JSON
+
+    def initialize(options = {})
+      @options = options
+      @forecast = open_weather_api.new(@options).forecast
+      @weather = open_weather_api.new(@options).weather
+    end
+
+    def forecast
+      @forecast
+    end
+
+    def weather
+      @weather
+    end
+
+    def prevision
+      "#{temp_now}. #{average_weather} "
+    end
+
+
+    private
+
+    def open_weather_api
+      ::OpenWeatherApi::OpenWeatherApi
+    end
+
+
+
+    def temp_type
+      case @options[:units]
+        when 'metric' then 'ºC'
+        when 'imperial' then 'ºF'
+        else ''
+      end
+    end
+
+    def temp_now
+      "#{weather.main['temp'].round(1)}#{temp_type} e #{weather.weather.last['description']} em #{forecast.convert_date(weather.dt)}"
+    end
+
+    #FIXME: workarround to be fixed
+    def average_weather
+      message = "Média para os proximos dias: "
+      5.times do |t|
+        date = Date.today + 1 + t
+        message += forecast.average_temperature(date).to_s
+        message += temp_type
+        message += " em "
+        message += date.to_s
+        message += "#{t == 5 ? '.' : ',' } "
+      end
+      message
+    end
+
+  end
+end

data/lib/open_weather_api/open_weather_api.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+require 'json'
+require 'open_weather_api/weather'
+require 'open_weather_api/forecast'
+
+module OpenWeatherApi
+  class OpenWeatherApi
+    URL = ENV['OPEN_WEATER_API_URL'] || 'https://api.openweathermap.org/data/2.5/'
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def weather
+      url = URL+'weather'
+      @weather = ::OpenWeatherApi::Weather.new.from_json(get(url, @options).body)
+      @weather.params = @options
+      @weather
+    end
+
+    def forecast
+      url = URL+'forecast'
+      @forecast = ::OpenWeatherApi::Forecast.new.from_json(get(url, @options).body)
+      @forecast.params = @options
+      @forecast
+    end
+
+    protected
+
+    def get(url, params)
+      Faraday.get(url) do |req|
+        params.each do |key, value|
+          req.params[key] = value
+        end
+        req.headers['Accept'] = 'application/json'
+      end
+    end
+
+  end
+end

data/lib/open_weather_api/weather.rb

@@ -0,0 +1,33 @@
+require 'active_model'
+
+module OpenWeatherApi
+  class Weather
+    include ActiveModel::Serializers::JSON
+
+    attr_accessor :id, :coord, :weather, :main, :base, :visibility, :wind,
+    :clouds, :dt, :sys, :timezone, :name, :cod, :message, :params
+
+    def attributes=(hash)
+      hash.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def attributes
+      instance_values
+    end
+
+    def error?
+      true unless cod.eq 200
+    end
+
+    def error
+      message
+    end
+
+    def temperature
+      main['temp'].to_f
+    end
+
+  end
+end

data/lib/weatherizableAPI.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "weatherizableAPI/version"
+
+module WeatherizableAPI
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/weatherizableAPI/version.rb

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

data/weatherizableAPI.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/weatherizableAPI/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "weatherizableAPI"
+  spec.version       = WeatherizableAPI::VERSION
+  spec.authors       = ["Hugo Silva"]
+  spec.email         = ["hugocardososilva@gmail.com"]
+
+  spec.summary       = "weatherizableAPI"
+  spec.description   = "weatherizableAPI"
+  spec.homepage      = "https://github.com/hugocardososilva/WeatherizableAPI"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/hugocardososilva/WeatherizableAPI/blob/master/CHANGELOG.md"
+
+  # 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"
+
+  # 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,70 @@
+--- !ruby/object:Gem::Specification
+name: weatherizableAPI
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hugo Silva
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-22 00:00:00.000000000 Z
+dependencies: []
+description: weatherizableAPI
+email:
+- hugocardososilva@gmail.com
+executables:
+- weatherizableAPI
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".idea/.gitignore"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/weatherizableAPI
+- lib/open_weather_api/forecast.rb
+- lib/open_weather_api/messageable.rb
+- lib/open_weather_api/open_weather_api.rb
+- lib/open_weather_api/weather.rb
+- lib/weatherizableAPI.rb
+- lib/weatherizableAPI/version.rb
+- weatherizableAPI.gemspec
+homepage: https://github.com/hugocardososilva/WeatherizableAPI
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hugocardososilva/WeatherizableAPI
+  source_code_uri: https://github.com/hugocardososilva/WeatherizableAPI
+  changelog_uri: https://github.com/hugocardososilva/WeatherizableAPI/blob/master/CHANGELOG.md
+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.2
+signing_key: 
+specification_version: 4
+summary: weatherizableAPI
+test_files: []