asynr 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af65e3652194e677bf1e61997ad7e279a90f43922c0d0c55df91a104975fa94f
+  data.tar.gz: 890b147fb197d9d5926b2cf6f88afd1d9f3f50df672e27c06723069de9b19b10
+SHA512:
+  metadata.gz: fb32e46c307a524d5376ce25a26458bde2c448952dee08efe94498116e3b32ea2c03d3572e7fb6ed125a3916938f77a16845a965f280d55adb1de6c1f8420b99
+  data.tar.gz: 40262c7d19e54bdaf196894c591d401585ccf0441bf014176886097ce7dadaaf29ae16cb0a8d8d452aee1a61295cd10ce87734728b603760b56211c5a18e4e1a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vendor/
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

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 gfrancois@online.net. 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 asynr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    asynr (1.0.1)
+      rufus-scheduler (~> 3.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    et-orbi (1.2.2)
+      tzinfo
+    fugit (1.3.3)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.1)
+    raabro (1.1.6)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rufus-scheduler (3.6.0)
+      fugit (~> 1.1, >= 1.1.6)
+    tzinfo (2.0.0)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  asynr!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rufus-scheduler
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Gautier François
+
+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,115 @@
+# Asynr
+
+A Ruby async scheduler based-upon Rufus::Scheduler gem.
+
+# How to install
+
+```bash
+$ gem install asynr
+$ echo "gem 'asynr'" >> Gemfile
+$  bundle install
+``` 
+
+# How to use
+
+## Minimal setup
+
+Asynr needs to know which class to be evaluated and scheduled. Require any class file before launching it.
+
+```ruby
+require "asynr"
+require_relative "./random_lib_with_class"
+...
+```
+
+## Add a new job
+
+Jobs are minimal, since all Rufus methods aren't intented to be implemented. Here are the four parameters currently supported by Asynr.
+
+* name: each job has a name which can be used to remove the concerned job.
+* action: is the evaluated class name. Async will search for a run method inside of this class.
+* first_in: directly taken from Rufus, time before the action starts.
+* every: time between two class executions.
+
+## Remove a job
+
+Jobs can be removed dynamically with their name: 
+
+```ruby
+...
+inst.job(name: :Test, action: :RandomTest, every: 10, first_in: 0)
+inst.queue.length # 1
+inst.remove :Test
+inst.queue.length # 0
+...
+```
+
+## Start all jobs
+
+Once launched, a new job cannot be defined and added. We need to set all the jobs and related timers before starting the scheduler.
+
+```ruby
+require "asynr"
+
+inst = Asynr.new
+inst.job(name: :Test, action: RandomTest, every: 10, first_in: 0)
+inst.job(name: :Again, action: AnotherTest, every: 3, first_in: 1)
+inst.queue.length # 2
+
+inst.start!
+```
+
+# Working example 
+
+Since the logic behind it may confuse you regarding the class evaluation, here's a working example of how to use Asynr. Minimal yet functionnal.
+\
+This example will save a HTTP request launched every 60 seconds, for ever (until it is stopped).
+
+```ruby
+require "asynr"
+require "typhoeus"
+
+class JSONFetcher
+    def self.run
+        res = Typhoeus::Request.get("https://httpbin.org/get")
+        f = File.open "./http_bin_get.log", "a+"
+        f.puts res.body
+    end
+end
+
+inst = Asynr.new
+inst.job(name: :JSONFetcher, action: JSONFetcher, first_in: 1, every: 60)
+inst.start!
+```
+
+## Optional architecture
+
+With the previous example, we saw how Asynr works, but its initial goal is to allow us to create easy-to-develop softwares with integrated scheduler, such as API aggregator, or middlewares.
+\
+Here's a software architecture that works.
+
+```
+Gemfile
+scheduler.rb
+worker/
+    - download_first_file.rb
+    - download_second_file.rb
+    - download_third_file.rb
+lib/
+    - dependency.rb
+```
+
+Asynr can easily handle all these executions every 60 seconds, for example.
+\
+Into scheduler.rb : 
+```ruby
+require "asynr"
+Dir.glob(Dir.pwd + "/worker/*.rb").each &method(:require)
+
+asynr = Asynr.new
+asynr.job(name: :firstFile, action: DownloadFirstFile, first_in: 0, every: 60)
+asynr.job(name: :secondFile, action: DownloadSecondFile, first_in: 0, every: 60)
+asynr.job(name: :thirFile, action: DownloadThirdFile, first_in: 0, every: 60)
+
+asynr.start!
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/asynr.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "asynr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "asynr"
+  spec.version       = Asynr::VERSION
+  spec.authors       = ["Atille"]
+  spec.email         = ["gfrancoisfrancois@outlook.com"]
+
+  spec.summary       = %q{Async job planner based upon Rufus scheduler}
+  spec.description   = %q{Async job planner based upon Rufus scheduler Ruby gem and threads, with history and states.}
+  spec.homepage      = "https://rubygems.org/gems/asynr"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/atilleh/async"
+  spec.metadata["changelog_uri"] = "https://github.com/atilleh/async"
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rufus-scheduler"
+
+  spec.add_runtime_dependency 'rufus-scheduler', '~> 3.6.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "asynr"
+
+# 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/asynr/core.rb

@@ -0,0 +1,52 @@
+require "rufus-scheduler"
+
+module Asynr
+  # Main gem class
+  class Core
+    # Creates a new Rufus Scheduler and waits to 
+    # populate the local queue.
+    # This local queue is gonna be converted into a 
+    # rufus queue.
+    def initialize(params={})
+      @params = params
+      @local_queue = []
+      @queue = Rufus::Scheduler.new
+    end
+
+    # @return .local_queue [Array] already registered but unlaunched jobs.
+    def queue
+      @local_queue
+    end
+
+    # Create a new job
+    # @see Job.new
+    # @return job [Object] newly created job object.
+    def job(options={})
+      job = Asynr::Job.new(options)
+      @local_queue.append job
+      job
+    end
+
+    # Removes a job from the local queue.
+    # Useless if the queue has already been converted by .dispatch!
+    # @see dispatch!
+    def remove(name)
+      @local_queue.delete_if {|i| i.name == name}
+    end
+
+    # Converts the local_queue to rufus queue
+    # execute it.
+    def start!
+      dispatch!
+      @queue.join
+    end
+
+    # dispatch! converts local queue to rufus every object queue.
+    protected
+    def dispatch!
+      @local_queue.each do |job|
+        @queue.every job.every, first_in: job.first_in do job.action.send(:run) ; end
+      end
+    end				
+  end
+end

data/lib/asynr/job.rb

@@ -0,0 +1,31 @@
+module Asynr
+  
+  # Class for job initialization
+  class Job
+    # Creates a new job instance, returned to Core library.
+    # @param options [Hash] job options before start! call
+    # @return nil
+    def initialize(options={first_in: 60, every: 60})
+      @options = options
+    end
+
+    # Setter/Getter of name option.
+    def name ; @options[:name] ; end
+    # @param name [Symbol] job short name
+    def name=(name) ; @options[:name] = name ; end
+    
+    def action ; @options[:action] ; end
+    # @param action [Class] class instance to evaluate
+    def action=(action) ; @options[:action] = action ; end
+
+    # Time to wait before running a job twice
+    def every ; @options[:every] ; end
+    # @param every [Int] amount of seconds
+    def every=(every) ; @options[:every] = every ; end
+
+    # Time to wait before starting the first job occurence
+    def first_in ; @options[:first_in] ; end
+    # @param first_in [Int] amount of seconds
+    def first_in=(first_in) ; @options[:first_in] = first_in ; end
+  end
+end

data/lib/asynr/version.rb

@@ -0,0 +1,3 @@
+module Asynr
+  VERSION = "1.0.1"
+end

data/lib/asynr.rb

@@ -0,0 +1,18 @@
+require "asynr/version"
+require "asynr/core"
+require "asynr/job"
+
+module Asynr
+
+  # Shortcut returning Core object
+  # Will be called with Asynr.new instead of 
+  # Asynr::Core.new
+  #
+  # @param params [Hash] defaults options
+  # @return self [Object] self from Asynr::Core
+  def self.new(params={})
+    Asynr::Core.new(params)
+  end
+
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: asynr
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Atille
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  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: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: Async job planner based upon Rufus scheduler Ruby gem and threads, with
+  history and states.
+email:
+- gfrancoisfrancois@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- asynr.gemspec
+- bin/console
+- bin/setup
+- lib/asynr.rb
+- lib/asynr/core.rb
+- lib/asynr/job.rb
+- lib/asynr/version.rb
+homepage: https://rubygems.org/gems/asynr
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/asynr
+  source_code_uri: https://github.com/atilleh/async
+  changelog_uri: https://github.com/atilleh/async
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Async job planner based upon Rufus scheduler
+test_files: []