hiatus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbf8e4ffa9ac68879d3d5b73fdc1a680f1b39ac8
+  data.tar.gz: 25e20bb996b32886f4f6a20fbeea5d4aea6736fe
+SHA512:
+  metadata.gz: 448a544e93e12bc1e7447de8284337917d952946ad3fb7edabcb55e087f360d798c52e1dfa045dbb2e94c9fa0bed862e923609322995cd13df0d3d636a0b40fd
+  data.tar.gz: 540022f607baa584ed4da291dd2ffc8fbeb909049add2edec8030553c58de410bc2da5ed3cd5e400e3ffd0d8d0a6b6a852dc7e1de2a04511e490a48e485eb262

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--order random

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Gessner
+
+MIT License
+
+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,65 @@
+# Hiatus
+
+This gem will allow you to use Redis to pause and check for paused status of things.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hiatus'
+
+And then install with Bundler:
+
+    bundle install
+
+Or install it globally:
+
+    gem install hiatus
+
+## Usage
+
+### Initialization / Dependency
+
+You must have the thread-safe `Redis.current` set up
+
+### Extending an existing model
+
+```ruby
+class YeOldeBlob
+  extend Hiatus::Pausable
+
+  def self.process_everything
+    return if paused?
+    ...
+  end
+end
+
+rake stop_blobs do
+  YeOldeBlob.pause
+end
+```
+
+### Pausing processes by name
+
+```ruby
+rake read_only_maintenance_mode do
+  Hiatus.pause([:blobs, :jobs, :screaming_sobs], 2000)
+end
+```
+
+```ruby
+class BlobProcessor
+  def process
+    return if Hiatus.paused?(:blobs)
+    ...
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/shopkeep/hiatus/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/hiatus.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hiatus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hiatus"
+  spec.version       = Hiatus::VERSION
+  spec.authors       = ["Alex Gessner"]
+  spec.email         = ["alex.gessner@gmail.com"]
+  spec.summary       = "Use a key-value store to pause some of your functionality."
+  spec.description   = "This is useful for such things as maintenance mode, testing, and heavy migrations."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fakeredis"
+
+  spec.add_runtime_dependency "redis"
+end

data/lib/hiatus.rb

@@ -0,0 +1,43 @@
+require 'hiatus/version'
+require 'pausable'
+
+module Hiatus
+  NAMESPACE = 'hiatus:'
+  private_constant :NAMESPACE
+
+  def self.summary
+    hiatus_all_keys.map do |key|
+      {
+        process: key.sub(NAMESPACE, ''),
+        seconds_remaining: Redis.current.ttl(key),
+        paused_at: Redis.current.get(key)
+      }
+    end
+  end
+
+  def self.pause(processes, seconds = 1800)
+    Array(processes).all? { |process| hiatus_update(process, seconds) }
+  end
+
+  def self.paused?(process)
+    !!Redis.current.get( namespace(process) )
+  end
+
+  private
+
+  def self.namespace(process)
+    NAMESPACE + process.to_s
+  end
+
+  def self.hiatus_update(process, time)
+    Redis.current.setex(namespace(process), time, timestamp)
+  end
+
+  def self.hiatus_all_keys
+    Redis.current.keys(NAMESPACE + '*')
+  end
+
+  def self.timestamp
+    Redis.current.time.first
+  end
+end

data/lib/hiatus/version.rb

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

data/lib/pausable.rb

@@ -0,0 +1,19 @@
+require 'hiatus'
+
+module Hiatus
+  module Pausable
+    def pause(seconds = 1800)
+      Hiatus.pause(hiatus_key, seconds)
+    end
+
+    def paused?
+      !!Hiatus.paused?(hiatus_key)
+    end
+
+    private
+
+    def hiatus_key
+      self.to_s.downcase
+    end
+  end
+end

data/spec/lib/hiatus_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Hiatus do
+  let(:redis) { Redis.new }
+  let(:redis_time) { Time.at(1385107188) }
+
+  before { Redis.current.stub(:time).and_return([redis_time.to_i, 000000]) }
+
+  describe '.summary' do
+    context 'when there are no paused processes' do
+      it 'is an empty array' do
+        expect(Hiatus.summary).to eql []
+      end
+    end
+
+    context 'when there are two paused processes' do
+      let(:first_item) { Hiatus.summary.first }
+
+      before { Hiatus.pause([:franks, :beans], 1000) }
+
+      it 'has two items' do
+        expect(Hiatus.summary.count).to eql 2
+      end
+
+      it 'the first element has the correct process' do
+        expect(first_item[:process]).to eql 'franks'
+      end
+
+      it 'the first element has the correct seconds_remaining' do
+        expect(first_item[:seconds_remaining]).to be_within(1).of(1000)
+      end
+
+      it 'the first element has the correct paused_at' do
+        expect(first_item[:paused_at]).to eql '1385107188'
+      end
+    end
+
+  end
+
+  describe '.pause' do
+    context 'with a single process and no time given' do
+      before { Hiatus.pause(:arbitrary_migration) }
+
+      it 'the computed key is not nil' do
+        expect(redis.get('hiatus:arbitrary_migration')).not_to be_nil
+      end
+
+      it 'has a ttl of 30 minutes (1800 seconds)' do
+        time_remaining = redis.ttl('hiatus:arbitrary_migration')
+        expect(time_remaining).to be_within(5).of(1800)
+      end
+
+      it 'has a value with the current timestamp' do
+        expect(redis.get('hiatus:arbitrary_migration')).to eql '1385107188'
+      end
+    end
+
+    context 'with a single process and explicit 45 seconds' do
+      before { Hiatus.pause(:arbitrary_migration, 45) }
+
+      it 'the computed key is not nil' do
+        expect(redis.get('hiatus:arbitrary_migration')).not_to be_nil
+      end
+
+      it 'has a ttl of 45 seconds' do
+        time_remaining = redis.ttl('hiatus:arbitrary_migration')
+        expect(time_remaining).to be_within(5).of(45)
+      end
+    end
+
+    context 'with an array of processes and explicit 45 seconds' do
+      before do
+        Hiatus.pause([ :arbitrary_migration, :regular_processing_job, :transmission_worker ], 45)
+      end
+
+      it 'arbitrary_migration has a key set' do
+        expect(redis.get('hiatus:arbitrary_migration')).not_to be_nil
+      end
+
+      it 'regular_processing_job has a key set' do
+        expect(redis.get('hiatus:regular_processing_job')).not_to be_nil
+      end
+
+      it 'transmission_worker has a key set' do
+        expect(redis.get('hiatus:transmission_worker')).not_to be_nil
+      end
+
+      it 'arbitrary_migration has a ttl of 45 seconds' do
+        time_remaining = redis.ttl('hiatus:arbitrary_migration')
+        expect(time_remaining).to be_within(5).of(45)
+      end
+
+      it 'regular_processing_job has a ttl of 45 seconds' do
+        time_remaining = redis.ttl('hiatus:regular_processing_job')
+        expect(time_remaining).to be_within(5).of(45)
+      end
+
+      it 'transmission_worker has a ttl of 45 seconds' do
+        time_remaining = redis.ttl('hiatus:transmission_worker')
+        expect(time_remaining).to be_within(5).of(45)
+      end
+    end
+  end
+
+  describe 'paused?' do
+    context 'with a paused arbitrary_migration' do
+      before { Hiatus.pause(:arbitrary_migration) }
+
+      it 'is true' do
+        expect(Hiatus.paused?(:arbitrary_migration)).to be_true
+      end
+    end
+
+    context 'without anything paused' do
+      it 'is false' do
+        expect(Hiatus.paused?(:green_skittles)).to be_false
+      end
+    end
+  end
+end

data/spec/lib/pausable_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+class Dummy
+  extend Hiatus::Pausable
+end
+
+describe Hiatus::Pausable do
+  let(:redis) { Redis.new }
+  let(:redis_time) { Time.at(1385107188) }
+
+  before { Redis.current.stub(:time).and_return([redis_time.to_i, 000000]) }
+
+  describe 'pause' do
+    context 'without a number of seconds specified' do
+      before { Dummy.pause }
+
+      it 'the computed key is not nil' do
+        expect(redis.get('hiatus:dummy')).not_to be_nil
+      end
+
+      it 'has a ttl of 30 minutes (1800 seconds)' do
+        time_remaining = redis.ttl('hiatus:dummy')
+        expect(time_remaining).to be_within(5).of(1800)
+      end
+    end
+
+    context 'with 246 seconds' do
+      before { Dummy.pause(246) }
+
+      it 'the computed key is not nil' do
+        expect(redis.get('hiatus:dummy')).not_to be_nil
+      end
+
+      it 'has a ttl of 246 seconds' do
+        time_remaining = redis.ttl('hiatus:dummy')
+        expect(time_remaining).to be_within(5).of(246)
+      end
+    end
+  end
+
+  describe 'paused?' do
+    context 'when it has been paused' do
+      before { Dummy.pause }
+
+      it 'is true' do
+        expect(Dummy.paused?).to be_true
+      end
+    end
+
+    context 'when it has not been paused' do
+      it 'is false' do
+        expect(Dummy.paused?).to be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'fakeredis'
+require 'rspec'
+require 'hiatus'
+
+RSpec.configure do |config|
+  config.before { Redis.new.flushdb }
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: hiatus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Gessner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: bundler
+  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: rake
+  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: fakeredis
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is useful for such things as maintenance mode, testing, and heavy
+  migrations.
+email:
+- alex.gessner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hiatus.gemspec
+- lib/hiatus.rb
+- lib/hiatus/version.rb
+- lib/pausable.rb
+- spec/lib/hiatus_spec.rb
+- spec/lib/pausable_spec.rb
+- spec/spec_helper.rb
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Use a key-value store to pause some of your functionality.
+test_files:
+- spec/lib/hiatus_spec.rb
+- spec/lib/pausable_spec.rb
+- spec/spec_helper.rb