alephant-preview 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb29527d9bf9c048e248aa1aacb116c25db7f0ea
-  data.tar.gz: 2fd1eea531051f54534cb1074c338e3854c368c4
+  metadata.gz: c87e2e7b9c82a52f83127e9357ef49697ba5ce50
+  data.tar.gz: 22cb67ba4b3fb81dc64de8bbab95b1cc6c68f424
 SHA512:
-  metadata.gz: 41fceee23cfb06b4a574c71cb7576549cbb9dbcf6c73a293c3855bd5589c9890773702303396f6c55cc5a5fdd8cdd14e6341893465493373b60f2b26ba0cf91d
-  data.tar.gz: 8976cf2f8131f63a057bf99c3d9d82c1da9644c32861b296752aec66f0d9ece770619bbb611a6eb39ec3d0547cafe07cfcffc7bad2b2fa26e228068ea5a87233
+  metadata.gz: 2eba39230ac965cc3b43e5c4ecbec36b8f7d1bda50f82ad0d8e1649254e4b8932fe495aff1401bd4dbb929b334c45c0f6fc70cb02fa3ab7eb7c7eb956ebb47d4
+  data.tar.gz: 74623ea9364a0dcb52534f56b374ae5bfc25e948b964e5cb812317f3a68a32277f6245f2e78cd52e88120e9587ec5cf2ef7df1f9a28706b3455b4371c2ab2853

data/lib/alephant/preview/server.rb

@@ -32,16 +32,23 @@ module Alephant
       end
 
       get "/preview/:id/:template/:region/?:fixture?" do
+        response["X-Sequence"] = sequence_id
+
         render_preview
       end
 
       get "/component/:template/?:fixture?" do
         params["id"] = find_id_from_template params["template"]
         params["fixture"] = "responsive" unless params["fixture"]
+
+        response["X-Sequence"] = sequence_id
+
         render_component
       end
 
       get "/component/:id/:template/?:fixture?" do
+        response["X-Sequence"] = sequence_id
+
         render_component
       end
 
@@ -100,20 +107,41 @@ module Alephant
       end
 
       def render_component
-        view_mapper.generate(fixture_data)[template].render
+        view_mapper.generate(fixture_data)[template].render.tap do |content|
+          response["Content-Type"] = get_content_type(content)
+        end
       end
 
       def render_batch_component
+        content = render_component
+
         {
-          :component => template,
-          :options   => {},
-          :status    => 200,
-          :body      => render_component
+          :component    => template,
+          :options      => {},
+          :status       => 200,
+          :body         => content,
+          :content_type => get_content_type(content),
+          :sequence_id  => sequence_id
         }
       end
 
       private
 
+      def sequence_id
+        Time.now.to_i
+      end
+
+      def get_content_type(content)
+        return "application/json" if is_json?(content)
+        "text/html"
+      end
+
+      def is_json?(content)
+        JSON.parse(content) && true
+      rescue Exception
+        false
+      end
+
       def request_body
         JSON.parse(request.body.read, :symbolize_names => true) || {}
       end

data/lib/alephant/preview/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Preview
-    VERSION = "0.4.0".freeze
+    VERSION = "0.5.0".freeze
   end
 end

data/spec/fixtures/components/foo/models/foo.rb

@@ -1,9 +1,9 @@
-require "alephant/renderer/views/html"
+require "alephant/renderer/views/json"
 
 module MyApp
-  class Foo < ::Alephant::Renderer::Views::Html
-    def content
-      "content"
+  class Foo < ::Alephant::Renderer::Views::Json
+    def to_h
+      { "content" => "as json" }
     end
   end
 end

data/spec/integration/preview_spec.rb

@@ -6,8 +6,12 @@ describe Alephant::Preview::Server do
 
   describe "preview endpoint (GET /preview/{id}/{template}/{region}/{fixture})" do
     describe "content" do
+      expected_time = 123_456_789
+
       context "with valid data" do
         before(:each) do
+          allow(Time).to receive(:now).and_return(expected_time)
+
           get "/preview/#{id}/#{template}/#{region}/#{fixture}"
         end
         let (:id) { "foo" }
@@ -15,14 +19,31 @@ describe Alephant::Preview::Server do
         let (:fixture) { id }
         let (:region) { "page_region" }
 
