rack-olark 0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b73e4d28f59840a324703890bfe83c2d9d28100e
+  data.tar.gz: 64df536b159df3350015d517896dbef859c727a1
+SHA512:
+  metadata.gz: e81ec5afdf1e748e05c5d29a05a11f2440122c07c690338b57836da779c6eb15a5be20ed65d9172b0a4e6c80418267a98235978a294114cc24584e6112b5f781
+  data.tar.gz: 45ff877ad37199fb94e5ba6ecf42b276ef0eab6eb5a98a9d9a59fb35dc447c269abc2b86b025eb4c09bf7f12515a07f59f1826e848745f9fbd766761060a6087

data/LICENSE

@@ -1,7 +1,7 @@
-Copyright (C) 2012 Dan Poggi
+Copyright (C) 2011 Dan Poggi
 
 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.
+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

@@ -1,34 +1,39 @@
 # 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. 
+
+Middleware which inserts Olark JavaScript embed code before </body> in HTML served by Rack.
 
 ## Usage
 
+In `config.ru`, or wherever else you mount middleware:
+
     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:
+All non-special options given to Rack::Olark are passed through as JavaScript in the following manner:
 
     olark.configure('key', value);
 
-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.
+There are two special options: `id` and `paths`.
 
-tag is a custom script tag to be used at the beginning of the Olark code. Most people should never need this, and it will default to just `<script>` (HTML5-style). 
+`id` is your Olark Site-ID, and the middleware won't allow your app to boot without it.
 
-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 of your routes will display the Olark chat box. It accepts an array of routes, with the leading slash (`/`) included. `paths` defaults to empty array (`[]`), causing Olark to be embedded for every route. As of version 0.0.4, routes in `paths` can also be described with a Regexp. Non-Regexp `paths` entries will be handled using:
 
-    /^#{Regexp.escape(your_original_path_entry)}$/
+    /^#{Regexp.escape('/my/path')}$/
 
-Example using options:
+Example of usage with options:
 
-    use Rack::Olark, id: '1234-567-89-0123',
-                     tag: '<script type="text/javascript">',
-                     paths: ['/', '/aboutus']
+    use Rack::Olark, {
+      :id                          => '1234-567-89-0123',
+      :paths                       => ['/', '/aboutus'],
+      'features.attention_grabber' => true,
+    }
 
-Note that in order to use custom Olark JavaScript options, you may have to revert to using hashrocket syntax.
+Note that in order to use custom Olark JavaScript options, you may have to revert to hashrocket syntax, as they tend to contain characters Ruby doesn't like in symbols.
 
 ## 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.
