concussion 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9d9bd8e22789958ac0069c9598e7a1f737ca63a
+  data.tar.gz: bbe82e8fcf8dfc58bd9f071cb14e622b52d9a582
+SHA512:
+  metadata.gz: 84a4d186967d0abe66d815fd516a3383204cb1600721e7a0d6a2fc422acd2064f91cf27985eee4746d13f6f0579ad0c8ab2513a8bbacfbe17182ec52d6493442
+  data.tar.gz: 85008ec840632da4c4beb66409a302673d49575ef7cdca67260ce8f372419f18bcb0a42ce910e4e97b92e31c25aac51a6783ba1537771889dce1393426a9a94f

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.5

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, ethnicity, 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 concussion.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 chemica
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ben Dunkley
+
+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,94 @@
+# Concussion
+
+Sucker Punch is an awesome gem which allows in-process background jobs. If you want to run jobs at a particular time,
+however, there is a downside. Jobs are only held in memory, so restarting the process will kill any pending jobs.
+
+Most web apps will be using some kind of data store however, so Concussion allows them to be persisted.
+
+## WARNING
+
+Concussion is currently untested code. It has not been used in production and has no automated test suite. Use at your 
+own risk. I cannot be held responsible for any loss of data, sanity or clients that may result from use of this code.
+
+The interface may also change radically in the following versions.
+
+Currently only Redis can be used as a data store.
+
+The gem has been published mainly as a placeholder.
+
+You have been warned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'concussion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install concussion
+
+## Usage
+
+Concussion won't do much on its own. It needs to connect to a persistent storage, and for that it needs an adapter. For
+now it comes bundled with a Redis adapter, but that will be extracted into its own gem in due course.
+
+The adapter is a class with a simple interface, described in the redis class adapter class comments.
+
+To use Concussion in a Rails project, add an initializer containing something along the lines of the following code:
+
+```ruby
+# after_initialize is used to allow Redis to initialise first
+Rails.application.config.after_initialize do
+  namespace = "concussion-persistence"
+  redis = Redis.new(:host => "localhost", :port => 6379)
+  Concussion.store = Concussion::RedisAdapter.new(redis: redis, namespace: namespace)
+  Concussion.init
+end
+```
+ 
+Jobs any jobs which are set to run while the server is offline will run immediately on the initializer being run. For 
+this reason the initializer must be wrapped in an 'after_initialize' block to ensure all other components of the 
+application are ready for use.
+
+When defining a job, use the following form:
+
+```ruby
+class DoSomethingJob
+  include SuckerPunch::Job
+  prepend Concussion::Persist
+
+  def perform(opts = {})
+    MyThingDoer.new(opts).do_thing
+  end
+
+end
+```
+
+And call it with:
+
+```ruby
+run_at = Time.now + 5.hours
+DoSomethingJob.new.async.later run_at, opts
+```
+
+All done.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chemica/concussion. This project is 
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 
+[Contributor Covenant](contributor-covenant.org) code of conduct. Or something. These words were automatically
+added to this gem, but they are good words so they can stay.
+
+
+## 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 "concussion"
+
+# 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/concussion.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'concussion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "concussion"
+  spec.version       = Concussion::VERSION
+  spec.authors       = ["Benjamin Randles-Dunkley"]
+  spec.email         = ["ben@chemica.co.uk"]
+
+  spec.summary       = %q{An addition to the Suckerpunch gem to allow delayed jobs that survive a server reset.}
+  spec.description   = %q{Sucker Punch is an awesome gem which allows background tasks to be run from the current
+                          process. They can be set to run in the future, but they will disappear and not get run if the
+                          server or process running the jobs is stopped or restarted. Concussion uses the Ruby 2.x
+                          'prepend' feature to provide a thin wrapper around Suckerpunch job objects, persisting them to
+                          an external storage system of your choice. When the server is restarted, any jobs unprocessed
+                          jobs will be run immediately while future jobs will be reinstated to be run at the
+                          appropriate time.}
+  spec.homepage      = "https://github.com/chemica/concussion"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_dependency "sucker_punch", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/concussion.rb

@@ -0,0 +1,24 @@
+require "concussion/version"
+
+module Concussion
+
+  class << self
+    attr_accessor :store
+  end
+
+  def self.persist(klass, guid, time, *args)
+    store.set guid, {klass: klass.name, time: time, args: args}
+  end
+
+  def self.retire(guid)
+    store.del guid
+  end
+
+  def self.init
+    store.find_each do |guid, data|
+      retire guid
+      Object.const_get(data[:klass]).new.later data[:time], *(data[:args])
+    end
+  end
+
+end

