alephant-broker 3.11.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58251bb948e3620c95b0c67e8643e60426c25818
-  data.tar.gz: c355b17fe2d366043fbd84f5e284377f9d353a44
+  metadata.gz: 60b6af683863285e27316bde5b7392d93439b20e
+  data.tar.gz: 7052275d91783c7b02ab1996cdced8e606b58e51
 SHA512:
-  metadata.gz: dbdaf0f97e7c873b030be8418d6b7b7a076826fcd576d7f60b9c5f734f4ac8a13db6af1cb4744b222b48ee01abd267c6df051f22fac85dd8285b53b36128ce2c
-  data.tar.gz: a143fb0fbca1a39ab62a1a7facd718f9f38221a53daae7514ca82d1f9b7a42b3992ba06f8b427da717a919a50801f9877bb56d7c4b34e7adeae69702c5d63fde
+  metadata.gz: b8307c2cbe4304ebf233878d20026529e21302cec83e78132b43a6bb7da377da977f85d2f48b447c76d4e3647d2f7915659ec56cdbb9b4ecda8b4e5e26b26777
+  data.tar.gz: 0c2ba375708bfb96376954db24ab557b8bc615db013d9e85bd4ad3833d5f03861c6efc1074cd72e4a890d25ca42181f57caaf5da74ea29c458bd16ad71a7dafe

data/lib/alephant/broker/response/base.rb

@@ -25,7 +25,7 @@ module Alephant
           @content = STATUS_CODE_MAPPING[status]
           @headers = {
             "Content-Type"                  => content_type,
-            "Access-Control-Allow-Headers"  => "If-None-Match",
+            "Access-Control-Allow-Headers"  => "If-None-Match, If-Modified-Since",
             "Access-Control-Allow-Origin"   => "*"
           }
           headers.merge!(Broker.config[:headers]) if Broker.config.has_key?(:headers)
@@ -62,6 +62,7 @@ module Alephant
         end
 
         def self.component_not_modified(headers, request_env)
+          return false unless allow_not_modified_response_status
           return false if request_env.post?
           return false if request_env.if_modified_since.nil? && request_env.if_none_match.nil?
 
@@ -76,6 +77,10 @@ module Alephant
           etag.to_s.gsub(/\A"|"\Z/, '')
         end
 
+        def self.allow_not_modified_response_status
+          Broker.config[:allow_not_modified_response_status] || false
+        end
+
         def log
           logger.metric "BrokerNon200Response#{status}"
         end

data/lib/alephant/broker/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Broker
-    VERSION = "3.11.0"
+    VERSION = "3.12.0"
   end
 end

data/spec/integration/not_modified_response_spec.rb

