alephant-lookup 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aff72c4a54e98f1083023e67503f88a7290f0bdb
-  data.tar.gz: 4570723dbdbd206854ed2d992c82405a8036aaa7
+  metadata.gz: 6f7e07c301d41b1ad0433b62cbd83e89d4e1a911
+  data.tar.gz: 785873a081b3d684b092f4aa74d408f22dab9141
 SHA512:
-  metadata.gz: b912276212e95c51a3b7bddf8d99c1234b8f2df34555625dc7329905b1188c69bb52a120fa9ef851d9f1edc3ce8b366aaede38507c637139eacf05e3a341511e
-  data.tar.gz: 42ef112c847bb894400f06684b549b6490498e1be173550d20b745361f907a6ef3a4061a8e62fdc61dd816eee4eb14ae0511bd1998e8177cc05e0380120ca5ed
+  metadata.gz: 540b154e9875cb1c1977ac87f68c00dbb0b394f2e36f8d3e73703f3f29605e0a1b63ba9f9fbe275804c2e9a094038303d0eea936d0aa8fc3a096c9d39e952010
+  data.tar.gz: 992e6df834993e052f6f82ac1cc279a8e774569e4ee6a59c58b6e06fd46c49132c31b3d83bc3fae9e6563e0a01d493d180d6ab378a2a0475448db4238d9da780

data/alephant-lookup.gemspec

@@ -28,9 +28,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 
-  spec.add_runtime_dependency 'aws-sdk', '~> 1.0'
-  spec.add_runtime_dependency 'alephant-logger'
-  spec.add_runtime_dependency 'alephant-support'
+  spec.add_runtime_dependency "aws-sdk", "~> 1.0"
+  spec.add_runtime_dependency "alephant-logger"
+  spec.add_runtime_dependency "alephant-support"
 
+  spec.add_runtime_dependency "dalli-elasticache"
   spec.add_runtime_dependency "crimp"
 end

data/lib/alephant/lookup.rb

@@ -9,9 +9,9 @@ module Alephant
     include Logger
     @@lookup_tables = {}
 
-    def self.create(table_name)
+    def self.create(table_name, config={})
       @@lookup_tables[table_name] ||= LookupTable.new(table_name)
-      LookupHelper.new(@@lookup_tables[table_name])
+      LookupHelper.new(@@lookup_tables[table_name], config)
     end
   end
 end

data/lib/alephant/lookup/lookup_cache.rb

@@ -0,0 +1,69 @@
+require 'dalli-elasticache'
+require 'alephant/logger'
+
+module Alephant
+  module Lookup
+    class LookupCache
+      include Logger
+
+      attr_reader :config
+
+      DEFAULT_TTL  = 5
+
+      def initialize(config={})
+        @config = config
+
+        unless config_endpoint.nil?
+          @elasticache ||= ::Dalli::ElastiCache.new(config_endpoint, { :expires_in => ttl })
+          @client ||= @elasticache.client
+        else
+          logger.debug "Alephant::LookupCache::#initialize: No config endpoint, NullClient used"
+          logger.metric "NoConfigEndpoint"
+          @client = NullClient.new
+        end
+      end
+
+      def get(key, &block)
+        begin
+          versioned_key = versioned key
+          result = @client.get versioned_key
+          logger.info "Alephant::LookupCache#get key: #{versioned_key} - #{result ? 'hit' : 'miss'}"
+          logger.metric "GetKeyMiss" unless result
+          result ? result : set(key, block.call)
+        rescue StandardError => e
+          block.call if block_given?
+        end
+      end
+
+      def set(key, value, ttl = nil)
+        value.tap { |o| @client.set(versioned(key), o, ttl) }
+      end
+
+      private
+
+      def config_endpoint
+        config["elasticache_config_endpoint"]
+      end
+
+      def ttl
+        config['elasticache_ttl'] || DEFAULT_TTL
+      end
+
+      def versioned(key)
+        [key, cache_version].compact.join('_')
+      end
+
+      def cache_version
+        config['elasticache_cache_version']
+      end
+    end
+
+    class NullClient
+      def get(key); end
+
+      def set(key, value, ttl = nil)
+        value
+      end
+    end
+  end
+end

data/lib/alephant/lookup/lookup_helper.rb

