check_and_notify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff504b937b2e28a12d1217501bbaa6855079de84
+  data.tar.gz: 166a39634b1833be0d373929e52a4ddf04167d48
+SHA512:
+  metadata.gz: 922e694598210919953a91263e757b4ae4ea70d43e4002b2429fcad6248f79b4174a6d83b5980f536b5e289c6fa4282a32f691d924551b010718b6c92842438c
+  data.tar.gz: 52290a8a4b1591d9c830ec0ae82cbf60eb630493b92c3c262af64fed5f027aa0675f6c4b26925a92bf7941dd220ce438980cefdd5943d9a3cb1c48eb6d3437a9

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,74 @@
+# Check And Notify
+
+An easy to use regular checker and notifier via Slack without needing to setup cron jobs and rake tasks.
+This gem uses Sidekiq and Sidekiq Cron for asynchronous execution of jobs.
+
+In the future, other medium of notifications will be implemented like Email and SMS.
+
+### Installation
+
+```sh
+$ gem install check_and_notify
+```
+
+### Usage
+
+In your initializer, say for example, `check_and_notify.rb`, write a callback that will be called every ten minutes and then send a notification:
+
+```ruby
+require 'check_and_notify'
+
+CheckAndNotify::Callbacks.check_after_ten_minutes do
+    # Do anything here
+    message = "Hello World"
+
+    {
+      slack_webhook_url: "https://hooks.slack.com/services/111/222/abcd",
+      message: message
+    }
+  end
+end
+
+CheckAndNotify.init_cron
+```
+
+Remember that the return of the callback must be of the form: `{slack_webhook_url: "", message: ""}`.
+Also remember to call `CheckAndNotify.init_cron` to initialize Sidekiq crons.
+
+You can add multiple callbacks if you want:
+
+```ruby
+require 'check_and_notify'
+
+CheckAndNotify::Callbacks.check_after_ten_minutes do
+    # Do anything here
+    message = "Hello James"
+
+    {
+      slack_webhook_url: "https://hooks.slack.com/services/333/444/abcd",
+      message: message
+    }
+  end
+end
+
+CheckAndNotify::Callbacks.check_after_ten_minutes do
+    # Do anything here
+    message = "Hello World"
+
+    {
+      slack_webhook_url: "https://hooks.slack.com/services/111/222/abcd",
+      message: message
+    }
+  end
+end
+
+CheckAndNotify.init_cron
+```
+
+### Todos
+
+- Write checkers after every five minutes, fifteen minutes, thirty minutes, and so forth as long as there's a demand for it
+
+## 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,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "check_and_notify"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/check_and_notify.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'check_and_notify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "check_and_notify"
+  spec.version       = CheckAndNotify::VERSION
+  spec.authors       = ["Neil Marion dela Cruz"]
+  spec.email         = ["nmfdelacruz@gmail.com"]
+
+  spec.summary       = %q{Calls a callback regularly and notifies when it returns true}
+  spec.description   = %q{Calls a callback regularly and notifies when it returns true}
+  spec.homepage      = "https://github.com/carabao-capital/check_and_notify"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.0'
+  spec.add_dependency "sidekiq", "5.0.4"
+  spec.add_dependency "sidekiq-cron", "0.6.3"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-nav", "~> 0.2.4"
+end

data/lib/check_and_notify.rb

@@ -0,0 +1,18 @@
+require "active_support"
+require "httparty"
+require "sidekiq"
+require "sidekiq-cron"
+
+require "check_and_notify/version"
+require "check_and_notify/cron"
+require "check_and_notify/callbacks"
+require "check_and_notify/notifiers/slack"
+require "check_and_notify/workers/slack_notifier_worker"
+require "check_and_notify/workers/check_every_hour_worker"
+require "check_and_notify/workers/check_every_ten_minutes_worker"
+
+module CheckAndNotify
+  def self.init_cron
+    Cron.init
+  end
+end

data/lib/check_and_notify/callbacks.rb

@@ -0,0 +1,16 @@
+module CheckAndNotify
+  module Callbacks
+    mattr_accessor :check_after_one_hour_callbacks
+    mattr_accessor :check_after_ten_minutes_callbacks
+    self.check_after_one_hour_callbacks = []
+    self.check_after_ten_minutes_callbacks = []
+
+    def self.check_after_one_hour(&block)
+      self.check_after_one_hour_callbacks << block
+    end
+
+    def self.check_after_ten_minutes(&block)
+      self.check_after_ten_minutes_callbacks << block
+    end
+  end
+end

