seamule 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6dbd88d8473c2f609d7e913bb1a80b05bb787df
+  data.tar.gz: 57c3ccbeadf9ac5742ebaf029ff5d0be2df88c37
+SHA512:
+  metadata.gz: ad351067d1a19a662b00466766ebee4ff1b813c7c6969d2f280a8d1904eb3a16f9083d8cac98d1fb6fdca014731acd7b6b8624b9b375d3c4ab38c06406a46a27
+  data.tar.gz: 5466bd08adca0404a70772cff0bd79126feaf4919534a0286e1bd60a2cbdfea2429b5e00aa8f03c858ade12995568ee5706dec557f242eeedc7c549bb3d2747c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pablo Cárdenas
+
+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,41 @@
+# SeaMule
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/seamule`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seamule'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seamule
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/seamule. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seamule"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/seamule-server

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+begin
+  require 'vegas'
+rescue LoadError
+  require 'rubygems'
+  require 'vegas'
+end
+require 'seamule/server'
+
+Vegas::Runner.new(SeaMule::Server, 'seamule-server', {
+  :before_run => lambda {|v|
+    path = (ENV['SEAMULE_CONFIG'] || v.args.first)
+    load path.to_s.strip if path
+  }
+}) do |runner, opts, app|
+  opts.on('-N NAMESPACE', "--namespace NAMESPACE", "set the Redis namespace") {|namespace|
+    runner.logger.info "Using Redis namespace '#{namespace}'"
+    SeaMule.redis.namespace = namespace
+  }
+  opts.on('-r redis-connection', "--redis redis-connection", "set the Redis connection string") {|redis_conf|
+    runner.logger.info "Using Redis connection '#{redis_conf}'"
+    SeaMule.redis = redis_conf
+  }
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/seamule.rb

@@ -0,0 +1,110 @@
+require 'redis'
+require 'mono_logger'
+
+require 'seamule/version'
+require 'seamule/backend'
+require 'seamule/encoder'
+require 'seamule/json_encoder'
+require 'seamule/job'
+require 'seamule/server'
+require 'seamule/queue'
+
+require 'forwardable'
+
+module SeaMule
+  extend Forwardable
+  extend self
+
+  QUEUES = %w(pending active done).freeze
+
+  DEFAULT_QUEUE = QUEUES.first.freeze
+
+  attr_reader :redis
+
+  attr_writer :coder
+
+  attr_accessor :logger
+
+  def encode(object)
+    coder.encode(object)
+  end
+
+  def decode(object)
+    coder.decode(object)
+  end
+
+  def backend
+    @backend ||= Backend.new(@redis, SeaMule.logger)
+  end
+
+  def redis=(server)
+    @redis = Backend.connect(server) unless server.nil?
+    @backend = Backend.new(@redis, SeaMule.logger)
+    create_queues
+    @redis
+  end
+
+  def create_queues
+    @queues = {}
+    QUEUES.each do |queue_name|
+      @queues[queue_name] = SeaMule::Queue.new(queue_name, @redis)
+    end
+  end
+
+  def coder
+    @coder ||= JsonEncoder.new
+  end
+
+  def push(queue, item)
+    queue(queue) << item
+  end
+
+  def pop(queue, id = nil)
+    queue(queue).pop(id)
+  end
+
+  def pop_and_push(from_queue, to_queue)
+    job = pop(from_queue)
+    push(to_queue, job) if job
+    job
+  end
+
+  def size(queue)
+    queue(queue).size
+  end
+
+  def queues
+    Array(backend.store.smembers(:queues))
+  end
+
+  def remove_queue(queue)
+    queue(queue).destroy
+    @queues.delete(queue.to_s)
+  end
+
+  def queue(name)
+    @queues[name.to_s]
+  end
+
+  def enqueue(klass, payload, meta = nil)
+    enqueue_to(DEFAULT_QUEUE, klass, payload, meta)
+  end
+
+  def enqueue_to(queue, klass, payload, meta)
+    Job.create(queue, klass, payload, meta)
+  end
+
+  def dequeue(queue, klass: nil, payload: nil, id: nil)
+    Job.destroy(queue, klass: klass, payload: payload, id: id)
+  end
+
+  def queued(queue, klass: nil, payload: nil, id: nil)
+    Job.queued(queue, klass: klass, payload: payload, id: id)
+  end
+
+  def keys
+    backend.store.keys('*')
+  end
+end
+
+SeaMule.logger = MonoLogger.new(STDOUT)

data/lib/seamule/backend.rb

@@ -0,0 +1,46 @@
+require 'redis-namespace'
+
+module SeaMule
+  class Backend
+    attr_reader :store
+
+    attr_reader :logger
+
+    def initialize(store, logger)
+      @store = store
+      @logger = logger
+    end
+
+    def self.connect(server)
+      case server
+        when String
+          redis = connect_to(server)
+          Redis::Namespace.new(:seamule, redis: redis)
+        when Hash
+          Redis::Namespace.new(:seamule, redis: Redis.new(server))
+        else
+          raise ArgumentError, "Invalid Server: #{server.inspect}"
+      end
+    end
+
+    def self.connect_to(server)
+      Redis.connect(url: server, :thread_safe => true)
+    end
+
+    MAX_RECONNECT_ATTEMPTS = 3
+
+    def reconnect
+      store.client.reconnect
+    rescue Redis::BaseConnectionError
+      tries ||= 0
+      if (tries += 1) < MAX_RECONNECT_ATTEMPTS
+        logger.info "Error reconnecting to Redis; retrying"
+        Kernel.sleep(tries)
+        retry
+      else
+        logger.info "Error reconnecting to Redis; quitting"
+        raise ConnectionError
+      end
+    end
+  end
+end

data/lib/seamule/encoder.rb

@@ -0,0 +1,23 @@
+module SeaMule
+  class EncodeException < StandardError; end
+
+  class DecodeException < StandardError; end
+
+  class Encoder
+    def encode(object)
+      raise EncodeException
+    end
+
+    def dump(object)
+      encode(object)
+    end
+
+    def decode(object)
+      raise DecodeException
+    end
+
+    def load(object)
+      decode(object)
+    end
+  end
+end

data/lib/seamule/job.rb

@@ -0,0 +1,108 @@
+require 'json'
+
+module SeaMule
+  class Job
+    attr_reader :id
+
+    attr_reader :callback_class_name
+
+    attr_reader :meta
+
+    attr_reader :queue
+
+    attr_reader :payload
+
+    attr_accessor :result
+
+    def initialize(queue, content)
+      @queue = queue
+      @payload = content['payload']
+      @meta = content['meta']
+      @id = content['id']
+      @callback_class_name = content['class']
+    end
+
+    def self.create(queue, klass, payload, meta)
+      SeaMule.push(queue, class: klass.to_s, payload: payload, meta: meta, id: SecureRandom.hex)
+    end
+
+    def self.destroy(queue, klass: nil, payload: nil, id: nil)
+      coder = SeaMule.coder
+      redis = SeaMule.backend.store
+      klass = klass.to_s
+
+      destroyed_count = process_queue(queue, coder, redis, klass, payload, id) do |decoded, new_queue, temp_queue, requeue_queue|
+        redis.del(temp_queue).to_i
+      end
+
+      destroyed_count.inject(0, :+)
+    end
+
+    def self.queued(queue, klass: nil, payload: nil, id: nil)
+      coder = SeaMule.coder
+      redis = SeaMule.backend.store
+      klass = klass.to_s
+
+      jobs = process_queue(queue, coder, redis, klass, payload, id) do |decoded, _new_queue, temp_queue, requeue_queue|
+        redis.rpoplpush(temp_queue, requeue_queue)
+        new(queue, decoded)
+      end
+
+      jobs
+    end
+
+    def perform
+      object = callback_class.new
+      object.perform(id, meta, payload, result)
+    end
+
+    def callback_class
+      @callback_class ||= callback_class_name.to_s.constantize
+    end
+
+    def to_h
+      {
+          :queue => queue,
+          :run_at => Time.now.utc.iso8601,
+          :payload => payload
+      }
+    end
+
+    def inspect
+      "Job @#{@queue} | #{@callback_class_name} | #{@meta.inspect} | #{@payload.inspect}"
+    end
+
+
+    def ==(other)
+      queue == other.queue &&
+          callback_class == other.callback_class &&
+          meta == other.meta &&
+          payload == other.payload
+    end
+
+    protected
+
+    def self.process_queue(queue, coder, redis, klass, payload, id)
+      return_array = []
+      new_queue = "queue:#{queue}"
+      temp_queue = "queue:#{queue}:temp:#{Time.now.to_i}"
+      requeue_queue = "#{temp_queue}:requeue"
+
+      while string = redis.rpoplpush(new_queue, temp_queue)
+        decoded = coder.decode(string)
+        if decoded['id'] == id || (decoded['class'] == klass && (payload.empty? || decoded['payload'] == payload))
+          return_array.unshift(yield decoded, new_queue, temp_queue, requeue_queue)
+        else
+          redis.rpoplpush(temp_queue, requeue_queue)
+        end
+      end
+      push_queue(redis, requeue_queue, new_queue)
+
+      return_array
+    end
+
+    def self.push_queue(redis, requeue_queue, queue)
+      loop { redis.rpoplpush(requeue_queue, queue) or break }
+    end
+  end
+end

data/lib/seamule/json_encoder.rb

@@ -0,0 +1,20 @@
+require 'seamule/encoder'
+require 'multi_json'
+
+module SeaMule
+  class JsonEncoder < Encoder
+    def encode(object)
+      JSON.dump(object)
+    end
+
+    def decode(object)
+      return unless object
+
+      begin
+        JSON.load(object)
+      rescue ::JSON::JSONError => e
+        raise SeaMule::DecodeException, e.message, e.backtrace
+      end
+    end
+  end
+end

data/lib/seamule/queue.rb

@@ -0,0 +1,42 @@
+require 'redis'
+
+module SeaMule
+  class Queue
+    attr_reader :name, :redis_name
+
+    def initialize(name, redis)
+      super()
+      @name = name
+      @redis_name = "queue:#{@name}"
+      @redis = redis
+      @redis.sadd(:queues, @name)
+    end
+
+    def push(object)
+      begin
+        encoded_object = SeaMule.encode(object)
+      rescue SeaMule::EncodeException => e
+        SeaMule.logger.error "Invalid UTF-8 character in job: #{e.message}"
+        return
+      end
+
+      @redis.rpush(@redis_name, encoded_object)
+    end
+
+    alias :<< :push
+
+    def pop(id = nil)
+      SeaMule.decode(@redis.lpop(@redis_name))
+    end
+
+    def length
+      @redis.llen(@redis_name)
+    end
+
+    alias :size :length
+
+    def empty?
+      size == 0
+    end
+  end
+end

data/lib/seamule/server.rb

@@ -0,0 +1,60 @@
+require 'sinatra/base'
+require 'seamule'
+
+if defined? Encoding
+  Encoding.default_external = Encoding::UTF_8
+end
+
+module SeaMule
+  class Server < Sinatra::Base
+    set :static, true
+
+    def render_json(object)
+      response['Cache-Control'] = 'max-age=0, private, must-revalidate'
+      content_type :json
+      begin
+        object.to_json
+      rescue Errno::ECONNREFUSED
+        status 500
+      end
+    end
+
+    get '/jobs.json' do
+      render_json([])
+    end
+
+    post '/jobs.json' do
+      job = SeaMule.pop_and_push(:pending, :active)
+      if job
+        render_json(job)
+      else
+        unprocessable_entity
+      end
+    end
+
+    patch '/jobs/:id.json' do
+      job = SeaMule.queued(:active, id: params[:id]).first
+      if job
+        job.result = read_json
+        SeaMule.dequeue(:active, id: params[:id])
+        SeaMule.push(:done, job)
+        render_json(params.to_json)
+        job.perform
+      else
+        unprocessable_entity
+      end
+    end
+
+    def not_authorized
+      status 403
+    end
+
+    def unprocessable_entity
+      status 422
+    end
+
+    def read_json
+      JSON.parse(request.env['rack.input'].read)
+    end
+  end
+end

data/lib/seamule/version.rb

@@ -0,0 +1,3 @@
+module SeaMule
+  VERSION = '0.0.1'
+end

data/seamule.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seamule/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'seamule'
+  spec.version = SeaMule::VERSION
+  spec.authors = ['Pablo Cárdenas']
+  spec.email = ['pcardenasoliveros@gmail.com']
+
+  spec.summary = %q{SeaMule is a Redis-backed Ruby library for creating jobs assigning them to clients and reducing them later}
+  spec.description = %q{SeaMule is a Redis-backed Ruby library for creating jobs assigning them to clients and reducing them later}
+  spec.homepage = 'https://github.com/pablo-co/seamule'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'bin'
+  spec.executables = ['seamule-server']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+
+  spec.add_dependency 'multi_json', '~> 1.11.2'
+  spec.add_dependency 'sinatra', '>= 0.9.2'
+  spec.add_dependency 'redis-namespace', '~> 1.5.1'
+  spec.add_dependency 'vegas', '~> 0.1.2'
+  spec.add_dependency 'mono_logger', '>= 1.1.0'
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: seamule
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pablo Cárdenas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: vegas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: mono_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: SeaMule is a Redis-backed Ruby library for creating jobs assigning them
+  to clients and reducing them later
+email:
+- pcardenasoliveros@gmail.com
+executables:
+- seamule-server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/seamule-server
+- bin/setup
+- lib/seamule.rb
+- lib/seamule/backend.rb
+- lib/seamule/encoder.rb
+- lib/seamule/job.rb
+- lib/seamule/json_encoder.rb
+- lib/seamule/queue.rb
+- lib/seamule/server.rb
+- lib/seamule/version.rb
+- seamule.gemspec
+homepage: https://github.com/pablo-co/seamule
+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.4.8
+signing_key: 
+specification_version: 4
+summary: SeaMule is a Redis-backed Ruby library for creating jobs assigning them to
+  clients and reducing them later
+test_files: []