owmo 2.1.1 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125a82a8915262a016d7b78461f403abf325d76d177d97700e1be023ad3e22eb
-  data.tar.gz: 6d47d5e59c2d3b31322a478dc252a33cfdbc88139d86d641f29cc67861d9c88c
+  metadata.gz: 7206b29a014088dd08403d1199d6b410a4d2d2e7dd1087290058d542add26f79
+  data.tar.gz: 0115ffba7abd0eca441f6117c2cb20561a09c2556b606af56c1cde829372fe7c
 SHA512:
-  metadata.gz: a574a3a6a6b8f81bb77da1a4e8f10809fe8f43012b214061c269c7c91c22768543357e280d18cc7ef72e0f2cce04f9af35ae3c70c3370f5364257cae4fdd79eb
-  data.tar.gz: 9a93faefecb90ae2147ef9d20b2fe1f280ba582fba580e8588d7bf6084ab2e9b400e9b0a2e162c0dfc5efac105860fa8b15e28850d26c4215c7d96c80db4640d
+  metadata.gz: 48059ce954439c46e4c19edc050c9b0d8193caf6b9e464726b255f88aa42b5591dc69b6bbd17c227728bf89a16e4c8adfe744ad0891d1f9bd448c6250ceadc01
+  data.tar.gz: 73af163549823603d7222ed682367c91baa4dab7276bd2bcd318ede49e435b03c4480abb318e3425cec3a5ace4dd8f5c393a5591622c519a8cc75c8e86a9c5e6

data/.github/workflows/{ruby-publish-gem.yml → rake-release.yml}

@@ -1,4 +1,4 @@
-name: Publish Gem
+name: Publish to Rubygems
 
 on:
   push:
@@ -13,9 +13,9 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Release Gem
+      - name: Publish to Rubygems
         if: contains(github.ref, 'refs/tags/v')
-        uses: cadwallion/publish-rubygems-action@master
+        uses: cadwallion/publish-rubygems-action@v1.0.0
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.github/workflows/rake.yml

@@ -0,0 +1,23 @@
+name: Ruby CI
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.0', '2.7']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -13,6 +13,5 @@
 
 
 *.gem
-test.rb
-scratch.rb
 api_key.txt
+coverage

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+

data/Gemfile

@@ -4,5 +4,12 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rake_tasks', '>= 5.x'
+
 gem 'rspec'
+
+gem 'rubocop', require: false
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false
+
 gem 'simplecov', require: false, group: :test

data/Rakefile

@@ -2,7 +2,12 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new :spec
 
-task default: :spec
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rake'
+end
+
+task default: %i[rubocop spec]

data/bin/examples

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'owmo'
+
+# Read the API key
+api_key_file = 'api_key.txt'
+
+unless File.exist? api_key_file
+  puts %(
+    File `#{api_key_file}` does not exist in the root of the repository.
+    Please create the file with your OpenWeatherMap API key and rerun bin/example.
+
+      # #{api_key_file} << cat '<your api key>'
+  )
+  exit(1)
+end
+
+api_key = File.read(api_key_file).chomp
+
+unless api_key.length == 32
+  puts %(
+    File `#{api_key_file}` does not contain a valid OpenWeatherMap API key.
+    Please update the file with a valid key and rerun bin/example.
+
+    Found: '#{api_key}'
+  )
+  exit(1)
+end
+
+examples = {
+  'current_box' => { path: :box, query: { bbox: [12, 32, 15, 37, 10].join(',') } },
+  'current_circle' => { path: :circle, query: { lat: 55.5, lon: 37.5, cnt: 10 } },
+  'current_group' => { path: :group,
+                       query: { id: [4_850_751, 4_887_398, 2_643_743, 4_164_138, 5_368_361].join(',') } },
+  'forecast16 by city_name' => { path: :forecast16, query: { city_name: 'London,UK' } },
+  'forecast5 by city_name' => { path: :forecast5, query: { city_name: 'London,UK' } },
+  'current by city_name, (json/imperial/fr)' => { path: :current,
+                                                  query: { city_name: 'London,UK', mode: 'json', units: 'imperial',
+                                                           lang: 'fr' } },
+  'current by city_id' => { path: :current, query: { city_id: 5_328_041 } },
+  'current by city_name' => { path: :current, query: { city_name: 'Beverly Hills' } },
+  'current by id' => { path: :current, query: { id: 5_328_041 } },
+  'current by lon/lat' => { path: :current, query: { lon: -118.41, lat: 34.09 } },
+  'current by q' => { path: :current, query: { q: 'Beverly Hills' } },
+  'current by zip' => { path: :current, query: { zip: 90_210 } },
+  'current by zip_code' => { path: :current, query: { zip_code: 90_210 } },
+  'current by city_name (html)' => { path: :current, query: { city_name: 'London,UK', mode: :html } },
+  'current by city_name (json)' => { path: :current, query: { city_name: 'London,UK', mode: :json } },
+  'current by city_name (xml)' => { path: :current, query: { city_name: 'London,UK', mode: :xml } },
+  'current by city_name (imperial)' => { path: :current, query: { city_name: 'London,UK', units: :imperial } },
+  'current by city_name (metric)' => { path: :current, query: { city_name: 'London,UK', units: :metric } }
+}
+
+execution_output = {}
+
+puts "OWMO Version #{OWMO::VERSION}"
+
+OWMO.weather(api_key) do |weather|
+  examples.each do |name, params|
+    puts '', '/********************', name, '********************/'
+    begin
+      pp weather.get params[:path], **params[:query]
+      execution_output[name] = 'SUCCESS'
+    rescue StandardError => e
+      pp e.message
+      execution_output[name] = 'FAILURE'
+    end
+  end
+end
+
+puts "\n\nSummary:"
+execution_output.each do |name, outcome|
+  puts "  - [#{outcome}] #{name.capitalize}"
+end