@@ -0,0 +1,230 @@
+require_relative "spec_helper"
+require "alephant/broker"
+
+describe Alephant::Broker::Application do
+  include Rack::Test::Methods
+
+  let(:options) do
+    {
+      :lookup_table_name                  => "test_table",
+      :bucket_id                          => "test_bucket",
+      :path                               => "bucket_path",
+      :allow_not_modified_response_status => true
+    }
+  end
+
+  let(:app) do
+    described_class.new(
+      Alephant::Broker::LoadStrategy::S3::Sequenced.new,
+      options
+    )
+  end
+
+  let(:content) do
+    AWS::Core::Data.new(
+      :content_type => "test/content",
+      :content      => "Test",
+      :meta         => {
+        "head_ETag"          => "123",
+        "head_Last-Modified" => "Mon, 11 Apr 2016 10:39:57 GMT"
+      }
+    )
+  end
+
+  let(:sequencer_double) do
+    instance_double(
+      "Alephant::Sequencer::Sequencer",
+      :get_last_seen => "111"
+    )
+  end
+
+  let(:lookup_location_double) do
+    instance_double("Alephant::Lookup::Location", :location => "test/location")
+  end
+  let(:lookup_helper_double) do
+    instance_double(
+      "Alephant::Lookup::LookupHelper",
+      :read => lookup_location_double
+    )
+  end
+
+  let(:s3_double) { instance_double("Alephant::Storage", :get => content) }
+
+  let(:not_modified_status_code) { Alephant::Broker::Response::Base::NOT_MODIFIED_STATUS_CODE }
+
+  before do
+    allow_any_instance_of(Logger).to receive(:info)
+    allow_any_instance_of(Logger).to receive(:debug)
+    allow(Alephant::Lookup).to receive(:create) { lookup_helper_double }
+    allow(Alephant::Sequencer).to receive(:create) { sequencer_double }
+  end
+
+  describe "single component not modified response" do
+    before do
+      allow(Alephant::Storage).to receive(:new) { s3_double }
+      get(
+        "/component/test_component",
+        {},
+        {
+          "HTTP_IF_MODIFIED_SINCE" => "Mon, 11 Apr 2016 10:39:57 GMT"
+        }
+      )
+    end
+
+    specify { expect(last_response.status).to eql not_modified_status_code }
+    specify { expect(last_response.body).to eql "" }
+    specify { expect(last_response.headers).to_not include("Cache-Control") }
+    specify { expect(last_response.headers).to_not include("Pragma") }
+    specify { expect(last_response.headers).to_not include("Expires") }
+    specify { expect(last_response.headers["ETag"]).to eq("123") }
+    specify { expect(last_response.headers["Last-Modified"]).to eq("Mon, 11 Apr 2016 10:39:57 GMT") }
+  end
+
+  describe "Components POST unmodified '/components' response" do
+    let(:fixture_path)        { "#{File.dirname(__FILE__)}/../fixtures/json" }
+    let(:batch_json)          { IO.read("#{fixture_path}/batch.json").strip }
+    let(:batch_compiled_json) { IO.read("#{fixture_path}/batch_compiled.json").strip }
+    let(:s3_double_with_etag) { instance_double("Alephant::Storage") }
+    let(:lookup_location_double_for_options_request) do
+      instance_double("Alephant::Lookup::Location", :location => "test/location/with/options")
+    end
+
+    before do
+      allow(lookup_helper_double).to receive(:read)
+        .with("ni_council_results_table", { :foo => "bar" }, "111")
+        .and_return(lookup_location_double_for_options_request)
+
+      allow(s3_double_with_etag).to receive(:get)
+        .with("test/location")
+        .and_return(
+          content
+        )
+
+      allow(s3_double_with_etag).to receive(:get)
+        .with("test/location/with/options")
+        .and_return(
+          AWS::Core::Data.new(
+            :content_type => "test/content",
+            :content      => "Test",
+            :meta         => {
+              "head_ETag"          => "abc",
+              "head_Last-Modified" => "Mon, 11 Apr 2016 09:39:57 GMT"
+            }
+          )
+        )
+
+      allow(Alephant::Storage).to receive(:new) { s3_double_with_etag }
+    end
+
+    context "when requesting an unmodified response" do
+      let(:path)         { "/components/batch" }
+      let(:content_type) { "application/json" }
+      let(:etag)         { '"34774567db979628363e6e865127623f"' }
+
+      before do
+        post(path, batch_json,
+          "CONTENT_TYPE"  => content_type,
+          "HTTP_IF_NONE_MATCH" => etag)
+      end
+
+      specify { expect(last_response.status).to eql 200 }
+      specify { expect(last_response.body).to eq batch_compiled_json }
+
+      describe "response should have headers" do
+        it "should have a Content-Type header" do
+          expect(last_response.headers).to include("Content-Type")
+        end
+
+        it "should have ETag cache header" do
+          expect(last_response.headers["ETag"]).to eq(etag)
+        end
+
+        it "should have most recent Last-Modified header" do
+          expect(last_response.headers["Last-Modified"]).to eq("Mon, 11 Apr 2016 10:39:57 GMT")
+        end
+
+        it "shoud not have no cache headers" do
+          expect(last_response.headers).to_not include("Cache-Control")
+          expect(last_response.headers).to_not include("Pragma")
+          expect(last_response.headers).to_not include("Expires")
+        end
+      end
+    end
+  end
+
+  describe "Components GET unmodified '/components' response" do
+    let(:fixture_path)        { "#{File.dirname(__FILE__)}/../fixtures/json" }
+    let(:batch_compiled_json) { IO.read("#{fixture_path}/batch_compiled.json").strip }
+    let(:s3_double_with_etag) { instance_double("Alephant::Storage") }
+    let(:lookup_location_double_for_options_request) do
+      instance_double("Alephant::Lookup::Location", :location => "test/location/with/options")
+    end
+
+    before do
+      allow(lookup_helper_double).to receive(:read)
+        .with("ni_council_results_table", { :foo => "bar" }, "111")
+        .and_return(lookup_location_double_for_options_request)
+
+      allow(s3_double_with_etag).to receive(:get)
+        .with("test/location")
+        .and_return(
+          content
+        )
+
+      allow(s3_double_with_etag).to receive(:get)
+        .with("test/location/with/options")
+        .and_return(
+          AWS::Core::Data.new(
+            :content_type => "test/content",
+            :content      => "Test",
+            :meta         => {
+              "head_ETag"          => "abc",
+              "head_Last-Modified" => "Mon, 11 Apr 2016 09:39:57 GMT"
+            }
+          )
+        )
+
+      allow(Alephant::Storage).to receive(:new) { s3_double_with_etag }
+    end
+
+    context "when requesting an unmodified response with GET" do
+      let(:path)         { "/components/batch?batch_id=baz&components[ni_council_results_table][component]=ni_council_results_table&components[ni_council_results_table][options][foo]=bar&components[ni_council_results_table_no_options][component]=ni_council_results_table" }
+      let(:content_type) { "application/json" }
+      let(:etag)         { '"34774567db979628363e6e865127623f"' }
+
+      before do
+        get(
+          path,
+          {},
+          {
+            "CONTENT_TYPE"  => content_type,
+            "HTTP_IF_NONE_MATCH" => etag
+          }
+        )
+      end
+
+      specify { expect(last_response.status).to eql not_modified_status_code }
+      specify { expect(last_response.body).to eq "" }
+
+      describe "response should have headers" do
+        it "should not have a Content-Type header" do
+          expect(last_response.headers).to_not include("Content-Type")
+        end
+
+        it "should have ETag cache header" do
+          expect(last_response.headers["ETag"]).to eq(etag)
+        end
+
+        it "should have most recent Last-Modified header" do
+          expect(last_response.headers["Last-Modified"]).to eq("Mon, 11 Apr 2016 10:39:57 GMT")
+        end
+
+        it "shoud not have no cache headers" do
+          expect(last_response.headers).to_not include("Cache-Control")
+          expect(last_response.headers).to_not include("Pragma")
+          expect(last_response.headers).to_not include("Expires")
+        end
+      end
+    end
+  end
+end

data/spec/integration/rack_spec.rb

@@ -96,27 +96,6 @@ describe Alephant::Broker::Application do
     end
   end
 
-  describe "single component not modified response" do
-    before do
-      allow(Alephant::Storage).to receive(:new) { s3_double }
-      get(
-        "/component/test_component",
-        {},
-        {
-          "HTTP_IF_MODIFIED_SINCE" => "Mon, 11 Apr 2016 10:39:57 GMT"
-        }
-      )
-    end
-
-    specify { expect(last_response.status).to eql not_modified_status_code }
-    specify { expect(last_response.body).to eql "" }
-    specify { expect(last_response.headers).to_not include("Cache-Control") }
-    specify { expect(last_response.headers).to_not include("Pragma") }
-    specify { expect(last_response.headers).to_not include("Expires") }
-    specify { expect(last_response.headers["ETag"]).to eq("123") }
-    specify { expect(last_response.headers["Last-Modified"]).to eq("Mon, 11 Apr 2016 10:39:57 GMT") }
-  end
-
   describe "Components endpoint '/components' POST" do
     let(:fixture_path) { "#{File.dirname(__FILE__)}/../fixtures/json" }
     let(:batch_json) do
@@ -169,78 +148,6 @@ describe Alephant::Broker::Application do
     end
   end
 
-  describe "Components POST unmodified '/components' response" do
-    let(:fixture_path)        { "#{File.dirname(__FILE__)}/../fixtures/json" }
-    let(:batch_json)          { IO.read("#{fixture_path}/batch.json").strip }
-    let(:batch_compiled_json) { IO.read("#{fixture_path}/batch_compiled.json").strip }
-    let(:s3_double_with_etag) { instance_double("Alephant::Storage") }
-    let(:lookup_location_double_for_options_request) do
-      instance_double("Alephant::Lookup::Location", :location => "test/location/with/options")
-    end
-
-    before do
-      allow(lookup_helper_double).to receive(:read)
-        .with("ni_council_results_table", { :foo => "bar" }, "111")
-        .and_return(lookup_location_double_for_options_request)
-
-      allow(s3_double_with_etag).to receive(:get)
-        .with("test/location")
-        .and_return(
-          content
-        )
-
-      allow(s3_double_with_etag).to receive(:get)
-        .with("test/location/with/options")
-        .and_return(
-          AWS::Core::Data.new(
-            :content_type => "test/content",
-            :content      => "Test",
-            :meta         => {
-              "head_ETag"          => "abc",
-              "head_Last-Modified" => "Mon, 11 Apr 2016 09:39:57 GMT"
-            }
-          )
-        )
-
-      allow(Alephant::Storage).to receive(:new) { s3_double_with_etag }
-    end
-
-    context "when requesting an unmodified response" do
-      let(:path)         { "/components/batch" }
-      let(:content_type) { "application/json" }
-      let(:etag)         { '"34774567db979628363e6e865127623f"' }
-
-      before do
-        post(path, batch_json,
-          "CONTENT_TYPE"  => content_type,
-          "HTTP_IF_NONE_MATCH" => etag)
-      end
-
-      specify { expect(last_response.status).to eql 200 }
-      specify { expect(last_response.body).to eq batch_compiled_json }
-
-      describe "response should have headers" do
-        it "should have a Content-Type header" do
-          expect(last_response.headers).to include("Content-Type")
-        end
-
-        it "should have ETag cache header" do
-          expect(last_response.headers["ETag"]).to eq(etag)
-        end
-
-        it "should have most recent Last-Modified header" do
-          expect(last_response.headers["Last-Modified"]).to eq("Mon, 11 Apr 2016 10:39:57 GMT")
-        end
-
-        it "shoud not have no cache headers" do
-          expect(last_response.headers).to_not include("Cache-Control")
-          expect(last_response.headers).to_not include("Pragma")
-          expect(last_response.headers).to_not include("Expires")
-        end
-      end
-    end
-  end
-
   describe "Components endpoint '/components' GET" do
     let(:fixture_path)        { "#{File.dirname(__FILE__)}/../fixtures/json" }
     let(:batch_compiled_json) do
