Merge branch 'feature/cache-redis' into develop

* feature/cache-redis:
  Added redis docker run command for cache
  Deleted config.cache_store that not working
  Added how to redis
  Added PostHelper
  Added pagaination_param for redis key
  Added redis namespece
  docker run redis
  Added after_save :clear_cache in Post
  Added fetch_categories in categories controller
  Changed redis port to 7001
  Added to_json
  https://www.sitepoint.com/rails-model-caching-redis/

Author: x1wins

Gemfile

@@ -66,4 +66,9 @@ gem 'kaminari'
 
 gem 'lograge'
 gem 'logstash-event'
-gem 'logstash-logger'
+gem 'logstash-logger'
+
+gem 'redis'
+gem 'redis-namespace'
+gem 'redis-rails'
+gem 'redis-rack-cache'

Gemfile.lock

@@ -138,6 +138,8 @@ GEM
     puma (4.3.1)
       nio4r (~> 2.0)
     rack (2.0.8)
+    rack-cache (1.11.0)
+      rack (>= 0.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.2.1)
@@ -170,6 +172,28 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    redis (4.1.3)
+    redis-actionpack (5.2.0)
+      actionpack (>= 5, < 7)
+      redis-rack (>= 2.1.0, < 3)
+      redis-store (>= 1.1.0, < 2)
+    redis-activesupport (5.2.0)
+      activesupport (>= 3, < 7)
+      redis-store (>= 1.3, < 2)
+    redis-namespace (1.7.0)
+      redis (>= 3.0.4)
+    redis-rack (2.1.0)
+      rack (>= 2.0.8, < 3)
+      redis-store (>= 1.2, < 2)
+    redis-rack-cache (2.2.1)
+      rack-cache (>= 1.10, < 2)
+      redis-store (>= 1.6, < 2)
+    redis-rails (5.0.2)
+      redis-actionpack (>= 5.0, < 6)
+      redis-activesupport (>= 5.0, < 6)
+      redis-store (>= 1.2, < 2)
+    redis-store (1.8.1)
+      redis (>= 4, < 5)
     request_store (1.5.0)
       rack (>= 1.4)
     rspec-core (3.9.1)
@@ -241,6 +265,10 @@ DEPENDENCIES
   pg (>= 0.18, < 2.0)
   puma (~> 4.1)
   rails (~> 6.0.2, >= 6.0.2.1)
+  redis
+  redis-namespace
+  redis-rack-cache
+  redis-rails
   rspec-rails (~> 3.5)
   rswag-api
   rswag-specs

README.md

@@ -4,20 +4,26 @@ How to Run
 ----------
 
 1. Ready to database
-    ```bash
-        bundle install
-    ````
-    ```bash
-        rake docker:db:init
-        rake docker:db:run
-    ```
-    ```bash
-        rake db:migrate
-        rake db:migrate RAILS_ENV=test
-    ````
-    ```bash
-        rake db:seed
-    ```
+    1. Run Postgresql and migrate
+        ```bash
+            bundle install
+        ````
+        ```bash
+            rake docker:db:init
+            rake docker:db:run
+        ```
+        ```bash
+            rake db:migrate
+            rake db:migrate RAILS_ENV=test
+        ````
+        ```bash
+            rake db:seed
+        ```
+    2. Run Redis for cache
+       ```bash
+           docker run --rm --name my-redis-container -p 7001:6379 -d redis redis-server --appendonly yes
+           redis-cli -h localhost -p 7001
+       ```
 2. ELK
     ```bash
         git clone https://github.com/deviantony/docker-elk
@@ -87,6 +93,11 @@ How what to do
 * [Log For ELK stack (Elastic Search, Logstash, Kibana)](#log-for-elk-stack-elastic-search-logstash-kibana)
     * [lograge.rb with custom config](#logragerb-with-custom-config)
     * [ELK Setup](/rails_log_with_elk_setup.md)
+* [Redis](#redis)    
+    * [server run](#server-run)    
+    * [add gem](#add-gem)    
+    * [config](#config)    
+    * [how to added cache](#how-to-added-cache)    
 
 ### Build Json with active_model_serializers Gem
 1. Gemfile
@@ -317,3 +328,74 @@ https://ericlondon.com/2017/01/26/integrate-rails-logs-with-elasticsearch-logsta
 ```
          
 #### [ELK Setup](/rails_log_with_elk_setup.md)
+
+### Redis
+#### server run
+```bash
+docker run --rm --name my-redis-container -p 7001:6379 -d redis redis-server --appendonly yes
+redis-cli -h localhost -p 7001
+```
+
+#### add gem
+```ruby
+gem 'redis'
+gem 'redis-namespace'
+gem 'redis-rails'
+gem 'redis-rack-cache'
+```
+
+#### config
+```ruby
+# config/initializers/redis.rb
+
+$redis = Redis::Namespace.new("tutorial_post", :redis => Redis.new(:host => '127.0.0.1', :port => 7001))
+
+```
+
+#### how to added cache
+```ruby
+  # GET /categories
+  def index
+    page = params[:page].present? ? params[:page] : 1
+    per = params[:per].present? ? params[:per] : 10
+    pagaination_param = {
+        category_page: page,
+        category_per: per,
+        post_page: @post_page,
+        post_per: @post_per
+    }
+    @categories = fetch_categories pagaination_param
+    render json: @categories
+  end
+```
+
+```ruby
+    class Category < ApplicationRecord
+      include CategoryHelper
+      ...your code
+      after_save :clear_cache
+    end
+```
+
+```ruby
+    # app/helpers/category_helper.rb
+    module CategoryHelper
+      def fetch_categories pagaination_param
+        page = pagaination_param[:category_page]
+        per = pagaination_param[:category_per]
+        key = "categories"+pagaination_param.to_s
+        categories =  $redis.get(key)
+        if categories.nil?
+          @categories = Category.published.by_date.page(page).per(per)
+          categories = Pagination.build_json(@categories, pagaination_param).to_json
+          $redis.set(key, categories)
+          $redis.expire(key, 1.hour.to_i)
+        end
+        categories
+      end
+      def clear_cache
+        keys = $redis.keys "*categories*"
+        keys.each {|key| $redis.del key}
+      end
+    end
+```

