tavern-history 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Darcy Laycock
+
+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,38 @@
+# tavern-history
+
+Tavern history adds basic history to the events published with tavern,
+letting you retrieve a historical record of things that have happened.
+
+How does it work you ask? easy! Tavern history uses a backend to store
+entities (out of the box, it's built to work with Redis at the moment)
+as well as a generaled channel to events mapping.
+
+The redis backend is the primary backend at the moment and makes uses of redis
+hashes (for the actual event storage) and sorted sets for the actual
+historical channel tracking.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tavern-history'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tavern-history
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new :spec

data/lib/tavern-history.rb

@@ -0,0 +1 @@
+require 'tavern/history'

data/lib/tavern/history.rb

@@ -0,0 +1,9 @@
+require "tavern"
+require "tavern/history/version"
+
+module Tavern
+  module History
+    require 'tavern/history/base'
+    require 'tavern/history/redis'
+  end
+end

data/lib/tavern/history/base.rb

@@ -0,0 +1,65 @@
+module Tavern
+  module History
+    class Base
+
+      attr_reader :hub
+
+      def initialize(hub)
+        @hub = hub
+        hub.subscribe('') { |event| persist event }
+      end
+
+      def history(channel, limit = 10)
+        identifiers = identifiers_for channel, limit
+        fetch identifiers
+      end
+
+      def persist(event)
+        identifier = record event
+        each_subchannel event do |channel|
+          add_record channel, identifier
+        end
+        true
+      end
+
+      def subscribe(*args, &blk);   hub.subscribe(*args, &blk);   end
+      def unsubscribe(*args, &blk); hub.unsubscribe(*args, &blk); end
+      def publish(*args, &blk);     hub.publish(*args, &blk);     end
+
+      # TODO: We need to delegate all normal hub methods to the hub.
+      # On creation, we need to subscribe to the lowest level hub,
+      # and then have something to record it.
+
+      private
+
+      # Given a single event, records them and returns the identifiers that match them.
+      def record(entry)
+        raise NotImplementedError
+      end
+
+      def fetch(identifiers)
+        raise NotImplementedError
+      end
+
+      # Given a record identifier and a channel name, will
+      # add the specified record to the given channel.
+      def add_record(channel_name, identifier)
+        raise NotImplementedError
+      end
+
+      # Gets the specified number of identifers from the given channel.
+      def identifiers_for(channel, limit)
+        raise NotImplementedError
+      end
+
+      def each_subchannel(event)
+        parts = event[:path_parts].dup
+        while parts.any?
+          yield parts.join ':'
+          parts.pop
+        end
+      end
+
+    end
+  end
+end

data/lib/tavern/history/redis.rb

@@ -0,0 +1,56 @@
+require 'redis'
+require 'multi_json'
+
+module Tavern
+  module History
+    class Redis < Base
+
+      attr_reader :redis
+
+      def initialize(hub, keyspace, redis = ::Redis.current)
+        super hub
+        @redis       = redis
+        @base_key    = "#{keyspace}:history"
+        @counter     = "#{@base_key}:counter"
+        @records     = "#{@base_key}:records"
+        @stream_base = "#{@base_key}:entries"
+      end
+
+      private
+
+      def generate_id
+        @redis.incr @counter
+      end
+
+      # Given a single event, records them and returns the identifiers that match them.
+      def record(entry)
+        dumped     = MultiJson.encode(entry)
+        identifier = generate_id
+        @redis.hset @records, identifier, dumped
+        identifier
+      end
+
+      def fetch(identifiers)
+        records = identifiers.any? ? @redis.hmget(@records, identifiers) : []
+        records.map do |record|
+          MultiJson.decode record
+        end.compact
+      end
+
+      # Given a record identifier and a channel name, will
+      # add the specified record to the given channel.
+      def add_record(channel_name, identifier)
+        stream = "#{@stream_base}:#{channel_name}"
+        current_score = (Time.now.to_f * 1000000).round
+        @redis.zadd stream, current_score, identifier
+      end
+
+      # Gets the specified number of identifers from the given channel.
+      def identifiers_for(channel_name, limit)
+        stream = "#{@stream_base}:#{channel_name}"
+        @redis.zrevrange stream, 0, limit - 1
+      end
+
+    end
+  end
+end

data/lib/tavern/history/version.rb

@@ -0,0 +1,5 @@
+module Tavern
+  module History
+    VERSION = "0.0.1"
+  end
+end

data/spec/history/redis_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Tavern::History::Redis do
+
+  let(:redis) { Redis.new(database: 4) }
+
+  let(:base_hub) { Tavern::Hub.new }
+  let(:hub)      { Tavern::History::Redis.new base_hub, 'redis-tests', redis }
+  after(:each)   { redis.flushdb }
+
+  it_should_behave_like 'a hub with history'
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'tavern-history'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+
+RSpec.configure do |c|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,62 @@
+shared_examples_for 'a hub with history' do
+
+  it 'should maintain a list of events' do
+    hub.history('test-event').should == []
+    (1..3).each { |i| hub.publish 'test-event', index: i }
+    history = hub.history('test-event')
+    history.should be_a Array
+    history.should have(3).entries
+    history.map { |h| h['index'] }.should == [3, 2, 1]
+  end
+
+  it 'should let you control the number' do
+    (1..3).each { |i| hub.publish 'test-event', index: i }
+    result = hub.history('test-event', 1)
+    result.should be_a Array
+    result.should have(1).item
+    result.first['index'].should == 3
+  end
+
+  it 'should give a sliding window' do
+    (1..3).each { |i| hub.publish 'test-event', index: i }
+    history = -> { hub.history 'test-event', 3 }
+    expect do
+      hub.publish 'test-event', index: 4
+    end.to change(history, :call)
+  end
+
+  it 'should work correctly with top level lists' do
+    hub.publish 'x', type: 'x'
+    hub.publish 'x', type: 'x'
+    hub.history('x').map { |r| r['type'] }.should == %w(x x)
+  end
+
+  it 'should work correctly with nested lists' do
+    hub.publish 'x',   type: 'x'
+    hub.publish 'x:y:z', type: 'x:y:z'
+    hub.publish 'x:y',   type: 'x:y'
+    hub.history('x:y:z').map { |r| r['type'] }.should == %w(x:y:z)
+    hub.history('x:y').map { |r| r['type'] }.should == %w(x:y x:y:z)
+    hub.history('x').map { |r| r['type'] }.should == %w(x:y x:y:z x)
+  end
+
+  it 'should return an empty array with any objects' do
+    hub.history('blah').should == []
+  end
+
+  it "should return the correct data if it doesn't fill the limit" do
+    (1..3).each { |i| hub.publish('other', index: i) }
+    hub.history('other', 10).map { |i| i['index'] }.should == [3, 2, 1]
+  end
+
+  it "should return the full set if it fits the limit" do
+    (1..10).each { |i| hub.publish('other', index: i) }
+    hub.history('other', 10).map { |i| i['index'] }.should == (1..10).to_a.reverse
+  end
+
+  it "should return a cut down set if it's more than the limit" do
+    (1..15).each { |i| hub.publish('other', index: i) }
+    hub.history('other', 10).map { |i| i['index'] }.should == (6..15).to_a.reverse
+  end
+
+end

data/tavern-history.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tavern/history/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Darcy Laycock"]
+  gem.email         = ["sutto@sutto.net"]
+  gem.description   = %q{Adds support for history to tavern.}
+  gem.summary       = %q{Adds support for history to tavern.}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "tavern-history"
+  gem.require_paths = ["lib"]
+  gem.version       = Tavern::History::VERSION
+
+  gem.add_dependency 'multi_json'
+  gem.add_dependency 'redis'
+  gem.add_dependency 'tavern'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: tavern-history
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tavern
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds support for history to tavern.
+email:
+- sutto@sutto.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tavern-history.rb
+- lib/tavern/history.rb
+- lib/tavern/history/base.rb
+- lib/tavern/history/redis.rb
+- lib/tavern/history/version.rb
+- spec/history/redis_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+- tavern-history.gemspec
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds support for history to tavern.
+test_files:
+- spec/history/redis_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb