alephant-broker 3.10.2 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 223acfc17ab349160c5dbf9597213a35b9cdc33a
-  data.tar.gz: abb1103b13b95e494096b531ad8c109d2c965bdc
+  metadata.gz: 58251bb948e3620c95b0c67e8643e60426c25818
+  data.tar.gz: c355b17fe2d366043fbd84f5e284377f9d353a44
 SHA512:
-  metadata.gz: ec8f97f5911fef1ca5d4bfee7694fee0c9173d4c2275dec58ae3d2161b0d6b19ccf6faee403d00beaa54c7bcaec8dcbeaa80a584d0f45da1e05e0277a6856d28
-  data.tar.gz: 89841c9e7fa8bcc92e2d20da30834e0b63d80f8cca322a0e65b1ad0455390dba3161a61d5ac03ab7d585968b5b693f34ac1be6d3294cfa135359f968be608867
+  metadata.gz: dbdaf0f97e7c873b030be8418d6b7b7a076826fcd576d7f60b9c5f734f4ac8a13db6af1cb4744b222b48ee01abd267c6df051f22fac85dd8285b53b36128ce2c
+  data.tar.gz: a143fb0fbca1a39ab62a1a7facd718f9f38221a53daae7514ca82d1f9b7a42b3992ba06f8b427da717a919a50801f9877bb56d7c4b34e7adeae69702c5d63fde

data/alephant-broker.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "dalli-elasticache"
   spec.add_runtime_dependency "faraday"
   spec.add_runtime_dependency "crimp"
+  spec.add_runtime_dependency "listen", "~> 3.0.0"
 end

data/lib/alephant/broker/environment.rb

@@ -13,23 +13,23 @@ module Alephant
       end
 
       def method
-        settings['REQUEST_METHOD']
+        settings["REQUEST_METHOD"]
       end
 
       def post?
-        settings['REQUEST_METHOD'] == 'POST'
+        settings["REQUEST_METHOD"] == "POST"
       end
 
       def get?
-        settings['REQUEST_METHOD'] == 'GET'
+        settings["REQUEST_METHOD"] == "GET"
       end
 
       def query
-        settings['QUERY_STRING'] || ""
+        settings["QUERY_STRING"] || ""
       end
 
       def path
-        settings['PATH_INFO']
+        settings["PATH_INFO"]
       end
 
       def if_none_match
@@ -51,7 +51,7 @@ module Alephant
       private
 
       def rack_input
-        (settings['rack.input'].read).tap { settings['rack.input'].rewind }
+        (settings["rack.input"].read).tap { settings["rack.input"].rewind }
       end
 
       def parse(json)

data/lib/alephant/broker/request/batch.rb

@@ -10,24 +10,37 @@ module Alephant
         attr_reader :batch_id, :components, :load_strategy
 
         def initialize(component_factory, env)
-          logger.info "Request::Batch#initialize: id: #{env.data['batch_id']}" if env.data
+          if env.data
+            @batch_id        = env.data["batch_id"]
+          else
+            @batch_id        = env.options.fetch("batch_id", nil)
+          end
+
+          logger.info "Request::Batch#initialize: id: #{batch_id}"
 
-          @batch_id          = env.data["batch_id"] if env.data
           @component_factory = component_factory
-          @components        = components_for env
+
+          @components        = env.post? ? components_post(env) : components_get(env)
         end
 
         private
 
-        def components_for(env)
+        def components_post(env)
           ((env.data || {}).fetch("components", []) || []).map do |c|
-            @component_factory.create(
-              c["component"],
-              batch_id,
-              c["options"]
-            )
+            create_component(c["component"], batch_id, c["options"])
+          end
+        end
+
+        def components_get(env)
+          (env.options.fetch("components", []) || []).map do |c|
+            options = c[1].fetch("options", {}) || {}
+            create_component(c[1]["component"], batch_id, options)
           end
         end
+
+        def create_component(component, batch_id, options)
+          @component_factory.create(component, batch_id, options)
+        end
       end
     end
   end

data/lib/alephant/broker/request/factory.rb

@@ -6,18 +6,18 @@ module Alephant
     module Request
       class Factory
         def self.request_type_from(env)
-          env.path.split('/')[1]
+          env.path.split("/")[1]
         end
 
         def self.request_for(load_strategy, env)
           component_factory = ComponentFactory.new load_strategy
 
           case request_type_from(env)
-          when 'component'
+          when "component"
             Asset.new(component_factory, env)
-          when 'components'
+          when "components"
             Batch.new(component_factory, env)
-          when 'status'
+          when "status"
             Status.new
           else
             NotFound.new

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

@@ -12,7 +12,7 @@ module Alephant
 
         attr_reader :content, :headers, :status
 
-        NOT_MODIFIED_STATUS_CODE = 202
+        NOT_MODIFIED_STATUS_CODE = 304
 
         STATUS_CODE_MAPPING = {
           200                      => "ok",
@@ -62,6 +62,7 @@ module Alephant
         end
 
         def self.component_not_modified(headers, request_env)
+          return false if request_env.post?
           return false if request_env.if_modified_since.nil? && request_env.if_none_match.nil?
 
           last_modified_match = !request_env.if_modified_since.nil? && headers["Last-Modified"] == request_env.if_modified_since

data/lib/alephant/broker/version.rb

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

data/spec/integration/rack_spec.rb

@@ -117,7 +117,7 @@ describe Alephant::Broker::Application do
     specify { expect(last_response.headers["Last-Modified"]).to eq("Mon, 11 Apr 2016 10:39:57 GMT") }
   end
 
-  describe "Components endpoint '/components'" do
+  describe "Components endpoint '/components' POST" do
     let(:fixture_path) { "#{File.dirname(__FILE__)}/../fixtures/json" }
     let(:batch_json) do
       IO.read("#{fixture_path}/batch.json").strip
@@ -169,7 +169,7 @@ describe Alephant::Broker::Application do
     end
   end
 
-  describe "Components unmodified '/components' response" do
+  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 }
@@ -216,8 +216,8 @@ describe Alephant::Broker::Application do
           "HTTP_IF_NONE_MATCH" => etag)
       end
 
-      specify { expect(last_response.status).to eql not_modified_status_code }
-      specify { expect(last_response.body).to eq "" }
+      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
@@ -241,6 +241,131 @@ describe Alephant::Broker::Application do
     end
   end
 
+  describe "Components endpoint '/components' GET" do
+    let(:fixture_path)        { "#{File.dirname(__FILE__)}/../fixtures/json" }
+    let(:batch_compiled_json) do
+      IO.read("#{fixture_path}/batch_compiled.json").strip
+    end
+    let(:s3_double_batch) { instance_double("Alephant::Storage") }
+
+    before do
+      allow(s3_double_batch).to receive(:get).and_return(
+        content,
+        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_batch }
+    end
+
+    context "when using valid batch asset data" 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" }
+
+      before { get path, {}, "CONTENT_TYPE" => content_type }
+
+      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 content headers" do
+          expect(last_response.headers["Content-Type"]).to eq("application/json")
+          expect(last_response.headers["Content-Length"]).to eq("266")
+        end
+
+        it "should have ETag cache header" do
+          expect(last_response.headers["ETag"]).to eq('"34774567db979628363e6e865127623f"')
+        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
+      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
+
   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.10.2
+  version: 3.11.0
 platform: ruby
 authors:
 - BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +262,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: listen
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Brokers requests for alephant components
 email:
 - FutureMediaNewsRubyGems@bbc.co.uk