sidekiq_hero 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95f22a1885f5b4c34c76d75b59e111570f69fe3ab59da2baa1609025bd1b91c3
+  data.tar.gz: 6fd444444c2a4b5d17d5cf5df2aedbe8f83402a3da8881f5ed761224050eb1a8
+SHA512:
+  metadata.gz: 30d4e80644ccc5e1cdbff03eecee63c8f8114b918b4bef0cc8b039bb1e859d7868986551772dec345ab0697c5938a5ac3c84b34612de0217810fea2b6706d76e
+  data.tar.gz: 47a6cc6564643e10b494480ab693503fe945c6d06b665c5205da0167d42a961c7752bc1966f43e7fdec105c0ec0ebfc136d3b7dae49c774938a2ce77e2df5868

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq_hero.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    sidekiq_hero (0.1.0)
+      sidekiq (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    rack (2.0.6)
+    rack-protection (2.0.5)
+      rack
+    rake (10.5.0)
+    redis (4.1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sidekiq (5.2.5)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack (>= 1.5.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sidekiq_hero!
+  timecop
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Samuel
+
+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,39 @@
+# SidekiqHero
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq_hero`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq_hero'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_hero
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/sidekiq_hero.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/sidekiq_hero/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SidekiqHero
+  class Configuration
+    attr_accessor :notifier_server_message_class, :exceed_maximum_time
+
+    def initialize
+      @notifier_server_message_class = SidekiqHero::Notifier.new
+      @exceed_maximum_time = 0
+    end
+  end
+end
+

data/lib/sidekiq_hero/notifier.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SidekiqHero
+  class Notifier
+
+    def self.notify(job, meta_data)
+      new.notify(job, meta_data)
+    end
+
+    def notify(job, meta_data)
+      Sidekiq.logger.info "#{job} -- #{meta_data}"
+    end
+  end
+end
+

data/lib/sidekiq_hero/recorder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SidekiqHero
+  class Recorder
+    attr_reader :meta_data
+
+    def initialize
+      @meta_data = {}
+    end
+
+    def record(hash)
+      meta_data.merge!(hash)
+    end
+
+    def record_elapsed_time
+      total = meta_data.fetch(:ended_at, 0) - meta_data.fetch(:started_at, 0)
+      record(total_time: total)
+    end
+  end
+end
+

data/lib/sidekiq_hero/server_middleware.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SidekiqHero
+  class ServerMiddleware
+    def call(_worker, job, _queue)
+      recorder.record(status: 'passed', started_at: Time.now.utc.round)
+      yield
+      recorder.record(status: 'success')
+    rescue => e
+      recorder.record(status: 'failed', error: e.to_s)
+      raise e
+    ensure
+      recorder.record(ended_at: Time.now.utc.round)
+      recorder.record_elapsed_time
+      notifier.notify(job, recorder.meta_data) if exceeded_maximum_time? || job_failed?
+    end
+
+    private
+
+    def recorder
+      @recorder ||= SidekiqHero::Recorder.new
+    end
+
+    def server_message_class
+      @server_message_class ||= SidekiqHero.configuration.server_message_class
+    end
+
+    def meta_data
+      @meta_data ||= {}
+    end
+
+    def notifier
+      SidekiqHero.configuration.notifier_server_message_class
+    end
+
+    def exceed_maximum_time
+      @exceed_maximum_time ||= SidekiqHero.configuration.exceed_maximum_time
+    end
+
+    def exceeded_maximum_time?
+      recorder.meta_data[:total_time] > exceed_maximum_time
+    end
+
+    def job_failed?
+      recorder.meta_data[:status] == 'failed'
+    end
+  end
+end

data/lib/sidekiq_hero/version.rb

@@ -0,0 +1,3 @@
+module SidekiqHero
+  VERSION = "0.1.0"
+end

data/lib/sidekiq_hero.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'sidekiq_hero/version'
+require 'sidekiq/api'
+require 'sidekiq_hero/configuration'
+require 'sidekiq_hero/notifier'
+require 'sidekiq_hero/recorder'
+require 'sidekiq_hero/server_middleware'
+
+module SidekiqHero
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/sidekiq_hero.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq_hero/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_hero"
+  spec.version       = SidekiqHero::VERSION
+  spec.authors       = ["Samuel"]
+  spec.email         = ["samueljmartini@gmail.com"]
+
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|dummy_app)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             'sidekiq', '>= 3.0'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_hero
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: timecop
+  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: ''
+email:
+- samueljmartini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq_hero.rb
+- lib/sidekiq_hero/configuration.rb
+- lib/sidekiq_hero/notifier.rb
+- lib/sidekiq_hero/recorder.rb
+- lib/sidekiq_hero/server_middleware.rb
+- lib/sidekiq_hero/version.rb
+- sidekiq_hero.gemspec
+homepage: ''
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []