alephant-lookup 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98503e14f9675716baec8c74c0cfe7882a12c628
-  data.tar.gz: 444d864611be03547cdd1539998d5538bde4fa56
+  metadata.gz: ee8710b1105981b02407c5f9cde7eb768add6f7a
+  data.tar.gz: 7b5e984fcc9df4abd22a6381efedff235ddecd4e
 SHA512:
-  metadata.gz: 7eacdceed2927d2b13fb2687346ae6c4eb5e69735a8f32870f17fc0357e92b107fa43d889084de7c3cda302f12eaa9a812ce828eb2cd84d0556acc3c56cc1e65
-  data.tar.gz: fa017c4d8c8a384aa951f97370e667263c65b331cde16b62e596958abf89142ef1b5df5365e01a4e8e981d6de61a8747db82ea39b7e927e8176682a7ba6dd02f
+  metadata.gz: 15bb96737efdd8f21ae30527f200007d542fa9d19771efaf51622498d7bb8319d572b3ce8ed7fd317778dd50839aade495b48ff74a5c5262edba23097e812132
+  data.tar.gz: 0fa7a64f459bae0ee17cc94a7b2ffd354892b548d3b70ae9db6cc0685c4f9528b66165743038c4b8aeceddc3300c25219fa0809e9d8f12f2b6e503abbaffee62

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 ## Usage
 
 ```rb
-require 'alephant-lookup'
+require 'alephant/lookup'
 
 lookup = Alephant::Lookup.create('table_name', 'component_id')
 

data/alephant-lookup.gemspec

@@ -29,5 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
 
   spec.add_runtime_dependency 'aws-sdk', '~> 1.0'
+  spec.add_runtime_dependency 'alephant-logger'
+
   spec.add_runtime_dependency "crimp"
 end

data/lib/alephant/lookup.rb

@@ -1,5 +1,5 @@
 require "alephant/lookup/version"
-require "alephant/lookup/lookup"
+require "alephant/lookup/lookup_helper"
 require "alephant/lookup/lookup_table"
 
 module Alephant
@@ -8,7 +8,7 @@ module Alephant
 
     def self.create(table_name, component_id)
       @@lookup_tables[table_name] ||= LookupTable.new(table_name)
-      Lookup.new(@@lookup_tables[table_name], component_id)
+      LookupHelper.new(@@lookup_tables[table_name], component_id)
     end
   end
 end

data/lib/alephant/lookup/location_read.rb

@@ -0,0 +1,71 @@
+require 'aws-sdk'
+require 'alephant/lookup/lookup_location'
+require 'alephant/lookup/lookup_query'
+require 'alephant/logger'
+
+module Alephant
+  module Lookup
+    class LocationRead
+      include ::Alephant::Logger
+
+      attr_reader :table_name
+
+      def initialize(lookup_table)
+        @client = AWS::DynamoDB::Client::V20120810.new
+        @table_name = lookup_table.table_name
+      end
+
+      def read(lookup)
+        logger.info("LocationRead#read: looking up #{lookup.to_h}")
+        raise TypeError unless lookup.is_a? LookupQuery
+
+        location = LookupLocation.new(
+          lookup.component_id,
+          lookup.opts_hash,
+          s3_location_from(
+            run_query(
+              lookup.component_id,
+              lookup.opts_hash
+            )
+          )
+        )
+        logger.info("LocationRead#read: got location #{location.to_h}")
+
+        location
+      end
+
+      private
+
+      def s3_location_from(result)
+        result[:count] == 1 ? result[:member].first[LookupLocation::S3_LOCATION_FIELD][:s] : nil
+      end
+
+      def run_query(component_id, opts_hash)
+        @client.query(query(component_id, opts_hash))
+      end
+
+      def query(component_id, opts_hash)
+        {
+          :table_name => table_name,
+          :consistent_read => true,
+          :select => 'SPECIFIC_ATTRIBUTES',
+          :attributes_to_get => [LookupLocation::S3_LOCATION_FIELD],
+          :key_conditions => {
+            'component_id' => {
+              :comparison_operator => 'EQ',
+              :attribute_value_list => [
+                { 's' => component_id.to_s }
+              ],
+            },
+            'opts_hash' => {
+              :comparison_operator => 'EQ',
+              :attribute_value_list => [
+                { 's' => opts_hash }
+              ]
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/alephant/lookup/location_write.rb

@@ -0,0 +1,50 @@
+require 'aws-sdk'
+require 'alephant/lookup/lookup_query'
+require 'alephant/logger'
+
+module Alephant
+  module Lookup
+    class LocationWrite
+      include ::Alephant::Logger
+
+      attr_reader :table_name
+      attr_reader :lookups
+
+      def initialize(lookup_table)
+        @table_name = lookup_table.table_name
+        @batch = AWS::DynamoDB::BatchWrite.new
+        @lookups = []
+        @processed = false
+      end
+
+      def <<(lookup)
+        raise TypeError unless lookup.is_a? LookupQuery
+
+        @lookups << lookup
+      end
+
+      def processed?
+        @processed
+      end
+
+      def process!
+        logger.info("LocationWrite#process! #{processed? ? "is" : "not"} running batch put on #{table_name}")
+        processed? ? false : process_batch_put
+      end
+
+      private
+
+      def process_batch_put
+        logger.info("LocationWrite#process_batch_put to #{table_name} for #{@lookups.map { |lookup| lookup.to_h }}")
+
+        @batch.put(
+          table_name,
+          @lookups.map { |lookup| lookup.to_h }
+        )
+        @batch.process!
+
+        processed = true
+      end
+    end
+  end
+end

data/lib/alephant/lookup/lookup_helper.rb

@@ -0,0 +1,46 @@
+require 'alephant/lookup/lookup_table'
+require 'alephant/lookup/lookup_query'
+require 'alephant/lookup/location_read'
+require 'alephant/lookup/location_write'
+
+module Alephant
+  module Lookup
+    class LookupHelper
+      attr_reader :component_id
+
+      def initialize(lookup_table, component_id)
+        @lookup_table = lookup_table
+        @component_id = component_id
+        create_lookup_table
+      end
+
+      def read(opts)
+        reader = LocationRead.new(@lookup_table)
+        reader.read(LookupQuery.new(@component_id, opts)).location
+      end
+
+      def write(opts, location)
+        writer = LocationWrite.new(@lookup_table)
+        writer << LookupQuery.new(@component_id, opts, location)
+        writer.process!
+      end
+
+      def batch_write(opts, location)
+        @batch_write ||= LocationWrite.new(@lookup_table)
+        @batch_write << LookupQuery.new(@component_id, opts, location)
+      end
+
+      def batch_process
+        @batch_write.process!
+        @batch_write = nil
+      end
+
+      private
+
+      def create_lookup_table
+        @lookup_table.create
+      end
+
+    end
+  end
+end

data/lib/alephant/lookup/lookup_location.rb

@@ -0,0 +1,23 @@
+module Alephant
+  module Lookup
+    class LookupLocation
+      S3_LOCATION_FIELD = 'location'
+
+      attr_reader :component_id, :opts, :location
+
+      def initialize(component_id, opts, location)
+        @component_id = component_id
+        @opts = opts
+        @location = location
+      end
+
+      def to_h
+        {
+          :component_id => @component_id,
+          :opts => opts,
+          S3_LOCATION_FIELD => @location
+        }
+      end
+    end
+  end
+end

data/lib/alephant/lookup/lookup_query.rb

@@ -0,0 +1,30 @@
+require 'crimp'
+require 'alephant/lookup/lookup_location'
+
+module Alephant
+  module Lookup
+    class LookupQuery < LookupLocation
+      attr_reader :opts_hash
+      attr_writer :location
+
+      def initialize(component_id, opts, location = nil)
+        super(component_id, opts, location)
+        @opts_hash = hash_for(opts)
+      end
+
+      def to_h
+        {
+          :component_id => @component_id,
+          :opts_hash => @opts_hash,
+          S3_LOCATION_FIELD => @location
+        }
+      end
+
+      private
+
+      def hash_for(opts)
+        Crimp.signature opts
+      end
+    end
+  end
+end

data/lib/alephant/lookup/lookup_table.rb

@@ -1,7 +1,6 @@
 require 'aws-sdk'
 require 'thread'
 require 'timeout'
-require 'crimp'
 
 module Alephant
   module Lookup
@@ -22,12 +21,9 @@ module Alephant
         }
       }
 
-      S3_LOCATION_FIELD = 's3_location'
-
       def initialize(table_name, config = DEFAULT_CONFIG)
         @mutex      = Mutex.new
         @dynamo_db  = AWS::DynamoDB.new
-        @client     = AWS::DynamoDB::Client::V20120810.new
         @table_name = table_name
         @config     = config
       end
@@ -43,48 +39,8 @@ module Alephant
         @table ||= @dynamo_db.tables[@table_name]
       end
 
-
-      def location_for(component_id, opts)
-        result = @client.query({
-          :table_name => @table_name,
-          :consistent_read => true,
-          :select => 'SPECIFIC_ATTRIBUTES',
-          :attributes_to_get => [S3_LOCATION_FIELD],
-          :key_conditions => {
-            'component_id' => {
-              :comparison_operator => 'EQ',
-              :attribute_value_list => [
-                { 's' => component_id.to_s }
-              ],
-            },
-            'opts_hash' => {
-              :comparison_operator => 'EQ',
-              :attribute_value_list => [
-                { 's' => hash_for(opts) }
-              ]
-            }
-          }
-        })
-        result[:count] == 1 ? result[:member].first[S3_LOCATION_FIELD][:s] : nil
-      end
-
-      def write_location_for(component_id, opts, location)
-
-        @table.batch_put([
-          {
-            :component_id => component_id,
-            :opts_hash    => hash_for(opts),
-            :s3_location  => location
-          }
-        ])
-      end
-
       private
 
-      def hash_for(opts)
-        Crimp.signature opts
-      end
-
       def ensure_table_exists
         create_dynamodb_table unless table.exists?
       end

data/lib/alephant/lookup/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Lookup
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/lookup_spec.rb

@@ -3,17 +3,17 @@ require 'spec_helper'
 describe Alephant::Lookup do
   describe '.create(table_name, component_id)' do
     it 'returns a lookup' do
-      Alephant::Lookup::Lookup
+      Alephant::Lookup::LookupHelper
         .any_instance
         .stub(:initialize)
         .and_return(double())
 
-      expect(subject.create(:table_name, :component_id)).to be_a Alephant::Lookup::Lookup
+      expect(subject.create(:table_name, :component_id)).to be_a Alephant::Lookup::LookupHelper
     end
   end
 
-  describe Alephant::Lookup::Lookup do
-    subject { Alephant::Lookup::Lookup }
+  describe Alephant::Lookup::LookupHelper do
+    subject { Alephant::Lookup::LookupHelper }
 
     describe '#initialize(table_name)' do
       it 'calls create on lookup_table' do
@@ -26,8 +26,9 @@ describe Alephant::Lookup do
     describe '#read(opts)' do
       let (:lookup_table) { Alephant::Lookup::LookupTable }
       let (:s3_location)  { '/s3-render-example/test/html/england_council_election_results/responsive' }
+      let (:location_read){ Alephant::Lookup::LocationRead }
 
-      it 'returns lookup_table.location_for(component_id, opts)' do
+      it 'returns correct S3 Location' do
         subject
           .any_instance
           .stub(:create_lookup_table)
@@ -36,10 +37,12 @@ describe Alephant::Lookup do
           .any_instance
           .stub(:initialize)
 
-        lookup_table
+        location = Alephant::Lookup::LookupLocation.new(:component_id,:opts_hash, s3_location)
+
+        location_read
           .any_instance
-          .stub(:location_for)
-          .and_return(s3_location)
+          .stub(:read)
+          .and_return(location)
 
         pal_opts = {
           :id   => :england_council_election_results,
@@ -56,8 +59,9 @@ describe Alephant::Lookup do
 
     describe '#write(opts, location)' do
 
-      let (:lookup_table) { Alephant::Lookup::LookupTable }
-      let (:s3_location)  { '/s3-render-example/test/html/england_council_election_results/responsive' }
+      let (:lookup_table)  { Alephant::Lookup::LookupTable }
+      let (:s3_location)   { '/s3-render-example/test/html/england_council_election_results/responsive' }
+      let (:location_write){ Alephant::Lookup::LocationWrite }
 
       it 'returns lookup_table.update_location_for(component_id, opts_hash, data)' do
 
@@ -69,23 +73,39 @@ describe Alephant::Lookup do
           .any_instance
           .stub(:initialize)
 
+        lookup_table
+          .any_instance
+          .stub(:table_name)
+          .and_return('table_name')
+
         pal_opts = {
           :id   => :england_council_election_results,
           :env  => :test,
           :type => :responsive
         }
 
-        lookup_table
+        AWS::DynamoDB::BatchWrite
           .any_instance
-          .stub(:write_location_for)
-          .with(pal_opts[:id], pal_opts, :s3_location)
-          .and_return(nil)
+          .should_receive(:put)
+          .with(
+            'table_name',
+              [
+                {
+                  :component_id=> :england_council_election_results,
+                  :opts_hash=>"52a25baaaa8c4527ddc869feaa285c3a",
+                  "location"=>:s3_location
+                }
+              ]
+          )
+
+        AWS::DynamoDB::BatchWrite
+          .any_instance
+          .should_receive(:process!)
 
         instance      = subject.new(lookup_table.new, pal_opts[:id])
         write_return  = instance.write(pal_opts, :s3_location)
 
-        expect(write_return).to eq(nil)
-
+        expect(write_return).to eq(true)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-lookup
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Robert Kenny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -150,6 +150,20 @@ dependencies:
         version: '1.0'
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-logger
+  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'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: crimp
   version_requirements: !ruby/object:Gem::Requirement
@@ -181,7 +195,11 @@ files:
 - Rakefile
 - alephant-lookup.gemspec
 - lib/alephant/lookup.rb
-- lib/alephant/lookup/lookup.rb
+- lib/alephant/lookup/location_read.rb
+- lib/alephant/lookup/location_write.rb
+- lib/alephant/lookup/lookup_helper.rb
+- lib/alephant/lookup/lookup_location.rb
+- lib/alephant/lookup/lookup_query.rb
 - lib/alephant/lookup/lookup_table.rb
 - lib/alephant/lookup/version.rb
 - spec/lookup_spec.rb

data/lib/alephant/lookup/lookup.rb

@@ -1,28 +0,0 @@
-module Alephant
-  module Lookup
-    class Lookup
-      attr_reader :component_id
-
-      def initialize(lookup_table, component_id)
-        @lookup_table = lookup_table
-        @component_id = component_id
-        create_lookup_table
-      end
-
-      def read(opts)
-        @lookup_table.location_for(@component_id, opts)
-      end
-
-      def write(opts, location)
-        @lookup_table.write_location_for(@component_id, opts, location)
-      end
-
-      private
-
-      def create_lookup_table
-        @lookup_table.create
-      end
-
-    end
-  end
-end