open_weather_client 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dec682ab56d84b58d75c7cee7e1741ea87e5a38e8cedec1ef927b35014108be
-  data.tar.gz: ed092b5ca8ddeb5bffdb77d1abcacbb52cc5c37a317cee41aacd4063fd680a25
+  metadata.gz: 17bf8dfad870e88aaf543056800194275c1571aca109a24cc622a22b79b8d045
+  data.tar.gz: f3636d87638a6567c008e30ac0cebb557cc0835f3d1c56217a6164b57ac2b1e9
 SHA512:
-  metadata.gz: 84de4f4266c121d44033694c6dbca2519db1f87976dd420ec64711831e45957ceb827a33b60a30a045ac6b7734760c85f7404654332c4d22fd9a7fb1423c05be
-  data.tar.gz: 037bcb2ff6e0fdf53023520b290fc0cfc821c0184a94208dfd9d108a86852998d5af7ff23a1aa4d8ceb73f2dacc46d9bb64d0e01a7e096c198ff121aab7a2fff
+  metadata.gz: 0c00a702fbedee69d3860d6dc1c0c99ffaf3dd51be0c0db3dadddf5f7aba2739cc015bb8a0c641f280433754a97a77d0cebd4a40ae355a85a8c6c1e6bdcf187a
+  data.tar.gz: 61fc3ea2ef6ed2a72adfa45281ce63169643598cad654b42f74665e415329da934b0dee9b80c8d26ebc7ac7bd581db840b512a3fa86b0cf7bc26ba4434ab818c

data/.github/workflows/ruby.yml

@@ -15,21 +15,17 @@ on:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0']
+        ruby-version: ['3.0', '3.2']
 
     steps:
-    - uses: actions/checkout@v2
+    - 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@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
+        bundler-cache: true
+    - name: Run the default task
       run: bundle exec rake

data/.rubocop.yml

@@ -4,3 +4,7 @@ AllCops:
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
+
+Layout/LineLength:
+  Exclude:
+    - spec/**/*

data/CHANGES.md

@@ -1,4 +1,12 @@
-# Open Weather Client Changelog
+# OpenWeatherClient Changelog
+
+## [Unreleased]
+
+## 0.1.4
+- Add rubocop rake task
+- Run Github actions for ruby 3.2
+- Change cache key format to `weather:<lat>:<lon>:<time}>` for better compatibility with redis
+- Make `OpenWeatherClient::Caching#cache_key` public
 
 ## 0.1.3
 Re-release of 0.1.2 since this version was released from an incorrect branch.

data/Gemfile

@@ -2,7 +2,5 @@
 
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
 # Specify your gem's dependencies in open_weather_client.gemspec
 gemspec

data/README.md