-        specify { expect(last_response.body).to eq("topcontent\nbottom\n") }
+        it "should return correct response" do
+          expect(last_response.body).to eq(%(top{"content":"as json"}bottom\n))
+        end
+
+        expected_headers = {
+          "Content-Type"                => "application/json",
+          "Access-Control-Allow-Origin" => "*",
+          "X-Sequence"                  => expected_time,
+          "Content-Length"              => "31"
+        }
+
+        it "should have correct response headers" do
+          expect(last_response.headers).to include(expected_headers)
+        end
       end
     end
   end
 
   describe "component endpoint (GET /component/{id}/{template}/{fixture})" do
     describe "content" do
+      expected_time = 123_456_789
+
       before(:each) do
+        allow(Time).to receive(:now).and_return(expected_time)
+
         get "/component/#{id}/#{template}/#{fixture}"
       end
       let (:response) { last_response.body.chomp }
@@ -32,7 +53,20 @@ describe Alephant::Preview::Server do
         let (:template) { id }
         let (:fixture) { id }
 
-        specify { expect(response).to eq("content") }
+        it "should return correct response" do
+          expect(response).to eq(%({"content":"as json"}))
+        end
+
+        expected_headers = {
+          "Content-Type"                => "application/json",
+          "Access-Control-Allow-Origin" => "*",
+          "X-Sequence"                  => expected_time,
+          "Content-Length"              => "21"
+        }
+
+        it "should have correct response headers" do
+          expect(last_response.headers).to include(expected_headers)
+        end
       end
 
       context "with a data mapper" do
@@ -41,7 +75,20 @@ describe Alephant::Preview::Server do
           let (:template) { id }
           let (:fixture) { id }
 
-          specify { expect(response).to eq("data mapped content") }
+          it "should return data mapped content" do
+            expect(response).to eq("data mapped content")
+          end
+
+          expected_headers = {
+            "Content-Type"                => "text/html",
+            "Access-Control-Allow-Origin" => "*",
+            "X-Sequence"                  => expected_time,
+            "Content-Length"              => "20"
+          }
+
+          it "should have correct response headers" do
+            expect(last_response.headers).to include(expected_headers)
+          end
         end
 
         context "using multiple fixtures" do
@@ -49,7 +96,20 @@ describe Alephant::Preview::Server do
           let (:template) { id }
           let (:fixture) { id }
 
-          specify { expect(response).to eq("multiple endpoint data mapped content") }
+          it "should return multiple mapped content" do
+            expect(response).to eq("multiple endpoint data mapped content")
+          end
+
+          expected_headers = {
+            "Content-Type"                => "text/html",
+            "Access-Control-Allow-Origin" => "*",
+            "X-Sequence"                  => expected_time,
+            "Content-Length"              => "38"
+          }
+
+          it "should have correct response headers" do
+            expect(last_response.headers).to include(expected_headers)
+          end
         end
       end
     end
@@ -57,7 +117,11 @@ describe Alephant::Preview::Server do
 
   describe 'component batch endpoint (GET /components/batch?components[#{id}]=#{id})' do
     describe "content" do
+      expected_time = 123_456_789
+
       before(:each) do
+        allow(Time).to receive(:now).and_return(expected_time)
+
         get "/components/batch?components[#{id}][component]=#{id}&components[#{id}][options][fixture]=#{id}"
       end
 
@@ -71,15 +135,19 @@ describe Alephant::Preview::Server do
         expected = {
           :components => [
             {
-              :component => "foo",
-              :options   => {},
-              :status    => 200,
-              :body      => "content\n"
+              :component    => "foo",
+              :options      => {},
+              :status       => 200,
+              :body         => %({"content":"as json"}),
+              :content_type => "application/json",
+              :sequence_id  => expected_time
             }
           ]
         }
 
-        specify { expect(response).to eq(expected) }
+        it "should return correct response" do
+          expect(response).to eq(expected)
+        end
       end
 
       context "with a data mapper" do
@@ -91,15 +159,19 @@ describe Alephant::Preview::Server do
           expected = {
             :components => [
               {
-                :component => "bar",
-                :options   => {},
-                :status    => 200,
-                :body      => "data mapped content\n"
+                :component    => "bar",
+                :options      => {},
+                :status       => 200,
+                :body         => "data mapped content\n",
+                :content_type => "text/html",
+                :sequence_id  => expected_time
               }
             ]
           }
 
-          specify { expect(response).to eq(expected) }
+          it "should return correct response" do
+            expect(response).to eq(expected)
+          end
         end
 
         context "using multiple fixtures" do
@@ -110,15 +182,19 @@ describe Alephant::Preview::Server do
           expected = {
             :components => [
               {
-                :component => "baz",
-                :options   => {},
-                :status    => 200,
-                :body      => "multiple endpoint data mapped content\n"
+                :component    => "baz",
+                :options      => {},
+                :status       => 200,
+                :body         => "multiple endpoint data mapped content\n",
+                :content_type => "text/html",
+                :sequence_id  => expected_time
               }
             ]
           }
 
-          specify { expect(response).to eq(expected) }
+          it "should return correct response" do
+            expect(response).to eq(expected)
+          end
         end
       end
     end
@@ -126,7 +202,11 @@ describe Alephant::Preview::Server do
 
   describe "component batch endpoint (POST /components/batch" do
     describe "content" do
+      expected_time = 123_456_789
+
       before(:each) do
+        allow(Time).to receive(:now).and_return(expected_time)
+
         post "/components/batch", {
           :components => [
             {
@@ -147,15 +227,19 @@ describe Alephant::Preview::Server do
         expected = {
           :components => [
             {
-              :component => "foo",
-              :options   => {},
-              :status    => 200,
-              :body      => "content\n"
+              :component    => "foo",
+              :options      => {},
+              :status       => 200,
+              :body         => %({"content":"as json"}),
+              :content_type => "application/json",
+              :sequence_id  => expected_time
             }
           ]
         }
 
-        specify { expect(response).to eq(expected) }
+        it "should return correct response" do
+          expect(response).to eq(expected)
+        end
       end
 
       context "with a data mapper" do
@@ -165,15 +249,19 @@ describe Alephant::Preview::Server do
           expected = {
             :components => [
               {
-                :component => "bar",
-                :options   => {},
-                :status    => 200,
-                :body      => "data mapped content\n"
+                :component    => "bar",
+                :options      => {},
+                :status       => 200,
+                :body         => "data mapped content\n",
+                :content_type => "text/html",
+                :sequence_id  => expected_time
               }
             ]
           }
 
-          specify { expect(response).to eq(expected) }
+          it "should return correct response" do
+            expect(response).to eq(expected)
+          end
         end
 
         context "using multiple fixtures" do
@@ -182,15 +270,19 @@ describe Alephant::Preview::Server do
           expected = {
             :components => [
               {
-                :component => "baz",
-                :options   => {},
-                :status    => 200,
-                :body      => "multiple endpoint data mapped content\n"
+                :component    => "baz",
+                :options      => {},
+                :status       => 200,
+                :body         => "multiple endpoint data mapped content\n",
+                :content_type => "text/html",
+                :sequence_id  => expected_time
               }
             ]
           }
 
-          specify { expect(response).to eq(expected) }
+          it "should return correct response" do
+            expect(response).to eq(expected)
+          end
         end
       end
     end
@@ -202,7 +294,9 @@ describe Alephant::Preview::Server do
     end
 
     context "status code" do
-      specify { expect(last_response.status).to eq 200 }
+      it "should return ok status code" do
+        expect(last_response.status).to eq(200)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-preview
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +275,6 @@ files:
 - spec/fixtures/components/foo/fixtures/foo.json
 - spec/fixtures/components/foo/models/foo.rb
 - spec/fixtures/components/foo/templates/.DS_Store
-- spec/fixtures/components/foo/templates/foo.mustache
 - spec/fixtures/lib/templates/preview.mustache
 - spec/integration/preview_spec.rb
 - spec/spec_helper.rb
@@ -318,7 +317,6 @@ test_files:
 - spec/fixtures/components/foo/fixtures/foo.json
 - spec/fixtures/components/foo/models/foo.rb
 - spec/fixtures/components/foo/templates/.DS_Store
-- spec/fixtures/components/foo/templates/foo.mustache
 - spec/fixtures/lib/templates/preview.mustache
 - spec/integration/preview_spec.rb
 - spec/spec_helper.rb

data/spec/fixtures/components/foo/templates/foo.mustache

@@ -1 +0,0 @@
-{{content}}