alephant-sequencer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39cf57ec693d0b9940bc8697bed009cfdac7f681
+  data.tar.gz: a7ac6da5464b431b80d822310c86b681575ec85d
+SHA512:
+  metadata.gz: 1c6720473cd4f33b5b4f72ef21ffcb8ae34c73cf9d520c5bf686be6e37e9d38d50a42992dde1289bf9975de2114ae422bec27348415d856b7a76ecb133f671ce
+  data.tar.gz: e5b0ad2c052721f9ab3386840adf53f426f5ef56be0f7dfce1c79206fb22df721950807b6df9ea79ae1ae17da79ad11b9ac37043a9ee256aebbeac68e4e01c0a

data/.gitignore

@@ -0,0 +1,10 @@
+/config/*.yaml
+/config/*.yml
+Gemfile.lock
+.rspec
+*.gem
+
+/pkg
+/tmp
+/components
+

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "jruby"
+notifications:
+  email:
+    recipients:
+      - kenoir@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alephant-sequencer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Kenny
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Alephant::Sequencer
+
+Using DynamoDB consistent read to enforce message order from SQS.
+
+[![Build
+Status](https://travis-ci.org/BBC-News/alephant-sequencer.png)](https://travis-ci.org/BBC-News/alephant-sequencer)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'alephant-sequencer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alephant-sequencer
+
+## Usage
+
+```rb
+
+require 'alephant-sequencer'
+
+#Optional JSONPath specifying location of sequence_id
+sequence_id = '$.sequence_number'
+
+sequencer = Sequencer.create(table_name, sqs_queue_url, sequence_id)
+
+# Data from SQS message
+data = Struct.new(:body).new({:sequence_number => 3})
+
+# Sets last seen id
+sequencer.set_last_seen(data)
+
+# Gets last seen id
+sequencer.get_last_seen
+# => 3
+
+# Is the message sequential?
+sequencer.sequential?(data)
+
+# Reset sequence
+sequencer.delete!
+
+## Contributing
+1. Fork it ( http://github.com/<my-github-username>/alephant-sequencer/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'alephant/sequencer'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alephant-sequencer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alephant/sequencer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alephant-sequencer"
+  spec.version       = Alephant::Sequencer::VERSION
+  spec.authors       = ["Robert Kenny"]
+  spec.email         = ["kenoir@gmail.com"]
+  spec.summary       = %q{Adds sequencing functionality to Alephant.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+
+  spec.add_runtime_dependency 'aws-sdk', '~> 1.0'
+end

data/lib/alephant/sequencer.rb

@@ -0,0 +1,15 @@
+require "alephant/sequencer/version"
+require "alephant/sequencer/sequencer"
+require "alephant/sequencer/sequence_table"
+
+module Alephant
+  module Sequencer
+    @@sequence_tables = {}
+
+    def self.create(table_name, ident, jsonpath = nil)
+      @@sequence_tables[table_name] ||= SequenceTable.new(table_name)
+      Sequencer.new(@@sequence_tables[table_name], ident, jsonpath)
+    end
+
+  end
+end

data/lib/alephant/sequencer/sequence_table.rb

@@ -0,0 +1,99 @@
+require 'aws-sdk'
+require 'thread'
+require 'timeout'
+
+module Alephant
+  module Sequencer
+    class SequenceTable
+      attr_reader :table_name
+
+      TIMEOUT = 120
+      DEFAULT_CONFIG = {
+        :write_units => 5,
+        :read_units => 10,
+      }
+      SCHEMA = {
+        :hash_key => {
+          :key => :string,
+          :value => :string
+        }
+      }
+
+      def initialize(table_name, config = DEFAULT_CONFIG)
+        @mutex = Mutex.new
+        @dynamo_db = AWS::DynamoDB.new
+        @table_name = table_name
+        @config = config
+      end
+
+      def create
+        @mutex.synchronize do
+          ensure_table_exists
+          ensure_table_active
+        end
+      end
+
+      def table
+        @table ||= @dynamo_db.tables[@table_name]
+      end
+
+      def sequence_for(ident)
+        rows = batch_get_value_for(ident)
+        rows.count >= 1 ? rows.first['value'].to_i : 0
+      end
+
+      def set_sequence_for(ident,value)
+        @mutex.synchronize do
+          AWS::DynamoDB::BatchWrite.new.tap { |batch|
+            batch.put(
+              table_name,
+              [:key => ident,:value => value]
+            )
+          }.process!
+        end
+      end
+
+      def delete_item!(ident)
+        table.items[ident].delete
+      end
+
+      private
+      def batch_get_value_for(ident)
+        table.batch_get(['value'],[ident],batch_get_opts)
+      end
+
+      def batch_get_opts
+        { :consistent_read => true }
+      end
+
+      def ensure_table_exists
+        create_dynamodb_table unless table.exists?
+      end
+
+      def ensure_table_active
+        sleep_until_table_active unless table_active?
+      end
+
+      def create_dynamodb_table
+        @table = @dynamo_db.tables.create(
+          @table_name,
+          @config[:read_units],
+          @config[:write_units],
+          SCHEMA
+        )
+      end
+
+      def table_active?
+        table.status == :active
+      end
+
+      def sleep_until_table_active
+        begin
+          Timeout::timeout(TIMEOUT) do
+            sleep 1 until table_active?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alephant/sequencer/sequencer.rb

@@ -0,0 +1,52 @@
+require 'jsonpath'
+
+module Alephant
+  module Sequencer
+    class Sequencer
+      attr_reader :ident, :jsonpath
+
+      def initialize(sequence_table, id, sequence_path = nil)
+        @mutex = Mutex.new
+        @sequence_table = sequence_table
+        @jsonpath = sequence_path
+        @ident = id
+
+        @sequence_table.create
+      end
+
+      def sequential?(data)
+        get_last_seen < sequence_id_from(data)
+      end
+
+      def delete!
+        @sequence_table.delete_item!(ident)
+      end
+
+      def set_last_seen(data)
+        last_seen_id = sequence_id_from(data)
+
+        @sequence_table.set_sequence_for(ident, last_seen_id)
+      end
+
+      def get_last_seen
+        @sequence_table.sequence_for(ident)
+      end
+
+      private
+      def sequence_id_from(data)
+        jsonpath.nil? ?
+          default_sequence_id_for(data) :
+          sequence_from_jsonpath_for(data)
+      end
+
+      def sequence_from_jsonpath_for(data)
+        JsonPath.on(data.body, jsonpath).first
+      end
+
+      def default_sequence_id_for(data)
+        data.body['sequence_id'].to_i
+      end
+
+    end
+  end
+end

data/lib/alephant/sequencer/version.rb

@@ -0,0 +1,5 @@
+module Alephant
+  module Sequencer
+    VERSION = "0.0.1"
+  end
+end

data/spec/sequencer_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Alephant::Sequencer do
+  let(:ident) { :ident }
+  let(:jsonpath) { :jsonpath }
+
+  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
+    end
+  end
+
+  describe Alephant::Sequencer::Sequencer do
+    let(:data)     { double() }
+    let(:last_seen) { 42 }
+    let(:sequence_table) { double().tap { |o| o.stub(:create) } }
+    subject { Alephant::Sequencer::Sequencer.new(sequence_table, ident, jsonpath) }
+
+    describe "#initialize(opts, id)" do
+      it "sets @jsonpath, @ident" do
+        expect(subject.jsonpath).to eq(jsonpath)
+        expect(subject.ident).to eq(ident)
+      end
+
+      it "calls create on sequence_table" do
+        table = double()
+        table.should_receive(:create)
+
+        Alephant::Sequencer::Sequencer.new(table, ident, jsonpath)
+      end
+    end
+
+    describe "#get_last_seen" do
+      it "returns sequence_table.sequence_for(ident)" do
+        table = double()
+        table.stub(:create)
+        table.should_receive(:sequence_for).with(ident).and_return(:expected_value)
+
+        expect(
+          Alephant::Sequencer::Sequencer.new(table, ident).get_last_seen
+        ).to eq(:expected_value)
+      end
+    end
+
+    describe "#set_last_seen(data)" do
+      before(:each) do
+        Alephant::Sequencer::Sequencer.any_instance.stub(:sequence_id_from).and_return(last_seen)
+      end
+
+      it "calls set_sequence_for(ident, last_seen)" do
+        table = double()
+        table.stub(:create)
+        table.should_receive(:set_sequence_for).with(ident, last_seen)
+
+        Alephant::Sequencer::Sequencer.new(table, ident).set_last_seen(data)
+      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)
+      end
+
+      context "jsonpath = '$.sequence_id'" do
+        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
+        end
+
+        context "nonsequential" do
+          let(:id_value) { 0 }
+          it "is false" do
+            expect(subject.sequential?(data)).to be_false
+          end
+        end
+      end
+
+      context "jsonpath = nil" do
+        let(:jsonpath) { nil }
+        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
+        end
+
+        context "nonsequential" do
+          let(:id_value) { 0 }
+          it "is false" do
+            expect(subject.sequential?(data)).to be_false
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: alephant-sequencer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Kenny
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: :development
+- !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'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  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: :development
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: :development
+- !ruby/object:Gem::Dependency
+  name: guard-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'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: :development
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  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: :development
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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: :development
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  prerelease: false
+  type: :runtime
+description:
+email:
+- kenoir@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alephant-sequencer.gemspec
+- lib/alephant/sequencer.rb
+- lib/alephant/sequencer/sequence_table.rb
+- lib/alephant/sequencer/sequencer.rb
+- lib/alephant/sequencer/version.rb
+- spec/sequencer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Adds sequencing functionality to Alephant.
+test_files:
+- spec/sequencer_spec.rb
+- spec/spec_helper.rb