alephant-broker 3.9.2 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3551ebe253cb1eb4939a53c0175a486e018aa640
-  data.tar.gz: 112525df499493ea48bbaf9c7c7d7a5aa99c65b9
+  metadata.gz: 272a9c7f2d5df921c3188da9cf79398f5cf5c8f7
+  data.tar.gz: a3f1f91801351092cf9f8da3e1bc533c69178875
 SHA512:
-  metadata.gz: e99f9ffabc1aeead26a0ee7d8cab8e363b2d8e7274a3b544e0aca9916ecb5157c3aed074c5989523fd97dbf49959a3c442a8276fd53fb03eee0dbdd9d5e3bff6
-  data.tar.gz: 7d70165c6a1fdc5a31ca876a744b0d55b3bc62fe5d542fd8d5ad6b63a7f24fb131896958ee2d47bb578816c883d8b643dbf6dbe5faebdd0cf7dc398fa51eed51
+  metadata.gz: 512e9abbe4ad8299257d01e816268992876ff91ba5abcade3e4d54bf10fb2621ce5ce091f9c6b9ffe9df1e586589e1e099379dfa43d3f188a0f72ce99f3c3d77
+  data.tar.gz: 54e34ee9a11283eb9e7a44f1781564537419036f81a6a81a43f23a5cad48d2bc6c0a0f009bc99cfaae7a6f83f4ec1702b730943050b933159dcd40dd8ba88ff4

data/alephant-broker.gemspec

@@ -36,7 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "alephant-logger", "1.2.0"
   spec.add_runtime_dependency 'alephant-sequencer'
   spec.add_runtime_dependency "dalli-elasticache"
-  spec.add_runtime_dependency "pmap"
   spec.add_runtime_dependency "faraday"
   spec.add_runtime_dependency "crimp"
 end

data/lib/alephant/broker/cache.rb

@@ -11,19 +11,19 @@ module Alephant
 
         def initialize
           unless config_endpoint.nil?
-            @@elasticache ||= ::Dalli::ElastiCache.new(config_endpoint, { :expires_in => ttl })
-            @@client ||= @@elasticache.client
+            @elasticache ||= ::Dalli::ElastiCache.new(config_endpoint, { :expires_in => ttl })
+            @client ||= @elasticache.client
           else
             logger.debug "Broker::Cache::Client#initialize: No config endpoint, NullClient used"
             logger.metric "NoConfigEndpoint"
-            @@client = NullClient.new
+            @client = NullClient.new
           end
         end
 
         def get(key, &block)
           begin
             versioned_key = versioned key
-            result = @@client.get versioned_key
+            result = @client.get versioned_key
             logger.info "Broker::Cache::Client#get key: #{versioned_key} - #{result ? 'hit' : 'miss'}"
             logger.metric "GetKeyMiss" unless result
             result ? result : set(key, block.call)
@@ -33,7 +33,7 @@ module Alephant
         end
 
         def set(key, value, ttl = nil)
-          value.tap { |o| @@client.set(versioned(key), o, ttl) }
+          value.tap { |o| @client.set(versioned(key), o, ttl) }
         end
 
         private
@@ -56,7 +56,9 @@ module Alephant
       end
 
       class NullClient
-        def get(key); end
+        def get(key, &block)
+          yield
+        end
 
         def set(key, value, ttl = nil)
           value

data/lib/alephant/broker/environment.rb

@@ -32,6 +32,14 @@ module Alephant
         settings['PATH_INFO']
       end
 
+      def if_none_match
+        settings["IF_NONE_MATCH"]
+      end
+
+      def if_modified_since
+        settings["IF_MODIFIED_SINCE"]
+      end
+
       def data
         parse(rack_input) if post?
       end

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

@@ -1,6 +1,5 @@
-require 'alephant/logger'
-require 'alephant/broker/component'
-require 'pmap'
+require "alephant/logger"
+require "alephant/broker/component"
 
 module Alephant
   module Broker
@@ -13,7 +12,7 @@ module Alephant
         def initialize(component_factory, env)
           logger.info "Request::Batch#initialize: id: #{env.data['batch_id']}"
 
-          @batch_id          = env.data['batch_id']
+          @batch_id          = env.data["batch_id"]
           @component_factory = component_factory
           @components        = components_for env
         end
@@ -21,11 +20,11 @@ module Alephant
         private
 
         def components_for(env)
-          env.data['components'].pmap do |c|
+          env.data["components"].map do |c|
             @component_factory.create(
-              c['component'],
+              c["component"],
               batch_id,
-              c['options']
+              c["options"]
             )
           end
         end

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

@@ -12,16 +12,16 @@ module Alephant
       class Handler
         extend Logger
 
-        def self.request_for(load_strategy, env)
-          Request::Factory.request_for(load_strategy, env)
+        def self.request_for(load_strategy, request_env)
+          Request::Factory.request_for(load_strategy, request_env)
         end
 
-        def self.response_for(request)
-          Response::Factory.response_for request
+        def self.response_for(request, request_env)
+          Response::Factory.response_for(request, request_env)
         end
 
-        def self.process(load_strategy, env)
-          response_for request_for(load_strategy, env)
+        def self.process(load_strategy, request_env)
+          response_for(request_for(load_strategy, request_env), request_env)
         end
       end
     end

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

@@ -6,13 +6,17 @@ module Alephant
       class Asset < Base
         include Logger
 
-        def initialize(component)
+        def initialize(component, request_env)
           @component = component
-          super component.status
+
+          @status = component_not_modified(@component.headers, request_env) ? 304 : component.status
+
+          super @status
+
+          @headers.merge!(@component.headers)
         end
 
         def setup
-          @headers.merge!(@component.headers)
           @content  = @component.content
           log if @component.is_a? Component
         end

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

@@ -14,6 +14,7 @@ module Alephant
 
         STATUS_CODE_MAPPING = {
           200 => "ok",
+          304 => "",
           404 => "Not found",
           500 => "Error retrieving content"
         }
@@ -24,8 +25,8 @@ module Alephant
           @headers.merge!(Broker.config[:headers]) if Broker.config.has_key?(:headers)
           @status  = status
 
-          add_no_cache_headers if status != 200
-          setup
+          add_no_cache_headers if should_add_no_cache_headers?(status)
+          setup if status == 200
         end
 
         protected
@@ -34,6 +35,10 @@ module Alephant
 
         private
 
+        def should_add_no_cache_headers?(status)
+          status != 200 && status != 304
+        end
+
         def add_no_cache_headers
           headers.merge!(
             "Cache-Control" => "no-cache, must-revalidate",
@@ -43,6 +48,12 @@ module Alephant
           log
         end
 
+        def component_not_modified(headers, request_env)
+          return false if headers["Last-Modified"].nil? && headers["ETag"].nil?
+
+          headers["Last-Modified"] == request_env.if_modified_since || headers["ETag"] == request_env.if_none_match
+        end
+
         def log
           logger.metric "BrokerNon200Response#{status}"
         end

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

@@ -9,11 +9,14 @@ module Alephant
 
         attr_reader :components, :batch_id
 
-        def initialize(components, batch_id)
+        def initialize(components, batch_id, request_env)
           @components = components
           @batch_id   = batch_id
+          @status     = component_not_modified(batch_response_headers, request_env) ? 304 : 200
 
-          super(200, "application/json")
+          super(@status, "application/json")
+
+          @headers.merge!(batch_response_headers)
         end
 
         def setup
@@ -21,8 +24,6 @@ module Alephant
             'batch_id' => batch_id,
             'components' => json
           })
-
-          @headers.merge!(batch_response_headers)
         end
 
         private
@@ -53,7 +54,7 @@ module Alephant
         def batch_response_etag
           etags = components.map do |component|
             component.headers["ETag"]
-          end.compact
+          end.compact.sort
 
           Crimp.signature(etags)
         end

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

@@ -4,12 +4,12 @@ module Alephant
   module Broker
     module Response
       class Factory
-        def self.response_for(request)
+        def self.response_for(request, request_env)
           case request
           when Request::Asset
-            Asset.new(request.component)
+            Asset.new(request.component, request_env)
           when Request::Batch
-            Batch.new(request.components, request.batch_id)
+            Batch.new(request.components, request.batch_id, request_env)
           when Request::Status
             Status.new
           else

data/lib/alephant/broker/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Broker
-    VERSION = "3.9.2"
+    VERSION = "3.10.0"
   end
 end

data/spec/integration/rack_spec.rb

@@ -1,7 +1,9 @@
 require_relative "spec_helper"
+require "alephant/broker"
 
 describe Alephant::Broker::Application do
   include Rack::Test::Methods
+
   let(:options) do
     {
       :lookup_table_name => "test_table",
@@ -16,16 +18,18 @@ describe Alephant::Broker::Application do
       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"
+        "head_ETag"          => "123",
+        "head_Last-Modified" => "Mon, 11 Apr 2016 10:39:57 GMT"
       }
     )
   end
+
   let(:sequencer_double) do
     instance_double(
       "Alephant::Sequencer::Sequencer",
@@ -90,6 +94,27 @@ 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",
+        {},
+        {
+          "IF_MODIFIED_SINCE" => "Mon, 11 Apr 2016 10:39:57 GMT"
+        }
+      )
+    end
+
+    specify { expect(last_response.status).to eql 304 }
+    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'" do
     let(:fixture_path) { "#{File.dirname(__FILE__)}/../fixtures/json" }
     let(:batch_json) do
@@ -98,9 +123,10 @@ describe Alephant::Broker::Application do
     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).to receive(:get).and_return(
+      allow(s3_double_batch).to receive(:get).and_return(
         content,
         AWS::Core::Data.new(
           :content_type => "test/content",
@@ -112,7 +138,7 @@ describe Alephant::Broker::Application do
         )
       )
 
-      allow(Alephant::Storage).to receive(:new) { s3_double }
+      allow(Alephant::Storage).to receive(:new) { s3_double_batch }
     end
 
     context "when using valid batch asset data" do
@@ -141,6 +167,78 @@ describe Alephant::Broker::Application do
     end
   end
 
+  describe "Components 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,
+          "IF_NONE_MATCH" => etag)
+      end
+
+      specify { expect(last_response.status).to eql 304 }
+      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(

data/spec/spec_helper.rb

@@ -9,6 +9,10 @@ require "alephant/broker/load_strategy/http"
 require "alephant/broker/cache"
 require "alephant/broker/errors/content_not_found"
 
-require 'rack/test'
+require "rack/test"
 
-ENV['RACK_ENV'] = 'test'
+ENV['RACK_ENV'] = "test"
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-broker
 version: !ruby/object:Gem::Version
-  version: 3.9.2
+  version: 3.10.0
 platform: ruby
 authors:
 - BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -234,20 +234,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  name: pmap
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: