locomotivecms_steam 1.5.0.rc0 → 1.5.0.rc1

data/spec/unit/middlewares/cache_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+require_relative '../../../lib/locomotive/steam/middlewares/thread_safe'
+require_relative '../../../lib/locomotive/steam/middlewares/concerns/helpers'
+require_relative '../../../lib/locomotive/steam/middlewares/cache'
+
+describe Locomotive::Steam::Middlewares::Cache do
+
+  let(:now)             { DateTime.parse('2015/09/26 22:00:00') }
+  let(:method)          { 'GET' }
+  let(:code)            { 200 }
+  let(:live_editing)    { nil }
+  let(:published)       { true }
+  let(:etag)            { nil }
+  let(:modified_at)     { nil }
+  let(:url)             { 'http://models.example.com' }
+  let(:path)            { 'hello-world' }
+  let(:page)            { instance_double('Page') }
+  let(:cache)           { instance_double('CacheService', ) }
+  let(:app)             { ->(env) { [code, {}, ['Hello world!']] } }
+  let(:middleware)      { described_class.new(app) }
+
+  subject do
+    env = send_request[:env]
+    [env['steam.cache_control'], env['steam.cache_vary']]
+  end
+
+  describe 'caching is disabled for the site' do
+
+    let(:site) { instance_double('Site', cache_enabled: false) }
+
+    it 'tells the the CDN to not cache the page' do
+      is_expected.to eq ['max-age=0, private, must-revalidate', nil]
+    end
+
+  end
+
+  describe 'caching is disabled for the page' do
+
+    let(:site) { instance_double('Site', cache_enabled: true) }
+    let(:page) { instance_double('Page', cache_enabled: false) }
+
+    it 'tells the the CDN to not cache the page' do
+      is_expected.to eq ['max-age=0, private, must-revalidate', nil]
+    end
+
+  end
+
+  describe 'the caching is enabled for the page' do
+
+    let(:site) { instance_double('Site', _id: 42, last_modified_at: now, cache_enabled: true, cache_control: '', cache_vary: nil) }
+    let(:page) { instance_double('Page', cache_enabled: true) }
+
+    context 'the request is a GET' do
+
+      let(:response) { nil }
+
+      before { expect(cache).to receive(:read).with('a31217f79aba42b0e1c98f7a6bb593fd').and_return(response) }
+
+      context 'the cache is empty' do
+
+        before { expect(cache).to receive(:write).with('a31217f79aba42b0e1c98f7a6bb593fd', Marshal.dump([200, {}, ["Hello world!"]])) }
+
+        it 'tells the CDN to cache the page and also cache it internally' do
+          is_expected.to eq ['max-age=0, s-maxage=3600, public, must-revalidate', 'Accept-Language']
+        end
+
+        describe 'ETag' do
+
+          subject { send_request[:env]['steam.cache_etag'] }
+
+          it { is_expected.to eq 'a31217f79aba42b0e1c98f7a6bb593fd' }
+
+        end
+
+        describe 'the site administrator sets a custom cache control and vary' do
+
+          let(:site) { instance_double('Site', _id: 42, last_modified_at: now, cache_enabled: true, cache_control: 'max-age=600, s-maxage=600, public, must-revalidate', cache_vary: 'Cookie') }
+
+          it 'tells the CDN to cache the page with the custom cache control' do
+            is_expected.to eq ['max-age=600, s-maxage=600, public, must-revalidate', 'Cookie']
+          end
+
+        end
+
+      end
+
+      describe 'the cache contains the response' do
+
+        let(:response) { Marshal.dump([200, {}, ["Hello world!"]]) }
+
+        it 'tells the CDN to cache the page' do
+          expect(cache).not_to receive(:write)
+          is_expected.to eq ['max-age=0, s-maxage=3600, public, must-revalidate', 'Accept-Language']
+        end
+
+      end
+
+    end
+
+    describe 'the page has not been modified for a while' do
+
+      subject { [send_request[:code], send_request[:headers]] }
+
+      context 'based on the ETag' do
+
+        let(:etag) { 'a31217f79aba42b0e1c98f7a6bb593fd' }
+
+        it 'returns a 304 (Not modified) without no cache headers' do
+          expect(subject.first).to eq 304
+          expect(subject.last['Cache-Control']).to eq nil
+        end
+
+      end
+
+      context 'based on the Last-Modified' do
+
+        let(:modified_at) { now }
+
+        it 'returns a 304 (Not modified) without no cache headers' do
+          expect(subject.first).to eq 304
+          expect(subject.last['Cache-Control']).to eq nil
+        end
+
+      end
+
+    end
+
+    context 'the request is a POST' do
+
+      let(:method) { 'POST' }
+
+      it 'tells the the CDN to not cache the page' do
+        is_expected.to eq ['max-age=0, private, must-revalidate', nil]
+      end
+
+    end
+
+    context 'the response is a redirection (302)' do
+
+      let(:code) { 302 }
+
+      before do
+        allow(cache).to receive(:read).and_return(nil)
+        allow(cache).to receive(:write).and_return(true)
+      end
+
+      it 'tells the the CDN to not cache the page' do
+        is_expected.to eq ['max-age=0, private, must-revalidate', nil]
+      end
+
+    end
+
+    context 'the live editing mode is on' do
+
+      let(:live_editing) { true }
+
+      it 'tells the the CDN to not cache the page' do
+        is_expected.to eq ['max-age=0, private, must-revalidate', nil]
+      end
+
+    end
+
+  end
+
+  def send_request
+    env = env_for(url,
+      method:                   method,
+      'HTTP_IF_NONE_MATCH'      => etag,
+      'HTTP_IF_MODIFIED_SINCE'  => modified_at,
+      'steam.site'              => site,
+      'steam.page'              => page,
+      'steam.path'              => path,
+      'steam.locale'            => 'en',
+      'steam.live_editing'      => live_editing,
+      'steam.services'          => instance_double('Services', cache: cache)
+    )
+
+    env['steam.request'] = Rack::Request.new(env)
+
+    code, headers, body = middleware.call(env)
+
+    { env: env, code: code, headers: headers }
+  end
+
+end

data/spec/unit/middlewares/impersonated_entry_spec.rb

@@ -14,6 +14,8 @@ describe Locomotive::Steam::Middlewares::ImpersonatedEntry do
   let(:session)         { {} }
   let(:params)          { {} }
   let(:middleware)      { described_class.new(app) }
+  let(:auth_service)    { instance_double('Auth') }
+  let(:services)        { instance_double('Services', :auth => auth_service) }
 
   subject do
     code, env, body = call
@@ -55,6 +57,10 @@ describe Locomotive::Steam::Middlewares::ImpersonatedEntry do
         [code, env['steam.impersonating_authenticated_entry'], env['Location']]
       end
 
+      before do
+        expect(auth_service).to receive(:notify).with(:signed_out, any_args).and_return(nil)
+      end
+
       it { is_expected.to eq [302, nil, '/'] }
 
       it "resets the session variable used to tell if we're in the impersonating mode" do
@@ -74,6 +80,7 @@ describe Locomotive::Steam::Middlewares::ImpersonatedEntry do
     env['steam.request']              = Rack::Request.new(env)
     env['steam.liquid_assigns']       = {}
     env['steam.authenticated_entry']  = entry
+    env['steam.services'] = services
     middleware.call(env)
   end
 

data/spec/unit/middlewares/locale_redirection_spec.rb

@@ -50,6 +50,13 @@ describe Locomotive::Steam::Middlewares::LocaleRedirection do
       let(:url) { 'http://models.example.com/de/hello' }
       it { is_expected.to eq [301, '/hello'] }
 
+      context 'pass the query string to the redirection' do
+
+        let(:url) { 'http://models.example.com/de/hello?name=John' }
+        it { is_expected.to eq [301, '/hello?name=John'] }
+
+      end
+
     end
 
   end

data/spec/unit/middlewares/locale_spec.rb

@@ -6,7 +6,7 @@ require_relative '../../../lib/locomotive/steam/middlewares/locale'
 
 describe Locomotive::Steam::Middlewares::Locale do
 
-  let(:site)            { instance_double('Site', default_locale: :de, locales: [:de, :fr, :en]) }
+  let(:site)            { instance_double('Site', bypass_browser_locale: false, default_locale: :de, locales: [:de, :fr, :en]) }
   let(:url)             { 'http://models.example.com' }
   let(:app)             { ->(env) { [200, env, 'app'] } }
   let(:cookie_lang)     { nil }
@@ -70,6 +70,13 @@ describe Locomotive::Steam::Middlewares::Locale do
 
           it { is_expected.to eq [:fr,  '/'] }
 
+          context 'the site is set up to bypass the browser locale' do
+
+            let(:site) { instance_double('Site', default_locale: :de, locales: [:de, :fr, :en], bypass_browser_locale: true) }
+            it { is_expected.to eq [:de, '/'] }
+
+          end
+
           context 'with url path' do
 
             let(:url) { 'http://models.example.com/werkzeug' }

data/spec/unit/middlewares/page_not_found_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+require_relative '../../../lib/locomotive/steam/middlewares/thread_safe'
+require_relative '../../../lib/locomotive/steam/middlewares/concerns/helpers'
+require_relative '../../../lib/locomotive/steam/middlewares/concerns/liquid_context'
+require_relative '../../../lib/locomotive/steam/middlewares/concerns/rendering'
+require_relative '../../../lib/locomotive/steam/middlewares/page_not_found'
+
+describe Locomotive::Steam::Middlewares::PageNotFound do
+
+  let(:site)            { instance_double('Site', asset_host: nil) }
+  let(:url)             { 'http://models.example.com/about-us' }
+  let(:page_finder)     { instance_double('PageFinder') }
+  let(:locomotive_path) { nil }
+  let(:app)             { ->(env) { [200, env, ['Hello world']] } }
+  let(:middleware)      { described_class.new(app) }
+
+  subject do
+    env = env_for(url, 'steam.site' => site)
+    env['steam.request']    = Rack::Request.new(env)
+    env['steam.services']   = instance_double('Services', page_finder: page_finder)
+    env['locomotive.path']  = locomotive_path
+    code, _, body = middleware.call(env)
+    [code, body]
+  end
+
+  describe 'no page not found exception raised' do
+
+    it { is_expected.to eq [200, ['Hello world']] }
+
+  end
+
+  describe 'page not found exception raised' do
+
+    let(:page)  { instance_double('PageNotFound',not_found?: true, response_type: 'text/html') }
+    let(:app)   { ->(env) { raise Locomotive::Steam::PageNotFoundException.new } }
+
+    it 'renders the 404 error page' do
+      expect(page_finder).to receive(:find).with('404').and_return(page)
+      expect_any_instance_of(described_class).to receive(:parse_and_render_liquid).and_return("We're sorry")
+      is_expected.to eq [404, ["We're sorry"]]
+    end
+
+  end
+
+end

data/spec/unit/middlewares/redirection_spec.rb

@@ -32,6 +32,14 @@ describe Locomotive::Steam::Middlewares::Redirection do
 
     it { is_expected.to eq [302, '/sign_in'] }
 
+    context 'permanent' do
+
+      let(:app) { ->(env) { raise Locomotive::Steam::RedirectionException.new('/sign_in', permanent: true) } }
+
+      it { is_expected.to eq [301, '/sign_in'] }
+
+    end
+
   end
 
 end

data/spec/unit/middlewares/renderer_spec.rb

@@ -7,15 +7,13 @@ require_relative '../../../lib/locomotive/steam/middlewares/renderer'
 
 describe Locomotive::Steam::Middlewares::Renderer do
 
-  let(:app) { ->(env) { [200, env, 'app'] }}
-
-  let(:middleware) { described_class.new(app) }
+  let(:locale)      { 'en' }
+  let(:site)        { instance_double('Site', default_locale: 'en') }
+  let(:app)         { ->(env) { [200, env, 'app'] }}
+  let(:middleware)  { described_class.new(app) }
 
   describe 'missing 404 page' do
 
-    let(:locale)  { 'en' }
-    let(:site)    { instance_double('Site', default_locale: 'en') }
-
     subject do
       middleware.call env_for('http://www.example.com', { 'steam.page' => nil, 'steam.locale' => locale, 'steam.site' => site })
     end
@@ -40,4 +38,64 @@ describe Locomotive::Steam::Middlewares::Renderer do
 
   end
 
