jobi 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40d1fc4cc7f08510bb497261a241ad8d8978585926b398c74f7b94d7a574a9df
+  data.tar.gz: 79021f27feb63bc53f9255bde60aa0337d8813b559da8f6e842447dba92c35ae
+SHA512:
+  metadata.gz: 7f2c2c2ff54b42eba6c571f2b37ee27d6aaa3c8840e71a3d7229218cd5bbe9a07e0f95765a1aa13267bc7fab8e5a48323f5e7f0ad25c0363361e434cd72d9972
+  data.tar.gz: a901943b861161481019a0e5b392c02ffb12f83adeaf47ab5d74544f7bbff0de5e04a0b0aa2a0ac9fb0b7223f4888018c1c2681b7d2d23169cd3c8248e9bda02

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+jobi

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [0.1.1] - 2020-08-04
+### Updated
+- Jobi gemspec file. 
+## [0.1.0] - 2020-08-02
+### Added
+- Initial Jobi structure.
+- Support custom configurations include Rabbitmq client configurations.
+- Support Rabbitmq sessions and consumers.
+- Implement unified messsage for data transmission.
+- Implement Job to handle async jobs.
+- Implement Runner to handle the job execution.
+- Allow Jobi to act as publisher or consumer or both.

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 rz.zidan@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jobi.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "bunny", ">= 2.14.1"
+gem 'logger'
+gem 'bunny-mock'

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    jobi (0.1.0)
+      bunny (>= 2.14.1)
+      logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.3.1)
+    bunny (2.15.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
+    bunny-mock (1.7.0)
+      bunny (>= 1.7)
+    diff-lcs (1.3)
+    logger (1.4.2)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bunny (>= 2.14.1)
+  bunny-mock
+  jobi!
+  logger
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Rudy Zidan
+
+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,132 @@
+# Jobi
+
+A simple framework for Ruby, provides a full interaction between your app/micro-service and message brokers like: (Rabbitmq, Kafka, ..etc).
+</br>
+Currently it only support [Rabbitmq](https://www.rabbitmq.com/).
+
+## Requirements
+- [Rabbitmq](https://www.rabbitmq.com/) server installed and ready.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jobi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jobi
+
+## Setup
+- Add the below code to your app:
+```ruby
+Jobi.configure do |config|
+    config.rabbitmq
+    config.act_as_publisher = true
+    config.act_as_consumer = true
+    config.jobs = ['{Your Job classes goes here}']
+    config.log_file = 'log/jobi.log'
+    config.log_level = :debug
+end
+```
+- To change rabbitmq client configuration you can do the following:
+```ruby
+Jobi.configure do |config|
+    # same as the above example
+    # and you can add the below one:
+    config.rabbitmq(
+        {
+            host: ENV['RABBITMQ_HOST'],
+            port: ENV['RABBITMQ_PORT'],
+            user: ENV['RABBITMQ_USER'],
+            pass: ENV['RABBITMQ_PWD'],
+            vhost: '/',
+            auth_mechanism: 'PLAIN',
+            heartbeat: 'server',
+            automatically_recover: true,
+            network_recovery_interval: 5.0,
+            ssl: false,
+            threaded: true,
+            continuation_timeout: 4000,
+            frame_max: 131_072
+        }
+    )
+end
+```
+- For rails you can do the following:
+```ruby
+# config/initializers/jobi.rb
+Jobi.configure do |config|
+    # You can add the above examples here safely.
+end
+```
+## Usage
+
+- Create an asynchronous job:
+```ruby
+class ExampleJob < Jobi::Job
+    # Queue name that will be used for publishing and consuming messages.
+    # Force acknowledge of the message or not.
+    # Number of consumers that will consume from this queue.
+    options queue_name: :example,
+            ack: true,
+            consumers: 5
+
+    # Will be called after run.
+    after_run :print_sum
+
+    # Entry point of the job
+    def initialize(arg1:, arg2:)
+        @arg1 = @arg1
+        @arg2 = @arg2
+    end
+
+    def run
+        # Your custom logic goes here
+        @sum = @arg1 + @arg2
+    end
+
+    private
+
+    def print_sum
+        # Your custom logic that will run after
+        # the execution of your job.
+        puts @sum
+    end
+end
+```
+
+Then you can call it like this:
+```ruby
+ExampleJob.run(arg1: 1, arg2: 2)
+```
+## Examples
+Below some examples that will help you to start with Jobi.
+- [Ruby](https://github.com/Rudy-Zidan/jobi/blob/master/examples/normal_job.rb)
+- [Rails](https://github.com/Rudy-Zidan/jobi/tree/master/examples/demo_app)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/Rudy-Zidan/jobi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Rudy-Zidan/jobi/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Jobi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Rudy-Zidan/jobi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,31 @@
+# Logfile created on 2020-08-02 14:14:00 +0300 by logger.rb/v1.4.2
+I, [2020-08-02T14:15:03.498961 #20403]  INFO -- : Completed in: 0.0006229877471923828
+I, [2020-08-02T14:15:03.499179 #20403]  INFO -- : Completed in: 0.0006537437438964844
+I, [2020-08-02T14:15:03.499314 #20403]  INFO -- : Completed in: 0.0006098747253417969
+I, [2020-08-02T14:15:03.499436 #20403]  INFO -- : Completed in: 0.0005278587341308594
+I, [2020-08-02T14:15:03.499611 #20403]  INFO -- : Completed in: 0.0005152225494384766
+I, [2020-08-02T14:15:03.500180 #20403]  INFO -- : Completed in: 0.0008637905120849609
+I, [2020-08-02T14:15:03.500406 #20403]  INFO -- : Completed in: 0.00044274330139160156
+I, [2020-08-02T14:15:03.500572 #20403]  INFO -- : Completed in: 0.00039005279541015625
+I, [2020-08-02T14:15:03.500787 #20403]  INFO -- : Completed in: 0.0004138946533203125
+I, [2020-08-02T14:15:03.500969 #20403]  INFO -- : Completed in: 0.00039124488830566406
+I, [2020-08-02T14:15:15.597311 #20403]  INFO -- : Completed in: 0.00615382194519043
+I, [2020-08-02T14:15:15.597544 #20403]  INFO -- : Completed in: 0.0005860328674316406
+I, [2020-08-02T14:15:15.597729 #20403]  INFO -- : Completed in: 0.0006017684936523438
+I, [2020-08-02T14:15:15.597903 #20403]  INFO -- : Completed in: 0.0005707740783691406
+I, [2020-08-02T14:15:15.598084 #20403]  INFO -- : Completed in: 0.0005507469177246094
+I, [2020-08-02T14:15:15.598269 #20403]  INFO -- : Completed in: 0.0005309581756591797
+I, [2020-08-02T14:15:15.598435 #20403]  INFO -- : Completed in: 0.00045490264892578125
+I, [2020-08-02T14:15:15.598588 #20403]  INFO -- : Completed in: 0.0004150867462158203
+I, [2020-08-02T14:15:15.598801 #20403]  INFO -- : Completed in: 0.0004291534423828125
+I, [2020-08-02T14:15:15.599029 #20403]  INFO -- : Completed in: 0.00044798851013183594
+I, [2020-08-02T14:15:23.420378 #20403]  INFO -- : Completed in: 0.006279945373535156
+I, [2020-08-02T14:15:23.420583 #20403]  INFO -- : Completed in: 0.0005891323089599609
+I, [2020-08-02T14:15:23.420811 #20403]  INFO -- : Completed in: 0.0005612373352050781
+I, [2020-08-02T14:15:23.420987 #20403]  INFO -- : Completed in: 0.0005502700805664062
+I, [2020-08-02T14:15:23.421150 #20403]  INFO -- : Completed in: 0.0004863739013671875
+I, [2020-08-02T14:15:23.421325 #20403]  INFO -- : Completed in: 0.0004470348358154297
+I, [2020-08-02T14:15:23.421516 #20403]  INFO -- : Completed in: 0.00040793418884277344
+I, [2020-08-02T14:15:23.421733 #20403]  INFO -- : Completed in: 0.00045680999755859375
+I, [2020-08-02T14:15:23.421959 #20403]  INFO -- : Completed in: 0.00048613548278808594
+I, [2020-08-02T14:15:23.422115 #20403]  INFO -- : Completed in: 0.00044798851013183594

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/examples/demo_app/.browserslistrc

@@ -0,0 +1 @@
+defaults

data/examples/demo_app/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+/public/packs
+/public/packs-test
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity