seo_cache 0.19.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93939e53687c186d003b4b09abed06bcf1b6ac0a63b808c3a7abfadd7e6531cb
-  data.tar.gz: 4d362ee26521e0ebb55b61c15e6b9d5e6c9e19877e57ead9cfab9765c4310142
+  metadata.gz: b82b45544128dd934db5108a1ac3ee005b469a4ff930a2f30ab0c1f07053dea0
+  data.tar.gz: 674c9bd71f0742be48cb92fe1b2d1fe8c78567137a0feb7ff591174f563fc904
 SHA512:
-  metadata.gz: fc485c1ea013d77fcf9337c3423bacec563701b319d79b4949304f6bf51fe78c54a3553cdf875b8067e60c1c9c8ae3667dfeec0ee8f29f3991079d5662c3ffa7
-  data.tar.gz: 1d634743d69e52965d9c450b046dc19edabd88b92783c567c460a11b7407473d395600775cd5aaff31f96db5b68fa5143954f90fa7b154fbccf76f3f9284e00b
+  metadata.gz: 33e0310c7630322bed31cd4de556669959d469f3a5e8c2c4726d88d7a3b88dc7adf92fad7c33487afebc19cf69584d5ff9f9ea4ce019a4641e29385c40a2133d
+  data.tar.gz: c9667584c03fbe472807d9fa9875e5cb956052729c50bfd5e7a69177c105ca0a5d92f021826bfbbc9cee7419b972328594d01b316a8a50889e12310d55eacd8d

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -0,0 +1,14 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+Thanks for contributing to SeoCache!

data/.travis.yml

@@ -1,7 +1,41 @@
 ---
-sudo: false
 language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1
+
+gemfile:
+  - Gemfile
+
+before_install:
+  - gem update --system -N
+  - gem install bundler -N
+
+services:
+  - redis
+
+addons:
+  apt:
+    packages:
+      - chromium-browser
+
+cache:
+  bundler: true
+  directories:
+    - ~/.webdrivers
+
+notifications:
+  email:
+    on_success: never
+    on_failure: change
+
+script: bundle exec rake $RAKE_TASK
+
+matrix:
+  include:
+    - rvm: 2.7
+      gemfile: Gemfile
+      env: RAKE_TASK=spec
+    - rvm: 2.6
+      gemfile: Gemfile
+      env: RAKE_TASK=spec
+    - rvm: 2.5
+      gemfile: Gemfile
+      env: RAKE_TASK=spec

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.0
+
+- Update Readme (badges, syntax, links, ...)
+- Add Travis CI
+- Update dependencies
+- Do not cache pages in error
+
 ## 0.19.0
 
 - Add option to cache page if user connected

data/CODE_OF_CONDUCT.md

@@ -5,9 +5,9 @@
 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.
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -23,13 +23,13 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+ 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
+ address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+ professional setting
 
 ## Our Responsibilities
 
@@ -68,7 +68,9 @@ 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]
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -1,41 +1,38 @@
-# Contributing
+## How to contribute to Ruby on Rails
 
-First, thanks for wanting to contribute. You’re awesome! :heart:
+#### **Did you find a bug?**
 
-## Help
+* **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to contact us by email contact@ginkonote.com.
 
-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/).
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/floXcoder/seo_cache/issues).
 
-All features should be documented. If you don’t see a feature in the docs, assume it doesn’t exist.
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/floXcoder/seo_cache/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **scenario** demonstrating the expected behavior that is not occurring.
 
