weatherfor 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea8a9060ac36004565702627c743ed73d103a703c815291f5bf6d64cb1297060
-  data.tar.gz: 7aeb1e2caa751f23d69c6687285cbef8170cfcf4513ac786ba5acff29df790ff
+  metadata.gz: 883f424e335c37d98240e90f31c7a6d771421baed9868d5ee3d530c20ba8d569
+  data.tar.gz: 2a75af9ca384fbdd288f7bc66df31d7d44b02ccb912080ae7f02666b2b84e128
 SHA512:
-  metadata.gz: af955872029404fbe4f2c23a56e858e07c055fb10b8fd321106b163a6c6df67d9d744597d8c85b8250b68edabfa1baf75989634769556f5b8675e63d541a520c
-  data.tar.gz: 2a38d934ee522d7625deacf365f3f13011546ddebf1315d20d1705eee2911a0407a0518d949964c9926e5ef1e9240df4db2e5d7255ab873c25cef2595234e797
+  metadata.gz: d65b683e7082546daf93dac8fa29cfbda910f5e235c47f8eaaf84ce97a411413434e01533ca13d11ccc2f0e9ba6188aa6ff3dfd249e7d8088f0d7488cb37e8a2
+  data.tar.gz: c6447a0288856b2ff03c66fd7cdbe0a140ac82f048669f51ae01c6038845acf91d32d01ca321a7a06852adc3851a948093584a578bd06ac90e31b2fee29cf543

data/.github/workflows/gem-push.yml

@@ -0,0 +1,42 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/LineLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/Gemfile

@@ -1,8 +1,17 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 require 'net/http'
 
 # Specify your gem's dependencies in weatherfor.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', require: false
+gem 'vcr'
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -1,13 +1,27 @@
 PATH
   remote: .
   specs:
