rack-olark 0.0.3 → 0.0.4

data/README.md

@@ -1,16 +1,31 @@
 # Rack Olark
-Rack middleware which injects the Olark JavaScript code before the end of the body of any HTML document being sent to the client. Code from rack/google-analytics has been used liberally and expanded/trimmed down where needed. Mucho thanks to Lee Hambley and other cool rack/google-analytics bros.
+Rack middleware which injects the Olark JavaScript code before the end of the body of any HTML document being sent to the client. 
 
 ## Usage
 
     require 'rack/olark'
-    use Rack::Olark, :id => '1234-567-89-0123', :options => 'like', :this => true, :orthis => 45
+    use Rack::Olark, :id => '1234-567-89-0123'
 
-Options become this line of JavaScript:
+Most of the options you give Rack::Olark are passed along to Olark in the following format:
 
     olark.configure('key', value);
 
-Strings are quoted for you, you needn't worry about that.
+There are three special options: :id, :format, and :paths. :id is your Olark API ID, and the middleware won't let your Rack app boot without it.
+
+:format is my (possibly lame) justification for using Haml in this project - this option is passed directly to Haml::Engine, and determines the form of the script tags that are inserted into your pages. Choices are :html4, :xhtml, and :html5, with a default of :html5.
+
+:paths decides which routes in your application will display the Olark chat box. It takes an array of routes, and you need to include the leading slash (/). As of version 0.0.4, you can now describe routes in the :paths array with a Regexp as well, and any non-Regexp entries will be handled like this:
+
+    /^#{Regexp.escape(your_original_path_entry)}$/
+
+Example using options:
+
+    require 'rack/olark'
+    use Rack::Olark, :id => '1234-567-89-0123', :format => :xhtml, :paths => ['/', '/aboutus'], 'box.corner_position' => 'BL', 'box.start_hidden' => true
+
+## Acknowledgements
+
+Code from rack/google-analytics has been used liberally and expanded/trimmed down where needed. Mucho thanks to Lee Hambley and other cool rack/google-analytics bros.
 
 ## Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/rack/olark.rb

@@ -10,7 +10,7 @@ module Rack
       raise ArgumentError, "Need a valid Olark ID!" unless options[:id] and options[:id].length.eql? 16
       @app, @options = app, Defaults.merge(options)
       @id, @format, @paths = [@options.delete(:id), @options.delete(:format), @options.delete(:paths)]
-      @paths = [] unless @paths.class.eql? Array
+      @paths = @paths.class.eql?(Array) ? @paths.map {|path| path.class.eql?(Regexp) ? path : /^#{Regexp.escape(path.to_s)}$/} : []
       @option_js = "olark.identify('#{@id}');"
       @options.each do |key, val|
         @option_js << "olark.configure('#{key.to_s}', #{[String, Symbol].include? val.class ? "'#{val.to_s}'" : val.to_s});"
@@ -22,8 +22,9 @@ module Rack
     end
 
     def _call(env)
-      @status, @headers, @response = @app.call(env)
-      return [@status, @headers, @response] unless html? and (@paths.empty? or @paths.include? Rack::Request.new(env).path_info)
+      @status, @headers, @response = @app.call env
+      @request = Rack::Request.new env
+      return [@status, @headers, @response] unless html? and (@paths.empty? or @paths.select {|path| @request.path_info =~ path}.length > 0)
       response = Rack::Response.new [], @status, @headers
       @response.each {|fragment| response.write inject(fragment)}
       response.finish

data/rack-olark.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.email       = ["dan.poggi@gmail.com"]
   s.homepage    = "https://github.com/dpoggi/rack-olark"
   s.summary     = %q{Rack middleware for embedding Olark.}
-  s.description = %q{Rack middleware which injects the Olark JavaScript code before the end of the body of any HTML document being sent to the client. Code from rack/google-analytics has been used liberally and expanded/trimmed down where needed. Mucho thanks to Lee Hambley and other cool rack/google-analytics bros.}
+  s.description = %q{Rack middleware which injects the Olark JavaScript code before the end of the body of any HTML document being sent to the client. See README.md for details.}
 
   s.rubyforge_project = "rack-olark"
 

metadata

@@ -2,7 +2,7 @@
 name: rack-olark
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Dan Poggi
@@ -34,7 +34,7 @@ dependencies:
         version: 3.1.1
   type: :runtime
   version_requirements: *id002
-description: Rack middleware which injects the Olark JavaScript code before the end of the body of any HTML document being sent to the client. Code from rack/google-analytics has been used liberally and expanded/trimmed down where needed. Mucho thanks to Lee Hambley and other cool rack/google-analytics bros.
+description: Rack middleware which injects the Olark JavaScript code before the end of the body of any HTML document being sent to the client. See README.md for details.
 email: 
 - dan.poggi@gmail.com
 executables: []
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rack-olark
-rubygems_version: 1.7.2
+rubygems_version: 1.8.0
 signing_key: 
 specification_version: 3
 summary: Rack middleware for embedding Olark.