@@ -1,5 +1,6 @@
 require "alephant/lookup/lookup_table"
 require "alephant/lookup/lookup_query"
+require "alephant/lookup/lookup_cache"
 
 require 'alephant/logger'
 
@@ -8,10 +9,11 @@ module Alephant
     class LookupHelper
       include Logger
 
-      attr_reader :lookup_table
+      attr_reader :lookup_table, :config
 
-      def initialize(lookup_table)
+      def initialize(lookup_table, config={})
         @lookup_table = lookup_table
+        @config = config
 
         logger.info(
           "event"     => "LookupHelperInitialized",
@@ -21,15 +23,17 @@ module Alephant
       end
 
       def read(id, opts, batch_version)
-        LookupQuery.new(lookup_table.table_name, id, opts, batch_version).run!.tap do
-          logger.info(
-            "event"        => "LookupQuery",
-            "tableName"    => lookup_table.table_name,
-            "id"           => id,
-            "opts"         => opts,
-            "batchVersion" => batch_version,
-            "method"       => "#{self.class}#read"
-          )
+        LookupCache.new(config).get(component_cache_key(id, opts, batch_version)) do
+          LookupQuery.new(lookup_table.table_name, id, opts, batch_version).run!.tap do
+            logger.info(
+              "event"        => "LookupQuery",
+              "tableName"    => lookup_table.table_name,
+              "id"           => id,
+              "opts"         => opts,
+              "batchVersion" => batch_version,
+              "method"       => "#{self.class}#read"
+            )
+          end
         end
       end
 
@@ -53,7 +57,19 @@ module Alephant
       end
 
       def truncate!
-        @lookup_table.truncate!
+        lookup_table.truncate!
+      end
+
+      private
+
+      def component_cache_key(id, opts, batch_version)
+        template_key(batch_version).gsub("{{COMPONENT_KEY}}") do |s|
+          LookupLocation.new(id, opts, batch_version).component_key
+        end
+      end
+
+      def template_key(batch_version)
+        "#{lookup_table.table_name}/{{COMPONENT_KEY}}/#{batch_version}"
       end
     end
   end

data/lib/alephant/lookup/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Lookup
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/spec/lookup_spec.rb

@@ -1,11 +1,9 @@
 require "spec_helper"
 
 describe Alephant::Lookup do
-  describe ".create(table_name, component_id)" do
+  describe ".create" do
     it "returns a lookup" do
-      Alephant::Lookup::LookupHelper
-        .any_instance
-        .stub(:initialize)
+      expect_any_instance_of(Alephant::Lookup::LookupHelper).to receive(:initialize)
 
       expect(subject.create(:table_name)).to be_a Alephant::Lookup::LookupHelper
     end
@@ -14,15 +12,15 @@ describe Alephant::Lookup do
   describe Alephant::Lookup::LookupHelper do
     subject { Alephant::Lookup::LookupHelper }
 
-    describe "#initialize(table_name)" do
+    describe "#initialize" do
       it "calls create on lookup_table" do
         table = double()
-        table.should_receive(:table_name)
+        expect(table).to receive(:table_name)
         subject.new(table)
       end
     end
 
-    describe "#read(id, opts, batch_version)" do
+    describe "#read" do
       let(:expected_query) do
         {
           :table_name=>"table_name",
@@ -32,24 +30,28 @@ describe Alephant::Lookup do
           :key_conditions=>{
             "component_key"=> {
               :comparison_operator=>"EQ",
-              :attribute_value_list=>[{"s"=>"id/9dd916afd5516828a91d259967fd394a"}]
+              :attribute_value_list=>[{"s"=>"id/218c835cec343537589dbf1619532e4d"}]
             },
             "batch_version"=>{
               :comparison_operator=>"EQ",
-              :attribute_value_list=>[{"n"=>"{:variant=>\"foo\"}"}]
+              :attribute_value_list=>[{"n"=>"0"}]
             }
           }
         }
       end
 
-      it "queries DynamoDb and returns a location" do
-        AWS::DynamoDB::Client::V20120810
-          .any_instance
-          .stub(:initialize)
+      it "queries DynamoDb and returns a location when not in cache" do
+        expect_any_instance_of(Dalli::ElastiCache).to receive(:initialize)
+        expect_any_instance_of(Dalli::ElastiCache).to receive(:client).and_return(Dalli::Client.new)
 
-        AWS::DynamoDB::Client::V20120810
-          .any_instance
-          .should_receive(:query)
+        expect_any_instance_of(Dalli::Client).to receive(:get)
+        expect_any_instance_of(Dalli::Client).to receive(:set)
+
+        expect_any_instance_of(AWS::DynamoDB::Client::V20120810)
+          .to receive(:initialize)
+
+        expect_any_instance_of(AWS::DynamoDB::Client::V20120810)
+          .to receive(:query)
           .with(expected_query)
           .and_return(
             {
@@ -61,40 +63,61 @@ describe Alephant::Lookup do
           )
 
         table = double().as_null_object
-        table.stub(:table_name).and_return("table_name")
+        expect(table).to receive(:table_name).and_return("table_name").exactly(4).times
+
+        config = { "elasticache_config_endpoint" => "/cache" }
 
-        instance = subject.new(table)
-        lookup = instance.read("id", 0, {:variant => "foo"})
+        instance = subject.new(table, config)
+        lookup = instance.read("id", {:variant => "foo"}, 0)
 
         expect(lookup.location).to eq("/location")
       end
-    end
 
-    describe "#write(opts, location)" do
-      it "does not fail" do
+      it "reads location from the cache when in cache" do
+        lookup_location = Alephant::Lookup::LookupLocation.new("id", {:variant => "foo"}, 0, "/location")
 
-        AWS::DynamoDB::Client::V20120810
-          .any_instance
-          .stub(:initialize)
-          .and_return(
-            double().as_null_object
-          )
+        expect_any_instance_of(Dalli::ElastiCache).to receive(:initialize)
+        expect_any_instance_of(Dalli::ElastiCache).to receive(:client).and_return(Dalli::Client.new)
+
+        expect_any_instance_of(Dalli::Client).to receive(:get)
+          .with("table_name/id/218c835cec343537589dbf1619532e4d/0")
+          .and_return(lookup_location)
+        expect_any_instance_of(Dalli::Client).to_not receive(:set)
+
+        expect_any_instance_of(AWS::DynamoDB::Client::V20120810).to_not receive(:initialize)
 
+        expect_any_instance_of(AWS::DynamoDB::Client::V20120810).to_not receive(:query)
+
+        table = double().as_null_object
+        expect(table).to receive(:table_name).and_return("table_name").twice
+
+        config = { "elasticache_config_endpoint" => "/cache" }
+
+        instance = subject.new(table, config)
+        lookup = instance.read("id", {:variant => "foo"}, 0)
+
+        expect(lookup.location).to eq("/location")
+      end
+    end
+
+    describe "#write" do
+      it "does not fail" do
         lookup_table = double().as_null_object
-        lookup_table
-          .should_receive(:table_name)
+
+        expect(lookup_table)
+          .to receive(:table_name)
           .and_return('test')
-        lookup_table
-          .should_receive(:write)
+
+        expect(lookup_table)
+          .to receive(:write)
           .with(
             "id/7e0c33c476b1089500d5f172102ec03e",
             "0",
             "/location"
           )
 
-        Alephant::Lookup::LookupHelper
-          .any_instance
-          .stub(:lookup_table)
+        expect_any_instance_of(Alephant::Lookup::LookupHelper)
+          .to receive(:lookup_table)
           .and_return(lookup_table)
 
         instance = subject.new(lookup_table)
@@ -105,9 +128,8 @@ describe Alephant::Lookup do
     describe "#truncate!" do
       it "deletes all table rows" do
         table = double()
-        table.stub(:create)
-        table.should_receive(:table_name)
-        table.should_receive(:truncate!)
+        expect(table).to receive(:table_name)
+        expect(table).to receive(:truncate!)
 
         subject = Alephant::Lookup::LookupHelper.new(table)
         subject.truncate!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-lookup
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - '>='
       - !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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -210,6 +224,7 @@ files:
 - Rakefile
 - alephant-lookup.gemspec
 - lib/alephant/lookup.rb
+- lib/alephant/lookup/lookup_cache.rb
 - lib/alephant/lookup/lookup_helper.rb
 - lib/alephant/lookup/lookup_location.rb
 - lib/alephant/lookup/lookup_query.rb