snapsearch-client-ruby 0.1.0

data/resources/extensions.json

@@ -0,0 +1,26 @@
+{
+	"generic": [
+		"html",
+		"htm",
+		"shtml",
+		"xhtml",
+		"xht",
+		"cgi"
+	],
+	"php": [
+		"php"
+	],
+	"python" : [
+		"py"
+	],
+	"asp": [
+		"asp",
+		"aspx"
+	],
+	"java": [
+		"jsp"
+	],
+	"perl": [
+		"pl"
+	]
+}

data/resources/robots.json

@@ -0,0 +1,208 @@
+{
+    "ignore": [
+        "SnapSearch"
+    ],
+    "match": [
+        "008",
+        "ABACHOBot",
+        "Accoona-AI-Agent",
+        "AddSugarSpiderBot",
+        "Adsbot-Google",
+        "altavista",
+        "AnyApexBot",
+        "Arachmo",
+        "archiver",
+        "B-l-i-t-z-B-O-T",
+        "Baiduspider",
+        "BecomeBot",
+        "BeslistBot",
+        "BillyBobBot",
+        "Bimbot",
+        "Bingbot",
+        "BingPreview",
+        "bitlybot",
+        "BlitzBOT",
+        "boitho.com-dc",
+        "boitho.com-robot",
+        "borg",
+        "BrowserMob",
+        "btbot",
+        "CatchBot",
+        "Catchpoint bot",
+        "Cerberian Drtrs",
+        "Charlotte",
+        "ConveraCrawler",
+        "cosmos",
+        "Covario IDS",
+        "crawler",
+        "DataparkSearch",
+        "DiamondBot",
+        "Discobot",
+        "Dotbot",
+        "Embedly",
+        "EmeraldShield.com WebBot",
+        "envolk[ITS]spider",
+        "EsperanzaBot",
+        "Exabot",
+        "facebookexternalhit",
+        "FAST-WebCrawler",
+        "FAST Enterprise Crawler",
+        "Feedfetcher",
+        "FDSE robot",
+        "FindLinks",
+        "FurlBot",
+        "FyberSpider",
+        "g2crawler",
+        "Gaisbot",
+        "GalaxyBot",
+        "genieBot",
+        "Gigabot",
+        "Girafabot",
+        "GomezA",
+        "Googlebot",
+        "GurujiBot",
+        "HappyFunBot",
+        "hl_ftien_spider",
+        "Holmes",
+        "htdig",
+        "http client",
+        "HttpMonitor",
+        "iaskspider",
+        "ia_archiver",
+        "iCCrawler",
+        "ichiro",
+        "igdeSpyder",
+        "IRLbot",
+        "IssueCrawler",
+        "Jaxified Bot",
+        "Jyxobot",
+        "KoepaBot",
+        "L.webis",
+        "LapozzBot",
+        "Larbin",
+        "LDSpider",
+        "LexxeBot",
+        "Linguee Bot",
+        "LinkedInBot",
+        "LinkWalker",
+        "lmspider",
+        "lwp-trivial",
+        "lycos",
+        "mabontland",
+        "magpie-crawler",
+        "Mediapartners",
+        "MJ12bot",
+        "Mnogosearch",
+        "mogimogi",
+        "MojeekBot",
+        "Moreoverbot",
+        "Morning Paper",
+        "msnbot",
+        "MSRBot",
+        "MVAClient",
+        "mxbot",
+        "netresearch",
+        "NetResearchServer",
+        "NetSeer Crawler",
+        "NewsGator",
+        "NG-Search",
+        "nicebot",
+        "noxtrumbot",
+        "Nusearch Spider",
+        "NutchCVS",
+        "Nymesis",
+        "obot",
+        "oegp",
+        "omgilibot",
+        "OmniExplorer_Bot",
+        "OOZBOT",
+        "openbot",
+        "Orbiter",
+        "PageBitesHyperBot",
+        "PagePeeker",
+        "Peew",
+        "Pinterest",
+        "polybot",
+        "Pompos",
+        "PostPost",
+        "Psbot",
+        "PycURL",
+        "Qseero",
+        "Radian6",
+        "RAMPyBot",
+        "Read Later",
+        "rogerbot",
+        "RufusBot",
+        "SandCrawler",
+        "SBIder",
+        "scooter",
+        "ScoutJet",
+        "Scrubby",
+        "SearchSight",
+        "Seekbot",
+        "semanticdiscovery",
+        "Sensis Web Crawler",
+        "SEOChat::Bot",
+        "SeznamBot",
+        "Shim-Crawler",
+        "ShopWiki",
+        "Shoula robot",
+        "silk",
+        "Sitebot",
+        "slurp",
+        "Snappy",
+        "sogou spider",
+        "Sosospider",
+        "speedy",
+        "Speedy Spider",
+        "spider",
+        "Sqworm",
+        "StackRambler",
+        "suggybot",
+        "SurveyBot",
+        "SynooBot",
+        "Teoma",
+        "TerrawizBot",
+        "TheSuBot",
+        "Thumbnail.CZ robot",
+        "ThumbShotsBot",
+        "TinEye",
+        "truwoGPS",
+        "TurnitinBot",
+        "TweetedTimes Bot",
+        "TwengaBot",
+        "Twitterbot",
+        "updated",
+        "URL2PNG",
+        "Urlfilebot",
+        "Vagabondo",
+        "voila",
+        "VoilaBot",
+        "Vortex",
+        "voyager",
+        "VYU2",
+        "webcollage",
+        "Websquash.com",
+        "WebThumb",
+        "wf84",
+        "Willow Internet Crawler",
+        "WoFindeIch Robot",
+        "WomlpeFactory",
+        "Xaldon_WebSpider",
+        "yacy",
+        "yahoo",
+        "YandexBot",
+        "YandexImages",
+        "Yasaklibot",
+        "Yeti",
+        "YodaoBot",
+        "yoogliFetchAgent",
+        "YottaaMonitor",
+        "YoudaoBot",
+        "Zao",
+        "Zealbot",
+        "ZooShot",
+        "zspider",
+        "ZyBorg"
+    ]
+}

