seo_cache 1.0.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e81cc42e58735dd234bd336c165f5f98c910be1352d411328773ec665bafc3
-  data.tar.gz: 4eb8d5a45fb09013a626ad2dd1fba85dae74d93a7db47756b6761d1c1a6abc09
+  metadata.gz: 257a485a274532a58693567428f24615cf4f1c4ad9f45546d81b6ed26b2352c2
+  data.tar.gz: 6fe1ac814ab110ab97aca70682cdf4cff66cebc3449b6abd14594417bd26876d
 SHA512:
-  metadata.gz: a40d821a8bdeb984d5a0f52840680e76d7867bc5044805ccebe719ee485d79f9df16a98c1307704b9e869844f06e159bf96528293c4ca4383fa1fb60299970ae
-  data.tar.gz: 6bd0c086023df029305d247d48f4a0a08a0af23d85c739cce351134f21ca7e4c225f5f3ea5c4b4cad42f805ae70929f0d2984106499fa3ceb9e34d7ba4963ac0
+  metadata.gz: a5d651a0568691b994fdd94d76c52a8b6c83907e91dd8e95edcdf380cca1e994a7929e0ac92b94a0658be46f4564e33367bc6413c657fc9bcd372062362e922a
+  data.tar.gz: cbdbc8ba5ced409d94ddd0fed596c768042a32b1fd9ae861d2e0d2f5c406a51b447856a1005a9eded8b6ede343eeeac8acf9b6914fd4278688819d170b093204

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.1.2
+
+- Do not try to cache invalid requests
+
+## 1.1.2
+
+- Correct populate seo cache method
+
+## 1.1.1
+
+- Add new option to use locale as first directory for cache path
+
+## 1.1.0
+
+- Update dependencies
+
 ## 1.0.7
 
 - Use new syntax to check if Redis key exists

data/lib/seo_cache/middleware.rb

@@ -16,52 +16,39 @@ module SeoCache
     end
 
     def call(env)
-      if prerender_page?(env)
+      @status, @headers, @response = @app.call(env)
+
+      if prerender_page?(env, @status)
         cached_response = before_render(env)
 
         return cached_response.finish if cached_response.present?
 
-        if SeoCache.log_missed_cache
-          env_request = Rack::Request.new(env)
-          SeoCache.log("missed cache : #{env_request.path} (User agent: #{env_request.user_agent})")
-        end
-
         if SeoCache.prerender_service_url.present?
           prerender_response = prerender_service(env)
           if prerender_response
             response = build_response_from_prerender(prerender_response.body)
             after_render(env, prerender_response)
+
             return response.finish
           end
         else
           Thread.new do
             prerender_data = page_render(env)
-            # 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)
+            after_render(env, prerender_data, @status)
           end
         end
       elsif prerender_params?(env)
-        env['seo_mode'] = true
-        # Add status to render page because Selenium doesn't return http headers or status...
+        env['seo_mode']           = true
         status, headers, response = @app.call(env)
-        status_code               = "<!--status:#{status}-->"
-        # Cannot add at the top of file, Chrome removes leading comments...
         begin
-          body_code = response.body.sub(/<head( ?)(.*?)>/i, "<head\\1\\2>#{status_code}")
-          return [status, headers, [body_code]]
+          return [status, headers, [response.body]]
         rescue
           return [status, headers, [nil]]
         end
       end
 
-      return @app.call(env)
+      return [@status, @headers, @response]
     end
 
     def prerender_params?(env)
@@ -75,13 +62,15 @@ module SeoCache
       return true if query_params.has_key?(SeoCache.prerender_url_param) || query_params.has_key?(SeoCache.force_cache_url_param)
     end
 
-    def prerender_page?(env)
+    def prerender_page?(env, status)
       user_agent                   = env['HTTP_USER_AGENT']
       buffer_agent                 = env['HTTP_X_BUFFERBOT']
       is_requesting_prerender_page = false
 
       return false unless user_agent
 
+      return false if status.to_i > 299
+
       return false if env['REQUEST_METHOD'] != 'GET'
 
       request      = Rack::Request.new(env)
@@ -186,7 +175,9 @@ module SeoCache
       # return nil unless @options[:before_render]
       # cached_render = @options[:before_render].call(env)
 
-      cached_render = @page_caching.get(Rack::Request.new(env).path)
+      env_request = Rack::Request.new(env)
+
+      cached_render = @page_caching.get(env_request.path, get_locale(env_request.params, env_request.host))
 
       return nil unless cached_render
 
