seo_cache 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2c6084cfed22c86d8dae948445d042fb5bcccd8a01afac54974dfaa96181f20
-  data.tar.gz: a71c76d0d492bb9058d68a81ae8c5aa3170ef09d64192818d6f3a573453f18c9
+  metadata.gz: 91e81cc42e58735dd234bd336c165f5f98c910be1352d411328773ec665bafc3
+  data.tar.gz: 4eb8d5a45fb09013a626ad2dd1fba85dae74d93a7db47756b6761d1c1a6abc09
 SHA512:
-  metadata.gz: 454155f0bcc296c6ccd1d7d3eafa90d5a83f17a38c1d24cdd4d52a7ae44eb2dca7dc493fad4233c30b33fb6183028a39bb7e8c60baa55a61533b22ac239267fd
-  data.tar.gz: cf60d5d45b01fc2de32ee0963bd086e48859adcc6abcfee8921dcade7a38bdaae09727dfa025a49c0116f36fcff76f6adb651000293f6514db13d2415ccb223c
+  metadata.gz: a40d821a8bdeb984d5a0f52840680e76d7867bc5044805ccebe719ee485d79f9df16a98c1307704b9e869844f06e159bf96528293c4ca4383fa1fb60299970ae
+  data.tar.gz: 6bd0c086023df029305d247d48f4a0a08a0af23d85c739cce351134f21ca7e4c225f5f3ea5c4b4cad42f805ae70929f0d2984106499fa3ceb9e34d7ba4963ac0

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.0.7
+
+- Use new syntax to check if Redis key exists
+
+## 1.0.6
+
+- Logs only missed cache for success response
+
+## 1.0.5
+
+- Use correct path for index page with multiple domain names
+
+## 1.0.4
+
+- Add option to populate seo cache for multi-domains
+
 ## 1.0.3
 
 - Ensure page rendered status is present after head element 

data/README.md

@@ -227,6 +227,8 @@ end
 
 You can add the `force_cache: true` option to `SeoCache::PopulateCache` for overwrite cached data.
 
+If your website has several domains (.com, .fr, ...), you need to generate your urls for each locale (each key is the locale). And use the `with_locale_keys: true` option.
+
 If you want to execute only through a rake task, you can comment the line which include the middleware. keep all options configured and remove only the middleware. Thus all pages will be cached and SeoCache isn't called for pages not in cache.
 It's useful if you have a script which generates all website pages (based on sitemap for instance) and you run script every day.
 
