open_weather_client-caching-redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ceb73bb4309bdc88a064ee79b12a8685b2d5114c5721be3010158804566faaac
+  data.tar.gz: 55a673a1fb0e6a1f534cbe8b4f6f6a14c25ef5ddca5c422dab42978212a36e20
+SHA512:
+  metadata.gz: 2754c61e3690326078ecd33dc63f97cb78702f8137999cd850170beaaa588038d38be5bf9af6b0f1bdd2f5ddfdbf2454f18e24d44aa8ab0ca1ede2392f3a7e97
+  data.tar.gz: f716fa8a5b89542b0d951324f39429e63fde967cf1187003df9888e8913b179053b6d30c9e12dca1e6b4cb4f6176fd05e45dc2600e561149eded1a92c18d31ba

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - '*.gemspec'

data/CHANGES.md

@@ -0,0 +1,7 @@
+# OpenWeatherClient::Caching::Redis Changelog
+
+## [Unreleased]
+
+## [0.1.0]
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in open_weather_client-caching-redis.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Qurasoft GmbH
+
+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,82 @@
+# OpenWeatherClient::Caching::Redis
+
+[![Gem Version](https://badge.fury.io/rb/open_weather_client-caching-redis.svg)](https://badge.fury.io/rb/open_weather_client-caching-redis)
+![RSpec](https://github.com/qurasoft/open_weather_client-caching-redis/actions/workflows/ruby.yml/badge.svg)
+
+Welcome to OpenWeatherClient::Caching::Redis.
+This gem provides the redis caching method for [OpenWeatherClient](https://github.com/qurasoft/open_waether_client).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_weather_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_weather_client-caching-redis
+
+## Usage
+
+Configure `OpenWeatherClient` to use redis caching.
+The redis connection can be configured through rails credentials or by manually setting the parameters in configuration.
+
+```ruby
+# OpenWeatherClient initializer
+OpenWeatherClient.configure do |config|
+  config.caching = OpenWeatherClient::Caching::Redis
+  # Time in days until cached requests are expired, default: 7
+  config.ttl = 14
+  
+  # redis connection configuration
+  config.db = 0
+  config.host = 'localhost'
+  config.password = '123456'
+  config.port = 6379
+end
+```
+
+### Secure Configuration
+
+```yaml
+# $ bin/rails credentials:edit
+open_weather_client:
+  appid: "<INSERT OPENWEATHERMAP API KEY HERE>"
+  redis:
+    db: 0
+    host: 'localhost'
+    password: '123456'
+    port: 6379
+```
+
+After configuration of the credentials you can load the settings in your initializer with `#load_from_rails_configuration`.
+
+```ruby
+# OpenWeatherClient initializer
+OpenWeatherClient.configure do |config|
+  config.load_from_rails_credentials
+end
+```
+
+## 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/qurasoft/open_weather_client-caching-redis.
+
+## 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 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/open_weather_client-caching-redis/caching/redis/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OpenWeatherClient
+  class Caching
+    class Redis < OpenWeatherClient::Caching
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/open_weather_client-caching-redis/caching/redis.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'open_weather_client/caching'
+require 'open_weather_client-caching-redis/configuration'
+require 'redis'
+require_relative 'redis/version'
+
+module OpenWeatherClient
+  class Caching
+    ##
+    # Redis cache of OpenWeatherMap requests
+    #
+    # The requests are cached in redis with an expiration time set by the configuration
+    class Redis < OpenWeatherClient::Caching
+      attr_reader :redis
+
+      def initialize
+        super
+
+        config = OpenWeatherClient.configuration
+        @redis = ::Redis.new(host: config.host, port: config.port, db: config.db)
+      end
+
+      private
+
+      def caching_get(key)
+        JSON.parse(redis.get(key))
+      end
+
+      def caching_store(key, data)
+        redis.set key, data.to_json, ex: OpenWeatherClient.configuration.ttl * 24 * 60 * 60
+
+        data
+      end
+
+      def present?(key)
+        redis.exists?(key)
+      end
+    end
+  end
+end

data/lib/open_weather_client-caching-redis/configuration.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'open_weather_client/configuration'
+
+module OpenWeatherClient
+  ##
+  # Configuratin of OpenWeatherClient
+  class Configuration
+    # [Integer] db of the redis server used for caching
+    attr_accessor :db
+    # [String] host of the redis server
+    attr_accessor :host
+    # [Integer] password of the redis server
+    attr_accessor :password
+    # [Integer] port of the redis server
+    attr_accessor :port
+    # [Integer] The time in days until an entry cached in redis is expired
+    attr_accessor :ttl
+
+    alias old_initialize initialize
+
+    def initialize
+      old_initialize
+
+      self.ttl = 7
+    end
+
+    alias old_load load_from_rails_credentials
+
+    def load_from_rails_credentials
+      old_load
+
+      settings = Rails.application.credentials.open_weather_client!.redis!
+      self.host = settings[:host]
+      self.port = settings[:port]
+      self.db = settings[:db]
+      self.password = settings[:password]
+    end
+  end
+end

data/open_weather_client-caching-redis.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/open_weather_client-caching-redis/caching/redis/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'open_weather_client-caching-redis'
+  spec.version = OpenWeatherClient::Caching::Redis::VERSION
+  spec.required_ruby_version = '>= 3.0.0'
+  spec.authors = ['Lucas Keune']
+  spec.email = ['lucas.keune@qurasoft.de']
+
+  spec.summary = 'Redis caching for OpenWeatherClient'
+  spec.description = ''
+  spec.homepage = 'https://github.com/Qurasoft/open_weather_client-caching-redis'
+  spec.license = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Qurasoft/open_weather_client-caching-redis'
+  spec.metadata['changelog_uri'] = 'https://github.com/Qurasoft/open_weather_client-caching-redis/blob/main/CHANGES.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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'open_weather_client', '>= 0.1.4'
+  spec.add_dependency 'redis', '>= 4.5.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: open_weather_client-caching-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Keune
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open_weather_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- lucas.keune@qurasoft.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/open_weather_client-caching-redis/caching/redis.rb
+- lib/open_weather_client-caching-redis/caching/redis/version.rb
+- lib/open_weather_client-caching-redis/configuration.rb
+- open_weather_client-caching-redis.gemspec
+homepage: https://github.com/Qurasoft/open_weather_client-caching-redis
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Qurasoft/open_weather_client-caching-redis
+  source_code_uri: https://github.com/Qurasoft/open_weather_client-caching-redis
+  changelog_uri: https://github.com/Qurasoft/open_weather_client-caching-redis/blob/main/CHANGES.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: Redis caching for OpenWeatherClient
+test_files: []