Add redis caching

Gemfile

@@ -13,6 +13,7 @@ gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
 
 gem 'bootsnap', require: false
 gem 'pony_breeds', '~> 0.1.6'
+gem 'redis', '~> 5.0'
 gem 'rspec', '~> 3.0'
 gem 'rspec-rails', '~> 6.0'
 gem 'rswag', '~> 2.11.0'

Gemfile.lock

@@ -74,6 +74,7 @@ GEM
       msgpack (~> 1.2)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.3)
     diff-lcs (1.5.0)
@@ -156,6 +157,10 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    redis (5.0.8)
+      redis-client (>= 0.17.0)
+    redis-client (0.17.1)
+      connection_pool
     regexp_parser (2.8.1)
     rexml (3.2.6)
     rspec (3.12.0)
@@ -227,6 +232,7 @@ DEPENDENCIES
   pony_breeds (~> 0.1.6)
   puma (~> 5.0)
   rails (~> 7.0.8)
+  redis (~> 5.0)
   rspec (~> 3.0)
   rspec-rails (~> 6.0)
   rswag (~> 2.11.0)

app/controllers/api/v1/pony_breeds_controller.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'pony/breeds/read_pony_data'
+require 'pony/breeds/redis_caching'
 
 module Api
   module V1
@@ -16,7 +17,9 @@ def random_pony
       end
 
       def pony_by_name
-        @result = Pony::Breeds::ReadPonyData.get_pony_by_name(params[:name])
+        @result = Pony::Breeds::RedisCaching.instance.cache_data("pony_by_name-#{params[:name]}") do
+          Pony::Breeds::ReadPonyData.get_pony_by_name(params[:name])
+        end
 
         if @result.nil?
           render json: "No data available for the following name: '#{params[:name]}'"
@@ -26,7 +29,9 @@ def pony_by_name
       end
 
       def pony_by_key
-        @result = Pony::Breeds::ReadPonyData.get_pony_by_key(params[:key])
+        @result = Pony::Breeds::RedisCaching.instance.cache_data("pony_by_key-#{params[:key]}") do
+          Pony::Breeds::ReadPonyData.get_pony_by_key(params[:key])
+        end
 
         if @result.nil?
           render json: "No data available for the following key: '#{params[:key]}'"

app/controllers/concerns/pony/breeds/redis_caching.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Pony
+  module Breeds
+    class RedisCaching
+      include Singleton
+
+      def initialize
+        @redis = Redis.new(url: redis_config[:url])
+        @redis.ping
+      rescue StandardError => e
+        Rails.logger.error "Encountered an error while initializing Redis: '#{e.message}'."
+      end
+
+      def cache_data(key)
+        return yield unless redis_connected?
+
+        response = @redis.get(key)
+
+        if response.nil?
+          unless yield.nil?
+            @redis.setex(key, 604_800, yield.to_json)
+
+            return yield.to_json
+          end
+
+          return yield
+        end
+
+        response
+      end
+
+      private
+
+      def redis_config
+        Rails.configuration.redis
+      end
+
+      def redis_connected?
+        true if @redis.connected?
+      end
+    end
+  end
+end

config/environments/development.rb

@@ -29,7 +29,7 @@
   else
     config.action_controller.perform_caching = false
 
-    config.cache_store = :null_store
+    config.cache_store = :redis_cache_store
   end
 
   # Don't care if the mailer can't send.

config/environments/production.rb

@@ -48,7 +48,7 @@
   config.log_tags = [:request_id]
 
   # Use a different cache store in production.
-  # config.cache_store = :mem_cache_store
+  config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'] }
 
   # Use a real queuing backend for Active Job (and separate queues per environment).
   # config.active_job.queue_adapter     = :resque

config/initializers/app_config.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  redis_config = config_for(:redis_config).symbolize_keys
+  config.redis = redis_config
+end

config/redis_config.yml

@@ -0,0 +1,11 @@
+defaults: &base
+  host: <%= ENV['REDIS_HOST'] || '127.0.0.1' %>
+  port: <%= ENV['REDIS_PORT'] || '6379' %>
+  url: <%= ENV['REDIS_URL'] %>
+
+development:
+  <<: *base
+test:
+  <<: *base
+production:
+  <<: *base