alephant-sequencer 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cfb808e20d9d7e1ff9bf36eca6c61d3fb042152
-  data.tar.gz: 4936135a727783f3925d23ec2c018e04b6baf2f5
+  metadata.gz: 0390458d47e5ab213103d386505b95893d3b22ff
+  data.tar.gz: 6233dd2447347b73b0cb62349aa28fa3c6f74a3d
 SHA512:
-  metadata.gz: 83c66149df5dab3d97d6a619bbbc3b42adeb8887e1a3adc7cf39669f3a147c35fafacbf16062f91b737b9ef3123791fa7b9ee32148bd916917a329b8e3bbb7a5
-  data.tar.gz: d11b43af46a3329ac430b3e7669d054787b009370fa4957667fed40e06592e7e131e2599cd64eae7c273c91ed83de989b6f1cf475700209a0ff5823c640699c0
+  metadata.gz: b587d839b93e7eca666ca6e947e8d5c941331b582d0629bf92fe541dab39c899dd9494d65c3c57e214e0c43dc6a374609039dd4fc7ff782da8ef17444ad5e5ed
+  data.tar.gz: 6b54e05af1e9997358adbe0abf83010f9701da8781310578bbb8df75a113dd3d962186e810e8380d05c4fdabbffdb323623b1e1ec0f76e8fae6a428d8e12c2cd

data/README.md