data/snapsearch.gemspec

@@ -0,0 +1,31 @@
+require 'pathname'
+
+Gem::Specification.new do |s|
+  
+  # Variables
+  s.author      = 'Ryan Scott Lewis'
+  s.email       = 'roger.qiu@polycademy.com'
+  s.name        = 'snapsearch-client-ruby'
+  s.summary     = 'Ruby HTTP Client Middleware Libraries for SnapSearch. Search engine optimisation for single page applications.'
+  s.homepage    = 'https://github.com/SnapSearch/SnapSearch-Client-Ruby'
+  s.license     = 'MIT'
+  
+  # Dependencies
+  s.add_dependency 'version',                 '~> 1.0.0'
+  s.add_dependency 'httpi',                   '~> 2.1.0'
+  s.add_dependency 'addressable',             '~> 2.0.0'
+  s.add_dependency 'rack',                    '~> 1.5.0'
+  s.add_development_dependency 'rake',        '~> 10.1.1'
+  s.add_development_dependency 'rspec',       '~> 2.14.1'
+  s.add_development_dependency 'guard-rspec', '~> 4.2.5'
+  s.add_development_dependency 'guard-yard',  '~> 2.1.0'
+  s.add_development_dependency 'fuubar',      '~> 1.3.2'
+  
+  # Pragmatically set variables
+  s.version       = Pathname.glob('VERSION*').first.read rescue '0.0.0'
+  s.description   = s.summary
+  s.require_paths = ['lib']
+  s.files         = Dir['{{Rake,Gem}file{.lock,},README*,VERSION,LICENSE,*.gemspec,{lib,bin,examples,resources,spec,test}/**/*}']
+  s.test_files    = Dir['{examples,spec,test}/**/*']
+  
+end

data/spec/lib/rack/qs_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'rack/request'
+
+describe 'Rack application QS splitting' do
+    
+    let(:env) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'Mozilla/5.0 (Windows NT 6.2; WOW64; rv:25.0) Gecko/20100101 Firefox/25.0', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => 'key%201=value+1&_escaped_fragment_=%2Fpath2%3Fkey2=value2',
+            'PATH_INFO' => '/snapsearch/path1',
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    subject { Rack::Request.new(env) }
+    
+    it 'should decode the key/values when splitting the params of a request' do
+      subject.params.should == {
+        'key 1' => 'value 1',
+        "_escaped_fragment_" => '/path2?key2=value2'
+      }
+    end
+    
+end