-    weatherfor (0.1.0)
+    weatherfor (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
+    docile (1.3.5)
+    hashdiff (1.0.1)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -21,6 +35,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+    vcr (6.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -28,7 +66,11 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
+  simplecov
+  vcr
   weatherfor!
+  webmock
 
 BUNDLED WITH
    2.1.2

data/README.md

@@ -1,8 +1,8 @@
 # Weatherfor
 
-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/weatherfor`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to Weatherfor gem! 
 
-TODO: Delete this and the text above, and describe your gem
+The purpose of this Gem is to make API requests to OpenWeatherAPI to query meteorological data to process the average temperature for the next five days.
 
 ## Installation
 
@@ -22,8 +22,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After you install the gem you'll have access to this methods:
 
+To instance the gem class
+```ruby
+req = Weatherfor::ApiConsultant.new(CityName, OpenWeatherApiKey)
+```
+
+With this initialization you can check the parsed data:
+
+Methodo to consult average temperature in days:
+```ruby
+req.weather_in_days
+```
+
+Method to consult the raw data:
+```ruby
+req.list
+```
+
+Method to consult the city request data:
+```ruby
+req.list
+```
 ## 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.
@@ -32,7 +53,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/weatherfor.
+Bug reports and pull requests are welcome on GitHub at https://github.com/k41n3w/weatherfor.
 
 
 ## License

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "weatherfor"
+require 'bundler/setup'
+require 'weatherfor'
 
 # 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.
@@ -10,5 +11,5 @@ require "weatherfor"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/weatherfor.rb

@@ -1,47 +1,79 @@
-require "weatherfor/version"
+# frozen_string_literal: true
+
+require 'weatherfor/version'
 require 'net/http'
 require 'json'
 
 module Weatherfor
   class Error < StandardError; end
-  
+
+  # Make the API request and parse data
   class ApiConsultant
+    attr_reader :obj
+
     def initialize(city, api_id)
-      uri = URI("https://api.openweathermap.org/data/2.5/forecast?q=#{city}&appid=#{api_id}&lang=pt_br&units=metric")
-      res = Net::HTTP.get_response(uri);nil
+      uri = url(city, api_id)
+      res = Net::HTTP.get_response(uri)
+
+      @obj = case res.code
+             when '200'
+               JSON.parse(res.body)
+             else
+               { error: res.message }
+             end
+    end
 
-      if res.code == '200'
-        @json = JSON.parse res.body
-      else
-        return { 'error' => res.message }
+    def weather_in_days
+      avg_temp_in_days
+
+      "#{today_avg_temp}°C e #{current_temp_desc} em #{city_name} em #{current_date}." \
+        " Média para os próximos dias: #{parse_avg_text}"
+    end
+
+    def avg_temp_in_days
+      @arr = []
+      @obj['list'].group_by { |item| Time.at(item['dt']).strftime('%m-%d-%Y') }.each do |date, data|
+        avg_temp = data.sum { |info| info['main']['temp'] }
+        avg_temp /= data.count
+        @arr << { avg_temp: avg_temp, date: date }
       end
     end
 
-    def city
-      @json['city']
+    def today_avg_temp
+      @obj['list'][0]['main']['temp'].round
     end
 
-    def list
-      @json['list']
+    def city_name
+      @obj['city']['name']
     end
 
-    def weather_in_days
-      arr = []
-      @json['list'].group_by{ |item| Time.at(item['dt']).strftime("%m-%d-%Y") }.each do |date,data|
-        avg_temp = data.map { |info| info['main']['temp'] }.reduce(:+)
-        avg_temp = avg_temp / 8
-        arr << { avg_temp: avg_temp, date: date }
-      end
-      current_temp = @json['list'][0]['main']['temp']
-      city_name = @json['city']['name']
-      weather_description = @json['list'][0]['weather'][0]['description']
-      current_date =  arr.first[:date].gsub('-', '/').delete_suffix('/2021') 
-      text = "#{current_temp.round(0)}°C e #{weather_description} em #{city_name} em #{current_date}. Média para os próximos dias: "
-    
-      arr.last(4).each do |item|
-        text += "#{item[:avg_temp].round(0)}°C em #{item[:date].gsub('-', '/').delete_suffix('/2021')}, "
+    def current_temp_desc
+      @obj['list'][0]['weather'][0]['description']
+    end
+
+    def current_date
+      Time.now.strftime('%d/%m')
+    end
+
+    private
+
+    def parse_avg_text
+      text = ''
+      @arr.last(5).each_with_index do |item, index|
+        text += "#{item[:avg_temp].round(0)}°C em #{parse_date(item[:date])}"
+        text += ', ' if index <= 2
+        text += ' e ' if index == 3
+        text += '.' if index == 4
       end
       text
     end
+
+    def parse_date(date)
+      date.gsub('-', '/').delete_suffix('/2021')
+    end
+
+    def url(city, api_id)
+      URI("https://api.openweathermap.org/data/2.5/forecast?q=#{city}&appid=#{api_id}&lang=pt_br&units=metric")
+    end
   end
 end

data/lib/weatherfor/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Weatherfor
-  VERSION = "0.1.0"
+  VERSION = '0.2.1'
 end

data/weatherfor.gemspec

@@ -1,31 +1,27 @@
+# frozen_string_literal: true
+
 require_relative 'lib/weatherfor/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "weatherfor"
+  spec.name          = 'weatherfor'
   spec.version       = Weatherfor::VERSION
-  spec.authors       = ["Caio Ramos"]
-  spec.email         = ["kaineo@hotmai.l."]
+  spec.authors       = ['Caio Ramos']
+  spec.email         = ['kaineo@hotmai.l.']
 
   spec.summary       = 'Api to check the average weather forecast for the next five days'
   spec.description   = 'Sumario'
-  spec.homepage      = "https://github.com/k41n3w/weatherfor"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
+  spec.homepage      = 'https://github.com/k41n3w/weatherfor'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
 
   # 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('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weatherfor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Caio Ramos
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-10 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies: []
 description: Sumario
 email:
@@ -17,9 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -35,7 +36,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/k41n3w/weatherfor
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -43,15 +44,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      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:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Api to check the average weather forecast for the next five days
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.2