@@ -24,29 +24,34 @@ Or install it yourself as:
 ## Usage
 
 ```rb
+require "alephant/sequencer"
 
-require 'alephant-sequencer'
+# Ensure you check your AWS region configuration before you start using `AWS.config.region`
+# To set the value use: AWS.config(region: 'eu-west-1')
 
-#Optional JSONPath specifying location of sequence_id
-sequence_id = '$.sequence_number'
+table_name   = "foo"
+component_id = "bar_baz/e8c81cbbbeb3967a423bb49e352eed0e"
+sequence_id  = "$.sequence_number" # Optional JSONPath (specifying location of sequence_id)
 
-sequencer = Sequencer.create(table_name, sqs_queue_url, sequence_id)
+sequencer = Alephant::Sequencer.create(table_name, component_id, sequence_id)
 
 # Data from SQS message
-data = Struct.new(:body).new({:sequence_number => 3})
+json = JSON.generate({ :sequence_number => 3 })
+msg  = Struct.new(:body).new(json)
 
 # Sets last seen id
-sequencer.set_last_seen(data)
+sequencer.set_last_seen(msg)
 
 # Gets last seen id
 sequencer.get_last_seen
 # => 3
 
 # Is the message sequential?
-sequencer.sequential?(data)
+sequencer.sequential?(msg)
 
 # Reset sequence
 sequencer.delete!
+```
 
 ## Contributing
 1. Fork it ( http://github.com/<my-github-username>/alephant-sequencer/fork )

data/alephant-sequencer.gemspec

@@ -29,5 +29,6 @@ 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 'jsonpath'
 end

data/lib/alephant/sequencer/sequence_table.rb

@@ -1,21 +1,17 @@
-require 'aws-sdk'
-require 'thread'
-require 'timeout'
+require "aws-sdk"
+require "thread"
+require "timeout"
 
-require 'alephant/logger'
+require "alephant/logger"
+require "alephant/support/dynamodb/table"
 
 module Alephant
   module Sequencer
-    class SequenceTable
+    class SequenceTable < ::Alephant::Support::DynamoDB::Table
       include ::Alephant::Logger
 
       attr_reader :table_name
 
-      TIMEOUT = 120
-      DEFAULT_CONFIG = {
-        :write_units => 5,
-        :read_units => 10,
-      }
       SCHEMA = {
         :hash_key => {
           :key => :string,
@@ -47,7 +43,7 @@ module Alephant
 
       def sequence_for(ident)
         rows = batch_get_value_for(ident)
-        rows.count >= 1 ? rows.first['value'].to_i : nil
+        rows.count >= 1 ? rows.first["value"].to_i : nil
       end
 
       def set_sequence_for(ident, value, last_seen_check = nil)
@@ -78,12 +74,13 @@ module Alephant
       end
 
       private
+
       def put_condition(last_seen_check)
         last_seen_check.nil? ? unless_exists(:key) : if_value(last_seen_check)
       end
 
       def batch_get_value_for(ident)
-        table.batch_get(['value'],[ident],batch_get_opts)
+        table.batch_get(["value"],[ident],batch_get_opts)
       end
 
       def unless_exists(key)

data/lib/alephant/sequencer/sequencer.rb

@@ -42,6 +42,10 @@ module Alephant
         @sequence_table.delete_item!(ident)
       end
 
+      def truncate!
+        @sequence_table.truncate!
+      end
+
       def set_last_seen(msg, last_seen_check = nil)
         seen_id = Sequencer.sequence_id_from(msg, jsonpath)
 

data/lib/alephant/sequencer/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Sequencer
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/spec/sequencer_spec.rb

@@ -1,18 +1,23 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Sequencer do
-  let(:ident) { :ident }
+  let(:ident)    { :ident }
   let(:jsonpath) { "$.sequence_id" }
 
   describe ".create(table_name, ident, jsonpath)" do
     it "should return a Sequencer" do
-      Alephant::Sequencer::SequenceTable.any_instance.stub(:create)
-      expect(subject.create(:table_name, ident, jsonpath)).to be_a Alephant::Sequencer::Sequencer
+      Alephant::Sequencer::SequenceTable
+        .any_instance
+        .stub(:create)
+
+      expect(
+        subject.create(:table_name, ident, jsonpath)
+      ).to be_a Alephant::Sequencer::Sequencer
     end
   end
 
   describe Alephant::Sequencer::Sequencer do
-    let(:data)     { double() }
+    let(:data)      { double() }
     let(:last_seen) { 42 }
 
     def sequence_table
@@ -21,7 +26,7 @@ describe Alephant::Sequencer do
       table.stub(:sequence_exists)
       table.stub(:sequence_for)
       table.stub(:set_sequence_for)
-
+      table.stub(:truncate!)
       table
     end
 
@@ -42,12 +47,10 @@ describe Alephant::Sequencer do
       end
     end
 
-
     describe "#sequence(msg, &block)" do
       let(:message) do
         m = double()
         m.stub(:body)
-
         m
       end
 
@@ -71,15 +74,19 @@ describe Alephant::Sequencer do
 
       context "last_seen_id is nil" do
         before(:each) do
-          Alephant::Sequencer::Sequencer.any_instance
-            .stub(:get_last_seen).and_return(nil)
+          Alephant::Sequencer::Sequencer
+            .any_instance
+            .stub(:get_last_seen)
+            .and_return(nil)
 
           Alephant::Sequencer::Sequencer
-            .stub(:sequence_id_from).and_return(stubbed_seen_high)
+            .stub(:sequence_id_from)
+            .and_return(stubbed_seen_high)
         end
 
         it "should not call set_last_seen(msg, last_seen_id)" do
-          Alephant::Sequencer::Sequencer.any_instance
+          Alephant::Sequencer::Sequencer
+            .any_instance
             .should_receive(:set_last_seen)
             .with(message, nil)
 
@@ -90,15 +97,19 @@ describe Alephant::Sequencer do
 
       context "last_seen_id == sequence_id_from(msg)" do
         before(:each) do
-          Alephant::Sequencer::Sequencer.any_instance
-            .stub(:get_last_seen).and_return(stubbed_last_seen)
+          Alephant::Sequencer::Sequencer
+            .any_instance
+            .stub(:get_last_seen)
+            .and_return(stubbed_last_seen)
 
           Alephant::Sequencer::Sequencer
-            .stub(:sequence_id_from).and_return(stubbed_last_seen)
+            .stub(:sequence_id_from)
+            .and_return(stubbed_last_seen)
         end
 
         it "should not call set_last_seen(msg, last_seen_id)" do
-          Alephant::Sequencer::Sequencer.any_instance
+          Alephant::Sequencer::Sequencer
+            .any_instance
             .should_not_receive(:set_last_seen)
 
           subject = Alephant::Sequencer::Sequencer.new(sequence_table, ident, jsonpath)
@@ -108,15 +119,20 @@ describe Alephant::Sequencer do
 
       context "last_seen_id > sequence_id_from(msg)" do
         before(:each) do
-          Alephant::Sequencer::Sequencer.any_instance
-            .stub(:get_last_seen).and_return(stubbed_last_seen)
+          Alephant::Sequencer::Sequencer
+            .any_instance
+            .stub(:get_last_seen)
+            .and_return(stubbed_last_seen)
 
-          Alephant::Sequencer::Sequencer.any_instance
-            .stub(:sequence_id_from).and_return(stubbed_seen_low)
+          Alephant::Sequencer::Sequencer
+            .any_instance
+            .stub(:sequence_id_from)
+            .and_return(stubbed_seen_low)
         end
 
         it "should not call set_last_seen(msg, last_seen_id)" do
-          Alephant::Sequencer::Sequencer.any_instance
+          Alephant::Sequencer::Sequencer
+            .any_instance
             .should_not_receive(:set_last_seen)
 
           subject = Alephant::Sequencer::Sequencer.new(sequence_table, ident, jsonpath)
@@ -126,15 +142,19 @@ describe Alephant::Sequencer do
 
       context "last_seen_id < sequence_id_from(msg)" do
         before(:each) do
-          Alephant::Sequencer::Sequencer.any_instance
-            .stub(:get_last_seen).and_return(stubbed_last_seen)
+          Alephant::Sequencer::Sequencer
+            .any_instance
+            .stub(:get_last_seen)
+            .and_return(stubbed_last_seen)
 
           Alephant::Sequencer::Sequencer
-            .stub(:sequence_id_from).and_return(stubbed_seen_high)
+            .stub(:sequence_id_from)
+            .and_return(stubbed_seen_high)
         end
 
         it "should call set_last_seen(msg, last_seen_id)" do
-          Alephant::Sequencer::Sequencer.any_instance
+          Alephant::Sequencer::Sequencer
+            .any_instance
             .should_receive(:set_last_seen)
             .with(message, stubbed_last_seen)
 
@@ -149,17 +169,23 @@ describe Alephant::Sequencer do
         table = double()
         table.stub(:sequence_exists)
         table.stub(:create)
-        table.should_receive(:sequence_for).with(ident).and_return(:expected_value)
+        table.should_receive(:sequence_for)
+          .with(ident)
+          .and_return(:expected_value)
 
         expect(
-          Alephant::Sequencer::Sequencer.new(table, ident, jsonpath).get_last_seen
+          Alephant::Sequencer::Sequencer
+            .new(table, ident, jsonpath)
+            .get_last_seen
         ).to eq(:expected_value)
       end
     end
 
     describe "#set_last_seen(data)" do
       before(:each) do
-        Alephant::Sequencer::Sequencer.stub(:sequence_id_from).and_return(last_seen)
+        Alephant::Sequencer::Sequencer
+          .stub(:sequence_id_from)
+          .and_return(last_seen)
       end
 
       it "calls set_sequence_for(ident, last_seen)" do
@@ -167,32 +193,46 @@ describe Alephant::Sequencer do
         table.stub(:sequence_exists)
         table.stub(:create)
         table.stub(:sequence_for)
-        table.should_receive(:set_sequence_for).with(ident, last_seen, nil)
+        table.should_receive(:set_sequence_for)
+          .with(ident, last_seen, nil)
 
-        Alephant::Sequencer::Sequencer.new(table, ident, jsonpath).set_last_seen(data)
+        Alephant::Sequencer::Sequencer
+          .new(table, ident, jsonpath)
+          .set_last_seen(data)
       end
     end
 
     describe ".sequence_id_from(data)" do
       subject { Alephant::Sequencer::Sequencer }
+
       it "should return the id described by the set jsonpath" do
-        msg = Struct.new(:body).new({ "set_sequence_id" => 1 })
-        expect(subject.sequence_id_from(msg,'$.set_sequence_id')).to eq(1)
+        msg = Struct.new(:body).new("set_sequence_id" => 1)
+
+        expect(
+          subject.sequence_id_from(msg, "$.set_sequence_id")
+        ).to eq(1)
       end
     end
 
     describe "#sequential?(data, jsonpath)" do
-
       before(:each) do
-        Alephant::Sequencer::Sequencer.any_instance.stub(:get_last_seen).and_return(1)
-        data.stub(:body).and_return('sequence_id' => id_value)
+        Alephant::Sequencer::Sequencer
+          .any_instance
+          .stub(:get_last_seen)
+          .and_return(1)
+
+        data.stub(:body)
+          .and_return("sequence_id" => id_value)
       end
 
       context "jsonpath = '$.sequence_id'" do
-        let(:jsonpath) { '$.sequence_id' }
+        let(:jsonpath) { "$.sequence_id" }
+
         subject { Alephant::Sequencer::Sequencer.new(sequence_table, :ident, jsonpath) }
+
         context "sequential" do
           let(:id_value) { 2 }
+
           it "is true" do
             expect(subject.sequential?(data)).to be_true
           end
@@ -200,6 +240,7 @@ describe Alephant::Sequencer do
 
         context "nonsequential" do
           let(:id_value) { 0 }
+
           it "is false" do
             expect(subject.sequential?(data)).to be_false
           end
@@ -207,11 +248,13 @@ describe Alephant::Sequencer do
       end
 
       context "jsonpath = nil" do
-        let(:jsonpath) { '$.sequence_id' }
+        let(:jsonpath) { "$.sequence_id" }
+
         subject { Alephant::Sequencer::Sequencer.new(sequence_table, :ident, jsonpath) }
 
         context "sequential" do
           let(:id_value) { 2 }
+
           it "is true" do
             expect(subject.sequential?(data)).to be_true
           end
@@ -219,12 +262,24 @@ describe Alephant::Sequencer do
 
         context "nonsequential" do
           let(:id_value) { 0 }
+
           it "is false" do
             expect(subject.sequential?(data)).to be_false
           end
         end
       end
+    end
+
+    describe "#truncate!" do
+      it "verify SequenceTable#truncate!" do
+        table = double()
+        table.stub(:create)
+        table.stub(:sequence_exists)
+        table.should_receive(:truncate!)
 
+        subject = Alephant::Sequencer::Sequencer.new(table, ident, jsonpath)
+        subject.truncate!
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $: << File.join(File.dirname(__FILE__),"..", "lib")
 
-require 'pry'
-require 'alephant/sequencer'
+require "pry"
+require "alephant/sequencer"
+require "alephant/support"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-sequencer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Robert Kenny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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: jsonpath
   version_requirements: !ruby/object:Gem::Requirement