+Originally based on code from [rack-google-analytics](https://github.com/kangguru/rack-google-analytics). Never would've gotten started without them!
 
 ## Copyright
 
-Copyright (C) 2012 Dan Poggi. MIT License, see LICENSE for details.
+Copyright (C) 2011 Dan Poggi. MIT License, see LICENSE for details.

data/lib/rack/olark/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Olark
+    VERSION = '0.2.0'
+  end
+end

data/lib/rack/olark.rb

@@ -1,67 +1,69 @@
+require 'erb'
+require 'json'
 require 'rack'
 require 'rack/request'
-require 'erb'
 
 module Rack
   class Olark
-    DEFAULTS = {
-      tag: '<script>',
-      paths: []
-    }
+    TEMPLATE_PATH = ::File.expand_path(
+      ::File.join('..', 'templates', 'olark.erb'),
+      __FILE__
+    )
 
     def initialize(app, options = {})
-      unless options[:id] && options[:id].length == 16
-        raise ArgumentError, 'Need a valid Olark ID!'
+      @app = app
+
+      # Validity check on Site-ID
+      site_id = (options.delete(:id) || '').gsub(/[^0-9-]/, '')
+      unless site_id.length == 16
+        raise ArgumentError, 'rack-olark requires a valid Olark Site-ID!'
       end
 
-      @app, @options = app, DEFAULTS.merge(options)
-      @id, @tag, @paths = [@options.delete(:id),
-                           @options.delete(:tag),
-                           @options.delete(:paths)]
+      # Deprecation warnings
+      deprecation_warning('format') if options.delete(:format)
+      deprecation_warning('tag') if options.delete(:tag)
 
-      if @paths.is_a?(Array)
-        @paths.map! { |path| path.is_a?(Regexp) ? path : /^#{Regexp.escape(path.to_s)}$/ }
-      else
-        @paths = []
+      # Is it a Regexp? No? Then escape it, and make it a Regexp.
+      @paths = (options.delete(:paths) || []).map do |path|
+        path.is_a?(Regexp) ? path : /^#{Regexp.escape(path.to_s)}$/
       end
+      # Let's please not call Array#empty? on every request.
+      @inject_all = @paths.empty?
 
-      @option_js = "olark.identify('#{@id}');"
-      @options.each do |key, val|
-        val = [String, Symbol].include?(val.class) ? "'#{val.to_s}'" : val.to_s
-        @option_js << "olark.configure('#{key.to_s}', #{val});"
-      end
+      js = options.map { |k, v| olarkify(k, v) }.join
+      @html = ERB.new(::File.read(TEMPLATE_PATH)).result(binding)
     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
+    def call(env)
+      status, headers, body = @app.call(env)
+      request = Rack::Request.new(env)
 
-      # Deprecation warning, repeated and annoying. Sorry about your log space.
-      if @options[:format]
-        logger = env['rack.errors']
-        logger.write("[#{Time.now.strftime("%Y-%M-%d %H:%M:%S")}] WARNING  ")
-        logger.write("Rack::Olark: The 'format' option no longer works! See README.md for details.\n")
-      end
-
-      if html? && (@paths.empty? || valid_path)
-        response = Rack::Response.new([], @status, @headers)
-        @response.each { |fragment| response.write(inject(fragment)) }
+      if html?(headers) && (@inject_all || should_inject?(request))
+        response = Rack::Response.new([], status, headers)
+        body.each do |fragment|
+          response.write(fragment.gsub('</body>', @html))
+        end
         response.finish
       else
-        [@status, @headers, @response]
+        [status, headers, body]
       end
     end
 
     private
-    def html?; @headers['Content-Type'] =~ /html/; end
+    def olarkify(key, val)
+      "olark.configure(#{key.to_s.to_json}, #{val.to_json});"
+    end
+
+    def deprecation_warning(option)
+      STDOUT.puts("Rack::Olark: The '#{option}' option is deprecated and no longer functions! See README.md for details.")
+    end
+
+    def html?(headers)
+      (Rack::Utils::HeaderHash.new(headers)['Content-Type'] || '').include?('html')
+    end
 
-    def inject(response)
-      template_file = ::File.read(::File.expand_path('../templates/olark.erb', __FILE__))
-      @template = ERB.new(template_file).result(binding)
-      response.gsub('</body>', @template)
+    def should_inject?(request)
+      @paths.select { |p| request.path_info =~ p }.length > 0
     end
   end
 end

data/lib/rack/templates/olark.erb

@@ -1,7 +1,21 @@
-  <!-- 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 -->
+  <!-- begin olark code -->
+    <script data-cfasync="false" type='text/javascript'>/*<![CDATA[*/window.olark||(function(c){var f=window,d=document,l=f.location.protocol=="https:"?"https:":"http:",z=c.name,r="load";var nt=function(){
+    f[z]=function(){
+    (a.s=a.s||[]).push(arguments)};var a=f[z]._={
+    },q=c.methods.length;while(q--){(function(n){f[z][n]=function(){
+    f[z]("call",n,arguments)}})(c.methods[q])}a.l=c.loader;a.i=nt;a.p={
+    0:+new Date};a.P=function(u){
+    a.p[u]=new Date-a.p[0]};function s(){
+    a.P(r);f[z](r)}f.addEventListener?f.addEventListener(r,s,false):f.attachEvent("on"+r,s);var ld=function(){function p(hd){
+    hd="head";return["<",hd,"></",hd,"><",i,' onl' + 'oad="var d=',g,";d.getElementsByTagName('head')[0].",j,"(d.",h,"('script')).",k,"='",l,"//",a.l,"'",'"',"></",i,">"].join("")}var i="body",m=d[i];if(!m){
+    return setTimeout(ld,100)}a.P(1);var j="appendChild",h="createElement",k="src",n=d[h]("div"),v=n[j](d[h](z)),b=d[h]("iframe"),g="document",e="domain",o;n.style.display="none";m.insertBefore(n,m.firstChild).id=z;b.frameBorder="0";b.id=z+"-loader";if(/MSIE[ ]+6/.test(navigator.userAgent)){
+    b.src="javascript:false"}b.allowTransparency="true";v[j](b);try{
+    b.contentWindow[g].open()}catch(w){
+    c[e]=d[e];o="javascript:var d="+g+".open();d.domain='"+d.domain+"';";b[k]=o+"void(0);"}try{
+    var t=b.contentWindow[g];t.write(p());t.close()}catch(x){
+    b[k]=o+'d.write("'+p().replace(/"/g,String.fromCharCode(92)+'"')+'");d.close();'}a.P(2)};ld()};nt()})({
+    loader: "static.olark.com/jsclient/loader0.js",name:"olark",methods:["configure","extend","declare","identify"]});
+    /* custom configuration goes here (www.olark.com/documentation) */
+    olark.identify('<%= site_id %>');<%= js %>/*]]>*/</script><noscript><a href="https://www.olark.com/site/<%= site_id %>/contact" title="Contact us" target="_blank">Questions? Feedback?</a> powered by <a href="http://www.olark.com?welcome" title="Olark live chat software">Olark live chat software</a></noscript>
+    <!-- end olark code -->
   </body>

metadata

@@ -1,104 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: rack-olark
 version: !ruby/object:Gem::Version
-  version: '0.1'
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Dan Poggi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2016-03-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: '1.2'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   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.
+description: Middleware which inserts Olark JavaScript embed code before </body> in
+  HTML served by Rack.
 email:
 - dan.poggi@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- VERSION
 - lib/rack-olark.rb
 - lib/rack/olark.rb
+- lib/rack/olark/version.rb
 - lib/rack/templates/olark.erb
-- rack-olark.gemspec
 homepage: https://github.com/dpoggi/rack-olark
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rack-olark
-rubygems_version: 1.8.23
+rubyforge_project: 
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
-summary: Rack middleware for embedding Olark.
+specification_version: 4
+summary: Rack middleware for inserting Olark JavaScript embed code.
 test_files: []

data/.gitignore

@@ -1,5 +0,0 @@
-*.DS_Store
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/Gemfile

@@ -1,2 +0,0 @@
-source :rubygems
-gemspec

data/Rakefile

@@ -1 +0,0 @@
-require 'bundler/gem_tasks'

data/VERSION

@@ -1 +0,0 @@
-0.1

data/rack-olark.gemspec

@@ -1,21 +0,0 @@
-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.platform    = Gem::Platform::RUBY
-  s.authors     = ['Dan Poggi']
-  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. See README.md for details.}
-
-  s.rubyforge_project = "rack-olark"
-
-  s.add_dependency 'rack', ['>= 1.2']
-
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'bundler'
-
-  s.files         = `git ls-files`.split("\n")
-  s.require_paths = ['lib']
-end