@@ -275,6 +277,8 @@ location / {
     rewrite ^/(.*)/$ /$1 last;
     
     try_files /seo_cache/$uri/index$cache_extension /seo_cache/$uri$cache_extension /seo_cache/$uri $uri @rubyproxy;
+    # Or for multi-domains:
+    # try_files /seo_cache/fr/$uri/index$cache_extension /seo_cache/fr/$uri$cache_extension /seo_cache/fr/$uri $uri @rubyproxy;
 }
 
 location @rubyproxy {

data/lib/seo_cache/middleware.rb

@@ -36,9 +36,15 @@ module SeoCache
         else
           Thread.new do
             prerender_data = page_render(env)
-            # Extract status from render page or return 404
-            status = prerender_data&.scan(/<!--status:(\d+)-->/)&.last&.first
-            after_render(env, prerender_data, status || 200)
+            # Extract status from render page or return success (200)
+            status = prerender_data&.scan(/<!--status:(\d+)-->/)&.last&.first || 200
+
+            if SeoCache.log_missed_cache && status.to_s.start_with?('2')
+              env_request = Rack::Request.new(env)
+              SeoCache.log("missed cache : #{env_request.path} (User agent: #{env_request.user_agent})")
+            end
+
+            after_render(env, prerender_data, status)
           end
         end
       elsif prerender_params?(env)
@@ -94,7 +100,7 @@ module SeoCache
       return false if SeoCache.blacklist_params.present? && SeoCache.blacklist_params.any? { |param| query_params.has_key?(param) }
 
       # if it is a bot and is requesting a resource...don't prerender
-      return false if @extensions_to_ignore.any? { |extension| request.fullpath.include? extension }
+      return false if @extensions_to_ignore.any? { |extension| request.fullpath.include?(extension) }
 
       # if it is a bot and not requesting a resource and is not whitelisted...don't prerender
       return false if SeoCache.whitelist_urls.present? && SeoCache.whitelist_urls.all? { |whitelisted| !Regexp.new(whitelisted).match(request.fullpath) }

data/lib/seo_cache/page_caching.rb

@@ -17,12 +17,12 @@ module SeoCache
       @redis.get(cache_path(path, extension)) if SeoCache.memory_cache? && @redis
     end
 
-    def cache(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION)
+    def cache(content, path, locale_domain = nil, extension = nil, gzip = Zlib::BEST_COMPRESSION)
       instrument :write_page, path do
         if SeoCache.memory_cache? && @redis
-          write_to_memory(content, cache_path(path, extension))
+          write_to_memory(content, cache_path(path, extension, locale_domain))
         else
-          write_to_disk(content, cache_path(path, extension), gzip)
+          write_to_disk(content, cache_path(path, extension, locale_domain), gzip)
         end
       end
     end
@@ -35,7 +35,7 @@ module SeoCache
 
     def cache_exists?(path)
       if SeoCache.memory_cache? && @redis
-        @redis.exists(cache_path(path))
+        @redis.exists?(cache_path(path))
       else
         File.exist?(cache_path(path))
       end
@@ -51,22 +51,22 @@ module SeoCache
       SeoCache.cache_extension
     end
 
-    def cache_file(path, extension)
+    def cache_file(path, extension, locale_domain)
       name = if path.empty? || path =~ %r{\A/+\z}
                '/index'
              else
                URI::Parser.new.unescape(path.chomp('/'))
              end
 
-      if File.extname(name).empty?
-        name + (extension || default_extension)
-      else
-        name
-      end
+      name = "#{locale_domain}/#{name}" if locale_domain
+
+      name += extension || default_extension if File.extname(name).empty?
+
+      name
     end
 
-    def cache_path(path, extension = nil)
-      File.join(cache_directory, cache_file(path, extension))
+    def cache_path(path, extension = nil, locale_domain = nil)
+      File.join(cache_directory, cache_file(path, extension, locale_domain))
     end
 
     def write_to_memory(content, path)

data/lib/seo_cache/populate_cache.rb

@@ -11,23 +11,40 @@ module SeoCache
       @page_render  = PageRender.new
       @page_caching = PageCaching.new
 
-      @force_cache = options.fetch(:force_cache, false)
+      @force_cache      = options.fetch(:force_cache, false)
+      @with_locale_keys = options.fetch(:with_locale_keys, false)
     end
 
     def perform
-      @paths.each do |path|
-        next if @page_caching.cache_exists?(path) && !@force_cache
-
-        url = @host + path
-        url += path.include?('?') ? '&' : '?'
-        url += "#{SeoCache.prerender_url_param}=true"
-
-        page_source = @page_render.get(url, false)
-        @page_caching.cache(page_source, path) if page_source
+      if @with_locale_keys
+        @paths.each do |locale, paths|
+          paths.each do |path|
+            generate_cache(path, locale)
+          end
+        end
+      else
+        @paths.each do |path|
+          generate_cache(path)
+        end
       end
 
     ensure
       @page_render.close_connection
     end
+
+    private
+
+    def generate_cache(path, locale_domain = nil)
+      return if @page_caching.cache_exists?(path) && !@force_cache
+
+      url = @host + path
+      url += path.include?('?') ? '&' : '?'
+      url += "#{SeoCache.prerender_url_param}=true"
+
+      page_source = @page_render.get(url, false)
+      return unless page_source
+
+      @page_caching.cache(page_source, path, locale_domain)
+    end
   end
 end

data/lib/seo_cache/version.rb

@@ -1,3 +1,3 @@
 module SeoCache
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.0.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seo_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.27
 signing_key: 
 specification_version: 4
 summary: Cache dedicated for SEO with Javascript rendering