timestamper 0.0.2

data/Manifest

@@ -0,0 +1,14 @@
+README.rdoc
+Rakefile
+lib/timestamper.rb
+lib/timestamper/activeresource.rb
+lib/timestamper/configuration.rb
+lib/timestamper/rack_middleware.rb
+lib/timestamper/timestamper.rb
+spec/fixtures.rb
+spec/lib_specs/activeresource_spec.rb
+spec/lib_specs/configuration_spec.rb
+spec/lib_specs/rack_spec.rb
+spec/lib_specs/timestamper_spec.rb
+spec/spec_helper.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,16 @@
+= Use
+
+Timestamper allows you to automatically set http response's header Last-Modified with value from ActiveResource or ActiveRecord. Currently only supports ActiveResource.
+
+= Configuration
+
+  Timestamper.config do
+    updated_at_column :updated_at  # global default column
+  end
+
+  class Article
+    timestamper_column :last_modified  # custom timestamp column
+  end
+
+To configure rack middleware in a Rails app, add following line to config/environment.rb.
+  ActionController::Dispatcher.middleware.use Timestamper::RackMiddleware

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('timestamper', '0.0.2') do |p|
+  p.description    = "This gem sets Last-Modified in http response header with timestamp extracted from ActiveResource."
+  p.url            = "http://github.com/dorren/timestamper"
+  p.author         = "Dorren Chen"
+  p.email          = "dorrenchen@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/lib/timestamper.rb

@@ -0,0 +1,6 @@
+require 'singleton'
+require 'activeresource'
+require 'timestamper/timestamper'
+require 'timestamper/activeresource'
+require 'timestamper/configuration'
+require 'timestamper/rack_middleware'

data/lib/timestamper/activeresource.rb

@@ -0,0 +1,21 @@
+module ActiveResource
+  class Base
+    class << self
+      def timestamper_column(column)
+        @timestamper_column = column
+      end
+      
+      private 
+      def new_with_timestamper(*args)
+        returning new_without_timestamper(*args) do |record|
+          next if !Timestamper.configuration.reportable?(record.class)  # return triggers "LocalJumpError: unexpected return"
+          
+          column = @timestamper_column || Timestamper.configuration.updated_at_column
+          Timestamper.instance.updated_at = record.send(column) if record.respond_to?(column)
+        end
+      end
+      
+      alias_method_chain :new, :timestamper
+    end
+  end
+end

data/lib/timestamper/configuration.rb

@@ -0,0 +1,37 @@
+class Timestamper
+  class Configuration
+    attr_accessor :updated_at_column
+    
+    def initialize
+      @updated_at_column = :updated_at
+      @exclude = []
+      @only = []
+    end
+    
+    def exclude(*args)
+      @exclude += args
+    end
+    
+    def excluded_models
+      @exclude.dup
+    end
+    
+    def only(*args)
+      @only += args
+    end
+    
+    def only_models
+      @only.dup
+    end
+    
+    def reportable?(klass)
+      return true if @exclude.empty? and @only.empty?
+      
+      if @only.empty?
+        !@exclude.include?(klass)
+      else
+        (@only - @exclude).include?(klass)
+      end 
+    end
+  end
+end

data/lib/timestamper/rack_middleware.rb

@@ -0,0 +1,24 @@
+class Timestamper
+  class RackMiddleware
+    def initialize(app)
+      @app = app
+    end
+  
+    def call(env)
+      Timestamper.instance.reset
+      status, headers, response = @app.call(env)
+      if headers["Content-Type"].to_s =~ /^text\/html/
+
+        if status == 200 and headers['Last-Modified'].nil?
+          timestamp = Timestamper.instance.updated_at || Time.now
+          headers['Last-Modified'] = timestamp.httpdate
+        end
+        # rails return response object with body method, sinatra just returns array of 1 string
+        response = response.respond_to?(:body) ? response.body : response
+        [status, headers, response]
+      else
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/timestamper/timestamper.rb

@@ -0,0 +1,26 @@
+
+class Timestamper 
+  include Singleton
+  attr_accessor :updated_at, :override
+  
+  def reset
+    @override = nil
+    @updated_at = nil
+  end
+  
+  def updated_at
+    @override ? @override : @updated_at
+  end
+  
+  def updated_at=(time)
+    @updated_at = time if self.updated_at.nil? or time > self.updated_at
+  end
+  
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  def self.config(&block)
+    configuration.instance_eval(&block)
+  end
+end

data/spec/fixtures.rb

