antelopes 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e88bf96f54206dbee16ac32a93408d5e228d948c
-  data.tar.gz: f336c55853631cff7ee6440e091b87100ebc6402
+  metadata.gz: 7995a53cb70eeafa32ec80a194bf59ad2bf7ded9
+  data.tar.gz: 5927101da8a299a0c49a62001f0d6d8e6e504404
 SHA512:
-  metadata.gz: 426d2a3f03e65a6690e769e0a186173772c48ad302e4149f8b343a1064ec34ecd127b4097f5607aed37b1d257a67e48ee734c2e1950603de69719313076f7b5f
-  data.tar.gz: 2fce0e2754ddf088687c98758c64e07d0d9bdae16c012b6fa4d6e3a3a0acb91e824cb60e0c8c13ba646bf83e609b36530fac1da709f82f15e460f5ad2ca0ce89
+  metadata.gz: d7e22f5ed0604eaa6bcbec7a3336512886006beab1936c1ec151649b93dd316d29e0a827a19b8a6db0bc7a6f1c1a6ab9bee4ebf9229cb71ebfc333590141beba
+  data.tar.gz: fe7732547d156e4e49e57516af1f06628db68d767dfe2f7f31f28635983d107a3339e41eea726ded1744e0bd1b1227077ebd6279f25943323fbc555a15cc5cf8

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Antelopes
+
+Smart and agile workers.
+
+## v0.0.2 - 2017-04-20
+
+### Fixed
+
+* [Marion Duprey] Fixed gem packaging
+
+## v0.0.1 - 2017-04-20
+
+### Added
+
+* [Marion Duprey] Add basic push/pull queue system

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+# Antelopes
+
+This project endgoal is to be a clean and framework-agnostic background jobs worker system,
+primilary focused on batches.
+
+This project is all new and has not yet reached a stable state.
+
+## Contributing
+
+* Fork it ( https://github.com/titeiko/antelopes/fork )
+* Create your feature branch (git checkout -b my-new-feature)
+* Commit your changes (git commit -am 'Add some feature')
+* Push to the branch (git push origin my-new-feature)
+* Create a new Pull Request
+
+## Development Requirements
+
+* Ruby 2.3+
+* Bundler
+* Redis 3+
+
+## Testing
+
+```
+bundle exec rake
+```
+
+## Versioning
+
+Antelopes uses Semantic Versioning 2.0.0

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test'
+  t.warning = false
+end
+
+task default: :test

data/antelopes.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'antelopes'
+  s.version     = '0.0.2'
+  s.summary     = 'Nice and smart background jobs'
+  s.authors     = ['Marion Duprey']
+  s.email       = 'titeiko@gmail.com'
+  s.files       = `git ls-files | grep -Ev '^(bin|test)'`.split("\n")
+  s.homepage    = 'https://github.com/titeiko/antelopes'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3'
+
+  s.add_runtime_dependency 'connection_pool', '~> 2'
+  s.add_runtime_dependency 'redis', '~> 3'
+  s.add_runtime_dependency 'serverengine', '~> 2'
+
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'minitest-reporters', '~> 1'
+  s.add_development_dependency 'rake', '~> 12'
+  s.add_development_dependency 'pry', '~> 0'
+end

data/lib/antelopes/job.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Antelopes
+  # Job object representation
+  #
+  # @since 0.0.1
+  class Job
+    # @!attribute [r] jid
+    #   @return [String] the uuid of the job
+    # @!attribute [r] job_class
+    #   @return [String] the class name of the job to run
+    # @!attribute [r] job_method
+    #   @return [Symbol] the instance method to execute. nil if job_class_method is set
+    # @!attribute [r] job_class_method
+    #   @return [Symbol] the class method to execute. nil if job_method is set
+    # @!attribute [r] job_args
+    #   @return [Hash] arguments for the job (class) method
+    attr_reader :jid, :job_class, :job_method, :job_class_method, :job_args
+
+    # Initialization from json hash
+    #
+    # @param json_payload [Hash] deserialized JSON hash
+    # @return [Job] a Job
+    def initialize(json_payload)
+      @jid = json_payload['jid']
+      setup_job_attrs(json_payload['job'])
+    end
+
+    private
+
+    def setup_job_attrs(json_payload)
+      @job_class = json_payload['class']
+      @job_method = json_payload['method']&.to_sym
+      @job_class_method = json_payload['class_method']&.to_sym
+      setup_job_args(json_payload['args'])
+    end
+
+    def setup_job_args(args)
+      @job_args = Hash[args.map { |k, v| [k.to_sym, v] }]
+    end
+  end
+end

data/lib/antelopes/looper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Antelopes
+  # ServerEngine looper.
+  # It has two ways of working: either as a simple worker or
+  # as a manager.
+  # This class should not be used directly by Antelopes users.
+  #
+  # @since 0.0.1
+  # @private
+  module Looper
+    # Method called by {https://github.com/treasure-data/serverengine ServerEngine}
+    # that loops until stopped.
+    #
+    # @since 0.0.1
+    def run
+      logger.info 'Looper started'
+      @runner = Worker.new(logger: logger)
+      @runner.run until @stop
+    end
+
+    # Method called by {https://github.com/treasure-data/serverengine ServerEngine}
+    # to stop the worker when the service receives a signal to stop or restart.
+    #
+    # @since 0.0.1
+    def stop
+      logger.info 'Looper shutting down'
+      @stop = true
+    end
+  end
+end

data/lib/antelopes/master.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Antelopes
+  # ServerEngine master.
+  # Its job is to create a connection pool towards Redis and
+  # share it with the loopers.
+  # This class should not be used directly by Antelopes users.
+  #
+  # @since 0.0.1
+  # @private
+  module Master
+    # @!attribute [r] redis
+    #   @return [ConnectionPool] the a redis connection pool
+    attr_reader :redis
+
+    # Method called by ServerEngine before starting the workers.
+    # It initialize the redis connection pool used by the Loopers.
+    #
+    # @since 0.0.1
+    def before_run
+      logger.info 'Master starting'
+      @redis = ConnectionPool.new(size: 5, timeout: 3) { Antelopes::Redis.new.connection }
+    end
+
+    # Method called by ServerEngine before shutting down
+    #
+    # @since 0.0.1
+    def after_run
+      logger.info 'Master shutting down'
+      @redis.shutdown(&:quit)
+    end
+  end
+end

data/lib/antelopes/puller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Antelopes
+  # Class used to pull jobs
+  # This should not be used directly by Antelopes users.
+  #
+  # @since 0.0.1
+  # @private
+  class Puller
+    # Initialization
+    #
+    # @param logger [ServerEngine::DaemonLogger] a logger
+    # @param redis [Redis] a {https://github.com/redis/redis-rb redis} connection
+    def initialize(logger: nil, redis: nil)
+      @logger = logger || ServerEngine::DaemonLogger.new($stdout)
+      @redis = redis || Antelopes::Redis.new.connection
+    end
+
+    # Method used by the workers to get a job to work on.
+    # When the job is started, it goes in the 'doing' list.
+    #
+    # @return [Hash] the job
+    def next_todo
+      jid = redis.brpoplpush('antelopes:todo', 'antelopes:doing', timeout: 1)
+
+      return if jid.nil?
+      Job.new(JSON.parse(redis.get("antelopes:job:#{jid}")))
+    end
+
+    private
+
+    attr_reader :redis, :logger
+  end
+end

data/lib/antelopes/pusher.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Antelopes
+  # Class used to push jobs in the todo queue
+  # This should not be used directly by Antelopes users.
+  #
+  # @since 0.0.1
+  # @private
+  class Pusher
+    # Initialization
+    #
+    # @param logger [ServerEngine::DaemonLogger] a logger
+    # @param redis [Redis] a {https://github.com/redis/redis-rb redis} connection
+    def initialize(logger: nil, redis: nil)
+      @logger = logger || ServerEngine::DaemonLogger.new($stdout)
+      @redis = redis || Antelopes::Redis.new.connection
+    end
+
+    # Mechod that actually adds the job to queue
+    #
+    # @example Enqueing a job
+    #   result = Antelopes::Pusher.new.call(
+    #     job: Hash[class: 'MyClass', method: 'call', args: Hash[foo: 'bar']]
+    #   )
+    #   result.jid
+    #
+    # @param job_params [Hash] parameters of the job
+    # @return [OpenStruct] response object
+    def call(job_params)
+      @result = OpenStruct.new(jid: SecureRandom.uuid)
+
+      redis.set("antelopes:job:#{@result.jid}", JSON.generate(job_params.merge(jid: @result.jid)))
+      redis.lpush('antelopes:todo', @result.jid)
+
+      logger.info "Pushed #{@result.jid} - #{job_params}"
+
+      @result
+    end
+
+    private
+
+    attr_reader :redis, :logger
+  end
+end

data/lib/antelopes/redis.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Antelopes
+  # Class used to generate a Redis connection
+  #
+  # @since 0.0.1
+  class Redis
+    # Retrieve a Redis connection
+    #
+    # @todo Make it configurable
+    # @return [::Redis] a {https://github.com/redis/redis-rb Redis} connection
+    def connection
+      ::Redis.new
+    end
+  end
+end

data/lib/antelopes/worker.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Antelopes
+  # Basic worker that pulls a job, runs it, reports and repeats.
+  #
+  # @since 0.0.1
+  # @private
+  class Worker
+    # Worker initialization.
+    #
+    # @param logger [ServerEngine::DaemonLogger] a logger
+    # @param puller
+    def initialize(logger: ServerEngine::DaemonLogger.new($stdout), puller:)
+      @logger = logger
+      @puller = puller
+    end
+
+    # Method called by the looper at every loop.
+    #
+    # @since 0.0.1
+    def run
+      job = puller.pull
+      return if job.nil?
+
+      klass = Object.const_get(job.job_class)
+      if job.job_method.nil?
+        klass.public_send(job.job_class_method, **job.job_args)
+      else
+        klass.new.public_send(job.job_method, **job.job_args)
+      end
+    end
+
+    private
+
+    attr_reader :logger, :puller
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: antelopes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Marion Duprey
@@ -56,56 +56,56 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: pry
   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: 
@@ -114,7 +114,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- antelopes.gemspec
 - lib/antelopes.rb
+- lib/antelopes/job.rb
+- lib/antelopes/looper.rb
+- lib/antelopes/master.rb
+- lib/antelopes/puller.rb
+- lib/antelopes/pusher.rb
+- lib/antelopes/redis.rb
+- lib/antelopes/worker.rb
 homepage: https://github.com/titeiko/antelopes
 licenses:
 - MIT