flux_capacitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bdc364e1a19df5645ef0291b4c8fb231f7a5c91
+  data.tar.gz: 1fd589797273708272ef7db6908eeee460fc5b3c
+SHA512:
+  metadata.gz: e33a47111b4fa40fd04b6e28894c89f0a4b5db3e295e21e42369dbe6d34181e822fa9447c1190ccf55c2e628a718ef1957d9b2242738495d8e4cdb79d81ce882
+  data.tar.gz: 3e5be9ef3e76884bb73b8ba2bf6a6399724775899b44ab62b391726cf8f2f75f07d6e9c7929a046187cc71e25b074f45be57dfe08ea2112eb62d9e3b545e88ed

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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.15.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,73 @@
+# FluxCapacitor
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/flux_capacitor`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flux_capacitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flux_capacitor
+
+## Usage
+
+```ruby
+require 'flux_capacitor'
+
+pivot = DateTime.parse('2017/08/14 00:00:00-000') # Everything after this date will have the new feature. This is the point in time when your new feature will start to go live
+oldest = MyModel.first.created_at # If you are using active record finding your oldest item is pretty easy, otherwise if you know the date of your first item, just use that
+end_point = DateTime.parse('2017/09/14') # At this point the feature should be fully rolled out and it is safe to remove the Flux Capacitor. This dictates how quickly the feature rolls out. If you are concerned about overloading a required service set this to farther in the future to lower load
+
+FEATURE_1_CAPACITOR = Flux::Capacitor.new(pivot, end_point, oldest)
+
+def controller_method
+    model = MyModel.find(params[:id])
+    if FEATURE_1_CAPACITOR.travel_to?(model.created_at)
+        use_new_feature
+    else
+        use_old_feature
+    end
+end
+```
+
+If your feature doesn't map well to something where you have a date for each piece of content you can still use flux capacitor. It can also take strings and distribute them evenly over your rollout period using the murmur3 hashing algorithm.
+```ruby
+require 'flux_capacitor'
+pivot = DateTime.parse('2017/08/14 00:00:00-000') # when do you want to start rolling out the feature
+end_point = DateTime.parse('2017/09/14') # when do you want the rollout to finish
+
+# NOTE: We don't need an oldest date when using strings
+FEATURE_1_CAPACITOR = Flux::Capacitor.new(pivot, end_point)
+
+def controller_method
+    model = MyModel.find(params[:id])
+    if FEATURE_1_CAPACITOR.travel_to?(model.uuid)
+        use_new_feature
+    else
+        use_old_feature
+    end
+end
+```
+
+One note about using the string hashing method, new content could get the old feature for a while.
+
+## 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/raphaeleidus/flux_capacitor.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flux_capacitor"
+
+# 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(__FILE__)

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/flux_capacitor.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "flux_capacitor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "flux_capacitor"
+  spec.version       = Flux::VERSION
+  spec.authors       = ["Raphael Eidus"]
+  spec.email         = ["raphaeleidus@gmail.com"]
+
+  spec.summary       = %q{Utility for progressively rolling out a feature to existing content}
+  spec.description   = %q{When you have some service that might not be able to handle a large transition of historical content, say a dynamic image service.
+    Instead of changing everything at once you can use the flux capacitor to progressively enable the new functionality based on content age.}
+  spec.homepage      = "https://github.com/raphaeleidus/flux_capacitor"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "murmurhash3"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/flux_capacitor.rb

@@ -0,0 +1,52 @@
+require 'flux_capacitor/version'
+require 'date'
+require 'murmurhash3'
+
+module Flux
+
+  class Capacitor
+    attr_reader :pivot, :pivot_ts, :time_dilation
+    def initialize (start_time, completion_target, oldest_target = Capacitor.oldest_string_time(start_time))
+      @pivot = start_time
+      @pivot_ts = pivot.strftime("%s").to_i
+      time_to_complete = seconds_between(completion_target, pivot)
+      dilation = seconds_between(pivot, oldest_target).to_f / time_to_complete.to_f
+      @time_dilation = dilation
+    end
+
+    def limit
+      diff = seconds_between(DateTime.now, pivot)
+      datetime_minus_seconds(pivot, (diff * time_dilation).to_i)
+    end
+
+    def travel_to?(destination)
+      destination = destination.is_a?(DateTime) ? destination : string_to_time(destination)
+      limit < destination
+    end
+
+    def string_to_time(str)
+      Capacitor.string_to_time(pivot, str)
+    end
+
+    def self.string_to_time(pivot, str)
+      timestamp  = pivot.strftime("%s").to_i - (MurmurHash3::V32.str_hexdigest(str).to_i(16)/8)
+      DateTime.strptime(timestamp.to_s, "%s")
+    end
+
+    def self.oldest_string_time(pivot)
+      timestamp  = pivot.strftime("%s").to_i - ("ffffffff".to_i(16)/8)
+      DateTime.strptime(timestamp.to_s, "%s")
+    end
+
+    private
+
+    def seconds_between(date_time_1, date_time_2)
+      date_time_1.strftime("%s").to_i - date_time_2.strftime("%s").to_i
+    end
+
+    def datetime_minus_seconds(datetime, seconds)
+      ts = (datetime.strftime("%s").to_i - seconds).to_s
+      DateTime.strptime(ts, "%s")
+    end
+  end
+end

data/lib/flux_capacitor/version.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: flux_capacitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raphael Eidus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: murmurhash3
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: |-
+  When you have some service that might not be able to handle a large transition of historical content, say a dynamic image service.
+      Instead of changing everything at once you can use the flux capacitor to progressively enable the new functionality based on content age.
+email:
+- raphaeleidus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flux_capacitor.gemspec
+- lib/flux_capacitor.rb
+- lib/flux_capacitor/version.rb
+homepage: https://github.com/raphaeleidus/flux_capacitor
+licenses: []
+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 progressively rolling out a feature to existing content
+test_files: []