rack-olark 0.0.6 → 0.0.7

data/Gemfile

@@ -1,3 +1,2 @@
-source 'http://rubygems.org/'
-
+source :rubygems
 gemspec

data/LICENSE

@@ -1,25 +1,7 @@
-Copyright 2011 Dan Poggi. All rights reserved.
+Copyright (C) 2012 Dan Poggi
 
-Redistribution and use in source and binary forms, with or without modification, are
-permitted provided that the following conditions are met:
+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:
 
-   1. Redistributions of source code must retain the above copyright notice, this list of
-      conditions and the following disclaimer.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-   2. Redistributions in binary form must reproduce the above copyright notice, this list
-      of conditions and the following disclaimer in the documentation and/or other materials
-      provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are those of the
-authors and should not be interpreted as representing official policies, either expressed
-or implied, of Dan Poggi.
+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

@@ -3,23 +3,25 @@ Rack middleware which injects the Olark JavaScript code before the end of the bo
 
 ## Usage
 
-    use Rack::Olark, :id => '1234-567-89-0123'
+    use Rack::Olark, id: '1234-567-89-0123'
 
 Most of the options you give Rack::Olark are passed along to Olark in the following format:
 
     olark.configure('key', value);
 
-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.
+There are three special options: id, tag, 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.
+tag is a custom <script> tag to be used at the beginning of the Olark code. Most people shouldn't need this, and it will default to just <script> (HTML5-style). 
 
-: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 (/). If you don't give an array for :paths, it is empty by default, and this will cause the Olark code to be inserted on every route. 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:
+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 (/). If you don't give an array for paths, it is empty by default, and this will cause the Olark code to be inserted on every route. 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:
 
-    use Rack::Olark, :id => '1234-567-89-0123', :format => :xhtml, :paths => ['/', '/aboutus'], 'box.corner_position' => 'BL', 'box.start_hidden' => true
+    use Rack::Olark, id: '1234-567-89-0123',
+                     tag: '<script type="text/javascript">',
+                     paths: ['/', '/aboutus']
 
 ## Acknowledgements
 
@@ -27,4 +29,4 @@ Code from rack/google-analytics has been used liberally and expanded/trimmed dow
 
 ## Copyright
 
-Copyright (c) 2011 Dan Poggi. License is 2-clause BSD, see LICENSE for details.
+Copyright (C) 2012 Dan Poggi. MIT License, see LICENSE for details.

data/Rakefile

@@ -1,2 +1 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/rack/olark.rb

@@ -1,53 +1,59 @@
 require 'rack'
 require 'rack/request'
-require 'haml'
+require 'erb'
 
 module Rack
   class Olark
-    Defaults = {:format => :html5, :paths => []}
+    DEFAULTS = {
+      tag: '<script>',
+      paths: []
+    }
 
     def initialize(app, options = {})