data/bin/rake

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -8,12 +8,12 @@
 # this file is here to facilitate running it.
 #
 
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
-bundle_binstub = File.expand_path("bundle", __dir__)
+bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -21,7 +21,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("rspec-core", "rspec")
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/lib/owmo/version.rb

@@ -3,5 +3,5 @@
 module OWMO
   # rdoc
   # Gem Version
-  VERSION = '2.1.1'
+  VERSION = '2.1.5'
 end

data/lib/owmo/weather.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'core_extensions/net/http_response/weather_response'
+require 'owmo/weather_response'
 
 require 'json'
 require 'logger'
@@ -19,8 +19,8 @@ module OWMO
     # rdoc
     # Weather response error to handle errors received from OpenWeatherMap.orgs API
     class WeatherResponseError < StandardError
-      def initialize(response)
-        super("ERROR #{response.weather_code}: #{response.message}")
+      def initialize(weather_response)
+        super("ERROR #{weather_response.code}: #{weather_response.weather}")
       end
     end
 
@@ -84,11 +84,13 @@ module OWMO
       uri = format_uri(OWMO::URL, PATHS[path], query)
 
       # Get the weather data
-      response = http_get(uri)
+      http_response = http_get(uri)
 
-      raise(WeatherResponseError, response) if response.error?
+      weather_response = WeatherResponse.new(http_response)
 
-      response.weather
+      raise(WeatherResponseError, weather_response) if weather_response.error?
+
+      weather_response.weather
     end
 
     private
@@ -119,11 +121,9 @@ module OWMO
     # Sends the GET request to OpenWeatherMap.org
     # :nocov:
     def http_get(uri)
-      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+      Net::HTTP.start(uri.hostname, uri.port) do |http|
         http.request(Net::HTTP::Get.new(uri))
       end
-
-      response
     end
   end
   # :nocov:

data/lib/owmo/weather_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module OWMO
+  # Weather response class
+  class WeatherResponse
+    attr_reader :weather, :code
+
+    def initialize(http_response)
+      # JSON
+      @weather = JSON.parse(http_response.body)
+      @code = parse_code
+    rescue JSON::ParserError, TypeError
+      # Assume XML or HTML
+      @weather = http_response.body
+      @code = weather.length > 10 ? 200 : 500
+    end
+
+    def error?
+      code != 200
+    end
+
+    private
+
+    def parse_code
+      if weather.key? 'cod'
+        weather['cod'].to_i
+      elsif weather.key? 'cnt'
+        weather['cnt'].to_i >= 0 ? 200 : 500
+      else
+        500
+      end
+    end
+  end
+end

data/owmo.gemspec

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# coding: utf-8
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -24,7 +23,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.7'
   spec.add_development_dependency 'bundler', '~> 2.x'
   spec.add_development_dependency 'rake', '~> 13.x'
   spec.add_development_dependency 'rspec', '~> 3.x'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owmo
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.5
 platform: ruby
 authors:
 - Robb Randall
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,10 +59,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby-publish-gem.yml"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/rake-release.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CONTRIBUTING.MD
 - Gemfile
@@ -71,7 +72,10 @@ files:
 - Rakefile
 - _config.yml
 - bin/console
+- bin/examples
+- bin/rake
 - bin/rspec
+- bin/rubocop
 - bin/setup
 - examples/current.rb
 - examples/current_box.rb
@@ -84,15 +88,16 @@ files:
 - examples/query_mode.rb
 - examples/query_units.rb
 - examples/sinatra_example.rb
-- lib/core_extensions/net/http_response/weather_response.rb
 - lib/owmo.rb
 - lib/owmo/version.rb
 - lib/owmo/weather.rb
+- lib/owmo/weather_response.rb
 - owmo.gemspec
 homepage: https://github.com/robb-randall/owmo
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -101,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/ruby.yml

@@ -1,38 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/lib/core_extensions/net/http_response/weather_response.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'net/http'
-
-module CoreExtensions
-  module Net
-    module HTTPResponse
-      module WeatherResponse
-        # rdoc
-        # Returns the weather
-        def weather
-          parse_weather
-          @weather
-        end
-
-        # rdoc
-        # Returns the response code
-        def weather_code
-          parse_weather
-
-          return (weather['cod'] || '500').to_i if weather.is_a? Hash
-
-          200
-        end
-
-        # rdoc
-        # Returns the response message
-        def weather_message
-          parse_weather
-          return weather['message'] if weather.is_a? Hash
-
-          'None'
-        end
-
-        # rdoc
-        # Returns boolean if the response contains an error or not.
-        def error?
-          weather_code != 200
-        end
-
-        private
-
-        # rdoc
-        # Sets the weather variable
-        def weather=(weather)
-          @weather = weather if @weather.nil?
-        end
-
-        # rdoc
-        # Attempts to parse the body to JSON.  This is so we don't have to continually
-        # parse the raw JSON.
-        def parse_weather
-          # Try to parse the response and return a hash
-          @weather = JSON.parse(body)
-        rescue StandardError
-          # Return the body string if parsing fails (used for html and xml responses)
-          @weather = body
-        end
-      end
-    end
-  end
-end
-
-Net::HTTPResponse.include CoreExtensions::Net::HTTPResponse::WeatherResponse