data/lib/concussion/persist.rb

@@ -0,0 +1,20 @@
+module Concussion
+  module Persist
+    def perform(*args)
+      begin
+        super *args
+      ensure
+        Concussion.retire @guid
+      end
+    end
+
+    def later(time, *args)
+      time = Time.now if time < Time.now
+      seconds = (time - Time.now).to_i
+      @guid = SecureRandom.uuid
+      Concussion.persist(self.class, @guid, time, *args)
+
+      after(seconds) { perform(*args) }
+    end
+  end
+end

data/lib/concussion/redis_adapter.rb

@@ -0,0 +1,79 @@
+# An adapter class must create an instance object which responds to:
+#
+# get([key])          # returns data as an object (any ruby construct that can be Marshaled)
+
+# set([key], [data])  # sets data (a Marshalable object) against a text key.
+#                       Returns data if successful, or raises an exception.
+
+# del([key])          # Deletes data against [key] (String)
+
+# find_each(opts)     # Returns an enumerator or can be passed a block.
+#                       Enumerator iterates through all stored keys and yields the key
+#                       and the associated data (as a Ruby object)
+#                       find_each may take options as a hash (opts).
+#                       Currently it should only expect one option: :batch_size
+#                       which takes an integer.
+#
+# An adapter class instance must also provide a 'namespace' accessor, which can optionally be set to allow
+# multiple stores on the same storage device. In the case of Redis, this is added to the hash key.
+
+# An adapter class must allow 'namespace' to be set using the options on the 'initialize' method.
+#
+
+# This adapter uses a Redis hash, as providing a list of normal keys matching a pattern is problematic.
+# We manage key/value expiration outside Redis, to avoid jobs disappearing while the server is inactive.
+
+module Concussion
+  class RedisAdapter
+
+    attr_accessor :redis, :namespace
+
+    KEY                = "--concussion-redis-adapter-store"
+    DEFAULT_BATCH_SIZE = 1000
+
+    def initialize(opts = {})
+      self.redis = opts.fetch(:redis) { Redis.new }
+      self.namespace = opts.fetch(:namespace) { "" }
+    end
+
+    def namespaced_key
+      "#{namespace}#{KEY}"
+    end
+
+    def get(key)
+      decode_from_redis redis.hget(namespaced_key, key)
+    end
+
+    def set(key, data)
+      redis.hset(namespaced_key, key, encode_for_redis(data))
+      data
+    end
+
+    def del(key)
+      redis.hdel(namespaced_key, key)
+    end
+
+    def find_each(opts = {})
+      return enum_for(:find_each, opts) unless block_given?
+      batch_size = opts.fetch(:batch_size) { DEFAULT_BATCH_SIZE }
+      keys = redis.hkeys namespaced_key
+
+      keys.each_slice(batch_size).each do |key_slice|
+          Hash[key_slice.zip(redis.hmget(namespaced_key, key_slice))].each do |key, data|
+            yield key, decode_from_redis(data)
+          end
+      end
+    end
+
+    private
+
+    def decode_from_redis(str)
+      val = str.to_s.force_encoding('iso-8859-1')
+      val.present? ? Marshal.restore(val) : nil
+    end
+
+    def encode_for_redis(data)
+      Marshal.dump(data)
+    end
+  end
+end

data/lib/concussion/version.rb

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

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: concussion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Randles-Dunkley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Sucker Punch is an awesome gem which allows background tasks to be run from the current
+                            process. They can be set to run in the future, but they will disappear and not get run if the
+                            server or process running the jobs is stopped or restarted. Concussion uses the Ruby 2.x
+                            'prepend' feature to provide a thin wrapper around Suckerpunch job objects, persisting them to
+                            an external storage system of your choice. When the server is restarted, any jobs unprocessed
+                            jobs will be run immediately while future jobs will be reinstated to be run at the
+                            appropriate time.
+email:
+- ben@chemica.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- concussion.gemspec
+- lib/concussion.rb
+- lib/concussion/persist.rb
+- lib/concussion/redis_adapter.rb
+- lib/concussion/version.rb
+homepage: https://github.com/chemica/concussion
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: An addition to the Suckerpunch gem to allow delayed jobs that survive a server
+  reset.
+test_files: []