rack-cachely 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.log
+.DS_Store
+doc
+tmp
+pkg
+*.gem
+*.pid
+coverage
+coverage.data
+build/*
+*.pbxuser
+*.mode1v3
+.svn
+profile
+.console_history
+.sass-cache/*
+.rake_tasks~
+*.log.lck
+solr/
+myapp/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-cachely.gemspec
+gemspec
+
+gem 'activesupport'
+gem 'rspec'
+gem 'fakeweb'
+gem 'vcr'

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    rack-cachely (0.0.1)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    i18n (0.6.1)
+    multi_json (1.3.6)
+    rack (1.4.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    vcr (2.2.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  fakeweb
+  rack-cachely!
+  rspec
+  vcr

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Bates
+
+MIT License
+
+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,29 @@
+# Rack::Cachely
+
+THIS IS A WORK IN PROGRESS!!! DO NOT USE!!!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-cachely'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-cachely
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'  
+Bundler::GemHelper.install_tasks
+
+desc "Run tests"
+task :default do
+  system "bundle exec rspec"
+end

data/lib/rack-cachely.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+require 'net/http'
+require 'timeout'
+require 'logger'
+require 'fileutils'
+require 'cgi'
+require 'rack'
+require "rack-cachely/version"
+require "rack-cachely/config"
+require "rack-cachely/context"
+require "rack-cachely/store"
+require "rack-cachely/key"
+
+module Rack
+  class Cachely
+
+    def initialize(app, options = {})
+      @app = app
+      self.class.config = Rack::Cachely::Config.new(options)
+    end
+
+    def call(env)
+      Context.new(@app).call(env)
+    end
+
+    class << self
+
+      attr_accessor :config
+
+    end
+
+  end
+end

data/lib/rack-cachely/config.rb

@@ -0,0 +1,36 @@
+module Rack
+  class Cachely
+    class Config
+
+      attr_accessor :options
+
+      def initialize(options = {})
+        self.options = options
+        self.options[:cachely_api_key] ||= ENV["CACHELY_API_KEY"]
+        self.options[:cachely_url] = "#{(self.options[:cachely_url] ||= ENV["CACHELY_URL"])}/v1/cache?_token=#{self.options[:cachely_api_key]}"
+      end
+
+      def method_missing(sym, *args, &block)
+        if /(.+)=$/.match(sym.to_s)
+          self.options[$1.to_sym] = args[0]
+        else
+          self.options[sym]
+        end
+      end
+
+      def logger
+        self.options[:logger] ||= begin
+          if Object.const_defined?(:Rails)
+            logger = Rails.logger
+          else
+            path = ::File.expand_path("log", ::File.dirname(__FILE__))
+            FileUtils.mkdir_p(path)
+            logger = ::Logger.new(::File.join(path, "#{ENV['RACK_ENV']}.log"))
+          end
+          logger
+        end
+      end
+
+    end
+  end
+end

data/lib/rack-cachely/context.rb

@@ -0,0 +1,59 @@
+module Rack
+  class Cachely
+    class Context
+
+      def initialize(app)
+        @app = app
+      end
+
+      def request
+        @request ||= Rack::Request.new(@env.dup.freeze)
+      end
+
+      def call(env)
+        @env = env
+        if self.perform_caching?
+          results = Rack::Cachely::Store.get(key)
+          if results
+            return results
+          end
+        end
+        results = @app.call(@env)
+        if self.perform_caching? && is_cacheable?(results)
+          Rack::Cachely::Store.post(key, results, age: @age.to_i)
+        end
+        return results
+      end
+
+      def perform_caching?
+        config = if Kernel.const_defined?(:Rails)
+          Rails.application.config.action_controller.perform_caching
+        else
+          @env['rack-cachely.perform_caching'].to_s == 'true'
+        end
+        config && request.request_method == 'GET'
+      end
+
+      def is_cacheable?(results)
+        return false if results[0].to_i != 200
+        headers = results[1]
+        control = headers["Cache-Control"]
+        if /public/.match(control) && /max-age=(\d+)/.match(control)
+          @age = $1
+          return true
+        end
+        return false
+      end
+
+      def key
+        @key ||= Rack::Cachely::Key.new(request)
+      end
+
+      def config
+        Rack::Cachely.config
+      end
+
+    end
+
+  end
+end

data/lib/rack-cachely/key.rb

@@ -0,0 +1,56 @@
+require 'rack/utils'
+
+# Borrowed from Rache::Cache
+module Rack
+  class Cachely
+    class Key
+      include Rack::Utils
+
+      def initialize(request)
+        @request = request
+      end
+
+      # Generate a normalized cache key for the request.
+      def generate
+        @key ||= begin
+          parts = []
+          parts << @request.scheme << "://"
+          parts << @request.host
+
+          if @request.scheme == "https" && @request.port != 443 ||
+              @request.scheme == "http" && @request.port != 80
+            parts << ":" << @request.port.to_s
+          end
+
+          parts << @request.script_name
+          parts << @request.path_info
+
+          if qs = query_string
+            parts << "?"
+            parts << qs
+          end
+
+          parts.join
+        end
+      end
+
+      def to_s
+        self.generate
+      end
+
+      private
+      # Build a normalized query string by alphabetizing all keys/values
+      # and applying consistent escaping.
+      def query_string
+        return nil if @request.query_string.nil?
+
+        @request.query_string.split(/[&;] */n).
+          map { |p| unescape(p).split('=', 2) }.
+          sort.
+          map { |k,v| "#{escape(k)}=#{escape(v)}" }.
+          join('&')
+      end
+    end
+
+  end
+end

data/lib/rack-cachely/store.rb

@@ -0,0 +1,77 @@
+module Rack
+  class Cachely
+    class Store
+      include Singleton
+
+      def self.method_missing(sym, *args, &block)
+        self.instance.send(sym, *args, &block)
+      end
+
+      def get(key)
+        remote do
+          uri = URI("#{config.cachely_url}&url=#{CGI.escape(key.to_s)}")
+          response = Net::HTTP.get_response(uri)
+          if config.verbose
+            logger.info "Cachely [uri]: #{uri}"
+            logger.info "Cachely [response.code]: #{response.code}"
+            logger.info "Cachely [response.body]: #{response.body}"
+          end
+          if response.code.to_i == 200
+            headers = {}
+            response.each_header do |key, value|
+              headers[key] = value
+            end
+            return [response.code.to_i, headers, StringIO.new(response.body)]
+          end
+        end
+        return nil
+      end
+
+      def post(key, rack, options = {})
+        remote do
+          body = rack[2].respond_to?(:body) ? rack[2].body : rack[2]
+          data = {
+            "document[url]" => key,
+            "document[status]" => rack[0].to_i,
+            "document[body]" => body,
+            "document[age]" => options[:age] || 0,
+            "_token" => Rack::Cachely.config.cachely_api_key
+          }
+          rack[1].each do |key, value|
+            data["document[headers][#{key}]"] = value
+          end
+          if config.verbose
+            logger.debug "Cachely [data]: #{data.inspect}"
+          end
+          response = Net::HTTP.post_form(URI(config.cachely_url), data)
+          if config.verbose
+            logger.debug "Cachely [response.code]: #{response.code}"
+            logger.debug "Cachely [response.body]: #{response.body}"
+          end
+        end
+        return true
+      end
+
+      def delete(pattern)
+        Net::HTTP.post_form(URI(config.cachely_url), {_method: "DELETE", pattern: pattern, _token: config.cachely_api_key})
+      end
+
+      def remote(&block)
+        begin
+          Timeout::timeout(0.5, &block)
+        rescue Timeout::Error, Errno::ECONNREFUSED => e
+          logger.error(e)
+        end
+      end
+
+      def config
+        Rack::Cachely.config
+      end
+
+      def logger
+        Rack::Cachely.config.logger
+      end
+
+    end
+  end
+end

data/lib/rack-cachely/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Cachely
+    VERSION = "0.0.1"
+  end
+end

data/rack-cachely.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-cachely/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-cachely"
+  gem.version       = Rack::Cachely::VERSION
+  gem.authors       = ["Mark Bates"]
+  gem.email         = ["mark@markbates.com"]
+  gem.description   = %q{Rack middleware for interfacing with the Cachely page caching service.}
+  gem.summary       = %q{Rack middleware for interfacing with the Cachely page caching service.}
+  gem.homepage      = "http://www.cachelyapp.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("rack")
+end

data/spec/rack-cachely/config_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Rack::Cachely::Config do
+
+  let(:config) { Rack::Cachely::Config.new(foo: 'bar') }
+
+  describe "method_missing" do
+  
+    it "returns a value from the options" do
+      config.foo.should eql("bar")
+    end
+
+    it "returns nil if there is no value" do
+      config.bar.should be_nil
+    end
+
+    it "sets a value into the options" do
+      config.foo = 'FOO'
+      config.foo.should eql("FOO")
+    end
+  
+  end
+
+end

data/spec/rack-cachely/context_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Rack::Cachely::Context do
+
+  
+
+end

data/spec/rack-cachely/key_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Rack::Cachely::Key do
+
+  let(:key) { Rack::Cachely::Key.new(request) }
+
+  describe "generate" do
+  
+    let(:request) { double(scheme: "http", host: "example.com", port: 80, script_name: "/foo", path_info: "/bar", query_string: "b=B&a=A") }
+
+    it "returns a uniformed url" do
+      key.to_s.should eql("http://example.com/foo/bar?a=A&b=B")
+    end
+  
+  end
+
+end

data/spec/rack-cachely/store_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe Rack::Cachely::Store do
+
+  let(:key) { "http://example.com" }
+  let(:store) { Rack::Cachely::Store }
+
+  describe "get" do
+  
+    it "retreives a page from the service" do
+      mock = double(code: "200", body: "hello!")
+      mock.stub!(:each_header).and_yield("Content-Type", "text/html")
+      Net::HTTP.stub!(:get_response).and_return(mock)
+
+      res = store.get(key)
+      res[0].should eql(200)
+      res[1].should eql("Content-Type" => "text/html")
+      res[2].read.should eql("hello!")
+    end
+
+    it "returns nil if no page is found" do
+      Net::HTTP.stub!(:get_response).and_return(double(code: "404"))
+
+      store.get(key).should be_nil
+    end
+
+    it "rescues from a timeout" do
+      Net::HTTP.stub!(:get_response).and_raise(Timeout::Error)
+      expect {
+        store.get(key).should be_nil
+      }.to_not raise_error(Timeout::Error)
+    end
+  
+  end
+
+  describe "post" do
+
+    let(:rack) { [200, {"Content-Type" => "text/html"}, "hello!"] }
+    let(:data) do
+      {
+        "document[url]" => "http://example.com", 
+        "document[status]" => 200, 
+        "document[body]" => "hello!", 
+        "document[age]" => 30, 
+        "document[headers][Content-Type]"=>"text/html",
+        "_token" => Rack::Cachely.config.cachely_api_key
+      }
+    end
+    
+    context "pure string" do
+      
+      it "adds a page to the service" do
+        Net::HTTP.should_receive(:post_form).with(URI(Rack::Cachely.config.cachely_url), data)
+
+        store.post(key, rack, age: 30)
+      end
+
+    end
+
+    context "with .body" do
+
+      it "adds a page to the service" do
+        rack[2] = double(body: "hello!")
+        Net::HTTP.should_receive(:post_form).with(URI(Rack::Cachely.config.cachely_url), data)
+
+        store.post(key, rack, age: 30)
+      end  
+
+    end
+
+    it "rescues from a timeout" do
+      Net::HTTP.stub!(:post_form).and_raise(Timeout::Error)
+      expect {
+        store.post(key, rack, age: 30)
+      }.to_not raise_error(Timeout::Error)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV["RACK_ENV"] ||= "test"
+
+require 'bundler/setup'
+
+require 'rack-cachely' # and any other gems you need
+require 'active_support/core_ext'
+require 'vcr'
+
+Dir[File.expand_path(File.join("support", "**", "*.rb"), File.dirname(__FILE__))].each {|f| require f}
+
+RSpec.configure do |config|
+
+  config.before do
+    Rack::Cachely.config = Rack::Cachely::Config.new(cachely_api_key: '1234567890', cachely_url: "http://localhost:9292")
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rack-cachely
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware for interfacing with the Cachely page caching service.
+email:
+- mark@markbates.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-cachely.rb
+- lib/rack-cachely/config.rb
+- lib/rack-cachely/context.rb
+- lib/rack-cachely/key.rb
+- lib/rack-cachely/store.rb
+- lib/rack-cachely/version.rb
+- rack-cachely.gemspec
+- spec/rack-cachely/config_spec.rb
+- spec/rack-cachely/context_spec.rb
+- spec/rack-cachely/key_spec.rb
+- spec/rack-cachely/store_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.cachelyapp.com
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware for interfacing with the Cachely page caching service.
+test_files:
+- spec/rack-cachely/config_spec.rb
+- spec/rack-cachely/context_spec.rb
+- spec/rack-cachely/key_spec.rb
+- spec/rack-cachely/store_spec.rb
+- spec/spec_helper.rb