qpush 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c81c28b25016af05e8ab1560015b659c073fb19a
-  data.tar.gz: 8e08d686417972044dc952001bd521bdf3a1b700
+  metadata.gz: 30fcd80a97393fd4b5d20192e0f90b6b44865eb8
+  data.tar.gz: fd5f9ac7220513fb70bd722725e5c7e72fa2ceb3
 SHA512:
-  metadata.gz: 90b802ddd706fd24e326e15b1fa4ca4a9a7578dcd87c10512fea84e148b8506b8a34f17b30be996ce9c122dfe4ed95b1ec785a54c5e4e6d5194c49b853f262b1
-  data.tar.gz: 69302a4491443410a50827ea88b50a3070917c6c108d515eb9ebd3afa2702d33f2f3f549ca9ee688f337c2f862db814ba1c09d7d0de9f36ab5423353b4a88a6b
+  metadata.gz: f3c877c1e9e2412d7529d414f6c3282c560ef40f016ea4b293d54cc3485acd6921c980bf92fd1a4e4f8a07278bbe2406fafa18080c39847956164e8f412863e4
+  data.tar.gz: 9fd65ca2be6e3d24641781a02f04d4c53fba13890430d24286a7383e71a55a78c9ee8ba9bd0111aa5f2a76809cce065d280f0df9577af38303af45941a90b797

data/.byebug_history

@@ -1,4 +1,47 @@
 c
+self.config
+config
+Server.config
+c
+Server.config
+c
+QPush::Server.config
+c
+QPush::Server.config
+c
+job.perform
+job = Job.new(JSON.parse(json))
+json
+c
+delays.count
+delays.any?
+delays
+@conn
+c
+valid?
+c
+configs
+c
+configs
+c
+valid?
+config
+c
+valid?
+@configs
+configs
+c
+configs ? true : false
+configs
+c
+valid?
+quit
+job.klass
+job.errors
+job.valid?
+c
+jobs
+c
 request.path_info
 c
 hash

data/README.md

@@ -37,7 +37,7 @@ By providing a path to a configuration file, we can setup QPush with plain old r
 
 ```ruby
 # QPush server configuration
-QPush.configure do |config|
+QPush::Server.configure do |config|
   # Your redis server url and number of connections to provide
   config.redis_url = ENV['REDIS_URL']
   config.redis_pool = 10
@@ -48,13 +48,13 @@ Once the QPush server is running, it will begin processing any queued jobs based
 
 #### 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.
+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 a similar manner as above.
 
 ```ruby
 require 'qpush'
 
 # QPush client configuration
-QPush.configure do |config|
+QPush::Client.configure do |config|
   # Your redis server url and number of connections to provide
   config.redis_url = ENV['REDIS_URL']
   config.redis_pool = 10
@@ -121,7 +121,7 @@ Although QPush is designed to independent in its operation, it still provides ac
 require 'pg'
 
 # QPush database configuration
-QPush.configure do |config|
+QPush::Server.configure do |config|
   # Redis and additional config omitted
   # ....
   # ....

data/bin/console

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require 'qpush/client'
 require 'qpush/server'
 require 'qpush/web'
 

data/jobs/fail_job.rb

@@ -1,5 +1,5 @@
 class FailJob
-  include QPush::Job
+  include QPush::Server::JobRegister
 
   def initialize(options)
     @option = options

data/jobs/test_job.rb

@@ -1,5 +1,5 @@
 class TestJob
-  include QPush::Job
+  include QPush::Server::JobRegister
 
   def call
     puts 'Hello from TestJob'

data/lib/qpush.rb

@@ -1,2 +1,2 @@
-# Base
-require 'qpush/base'
+# QPush Client Base
+require 'qpush/client'

data/lib/qpush/base.rb

@@ -1,10 +1,12 @@
-# Base
-# require 'byebug'
+# External
+require 'byebug'
 require 'securerandom'
 require 'json'
 require 'redis'
 require 'connection_pool'
-require 'qpush/config'
-require 'qpush/job'
-require 'qpush/redis'
+
+# QPush Base
 require 'qpush/version'
