alephant-broker 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70103bf930de096da5829872125d161af9a9d17a
-  data.tar.gz: 95a5865427ae88a3b456f1f38e0ae7583f309f37
+  metadata.gz: bad508555563294c2782af87c53618b28b78834b
+  data.tar.gz: ce942ad7a32671222334f7883d772ea5a3135467
 SHA512:
-  metadata.gz: 51e92cb40072fbe3088e08495fabfc90e4140255572ac8ae0a720398c8e25ed4d5b87e86bbaa850c5b276b83c4e2640debf35917a7bd4b496c158a252207d0f0
-  data.tar.gz: a5fae01f6f1d2463e9dc028b0850cdbf7c767853aaf0787acd522bf626739c77863e79b130d2aa16723fc9b82dab004987ac917c15a65eec34bab8dd40468a61
+  metadata.gz: baf72da1f88eb8dec96b3e41af92538325a0cbcb4a796861bc292e237d856a6710ce171af01270e036f5e64a6cff415508c7a3b9e6ca44a1905707958d38d1a9
+  data.tar.gz: 5e8768a0475a5a5e8358f4e6aad32019ffa4648f24f77de89e3567666490403256b9069fce804d12e2713592fb45a9ca06340add5cf9e0a256e57561729ad14c

data/README.md

