seo_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e55653809271350248536acbfc6aaf970f27e5141487cd389bc5426d52fe6d0
+  data.tar.gz: 12f93fb02f2dbfde2296d7bf83a3cb98f13b97b16060a7e0a4a08ddd19ed2dde
+SHA512:
+  metadata.gz: dedd26e0dcdefdd193e634bbf88a513472951eea1b19cfb6a3f45450793ab14403ef87d7097191ebd83d3e53b2df05c07368b999695da071ce8772da8069b0fa
+  data.tar.gz: ed52a24c1b3efb7be25b97247ca0ebc22843d24e0f4507012c8db789c26422040e7e5fed0ef6e6d893567944774a95757268d83fcc0ef57cc76e2f8d7a781b90

data/.gitignore

@@ -0,0 +1,17 @@
+/.idea/
+/.bundle/
+/.config/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+tmp
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,127 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Documentation:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+Layout/AlignParameters:
+  Enabled: false
+
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/ExtraSpacing:
+  Enabled: false
+  AllowForAlignment: true
+
+Layout/FirstParameterIndentation:
+  Enabled: false
+
+Layout/IndentHash:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Layout/MultilineBlockLayout:
+  Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
+Layout/TrailingWhitespace:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or a Float.
+  Max: 240
+
+Metrics/BlockLength:
+  Max: 90
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 600
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 120
+
+Metrics/ParameterLists:
+  Max: 7
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Rails/OutputSafety:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ColonMethodCall:
+  Enabled: false
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/MultilineIfModifier:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+  AllowMultipleReturnValues: true
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First major release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at flo@l-x.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+
+First, thanks for wanting to contribute. You’re awesome! :heart:
+
+## Help
+
+We’re not able to provide support through GitHub Issues. If you’re looking for help with your code, try posting on [Stack Overflow](https://stackoverflow.com/).
+
+All features should be documented. If you don’t see a feature in the docs, assume it doesn’t exist.
+
+## Bugs
+
+Think you’ve discovered a bug?
+
+1. Search existing issues to see if it’s been reported.
+2. Try the `master` branch to make sure it hasn’t been fixed.
+
+```rb
+gem "seo_cache", github: "floXcode/seo_cache"
+```
+
+If the above steps don’t help, create an issue. Include:
+
+- Detailed steps to reproduce
+- Complete backtraces for exceptions
+
+## New Features
+
+If you’d like to discuss a new feature, create an issue and start the title with `[Idea]`.
+
+## Pull Requests
+
+Fork the project and create a pull request. A few tips:
+
+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
+- Follow the existing style. The code should read like it’s written by a single person.
+
+Feel free to open an issue to get feedback on your idea before spending too much time on it.
+
+---
+
+This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in seo_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Flo
+
+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,101 @@
+# SeoCache
+
+Cache dedicated for SEO with Javascript rendering :fire:
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seo_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seo_cache
+
+Install chrome driver on your device
+
+## How it works
+
+Specific cache for bots to optimize time to first byte and render Javascript on server side.
+
+Options:
+
+Choose a cache mode (`disk` or `memory`):
+
+    SeoCache.cache_mode = 'memory'
+
+If cache on disk, specify the cache path (e.g. `Rails.root.join('public', 'seo_cache')`):
+    
+    SeoCache.disk_cache_path = nil
+    
+URLs to blacklist:
+
+    SeoCache.blacklist_urls = []
+    
+URLs to whitelist:
+
+    SeoCache.whitelist_urls = []
+    
+Query params un URl to blacklist:
+
+    SeoCache.blacklist_params = []
+
+## Automatic caching
+
+To automate cache, create a cron rake task which called:
+
+```ruby
+SeoCache::PopulateCache.new('https://<your-domain-name>', paths_to_cache).new.perform
+```
+
+## Server
+
+If you use disk caching, add to your Nginx configuration:
+
+```
+location / {
+    # cached pages
+    set $cache_extension '';
+    if ($request_method = GET) {
+      set $cache_extension '.html';
+    }
+    
+    # Index HTML Files
+    if (-f $document_root/seo_cache/$uri/index$cache_extension) {
+      rewrite (.*) /seo_cache/$1/index.html break;
+    }
+    
+    # Other HTML Files
+    if (-f $document_root/seo_cache/$uri$cache_extension) {
+      rewrite (.*) /seo_cache/$1.html break;
+    }
+    
+    # All
+    if (-f $document_root/seo_cache/$uri) {
+      rewrite (.*) /seo_cache/$1 break;
+    }
+}
+```
+
+## Inspiration
+
+Inspired by [prerender gem](https://github.com/prerender/prerender_rails).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/floXcoder/seo_cache. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SeoCache project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/seo_cache/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seo_cache"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/seo_cache/middleware.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'seo_cache/page_caching'
+require 'seo_cache/page_render'
+
+module SeoCache
+  class Middleware
+    def initialize(app, options = {})
+      @options                  = options
+      @extensions_to_ignore     = SeoCache.extensions_to_ignore
+      @crawler_user_agents      = SeoCache.crawler_user_agents
+
+      @app = app
+
+      @page_caching = PageCaching.new
+    end
+
+    def call(env)
+      if should_show_prerendered_page(env)
+        cached_response = before_render(env)
+
+        return cached_response.finish if cached_response.present?
+
+        SeoCache.log('missed cache : ' + Rack::Request.new(env).path) if SeoCache.log_missed_cache
+
+        if SeoCache.prerender_service_url.present?
+          prerendered_response = get_prerendered_page_response(env)
+          if prerendered_response
+            response = build_rack_response_from_prerender(prerendered_response.body)
+            after_render(env, prerendered_response)
+            return response.finish
+          end
+        else
+          Thread.new do
+            prerendered_data = page_render(env)
+            after_render(env, prerendered_data) if prerendered_data
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    def should_show_prerendered_page(env)
+      user_agent                     = env['HTTP_USER_AGENT']
+      buffer_agent                   = env['HTTP_X_BUFFERBOT']
+      is_requesting_prerendered_page = false
+
+      return false unless user_agent
+
+      return false if env['REQUEST_METHOD'] != 'GET'
+
+      request = Rack::Request.new(env)
+      query_params = Rack::Utils.parse_query(request.query_string)
+
+      # If it is the generated page...don't prerender
+      return false if query_params.has_key?(SeoCache.prerender_url_param)
+
+      return false if SeoCache.blacklist_params.present? && SeoCache.blacklist_params.any? { |param| query_params.has_key?(param) }
+
+      is_requesting_prerendered_page = true if Rack::Utils.parse_query(request.query_string).has_key?('_escaped_fragment_') || Rack::Utils.parse_query(request.query_string).has_key?(SeoCache.force_cache_url_param)
+
+      # if it is a bot...show prerendered page
+      is_requesting_prerendered_page = true if @crawler_user_agents.any? { |crawler_user_agent| user_agent.downcase.include?(crawler_user_agent.downcase) }
+
+      # if it is BufferBot...show prerendered page
+      is_requesting_prerendered_page = true if buffer_agent
+
+      # 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 }
+
+      # 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) }
+
+      # if it is a bot and not requesting a resource and is blacklisted(url or referer)...don't prerender
+      blacklisted_url = SeoCache.blacklist_urls.present? && SeoCache.blacklist_urls.any? do |blacklisted|
+        regex = Regexp.new(blacklisted)
+
+        blacklisted_url     = regex.match(request.fullpath)
+        blacklisted_referer = request.referer ? regex.match(request.referer) : false
+
+        blacklisted_url || blacklisted_referer
+      end
+      return false if blacklisted_url
+
+      return is_requesting_prerendered_page
+    end
+
+    def get_prerendered_page_response(env)
+      url          = URI.parse(build_api_url(env))
+      headers      = {
+        'User-Agent'      => env['HTTP_USER_AGENT'],
+        'Accept-Encoding' => 'gzip'
+      }
+      req          = Net::HTTP::Get.new(url.request_uri, headers)
+      http         = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true if url.scheme == 'https'
+      response     = http.request(req)
+      if response['Content-Encoding'] == 'gzip'
+        response.body              = ActiveSupport::Gzip.decompress(response.body)
+        response['Content-Length'] = response.body.length
+        response.delete('Content-Encoding')
+      end
+      response
+    rescue StandardError => error
+      SeoCache.log_error(error.message)
+    end
+
+    def build_api_url(env)
+      new_env = env
+      if env['CF-VISITOR']
+        match = /"scheme":"(http|https)"/.match(env['CF-VISITOR'])
+        (new_env['HTTPS'] = true) && (new_env['rack.url_scheme'] = 'https') && (new_env['SERVER_PORT'] = 443) if match && match[1] == 'https'
+        (new_env['HTTPS'] = false) && (new_env['rack.url_scheme'] = 'http') && (new_env['SERVER_PORT'] = 80) if match && match[1] == 'http'
+      end
+
+      if env['X-FORWARDED-PROTO']
+        (new_env['HTTPS'] = true) && (new_env['rack.url_scheme'] = 'https') && (new_env['SERVER_PORT'] = 443) if env['X-FORWARDED-PROTO'].split(',')[0] == 'https'
+        (new_env['HTTPS'] = false) && (new_env['rack.url_scheme'] = 'http') && (new_env['SERVER_PORT'] = 80) if env['X-FORWARDED-PROTO'].split(',')[0] == 'http'
+      end
+
+      if SeoCache.protocol.present?
+        (new_env['HTTPS'] = true) && (new_env['rack.url_scheme'] = 'https') && (new_env['SERVER_PORT'] = 443) if @options[:protocol] == 'https'
+        (new_env['HTTPS'] = false) && (new_env['rack.url_scheme'] = 'http') && (new_env['SERVER_PORT'] = 80) if @options[:protocol] == 'http'
+      end
+
+      url           = Rack::Request.new(new_env).url
+      prerender_url = SeoCache.prerender_service_url
+      forward_slash = prerender_url[-1, 1] == '/' ? '' : '/'
+      "#{prerender_url}#{forward_slash}#{url}"
+    end
+
+    def build_rack_response_from_prerender(prerendered_response)
+      response = Rack::Response.new(prerendered_response.body, prerendered_response.code, prerendered_response.header)
+
+      # @options[:build_rack_response_from_prerender]&.call(response, prerendered_response)
+
+      return response
+    end
+
+    def before_render(env)
+      # return nil unless @options[:before_render]
+      # cached_render = @options[:before_render].call(env)
+
+      cached_render = @page_caching.get(Rack::Request.new(env).path)
+
+      return nil unless cached_render
+
+      if cached_render&.is_a?(String)
+        Rack::Response.new(cached_render, 200, 'Content-Type' => 'text/html; charset=utf-8')
+      elsif cached_render&.is_a?(Rack::Response)
+        cached_render
+      end
+    end
+
+    def page_render(env)
+      # return nil unless @options[:page_render]
+      # @options[:page_render].call(url)
+
+      # Add key parameter to url
+      request = Rack::Request.new(env)
+      url     = if request.query_string.present? || request.url.end_with?('?')
+                  request.url + '&'
+                else
+                  request.url + '?'
+                end
+      url     += "#{SeoCache.prerender_url_param}=true"
+
+      PageRender.new.get(url)
+    end
+
+    def after_render(env, response)
+      # return true unless @options[:after_render]
+      # @options[:after_render].call(env, response)
+
+      @page_caching.cache(response, Rack::Request.new(env).path)
+    end
+  end
+end

data/lib/seo_cache/page_caching.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SeoCache
+  class PageCaching
+    def initialize
+      @redis = nil
+
+      initialize_memory_cache if SeoCache.memory_cache?
+    end
+
+    def initialize_memory_cache
+      uri    = URI.parse(SeoCache.redis_url)
+      @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
+    end
+
+    def cache(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION)
+      instrument :write_page, path do
+        if SeoCache.memory_cache? && @redis
+          write_to_memory(content, cache_path(path, extension))
+        else
+          write_to_disk(content, cache_path(path, extension), gzip)
+        end
+      end
+    end
+
+    def expire(path)
+      instrument :expire_page, path do
+        delete(cache_path(path))
+      end
+    end
+
+    def cache_exists?(path)
+      if SeoCache.memory_cache? && @redis
+        @redis.exists?(cache_path(path))
+      else
+        File.exist?(cache_path(path))
+      end
+    end
+
+    private
+
+    def cache_directory
+      SeoCache.disk_cache_path
+    end
+
+    def default_extension
+      SeoCache.disk_cache_extension
+    end
+
+    def cache_file(path, extension)
+      name = if path.empty? || path =~ %r{\A/+\z}
+               '/index'
+             else
+               URI.parser.unescape(path.chomp('/'))
+             end
+
+      if File.extname(name).empty?
+        name + (extension || default_extension)
+      else
+        name
+      end
+    end
+
+    def cache_path(path, extension = nil)
+      File.join(cache_directory, cache_file(path, extension))
+    end
+
+    def write_to_memory(content, path)
+      @redis&.set(path, content)
+    end
+
+    def write_to_disk(content, path, gzip)
+      FileUtils.makedirs(File.dirname(path))
+      File.open(path, 'wb+') { |f| f.write(content) }
+
+      Zlib::GzipWriter.open(path + '.gz', gzip) { |f| f.write(content) } if gzip
+    end
+
+    def disk_delete(path)
+      File.delete(path) if File.exist?(path)
+      File.delete(path + '.gz') if File.exist?(path + '.gz')
+    end
+
+    def memory_delete(path)
+      @redis.del(path) if @redis&.exists?(path)
+    end
+
+    def instrument(name, path)
+      ActiveSupport::Notifications.instrument("#{name}.seo_cache", path: path) { yield }
+    end
+  end
+end

data/lib/seo_cache/page_render.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SeoCache
+  class PageRender
+    def initialize
+      init_driver
+    end
+
+    def get(url)
+      @driver.get(url)
+
+      return @driver.page_source
+    rescue StandardError => error
+      SeoCache.log_error(error.message)
+    ensure
+      @driver&.quit
+    end
+
+    def persistent_get(url)
+      @driver.get(url)
+
+      return @driver.page_source
+    rescue StandardError => error
+      SeoCache.log_error(error.message)
+    end
+
+    def close_connection
+      @driver&.quit
+    end
+
+    private
+
+    def init_driver
+      # Selenium::WebDriver.logger.level = :info
+
+      client          = ::Selenium::WebDriver::Remote::Http::Persistent.new
+      browser_options = ::Selenium::WebDriver::Chrome::Options.new
+      browser_options.args << '--headless'
+      browser_options.args << '--disable-gpu'
+      browser_options.args << '--no-sandbox'
+      browser_options.args << '--disable-web-security'
+      browser_options.args << '--window-size=1920x1080'
+      # browser_options.args << '--remote-debugging-port=3020'
+      @driver = ::Selenium::WebDriver.for(:chrome, options: browser_options, http_client: client)
+    end
+  end
+end

data/lib/seo_cache/populate_cache.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'seo_cache/page_caching'
+require 'seo_cache/page_render'
+
+module SeoCache
+  class PopulateCache
+    def initialize(host, paths, options = {})
+      @host         = host
+      @paths        = paths
+      @page_render  = PageRender.new
+      @page_caching = PageCaching.new
+
+      @force_cache = options.fetch(:force_cache, false)
+    end
+
+    def perform
+      @paths.each do |path|
+        next if @page_caching.cache_exists?(path) && !@force_cache
+
+        page_source = @page_render.persistent_get(@host + path)
+        @page_caching.cache(page_source, path)
+      end
+
+      @page_render.close_connection
+    end
+  end
+end

data/lib/seo_cache/version.rb

@@ -0,0 +1,3 @@
+module SeoCache
+  VERSION = '0.1.0'.freeze
+end

data/lib/seo_cache.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'active_support'
+require 'selenium/webdriver'
+require 'chromedriver-helper'
+require 'selenium/webdriver/remote/http/persistent'
+require 'redis'
+require 'redis-namespace'
+
+require 'seo_cache/version'
+require 'seo_cache/middleware'
+
+module SeoCache
+
+  mattr_accessor :cache_mode # disk or memory
+  self.cache_mode = 'memory'
+
+  mattr_accessor :disk_cache_path
+  self.disk_cache_path = nil
+
+  mattr_accessor :disk_cache_extension
+  self.disk_cache_extension = '.html'
+
+  mattr_accessor :redis_url
+  self.redis_url = 'redis://localhost:6379/'
+
+  mattr_accessor :redis_namespace
+  self.redis_namespace = '_seo_cache:'
+
+  mattr_accessor :blacklist_urls
+  self.blacklist_urls = []
+
+  mattr_accessor :whitelist_urls
+  self.whitelist_urls = []
+
+  mattr_accessor :blacklist_params
+  self.blacklist_params = []
+
+  mattr_accessor :log_missed_cache
+  self.log_missed_cache = false
+
+  mattr_accessor :protocol
+  self.protocol = nil
+
+  mattr_accessor :prerender_service_url
+  self.prerender_service_url = nil
+
+  mattr_accessor :prerender_url_param
+  self.prerender_url_param = '_prerender_'
+
+  mattr_accessor :force_cache_url_param
+  self.force_cache_url_param = '_seo_cache_'
+
+  mattr_accessor :extensions_to_ignore
+  self.extensions_to_ignore = %w[.js .css .xml .less .png .jpg .jpeg .gif .pdf .doc .txt .ico .rss .zip .mp3 .rar .exe .wmv .doc .avi .ppt .mpg .mpeg .tif .wav .mov .psd .ai .xls .mp4 .m4a .swf .dat .dmg .iso .flv .m4v .torrent]
+
+  mattr_accessor :crawler_user_agents
+  self.crawler_user_agents = [
+    'googlebot',
+    'yahoo',
+    'bingbot',
+    'baiduspider',
+    'facebookexternalhit',
+    'twitterbot',
+    'rogerbot',
+    'linkedinbot',
+    'embedly',
+    'bufferbot',
+    'quora link preview',
+    'showyoubot',
+    'outbrain',
+    'pinterest/0.',
+    'developers.google.com/+/web/snippet',
+    'www.google.com/webmasters/tools/richsnippets',
+    'slackbot',
+    'vkShare',
+    'W3C_Validator',
+    'redditbot',
+    'Applebot',
+    'WhatsApp',
+    'flipboard',
+    'tumblr',
+    'bitlybot',
+    'SkypeUriPreview',
+    'nuzzel',
+    'Discordbot',
+    'Google Page Speed',
+    'Qwantify'
+  ]
+
+  def self.memory_cache?
+    SeoCache.cache_mode == 'memory'
+  end
+
+  def self.disk_cache?
+    SeoCache.cache_mode == 'disk'
+  end
+
+  def self.log(message)
+    Rails.logger.info { "[seo_cache] #{message}" }
+  end
+
+  def self.log_error(message)
+    Rails.logger.error { "[seo_cache] #{message}" }
+  end
+end

data/seo_cache.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seo_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'seo_cache'
+  spec.version = SeoCache::VERSION
+  spec.authors = ['FloXcoder']
+  spec.email   = ['flo@l-x.fr']
+
+  spec.summary     = 'Cache dedicated for SEO with Javascript rendering'
+  spec.description = 'Specific cache for bots to optimize time to first byte and render Javascript on server side.'
+  spec.homepage    = 'https://github.com/floXcoder/SeoCache'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rack', '~> 2'
+  spec.add_dependency 'railties', '~> 5'
+  spec.add_dependency 'activesupport', '~> 5'
+  spec.add_dependency 'selenium-webdriver', '~> 3'
+  spec.add_dependency 'chromedriver-helper', '~> 2'
+  spec.add_dependency 'redis', '~> 4'
+  spec.add_dependency 'redis-namespace', '~> 1'
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: seo_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- FloXcoder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  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: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Specific cache for bots to optimize time to first byte and render Javascript
+  on server side.
+email:
+- flo@l-x.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seo_cache.rb
+- lib/seo_cache/middleware.rb
+- lib/seo_cache/page_caching.rb
+- lib/seo_cache/page_render.rb
+- lib/seo_cache/populate_cache.rb
+- lib/seo_cache/version.rb
+- seo_cache.gemspec
+homepage: https://github.com/floXcoder/SeoCache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Cache dedicated for SEO with Javascript rendering
+test_files: []