data/spec/lib/rack/snap_search/config_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Rack::SnapSearch::Config do
+    
+    subject { described_class.new }
+    
+    let(:proc) do
+        Proc.new {}
+    end
+    
+    context 'For each attribute' do
+        
+        described_class::ATTRIBUTES.each do |attribute|
+            it { should respond_to(attribute) } # Have a getter method
+            it { should respond_to("#{attribute}=") } # Have a setter method
+        end
+        
+    end
+    
+    describe '#on_exception' do
+        
+        it { should respond_to(:on_exception) }
+        
+        it 'should be a setter if a block is given and a getter if not' do
+            subject.on_exception.should == nil
+            subject.on_exception(&proc) # Note that this is the same as giving a block with do/end or curly brackets
+            subject.on_exception.should == proc
+        end
+        
+    end
+    
+    describe '#before_intercept' do
+        
+        it { should respond_to(:before_intercept) }
+        
+        it 'should be a setter if a block is given and a getter if not' do
+            subject.before_intercept.should == nil
+            subject.before_intercept(&proc) # Note that this is the same as giving a block with do/end or curly brackets
+            subject.before_intercept.should == proc
+        end
+        
+    end
+    
+    describe '#after_intercept' do
+        
+        it { should respond_to(:after_intercept) }
+        
+        it 'should be a setter if a block is given and a getter if not' do
+            subject.after_intercept.should == nil
+            subject.after_intercept(&proc) # Note that this is the same as giving a block with do/end or curly brackets
+            subject.after_intercept.should == proc
+        end
+        
+    end
+    
+end

data/spec/lib/snap_search/detector_spec.rb