data/lib/check_and_notify/cron.rb

@@ -0,0 +1,26 @@
+module CheckAndNotify
+  class Cron
+    def self.init
+      init_every_hour_cron
+      init_every_ten_minutes_cron
+    end
+
+    private
+
+    def self.init_every_hour_cron
+      Sidekiq::Cron::Job.create({
+        name: 'CheckEveryHourWorker',
+        cron: '0 * * * *',
+        class: 'CheckAndNotify::Workers::CheckEveryHourWorker'
+      })
+    end
+
+    def self.init_every_ten_minutes_cron
+      Sidekiq::Cron::Job.create({
+        name: 'CheckEveryTenMinutesWorker',
+        cron: '*/10 * * * *',
+        class: 'CheckAndNotify::Workers::CheckEveryTenMinutesWorker'
+      })
+    end
+  end
+end

data/lib/check_and_notify/notifiers/slack.rb

@@ -0,0 +1,25 @@
+module CheckAndNotify
+  module Notifiers
+    class Slack
+      HEADERS = {'Content-Type' => 'application/json'}
+
+      def self.notify(params)
+        @slack_webhook_url = params[:slack_webhook_url]
+        @message = params[:message]
+
+        post
+      end
+
+      private
+
+      def self.post
+        body = {text: @message}.to_json
+
+        HTTParty.post(@slack_webhook_url,
+          headers: HEADERS,
+          body: body,
+        )
+      end
+    end
+  end
+end

data/lib/check_and_notify/version.rb

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

data/lib/check_and_notify/workers/check_every_hour_worker.rb

@@ -0,0 +1,19 @@
+module CheckAndNotify
+  module Workers
+    class CheckEveryHourWorker
+      include Sidekiq::Worker
+      sidekiq_options retry: 1
+
+      def perform
+        callbacks_size = CheckAndNotify::Callbacks.
+          check_after_one_hour_callbacks.count
+
+        callbacks_size.times do |index|
+          SlackNotifierWorker.perform_async(
+            index, SlackNotifierWorker::EVERY_HOUR
+          )
+        end
+      end
+    end
+  end
+end

data/lib/check_and_notify/workers/check_every_ten_minutes_worker.rb

@@ -0,0 +1,19 @@
+module CheckAndNotify
+  module Workers
+    class CheckEveryTenMinutesWorker
+      include Sidekiq::Worker
+      sidekiq_options retry: 1
+
+      def perform
+        callbacks_size = CheckAndNotify::Callbacks.
+          check_after_ten_minutes_callbacks.count
+
+        callbacks_size.times do |index|
+          SlackNotifierWorker.perform_async(
+            index, SlackNotifierWorker::EVERY_TEN_MINUTES
+          )
+        end
+      end
+    end
+  end
+end

data/lib/check_and_notify/workers/slack_notifier_worker.rb

@@ -0,0 +1,25 @@
+module CheckAndNotify
+  module Workers
+    class SlackNotifierWorker
+      include Sidekiq::Worker
+      sidekiq_options retry: 1
+
+      EVERY_HOUR = 3600
+      EVERY_TEN_MINUTES = 600
+
+      def perform(callback_index, callbacks_array_type)
+        callback = case callbacks_array_type
+          when EVERY_HOUR
+            CheckAndNotify::Callbacks.
+              check_after_one_hour_callbacks[callback_index]
+          when EVERY_TEN_MINUTES
+            CheckAndNotify::Callbacks.
+              check_after_ten_minutes_callbacks[callback_index]
+          end
+
+        result = callback.call
+        Notifiers::Slack.notify(result) if result
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: check_and_notify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil Marion dela Cruz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+- !ruby/object:Gem::Dependency
+  name: sidekiq-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: Calls a callback regularly and notifies when it returns true
+email:
+- nmfdelacruz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- check_and_notify.gemspec
+- lib/check_and_notify.rb
+- lib/check_and_notify/callbacks.rb
+- lib/check_and_notify/cron.rb
+- lib/check_and_notify/notifiers/slack.rb
+- lib/check_and_notify/version.rb
+- lib/check_and_notify/workers/check_every_hour_worker.rb
+- lib/check_and_notify/workers/check_every_ten_minutes_worker.rb
+- lib/check_and_notify/workers/slack_notifier_worker.rb
+homepage: https://github.com/carabao-capital/check_and_notify
+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: Calls a callback regularly and notifies when it returns true
+test_files: []