coordinator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 480787ac7b5eecf9271ec542f15f5ebf17d23085
+  data.tar.gz: 9f688ebfcd97125c0292784f8ab06a121b9a4b51
+SHA512:
+  metadata.gz: c4ee690d00d2e78c10636c587c6f701230822c85a43118ab8c605759c4f9f2c75130f773649f2671ea1a4af2a6674d9643bc2be958c3dafbe21c5cc6acac4375
+  data.tar.gz: 7b4742110498118ffcf39ad32e72b98c55bb8957d3df4f4b67fc065abe705e73a1d00ce2e60018f18839598afc228dbe0d3359830eea5e007a9b6cb83b1a473f

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/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tyler Mercier
+
+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 @@
+# Coordinator
+
+Ruby gem for coordinating multiple redis queues
+
+## Status
+[![Gem Version](https://badge.fury.io/rb/coordinator.png)](http://badge.fury.io/rb/coordinator)
+[![Build Status](https://secure.travis-ci.org/tylermercier/coordinator.png)](http://travis-ci.org/tylermercier/coordinator)
+[![Code Climate](https://codeclimate.com/github/tylermercier/coordinator.png)](https://codeclimate.com/github/tylermercier/coordinator)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'coordinator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coordinator
+
+## Usage
+
+    @coordinator = Coordinator::Base.new([
+      Coordinator::Queue.new("high"),
+      Coordinator::Queue.new("medium"),
+      Coordinator::Queue.new("low")
+    ])
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/coordinator/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,13 @@
+#!/usr/bin/env rake
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: 'test'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/coordinator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coordinator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coordinator"
+  spec.version       = Coordinator::VERSION
+  spec.authors       = ["Tyler Mercier"]
+  spec.email         = ["tylermercier@gmail.com"]
+  spec.summary       = %q{Ruby gem for coordinating multiple redis queues}
+  spec.description   = %q{Ruby gem for coordinating multiple redis queues}
+  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_dependency "http"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "fakeredis"
+end

data/lib/coordinator.rb

@@ -0,0 +1,4 @@
+require "coordinator/version"
+require "coordinator/redis_queue"
+require "coordinator/queue"
+require "coordinator/base"

data/lib/coordinator/base.rb

@@ -0,0 +1,33 @@
+module Coordinator
+  class Base
+    def initialize(queues)
+      @queues = queues
+    end
+
+    def add_task(skill, task)
+      queue = queue_for_skill(skill)
+      queue.add_task(task)
+    end
+
+    def add_priority_task(skill, task)
+      queue = queue_for_skill(skill)
+      queue.add_priority_task(task)
+    end
+
+    def next_task(skills)
+      @queues.each do |q|
+        task = q.next_task(skills)
+        return task if task
+      end
+      false
+    end
+
+    private
+
+    def queue_for_skill(skill)
+      queue = @queues.find {|q| q.skill == skill}
+      raise "No matching queue for #{skill}" unless queue
+      queue
+    end
+  end
+end

data/lib/coordinator/queue.rb

@@ -0,0 +1,26 @@
+module Coordinator
+  class Queue
+    attr_reader :skill
+
+    def initialize(skill)
+      @skill = skill
+      @store = Coordinator::RedisQueue.new(@skill)
+    end
+
+    def add_task(task)
+      @store.push(task)
+    end
+
+    def add_priority_task(task)
+      @store.left_push(task)
+    end
+
+    def next_task(skills)
+      can_work?(skills) ? @store.pop : nil
+    end
+
+    def can_work?(skills)
+      skills.include?(@skill)
+    end
+  end
+end

data/lib/coordinator/redis_queue.rb

@@ -0,0 +1,60 @@
+require 'json'
+
+module Coordinator
+  class RedisQueue
+    def initialize(name)
+      @name = name
+      raise "redis not found, please set 'Redis.current'" unless Redis.current
+      @redis = Redis.current
+    end
+
+    def push(item)
+      data = serialize(item)
+      @redis.rpush(@name, data) unless items.include?(data)
+    end
+
+    def left_push(item)
+      data = serialize(item)
+      @redis.lpush(@name, data) unless items.include?(data)
+    end
+
+    def pop
+      data = @redis.lpop(@name)
+      parse(data)
+    end
+
+    def remove(item)
+      data = serialize(item)
+      @redis.lrem(@name, 1, data)
+    end
+
+    def peek
+      data = @redis.lrange(@name, 0, 0).first
+      parse(data)
+    end
+
+    def length
+      @redis.llen(@name)
+    end
+
+    private
+
+    def items
+      @redis.lrange(@name, 0, length)
+    end
+
+    def serialize(item)
+      item.is_a?(String) ? item : item.to_json
+    end
+
+    def parse(item)
+      return item if item.nil?
+      return item.to_i if item.to_i.to_s == item
+      begin
+        JSON::parse(item)
+      rescue JSON::ParserError
+        item # regular string
+      end
+    end
+  end
+end

data/lib/coordinator/version.rb

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

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+require "fakeredis"
+
+Redis.current = Redis.new
+Minitest::Reporters.use!(Minitest::Reporters::DefaultReporter.new(color: true))
+
+ENV['RACK_ENV'] = 'test'
+
+Dir[File.dirname(__FILE__) + '/../lib/*.rb'].each do |file|
+  require File.basename(file, File.extname(file))
+end

data/test/unit/base_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+describe 'Coordinator::Base' do
+  before do
+    @coordinator = Coordinator::Base.new([
+      Coordinator::Queue.new("high"),
+      Coordinator::Queue.new("medium"),
+      Coordinator::Queue.new("low")
+    ])
+  end
+
+  describe 'adding work' do
+    it 'adds task to appropriate queue with priority' do
+      @coordinator.add_task("high", 1)
+      @coordinator.add_task("medium", 2)
+      @coordinator.add_priority_task("high", 3)
+      assert_equal 3, @coordinator.next_task(["high"])
+      assert_equal 1, @coordinator.next_task(["high"])
+      assert_equal 2, @coordinator.next_task(["medium"])
+      assert_equal false, @coordinator.next_task(["medium"])
+    end
+  end
+end

data/test/unit/queue_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+
+describe "Coordinator::Queue" do
+  before do
+    @queue = Coordinator::Queue.new("high")
+    Redis.current.flushall
+  end
+
+  describe "add_task" do
+    it "returns true when skill present" do
+      @queue.add_task(5)
+      @queue.add_task(4)
+
+      assert_equal 5, @queue.next_task(["high"])
+    end
+  end
+
+  describe "add_priority_task" do
+    it "returns true when skill present" do
+      @queue.add_task(5)
+      @queue.add_priority_task(4)
+
+      assert_equal 4, @queue.next_task(["high"])
+    end
+  end
+
+  describe "can_work?" do
+    it "returns true when skill present" do
+      assert @queue.can_work?(["high"])
+    end
+
+    it "returns false when skill not present" do
+      refute @queue.can_work?(["general", "rogers"])
+    end
+  end
+end

data/test/unit/redis_queue_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+describe 'Coordinator::RedisQueue' do
+  before do
+    @queue = Coordinator::RedisQueue.new('test')
+    Redis.current.flushall
+  end
+
+  describe '.push' do
+    it 'adds element to queue, returns length' do
+      @queue.push("a")
+      @queue.push("b")
+      assert_equal 2, @queue.length
+    end
+
+    it 'adds the same item only once' do
+      @queue.push("a")
+      @queue.push("a")
+      assert_equal 1, @queue.length
+    end
+  end
+
+  describe '.left_push' do
+    it 'adds element to front of queue' do
+      @queue.push("b")
+      @queue.push("c")
+      @queue.left_push("a")
+      assert_equal "a", @queue.pop
+      assert_equal 2, @queue.length
+    end
+  end
+
+  describe '.pop' do
+    it 'returns top item from queue' do
+      @queue.push("a")
+      @queue.push("b")
+      @queue.push("c")
+      assert_equal "a", @queue.pop
+    end
+
+    it 'returns nil when empty' do
+      assert_equal nil, @queue.pop
+    end
+  end
+
+  describe '.remove' do
+    it 'returns 1 when element found and removes' do
+      @queue.push(1)
+      assert_equal 1, @queue.remove(1)
+      assert_equal 0, @queue.length
+    end
+
+    it 'returns 0 when element not found' do
+      @queue.push(1)
+      assert_equal 0, @queue.remove(4)
+      assert_equal 1, @queue.length
+    end
+
+    it 'returns nil when queue empty' do
+      assert_equal nil, @queue.remove(4)
+    end
+  end
+
+  describe '.peek' do
+    it 'gets the top item and does not remove' do
+      @queue.push(1)
+      @queue.push(2)
+      assert_equal 1, @queue.peek
+      assert_equal 2, @queue.length
+    end
+  end
+
+  it 'allows for objects' do
+    [1000, "taco", {"a" => 1}, [1,2,3]].each do |o|
+      @queue.push(o)
+      assert_equal o, @queue.pop
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: coordinator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Mercier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem for coordinating multiple redis queues
+email:
+- tylermercier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- coordinator.gemspec
+- lib/coordinator.rb
+- lib/coordinator/base.rb
+- lib/coordinator/queue.rb
+- lib/coordinator/redis_queue.rb
+- lib/coordinator/version.rb
+- test/test_helper.rb
+- test/unit/base_test.rb
+- test/unit/queue_test.rb
+- test/unit/redis_queue_test.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.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby gem for coordinating multiple redis queues
+test_files:
+- test/test_helper.rb
+- test/unit/base_test.rb
+- test/unit/queue_test.rb
+- test/unit/redis_queue_test.rb