qpush 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 806a9acd2181b5402712357fa31dbd83bc07043f
+  data.tar.gz: 63ac3b505e48c766626f93982577c313944dd6e5
+SHA512:
+  metadata.gz: bdfa048b61f185be1f2c4609b38c30ddeb5c21c54f37d1e936a1929b7151619e364dd1a5ccb988c2e76d905b52a4aeec688ce05156ec9dac69d6ea151c87d566
+  data.tar.gz: 5d46f619f6c2c13e809ed8907cf1699b39f57036903de319fe71bc9f63e1de62945e13f359314aa9de3f64d03411232dd788fa96a46bcb3a52ae8546da45e290

data/.byebug_history

@@ -0,0 +1,107 @@
+quit
+puts e
+puts s
+c
+puts e
+puts s
+s
+jobs.compact!
+jobs.compact![s, e]
+jobs
+quit
+jobs
+c
+jobs
+quit
+job_hash
+quit
+delayed_jobs
+delay_jobs
+c
+conn.zrange(QPush.config.delay_namespace, 0, -1, with_scores: true)
+delayed_jobs
+quit
+conn.get("#{@namespace}:#{stat}")
+"#{@namespace}:#{stat}"
+c
+name
+c
+self.name
+quit
+job
+delays.each { |job| PerformJob.call(Job.new(job)) }
+cccccccccccc
+elcccccccccccccccccccc
+delaysdelays.each {|job| PerformJob.call(Job.new(job))}
+quit
+Server.connection_pool
+Qued::QPush.redis
+QPush.redis
+c
+QueueJob.new(job).call
+job.valid? && job.queueable?
+job.valid?
+return false unless job.valid? && job.queueable?
+job
+quit
+@start_at < Time.now.to_i && !@cron.empty?
+@start_at > Time.now.to_i && @cron.empty?
+@start_at < Time.now.to_i && @cron.empty?
+QueueJob.new(self).call
+quit
+job.valid?
+job.save
+test
+quit
+job.save
+job
+job = Job.new(options)
+options
+quit
+cron?
+delay?
+queue?
+quit
+c
+job_type.call
+quit
+job_type.call
+quit
+performer
+performer = retrieve_job_type
+quit
+self
+performer.call
+performer
+performer = retrieve_job_type
+performer.call
+performer
+retrieve_job_type
+performer
+c
+quit
+performer.call
+performer
+performer = retrieve_job_type
+valid?
+c
+@job.queue?
+@job.delay?
+@job.cron?
+@job
+job_success
+measure_run_time { @job.run }
+@job.run
+c
+quit
+log_success
+job_success && log_success
+c
+@job.run
+@job = Job.new(JSON.parse(json))
+c
+@job = Job.new(JSON.parse(json))
+json
+quit
+json
+son

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at nsweeting@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in job_que.gemspec
+gemspec
+
+gem 'pg'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicholas Sweeting
+
+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,154 @@
+# QPush
+[![Code Climate](https://codeclimate.com/github/nsweeting/qpush/badges/gpa.svg)](https://codeclimate.com/github/nsweeting/qpush)
+
+Fast and simple job queue microservice for Ruby. **Please consider it under development at the moment.**
+
+QPush provides a scalable solution to your background job processing needs. Its Redis-backed, with support for forking and threading - letting it process an enormous amount of jobs in short order.
+
+As a microservice, QPush is meant to be independent in its operation and deployment. This means that unlike other job processors such as Sidekiq, DelayedJob, etc - QPush does not hook into a web framework. Jobs must therefore be self-sufficent in their operation. This can often lead to better application designs - but also means QPush will have a minimal memory footprint.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qpush'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install job_que
+
+## Usage
+
+Before starting, ensure you have a functioning Redis server available.
+
+#### The Server
+
+In order to process queued jobs, we run the QPush server. This is a separate service beyond your web application (Rails, Sinatra, etc). To start the server simply type the following in your console.
+
+    $ bundle exec qpush-server -c path/to/config.rb
+
+By providing a path to a configuration file, we can setup QPush with plain old ruby. At a minimum, we should provide details on our Redis server and connections. There are more configuration options available - all of which can be viewed here (to come).
+
+```ruby
+# QPush server configuration
+QPush.configure do |config|
+  # Your redis server url and number of connections to provide
+  config.redis_url = ENV['REDIS_URL']
+  config.redis_pool = 10
+end
+```
+
+Once the QPush server is running, it will begin processing any queued jobs based on priority.
+
+#### The Client
+
+Before we can add jobs to our server, we must first ensure our client has the same connection to our Redis server. We can setup our configuration in the same manner as above.
+
+```ruby
+require 'qpush'
+
+# QPush client configuration
+QPush.configure do |config|
+  # Your redis server url and number of connections to provide
+  config.redis_url = ENV['REDIS_URL']
+  config.redis_pool = 10
+end
+```
+
+With our client setup, we can now queue jobs on our QPush server. All we have to do is:
+
+```ruby
+QPush.job(klass: 'Example::Job', args: { example: 'Job' })
+```
+
+The job above would be equivalent to running the following command on the server.
+
+```ruby
+Example::Job.new(example: 'Job').call
+```
+
+At a minimum, we must provide the job with a 'klass'. There are many more options that we can provide to the job though - all of which can be viewed here (to come).
+
+#### Building Jobs
+
+Jobs are simply plain old ruby objects that contain a 'call' method. If you provide a hash for the 'args' of the job, the job will be initialized with them. Below is an example of a simple mailing job utilizing the 'mail' gem.
+
+```ruby
+require 'mail'
+
+class MailJob
+  def initialize(options = {})
+    @mail = Mail.new(options)
+  end
+
+  def call
+    @mail.deliver
+  end
+end
+```
+
+From our client, we could then queue a mail job with the following:
+
+```ruby
+mail_options = { to: 'person@example.com', from: 'admin@test.com', subject: 'Hello!', body: 'From MailJob' }
+QPush.job(klass: 'MailJob', args: mail_options)
+```
+
+#### Failed Jobs
+
+Jobs that raise an error will be sent to the retry queue. As a default, they are set to attempt a maximum of 10 retries. Each failed attempt creates a longer delay for subsequent attempts. The job will permanently fail once the max retries has been hit.
+
+#### Cron Jobs
+
+QPush supports cron jobs. All you have to do is include a cron expression with your job. For example, the following would perform our job everyday at 4AM UTC.
+
+```ruby
+QPush.job(klass: 'Example::Job', args: { example: 'Job' }, cron: '0 4 * * *')
+```
+
+#### Relational Databases
+
+Although QPush is designed to independent in its operation, it still provides access to relational databases via Sequel. You can read more about [how to use Sequel here](https://github.com/jeremyevans/sequel). Suffice to say, its quite easy. We first will need to add the required information to our configuration:
+
+```ruby
+# You must remember to require the gem for whatever database you will be using.
+require 'pg'
+
+# QPush database configuration
+QPush.configure do |config|
+  # Redis and additional config omitted
+  # ....
+  # ....
+  # Your database server url and number of connections to provide
+  config.database_url = ENV['DATABASE_URL']
+  config.database_pool = 10
+end
+```
+
+We can then access the database from any job. For example, we could retrieve all of our users with the following:
+
+```ruby
+  QPush.db[:users].all
+```
+It is recommended that you read up on Sequel before use.
+
+## 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]/job_que. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'qpush/server'
+require 'qpush/web'
+
+# 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/qpush-server

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'qpush/server'
+
+server = QPush::Server::Launcher.new(ARGV)
+server.start

data/bin/qpush-web

@@ -0,0 +1 @@
+exec( "bundle exec rackup lib/qpush/web/server.ru" )

data/bin/setup

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

data/lib/qpush.rb

@@ -0,0 +1,2 @@
+# Base
+require 'qpush/base'

data/lib/qpush/base.rb

@@ -0,0 +1,12 @@
+# Base
+# require 'byebug'
+require 'securerandom'
+require 'json'
+require 'redis'
+require 'connection_pool'
+require 'qpush/config'
+require 'qpush/job'
+require 'qpush/redis'
+require 'qpush/version'
+
+require 'qpush/jobs/test_job'

data/lib/qpush/config.rb

@@ -0,0 +1,70 @@
+module QPush
+  class << self
+    def configure
+      reset
+      yield(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def reset
+      @config = nil
+      @connection_pool = nil
+    end
+  end
+
+  class Config
+    DEFAULTS = {
+      redis_url: ENV['REDIS_URL'],
+      database_url: ENV['DATABASE_URL'],
+      redis_pool: 10,
+      database_pool: 10,
+      workers: 2,
+      stats_namespace: 'qpush:v1:stats',
+      queue_threads: 2,
+      queue_namespace: 'qpush:v1:queue',
+      perform_threads: 2,
+      perform_namespace: 'qpush:v1:perform',
+      delay_threads:1,
+      delay_namespace: 'qpush:v1:delay',
+      priorities: 5
+    }.freeze
+
+    attr_accessor :workers, :queue_threads, :queue_namespace, :delay_threads,
+                  :delay_namespace, :perform_threads, :perform_namespace,
+                  :stats_namespace, :redis_url, :redis_pool, :priorities,
+                  :database_url, :database_pool, :database_adapter
+
+    def initialize
+      DEFAULTS.each { |key, value| send("#{key}=", value) }
+    end
+
+    def worker_options
+      {
+        perform_threads: perform_threads,
+        queue_threads: queue_threads,
+        delay_threads: delay_threads
+      }
+    end
+
+    def manager_options
+      {
+        workers: workers,
+        options: worker_options
+      }
+    end
+
+    def redis
+      {
+        size: redis_pool,
+        url: redis_url
+      }
+    end
+
+    def perform_lists
+      (1..priorities).collect { |num| "#{perform_namespace}:#{num}" }
+    end
+  end
+end