runner_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdbb3207599aeb2067052e62131316a5f1647174
+  data.tar.gz: ceb760411137efd6826b097b3e51cc484d8200d5
+SHA512:
+  metadata.gz: fb648577b55bf8f511e4cecbe2663c325de2531dfa78d5e6d247cd2c75cdd96b61c78d4c802cf84d1cdc43ed5eb7167839c3d92c26b3826f9a4e785e16501d68
+  data.tar.gz: febcab8584c2d3948314436619dcf999eb09c8d337d360974d48d97e7a666b7fe7b7361644f3f27c3ed8f82327686433ef075045c0c4c776fd388d9614597a03

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  TargetRubyVersion: 2.4
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.4.1
+before_install: gem install bundler -v 1.13.6
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'exception_notification'
+gem 'rails'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rinat Garifullin
+
+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,34 @@
+# RunnerHelper
+
+RunnerHelper launches [Rails runner](http://guides.rubyonrails.org/command_line.html#rails-runner) as [Systemd](https://www.freedesktop.org/wiki/Software/systemd/) service. This runner periodically runs code (every 5 seconds by default).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'runner_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install runner_helper
+
+## Usage
+
+    $ rails g runner billing
+
+creates `Billing` class file `app/runners/billing.rb` with systemd unit file `vendor/systemd/billing.service`. Implement your business logic in `run_once` method.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ringarifullin/runner_helper.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 'runner_helper'
+
+# 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

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/generators/runner_helper/runner_helper_generator.rb

@@ -0,0 +1,24 @@
+require 'rails'
+require 'rails/generators'
+
+# Generates runner class and systemd unit file
+class RunnerHelperGenerator < Rails::Generators::NamedBase
+  desc 'Create runner class with systemd unit file.'
+
+  source_root File.expand_path('../templates', __FILE__)
+  argument 'username', default: 'deploy'
+
+  def assert_runner_helper_presence
+    file = Rails.root.join('lib', 'runner_helper.rb')
+
+    raise "File not found: #{file}" unless File.exist?(file)
+  end
+
+  def gen_runner_class
+    template('runner_helper.rb.erb', "app/runners/#{file_name}.rb")
+  end
+
+  def gen_unit_file
+    template('unit.service.erb', "vendor/systemd/#{file_name}.service")
+  end
+end

data/lib/generators/runner_helper/templates/runner_helper.rb.erb

@@ -0,0 +1,9 @@
+class <%= class_name %>
+  # default value of repetition time is 5 seconds
+  # TIMEOUT = 5
+  include RunnerHelper
+
+  def run_once
+    # implement your logic here
+  end
+end

data/lib/generators/runner_helper/templates/unit.service.erb

@@ -0,0 +1,22 @@
+[Unit]
+Description=<%= class_name %>
+After=syslog.target network.target
+
+[Service]
+Type=simple
+WorkingDirectory=/home/deploy/<%= application_name %>/current
+ExecStart=/bin/bash -lc 'rails runner -e production "<%= class_name %>.new.service"'
+User=<%= username %>
+Group=<%= username %>
+UMask=0002
+
+RestartSec=1
+Restart=on-failure
+
+StandardOutput=syslog
+StandardError=syslog
+
+SyslogIdentifier=<%= file_name %>
+
+[Install]
+WantedBy=multi-user.target

data/lib/runner_helper.rb

@@ -0,0 +1,20 @@
+require 'runner_helper/version'
+require 'exception_notification'
+
+# Periodically run in infinite loop
+module RunnerHelper
+  TIMEOUT = 5
+
+  def service
+    loop do
+      run_once
+      sleep TIMEOUT
+    end
+  rescue Exception => ex
+    ExceptionNotifier.notify_exception(ex)
+  end
+
+  def run_once
+    raise NotImplementedError.new, 'implement `run_once` method first'
+  end
+end

data/lib/runner_helper/version.rb

@@ -0,0 +1,3 @@
+module RunnerHelper
+  VERSION = '0.0.1'.freeze
+end

data/runner_helper.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runner_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'runner_helper'
+  spec.version       = RunnerHelper::VERSION
+  spec.authors       = ['Rinat Garifullin']
+  spec.email         = ['ringarifullin@gmail.com']
+
+  spec.summary       = 'Rails runner generator'
+  spec.description   = 'Rails runner generator which works with Systemd.'
+  spec.homepage      = 'https://github.com/ringarifullin/runner_helper'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+  spec.add_development_dependency 'rubocop', '~> 0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: runner_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rinat Garifullin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Rails runner generator which works with Systemd.
+email:
+- ringarifullin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/runner_helper/runner_helper_generator.rb
+- lib/generators/runner_helper/templates/runner_helper.rb.erb
+- lib/generators/runner_helper/templates/unit.service.erb
+- lib/runner_helper.rb
+- lib/runner_helper/version.rb
+- runner_helper.gemspec
+homepage: https://github.com/ringarifullin/runner_helper
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Rails runner generator
+test_files: []