fastr-compress 0.0.1

data/README.md

@@ -0,0 +1,22 @@
+fastr-compress
+================
+
+*fastr-compress* is a plugin for [fastr](http://github.com/chrismoos/fastr) that will compress a Rack response body.
+
+how it works
+-------------
+
+The plugin is called after a Rack response has been returned from your application. It will inspect the **Accept-Encoding** header and attempt to encode the response's body if possible. Currently gzip and deflate are supported.
+
+usage
+--------
+
+Add *fastr-compress* to your Gemfile
+
+    source "http://rubygems.org"
+    gem 'fastr-compress'
+    ...
+
+Enable the plugin in your fastr application by modifying your **app/config/settings.rb** file
+
+    config.plugins << Fastr::Compress

data/lib/fastr/compress.rb

@@ -0,0 +1,68 @@
+begin
+  require 'zlib'
+  HAS_ZLIB = true
+rescue
+  HAS_ZLIB = false
+end
+
+require 'stringio'
+require 'fastr/logger'
+
+module Fastr::Compress
+  include Fastr::Log
+
+  ACCEPTABLE_ENCODINGS = [:gzip, :deflate]
+
+  def self.after_boot(app)
+    if HAS_ZLIB
+      logger.debug "Compression plugin loaded."
+    else
+      logger.error "Compression plugin could not be loaded (zlib not found)."
+    end
+  end
+
+  def self.compress(response, encoding)
+    code, hdrs, body = response
+
+    # Set the content encoding header
+    hdrs['Content-Encoding'] = encoding.to_s
+
+    case encoding
+    when :gzip
+      fake_io = StringIO.new
+      gz = Zlib::GzipWriter.new(fake_io, Zlib::DEFAULT_COMPRESSION, Zlib::DEFAULT_STRATEGY)
+      gz.write(body.join(""))
+      gz.close
+      [code, hdrs, [fake_io.string]]
+    when :deflate
+      z = Zlib::Deflate.new(Zlib::DEFAULT_COMPRESSION)
+      dst = z.deflate(body.join(""), Zlib::FINISH)
+      z.close
+      [code, hdrs, [dst.to_s]]
+    else
+      raise StandardError.new("not an acceptable encoding format: #{encoding}")
+    end
+  end
+
+  def self.after_dispatch(app, env, response)
+    return response if not HAS_ZLIB
+    return response if env['HTTP_ACCEPT_ENCODING'].nil?
+
+    code, hdrs, body = response
+
+    # Check to see what the acceptable content encodings are
+    accept_encodings = env['HTTP_ACCEPT_ENCODING'].split(/,/).collect { |e| e.downcase.to_sym }
+    encoding_format = nil
+
+    accept_encodings.each do |enc|
+      if ACCEPTABLE_ENCODINGS.include? enc
+        encoding_format = enc
+        break
+      end
+    end
+
+    return response if encoding_format.nil?
+
+    compress(response, encoding_format)
+  end
+end

data/lib/fastr/compress/version.rb

@@ -0,0 +1,5 @@
+module Fastr
+    module Compress
+        VERSION = "0.0.1"
+    end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: fastr-compress
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Moos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastr
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id001
+description: Compresses output with GZip or Deflate for responses.
+email: 
+- chris@tech9computers.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/fastr/compress/version.rb
+- lib/fastr/compress.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/chrismoos/fastr-compress
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: fastr plugin for compressing output
+test_files: []
+