@@ -290,82 +197,6 @@ describe Alephant::Broker::Application do
     end
   end
 
-  describe "Components GET unmodified '/components' response" do
-    let(:fixture_path)        { "#{File.dirname(__FILE__)}/../fixtures/json" }
-    let(:batch_compiled_json) { IO.read("#{fixture_path}/batch_compiled.json").strip }
-    let(:s3_double_with_etag) { instance_double("Alephant::Storage") }
-    let(:lookup_location_double_for_options_request) do
-      instance_double("Alephant::Lookup::Location", :location => "test/location/with/options")
-    end
-
-    before do
-      allow(lookup_helper_double).to receive(:read)
-        .with("ni_council_results_table", { :foo => "bar" }, "111")
-        .and_return(lookup_location_double_for_options_request)
-
-      allow(s3_double_with_etag).to receive(:get)
-        .with("test/location")
-        .and_return(
-          content
-        )
-
-      allow(s3_double_with_etag).to receive(:get)
-        .with("test/location/with/options")
-        .and_return(
-          AWS::Core::Data.new(
-            :content_type => "test/content",
-            :content      => "Test",
-            :meta         => {
-              "head_ETag"          => "abc",
-              "head_Last-Modified" => "Mon, 11 Apr 2016 09:39:57 GMT"
-            }
-          )
-        )
-
-      allow(Alephant::Storage).to receive(:new) { s3_double_with_etag }
-    end
-
-    context "when requesting an unmodified response with GET" do
-      let(:path)         { "/components/batch?batch_id=baz&components[ni_council_results_table][component]=ni_council_results_table&components[ni_council_results_table][options][foo]=bar&components[ni_council_results_table_no_options][component]=ni_council_results_table" }
-      let(:content_type) { "application/json" }
-      let(:etag)         { '"34774567db979628363e6e865127623f"' }
-
-      before do
-        get(
-          path,
-          {},
-          {
-            "CONTENT_TYPE"  => content_type,
-            "HTTP_IF_NONE_MATCH" => etag
-          }
-        )
-      end
-
-      specify { expect(last_response.status).to eql not_modified_status_code }
-      specify { expect(last_response.body).to eq "" }
-
-      describe "response should have headers" do
-        it "should not have a Content-Type header" do
-          expect(last_response.headers).to_not include("Content-Type")
-        end
-
-        it "should have ETag cache header" do
-          expect(last_response.headers["ETag"]).to eq(etag)
-        end
-
-        it "should have most recent Last-Modified header" do
-          expect(last_response.headers["Last-Modified"]).to eq("Mon, 11 Apr 2016 10:39:57 GMT")
-        end
-
-        it "shoud not have no cache headers" do
-          expect(last_response.headers).to_not include("Cache-Control")
-          expect(last_response.headers).to_not include("Pragma")
-          expect(last_response.headers).to_not include("Expires")
-        end
-      end
-    end
-  end
-
   describe "S3 headers" do
     let(:content) do
       AWS::Core::Data.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-broker
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.0
 platform: ruby
 authors:
 - BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -322,6 +322,7 @@ files:
 - spec/fixtures/json/batch.json
 - spec/fixtures/json/batch_compiled.json
 - spec/http_spec.rb
+- spec/integration/not_modified_response_spec.rb
 - spec/integration/rack_spec.rb
 - spec/integration/spec_helper.rb
 - spec/spec_helper.rb
@@ -355,6 +356,7 @@ test_files:
 - spec/fixtures/json/batch.json
 - spec/fixtures/json/batch_compiled.json
 - spec/http_spec.rb
+- spec/integration/not_modified_response_spec.rb
 - spec/integration/rack_spec.rb
 - spec/integration/spec_helper.rb
 - spec/spec_helper.rb