@@ -0,0 +1,362 @@
+require 'spec_helper'
+require 'rack/request'
+
+describe SnapSearch::Detector do
+    
+    let(:normal_browser) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'Mozilla/5.0 (Windows NT 6.2; WOW64; rv:25.0) Gecko/20100101 Firefox/25.0', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/',
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:search_engine) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'AdsBot-Google ( http://www.google.com/adsbot.html)', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/',
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:snapsearch_robot) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'SnapSearch', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/',
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:non_get_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'AdsBot-Google ( http://www.google.com/adsbot.html)',
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'POST', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/', 
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+        
+    let(:ignored_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'Googlebot-Video/1.0', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/ignored/', 
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:matched_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'msnbot/1.1 ( http://search.msn.com/msnbot.htm)', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/matched/', 
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:basic_escaped_fragment_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'Mozilla/5.0 (Windows NT 6.2; WOW64; rv:25.0) Gecko/20100101 Firefox/25.0', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '_escaped_fragment_',
+            'PATH_INFO' => '/snapsearch',
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:escaped_fragment_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'Mozilla/5.0 (Windows NT 6.2; WOW64; rv:25.0) Gecko/20100101 Firefox/25.0', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => 'key1=value1&_escaped_fragment_=%2Fpath2%3Fkey2=value2',
+            'PATH_INFO' => '/snapsearch/path1',
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:valid_file_extension_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'AdsBot-Google ( http://www.google.com/adsbot.html)', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/song.html?key=value', 
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:invalid_file_extension_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'AdsBot-Google ( http://www.google.com/adsbot.html)', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/song.html.mp3?key=value', 
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:nonexistent_file_extension_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'AdsBot-Google ( http://www.google.com/adsbot.html)', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/', 
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    let(:mp3_file_extension_route) do
+        {
+            'HTTP_HOST' => 'localhost', 
+            'HTTP_USER_AGENT' => 'AdsBot-Google ( http://www.google.com/adsbot.html)', 
+            'SERVER_NAME' => 'localhost', 
+            'SERVER_PORT' => '80', 
+            'REMOTE_ADDR' => '::1', 
+            'DOCUMENT_ROOT' => 'C:/www', 
+            'REQUEST_SCHEME' => 'http', 
+            'GATEWAY_INTERFACE' => 'CGI/1.1', 
+            'SERVER_PROTOCOL' => 'HTTP/1.1', 
+            'REQUEST_METHOD' => 'GET', 
+            'QUERY_STRING' => '', 
+            'PATH_INFO' => '/snapsearch/song.html.mp3?key=value', 
+            'rack.url_scheme' => 'http', 
+            'rack.input' => StringIO.new
+        }
+    end
+    
+    subject { described_class.new }
+    
+    describe '#detect' do
+        
+        describe 'When a request from a normal browser comes through' do
+            
+            let(:request) { Rack::Request.new(normal_browser) }
+            
+            it('should not be intercepted') { subject.detect(request: request).should == false }
+            
+        end
+        
+        describe 'When a request from a search engine robot comes through' do
+            
+            let(:request) { Rack::Request.new(search_engine) }
+            
+            it('should be intercepted') { subject.detect(request: request).should == true }
+            
+        end
+        
+        describe 'When a request from a SnapSearch robot comes through' do
+            
+            let(:request) { Rack::Request.new(snapsearch_robot) }
+            
+            it('should not be intercepted') { subject.detect(request: request).should == false }
+            
+        end
+        
+        describe 'When a non-GET request comes through' do
+            
+            let(:request) { Rack::Request.new(non_get_route) }
+            
+            it('should not be intercepted') { subject.detect(request: request).should == false }
+            
+        end
+        
+        describe 'When an ignored route request comes through' do
+            
+            let(:request) { Rack::Request.new(ignored_route) }
+            
+            it('should not be intercepted') { subject.detect(ignored_routes: [/^\/ignored/], request: request).should == false }
+            
+        end
+        
+        describe 'When a non-matched route request comes through' do
+            
+            let(:request) { Rack::Request.new(matched_route) }
+            
+            it('should not be intercepted') { subject.detect(matched_routes: [/^\/non_matched_route/], request: request).should == false }
+            
+        end
+        
+        describe 'When a matched route request comes through' do
+            
+            let(:request) { Rack::Request.new(matched_route) }
+            
+            it('should be intercepted') { subject.detect(matched_routes: [/^\/matched/], request: request).should == true }
+            
+        end
+        
+        describe 'When an escaped fragmented request comes through' do
+            
+            let(:request) { Rack::Request.new(basic_escaped_fragment_route) }
+            
+            it('should be intercepted') { subject.detect(request: request).should == true }
+            
+        end
+        
+        describe 'When other factors allow it and a valid file extension comes through' do
+            
+            let(:request) { Rack::Request.new(valid_file_extension_route) }
+            
+            it('should be intercepted') { subject.detect(request: request, check_file_extensions: true).should == true }
+            
+        end
+        
+        describe 'When an invalid file extension comes through' do
+            
+            let(:request) { Rack::Request.new(invalid_file_extension_route) }
+            
+            it('should not be intercepted') { subject.detect(request: request, check_file_extensions: true).should == false }
+            
+        end
+        
+        describe 'When other factors allow it and a nonexistent file extension comes through' do
+            
+            let(:request) { Rack::Request.new(nonexistent_file_extension_route) }
+            
+            it('should be intercepted') { subject.detect(request: request, check_file_extensions: true).should == true }
+            
+        end
+        
+        describe 'When custom extensions are set' do
+            
+            let(:request) { Rack::Request.new(mp3_file_extension_route) }
+            
+            it('should be intercepted correctly') do
+                subject.detect(request: request, check_file_extensions: true).should == false
+                
+                subject.extensions['generic'] << 'mp3'
+                
+                subject.detect(request: request, check_file_extensions: true).should == true
+                
+                subject.extensions['generic'].delete('mp3')
+                
+                subject.detect(request: request, check_file_extensions: true).should == false
+            end
+            
+        end
+        
+    end
+    
+    describe '#get_encoded_url' do
+        
+        let(:request) { Rack::Request.new(escaped_fragment_route) }
+        let(:uri) { Addressable::URI.parse(request.url) }
+        
+        it 'should convert the escaped fragment route back to hash fragment' do
+            subject.get_encoded_url(request.params, uri).should == 'http://localhost/snapsearch/path1?key1=value1#!/path2?key2=value2'
+        end
+        
+    end
+    
+    describe '#get_decoded_path' do
+        
+        let(:uri) { Addressable::URI.parse('http://localhost:8080/some%20path/an%2Fother+path/path1.htm?key1=value%201%3F') }
+        
+        it 'should return the decoded path with the correct query and haash fragment' do
+            subject.get_decoded_path( {}, uri ).should == '/some path/an/other+path/path1.htm?key1=value 1?'
+        end
+        
+    end
+    
+end