amok_time 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe053bae917824071c157ba458f05151a5bf5dda
+  data.tar.gz: 449d35331df3ed3c10c98ea642cdcdeed00e2646
+SHA512:
+  metadata.gz: a59caa914958d36858f6ccd9935826cfe6d90e403be5846b43480129c2a2a32cafd9a65dc73d8f8535e59bcc13083887afe769fcd1899fe85e6cc4bacb5c29d7
+  data.tar.gz: f4dff2622181a9d8f77f9add27d646cc9866240b97a806a344c439984847916e6be7fadc10f1b4657ad5345f3d8262db3e21e0be5da56ecc973eb914a82503cf

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,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matt Larraz
+
+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,103 @@
+# Amok Time
+
+Utility for mocking time across service boundaries on a per-request basis.
+Also passes the mock along to any background jobs enqueued during the request.
+
+Amok Time is designed for end-to-end testing distributed systems where certain behavior is time-based.
+It works by allowing any client to send a request header that overrides Ruby's date and time.
+
+What could **possibly** go wrong?
+
+<img src=https://i.imgur.com/ZqAy9co.jpg height="75%" width="75%" title="Safety not guaranteed"/>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amok_time'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amok_time
+
+## Usage
+
+```ruby
+# In a Rails initializer or equivalent file
+AmokTime.enable!
+```
+
+### Rails
+
+```ruby
+# In the same initializer as above
+require 'amok_time/rack_middleware'
+
+Rails.application.config.middleware.use AmokTime::RackMiddleware
+```
+
+### Sinatra
+
+```ruby
+require 'amok_time/rack_middleware'
+
+class MyApp < Sinatra::Base
+  use AmokTime::RackMiddleware
+end
+```
+
+### Sidekiq
+
+```ruby
+# In your sidekiq initializer
+
+require 'amok_time/sidekiq_middlware'
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add AmokTime::SidekiqMiddleware::Client
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add AmokTime::SidekiqMiddleware::Server
+  end
+
+  # Need this again for any downstream jobs enqueued
+  config.client_middleware do |chain|
+    chain.add AmokTime::SidekiqMiddleware::Client
+  end
+end
+```
+
+### API
+For a given HTTP request to a service with Amok Time enabled, you can add the following header
+
+```ruby
+req.headers['X-Amok-Time'] = timestamp.to_s # any Date or Time object will work
+```
+
+The app will then behave as if the request was sent at that date.
+
+## 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/[USERNAME]/amok_time.
+
+
+## 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/amok_time.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amok_time/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amok_time"
+  spec.version       = AmokTime::VERSION
+  spec.authors       = ["Matt Larraz"]
+  spec.email         = ["matt.larraz@gmail.com"]
+
+  spec.summary       = %q{Utility for mocking time across service boundaries on a per-request basis}
+  spec.description   = %q{Amok Time is designed for end-to-end testing distributed systems where certain behavior is time-based.
+It works by allowing any client to send a request header that overrides Ruby's date and time}
+  spec.homepage      = "https://github.com/mlarraz/amok_time"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

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

@@ -0,0 +1,16 @@
+require "amok_time/mixins"
+require "amok_time/version"
+
+module AmokTime
+  class << self
+    attr_accesor :enabled
+
+    def enable!
+      self.enabled = true
+
+      Date.singleton_class.prepend AmokTime::Mixins::Date
+      Time.singleton_class.prepend AmokTime::Mixins::Time
+      DateTime.singleton_class.prepend AmokTime::Mixins::DateTime
+    end
+  end
+end

data/lib/amok_time/mixins.rb

@@ -0,0 +1,72 @@
+module AmokTime
+  module Mixins
+    module Date
+      def today
+        if Thread.current[:amok_time].present?
+          Thread.current[:amok_time].to_date
+        else
+          super
+        end
+      end
+
+      def parse(*args)
+        str = args.first
+
+        if str && ::Date::DAYNAMES[str.capitalize]
+          offset = ::Date::DAYNAMES.index(str.capitalize) - ::Date.today.wday
+
+          ::Date.today + offset
+        else
+          super
+        end
+      end
+
+      # TODO: Figure out if this is necessary
+      # def strptime(str = '-4712-01-01', fmt = '%F', start = ::Date::ITALY)
+      #   ::Time.strptime(str, fmt).to_date
+      # end
+    end
+
+    module DateTime
+      def now
+        if Thread.current[:amok_time].present?
+          Thread.current[:amok_time].to_datetime
+        else
+          super
+        end
+      end
+
+      def parse(*args)
+        str = args.first
+
+        if str && ::Date::DAYNAMES[str.capitalize]
+          offset = ::Date::DAYNAMES.index(str.capitalize) - ::DateTime.now.wday
+
+          parsed_weekday = (::DateTime.now + offset)
+
+          ::DateTime.new(parsed_weekday.year, parsed_weekday.month, parsed_weekday.day, 0, 0, 0, 0)
+        else
+          super
+        end
+      end
+    end
+
+    module Time
+      def now
+        if Thread.current[:amok_time].present?
+          Thread.current[:amok_time].to_time
+        else
+          super
+        end
+      end
+
+      def new(*args)
+        if args.size <= 0
+          ::Time.now
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/amok_time/rack_middleware.rb

@@ -0,0 +1,17 @@
+module AmokTime
+  class RackMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      if AmokTime.enabled
+        Thread.current[:amok_time] = headers['X-Amok-Time']
+      end
+
+      [status, headers, response]
+    end
+  end
+end

data/lib/amok_time/rails_filter.rb

@@ -0,0 +1,9 @@
+module AmokTime
+  module RailsFilter
+    def self.before(controller)
+      if AmokTime.enabled
+        Thread.current[:amok_time] = controller.request.headers['X-Amok-Time']
+      end
+    end
+  end
+end

data/lib/amok_time/sidekiq_middleware.rb

@@ -0,0 +1,20 @@
+module AmokTime
+  module SidekiqMiddleware
+    # Get the mocked time and store it in the message
+    # to be sent to Sidekiq.
+    class Client
+      def call(worker_class, msg, queue, redis_pool)
+        msg['amok_time'] ||= Thread.current[:amok_time]
+        yield
+      end
+    end
+
+    # Pull the mocked time out and set the current thread to use it.
+    class Server
+      def call(worker, msg, queue)
+        Thread.current[:amok_time] = msg['amok_time']
+        yield
+      end
+    end
+  end
+end

data/lib/amok_time/version.rb

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: amok_time
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Larraz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: |-
+  Amok Time is designed for end-to-end testing distributed systems where certain behavior is time-based.
+  It works by allowing any client to send a request header that overrides Ruby's date and time
+email:
+- matt.larraz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amok_time.gemspec
+- bin/console
+- bin/setup
+- lib/amok_time.rb
+- lib/amok_time/mixins.rb
+- lib/amok_time/rack_middleware.rb
+- lib/amok_time/rails_filter.rb
+- lib/amok_time/sidekiq_middleware.rb
+- lib/amok_time/version.rb
+homepage: https://github.com/mlarraz/amok_time
+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: Utility for mocking time across service boundaries on a per-request basis
+test_files: []
+has_rdoc: