schdlr 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1506ee367d1d772e51927a4562d6488f0db243262a749f39e7d6db35f9062425
+  data.tar.gz: 7f77828130b16f8de2d761057e289ac218bf0f70da20b9fba5d2c4ec08fd6c54
+SHA512:
+  metadata.gz: 7bd5dbef728b689e83f999b1ad97c8a3484b900af1e12588b84fbc4738c47486b1ba27754a45ae34bb27a4572050a3b9f61e981c9131f805a85b522fbc840c52
+  data.tar.gz: 56b084f3f704d7a085ea9339506f68a63094b8fe4a18103464dd8249b3ec8c21ad2cd7c91bdc1da566fadebae0839b89f471d3304557b493a2577fbce6454869

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at devsfutter@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in schdlr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    schdlr (0.1.0)
+      concurrent-ruby (~> 1.1.4)
+      sqlite3 (~> 1.3.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.4)
+    minitest (5.11.3)
+    rake (10.5.0)
+    sqlite3 (1.3.13)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  schdlr!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Devsfutter
+
+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,71 @@
+# Schdlr
+
+A minimal library for scheduling jobs for later execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schdlr', git: 'https://github.com/devsfutter/schdlr.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+
+class Job < Schdlr::Job
+    attr_accessor :id
+    def perform
+        puts "#{Time.now}: Job2 doing something with id: ##{id}"
+        return true
+    end
+end
+
+class JobThatFail < Schdlr::Job
+    attr_accessor :id
+    def perform
+        puts "#{Time.now}: JobThatFail doing something with id: ##{id}"
+        fail!('missing argument :id') if id.nil?
+    end
+end
+
+@queue = Schdlr::Queue::Sqlite.new
+@schhlr = Schdlr.new(@queue)
+
+job1 = Job.new(id: '12344')
+job2 = JobThatFail.new
+
+@schhlr.now(job1) #=> schhlr.at(Time.now, job1)
+at_time = Time.new(2019,2,2)
+@schhlr.at(at_time, job2)
+#Start processing queue
+@schhlr.start!
+# => 2019-01-27 13:40:21 +0100: Job2 doing something with id: #12344
+# (time passes by)
+# => 2019-02-02 00:00:00 +0100: JobThatFail doing something with id: #
+#Stop processing queue
+@schhlr.stop!
+
+```
+
+## TODO
+
+- [ ] Failed tasks stays in the queue, they should have a status to avoid retrying failed tasks.
+- [ ] Improve test suite.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/devsfutter/schdlr. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Schdlr project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/devsfutter/schdlr/blob/master/CODE_OF_CONDUCT.md).

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 "schdlr"
+
+# 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(__FILE__)

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/schdlr.rb

@@ -0,0 +1,62 @@
+require 'concurrent-ruby'
+require 'time'
+require "schdlr/version"
+require "schdlr/dispatcher"
+require "schdlr/job"
+require "schdlr/queue/sqlite"
+
+class Schdlr
+  class Error < StandardError; end
+
+  class JobFailed < Error
+    attr_accessor :task, :reason
+    def initialize(task, reason=nil)
+      @task = task
+      @reason = reason
+    end
+  end
+
+  def initialize(queue, **options)
+    @queue = queue
+    @dispatcher = Dispatcher.new
+    execution_interval = options[:interval] || 1
+    timeout_interval = options[:timeout] || 1
+    @timer = Concurrent::TimerTask.new(execution_interval: execution_interval, timeout_interval: timeout_interval) { puts Time.now }
+    @timer.add_observer(self)
+  end
+
+  def start!
+    @timer.execute
+  end
+
+  def stop!
+    @timer.shutdown
+  end
+
+  def at(datetime, task)
+    @queue.set(datetime, task)
+  end
+
+  def now(task)
+    at(Time.now, task)
+  end
+
+  def task_update(time, result, ex)
+    if ex
+      id, _, _, _ = *ex.task
+      @queue.fail(id)
+    else
+      id, _, _, _ = *result
+      @queue.del(id)
+    end
+  end
+
+  def update(time, result, ex)
+    tasks = @queue.tasks(time)
+    tasks.collect do |task_spec|
+      ivar = @dispatcher.async.dispatch(task_spec)
+      ivar.add_observer(self, :task_update)
+      ivar
+    end
+  end
+end

data/lib/schdlr/dispatcher.rb

@@ -0,0 +1,15 @@
+class Schdlr
+  class Dispatcher
+    include Concurrent::Async
+
+    def dispatch(task_spec)
+      _, _, _, task = *task_spec
+      worker = YAML.load(task)
+      worker.perform
+      return task_spec
+    rescue => ex
+      raise JobFailed.new(task_spec, ex.message)
+    end
+
+  end
+end

data/lib/schdlr/job.rb

@@ -0,0 +1,15 @@
+class Schdlr
+  class Job
+
+    def initialize(**args)
+      args.each do |k,v|
+        self.send("#{k}=", v)
+      end
+    end
+
+    def failed!(reason)
+      raise reason.to_s
+    end
+
+  end
+end

data/lib/schdlr/queue/sqlite.rb

@@ -0,0 +1,52 @@
+require "sqlite3"
+require "yaml"
+
+class Schdlr
+  class Queue
+    class Sqlite
+      INITIAL_STATUS = 'queued'
+      FAILED_STATUS = 'failed'
+
+      def initialize(name='test.db')
+        @db = SQLite3::Database.new(name)
+        @db.execute %(
+          create table if not exists tasks (
+            id integer PRIMARY KEY,
+            scheduled_at integer,
+            status varchar(30),
+            name varchar(30)
+          );)
+      end
+
+      def set(timestamp, task_spec)
+        #TODO: should raise if timestamp is not a proper date
+        @db.execute("INSERT INTO tasks (scheduled_at, name, status) VALUES (?, ?, ?)", [timestamp.to_i, task_spec.to_yaml, INITIAL_STATUS])
+      end
+
+      def get(key)
+        @db.execute("SELECT * FROM tasks WHERE id IN (?)", key)
+      end
+
+      def tasks(at_time=nil)
+        if at_time
+          @db.execute("SELECT * FROM tasks WHERE scheduled_at <= ? and status = ?", [at_time.to_i, INITIAL_STATUS])
+        else
+          @db.execute("SELECT * FROM tasks")
+        end
+      end
+
+      def del(*keys)
+        @db.execute("DELETE FROM tasks WHERE id IN (?)", keys)
+      end
+
+      def fail(*keys)
+        @db.execute("UPDATE tasks SET status = '#{FAILED_STATUS}' WHERE id IN (?)", keys)
+      end
+
+      def drop_all!
+        @db.execute("DELETE FROM tasks")
+      end
+
+    end
+  end
+end

data/lib/schdlr/version.rb

@@ -0,0 +1,3 @@
+class Schdlr
+  VERSION = "0.1.1"
+end

data/schdlr.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "schdlr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "schdlr"
+  spec.version       = Schdlr::VERSION
+  spec.authors       = ["Devsfutter"]
+  spec.email         = ["devsfutter@gmail.com"]
+
+  spec.summary       = %q{A minimal job queue for ruby.}
+  spec.description   = %q{Schdlr is a small library that let you store jobs for later exceution.}
+  spec.homepage      = "https://github.com/devsfutter/schdlr"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "https://github.com/devsfutter/schdlr"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sqlite3", "~> 1.3.13"
+  spec.add_dependency "concurrent-ruby", "~> 1.1.4"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: schdlr
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Devsfutter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Schdlr is a small library that let you store jobs for later exceution.
+email:
+- devsfutter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/schdlr.rb
+- lib/schdlr/dispatcher.rb
+- lib/schdlr/job.rb
+- lib/schdlr/queue/sqlite.rb
+- lib/schdlr/version.rb
+- schdlr.gemspec
+homepage: https://github.com/devsfutter/schdlr
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A minimal job queue for ruby.
+test_files: []