active_switch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ced59de3ae362b7e1caf48f0bc1b6a0e3ef8788
+  data.tar.gz: 2242e9403fd6eacf2e0cd80bcd0c66f8a0329b41
+SHA512:
+  metadata.gz: 56df8d8a4940f35a8b7060c039f3b2abb1910c1c8112b5a25a28cbb98ed2691ea0aebf7a4aae3f2f7e196c56d6cbbfd20c6cded69488ba46b309ae19f5b10dbd
+  data.tar.gz: 59398e3ce94ac1b15593068978d50f4d04aece9640f3e68e2bb1554c82ba7c7329890bcca838403d75f52f6f12985ccc86c34cd231bd5e911bbe3cb08cf202e2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brendon Murphy
+
+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,156 @@
+# ActiveSwitch
+
+ActiveSwitch stores last reported at timestamps in Redis so you can detect if cron style jobs are running at an expected interval.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_switch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_switch
+
+## Usage
+
+### Configuration & Registration
+
+First, configure `ActiveSwitch`, for instance in a Rails initializer:
+
+```ruby
+# config/initializers/active_switch.rb
+
+# configure the Redis client
+ActiveSwitch.redis = Redis.new
+
+# expect the big batch job to run within past day
+ActiveSwitch.register(:big_batch_job, 1.day)
+
+# expect the weekly mailer to run within the past week
+ActiveSwitch.register(:weekly_mailer, 1.week)
+```
+
+Attempting to register the same name more than once will raise an `ActiveSwitch::AlreadyRegistered` exception.
+
+Alternatively, you can register in one call with a hash:
+
+```ruby
+ActiveSwitch.register({
+  big_batch_job: 1.day,
+  weekly_mailer: 1.week
+})
+```
+
+### Reporting In
+
+After your scheduled task or background job completes, you can report it complete:
+
+```ruby
+ActiveSwitch.report(:weekly_mailer) # => true
+```
+
+Attempting to report on an unregistered name will raise an `ActiveSwitch::UnknownName` exception. This prevents
+dead code paths or typos of names.
+
+Alternatively, you can provide `.report` a block to yield:
+
+```ruby
+ActiveSwitch.report(:weekly_mailer) { 2 + 2 } # => 4
+```
+
+### Status Retrieval
+
+Statuses can be retrieved with `.all`, `.active`, or `.inactive`:
+
+```ruby
+ActiveSwitch.report(:weekly_mailer)
+
+# Returns hash of statuses with keys "big_batch_job" and "weekly_mailer"
+#
+#   {
+#     "big_batch_job"=>#<ActiveSwitch::Status:0x007fbb9309e880 @name="big_batch_job", @last_reported_at=nil, @threshold_seconds=86400>},
+#     "weekly_mailer"=>#<ActiveSwitch::Status:0x007fbb9309f990 @name="weekly_mailer", @last_reported_at=2017-12-03 23:02:42 -0800, @threshold_seconds=604800>}
+#   }
+ActiveSwitch.all
+
+# Returns hash of statuses with key "weekly_mailer"
+#
+#   {
+#     "weekly_mailer"=>#<ActiveSwitch::Status:0x007fbb9309f990 @name="weekly_mailer", @last_reported_at=2017-12-03 23:02:42 -0800, @threshold_seconds=604800>}
+#   }
+ActiveSwitch.active
+
+# Returns hash of statuses with key "big_batch_job"
+#
+#   {
+#     "big_batch_job"=>#<ActiveSwitch::Status:0x007fbb9309e880 @name="big_batch_job", @last_reported_at=nil, @threshold_seconds=86400>}
+#   }
+ActiveSwitch.inactive
+```
+
+Individual status may also be retrieved with `.status`
+
+```ruby
+ActiveSwitch.status(:weekly_mailer)
+# => <ActiveSwitch::Status:0x007fbb9309f990 @name="weekly_mailer", @last_reported_at=2017-12-03 23:02:42 -0800, @threshold_seconds=604800>
+```
+
+### Status instances
+
+A status instance can be asked for its values:
+
+```ruby
+status = ActiveSwitch.status(:weekly_mailer)
+status.name #=> "weekly_mailer"
+status.last_reported_at #=> 2017-12-03 23:02:42 -0800
+status.threshold_seconds #=> 604800
+```
+
+It can also be checked if active or inactive:
+
+```ruby
+status.active? #=> true
+status.inactive? #=> false
+status.state #=> "ACTIVE"
+```
+
+A status is considered active if it was last reported within its registered threshold seconds.
+
+## Redis Storage
+
+All data is stored in a single Redis hash to avoid n+1 roundtrip lookups to Redis when gathering all statuses. Care should
+be taken to avoid tracking too many switches to avoid overloading the hash. A maximum of about 1000 would be sane, and likely
+beyond typical use.
+
+The hash is stored under the key `active_switch_last_reported_ats` and reflects the following format:
+
+```ruby
+# Values are epoch seconds
+{
+  "weekly_mailer" => "1512371591",
+  "big_batch_job" => "1512285202"
+}
+```
+
+## 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/bemurphy/active_switch.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_switch.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_switch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_switch"
+  spec.version       = ActiveSwitch::VERSION
+  spec.authors       = ["Brendon Murphy"]
+  spec.email         = ["xternal1+github@gmail.com"]
+
+  spec.summary       = %q{Check that your scheduled tasks are still alive.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/bemurphy/active_switch"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mock_redis"
+
+  # Redis is added as a development dependency and expects the parent application to set the dependency
+  spec.add_development_dependency "redis"
+end

data/bin/console

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

@@ -0,0 +1,86 @@
+require "active_switch/version"
+require "active_switch/status"
+
+module ActiveSwitch
+  extend self
+
+  NoRedisClient     = Class.new(StandardError)
+  AlreadyRegistered = Class.new(ArgumentError)
+  UnknownName       = Class.new(ArgumentError)
+
+  STORAGE_KEY   = "active_switch_last_reported_ats".freeze
+  REGISTRATIONS = {}
+
+  class << self
+    attr_writer :redis
+
+    def redis
+      @redis or raise NoRedisClient, "No redis client configured"
+    end
+  end
+
+  def register(*args)
+    if args[0].is_a?(Hash)
+      args[0].each { |name, threshold_seconds| register(name, threshold_seconds) }
+    else
+      name, threshold_seconds = args[0].to_s, args[1]
+
+      if REGISTRATIONS[name]
+        raise AlreadyRegistered, "#{name} already registered"
+      else
+        REGISTRATIONS[name] = threshold_seconds
+      end
+    end
+  end
+
+  def report(name)
+    name = cast_name(name)
+
+    if block_given?
+      yield.tap { mark_reported(name) }
+    else
+      mark_reported(name)
+      true
+    end
+  end
+
+  def status(name)
+    name = cast_name(name)
+    ts   = redis.hget(STORAGE_KEY, name)
+
+    Status.new(name: name, last_reported_at: ts, threshold_seconds: REGISTRATIONS[name])
+  end
+
+  def all
+    data = redis.hgetall(STORAGE_KEY)
+
+    REGISTRATIONS.each_with_object({}) do |(name, threshold_seconds), obj|
+      obj[name] = Status.new(name: name, last_reported_at: data[name],
+                             threshold_seconds: threshold_seconds)
+    end
+  end
+
+  def active
+    all.select { |_, s| s.active? }
+  end
+
+  def inactive
+    all.select { |_, s| s.inactive? }
+  end
+
+  def report_on_inactive
+    inactive.keys.map { |name| report(name) }
+  end
+
+  # Considered private API
+
+  def mark_reported(name)
+    redis.hset(STORAGE_KEY, name, Time.now.to_i)
+  end
+
+  def cast_name(name)
+    name.to_s.tap do |name|
+      raise UnknownName, "#{name} not found" unless REGISTRATIONS[name]
+    end
+  end
+end

data/lib/active_switch/status.rb

@@ -0,0 +1,41 @@
+module ActiveSwitch
+  class Status
+    ACTIVE   = "ACTIVE".freeze
+    INACTIVE = "INACTIVE".freeze
+
+    attr_reader :name, :last_reported_at, :threshold_seconds
+
+    def initialize(name:, last_reported_at:, threshold_seconds:)
+      @name              = name.to_s
+      @last_reported_at  = cast_timestamp(last_reported_at, cast_null: false)
+      @threshold_seconds = threshold_seconds.to_i
+    end
+
+    def active?
+      (cast_timestamp(last_reported_at) + threshold_seconds) > cast_timestamp(now)
+    end
+
+    def inactive?
+      !active?
+    end
+
+    def state
+      active? ? ACTIVE : INACTIVE
+    end
+    alias_method :to_s, :state
+
+    private
+
+    def now
+      Time.now
+    end
+
+    def cast_timestamp(ts, cast_null: true)
+      if cast_null
+        Time.at((ts || 0).to_i)
+      else
+        ts ? Time.at(ts.to_i) : nil
+      end
+    end
+  end
+end

data/lib/active_switch/version.rb

@@ -0,0 +1,3 @@
+module ActiveSwitch
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: active_switch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: mock_redis
+  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: redis
+  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: Check that your scheduled tasks are still alive.
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_switch.gemspec
+- bin/console
+- bin/setup
+- lib/active_switch.rb
+- lib/active_switch/status.rb
+- lib/active_switch/version.rb
+homepage: https://github.com/bemurphy/active_switch
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Check that your scheduled tasks are still alive.
+test_files: []