varnish_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f08804be17b59401c9033b430e15d56df615b2f96f8280079e06968acd967ee
+  data.tar.gz: 6e0e358dda404fa3698423feb6ca40311af9db250a1be90e3536c3317772104a
+SHA512:
+  metadata.gz: e9dce1c5889833c2fd7a3a996fa3dc07ddf23c197996b77ad1bd5fd96f4792a686246e6ca4ede6efea634ff62b551c41e61d3f5189929df9a40a284bcf2ecf7a
+  data.tar.gz: 7b1405fbbf779f4baf52974cbfd702e75676663ee45a524a50bf73aea036dae5470ff7636e1fffef22577fde7d191155b99b2affc49cc36f0c997abca8c62a24

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Mario Bouchard
+
+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,35 @@
+# varnish_rails
+Add Varnish cache headers to controller actions. Automatically purge instances and models on `after_create`, `after_update` and `after_destroy` callbacks.
+
+## Installation
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'varnish_rails'
+```
+
+2. Run
+```bash
+$ bundle install
+```
+
+3. Install VarnishRails
+```bash
+$ rails generate varnish_rails:install
+```
+
+## Configuration
+1. Complete the `config/initializers/varnish_rails.rb` file.
+
+## Usage
+1. Add `before_action :set_varnish_headers(max_age_in_seconds)` in controllers that you wanna cache.
+
+2. Add calls to `add_to_varnish_xkey_header(my_collection_or_item)` in the cached controller actions to automatically generate the Varnish xkeys.
+
+3. For models that don't have to be purged automatically, add the following line `is_updated_via_import` to the model. You can then call `MyModel::purge_cache_by_varnish_class_name` to purge all cached pages that use this model.
+
+## Contributing
+- Mario Bouchard
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'VarnishRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/varnish_rails/install_generator.rb

@@ -0,0 +1,11 @@
+module VarnishRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_config_file
+        template 'varnish_rails.rb', 'config/initializers/varnish_rails.rb'
+      end
+    end
+  end
+end

data/lib/generators/varnish_rails/templates/varnish_rails.rb

@@ -0,0 +1,29 @@
+VarnishRails.configure do |config|
+
+  # To enable the varnish headers and purge calls
+  config.enable             = ENV['VARNISH'] == "true" ? true : false
+
+  # The varnish server URL (ex: http://localhost:6081)
+  config.url                = ENV['VARNISH_URL']
+
+  # The header max-age key to used
+  config.maxage_key         = ENV['VARNISH_MAXAGE_KEY'] || 's-maxage'
+
+  # The default max-age value
+  config.maxage_value       = ENV['VARNISH_MAXAGE_VALUE'] || 3600
+
+  # The xkey length that will be generated
+  config.xkey_length        = ENV['VARNISH_XKEY_LENGTH'] || 12
+
+  # The header for the xkey purge
+  config.header_xkey_purge  = ENV['VARNISH_XKEY_PURGE'] || 'xkey-purge'
+
+  # The header for the ban purge
+  config.header_x_ban_url   = ENV['VARNISH_X_BAN_URL'] || 'x-ban-url'
+
+  # Print requests
+  config.print_requests     = ENV['VARNISH_PRINT_REQUESTS'] == "true" ? true : false
+end
+
+# Flush the Varnish cache when the app starts
+VarnishRailsService::ban_cache('.+') unless File.basename($0) == 'rake'

data/lib/tasks/varnish_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :varnish_rails do
+#   # Task goes here
+# end

data/lib/varnish_rails.rb

@@ -0,0 +1,44 @@
+require "varnish_rails/railtie"
+require "varnish_rails/action_controller_methods"
+require "varnish_rails/application_record_methods"
+require "varnish_rails/varnish_rails_service"
+require "varnish_rails/varnish_debug_color"
+
+module VarnishRails
+
+  ActionController::Base.class_eval do
+    include ActionControllerMethods
+  end
+
+  application_record_class = defined?(ApplicationRecord) ? ApplicationRecord : ActiveRecord::Base
+  application_record_class.class_eval do
+    include ApplicationRecordMethods
+  end
+
+  # CONFIGURATION -----------------------------------------------------------------
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :enable, :url, :maxage_key, :maxage_value, :xkey_length, :header_xkey_purge, :header_x_ban_url, :print_requests
+
+    def initialize
+      @enable             = false
+      @url                = 'http://localhost:6081'
+      @maxage_key         = 's-maxage'
+      @maxage_value       = 3600
+      @xkey_length        = 12
+      @header_xkey_purge  = 'xkey-purge'
+      @header_x_ban_url   = 'x-ban-url'
+      @print_requests     = false
+    end
+  end
+  # CONFIGURATION -----------------------------------------------------------------
+
+end

data/lib/varnish_rails/action_controller_methods.rb

@@ -0,0 +1,34 @@
+module ActionControllerMethods
+
+  private
+
+  def set_varnish_headers(max_age_in_seconds=VarnishRails.configuration.maxage_value)
+    response.headers['Cache-Control'] = "public, #{VarnishRails.configuration.maxage_key}=#{max_age_in_seconds}" if VarnishRails.configuration.enable
+  end
+
+  def add_to_varnish_xkey_header(*collections)
+    return if !VarnishRails.configuration.enable
+
+    xkey_string = response.headers['xkey'] || ''
+    xkey        = xkey_string.split(' ')
+
+    collections.each do |collection|
+      if collection.is_a?(ActiveRecord::Relation) || collection.is_a?(Array)
+        if collection.length > 0
+          my_collection = collection.first
+          collection.each { |item| xkey << item.varnish_id }
+        end
+      elsif collection.present?
+        my_collection = collection
+        xkey << collection.varnish_id
+      end
+
+      xkey << my_collection.varnish_class_name if my_collection.present?
+      xkey = xkey.concat(my_collection.varnish_foreign_keys) if my_collection.present?
+    end
+
+    xkey = xkey.uniq
+    response.headers['xkey'] = xkey.join(' ') if xkey.length > 0
+  end
+
+end

data/lib/varnish_rails/application_record_methods.rb

@@ -0,0 +1,95 @@
+module ApplicationRecordMethods
+
+  extend ActiveSupport::Concern
+
+  included do
+
+    # == Extensions ===========================================================
+
+    # == Constants ============================================================
+
+    # == Attributes ===========================================================
+
+    class_attribute :varnish_purge_on_commit
+
+    # == Callbacks ============================================================
+
+    after_initialize  :varnish_configure
+
+    after_create      :purge_cache_by_varnish_class_name
+    after_destroy     :purge_cache_by_varnish_class_name
+    after_update      :purge_cache_by_varnish_id
+
+    # == Relationships ========================================================
+
+    # == Validations ==========================================================
+
+    # == Scopes ===============================================================
+
+    # == Instance Methods =====================================================
+
+    def varnish_configure
+      self.class.varnish_purge_on_commit = true if self.class.varnish_purge_on_commit.nil?
+    end
+
+    def varnish_class_name
+      return self.class.varnish_class_name
+    end
+
+    def varnish_class_name_fk
+      return self.class.varnish_class_name_fk
+    end
+
+    def varnish_foreign_keys
+      return self.class.varnish_foreign_keys
+    end
+
+    def varnish_id
+      return self.class.varnish_encode([self.class.name, id].join('-')) if defined?(id)
+    end
+
+    private
+
+    def purge_cache_by_varnish_class_name
+      self.class.purge_cache_by_varnish_class_name
+    end
+
+    def purge_cache_by_varnish_id
+      VarnishRailsService::purge_xkey_cache(varnish_id, varnish_class_name_fk) if (varnish_id.present? && !/.+::Translation/.match(self.class.name) && self.class.varnish_purge_on_commit)
+    end
+
+    # == Class Methods ========================================================
+
+    def self.varnish_class_name(namespace='')
+      class_name = namespace.present? ? [self.name, namespace].join('-') : self.name
+      return self.varnish_encode(class_name)
+    end
+
+    def self.varnish_class_name_fk
+      return self.varnish_class_name('fk')
+    end
+
+    def self.varnish_foreign_keys
+      foreign_keys = []
+      classes = self.reflect_on_all_associations.map(&:class_name).select{|c| !/.+::Translation/.match(c)}
+      foreign_keys = classes.map(&:constantize).map(&:varnish_class_name_fk) if classes.length > 0
+      return foreign_keys
+    end
+
+    def self.purge_cache_by_varnish_class_name
+      VarnishRailsService::purge_xkey_cache(self::varnish_class_name, self::varnish_class_name_fk) if self::varnish_purge_on_commit
+    end
+
+    def self.varnish_encode(value)
+      Digest::MD5.hexdigest([Rails.application.engine_name, Rails.env, value].join('-'))[0,VarnishRails.configuration.xkey_length]
+    end
+
+  end
+
+  module ClassMethods
+    def is_updated_via_import(value=true)
+      self.varnish_purge_on_commit = !value
+    end
+  end
+
+end

data/lib/varnish_rails/railtie.rb

@@ -0,0 +1,4 @@
+module VarnishRails
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/varnish_rails/varnish_debug_color.rb

@@ -0,0 +1,7 @@
+class String
+
+  def varnish_debug_color
+    "\e[#{33}m#{self}\e[0m"
+  end
+  
+end

data/lib/varnish_rails/varnish_rails_service.rb

@@ -0,0 +1,78 @@
+class VarnishRailsService
+
+  # == Extensions ===========================================================
+
+  require 'net/http'
+
+  include Singleton
+
+  # == Constants ============================================================
+
+  # == Attributes ===========================================================
+
+  # == Callbacks ============================================================
+
+  # == Relationships ========================================================
+
+  # == Validations ==========================================================
+
+  # == Scopes ===============================================================
+
+  # == Instance Methods =====================================================
+
+  # == Class Methods ========================================================
+
+  def self.purge_xkey_cache(*xkeys)
+    return if !VarnishRails.configuration.enable
+
+    xkey_purge = ''
+    xkeys.each do |xkey|
+      xkey_purge = xkey_purge + xkey + ' '
+    end
+    xkey_purge = xkey_purge.strip
+
+    uri                                                         = URI.parse(VarnishRails.configuration.url)
+    http_request                                                = Net::HTTPGenericRequest.new("PURGE", false, false, uri)
+    http_request[VarnishRails.configuration.header_xkey_purge]  = xkey_purge
+    req_options                                                 = { use_ssl: uri.scheme == "https" }
+
+    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+      http.request(http_request)
+    end
+
+    puts "Varnish - purge_xkey_cache - #{xkey_purge}".varnish_debug_color if VarnishRails.configuration.print_requests
+    puts response.inspect.varnish_debug_color if VarnishRails.configuration.print_requests
+  end
+
+  def self.purge_cache(url)
+    return if !VarnishRails.configuration.enable
+
+    uri           = URI.parse("#{VarnishRails.configuration.url}#{url}")
+    http_request  = Net::HTTPGenericRequest.new("PURGE", false, false, uri)
+    req_options   = { use_ssl: uri.scheme == "https" }
+
+    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+      http.request(http_request)
+    end
+
+    puts "Varnish - purge_cache - #{url}".varnish_debug_color if VarnishRails.configuration.print_requests
+    puts response.inspect.varnish_debug_color if VarnishRails.configuration.print_requests
+  end
+
+  def self.ban_cache(pattern)
+    return if !VarnishRails.configuration.enable
+
+    uri                                                       = URI.parse(VarnishRails.configuration.url)
+    http_request                                              = Net::HTTPGenericRequest.new("BAN", false, false, uri)
+    http_request[VarnishRails.configuration.header_x_ban_url] = pattern
+    req_options                                               = { use_ssl: uri.scheme == "https" }
+
+    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+      http.request(http_request)
+    end
+
+    puts "Varnish - ban_cache - #{pattern}".varnish_debug_color if VarnishRails.configuration.print_requests
+    puts response.inspect.varnish_debug_color if VarnishRails.configuration.print_requests
+  end
+
+end

data/lib/varnish_rails/version.rb

@@ -0,0 +1,3 @@
+module VarnishRails
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: varnish_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iXmedia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add Varnish cache headers to controller actions. Automatically purge
+  instances and models on after_create, after_update and after_destroy callbacks.
+email:
+- suivi@ixmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/varnish_rails/install_generator.rb
+- lib/generators/varnish_rails/templates/varnish_rails.rb
+- lib/tasks/varnish_rails_tasks.rake
+- lib/varnish_rails.rb
+- lib/varnish_rails/action_controller_methods.rb
+- lib/varnish_rails/application_record_methods.rb
+- lib/varnish_rails/railtie.rb
+- lib/varnish_rails/varnish_debug_color.rb
+- lib/varnish_rails/varnish_rails_service.rb
+- lib/varnish_rails/version.rb
+homepage: https://github.com/ixmedia/varnish_rails
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Add Varnish cache headers to controller actions.
+test_files: []