-      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 = @paths.class.eql?(Array) ? @paths.map do |path|
-        path.class.eql?(Regexp) ? path : /^#{Regexp.escape(path.to_s)}$/
-      end : []
+      unless options[:id] && options[:id].length == 16
+        raise ArgumentError, 'Need a valid Olark ID!'
+      end
+      @app, @options = app, DEFAULTS.merge(options)
+      @id, @tag, @paths = [@options.delete(:id),
+                           @options.delete(:tag),
+                           @options.delete(:paths)]
+
+      if @paths.is_a?(Array)
+        @paths.map! { |path| path.is_a?(Regexp) ? path : /^#{Regexp.escape(path.to_s)}$/ }
+      else
+        @paths = []
+      end
 
       @option_js = "olark.identify('#{@id}');"
       @options.each do |key, val|
-        val = [String, Symbol].include? val.class ? "'#{val.to_s}'" : val.to_s
+        val = [String, Symbol].include?(val.class) ? "'#{val.to_s}'" : val.to_s
         @option_js << "olark.configure('#{key.to_s}', #{val});"
       end
     end
 
-    def call(env)
-      dup._call(env)
-    end
+    def call(env); dup._call(env); end
 
     def _call(env)
-      @status, @headers, @response = @app.call env
-      @request = Rack::Request.new env
-
-      valid_path = @paths.select {|path| @request.path_info =~ path}.length > 0
-      return [@status, @headers, @response] unless html? and (@paths.empty? or valid_path)
-
-      response = Rack::Response.new [], @status, @headers
-      @response.each {|fragment| response.write inject(fragment)}
-      response.finish
+      @status, @headers, @response = @app.call(env)
+      @request = Rack::Request.new(env)
+      valid_path = @paths.select { |path| @request.path_info =~ path }.length > 0
+
+      if html? && (@paths.empty? || valid_path)
+        response = Rack::Response.new([], @status, @headers)
+        @response.each { |fragment| response.write(inject(fragment)) }
+        response.finish
+      else
+        [@status, @headers, @response]
+      end
     end
 
     private
-
-    def html?
-      @headers['Content-Type'] =~ /html/
-    end
+    def html?; @headers['Content-Type'] =~ /html/; end
 
     def inject(response)
-      template_contents = ::File.read ::File.expand_path('../templates/olark.haml', __FILE__)
-      @template = Haml::Engine.new(template_contents, {:format => @format}).render self
-      response.gsub '</body>', @template
+      template_file = ::File.read(::File.expand_path('../templates/olark.erb', __FILE__))
+      @template = ERB.new(template_file).result(binding)
+      response.gsub('</body>', @template)
     end
   end
 end

data/lib/rack/templates/olark.erb

@@ -0,0 +1,7 @@
+  <!-- Begin Olark code -->
+    <%= @tag %>
+      window.olark||(function(i){var e=window,h=document,a=e.location.protocol=="https:"?"https:":"http:",g=i.name,b="load";(function(){e[g]=function(){(c.s=c.s||[]).push(arguments)};var c=e[g]._={},f=i.methods.length; while(f--){(function(j){e[g][j]=function(){e[g]("call",j,arguments)}})(i.methods[f])} c.l=i.loader;c.i=arguments.callee;c.f=setTimeout(function(){if(c.f){(new Image).src=a+"//"+c.l.replace(".js",".png")+"&"+escape(e.location.href)}c.f=null},20000);c.p={0:+new Date};c.P=function(j){c.p[j]=new Date-c.p[0]};function d(){c.P(b);e[g](b)}e.addEventListener?e.addEventListener(b,d,false):e.attachEvent("on"+b,d); (function(){function l(j){j="head";return["<",j,"></",j,"><",z,' onload="var d=',B,";d.getElementsByTagName('head')[0].",y,"(d.",A,"('script')).",u,"='",a,"//",c.l,"'",'"',"></",z,">"].join("")}var z="body",s=h[z];if(!s){return setTimeout(arguments.callee,100)}c.P(1);var y="appendChild",A="createElement",u="src",r=h[A]("div"),G=r[y](h[A](g)),D=h[A]("iframe"),B="document",C="domain",q;r.style.display="none";s.insertBefore(r,s.firstChild).id=g;D.frameBorder="0";D.id=g+"-loader";if(/MSIE[ ]+6/.test(navigator.userAgent)){D.src="javascript:false"} D.allowTransparency="true";G[y](D);try{D.contentWindow[B].open()}catch(F){i[C]=h[C];q="javascript:var d="+B+".open();d.domain='"+h.domain+"';";D[u]=q+"void(0);"}try{var H=D.contentWindow[B];H.write(l());H.close()}catch(E){D[u]=q+'d.write("'+l().replace(/"/g,String.fromCharCode(92)+'"')+'");d.close();'}c.P(2)})()})()})({loader:(function(a){return "static.olark.com/jsclient/loader0.js?ts="+(a?a[1]:(+new Date))})(document.cookie.match(/olarkld=([0-9]+)/)),name:"olark",methods:["configure","extend","declare","identify"]});
+      <%= @option_js %>
+    </script>
+    <!-- End Olark code -->
+  </body>

data/rack-olark.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
-  s.name        = "rack-olark"
-  s.version     = ::File.read(::File.expand_path('../VERSION', __FILE__)).strip
-  s.date        = ::Date.today.to_s
+  s.name        = 'rack-olark'
+  s.version     = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  s.date        = Date.today.to_s
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Dan Poggi']
   s.email       = ['dan.poggi@gmail.com']
@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "rack-olark"
 
   s.add_dependency 'rack', ['>= 1.2']
-  s.add_dependency 'haml', ['>= 2.2.0']
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-olark
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-22 00:00:00.000000000Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2153884340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,15 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2153884340
-- !ruby/object:Gem::Dependency
-  name: haml
-  requirement: &2153883840 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *2153883840
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153883460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153883460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153883000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153883000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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:
@@ -71,7 +75,7 @@ files:
 - VERSION
 - lib/rack-olark.rb
 - lib/rack/olark.rb
-- lib/rack/templates/olark.haml
+- lib/rack/templates/olark.erb
 - rack-olark.gemspec
 homepage: https://github.com/dpoggi/rack-olark
 licenses: []
@@ -93,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rack-olark
-rubygems_version: 1.8.5
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Rack middleware for embedding Olark.

data/lib/rack/templates/olark.haml

@@ -1,7 +0,0 @@
-/ Begin Olark code
-:javascript
-  window.olark||(function(i){var e=window,h=document,a=e.location.protocol=="https:"?"https:":"http:",g=i.name,b="load";(function(){e[g]=function(){(c.s=c.s||[]).push(arguments)};var c=e[g]._={},f=i.methods.length; while(f--){(function(j){e[g][j]=function(){e[g]("call",j,arguments)}})(i.methods[f])} c.l=i.loader;c.i=arguments.callee;c.f=setTimeout(function(){if(c.f){(new Image).src=a+"//"+c.l.replace(".js",".png")+"&"+escape(e.location.href)}c.f=null},20000);c.p={0:+new Date};c.P=function(j){c.p[j]=new Date-c.p[0]};function d(){c.P(b);e[g](b)}e.addEventListener?e.addEventListener(b,d,false):e.attachEvent("on"+b,d); (function(){function l(j){j="head";return["<",j,"></",j,"><",z,' onload="var d=',B,";d.getElementsByTagName('head')[0].",y,"(d.",A,"('script')).",u,"='",a,"//",c.l,"'",'"',"></",z,">"].join("")}var z="body",s=h[z];if(!s){return setTimeout(arguments.callee,100)}c.P(1);var y="appendChild",A="createElement",u="src",r=h[A]("div"),G=r[y](h[A](g)),D=h[A]("iframe"),B="document",C="domain",q;r.style.display="none";s.insertBefore(r,s.firstChild).id=g;D.frameBorder="0";D.id=g+"-loader";if(/MSIE[ ]+6/.test(navigator.userAgent)){D.src="javascript:false"} D.allowTransparency="true";G[y](D);try{D.contentWindow[B].open()}catch(F){i[C]=h[C];q="javascript:var d="+B+".open();d.domain='"+h.domain+"';";D[u]=q+"void(0);"}try{var H=D.contentWindow[B];H.write(l());H.close()}catch(E){D[u]=q+'d.write("'+l().replace(/"/g,String.fromCharCode(92)+'"')+'");d.close();'}c.P(2)})()})()})({loader:(function(a){return "static.olark.com/jsclient/loader0.js?ts="+(a?a[1]:(+new Date))})(document.cookie.match(/olarkld=([0-9]+)/)),name:"olark",methods:["configure","extend","declare","identify"]});
-  #{@option_js}
-
-/ End Olark code
-</body>