+  describe 'rewriting of the asset urls' do
+
+    let(:env) {
+      env_for('http://www.example.com', {
+        'steam.page'    => instance_double('Page', redirect?: false, not_found?: false, response_type: 'text/html'),
+        'steam.locale'  => locale,
+        'steam.site'    => site
+      })
+    }
+    let(:site) { instance_double('Site', default_locale: 'en', asset_host: asset_host) }
+    let(:content) { <<-HTML
+<html>
+  <meta content="https://cdn.locomotive.works/sites/42/theme/images/logo.png" property='og:image' />
+  <script src="/sites/42/theme/javascripts/application.css"></script>
+  <body>
+    <img src="https://cdn.locomotive.works/steam/dynamic/42/abc/banner.png" />
+    <a href='https://cdn.locomotive.works/sites/42/pages/1/assets/brochure.pdf'>My brochure</a>
+    <p>https://cdn.locomotive.works/steam/dynamic/42/abc/banner.png</p>
+  </body>
+</html>
+      HTML
+    }
+
+    before { allow_any_instance_of(described_class).to receive(:parse_and_render_liquid).and_return(content) }
+
+    subject { _, _, response = middleware.call(env); response.first }
+
+    context 'no asset host defined by the site' do
+
+      let(:asset_host) { nil }
+
+      it "doesn't rewrite the asset urls" do
+        is_expected.to eq(content)
+      end
+
+    end
+
+    context 'the site owns a custom asset host' do
+
+      let(:asset_host) { 'https://cdn.mysite.dev' }
+
+      it 'rewrites the asset urls' do
+        is_expected.to eq(<<-HTML
+<html>
+  <meta content="https://cdn.mysite.dev/sites/42/theme/images/logo.png" property='og:image' />
+  <script src="https://cdn.mysite.dev/sites/42/theme/javascripts/application.css"></script>
+  <body>
+    <img src="https://cdn.mysite.dev/steam/dynamic/42/abc/banner.png" />
+    <a href='https://cdn.mysite.dev/sites/42/pages/1/assets/brochure.pdf'>My brochure</a>
+    <p>https://cdn.locomotive.works/steam/dynamic/42/abc/banner.png</p>
+  </body>
+</html>
+          HTML
+        )
+      end
+
+    end
+
+  end
+
 end

data/spec/unit/middlewares/section_spec.rb

@@ -22,6 +22,7 @@ describe Locomotive::Steam::Middlewares::Section do
   let(:services)        { instance_double(
                           'Services',
                           section_finder: section_finder,
+                          snippet_finder: nil,
                           repositories: repositories,
                           locale: 'en')
                         }

data/spec/unit/models/pager_spec.rb

@@ -23,7 +23,7 @@ describe Locomotive::Steam::Models::Pager do
       it { is_expected.to eq ['MongoDB'] }
     end
 
-    describe 'per_page is > to the number of total entries' do
+    describe 'per_page is greater than the number of total entries' do
       let(:per_page) { 10 }
       it { is_expected.to eq ['MongoDB', 'Rails', 'Liquid', 'Rack', 'Devise'] }
     end
@@ -33,6 +33,16 @@ describe Locomotive::Steam::Models::Pager do
       it { is_expected.to eq [] }
     end
 
+    describe 'page is a negative number' do
+      let(:page) { -3 }
+      it { is_expected.to eq ['MongoDB', 'Rails'] }
+    end
+
+    describe 'page is a string' do
+      let(:page) { ''.to_i }
+      it { is_expected.to eq ['MongoDB', 'Rails'] }
+    end
+
   end
 
   describe '#previous_page' do

data/spec/unit/repositories/section_repository_spec.rb

@@ -5,7 +5,7 @@ describe Locomotive::Steam::SectionRepository do
 
   #TODO: site_id should not be passed like this
   #TODO: template_path should be shorter
-  let(:sections)    { [{ name: 'Header', slug: 'header', site_id: 1, template_path: 'spec/fixtures/default/app/views/sections/header.liquid'  }] }
+  let(:sections)    { [{ name: 'Header', slug: 'header', site_id: 1, definition: {}, template_path: 'spec/fixtures/default/app/views/sections/header.liquid'  }] }
   let(:locale)      { :en }
   let(:site)        { instance_double('Site', _id: 1, default_locale: :en, locales: [:en, :fr]) }
   let(:adapter)     { Locomotive::Steam::FilesystemAdapter.new(nil) }

data/spec/unit/services/action_service_spec.rb

