alephant-lookup 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83ba12e6d7cc4f3e801b4d4510e51b4666720492
-  data.tar.gz: df3542816e3ed93187d19e0cfa85e537c32e950c
+  metadata.gz: 3721f4977e35f2aa609dd85c2c9debfae8fd7dac
+  data.tar.gz: cc50c1eee20d3a282b2c5bde7c46eb5744942b30
 SHA512:
-  metadata.gz: 873992af71a3a0faee4c15604ee99be4511136801238ade80ebe3b6cb7ea7d27689a068a52f0dc2adc33180ccdbb29a7a338b14dde36d8a70b8cf4ab42c6efda
-  data.tar.gz: 5ff60e44826de0ae31d5d3ad1105b0570ddb3c467f00d845586099ed1ed2549b3c8ab3afd04c52132b43d1a58b11e1f413b205174da5bf1db5b9d2ad93667b01
+  metadata.gz: 60bc1d72053a8970d0542e46d322fd9fc2535bc492fa052ad0217a68feda5477f6a7e0d86b868fc69bfa3366d396238091b2ad424cd8474834543ba7dd76c3f6
+  data.tar.gz: de5efa73bebc058ebbb21d8c28f81fbe745c9308fc40840ae10d90e776372a0cdb4352c1ad96ef6bddc348b014f4a52f5b628d393a060ff91dfe6ece65eeaede

data/README.md

@@ -25,22 +25,68 @@ Or install it yourself as:
 ## Usage
 
 ```rb
-require 'alephant/lookup'
+require "alephant/lookup"
+# => true
 
-lookup = Alephant::Lookup.create('table_name', 'component_id')
+AWS.config.region
+# => "us-east-1"
 
-opts = { :key => :value }
+AWS.config(:region => 'eu-west-1')
+# => <AWS::Core::Configuration>
 
-location = "s3-bucket/location"
-lookup.write(opts, location)
+AWS.config.region
+# => "eu-west-1"
 
-lookup.read(opts)
-# => s3-bucket/location
+lookup = Alephant::Lookup.create("mark_lookup_test")
+# => #<Alephant::Lookup::LookupHelper:0x1f881554
+#     @lookup_table=
+#      #<Alephant::Lookup::LookupTable:0x7f8dd355
+#       @config={:write_units=>5, :read_units=>10},
+#       @dynamo_db=<AWS::DynamoDB>,
+#       @mutex=#<Mutex:0x6a3f8a94>,
+#       @range_found=false,
+#       @table=<AWS::DynamoDB::Table table_name:mark_lookup_test>,
+#       @table_name="mark_lookup_test">>
+
+dynamo_db = AWS::DynamoDB.new
+# => <AWS::DynamoDB>
+
+dynamo_db.tables["mark_lookup_test"].exists?
+# => true
+
+table = dynamo_db.tables["mark_lookup_test"]
+# => <AWS::DynamoDB::Table table_name:mark_lookup_test>
+
+table.status
+# => :active
+
+table.items.count
+# => 0
+
+table.items
+# => <AWS::DynamoDB::ItemCollection>
+
+table.items.put({ :component_key => "a/b", :batch_version => 1, :location => "a/c/b/1" })
+# => <AWS::DynamoDB::Item table_name:mark_lookup_test hash_value:a/b range_value:0.1E1>
+
+table.items.put({ :component_key => "d/e", :batch_version => 1, :location => "d/f/e/1" })
+# => <AWS::DynamoDB::Item table_name:mark_lookup_test hash_value:d/e range_value:0.1E1>
+
+lookup.truncate!
+# => nil
+
+component_id  = "foo"
+opts          = { :key => :value }
+batch_version = 1
+location      = "s3-bucket/location"
+
+lookup.write(id, opts, batch_version, location)
+lookup.read(id, opts, batch_version)
 ```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/alephant-lookup/fork )
+1. Fork it ( http://github.com/BBC-News/alephant-lookup/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/alephant-lookup.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'aws-sdk', '~> 1.0'
   spec.add_runtime_dependency 'alephant-logger'
+  spec.add_runtime_dependency 'alephant-support'
 
   spec.add_runtime_dependency "crimp"
 end

data/lib/alephant/lookup/lookup_helper.rb

@@ -1,5 +1,5 @@
-require 'alephant/lookup/lookup_table'
-require 'alephant/lookup/lookup_query'
+require "alephant/lookup/lookup_table"
+require "alephant/lookup/lookup_query"
 
 module Alephant
   module Lookup
@@ -26,6 +26,10 @@ module Alephant
           ])
         end
       end
+
+      def truncate!
+        @lookup_table.truncate!
+      end
     end
   end
 end

data/lib/alephant/lookup/lookup_location.rb

@@ -1,4 +1,4 @@
-require 'crimp'
+require "crimp"
 
 module Alephant
   module Lookup

data/lib/alephant/lookup/lookup_query.rb

@@ -1,5 +1,5 @@
-require 'crimp'
-require 'alephant/lookup/lookup_location'
+require "crimp"
+require "alephant/lookup/lookup_location"
 
 module Alephant
   module Lookup
@@ -23,26 +23,26 @@ module Alephant
       private
 
       def s3_location_from(result)
-        result[:count] == 1 ? result[:member].first['location'][:s] : nil
+        result[:count] == 1 ? result[:member].first["location"][:s] : nil
       end
 
       def to_q
         {
           :table_name => table_name,
           :consistent_read => true,
-          :select => 'SPECIFIC_ATTRIBUTES',
-          :attributes_to_get => ['location'],
+          :select => "SPECIFIC_ATTRIBUTES",
+          :attributes_to_get => ["location"],
           :key_conditions => {
-            'component_key' => {
-              :comparison_operator => 'EQ',
+            "component_key" => {
+              :comparison_operator => "EQ",
               :attribute_value_list => [
-                { 's' => @lookup_location.component_key }
+                { "s" => @lookup_location.component_key }
               ],
             },
-            'batch_version' => {
-              :comparison_operator => 'EQ',
+            "batch_version" => {
+              :comparison_operator => "EQ",
               :attribute_value_list => [
-                { 'n' => @lookup_location.batch_version.to_s }
+                { "n" => @lookup_location.batch_version.to_s }
               ]
             }
           }

data/lib/alephant/lookup/lookup_table.rb

@@ -1,17 +1,14 @@
-require 'aws-sdk'
-require 'thread'
-require 'timeout'
+require "aws-sdk"
+require "thread"
+require "timeout"
+
+require "alephant/support/dynamodb/table"
 
 module Alephant
   module Lookup
-    class LookupTable
+    class LookupTable < ::Alephant::Support::DynamoDB::Table
       attr_reader :table_name
 
-      TIMEOUT = 120
-      DEFAULT_CONFIG = {
-        :write_units => 5,
-        :read_units  => 10
-      }
       SCHEMA = {
         :hash_key => {
           :component_key => :string

data/lib/alephant/lookup/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Lookup
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
   end
 end

data/spec/lookup_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Lookup do
-  describe '.create(table_name, component_id)' do
-    it 'returns a lookup' do
+  describe ".create(table_name, component_id)" do
+    it "returns a lookup" do
       Alephant::Lookup::LookupHelper
         .any_instance
         .stub(:initialize)
@@ -14,15 +14,15 @@ describe Alephant::Lookup do
   describe Alephant::Lookup::LookupHelper do
     subject { Alephant::Lookup::LookupHelper }
 
-    describe '#initialize(table_name)' do
-      it 'calls create on lookup_table' do
+    describe "#initialize(table_name)" do
+      it "calls create on lookup_table" do
         table = double()
         table.should_receive(:create)
         subject.new(table)
       end
     end
 
-    describe '#read(id, opts, batch_version)' do
+    describe "#read(id, opts, batch_version)" do
       let(:expected_query) do
         {
           :table_name=>"table_name",
@@ -42,7 +42,7 @@ describe Alephant::Lookup do
         }
       end
 
-      it 'queries DynamoDb and returns a location' do
+      it "queries DynamoDb and returns a location" do
         AWS::DynamoDB::Client::V20120810
           .any_instance
           .stub(:initialize)
@@ -55,23 +55,23 @@ describe Alephant::Lookup do
             {
               :count => 1,
               :member => [
-                { 'location' => { :s => '/location' } }
+                { "location" => { :s => "/location" } }
               ]
             }
           )
 
         table = double().as_null_object
-        table.stub(:table_name).and_return('table_name')
+        table.stub(:table_name).and_return("table_name")
 
         instance = subject.new(table)
-        lookup = instance.read('id', 0, {:variant => "foo"})
+        lookup = instance.read("id", 0, {:variant => "foo"})
 
-        expect(lookup.location).to eq('/location')
+        expect(lookup.location).to eq("/location")
       end
     end
 
-    describe '#write(opts, location)' do
-      it 'does not fail' do
+    describe "#write(opts, location)" do
+      it "does not fail" do
         AWS::DynamoDB
           .any_instance
           .stub(:initialize)
@@ -99,7 +99,18 @@ describe Alephant::Lookup do
           .and_return(lookup_table)
 
         instance = subject.new(lookup_table)
-        instance.write('id',{},'0','/location')
+        instance.write("id",{},"0","/location")
+      end
+    end
+
+    describe "#truncate!" do
+      it "deletes all table rows" do
+        table = double()
+        table.stub(:create)
+        table.should_receive(:truncate!)
+
+        subject = Alephant::Lookup::LookupHelper.new(table)
+        subject.truncate!
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-lookup
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Robert Kenny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -164,6 +164,20 @@ dependencies:
         version: '0'
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-support
+  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
@@ -229,3 +243,4 @@ summary: Lookup a location in S3 using DynamoDB.
 test_files:
 - spec/lookup_spec.rb
 - spec/spec_helper.rb
+has_rdoc: