heroku-readonly 0.0.1

data/lib/heroku/readonly.rb

@@ -0,0 +1,61 @@
+require 'rest_client'
+
+module Heroku
+  class ReadOnly
+    def initialize(options={})
+      @enabled = false
+      @have_polled = false
+      @url = options[:url]
+      @time_between_retries = options[:time_between_retries] || 2
+      @write_cache = options[:write_cache]
+      @read_cache = options[:read_cache]
+    end
+
+    def check
+      Timeout.timeout(1) do
+        RestClient.get(@url) != 'ok'
+      end
+    rescue StandardError, Timeout::Error => e
+      true
+    end
+
+    def poll(attempt=1)
+      result = check
+      if (result == @enabled) || (attempt >= 3)
+        @have_polled = true
+        @enabled = result
+        write_to_cache
+        result
+      elsif attempt < 3
+        sleep(@time_between_retries)
+        poll(attempt+1)
+      end
+    end
+
+    def write_to_cache
+      if @write_cache
+        File.open(@write_cache, 'w') { |f| f.write(@enabled ? 'readonly' : 'ok') }
+      end
+    end
+
+    def read_from_cache
+      if !File.exists?(@read_cache)
+        true
+      elsif File.mtime(@read_cache) < Time.now - 60*5
+        true
+      else
+        File.read(@read_cache).strip != 'ok'
+      end
+    end
+
+    def enabled?
+      if @read_cache
+        read_from_cache
+      elsif !@have_polled
+        raise('never polled, no read_cache')
+      else
+        @enabled
+      end
+    end
+  end
+end

data/spec/readonly_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe Heroku::ReadOnly do
+  let(:url) { "http://foo" }
+  let(:readonly) { Heroku::ReadOnly.new(:url => url, :time_between_retries => 0) }
+
+  it "enabled if the response is a 200 'ok'" do
+    FakeWeb.register_uri(:get, url, :body => "ok")
+    readonly.poll.should be_false
+    readonly.enabled?.should be_false
+  end
+
+  it "enabled if the response has other text" do
+    FakeWeb.register_uri(:get, url, :body => "readonly")
+    readonly.poll.should be_true
+    readonly.enabled?.should be_true
+  end
+
+  it "enabled if the response has another status code" do
+    FakeWeb.register_uri(:get, url, :body => "ok", :status => 503)
+    readonly.poll.should be_true
+    readonly.enabled?.should be_true
+  end
+
+  it "only changes after fetching the same result 3 times" do
+    FakeWeb.register_uri(:get, url, :body => "ok")
+    readonly.poll.should be_false
+    FakeWeb.register_uri(:get, url, [
+      { :body => "readonly" },
+      { :body => "readonly" },
+      { :body => "ok" }
+    ])
+    readonly.poll.should be_false
+    readonly.enabled?.should be_false
+  end
+
+  context "caching" do
+    before do
+      FakeWeb.register_uri(:get, url, :body => "ok")
+    end
+
+    let(:cache) { "/tmp/read_only_spec" }
+    let(:readonly_write) { Heroku::ReadOnly.new(:url => url, :write_cache => cache, :time_between_retries => 0) }
+    let(:readonly_read)  { Heroku::ReadOnly.new(:read_cache => cache) }
+
+    before(:each) do
+      File.unlink(cache) if File.exists?(cache)
+    end
+
+    it "enabled if the cache doesn't exist" do
+      readonly_read.enabled?.should be_true
+    end
+
+    it "enabled if the cache is old" do
+      readonly_write.poll.should be_false
+      old = Time.now - 60*60
+      File.utime(old, old, cache)
+      readonly_read.enabled?.should be_true
+    end
+
+    it "enabled if the cache has non-disabled text" do
+      FakeWeb.register_uri(:get, url, :body => "readonly")
+      readonly_write.poll.should be_true
+      readonly_read.enabled?.should be_true
+    end
+
+    it "not enabled if the cache has disabled text" do
+      readonly_write.poll.should be_false
+      readonly_read.enabled?.should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "rspec/core"
+require "rspec/expectations"
+
+require "rubygems"
+require "fakeweb"
+
+$:.unshift "#{File.dirname(__FILE__)}/../lib/heroku"
+require "readonly"
+
+RSpec.configure do |c|
+  c.run_all_when_everything_filtered = true
+  c.filter_run :focused => true
+  c.alias_example_to :fit, :focused => true
+  c.color_enabled = true
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: heroku-readonly
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Heroku
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-expectations
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-mocks
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id006
+description: 
+email: support@heroku.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/heroku/readonly.rb
+- spec/readonly_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://heroku.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Internal tool
+test_files: []
+