@@ -24,6 +24,15 @@ describe Locomotive::Steam::ActionService do
 
     it { is_expected.to eq 2.0 }
 
+    describe 'deal with dates (since EPOCH in milliseconds) from a param' do
+
+      let(:params) { { 'api' => { 'title' => 'Hello world', 'sent_at' => 1536598528930 } } }
+      let(:script) { "return params.api.sent_at;" }
+
+      it { is_expected.to eq 1536598528930 }
+
+    end
+
     describe 'deal with exceptions' do
 
       context 'wrong syntax' do
@@ -31,7 +40,7 @@ describe Locomotive::Steam::ActionService do
         let(:script) { 'a +/ b * var;' }
 
         it 'raises a meaningful exception' do
-          expect { subject }.to raise_error(Locomotive::Steam::ActionError, "eof or line terminator in regexp (line 2)")
+          expect { subject }.to raise_error(Locomotive::Steam::ActionError, "Action error - unterminated regexp (line 2)")
         end
 
       end
@@ -41,7 +50,7 @@ describe Locomotive::Steam::ActionService do
         let(:script) { 'a.b' }
 
         it 'raises a meaningful exception' do
-          expect { subject }.to raise_error(Locomotive::Steam::ActionError, "identifier 'a' undefined")
+          expect { subject }.to raise_error(Locomotive::Steam::ActionError, "Action error - identifier 'a' undefined")
         end
 
       end
@@ -136,6 +145,17 @@ describe Locomotive::Steam::ActionService do
 
       end
 
+      describe 'log' do
+
+        let(:script) { "log('Hello world!');" }
+
+        it 'should call the internal logger to output the log message' do
+          expect(Locomotive::Common::Logger).to receive(:info).with('Hello world!')
+          is_expected.to eq(nil)
+        end
+
+      end
+
       describe 'allEntries' do
 
         let(:now)     { Time.use_zone('America/Chicago') { Time.zone.local(2015, 'mar', 25, 10, 0) } }
@@ -241,7 +261,7 @@ describe Locomotive::Steam::ActionService do
 
         it 'stops the rendering process and redirects the user to another page' do
           expect(redirection_service).to receive(:redirect_to).with('about-us', nil).and_raise(Locomotive::Steam::RedirectionException.new('/about-us'))
-          expect { subject }.to raise_exception(Locomotive::Steam::RedirectionException, 'Redirect to /about-us')
+          expect { subject }.to raise_exception(Locomotive::Steam::RedirectionException, 'Redirect to /about-us (302)')
         end
 
       end

data/spec/unit/services/page_redirection_service_spec.rb

@@ -18,7 +18,7 @@ describe Locomotive::Steam::PageRedirectionService do
 
       it 'raises an PageRedirectionException that will caught the appropriate middleware' do
         expect(url_builder).to receive(:url_for).with(page, nil).and_return('/about-us')
-        expect { subject }.to raise_exception(Locomotive::Steam::RedirectionException, 'Redirect to /about-us')
+        expect { subject }.to raise_exception(Locomotive::Steam::RedirectionException, 'Redirect to /about-us (302)')
       end
 
       context 'passing a locale' do
@@ -27,7 +27,7 @@ describe Locomotive::Steam::PageRedirectionService do
 
         it 'raises an PageRedirectionException that will caught the appropriate middleware' do
           expect(url_builder).to receive(:url_for).with(page, 'fr').and_return('/a-notre-sujet')
-          expect { subject }.to raise_exception(Locomotive::Steam::RedirectionException, 'Redirect to /a-notre-sujet')
+          expect { subject }.to raise_exception(Locomotive::Steam::RedirectionException, 'Redirect to /a-notre-sujet (302)')
         end
 
       end

data/spec/unit/services/recaptcha_service_spec.rb

@@ -4,7 +4,7 @@ describe Locomotive::Steam::RecaptchaService do
 
   let(:api_url)     { nil }
   let(:secret)      { 'asecretkey' }
-  let(:site)        { instance_double('Site', metafields: { google: { recaptcha_api_url: api_url, recaptcha_secret: secret } }) }
+  let(:site)        { instance_double('Site', metafields: { google: { recaptcha_api_url: api_url, 'recaptcha_secret' => secret } }) }
   let(:request)     { instance_double('Request', ip: '127.0.0.1') }
   let(:service)     { described_class.new(site, request) }