-## Bugs
+* If possible, use the relevant bug report templates to create the issue:
+  * [**Bug** issues](https://github.com/floXcoder/seo_cache/blob/develop/.github/ISSUE_TEMPLATE/bug_report.md)*
+  
+#### **Did you have an idea to improve the project?**
 
-Think you’ve discovered a bug?
+* Open a new GitHub issue request with your idea.
 
-1. Search existing issues to see if it’s been reported.
-2. Try the `master` branch to make sure it hasn’t been fixed.
+* If possible, use the relevant feature report templates to create the issue:
+  * [**Feature** issues](https://github.com/floXcoder/seo_cache/blob/develop/.github/ISSUE_TEMPLATE/feature_request.md)
 
-```rb
-gem "seo_cache", github: "floXcode/seo_cache"
-```
+#### **Did you write a patch that fixes a bug or do you intend to add a new feature or change an existing one?**
 
-If the above steps don’t help, create an issue. Include:
+* Fork the project, write your code and open a new GitHub pull request with the patch.
 
-- Detailed steps to reproduce
-- Complete backtraces for exceptions
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
 
-## New Features
+* If possible, use the relevant pull request report templates to create the issue:
+  * [**Pull Request**](https://github.com/floXcoder/seo_cache/blob/develop/.github/pull_request_template.md)
+  
+#### **Do you have questions about the source code?**
 
-If you’d like to discuss a new feature, create an issue and start the title with `[Idea]`.
+* You can contact me by email: flo@l-x.fr. I will try to answer as much I can and if available.
 
-## 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.
+Thanks!
 
 ---
 

data/README.md

@@ -1,14 +1,34 @@
 # SeoCache
 
-Cache dedicated for SEO with Javascript rendering :fire:
+[![Gem Version](https://badge.fury.io/rb/seo_cache.svg)](https://badge.fury.io/rb/seo_cache)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
+[![Build Status](https://travis-ci.org/floXcoder/seo_cache.svg)](https://travis-ci.org/floXcoder/seo_cache)
+
+**SeoCache is a dedicated cache for SEO with JavaScript rendering** :fire:
+
+You can find in this article, a more detail explanation of the purpose and usage of this gem:
+
+- In english: https://www.ginkonote.com/users/flo/articles/seo-generate-and-cache-your-pages@seo
+- In french: https://www.ginkonote.com/fr/utilisateurs/flo/articles/seo-generation-et-mise-en-cache-des-pages@seo
+
+## Table of contents
+- [Purpose](#purpose)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Helpers for controllers](#helpers-for-controllers)
+- [Check cached pages](#check-cached-pages)
+- [Automatic caching](#automatic-caching)
+- [Server configuration](#server-configuration)
+- [Inspiration](#inspiration)
+- [Contributing](#contributing)
 
 ## Purpose
 
 Google credo is: Don't waste my bot time!
 
-So to reduce Googlebot crawling time, let's provide HTML files in a specific cache.
+In order to reduce Googlebot crawling time, let's provide the complete HTML files in a specific cache.
 
-This cache is suitable for static (generated or not) pages but not for connected pages.
+This cache is suitable for static (generated or not) pages but not for user private pages.
 
 ## Installation
 
@@ -38,7 +58,7 @@ require 'seo_cache'
 Rails.application.config.middleware.use SeoCache::Middleware
 ```
 
-## Options
+## Configuration
 
 Chrome path (**required**) (`disk` or `memory`):
 
@@ -97,13 +117,13 @@ SeoCache.whitelist_hosts = []
 URLs to blacklist:
 
 ```ruby
-SeoCache.blacklist_params = %w[^/assets/.* ^/admin.*]
+SeoCache.blacklist_urls = %w[^/assets/.* ^/admin.*]
 ```
 
 Params to blacklist:
 
 ```ruby
-SeoCache.blacklist_urls = %w[page]
+SeoCache.blacklist_params = %w[page]
 ```
 
 URLs to whitelist:
@@ -154,28 +174,36 @@ If you encounter the following error `DevToolsActivePort file doesn't exist`, yo
 SeoCache.chrome_debugging_port = '9222'
 ```
 
-Be aware, JS will be rendered twice: once by server rendering and once by client. For React, this not a problem but with jQuery plugins, it can duplicate elements in the page (you have to check the redundancy).
+Be aware, JS will be rendered twice: once by this gem and once by client. For React, this not a problem but with jQuery plugins, it can duplicate elements in the page (you have to check the redundancy).
 
-Disk cache is recommended by default. Nginx will directly fetch file on disk. The TTFB (time to first byte) will be under 200ms :). You can use memory cache if you have lot of RAM.
+Disk cache is recommended by default. Nginx will directly fetch HTML files on disk. The TTFB (time to first byte) will be under 200ms :). You can use memory cache if you have lot of RAM, but if you shut down your server, you will lost all the generated pages! So prefer cache disk storage.
 
-## Controllers
+## Helpers for controllers
 
 You can check if seo mode is active in your controllers, with the following variable:
 
 ```ruby
-request.env['seo_mode']
+def check_seo_mode
+  @seo_mode = (params.key?(SeoCache.prerender_url_param) || params.key?(SeoCache.force_cache_url_param))
+end
+```
+
+And if you want to access to this variable in JS files:
+
+```javascript
+window.seoMode = "{@seo_mode}"
 ```
 
 
-## Consult cache pages
+## Check cached pages
 
-Too see in browser the cache page, open a browser and set the user agent to:
+Too see in browser the cached page, open a browser and set the user agent to:
 
 `Googlebot (Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html))`
 
-For instance, with Chrome or Chromium, you can change the user agent in "Network conditions" panel.
+For instance, with Chrome or Chromium, you can change the user agent in "Network" / "Network conditions" panel.
 
-To (re)cache a page, add this parameter to the url (the browser must use the Googlebot user agent):
+To (re)cache a page, add this parameter to the url (and the browser must use the Googlebot user agent):
 
 `/?_seo_cache_=true`
 
@@ -184,7 +212,7 @@ To (re)cache a page, add this parameter to the url (the browser must use the Goo
 To automate caching, create a cron rake task (e.g. in `lib/tasks/populate_seo_cache.rake`):
 
 ```ruby
-namespace :MyProject do
+namespace :my_project do
 
   desc 'Populate cache for SEO'
   task populate_seo_cache: :environment do |_task, _args|
@@ -197,14 +225,14 @@ namespace :MyProject do
 end
 ```
 
-You can add the `force_cache: true` option to `SeoCache::PopulateCache` for overwrite cache data.
+You can add the `force_cache: true` option to `SeoCache::PopulateCache` for overwrite cached data.
 
-If you want to only 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 not called for pages not in cache.
+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.
 
-## Server
+## Server configuration
 
-If you use disk caching, add to your Nginx configuration:
+If you use disk caching, add this to your Nginx configuration:
 
 ```nginx
 # Before any block:
@@ -250,15 +278,24 @@ location / {
 }
 
 location @rubyproxy {
-    ...
+    proxy_connect_timeout 600;
+    proxy_send_timeout 600;
+    proxy_read_timeout 600;
+    send_timeout 600;
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_pass_header Server;
+    proxy_pass http://0.0.0.0:3020;
 }
 ```
 
-This configuration allow you to use SEO cache only for bots (you can add other bots) and GET requests. For users, you don't want to use the cached page (user connection, basket, ...). The performance are less important for users then bots.
+This configuration allow you to use SEO cache only for bots (you can add other bots at the beginning of the file) and HTML GET requests. For connected users, you don't want to use the cached page (user connection, basket, ...). The performance are less important for users than bots.
 
 ## Heroku case
 
-If you use Heroku server, you can't store file on dynos. But you have two alternatives :
+If you use Heroku server, you can't store files on dynos. But you have two alternatives:
 
 - Use the memory mode
 

data/lib/seo_cache/page_render.rb

@@ -14,6 +14,8 @@ module SeoCache
       return @driver.page_source
     rescue StandardError => error
       SeoCache.log_error(error.message)
+
+      return false
     ensure
       @driver&.quit if quit_after_render
     end

data/lib/seo_cache/populate_cache.rb

@@ -27,7 +27,7 @@ module SeoCache
         url += "#{SeoCache.prerender_url_param}=true"
 
         page_source = @page_render.get(url, false)
-        @page_caching.cache(page_source, path)
+        @page_caching.cache(page_source, path) if page_source
       end
 
     ensure

data/lib/seo_cache/version.rb

@@ -1,3 +1,3 @@
 module SeoCache
-  VERSION = '0.19.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/seo_cache.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'selenium-webdriver', '~> 3'
   spec.add_dependency 'webdrivers', '~> 4'
 
-  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'simplecov', '~> 0.17'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seo_cache
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 1.0.0
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +186,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"