fastly-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1341f356aab912800b0e0898c11e6b4427b4455
+  data.tar.gz: 31233d8c36f272493f625630131171d89c50a249
+SHA512:
+  metadata.gz: b462f2fcb9e5b89c0ae24274c6e7532fbe56c454d6db265fecd7bb1b8b68430e4a8315c4e243a038a7f59e685a74298650684fd89d4e5755038b1bb4ebc130bd
+  data.tar.gz: 964a2af61358129576c0e41363ba0cffdf9a51d83010691e6aee65480bef2ca8b63ba8aee4af8da7b58115253ab9df2bf3c1f8f0991fcf8045064b349e8a6b5c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Fastly, Inc
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'rubygems'
+  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    = 'FastlyRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/fastly-rails.rb

@@ -0,0 +1,29 @@
+require "fastly-rails/engine"
+require "fastly-rails/client"
+require "fastly-rails/configuration"
+require "fastly-rails/errors"
+
+module FastlyRails
+
+  attr_reader :client, :configuration
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield configuration if block_given?
+  end
+
+  def client
+      raise NoAuthCredentialsProvidedError unless configuration.authenticatable?
+      @client ||= Client.new(
+        :api_key  => configuration.api_key,
+        :user     => configuration.user,
+        :password => configuration.password,
+      )
+  end
+
+  extend self
+
+end

data/lib/fastly-rails/action_controller/cache_control_headers.rb

@@ -0,0 +1,24 @@
+module FastlyRails
+  module CacheControlHeaders
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :set_cache_control_headers, only: [:index, :show]
+    end
+
+    # Sets Cache-Control and Surrogate-Control headers
+    # Surrogate-Control is stripped at the cache, Cache-Control persists (in case of other caches in front of fastly)
+    # Defaults are:
+    #  Cache-Control: 'public, no-cache, s-maxage: 30 days'
+    #  Surrogate-Control: 'max-age: 30 days
+    # custom config example: 
+    #  {cache_control: 'public, no-cache, maxage=xyz', surrogate_control: 'max-age: blah'}
+    def set_cache_control_headers(max_age = FastlyRails.configuration.max_age, opts = {})
+      request.session_options[:skip] = true    # no cookies
+      response.headers['Cache-Control'] = opts[:cache_control] || "public, no-cache"
+      response.headers['Surrogate-Control'] = opts[:surrogate_control] || "max-age=#{max_age}"
+    end
+
+
+  end
+end

data/lib/fastly-rails/action_controller/surrogate_control_headers.rb

@@ -0,0 +1,20 @@
+module FastlyRails
+  module SurrogateControlHeaders
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    # Sets Surrogate-Control header
+    # Defaults are:
+    #  Cache-Control: 'public, no-cache, s-maxage: 30 days'
+    #  Surrogate-Control: 'max-age: 30 days
+    # custom config example: 
+    #  {cache_control: 'blah, blah, blah', surrogate_control: 'max-age: blah'}
+    def set_surrogate_key_header(surrogate_key)
+      request.session_options[:skip] = true    # no cookies
+      response.headers['Surrogate-Key'] = surrogate_key
+    end
+
+  end
+end

data/lib/fastly-rails/active_record/surrogate_key.rb

@@ -0,0 +1,43 @@
+# adds surrogate key instance methods to the models that inherit from activerecord
+module FastlyRails
+  module SurrogateKey
+    extend ActiveSupport::Concern
+
+    included do
+      include InstanceMethods
+    end
+
+    module ClassMethods
+
+      def purge_all
+        FastlyRails.client.purge(table_key)
+      end
+
+      def table_key
+        table_name
+      end
+
+    end
+
+    module InstanceMethods
+
+      def record_key
+        "#{table_key}/#{id}"
+      end
+
+      def table_key
+        self.class.table_key
+      end
+
+      def purge
+        FastlyRails.client.purge(record_key)
+      end
+
+      def purge_all
+        self.class.purge_all
+      end
+
+    end
+
+  end
+end

data/lib/fastly-rails/client.rb

@@ -0,0 +1,17 @@
+require 'fastly'
+
+module FastlyRails
+
+  ### For all intents and purposes
+  ### This is a wrapper around the
+  ### Fastly-ruby client
+
+  class Client < DelegateClass(Fastly)
+
+    def initialize(opts={})
+      super(Fastly.new(opts))
+    end
+
+  end
+
+end

data/lib/fastly-rails/configuration.rb

@@ -0,0 +1,47 @@
+module FastlyRails
+
+  class Configuration
+
+    attr_reader :api_key, :user, :password, :max_age
+
+    MAX_AGE_DEFAULT = '2592000'
+
+    class << self
+
+      def max_age_default
+        MAX_AGE_DEFAULT
+      end
+
+    end
+
+    def initialize
+      @api_key   = nil
+      @user      = nil
+      @password  = nil
+      @max_age   = self.class.max_age_default
+    end
+
+    def api_key=(val)
+      @api_key = val
+    end
+
+    def user=(val)
+      @user = val
+    end
+
+    def password=(val)
+      @password = val
+    end
+
+    def max_age=(val)
+      @max_age = val
+    end
+
+    def authenticatable?
+      !api_key.nil? || (!user.nil? && !password.nil?)
+    end
+
+  end
+
+end
+

data/lib/fastly-rails/engine.rb

@@ -0,0 +1,24 @@
+require 'fastly-rails/active_record/surrogate_key'
+require 'fastly-rails/action_controller/cache_control_headers'
+require 'fastly-rails/action_controller/surrogate_control_headers'
+
+module FastlyRails
+  class Engine < ::Rails::Engine
+    isolate_namespace FastlyRails
+
+    config.generators do |g|
+      g.test_framework      :mini_test, :spec => true, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'test/factories'
+    end
+
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.send :include, FastlyRails::CacheControlHeaders
+      ActionController::Base.send :include, FastlyRails::SurrogateControlHeaders
+    end
+
+    ActiveSupport.on_load :active_record do
+      ActiveRecord::Base.send :include, FastlyRails::SurrogateKey
+    end
+
+  end
+end

data/lib/fastly-rails/errors.rb

@@ -0,0 +1,5 @@
+module FastlyRails
+
+  class NoAuthCredentialsProvidedError < ArgumentError; end
+
+end

data/lib/fastly-rails/version.rb

@@ -0,0 +1,3 @@
+module FastlyRails
+  VERSION = "0.1.0"
+end

data/lib/fastly/purgeable.rb

@@ -0,0 +1,55 @@
+# Object that follows the observer pattern
+# usage:
+# Fastly::Purgeable.new(@article).save!
+# Fastly::Purgeable.new(@article).destroy!
+# This calls save on the @article and then makes a call to fastly to purge from cache
+module Fastly
+  class Purgeable
+
+    def self.initialize()
+    end
+
+
+    # These methods need to hook into activerecord
+    # Calls super
+    # Purges the object from the fastly cache
+    def destroy
+      super
+      @queue << self.resource_key
+    end
+
+    def destroy!
+      super
+      Fastly.purge(self.resource_key)
+    end
+
+    def save
+      super
+      Fastly.purge(self.resource_key)
+    end
+
+    def save!
+      super
+      Fastly.purge(self.resource_key)
+    end
+
+    def update
+      super
+      Fastly.purge(self.resource_key)
+    end
+
+    # updates all records in the table
+    # purge table key
+    def update_all
+      super
+      Fastly.purge(self.table_key)
+    end
+
+    def update_attribute
+    end
+
+    def update_attributes
+    end
+
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/books_controller.rb

@@ -0,0 +1,66 @@
+class BooksController < ApplicationController
+
+  before_filter :find_book, :only => [:show, :edit, :update, :destroy]
+
+  def index
+    @books = Book.all
+  end
+
+  def show
+  end
+
+  def new
+    @book = Book.new
+  end
+
+  def create
+    @book = Book.new(books_params)
+    if @book.save
+      redirect_to books_path
+    else
+      flash[:notice] = "failed to create book"
+      render :new
+    end
+  end
+
+  def edit
+  end
+
+  def update
+    if rails_4?
+      method = :update
+    else
+      method = :update_attributes
+    end
+    if @book.send(method, books_params)
+      redirect_to book_path(@book)
+    else
+      flash[:notice] = "failed to update book"
+      render :edit
+    end
+  end
+
+  def destroy
+    if @book.destroy
+      redirect_to books_path
+    else
+      flash[:notice] = "failed to destroy book"
+      redirect_to book_path(@book)
+    end
+  end
+
+  private
+
+  def books_params
+    if rails_4?
+      params.require(:book).permit!
+    else
+      params[:book]
+    end
+  end
+
+  def find_book
+    @book = Book.find(params[:id])
+  end
+
+end