app/controllers/categories_controller.rb

@@ -1,4 +1,5 @@
 class CategoriesController < ApplicationController
+  include CategoryHelper
   before_action :authorize_request
   before_action :post_pagination_params, only: [:index, :show]
   before_action except: [:index, :show] do
@@ -13,12 +14,14 @@ class CategoriesController < ApplicationController
   def index
     page = params[:page].present? ? params[:page] : 1
     per = params[:per].present? ? params[:per] : 10
-    @categories = Category.published.by_date.page(page).per(per)
     pagaination_param = {
+        category_page: page,
+        category_per: per,
         post_page: @post_page,
         post_per: @post_per
     }
-    render json: Pagination.build_json(@categories, pagaination_param)
+    @categories = fetch_categories pagaination_param
+    render json: @categories
   end
 
   # GET /categories/1

app/controllers/posts_controller.rb

@@ -1,4 +1,5 @@
 class PostsController < ApplicationController
+  include PostHelper
   before_action :authorize_request
   before_action :comment_pagination_params, only: [:index, :show]
   before_action :set_post, only: [:show, :update, :destroy]
@@ -13,12 +14,16 @@ def index
     page = params[:page].present? ? params[:page] : 1
     per = params[:per].present? ? params[:per] : 10
     @category = Category.published.find(category_id) if category_id.present?
-    @posts = Post.category(category_id).search(search).published.by_date.page(page).per(per)
     pagaination_param = {
+        category_id: category_id,
+        search: search,
+        post_page: page,
+        post_per: per,
         comment_page: @comment_page,
         comment_per: @comment_per
     }
-    render json: Pagination.build_json(@posts, pagaination_param)
+    @posts = fetch_posts pagaination_param
+    render json: @posts
   end
 
   # GET /posts/1

app/helpers/category_helper.rb

@@ -0,0 +1,21 @@
+# app/helpers/category_helper.rb
+
+module CategoryHelper
+  def fetch_categories pagaination_param
+    page = pagaination_param[:category_page]
+    per = pagaination_param[:category_per]
+    key = "categories"+pagaination_param.to_s
+    categories =  $redis.get(key)
+    if categories.nil?
+      @categories = Category.published.by_date.page(page).per(per)
+      categories = Pagination.build_json(@categories, pagaination_param).to_json
+      $redis.set(key, categories)
+      $redis.expire(key, 1.hour.to_i)
+    end
+    categories
+  end
+  def clear_cache
+    keys = $redis.keys "*categories*"
+    keys.each {|key| $redis.del key}
+  end
+end

app/helpers/post_helper.rb

@@ -0,0 +1,23 @@
+# app/helpers/post_helper.rb
+
+module PostHelper
+  def fetch_posts pagaination_param
+    category_id = pagaination_param[:category_id]
+    search = pagaination_param[:search]
+    page = pagaination_param[:post_page]
+    per = pagaination_param[:post_per]
+    key = "posts"+pagaination_param.to_s
+    posts =  $redis.get(key)
+    if posts.nil?
+      @posts = Post.category(category_id).search(search).published.by_date.page(page).per(per)
+      posts = Pagination.build_json(@posts, pagaination_param).to_json
+      $redis.set(key, posts)
+      $redis.expire(key, 1.hour.to_i)
+    end
+    posts
+  end
+  def clear_cache_posts
+    keys = $redis.keys "*posts*"
+    keys.each {|key| $redis.del key}
+  end
+end

app/models/category.rb

@@ -1,8 +1,10 @@
 class Category < ApplicationRecord
+  include CategoryHelper
   belongs_to :user
   has_many :posts
   scope :published, -> { where(published: true) }
   scope :by_date, -> { order('created_at DESC, id DESC') }
   validates :title, presence: true
   validates :body, presence: true
+  after_save :clear_cache
 end

app/models/post.rb

@@ -1,4 +1,6 @@
 class Post < ApplicationRecord
+  include CategoryHelper
+  include PostHelper
   belongs_to :category
   belongs_to :user
   has_many :comments
@@ -7,4 +9,6 @@ class Post < ApplicationRecord
   scope :published, -> { where(published: true) }
   scope :by_date, -> { order('created_at DESC, id DESC') }
   validates :body, presence: true
+  after_save :clear_cache
+  after_save :clear_cache_posts
 end

config/initializers/redis.rb

@@ -0,0 +1,3 @@
+# config/initializers/redis.rb
+
+$redis = Redis::Namespace.new("tutorial_post", :redis => Redis.new(:host => '127.0.0.1', :port => 7001))