@@ -213,12 +204,21 @@ module SeoCache
     def after_render(env, response, status = 200)
       return unless response && SeoCache.cache_only_status.include?(status.to_i)
 
+      env_request = Rack::Request.new(env)
+
       if SeoCache.log_missed_cache
-        env_request = Rack::Request.new(env)
         SeoCache.log("missed cache : #{env_request.path} (User agent: #{env_request.user_agent})")
       end
 
-      @page_caching.cache(response, Rack::Request.new(env).path)
+      @page_caching.cache(response, env_request.path, get_locale(env_request.params, env_request.host))
+    end
+
+    def get_locale(params, host)
+      if SeoCache.locale_as_first_directory
+        SeoCache.locale_method ? SeoCache.locale_method.call(params, host) : I18n.locale
+      else
+        nil
+      end
     end
   end
 end

data/lib/seo_cache/page_caching.rb

@@ -13,31 +13,31 @@ module SeoCache
       @redis = Redis::Namespace.new(SeoCache.redis_namespace, redis: Redis.new(host: uri.host, port: uri.port, password: uri.password, connect_timeout: 1, timeout: 1), warnings: false)
     end
 
-    def get(path, extension = nil)
-      @redis.get(cache_path(path, extension)) if SeoCache.memory_cache? && @redis
+    def get(path, locale_domain = nil, extension = nil)
+      @redis.get(cache_path(path, locale_domain, extension)) if SeoCache.memory_cache? && @redis
     end
 
     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, locale_domain))
+          write_to_memory(content, cache_path(path, locale_domain, extension))
         else
-          write_to_disk(content, cache_path(path, extension, locale_domain), gzip)
+          write_to_disk(content, cache_path(path, locale_domain, extension), gzip)
         end
       end
     end
 
-    def expire(path)
+    def expire(path, locale_domain = nil, extension = nil)
       instrument :expire_page, path do
-        delete(cache_path(path))
+        delete(cache_path(path, locale_domain, extension))
       end
     end
 
-    def cache_exists?(path)
+    def cache_exists?(path, locale_domain = nil, extension = nil)
       if SeoCache.memory_cache? && @redis
-        @redis.exists?(cache_path(path))
+        @redis.exists?(cache_path(path, locale_domain, extension))
       else
-        File.exist?(cache_path(path))
+        File.exist?(cache_path(path, locale_domain, extension))
       end
     end
 
@@ -51,7 +51,7 @@ module SeoCache
       SeoCache.cache_extension
     end
 
-    def cache_file(path, extension, locale_domain)
+    def cache_file(path, locale_domain, extension)
       name = if path.empty? || path =~ %r{\A/+\z}
                '/index'
              else
@@ -65,8 +65,8 @@ module SeoCache
       name
     end
 
-    def cache_path(path, extension = nil, locale_domain = nil)
-      File.join(cache_directory, cache_file(path, extension, locale_domain))
+    def cache_path(path, locale_domain = nil, extension = nil)
+      File.join(cache_directory, cache_file(path, locale_domain, extension))
     end
 
     def write_to_memory(content, path)

data/lib/seo_cache/populate_cache.rb

@@ -35,7 +35,7 @@ module SeoCache
     private
 
     def generate_cache(path, locale_domain = nil)
-      return if @page_caching.cache_exists?(path) && !@force_cache
+      return if @page_caching.cache_exists?(path, locale_domain) && !@force_cache
 
       url = @host + path
       url += path.include?('?') ? '&' : '?'

data/lib/seo_cache/version.rb

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

data/lib/seo_cache.rb

@@ -22,6 +22,12 @@ module SeoCache
   mattr_accessor :cache_path
   self.cache_path = ''
 
+  mattr_accessor :locale_as_first_directory
+  self.locale_as_first_directory = false
+
+  mattr_accessor :locale_method
+  self.locale_method = nil
+
   mattr_accessor :cache_extension
   self.cache_extension = '.html'
 

data/seo_cache.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'railties', '>= 5'
   spec.add_dependency 'redis', '~> 4'
   spec.add_dependency 'redis-namespace', '~> 1'
-  spec.add_dependency 'selenium-webdriver', '~> 3'
-  spec.add_dependency 'webdrivers', '~> 4'
+  spec.add_dependency 'selenium-webdriver', '>= 3'
+  spec.add_dependency 'webdrivers', '>= 3'
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake', '~> 13'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seo_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.2.0
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -84,30 +84,30 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Cache dedicated for SEO with Javascript rendering