@@ -3,7 +3,8 @@
 [![Gem Version](https://badge.fury.io/rb/open_weather_client.svg)](https://badge.fury.io/rb/open_weather_client)
 ![RSpec](https://github.com/qurasoft/open_weather_client/actions/workflows/ruby.yml/badge.svg)
 
-Welcome to Open Weather Client. This gem allows you to easily request weather information from OpenWeatherMap.
+Welcome to Open Weather Client.
+This gem allows you to easily request weather information from OpenWeatherMap.
 It integrates in your rails project, when you are using bundler or even in plain ruby projects.
 
 ## Installation
@@ -69,12 +70,16 @@ Whether requests are only performed when the requested time is within the last h
 If caching is enabled, requests with a time older than one hour might still be answered with a response.
 
 ```ruby
+# OpenWeatherClient initializer
 OpenWeatherClient.configure do |config|
   config.caching = OpenWeatherClient::Caching::Memory
   config.max_memory_entries = 100 # Maximum number of entries in memory cache
 end
 ```
 
+### Cache key
+The cache key for a given latitute, longitude and time is calculated by `OpenWeatherClient::Caching#cache_key(lat, lon, time)`.
+
 #### Memory Caching
 `OpenWeatherClient` supports simple in memory caching.
 A hash is used to store and look up the cached responses.
@@ -93,6 +98,7 @@ The quantization receives latitude and longitude.
 The result is coerced back into latitude and longitude.
 
 ```ruby
+# OpenWeatherClient initializer
 OpenWeatherClient.configure do |config|
   config.spatial_quantization = proc { |lat, lon| [lat.round(2), lon.round(2)] }
 end

data/Rakefile

@@ -5,4 +5,8 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/open_weather_client/caching.rb

@@ -44,8 +44,6 @@ module OpenWeatherClient
       data
     end
 
-    private
-
     ##
     # Calculate the key for storage in the cache
     #
@@ -53,9 +51,11 @@ module OpenWeatherClient
     # @param lon[Float] longitude of the requests location
     # @param time[Time] time of the request
     def cache_key(lat, lon, time)
-      "#{lat}_#{lon}_#{time.strftime('%Y-%m-%dT%H')}"
+      "weather:#{lat}:#{lon}:#{time.strftime('%Y-%m-%dT%H')}"
     end
 
+    private
+
     ##
     # Read an entry out of the memory cache
     #
@@ -71,11 +71,11 @@ module OpenWeatherClient
     #
     # Evicts the entry with the least recent access if the memory cache is full
     #
-    # @param key[String] key into the cache. Is stored at the end of the key registry
+    # @param _key[String] key into the cache. Is stored at the end of the key registry
     # @param data[Hash] data to be stored, must be able to be formatted and parsed as text
     #
     # @return [Hash] the input data
-    def caching_store(key, data)
+    def caching_store(_key, data)
       data
     end
 

data/lib/open_weather_client/request.rb

@@ -20,29 +20,39 @@ module OpenWeatherClient
     def self.get(lat:, lon:, time: Time.now)
       raise OpenWeatherClient::NotCurrentError if time < Time.now - 1 * 60 * 60
 
-      connection = Faraday.new(
+      begin
+        response = connection(lat, lon).get('2.5/weather')
+        OpenWeatherClient.cache.store(lat: lat, lon: lon, data: response.body, time: time)
+      rescue Faraday::UnauthorizedError
+        raise OpenWeatherClient::AuthenticationError
+      end
+    end
+
+    def self.connection(lat, lon)
+      Faraday.new(
         url: OpenWeatherClient.configuration.url,
-        params: {
-          appid: OpenWeatherClient.configuration.appid,
-          lat: lat,
-          lon: lon,
-          lang: OpenWeatherClient.configuration.lang,
-          units: OpenWeatherClient.configuration.units
-        },
-        headers: {
-          'User-Agent': OpenWeatherClient.configuration.user_agent
-        }
+        params: params(lat, lon),
+        headers: headers
       ) do |f|
         f.response :raise_error
         f.response :json
       end
+    end
 
-      begin
-        response = connection.get('2.5/weather')
-        OpenWeatherClient.cache.store(lat: lat, lon: lon, data: response.body, time: time)
-      rescue Faraday::UnauthorizedError
-        raise OpenWeatherClient::AuthenticationError
-      end
+    def self.headers
+      {
+        'User-Agent': OpenWeatherClient.configuration.user_agent
+      }
+    end
+
+    def self.params(lat, lon)
+      {
+        appid: OpenWeatherClient.configuration.appid,
+        lat: lat,
+        lon: lon,
+        lang: OpenWeatherClient.configuration.lang,
+        units: OpenWeatherClient.configuration.units
+      }
     end
   end
 end

data/lib/open_weather_client/version.rb

@@ -3,5 +3,5 @@
 module OpenWeatherClient
   ##
   # Version of OpenWeatherClient
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/open_weather_client.gemspec

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'open_weather_client/version'
+require_relative 'lib/open_weather_client/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'open_weather_client'
   spec.version       = OpenWeatherClient::VERSION
-  spec.required_ruby_version = '>= 3.0'
-  spec.required_rubygems_version = '>= 2'
+  spec.required_ruby_version = '>= 3.0.0'
   spec.authors       = ['Lucas Keune']
   spec.email         = ['lucas.keune@qurasoft.de']
 
@@ -23,7 +20,7 @@ Gem::Specification.new do |spec|
 
   # 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(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'bin'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_weather_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Lucas Keune
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -156,12 +156,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2'
+      version: '0'
 requirements: []
 rubygems_version: 3.4.1
 signing_key: