enqueue 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    enqueue (0.0.1)
+      version (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    at (0.1.4)
+      version (~> 1.0)
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    fuubar (1.1.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0.0)
+    github-markup (0.7.4)
+    guard (1.5.4)
+      listen (>= 0.4.2)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.3.1)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    guard-yard (2.0.1)
+      guard (>= 1.1.0)
+      yard (>= 0.7.0)
+    listen (0.6.0)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (10.0.3)
+    rb-fsevent (0.9.2)
+    redcarpet (2.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.12.0)
+    ruby-progressbar (1.0.2)
+    slop (3.3.3)
+    thor (0.16.0)
+    version (1.0.0)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  at (~> 0.1)
+  enqueue!
+  fuubar (~> 1.1)
+  github-markup (~> 0.7)
+  guard-rspec (~> 2.1)
+  guard-yard (~> 2.0)
+  rake (~> 10.0)
+  rb-fsevent (~> 0.9)
+  redcarpet (~> 2.2.2)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ryan Scott Lewis <ryan@rynet.us>.
+
+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,213 @@
+# Enqueue
+
+__enqueue__ _verb_ _\en′kyü\_ __:__ To add an item to a queue.
+
+Enqueue is an interface to [message queues][message_queue] for easy parallel processing and 
+multi-threading.
+
+## Install
+
+### Bundler: `gem 'enqueue'`
+
+### RubyGems: `gem install enqueue`
+
+## Usage
+
+### Publisher
+
+A publisher is any object that can find and push messages to a queue.
+
+#### Defining
+
+You can define a publisher by subclassing `Enqueue::Publisher` or by including/extending 
+`Enqueue::Publisher::Base`.
+
+#### Global Methods
+
+Besides the methods that are mixed into publisher by an adapter, all publishers 
+will have the following methods:
+
+#### Class
+
+`adapter(name)`  
+*returns: true, false*
+
+**name** <Symbol, #to_sym> The name of the adapter to mixin.
+
+Remove any previous adapter specific methods and include the module associated with the given Symbol.
+
+> Note: Adapters *will* overwrite any instance/class method that it uses.  
+> Not all adapters have the same set of methods so you may have to investigate which methods 
+> not to use when integrating the ability to publish to a queue onto an existing object.
+
+#### Instance
+
+`enqueue(message, options={})`  
+*aliases: push, shift, <<*  
+*returns: Enqueue::Message*
+
+**message** \<Object> The message to push. Note that some adapters require this to be a String.  
+**options** <Hash, #to_hash, #to_h> The adapter-specific options.
+
+Push a message to the/a queue.
+
+### Subscriber
+
+A subscriber is any object that can find and pop messages off a queue.
+
+#### Defining
+
+Just like a publisher, you can define a subscriber by subclassing `Enqueue::Subscriber` or by 
+including/extending `Enqueue::Subscriber::Base`.
+
+#### Global Methods
+
+Besides the methods that are mixed into publisher by an adapter, all publishers 
+will have the following methods:
+
+#### Class
+
+`adapter(name)`  
+*returns: true, false*
+
+**name** <Symbol, #to_sym> The name of the adapter to mixin.
+
+Remove any previous adapter specific methods and include the module associated with the given Symbol.
+
+#### Instance
+
+`pop(options={})`  
+*aliases: dequeue, unshift*  
+*returns: Enqueue::Message*
+
+**options** <Hash, #to_hash, #to_h> The adapter-specific options.
+
+Push a message to the/a queue.
+
+`run`  
+
+In a loop, wait until the queue has a message. When it does, pop it off.
+
+> Note: All adapters overwrite this method.
+
+`run!`  
+*returns: Thread*
+
+Call `run` in a new thread.
+
+### Example
+
+#### Ruby Queue
+
+By default, Enqueue uses the [Queue][queue] class from the Ruby standard library.
+
+`my_pub_sub`
+
+```ruby
+#!/usr/bin/env ruby
+
+subscribers, publishers, threads = [], [], []
+
+trap('INT') do
+  print 'Killing all publishers... '
+  publishers.each(&:disconnect)
+  puts 'Done!'
+  
+  print 'Killing all subscribers... '
+  subscribers.each(&:disconnect)
+  puts 'Done!'
+end
+puts "Press CTRL-C to exit."
+
+5.times do
+  publisher = Enqueue::Publisher.new
+  publishers << publisher
+  threads << Thread.new do
+    loop do
+      sleep rand(10)
+      publisher.push 'Hello, World!'
+    end
+  end
+end
+
+5.times do
+  subscriber = Enqueue::Subscriber.new
+  subscribers << subscriber
+  threads << subscriber.run!
+end
+```
+
+#### RabbitMQ
+
+`my_pub_sub`
+
+```ruby
+#!/usr/bin/env ruby
+
+class Publisher < Enqueue::Publisher
+  adapter :rabbit_mq
+  # This class now has RabbitMQ specific class and
+  # instance methods:
+  host 'localhost'
+  port 5672
+  
+  def notify(message)
+    enqueue message, to: 'my_message_queue'
+  end
+end
+
+class Subscriber < Enqueue::Subscriber
+  adapter :rabbit_mq
+  # This class now has RabbitMQ specific class and
+  # instance methods:
+  host 'localhost'
+  port 5672
+  
+  subscribe :print_message, to: 'my_message_queue'
+  
+  def print_message(message)
+    puts message
+  end
+end
+
+subscribers, publishers, threads = [], [], []
+
+trap('INT') do
+  print 'Disconnecting all publishers... '
+  publishers.each(&:disconnect)
+  puts 'Done!'
+  
+  print 'Disconnecting all subscribers... '
+  subscribers.each(&:disconnect)
+  puts 'Done!'
+end
+puts "Press CTRL-C to exit."
+
+5.times do
+  publisher = Publisher.new
+  publishers << publisher
+  publisher.connect
+  threads << Thread.new do
+    loop do
+      sleep rand(10)
+      publisher.notify 'Hello, World!'
+    end
+  end
+end
+
+5.times do
+  subscriber = Subscriber.new
+  subscribers << subscriber
+  subscriber.connect
+  threads << subscriber.run!
+end
+```
+
+## Copyright
+
+Copyright © 2012 Ryan Scott Lewis <ryan@rynet.us>.
+
+The MIT License (MIT) - See LICENSE for further details.
+
+[message_queue]: http://en.wikipedia.org/wiki/Message_queue
+[queue]: http://rubydoc.info/stdlib/thread/Queue

data/Rakefile

@@ -0,0 +1,61 @@
+require 'pathname'
+
+def require_task(path)
+  begin
+    require path
+    
+    yield
+  rescue LoadError
+    puts '', "Could not load '#{path}'.", 'Try to `rake gem:spec` and `bundle install` and try again.', ''
+  end
+end
+
+spec = Gem::Specification.new do |s|
+  
+  # Variables
+  s.name = 'enqueue'
+  s.author = 'Ryan Scott Lewis'
+  s.email = 'ryan@rynet.us'
+  s.summary = 'Enqueue is an interface to message queues for easy parallel processing.'
+  s.description = 'Interface with message queues with ease.'
+  s.post_install_message = 'Enqueue is not yet finished, check back with this gem has a MINOR version!'
+  
+  # Dependencies
+  s.add_dependency 'version', '~> 1.0'
+  s.add_development_dependency 'at', '~> 0.1'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'guard-rspec', '~> 2.1'
+  s.add_development_dependency 'guard-yard', '~> 2.0'
+  s.add_development_dependency 'rb-fsevent', '~> 0.9'
+  s.add_development_dependency 'fuubar', '~> 1.1'
+  s.add_development_dependency 'redcarpet', '~> 2.2.2'
+  s.add_development_dependency 'github-markup', '~> 0.7'
+  
+  # Pragmatically set variables
+  s.homepage = "http://github.com/RyanScottLewis/#{s.name}"
+  s.version = Pathname.glob('VERSION*').first.read
+  s.require_paths = ['lib']
+  s.files        = `git ls-files`.lines.to_a.collect { |s| s.strip }
+  s.executables  = `git ls-files -- bin/*`.lines.to_a.collect { |s| File.basename(s.strip) }
+  
+end
+
+desc 'Generate the gemspec defined in this Rakefile'
+task :gemspec do
+  Pathname.new("#{spec.name}.gemspec").open('w') { |f| f.write(spec.to_ruby) }
+end
+
+require_task 'rake/version_task' do
+  Rake::VersionTask.new do |t|
+    t.with_git_tag = true
+    t.with_gemspec = spec
+  end
+end
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(spec) do |t|
+  t.need_zip = false
+  t.need_tar = false
+end
+
+task :default => :gemspec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/enqueue.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "enqueue"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Scott Lewis"]
+  s.date = "2012-12-13"
+  s.description = "Interface with message queues with ease."
+  s.email = "ryan@rynet.us"
+  s.files = ["Gemfile", "Gemfile.lock", "LICENSE", "README.md", "Rakefile", "VERSION", "enqueue.gemspec", "lib/enqueue.rb"]
+  s.homepage = "http://github.com/RyanScottLewis/enqueue"
+  s.post_install_message = "Enqueue is not yet finished, check back with this gem has a MINOR version!"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Enqueue is an interface to message queues for easy parallel processing."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<version>, ["~> 1.0"])
+      s.add_development_dependency(%q<at>, ["~> 0.1"])
+      s.add_development_dependency(%q<rake>, ["~> 10.0"])
+      s.add_development_dependency(%q<guard-rspec>, ["~> 2.1"])
+      s.add_development_dependency(%q<guard-yard>, ["~> 2.0"])
+      s.add_development_dependency(%q<rb-fsevent>, ["~> 0.9"])
+      s.add_development_dependency(%q<fuubar>, ["~> 1.1"])
+      s.add_development_dependency(%q<redcarpet>, ["~> 2.2.2"])
+      s.add_development_dependency(%q<github-markup>, ["~> 0.7"])
+    else
+      s.add_dependency(%q<version>, ["~> 1.0"])
+      s.add_dependency(%q<at>, ["~> 0.1"])
+      s.add_dependency(%q<rake>, ["~> 10.0"])
+      s.add_dependency(%q<guard-rspec>, ["~> 2.1"])
+      s.add_dependency(%q<guard-yard>, ["~> 2.0"])
+      s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
+      s.add_dependency(%q<fuubar>, ["~> 1.1"])
+      s.add_dependency(%q<redcarpet>, ["~> 2.2.2"])
+      s.add_dependency(%q<github-markup>, ["~> 0.7"])
+    end
+  else
+    s.add_dependency(%q<version>, ["~> 1.0"])
+    s.add_dependency(%q<at>, ["~> 0.1"])
+    s.add_dependency(%q<rake>, ["~> 10.0"])
+    s.add_dependency(%q<guard-rspec>, ["~> 2.1"])
+    s.add_dependency(%q<guard-yard>, ["~> 2.0"])
+    s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
+    s.add_dependency(%q<fuubar>, ["~> 1.1"])
+    s.add_dependency(%q<redcarpet>, ["~> 2.2.2"])
+    s.add_dependency(%q<github-markup>, ["~> 0.7"])
+  end
+end

data/lib/enqueue.rb

@@ -0,0 +1,5 @@
+require 'version'
+
+module Enqueue
+  is_versioned
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: enqueue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: at
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  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: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Interface with message queues with ease.
+email: ryan@rynet.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- enqueue.gemspec
+- lib/enqueue.rb
+homepage: http://github.com/RyanScottLewis/enqueue
+licenses: []
+post_install_message: Enqueue is not yet finished, check back with this gem has a
+  MINOR version!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4127432239887490786
+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: Enqueue is an interface to message queues for easy parallel processing.
+test_files: []