expire_me 0.0.1

data/License

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Colin Young
+
+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,27 @@
+I have no clue what this library does.
+
+# Pro Tip
+
+To not have too many boilerplate commits (so you avoid ppl from thinking "WTF?
+Why did he/she start with rspec but instantly switched to minitest, and what's
+all that nonsense in the readme?") use `git commit --amend` to make changes in
+the initial commit rather than creating new commits. Just saying.
+
+# Usage
+
+``` ruby
+require 'expire_me'
+fail("Dunno how to use %p" % ExpireMe)
+```
+
+# Installation
+
+    gem install expire_me
+
+# TODO
+
+* Write code and documentation
+* Fix project description in gemspec
+* Change testing framework if necessary (see Rakefile, currently RSpec)
+* Adjust expire_me.gemspec if your github name is not colinyoung
+* Adjust License if your real name is not Colin Young

data/Rakefile

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue LoadError => e
+  $stderr.puts e
+end
+
+desc "run specs"
+task(:spec) { ruby '-S rspec spec' }
+
+desc "generate gemspec"
+task 'expire_me.gemspec' do
+  require 'expire_me/version'
+  content = File.read 'expire_me.gemspec'
+
+  fields = {
+    :authors => `git shortlog -sn`.scan(/[^\d\s].*/),
+    :email   => `git shortlog -sne`.scan(/[^<]+@[^>]+/),
+    :files   => `git ls-files`.split("\n").reject { |f| f =~ /^(\.|Gemfile)/ }
+  }
+
+  fields.each do |field, values|
+    updated = "  s.#{field} = ["
+    updated << values.map { |v| "\n    %p" % v }.join(',')
+    updated << "\n  ]"
+    content.sub!(/  s\.#{field} = \[\n(    .*\n)*  \]/, updated)
+  end
+
+  content.sub! /(s\.version.*=\s+).*/, "\\1\"#{ExpireMe::VERSION}\""
+  File.open('expire_me.gemspec', 'w') { |f| f << content }
+end
+
+task :gemspec => 'expire_me.gemspec'
+task :default => :spec
+task :test    => :spec

data/expire_me.gemspec

@@ -0,0 +1,42 @@
+# Run `rake expire_me.gemspec` to update the gemspec.
+Gem::Specification.new do |s|
+  # general infos
+  s.name        = "expire_me"
+  s.version     = "0.0.1"
+  s.description = "control varnish expiration"
+  s.homepage    = "http://github.com/colinyoung/expire_me"
+  s.summary     = s.description
+
+  # generated from git shortlog -sn
+  s.authors = [
+    "Colin Young"
+  ]
+
+  # generated from git shortlog -sne
+  s.email = [
+    "me@colinyoung.com"
+  ]
+  
+  s.add_dependency 'activesupport', ['>= 2.3.9', '< 4']
+
+  # generated from git ls-files
+  s.files = [
+    "License",
+    "README.md",
+    "Rakefile",
+    "expire_me.gemspec",
+    "lib/expire_me.rb",
+    "lib/expire_me/adapter.rb",
+    "lib/expire_me/adapters/varnish.rb",
+    "lib/expire_me/expire.rb",
+    "lib/expire_me/railtie.rb",
+    "lib/expire_me/response.rb",
+    "lib/expire_me/version.rb",
+    "spec/expire_me_spec.rb",
+    "test/test.rb",
+    "test/test_helper.rb"
+  ]
+
+  # dependencies
+  s.add_development_dependency "rspec", "~> 2.0"
+end

data/lib/expire_me/adapter.rb

@@ -0,0 +1,30 @@
+module ExpireMe
+  class Adapter
+    
+    attr_accessor :response
+    
+    def set_expiration(r, seconds=0)
+      self.response = r
+    end
+    
+    def self.select(adapter_name)
+      return self.new if self.name != Adapter.to_s
+      
+      (ExpireMe.const_get adapter_name.to_s.classify).new
+    end
+    
+  end
+end
+
+class Regexp
+  def unregex
+    puts "unr: #{self.to_s}"
+    s = self.to_s.gsub('?i-mx:', ''). # Remove initial ruby stuff
+      gsub(/(\=\)|)\(\[0-9\]\+\)/, '='). # Empties the value subgroup, heavily escaped because we're operating on a regex
+      gsub(/[^\d\w\-\=]/, '') # Replaces all nondigits and words
+    puts s
+    s
+  end
+end
+
+Dir[File.expand_path("../adapters/*.rb", __FILE__)].each {|f| require f }

data/lib/expire_me/adapters/varnish.rb

@@ -0,0 +1,42 @@
+module ExpireMe
+  class Varnish < Adapter
+    
+    PARTS = {
+      :age => /(max\-age=)([0-9]+)/i
+    }
+    
+    def set_expiration(response, seconds)
+      super
+      
+      puts "Caching page for seconds: #{seconds}"
+      replace_caching_header :age => seconds
+    end
+    
+    private
+    
+    def replace_caching_header(h)
+      needle = PARTS[h.keys.first]
+      value = h.values.first
+      return if value.nil? or needle.nil?
+      
+      if header =~ needle
+        self.header.interpolate! needle, value
+      else
+        if header.empty?
+          self.header = needle.unregex << value.to_s
+        else
+          self.header = self.header << header[needle, 1] << value.to_s
+        end
+      end
+    end
+    
+    def header
+      response.headers['Cache-Control'] || ""
+    end
+    
+    def header=(s)
+      response.headers['Cache-Control'] = s
+    end
+    
+  end
+end

data/lib/expire_me/expire.rb

@@ -0,0 +1,47 @@
+module ExpireMe
+  
+  class << self
+    
+    @@seconds = 0
+      
+    def expire=(descriptor, options={})
+      
+      seconds = 0 # Reset for each request.
+      
+      if options.empty?
+        self.send :in, descriptor
+      else
+        self.send descriptor, options        
+      end
+    end
+    
+    def expire_http_response(http_response)
+      Response.new({
+        :http_response => http_response,
+        :seconds => @@seconds,
+        :adapter => adapter
+      })
+    end
+  
+    private
+    
+    def adapter
+      # Maybe we'll support others later.
+      ExpireMe::Adapter.select(:varnish)
+    end
+  
+    def at time
+      @@seconds = (time - Time.now).to_i
+    end
+    
+    def in seconds
+      @@seconds = seconds
+    end
+  
+    def now
+      @@seconds = 0
+    end
+  
+  end
+  
+end

data/lib/expire_me/railtie.rb

@@ -0,0 +1,32 @@
+require 'rails'
+
+module ExpireMe
+  
+  module Controller
+    def expire_me(descriptor, options={})
+      ExpireMe.expire = descriptor, options
+      
+      include ExpireMe::Controller::InstanceMethods
+      after_filter :update_cache_expiration
+    end
+    
+    def no_cache
+      expire_me :now
+    end
+    
+    module InstanceMethods
+      
+      def update_cache_expiration
+        ExpireMe.expire_http_response(response)
+      end
+      
+    end
+  end
+  
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ApplicationController.send(:extend, ExpireMe::Controller)
+    end
+  end
+  
+end

data/lib/expire_me/response.rb

@@ -0,0 +1,17 @@
+module ExpireMe
+  class Response
+      
+    attr_accessor :hash
+    
+    def initialize(h={ :adapter => nil, :seconds => 0, :http_response => nil })
+      self.hash = h
+      adapter.set_expiration(http_response, seconds)
+    end
+      
+    def method_missing(t)
+      hash[t]
+    end
+  
+  end
+  
+end

data/lib/expire_me/version.rb

@@ -0,0 +1,42 @@
+module ExpireMe
+  def self.version
+    VERSION
+  end
+
+  module VERSION
+    extend Comparable
+
+    MAJOR     = 0
+    MINOR     = 0
+    TINY      = 1
+    SIGNATURE = [MAJOR, MINOR, TINY]
+    STRING    = SIGNATURE.join '.'
+
+    def self.major; MAJOR  end
+    def self.minor; MINOR  end
+    def self.tiny;  TINY   end
+    def self.to_s;  STRING end
+
+    def self.hash
+      STRING.hash
+    end
+
+    def self.<=>(other)
+      other = other.split('.').map { |i| i.to_i } if other.respond_to? :split
+      SIGNATURE <=> Array(other)
+    end
+
+    def self.inspect
+      STRING.inspect
+    end
+
+    def self.respond_to?(meth, *)
+      meth.to_s !~ /^__|^to_str$/ and STRING.respond_to? meth unless super
+    end
+
+    def self.method_missing(meth, *args, &block)
+      return super unless STRING.respond_to?(meth)
+      STRING.send(meth, *args, &block)
+    end
+  end
+end

data/lib/expire_me.rb

@@ -0,0 +1,17 @@
+require 'active_support'
+require 'active_support/inflector'
+
+classes = \
+[
+  :version,
+  :railtie,
+  :expire,
+  :adapter,
+  :response
+]
+
+classes.map {|c| require File.expand_path("../expire_me/#{c}", __FILE__) }
+
+module ExpireMe
+  
+end

data/spec/expire_me_spec.rb

@@ -0,0 +1,5 @@
+require 'expire_me'
+
+describe ExpireMe do
+  it "should behave"
+end

data/test/test.rb

@@ -0,0 +1,5 @@
+require 'test_helper'
+
+class MyController < ApplicationController
+  expire_me :now
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require File.expand_path('../../lib/expire_me', __FILE__)
+
+if not defined? ApplicationController
+  class ApplicationController
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: expire_me
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Colin Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-03 00:00:00.000000000 -06:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70338508618260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70338508618260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70338508617140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70338508617140
+description: control varnish expiration
+email:
+- me@colinyoung.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- License
+- README.md
+- Rakefile
+- expire_me.gemspec
+- lib/expire_me.rb
+- lib/expire_me/adapter.rb
+- lib/expire_me/adapters/varnish.rb
+- lib/expire_me/expire.rb
+- lib/expire_me/railtie.rb
+- lib/expire_me/response.rb
+- lib/expire_me/version.rb
+- spec/expire_me_spec.rb
+- test/test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/colinyoung/expire_me
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: control varnish expiration
+test_files: []