@@ -0,0 +1,8 @@
+
+# testing fixtures
+class Content < ActiveResource::Base
+  self.site = ""
+end
+class Article < Content; end
+class Page    < Content; end
+class Comment < Content; end

data/spec/lib_specs/activeresource_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ActiveResource::Base do
+  before do
+    @today = Time.now
+    @yesterday = 1.day.ago
+    @tomorrow = 1.day.from_now
+    Timestamper.instance.reset
+  end
+  
+  describe "#new" do
+    it "should report updated_at time" do
+      Timestamper.instance.updated_at.should be_nil
+      Article.new :updated_at => @today
+      Timestamper.instance.updated_at.should == @today
+    end
+  end
+
+  describe "#new_with_timestamper" do
+    it "should not set time if class is not reportable" do
+      class Draft < Content; end
+      
+      Timestamper.instance.updated_at.should be_nil
+      Timestamper.configuration.exclude Draft
+      Draft.new :updated_at => @today
+      Timestamper.instance.updated_at.should be_nil
+    end
+  end
+
+  describe "##timestamper_column" do
+    class MyArticle < Content; end
+    it "should set timestamper_column" do
+      MyArticle.class_eval do
+        timestamper_column :last_modified
+      end
+      Timestamper.instance.updated_at.should be_nil
+      MyArticle.new :last_modified => @today
+      Timestamper.instance.updated_at.should == @today
+    end
+  end
+  
+end

data/spec/lib_specs/configuration_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Timestamper::Configuration do
+  before(:each) do
+    @config = Timestamper::Configuration.new
+  end
+  
+  describe "#exclude" do
+    it "should exclude selected models" do
+      @config.exclude Article, Page
+      @config.excluded_models.should == [Article, Page]
+    end    
+  end
+  
+  describe "#only" do
+    it "should only have selected models" do
+      @config.only Article
+      @config.only_models.should == [Article]
+    end
+  end
+  
+  describe "#reportable?" do
+    it "should query whether model is reportable?" do
+      @config.reportable?(Article).should be_true
+      
+      @config.only Article
+      @config.reportable?(Article).should be_true
+      @config.reportable?(Page).should be_false
+  
+      @config.exclude Article
+      @config.reportable?(Article).should be_false
+      @config.reportable?(Page).should be_false
+      
+      @config = Timestamper::Configuration.new
+      @config.exclude Article
+      @config.reportable?(Article).should be_false
+      @config.reportable?(Page).should be_true
+      
+      @config.only Article
+      @config.reportable?(Article).should be_false
+      @config.reportable?(Page).should be_false
+    end
+  end
+  
+  describe "#updated_at_column" do
+    it "should set updated_at_column" do
+      @config.updated_at_column = :updated_at
+      @config.updated_at_column.should == :updated_at
+    end
+  end
+end

data/spec/lib_specs/rack_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'rack/test'
+require 'sinatra/base'
+require 'timestamper/rack_middleware'
+require 'active_resource/http_mock'
+
+class MyApp < Sinatra::Base 
+  use Timestamper::RackMiddleware 
+  
+  get "/" do
+    "homepage"
+  end
+  
+  get "/articles" do
+    @article1 = Article.find 1
+    'articles'
+  end
+end
+
+describe Timestamper::RackMiddleware do
+  include Rack::Test::Methods
+  before(:each) do
+    @today = Time.now
+    @yesterday = 1.day.ago
+    @tomorrow = 1.day.from_now
+    Timestamper.instance.reset
+
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get    "/articles/1.xml", {}, {:id => 1, :updated_at => @yesterday}.to_xml(:root => "article")
+    end
+  end
+  
+  def app
+    my_app = MyApp.new
+  end
+  
+  def log_response_body(str)
+    File.open('response.html', 'w') do |f|
+      f.write str
+    end
+  end
+  
+  it "should have default Last-Modified http header" do
+    get "/"
+    last_response.body.should == "homepage"
+    last_response.headers["Last-Modified"].should_not be_nil
+  end
+  
+  it "should set Last-Modified time from article" do
+    get "/articles"
+    last_response.body.should == "articles"
+    last_response.headers["Last-Modified"].should == @yesterday.httpdate
+  end
+end

data/spec/lib_specs/timestamper_spec.rb

