cassandra-queue 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Ooyala, Inc.
+
+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 @@
+WRITE ME

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler"
+require "rake/testtask"
+
+require File.join(File.dirname(__FILE__), "lib", "cassandra-queue", "version")
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = Dir.glob("test/**/*test.rb")
+  t.verbose = true
+end
+
+desc 'Builds the gem'
+task :build do
+  sh "gem build cassandra-queue.gemspec"
+end
+
+desc 'Builds and installs the gem'
+task :install => :build do
+  sh "gem install cassandra-queue-#{CassandraQueue::VERSION}"
+end

data/TODO

@@ -0,0 +1 @@
+WRITE ME

data/cassandra-cli.cass

@@ -0,0 +1,43 @@
+create keyspace CassandraQueueInfo
+  with placement_strategy = LocalStrategy
+  and strategy_options = [{replication_factor : 1}];
+
+use CassandraQueueInfo;
+
+create column family StringQueue
+  with column_type = Standard
+  and comparator = TimeUUIDType
+  and default_validation_class = UTF8Type
+  and key_validation_class = UTF8Type
+  and memtable_operations = 0.0328125
+  and memtable_throughput = 7
+  and memtable_flush_after = 1440
+  and rows_cached = 0.0
+  and row_cache_save_period = 0
+  and keys_cached = 200000.0
+  and key_cache_save_period = 14400
+  and read_repair_chance = 1.0
+  and gc_grace = 864000
+  and min_compaction_threshold = 4
+  and max_compaction_threshold = 32
+  and replicate_on_write = true
+  and row_cache_provider = 'ConcurrentLinkedHashCacheProvider';
+
+  create column family BytesQueue
+    with column_type = Standard
+    and comparator = TimeUUIDType
+    and default_validation_class = BytesType
+    and key_validation_class = UTF8Type
+    and memtable_operations = 0.0328125
+    and memtable_throughput = 7
+    and memtable_flush_after = 1440
+    and rows_cached = 0.0
+    and row_cache_save_period = 0
+    and keys_cached = 200000.0
+    and key_cache_save_period = 14400
+    and read_repair_chance = 1.0
+    and gc_grace = 864000
+    and min_compaction_threshold = 4
+    and max_compaction_threshold = 32
+    and replicate_on_write = true
+    and row_cache_provider = 'ConcurrentLinkedHashCacheProvider';

data/cassandra-queue.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "cassandra-queue/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cassandra-queue"
+  s.version     = CassandraQueue::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jay Bhat"]
+  s.email       = ["jbhat@ooyala.com"]
+  s.homepage    = "http://www.ooyala.com"
+  s.summary     = %q{Cassandra-backed general queue}
+  s.description = <<EOS
+Cassandra Queue is a queue that uses cassandra as a backend, that can hopefully be used
+as either a Job Queue, or a Message queue.
+EOS
+
+  s.rubyforge_project = "cassandra-queue"
+
+  ignores = File.readlines(".gitignore").grep(/\S+/).map {|pattern| pattern.chomp }
+  dotfiles = Dir[".*"]
+  s.files = Dir["**/*"].reject {|f| File.directory?(f) || ignores.any? {|i| File.fnmatch(i, f) } } + dotfiles
+  s.test_files = s.files.grep(/^test\//)
+
+  s.require_paths = ["lib"]
+
+  s.add_dependency "cassandra"
+
+  s.add_development_dependency "bundler", "~> 1.1"
+  s.add_development_dependency "scope", "~> 0.2.1"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "rake"
+end

data/lib/cassandra-queue.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+# queue = CassandraQueue::Queue.get_queue("myqueue", :keyspace => "KeyspaceName", :servers => "localhost:9160")
+
+require "cassandra"
+include SimpleUUID
+
+DEFAULT_KEYSPACE      = "CassandraQueueInfo"
+DEFAULT_SERVERS       = ["127.0.0.1:9160"]
+DEFAULT_STRING_QUEUE  = :StringQueue
+DEFAULT_BYTES_QUEUE   = :BytesQueue
+# Note(jbhat): Since almost all column names will be different, compression doesn't help for these CFs
+module CassandraQueue
+  # Singleton class that manages our cassandra queues
+  class QueueManager
+    def self.queues
+      @queues ||= {}
+    end
+
+    def self.queue(qid, string_queue, keyspace, servers)
+      key = :"#{qid}_#{string_queue}_#{keyspace}_#{servers.flatten.join(',')}"
+      queues[key] ||= Queue.send(:new, qid, string_queue, keyspace, servers)
+    end
+  end
+
+  class Queue
+    # Entry point for using a queue.  Class method which will return you a queue object for that UUID
+    def self.retrieve(qid, opts = {})
+      string_queue = opts[:string_queue] || false
+      keyspace = opts[:keyspace] || DEFAULT_KEYSPACE
+      servers = opts[:servers] || DEFAULT_SERVERS
+      QueueManager.queue(qid, string_queue, keyspace, servers)
+    end
+
+    class << self
+      alias :get_queue  :retrieve
+      alias :get        :retrieve
+    end
+    # Takes a payload, throws it on the queue, and returns the TimeUUID that was created for it
+    def insert(payload, time = Time.now, options = {})
+      timeUUID = UUID.new(time)
+      @client.insert(@queue_cf, @key, { timeUUID => payload }, options)
+      timeUUID
+    end
+
+    alias :add      :insert
+
+    def push(payload, options = {})
+      insert(payload, Time.now, options)
+    end
+
+    alias :enqueue  :push
+
+    # Removes a TimeUUID, and it's payload, from the queue
+    def remove(timeUUID, options = {})
+      @client.remove(@queue_cf, @key, timeUUID, options)
+    end
+
+    alias :delete :remove
+
+    # Show the first 100 elements of the queue by default, for things such as failure recovery
+    def list(get_times = false, options = {})
+      list = @client.get(@queue_cf, @key, options)
+      get_times ? list : list.values
+    end
+
+    alias :list_queue :list
+    alias :queue      :list
+
+    def payloads(options = {})
+      list(false, options)
+    end
+
+    alias :messages :payloads
+    alias :values   :payloads
+
+    def empty?(options = {})
+      list(true, options).empty?
+    end
+
+    # Show the first (oldest) element in the queue
+    # Returns payload [TimeUUID, payload] as a two element array
+    def peek(get_time = false, options = {})
+      options.merge(:count => 1)
+      payload = @client.get(@queue_cf, @key, options).first
+      payload && !get_time ? payload.last : payload
+    end
+
+    alias :front      :peek
+    alias :get_first  :peek
+
+    def pop(get_time = false, options = {})
+      item = peek(true, options)
+      return nil if item.nil?
+      remove(item.first, options)
+      get_time ? item : item.last
+    end
+
+    alias :dequeue  :pop
+
+    private_class_method :new
+
+    private
+    def initialize(qid, string_queue, keyspace, servers)
+      @key = qid_to_rowkey qid
+      # Set cassandra client if it has not already been set
+      @client = create_client(keyspace, servers)
+      @queue_cf = string_queue ? DEFAULT_STRING_QUEUE : DEFAULT_BYTES_QUEUE
+    end
+
+    def qid_to_rowkey(qid)
+      qid
+    end
+
+    def create_client(keyspace, servers)
+      ::Cassandra.new(keyspace, [servers].flatten)
+    end
+  end
+end

data/lib/cassandra-queue/version.rb

@@ -0,0 +1,3 @@
+module CassandraQueue
+  VERSION = "0.0.1"
+end

data/test/queue_test.rb

@@ -0,0 +1,26 @@
+require_relative "test_helper"
+
+class QueueTest < Scope::TestCase
+  context "with cassandra queue" do
+    setup do
+      @cassandra = mock("Cassandra")
+      ::Cassandra.stubs(:new).returns @cassandra
+      @qid = mock "qid"
+      @queue = CassandraQueue::Queue.get_queue(@qid)
+      @cf = :BytesQueue
+      @tid = mock "tuuid"
+      SimpleUUID::UUID.stubs(:new).returns(@tid)
+      @message = mock "message"
+    end
+
+    should "insert into cassandra when asked to" do
+      @cassandra.expects(:insert).with(@cf, @qid, {@tid => @message}, {})
+      @queue.push(@message)
+    end
+
+    should "remove from cassandra when asked to" do
+      @cassandra.expects(:remove).with(@cf, @qid, @tid, {})
+      @queue.remove(@tid)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "bundler"
+Bundler.require(:default, :development)
+require "minitest/autorun"
+
+# For testing cassandra-queue itself, use the local version *first*.
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "cassandra-queue"

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: cassandra-queue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jay Bhat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cassandra
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: scope
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: ! 'Cassandra Queue is a queue that uses cassandra as a backend, that
+  can hopefully be used
+
+  as either a Job Queue, or a Message queue.
+
+'
+email:
+- jbhat@ooyala.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- cassandra-cli.cass
+- cassandra-queue.gemspec
+- Gemfile
+- lib/cassandra-queue/version.rb
+- lib/cassandra-queue.rb
+- LICENSE
+- Rakefile
+- README.md
+- test/queue_test.rb
+- test/test_helper.rb
+- TODO
+- .gitignore
+homepage: http://www.ooyala.com
+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: cassandra-queue
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: Cassandra-backed general queue
+test_files:
+- test/queue_test.rb
+- test/test_helper.rb