@@ -125,6 +125,16 @@ run Alephant::Broker::Application.new(
 )
 ```
 
+### Cache version number
+
+The broker looks for a configuration value `elasticache_cache_version` and if it exists it uses it to construct the cache key.
+This allows the cache to be busted if the data in the cache changes, or for any other reason that it needs to be invalidated.
+
+This version is added as a header to the response in the following format:
+
+`X-Cache-Version: {CACHE_VERSION}`
+
+
 ## Contributing
 
 1. [Fork it!]( http://github.com/bbc-news/alephant-broker/fork)

data/lib/alephant/broker.rb

@@ -2,11 +2,9 @@ require 'alephant/broker/version'
 require 'alephant/broker/request'
 require 'alephant/broker/environment'
 require 'alephant/broker'
-require 'ostruct'
 
 module Alephant
   module Broker
-    @@poll = true
 
     def self.handle(load_strategy, env)
       Request::Handler.process(load_strategy, env)
@@ -20,14 +18,6 @@ module Alephant
       @@configuration = c
     end
 
-    def self.poll?
-      @@poll
-    end
-
-    def self.poll=(state)
-      @@poll = state
-    end
-
     class Application
       attr_reader :load_strategy
 
@@ -37,11 +27,7 @@ module Alephant
       end
 
       def call(env)
-        if ::Alephant::Broker.poll?
-          send response_for(environment_for(env))
-        else
-          send stop_poll_response
-        end
+        send response_for(environment_for(env))
       end
 
       def environment_for(env)
@@ -61,23 +47,6 @@ module Alephant
           ]
         ]
       end
-
-      private
-
-      def stop_poll_response
-        response = OpenStruct.new(
-          :status   => 420,
-          :content  => "Stopped polling",
-          :cached   => false,
-          :version  => 0,
-          :sequence => 0,
-          :headers => {
-            "Content-Type"   => "plain/text",
-            "X-Cached"       => "false",
-            "X-Stop-Polling" => "true"
-          }
-        )
-      end
     end
   end
 end

data/lib/alephant/broker/cache.rb

@@ -22,7 +22,8 @@ module Alephant
 
         def get(key, &block)
           begin
-            result = @@client.get(versioned(key))
+            key = versioned(key)
+            result = @@client.get key
             logger.info("Broker::Cache::Client#get key: #{key} - #{result ? 'hit' : 'miss'}")
             logger.metric(:name => "BrokerCacheClientGetKeyMiss", :unit => "Count", :value => 1) unless result
             result ? result : set(key, block.call)

data/lib/alephant/broker/component.rb

@@ -27,8 +27,6 @@ module Alephant
       def headers
         {
           'Content-Type' => data[:content_type].to_s,
-          'X-Version'    => meta.version.to_s,
-          'X-Cached'     => meta.cached.to_s
         }.merge(data[:headers] || {})
       end
 

data/lib/alephant/broker/component_meta.rb

@@ -2,23 +2,11 @@ module Alephant
   module Broker
     class ComponentMeta
       attr_reader :id, :options, :batch_id
-      attr_accessor :cached
 
       def initialize(id, batch_id, options)
         @id          = id
         @batch_id    = batch_id
         @options     = convert_keys(options || {})
-        @cached      = true
-      end
-
-      def cache_key
-        "#{id}/#{opts_hash}/#{version}"
-      end
-
-      def version
-        Broker.config.fetch(
-          'elasticache_cache_version', 'not available'
-        ).to_s
       end
 
       def key
@@ -29,27 +17,19 @@ module Alephant
         Crimp.signature options
       end
 
+      def component_key
+        "#{id}/#{opts_hash}"
+      end
+
       private
 
       def convert_keys(hash)
         Hash[ hash.map { |k, v| [k.to_sym, v] } ]
       end
 
-      def component_key
-        "#{id}/#{opts_hash}"
-      end
-
       def renderer_key
         "#{batch_id}/#{opts_hash}"
       end
-
-      def headers(data)
-        {
-          'Content-Type' => data[:content_type].to_s,
-          'X-Version'    => version.to_s,
-          'X-Cached'     => cached.to_s
-        }.merge(data[:headers] || {})
-      end
     end
   end
 end

data/lib/alephant/broker/load_strategy/s3/base.rb

@@ -9,6 +9,11 @@ module Alephant
       module S3
         class Base
           include Logger
+          attr_accessor :cached
+
+          def initialize
+            @cached = true
+          end
 
           def load(component_meta)
             add_s3_headers(
@@ -23,7 +28,7 @@ module Alephant
             )
             add_s3_headers(
               cache.set(
-                component_meta.cache_key,
+                cache_key(component_meta),
                 retrieve_object(component_meta)
               ),
               component_meta
@@ -36,6 +41,10 @@ module Alephant
             Hash.new
           end
 
+          def cache_key(component_meta)
+            component_meta.component_key
+          end
+
           private
 
           def s3_path(component_meta)
@@ -53,7 +62,7 @@ module Alephant
           end
 
           def retrieve_object(component_meta)
-            component_meta.cached = false
+            cached = false
             s3.get s3_path(component_meta)
           rescue AWS::S3::Errors::NoSuchKey, InvalidCacheKey
             logger.metric(
@@ -65,7 +74,7 @@ module Alephant
           end
 
           def cache_object(component_meta)
-            cache.get(component_meta.cache_key) do
+            cache.get cache_key(component_meta) do
               retrieve_object component_meta
             end
           end
@@ -82,6 +91,13 @@ module Alephant
               Broker.config[:lookup_table_name]
             )
           end
+
+          def headers(component_meta)
+            {
+              'X-Cache-Version'    => Broker.config['elasticache_cache_version'].to_s,
+              'X-Cached'           => cached.to_s
+            }
+          end
         end
       end
     end

data/lib/alephant/broker/load_strategy/s3/sequenced.rb

@@ -9,10 +9,6 @@ module Alephant
             sequencer.get_last_seen component_meta.key
           end
 
-          def headers(component_meta)
-            { "X-Sequence" => sequence(component_meta).to_s }
-          end
-
           def s3_path(component_meta)
             lookup.read(
               component_meta.id,
@@ -28,6 +24,16 @@ module Alephant
               Broker.config[:sequencer_table_name], nil
             )
           end
+
+          def cache_key(component_meta)
+            "#{super(component_meta)}/#{sequence(component_meta)}"
+          end
+
+          def headers(component_meta)
+            {
+              "X-Sequence" => sequence(component_meta).to_s
+            }.merge(super(component_meta))
+          end
         end
       end
     end

data/lib/alephant/broker/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Broker
-    VERSION = "3.2.0"
+    VERSION = "3.3.0"
   end
 end

metadata

@@ -1,281 +1,281 @@
 --- !ruby/object:Gem::Specification
 name: alephant-broker
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Steven Jack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rspec
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rspec-nc
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: guard
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: guard
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: guard-rspec
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: pry
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-remote
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: pry-remote
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-nav
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: pry-nav
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rake-rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+        version: 0.0.2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.2
-  name: rake-rspec
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: bundler
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.2
-- !ruby/object:Gem::Dependency
+        version: '1.5'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  name: bundler
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rake
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rack-test
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rack-test
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: alephant-lookup
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: alephant-lookup
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-cache
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: alephant-cache
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-logger
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0'
-  name: alephant-logger
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-sequencer
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: alephant-sequencer
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: dalli-elasticache
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: dalli-elasticache
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: pmap
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !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
+- !ruby/object:Gem::Dependency
+  name: faraday
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: faraday
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: crimp
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: crimp
   prerelease: false
   type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Brokers requests for alephant components
 email:
 - stevenmajack@gmail.com