@@ -0,0 +1,78 @@
+
+
+describe Timestamper do
+  before do
+    @today = Time.now
+    @yesterday = 1.day.ago
+    @tomorrow = 1.day.from_now
+    Timestamper.instance.reset
+  end
+  
+  describe "#instance" do
+    it "should implement singleton pattern" do
+      proc {Timestamper.new}.should raise_error
+      proc {Timestamper.instance}.should_not raise_error
+    end
+  end
+
+  describe "#reset" do
+    it "should reset itself" do
+      Timestamper.instance.updated_at = @today
+      Timestamper.instance.override = @yesterday
+      Timestamper.instance.reset
+      Timestamper.instance.updated_at.should be_nil
+      Timestamper.instance.override.should be_nil
+    end
+  end
+
+  describe "#update_at" do
+    it "should be able to set updated_at time" do
+      Timestamper.instance.updated_at.should be_nil
+      Timestamper.instance.updated_at = @today
+      Timestamper.instance.updated_at.should == @today    
+    end
+  
+    it "should only change updated_at time if the new value is the latest time" do
+      Timestamper.instance.updated_at = @tomorrow
+      Timestamper.instance.updated_at = @today
+      Timestamper.instance.updated_at.should == @tomorrow
+    end
+  end
+  
+  describe "#override" do
+    it "should override current updated_at value when updated_at is nil" do
+      Timestamper.instance.updated_at.should be_nil
+      Timestamper.instance.override = @today
+      Timestamper.instance.updated_at.should == @today
+    end
+    
+    it "should override current updated_at value" do
+      Timestamper.instance.updated_at = @tomorrow
+      Timestamper.instance.override = @today
+      Timestamper.instance.updated_at.should == @today
+      
+      Timestamper.instance.updated_at = @today + 2.days
+      Timestamper.instance.updated_at.should == @today
+    end
+  end
+  
+  describe "##configuration" do
+    it "should return an instance of Timestamper::Configuration" do
+      Timestamper.configuration.class.should == Timestamper::Configuration
+    end
+  end
+  
+  
+  
+  describe "##config" do
+    it "should accept a block" do
+      proc {Timestamper.config {}}.should_not raise_error
+    end
+    
+    it "should evaluate the block within the Timestamper.configuration instance" do
+      Timestamper.config do
+        self.should == Timestamper.configuration
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << './lib'
+require 'timestamper'
+require 'fixtures'

data/timestamper.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{timestamper}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dorren Chen"]
+  s.date = %q{2010-04-14}
+  s.description = %q{This gem sets Last-Modified in http response header with timestamp extracted from ActiveResource.}
+  s.email = %q{dorrenchen@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/timestamper.rb", "lib/timestamper/activeresource.rb", "lib/timestamper/configuration.rb", "lib/timestamper/rack_middleware.rb", "lib/timestamper/timestamper.rb"]
+  s.files = ["README.rdoc", "Rakefile", "lib/timestamper.rb", "lib/timestamper/activeresource.rb", "lib/timestamper/configuration.rb", "lib/timestamper/rack_middleware.rb", "lib/timestamper/timestamper.rb", "spec/fixtures.rb", "spec/lib_specs/activeresource_spec.rb", "spec/lib_specs/configuration_spec.rb", "spec/lib_specs/rack_spec.rb", "spec/lib_specs/timestamper_spec.rb", "spec/spec_helper.rb", "Manifest", "timestamper.gemspec"]
+  s.homepage = %q{http://github.com/dorren/timestamper}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Timestamper", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{timestamper}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{This gem sets Last-Modified in http response header with timestamp extracted from ActiveResource.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: timestamper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dorren Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-14 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: This gem sets Last-Modified in http response header with timestamp extracted from ActiveResource.
+email: dorrenchen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/timestamper.rb
+- lib/timestamper/activeresource.rb
+- lib/timestamper/configuration.rb
+- lib/timestamper/rack_middleware.rb
+- lib/timestamper/timestamper.rb
+files: 
+- README.rdoc
+- Rakefile
+- lib/timestamper.rb
+- lib/timestamper/activeresource.rb
+- lib/timestamper/configuration.rb
+- lib/timestamper/rack_middleware.rb
+- lib/timestamper/timestamper.rb
+- spec/fixtures.rb
+- spec/lib_specs/activeresource_spec.rb
+- spec/lib_specs/configuration_spec.rb
+- spec/lib_specs/rack_spec.rb
+- spec/lib_specs/timestamper_spec.rb
+- spec/spec_helper.rb
+- Manifest
+- timestamper.gemspec
+has_rdoc: true
+homepage: http://github.com/dorren/timestamper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Timestamper
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: timestamper
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: This gem sets Last-Modified in http response header with timestamp extracted from ActiveResource.
+test_files: []
+