+require 'qpush/base/config'
+require 'qpush/base/job'
+require 'qpush/base/redis'

data/lib/qpush/base/config.rb

@@ -0,0 +1,41 @@
+module QPush
+  module Base
+    module ConfigHelper
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def configure
+          reset
+          yield(config)
+        end
+
+        def reset_
+          @config = nil
+          @redis_pool = nil
+        end
+      end
+    end
+
+    class Config
+      DEFAULTS = {
+        redis_url: ENV['REDIS_URL'],
+        redis_pool: 10
+      }.freeze
+
+      attr_accessor :redis_url, :redis_pool
+
+      def initialize
+        DEFAULTS.each { |key, value| send("#{key}=", value) }
+      end
+
+      def redis
+        {
+          size: redis_pool,
+          url: redis_url
+        }
+      end
+    end
+  end
+end

data/lib/qpush/{job.rb → base/job.rb}

@@ -1,23 +1,13 @@
 module QPush
   class << self
     def job(options)
-      job = Job::ClientWrapper.new(options)
+      job = Client::Job.new(options)
       job.queue
     end
   end
 
-  module Job
-    class << self
-      def included(base)
-        _register_job(base)
-      end
-
-      def _register_job(base)
-        QPush.redis.with { |c| c.sadd(QPush.keys.jobs, base.name) }
-      end
-    end
-
-    class Base
+  module Base
+    class Job
       attr_accessor :klass, :id, :priority, :created_at, :start_at,
                     :cron, :retry_max, :total_success, :total_fail,
                     :run_time, :namespace
@@ -68,16 +58,7 @@ module QPush
           total_fail: 0,
           total_success: 0,
           failed: false,
-          namespace: QPush.config.namespace }
-      end
-    end
-
-    class ClientWrapper < QPush::Job::Base
-      def queue
-        QPush.redis.with do |conn|
-          conn.hincrby("qpush:v1:#{@namespace}:stats", 'queued', 1)
-          conn.lpush("qpush:v1:#{@namespace}:queue", to_json)
-        end
+          namespace: 'default' }
       end
     end
   end

data/lib/qpush/base/redis.rb

@@ -0,0 +1,13 @@
+module QPush
+  module Base
+    KEY = 'qpush:v1'.freeze
+
+    class RedisPool
+      def self.create(pool, url)
+        ::ConnectionPool.new(size: pool) do
+          ::Redis.new(url: url)
+        end
+      end
+    end
+  end
+end

data/lib/qpush/client.rb

@@ -0,0 +1,7 @@
+# QPush Base
+require 'qpush/base'
+
+# Qpush Client Base
+require 'qpush/client/config'
+require 'qpush/client/job'
+require 'qpush/client/redis'

data/lib/qpush/client/config.rb

@@ -0,0 +1,13 @@
+module QPush
+  module Client
+    include QPush::Base::ConfigHelper
+
+    class << self
+      def config
+        @config ||= Config.new
+      end
+    end
+
+    class Config < QPush::Base::Config; end
+  end
+end

data/lib/qpush/client/job.rb

@@ -0,0 +1,12 @@
+module QPush
+  module Client
+    class Job < QPush::Base::Job
+      def queue
+        Client.redis do |conn|
+          conn.hincrby("#{QPush::Base::KEY}:#{@namespace}:stats", 'queued', 1)
+          conn.lpush("#{QPush::Base::KEY}:#{@namespace}:queue", to_json)
+        end
+      end
+    end
+  end
+end

data/lib/qpush/client/redis.rb

@@ -0,0 +1,16 @@
+module QPush
+  module Client
+    class << self
+      def redis
+        redis_pool.with do |conn|
+          yield conn
+        end
+      end
+
+      def redis_pool
+        @redis_pool ||= QPush::Base::RedisPool.create(Client.config.redis_pool,
+                                                      Client.config.redis_url)
+      end
+    end
+  end
+end

data/lib/qpush/jobs/queue_delayed.rb

@@ -1,8 +1,6 @@
 module QPush
   module Jobs
     class QueueDelayed
-      include QPush::Job
-
       attr_accessor :id, :score
 
       def initialize(options)

data/lib/qpush/server.rb

@@ -1,13 +1,15 @@
-# Base
-require 'qpush/base'
-
-# Server Base
-require 'byebug'
+# External
 require 'sequel'
 require 'object_validator'
 require 'parse-cron'
 require 'forwardable'
+
+# QPush Base
+require 'qpush/base'
+
+# Qpush Server Base
 require 'qpush/server/apis'
+require 'qpush/server/config'
 require 'qpush/server/database'
 require 'qpush/server/delay'
 require 'qpush/server/errors'
@@ -19,9 +21,10 @@ require 'qpush/server/logger'
 require 'qpush/server/manager'
 require 'qpush/server/perform'
 require 'qpush/server/queue'
+require 'qpush/server/redis'
 require 'qpush/server/worker'
 
-# Server Apis
+# QPush Server Apis
 require 'qpush/server/apis/delay'
 require 'qpush/server/apis/execute'
 require 'qpush/server/apis/fail'
@@ -32,5 +35,5 @@ require 'qpush/server/apis/morgue'
 require 'qpush/server/apis/setup'
 require 'qpush/server/apis/success'
 
-# Base Jobs
+# QPush Base Jobs
 require 'qpush/jobs/queue_delayed'

data/lib/qpush/server/apis.rb

@@ -1,14 +1,24 @@
 module QPush
   module Server
     module Apis
+      # A Base class for all API classes.
+      #
       class Base
         def self.call(*args)
           api = new(*args)
           api.call
         end
+
+        def initialize(job)
+          @job = job
+        end
       end
     end
 
+    # The ApiWrapper provides simple wrapper functions for all the API
+    # classes available for jobs. This provides a single entry point to
+    # the API's for job objects.
+    #
     class ApiWrapper
       def initialize(job)
         @job = job

data/lib/qpush/server/apis/delay.rb

@@ -1,6 +1,8 @@
 module QPush
   module Server
     module Apis
+      # The Delay API will take a job and add it to the delay sorted set.
+      #
       class Delay < Base
         def initialize(job, type)
           @job = job
@@ -15,9 +17,9 @@ module QPush
         private
 
         def delay_job
-          QPush.redis.with do |conn|
-            conn.hincrby(QPush.keys.stats, @stat, 1)
-            conn.zadd(QPush.keys.delay, @time, @job.to_json)
+          Server.redis do |conn|
+            conn.hincrby(Server.keys.stats, @stat, 1)
+            conn.zadd(Server.keys.delay, @time, @job.to_json)
           end
         end
 

data/lib/qpush/server/apis/execute.rb

@@ -2,10 +2,6 @@ module QPush
   module Server
     module Apis
       class Execute < Base
-        def initialize(job)
-          @job = job
-        end
-
         def call
           measure_run_time { job_object.call }
           Success.call(@job)

data/lib/qpush/server/apis/fail.rb

@@ -23,11 +23,11 @@ module QPush
         end
 
         def stat_increment
-          QPush.redis.with { |c| c.hincrby(QPush.keys.stats, 'failed', 1) }
+          Server.redis { |c| c.hincrby(Server.keys.stats, 'failed', 1) }
         end
 
         def log_error
-          Server.log.err("Job FAILED | #{@job.klass} | #{@job.id} | #{@error.message}")
+          Server.log.err("Worker #{Server.worker.id} | Job FAILED | #{@job.klass} | #{@job.id} | #{@error.message}")
         end
 
         def update_history

data/lib/qpush/server/apis/history.rb

@@ -17,9 +17,9 @@ module QPush
         private
 
         def update_history
-          QPush.redis.with do |c|
-            c.lpush(QPush.keys.history, to_json)
-            c.ltrim(QPush.keys.history, 0, 10)
+          Server.redis do |c|
+            c.lpush(Server.keys.history, to_json)
+            c.ltrim(Server.keys.history, 0, 10)
           end
         end