laboratory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fddd4e5310fe374f6dce5c3662d4e171987a3aa1cd180fca0f4123890c74ff74
+  data.tar.gz: 22957e0e5595b93d4005dac1329f87ccc78428576a1b4519e7634edcb405eac3
+SHA512:
+  metadata.gz: 9ed204a1530ce008417f27407188a102982d77ec175f62fd0f117b9035c8f091f08700572798f9071ac2c352e5f199e8e6a53f114864005622e054beb69073a6
+  data.tar.gz: b0fbec760e8b1187ed5917b4d9e7ddd936e9b7caebc2f89738ed4d09fe6688a9343394eb2fac7e18f13b6ef0821226f6cfc4d4e6be39ccf3d4e12afe628dfdfd

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at npaters@tcd.ie. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in laboratory.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    laboratory (0.1.0)
+      redis (>= 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    fakeredis (0.8.0)
+      redis (~> 4.1)
+    rake (12.3.3)
+    redis (4.1.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeredis (~> 0.8)
+  laboratory!
+  rake (~> 12.0)
+  rspec (~> 3.8)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Niall Paterson
+
+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,265 @@
+# Laboratory 🧪
+
+Laboratory is an A/B testing and Feature Flag framework for Rails. It's focused on a number of key philosophies, all garnered from running A/B tests and feature flags in commercial settings and experiencing issues with other A/B testing gems out there:
+
+* Cohesiveness
+  * A/B tests and feature flags are, in many ways, very similar. Laboratory looks to marry them into a single 'Experiment' concept.
+* Flexiblity
+  * Laboratory allows you manage your A/B tests and feature flags with no code changes, through the Laboratory UI.
+* Tracability and Accountability
+  * It is vital that any updates or changes to an A/B test or feature flag is documented in a changelog with full tracability back to the user who performed the change. This is built into Laboratory.
+* Simplicity, while not being simplisitic
+  * Laboratory comes with a single A/B test algorithm and single storage adapter built-in, which we think will cover 99% of use cases for A/B testing and Feature Flagging. If you're in that 1%, it's easy to extend Laboratory to add custom Algorithms and Storage mechanisms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'laboratory'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install laboratory
+
+
+## Usage
+
+### Defining the adapter
+
+In an initializer (`app/config/initializers/laboratory.rb`), define the adapter you are going to use with Laboratory. Laboratory supports Redis out of the box, as it the recommended adapter:
+
+```ruby
+Laboratory::Config.adapter = Laboratory::Adapters::RedisAdapter.new(url: 'redis://localhost:6789') # Adjust to your redis URL.
+```
+
+### Defining your current_user_id & actor
+
+Laboratory needs to know which user is currently active when determining which variant to use for an experiment. It is also useful to define an 'actor' - the user who actions any changes to any Laboratory experiments - for better accountability and tracability tracking through the changelog.
+
+For **Rails**, we recommend defining a before_action in application_controller to do this:
+
+```ruby
+class ApplicationController
+
+  before_action :set_laboratory_current_user_id
+  before_action :set_laboratory_actor
+
+  def set_laboratory_current_user_id
+    Laboratory::Config.current_user_id = your_current_user_id
+  end
+
+  def set_laboratory_actor
+    Laboratory::Config.actor = 'Tom Jones'
+  end
+```
+
+Note: From experience, we recommend storing an identifier in a cookie once a new device is identified, and storing it on the user once that user has been identified (by signing up, logging in etc). This identifier should not change when the user logs out as otherwise you will find users experiencing multiple variants of the same test.
+
+
+### Setting up an experiment
+
+We recommend defining all of your A/B tests and feature flags in a single location (like an initializer) to make it easy to keep track of all tests and flags running but it absolutely possible to define them wherever they are needed. We use `find_or_create` below to create them to ensure they are created the first time they are deployed, and maintained throughout:
+
+```ruby
+Laboratory::Experiment.find_or_create(
+  id: 'blue_button_ab_test',
+  variants: [
+    {
+      id: 'control',
+      percentage: 50 # Note these percentages are just the initial starting percentages and may be adjusted dynamically in the future.
+    },
+    {
+      id: 'variant_a',
+      percentage: 50
+    }
+  ]
+)
+
+Laboratory::Experiment.find_or_create(
+  id: 'new_checkout_feature_flag',
+  variants: [
+    {
+      id: 'control',
+      percentage: 100
+    },
+    {
+      id: 'new_checkout',
+      percentage: 0
+    }
+  ]
+)
+```
+
+### Using an experiment
+
+Once an experiment has been defined, it's simple to use the experiment:
+
+```ruby
+experiment = Laboratory::Experiment.find('blue_button_ab_test')
+variant = experiment.variant
+
+if variant.id == 'control'
+  ...
+else
+  ...
+end
+```
+
+Note the `#variant` method also takes an optional user parameter should you want to define the user specifically in this case. It defaults to a user with the current_user_id defined in the Laboratory configuration.
+
+### Defining an event
+
+Events are a way to track key milestones for the purposes of later analysis. Each event is then displayed on the Laboratory Dashboard with significance levels. An event can be recorded as follows:
+
+```ruby
+experiment = Laboratory::Experiment.find('blue_button_ab_test')
+experiment.record_event!('completed')
+```
+
+Note the `#record_event!` method also takes an optional user parameter should you want to define the user specifically in this case. It defaults to a user with the current_user_id defined in the Laboratory configuration.
+
+### Using the Laboratory UI
+
+It's easy to analyse and manage your experiment from the dashboard. In routes.rb, mount the dashboard behind your appropriate authentication layer (this example uses Devise):
+
+```ruby
+authenticate :admin_user do
+  mount Laboratory::UI, at: 'admin/laboratory'
+  ...
+end
+```
+
+You can now visit /admin/laboratory to view the progess of your experiment, and update the variants as needed.
+
+### Analytics Integrations
+
+It's common to trigger analytics events upon common actions like a user being assigned to a variant, or an event occuring. Laboratory makes it easy to do this through two callback handlers that can be defined as so:
+
+**When a user gets assigned to a variant**:
+
+```ruby
+Laboratory::Config.on_assignment_to_variant = -> (experiment, variant, user) {
+  ...
+}
+```
+
+**When an event is recorded**:
+
+```ruby
+Laboratory::Config.on_event_recorded = -> (experiment, variant, user, event) {
+  ...
+}
+```
+
+### Managing an Experiment outside the regular request cycle
+
+Sometimes, you need to go a bit deeper with a test to understand which users are seeing which variant, or enforce a certain variant for a user. Laboratory has a number of tools to help you do this.
+
+**Finding all participants in a variant**:
+
+```ruby
+experiment = Laboratory::Experiment.find('blue_button_cta')
+control = experiment.variants.first
+
+control.participants_id
+```
+
+**Setting a user to a specific variant**:
+
+```ruby
+experiment = Laboratory::Experiment.find('blue_button_cta')
+user = Laboratory::User.new(id: 1)
+
+experiment.assign_to_variant('control', user: user)
+```
+
+Note the `#assign_to_variant` method also takes an optional user parameter should you want to define the user specifically in this case (like above). It defaults to a user with the current_user_id defined in the Laboratory configuration if you omit it.
+
+**Fetching the changelog for an experiment**
+
+```ruby
+experiment = Laboratory::Experiment.find('blue_button_cta')
+experiment.changelog
+```
+
+**Finding all the experiments a user is in**:
+
+```ruby
+user = Laboratory::User.new(id: 1)
+user.experiments
+```
+
+**Finding the variant a user is in for a specific experiment**:
+
+```ruby
+experiment = Laboratory::Experiment.find('blue_button_cta')
+user = Laboratory::User.new(id: 1)
+
+user.variant_for_experiment(experiment) # Note: This returns nil if the user is not in the experiment
+```
+
+**Updating an experiment's variants**:
+
+Note: This would wipe all users from the experiment.
+
+```ruby
+experiment = Laboratory::Experiment.find('blue_button_cta')
+variants = [
+  {
+    id: 'control',
+    percentage: 40
+  },
+  {
+    id: 'variant_a',
+    percentage: 60
+  }
+]
+
+experiment.update(variants: new_variants)
+```
+
+**Finding the current user**:
+
+The following will return a Laboratory::User object with the user id matching the current_user_id defined in the Laboratory configuration.
+
+```ruby
+Laboratory::Config.current_user
+```
+
+
+### Building your own adapters and algorithms
+
+**Adapters**:
+
+Any adapter just needs to the respond to the following methods:
+
+* `#write(experiment)`
+* `#read(experiment_id)`
+* `#read_all`
+* `#delete(experiment_id)`
+* `#delete_all`
+
+**Algorithm**:
+
+Any algorithm just needs to respond to a `#pick!(variants)` and a `#id` method, and needs to be added to the `Laboratory::Algorithms#ALGORITHMS` definition. The `#id` method returns an identifier that is used for serialisation purposes.
+
+## 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/butternutbox/laboratory. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to that.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

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

@@ -0,0 +1,32 @@
+require_relative 'lib/laboratory/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'laboratory'
+  spec.version = Laboratory::VERSION
+  spec.authors = ['Niall Paterson']
+  spec.email = ['niall@butternutbox.com']
+
+  spec.summary = 'Laboratory: An A/B Testing and Feature Flag system for Ruby'
+  spec.description = 'Laboratory: An A/B Testing and Feature Flag system for Ruby'
+  spec.homepage = 'https://github.com/butternutbox/laboratory'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/butternutbox/laboratory'
+  spec.metadata['changelog_uri'] = 'https://github.com/butternutbox/laboratory/releases'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'redis', '>= 2.1'
+
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'fakeredis', '~> 0.8'
+end

data/lib/laboratory/adapters/mock_adapter.rb

@@ -0,0 +1,31 @@
+module Laboratory
+  module Adapters
+    class MockAdapter
+      attr_accessor :experiment_hash
+
+      def initialize
+        @experiment_hash = {}
+      end
+
+      def write(experiment)
+        experiment_hash[experiment.id] = experiment
+      end
+
+      def read_all
+        experiment_hash.values
+      end
+
+      def read(experiment_id)
+        experiment_hash[experiment_id]
+      end
+
+      def delete(experiment_id)
+        experiment_hash.delete(experiment_id)
+      end
+
+      def delete_all
+        @experiment_hash = {}
+      end
+    end
+  end
+end

data/lib/laboratory/adapters/redis_adapter.rb

@@ -0,0 +1,149 @@
+module Laboratory
+  module Adapters
+    class RedisAdapter
+      attr_reader :redis
+
+      ALL_EXPERIMENTS_KEYS_KEY = 'SWITCH_ALL_EXPERIMENT_KEYS'.freeze
+
+      def initialize(url:)
+        @redis = Redis.new(url: url)
+
+        if !redis.get(ALL_EXPERIMENTS_KEYS_KEY)
+          redis.set(ALL_EXPERIMENTS_KEYS_KEY, [])
+        end
+      end
+
+      def write(experiment)
+        redis.set(redis_key(experiment_id: experiment.id), experiment_to_json(experiment))
+
+        # Write to ALL_EXPERIMENTS_KEY_KEY if it isn't already there.
+        experiment_ids = JSON.parse(redis.get(ALL_EXPERIMENTS_KEYS_KEY))
+        experiment_ids << experiment.id unless experiment_ids.include?(experiment.id)
+        redis.set(ALL_EXPERIMENTS_KEYS_KEY, experiment_ids.to_json)
+      end
+
+      def read(experiment_id)
+        key = redis_key(experiment_id: experiment_id)
+        response = redis.get(key)
+
+        return nil if response.nil?
+        parse_json_to_experiment(JSON.parse(response))
+      end
+
+      def read_all
+        experiment_ids = JSON.parse(redis.get(ALL_EXPERIMENTS_KEYS_KEY))
+        experiment_ids.map do |experiment_id|
+          read(experiment_id)
+        end
+      end
+
+      def delete(experiment_id)
+        key = redis_key(experiment_id: experiment_id)
+        redis.del(key)
+
+        # Remove from ALL_EXPERIMENTS_KEY_KEY
+        experiment_ids = JSON.parse(redis.get(ALL_EXPERIMENTS_KEYS_KEY))
+        experiment_ids.delete(experiment_id)
+        redis.set(ALL_EXPERIMENTS_KEYS_KEY, experiment_ids.to_json)
+      end
+
+      def delete_all
+        experiment_ids = JSON.parse(redis.get(ALL_EXPERIMENTS_KEYS_KEY))
+        experiment_ids.each { |experiment_id| delete(experiment_id) }
+      end
+
+      private
+
+      def redis_key(experiment_id:)
+        "laboratory_#{experiment_id}"
+      end
+
+      def experiment_to_json(experiment)
+        {
+          id: experiment.id,
+          algorithm: experiment.algorithm.id,
+          variants: experiment_variants_to_hash(experiment.variants),
+          changelog: experiment.changelog
+        }.to_json
+      end
+
+      def experiment_variants_to_hash(variants)
+        variants.map do |variant|
+          {
+            id: variant.id,
+            percentage: variant.percentage,
+            participant_ids: variant.participant_ids,
+            events: experiment_events_to_hash(variant.events)
+          }
+        end
+      end
+
+      def experiment_events_to_hash(events)
+        events.map do |event|
+          {
+            id: event.id,
+            event_recordings: experiment_event_recordings_to_hash(event.event_recordings)
+          }
+        end
+      end
+
+      def experiment_event_recordings_to_hash(event_recordings)
+        event_recordings.map do |event_recording|
+          {
+            user_id: event_recording.user_id,
+            timestamp: event_recording.timestamp
+          }
+        end
+      end
+
+      def parse_json_to_experiment(json)
+        Experiment.new(
+          id: json['id'],
+          algorithm: Algorithms.to_class(json['algorithm']),
+          variants: parse_json_to_experiment_variants(json['variants']),
+          changelog: parse_json_to_experiment_changelog_items(json['changelog'])
+        )
+      end
+
+      def parse_json_to_experiment_variants(variants_json)
+        variants_json.map do |json|
+          Experiment::Variant.new(
+            id: json['id'],
+            percentage: json['percentage'],
+            participant_ids: json['participant_ids'],
+            events: parse_json_to_experiment_events(json['events'])
+          )
+        end
+      end
+
+      def parse_json_to_experiment_changelog_items(changelog_json)
+        changelog_json.map do |json|
+          Experiment::ChangelogItems.new(
+            action: json[:action],
+            changes: json[:changes],
+            timestamp: json[:timestamp],
+            actor: json[:actor]
+          )
+        end
+      end
+
+      def parse_json_to_experiment_events(events_json)
+        events_json.map do |json|
+          Experiment::Event.new(
+            id: json['id'],
+            event_recordings: parse_json_to_experiment_event_recordings(json['event_recordings'])
+          )
+        end
+      end
+
+      def parse_json_to_experiment_event_recordings(event_recordings_json)
+        event_recordings_json.map do |json|
+          Experiment::Event::Recording.new(
+            user_id: json['user_id'],
+            timestamp: json['timestamp']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/laboratory/algorithms/random.rb

@@ -0,0 +1,13 @@
+module Laboratory
+  module Algorithms
+    class Random
+      def self.pick!(variants)
+        variants.sort_by { |variant| - variant.percentage * rand() }.first
+      end
+
+      def self.id
+        'RANDOM'
+      end
+    end
+  end
+end

data/lib/laboratory/algorithms.rb

@@ -0,0 +1,11 @@
+module Laboratory
+  module Algorithms
+    ALGORITHMS = [
+      Laboratory::Algorithms::Random
+    ].freeze
+
+    def self.to_class(algorithm_id)
+      ALGORITHMS.find { |algorithm_class| algorithm_class.id == algorithm_id }
+    end
+  end
+end

data/lib/laboratory/config.rb

@@ -0,0 +1,17 @@
+module Laboratory
+  class Config
+    class << self
+      attr_accessor(
+        :current_user_id,
+        :adapter,
+        :actor,
+        :on_assignment_to_variant,
+        :on_event_recorded
+      )
+
+      def current_user
+        @current_user ||= Laboratory::User.new(id: current_user_id)
+      end
+    end
+  end
+end

data/lib/laboratory/experiment/changelog_item.rb

@@ -0,0 +1,14 @@
+module Laboratory
+  class Experiment
+    class ChangelogItem
+      attr_reader :action, :changes, :timestamp, :actor
+
+      def initialize(action:, changes: [], timestamp:, actor:)
+        @action = action
+        @changes = changes
+        @timestamp = timestamp
+        @actor = actor
+      end
+    end
+  end
+end

data/lib/laboratory/experiment/event/recording.rb

@@ -0,0 +1,14 @@
+module Laboratory
+  class Experiment
+    class Event
+      class Recording
+        attr_reader :user_id, :timestamp
+
+        def initialize(user_id:, timestamp: Time.now)
+          @user_id = user_id
+          @timestamp = timestamp
+        end
+      end
+    end
+  end
+end

data/lib/laboratory/experiment/event.rb

@@ -0,0 +1,12 @@
+module Laboratory
+  class Experiment
+    class Event
+      attr_reader :id, :event_recordings
+
+      def initialize(id:, event_recordings: [])
+        @id = id
+        @event_recordings = event_recordings
+      end
+    end
+  end
+end

data/lib/laboratory/experiment/variant.rb

@@ -0,0 +1,18 @@
+module Laboratory
+  class Experiment
+    class Variant
+      attr_reader :id, :percentage, :participant_ids, :events
+
+      def initialize(id:, percentage:, participant_ids: [], events: [])
+        @id = id
+        @percentage = percentage
+        @participant_ids = participant_ids
+        @events = events
+      end
+
+      def add_participant(user)
+        participant_ids << user.id
+      end
+    end
+  end
+end

data/lib/laboratory/experiment.rb

@@ -0,0 +1,213 @@
+module Laboratory
+  class Experiment
+    class UserNotInExperimentError < StandardError; end
+    class ClashingExperimentIdError < StandardError; end
+    class MissingExperimentIdError < StandardError; end
+    class MissingExperimentAlgorithmError < StandardError; end
+    class InvalidExperimentVariantFormatError < StandardError; end
+    class IncorrectPercentageTotalError < StandardError; end
+
+    attr_reader :id, :variants, :algorithm, :changelog
+
+    def initialize(id:, variants:, algorithm: Algorithms::Random, changelog: [])
+      @id = id
+      @algorithm = algorithm
+      @changelog = changelog
+
+      # We want to allow users to input Variant objects, or simple hashes.
+      # This also helps when decoding from adapters
+
+      @variants =
+        if variants.all? { |variant| variant.instance_of?(Laboratory::Experiment::Variant) }
+          variants
+        elsif variants.all? { |variant| variant.instance_of?(Hash) }
+          variants.map do |variant|
+            Variant.new(
+              id: variant[:id],
+              percentage: variant[:percentage],
+              participant_ids: [],
+              events: []
+            )
+          end
+        end
+    end
+
+    def self.all
+      Laboratory.config.adapter.read_all
+    end
+
+    def self.create(id:, variants:, algorithm: Algorithms::Random)
+      raise ClashingExperimentIdError if find(id)
+
+      changelog_item = Laboratory::Experiment::ChangelogItem.new(
+        action: :create,
+        changes: [],
+        timestamp: Time.now,
+        actor: Laboratory::Config.actor
+      )
+
+      experiment = Experiment.new(
+        id: id,
+        variants: variants,
+        algorithm: algorithm,
+        changelog: [changelog_item]
+      )
+
+      experiment.write!
+      experiment
+    end
+
+    def self.find(id)
+      Laboratory.config.adapter.read(id)
+    end
+
+    def self.find_or_create(id:, variants:, algorithm: Algorithms::Random)
+      find(id) || create(id: id, variants: variants, algorithm: algorithm)
+    end
+
+    def update(attrs)
+      # delete previous key if valid? passes below.
+      old_id = id
+
+      # Diff changes
+
+      current_hash = {
+        id: id,
+        variants: variants.map { |variant|
+          {
+            id: variant.id,
+            percentage: variant.percentage
+          }
+        },
+        algorithm: algorithm
+      }
+
+      updated_variants_subhash = attrs[:variants]&.map do |variant|
+        {
+          id: variant[:id],
+          percentage: variant[:percentage]
+        }
+      end
+
+      updated_hash = {
+        id: attrs[:id] || id,
+        variants: updated_variants_subhash || current_hash[:variants],
+        algorithm: attrs[:algorithm] || algorithm
+      }
+
+      changes = current_hash.to_a - updated_hash.to_a
+      @id = attrs[:id] if !attrs[:id].nil?
+      @variants = attrs[:variants] if !attrs[:variants].nil?
+      @algorithm = attrs[:algorithm] if !attrs[:algorithm].nil?
+
+      raise errors.first unless valid?
+
+      changelog_item = Laboratory::Experiment::ChangelogItem.new(
+        action: :update,
+        changes: changes,
+        timestamp: Time.now,
+        actor: Laboratory.config.actor
+      )
+
+      @changelog << changelog_item
+
+      Laboratory.config.adapter.delete(old_id)
+      write!
+      self
+    end
+
+    def delete
+      Laboratory.config.adapter.delete(id)
+      nil
+    end
+
+    def variant(user: Laboratory.config.current_user)
+      selected_variant = variants.find { |variant| variant.participant_ids.include?(user.id)}
+      return selected_variant if !selected_variant.nil?
+
+      variant = algorithm.pick!(variants)
+      variant.add_participant(user)
+
+      Laboratory::Config.on_assignment_to_variant&.call(self, variant, user)
+
+      write!
+      variant
+    end
+
+    def assign_to_variant(variant_id, user: Laboratory.config.current_user)
+      variants.each do |variant|
+        variant.participant_ids.delete(user.id)
+      end
+
+      variant = variants.find { |s| s.id == variant_id }
+      variant.add_participant(user)
+
+      Laboratory::Config.on_assignment_to_variant&.call(self, variant, user)
+
+      write!
+      variant
+    end
+
+    def record_event!(event_id, user: Laboratory.config.current_user)
+      variant = variants.find { |s| s.participant_ids.include?(user.id) }
+      raise UserNotInExperimentError unless variant
+
+      maybe_event = variant.events.find { |event| event.id == event_id }
+      event =
+        if maybe_event != nil
+          maybe_event
+        else
+          e = Event.new(id: event_id)
+          variant.events << e
+          e
+        end
+      event_recording = Event::Recording.new(user_id: user.id)
+
+      event.event_recordings << event_recording
+
+      Laboratory::Config.on_event_recorded&.call(self, variant, user, event)
+
+      write!
+      event_recording
+    end
+
+    def write!
+      raise errors.first unless valid?
+      Laboratory.config.adapter.write(self)
+    end
+
+    def valid?
+      valid_variants =
+        variants.all? do |variant|
+          !variant.id.nil? && !variant.percentage.nil?
+        end
+
+      valid_percentage_amounts =
+        variants.map(&:percentage).sum == 100
+
+      !id.nil? && !algorithm.nil? && valid_variants && valid_percentage_amounts
+    end
+
+    def errors
+      errors = []
+
+      missing_variant_ids = variants.any? do |variant|
+        variant.id.nil?
+      end
+
+      missing_variant_percentages = variants.any? do |variant|
+        variant.percentage.nil?
+      end
+
+      incorrect_percentage_total = variants.map(&:percentage).sum != 100
+
+      errors << MissingExperimentIdError if id.nil?
+      errors << MissingExperimentAlgorithmError if algorithm.nil?
+      errors << MissingExperimentVariantIdError if missing_variant_ids
+      errors << MissingExperimentVariantPercentageError if missing_variant_percentages
+      errors << IncorrectPercentageTotalError if incorrect_percentage_total
+
+      errors
+    end
+  end
+end

data/lib/laboratory/user.rb

@@ -0,0 +1,23 @@
+module Laboratory
+  class User
+    attr_reader :id
+
+    def initialize(id:)
+      @id = id
+    end
+
+    def experiments
+      Experiment.all.select do |experiment|
+        experiment.variants.any? do |variant|
+          variant.participant_ids.include?(id)
+        end
+      end
+    end
+
+    def variant_for_experiment(experiment)
+      experiment.variants.find do |variant|
+        variant.participant_ids.include?(id)
+      end
+    end
+  end
+end

data/lib/laboratory/version.rb

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

data/lib/laboratory.rb

@@ -0,0 +1,20 @@
+require 'laboratory/version'
+require 'laboratory/config'
+require 'laboratory/user'
+require 'laboratory/adapters/redis_adapter'
+require 'laboratory/adapters/mock_adapter'
+require 'laboratory/algorithms/random'
+require 'laboratory/algorithms'
+require 'laboratory/experiment'
+require 'laboratory/experiment/variant'
+require 'laboratory/experiment/changelog_item'
+require 'laboratory/experiment/event'
+require 'laboratory/experiment/event/recording'
+
+module Laboratory
+  class << self
+    def config
+      Laboratory::Config
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: laboratory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Niall Paterson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 'Laboratory: An A/B Testing and Feature Flag system for Ruby'
+email:
+- niall@butternutbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- laboratory.gemspec
+- lib/laboratory.rb
+- lib/laboratory/adapters/mock_adapter.rb
+- lib/laboratory/adapters/redis_adapter.rb
+- lib/laboratory/algorithms.rb
+- lib/laboratory/algorithms/random.rb
+- lib/laboratory/config.rb
+- lib/laboratory/experiment.rb
+- lib/laboratory/experiment/changelog_item.rb
+- lib/laboratory/experiment/event.rb
+- lib/laboratory/experiment/event/recording.rb
+- lib/laboratory/experiment/variant.rb
+- lib/laboratory/user.rb
+- lib/laboratory/version.rb
+homepage: https://github.com/butternutbox/laboratory
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/butternutbox/laboratory
+  source_code_uri: https://github.com/butternutbox/laboratory
+  changelog_uri: https://github.com/butternutbox/laboratory/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: 'Laboratory: An A/B Testing and Feature Flag system for Ruby'
+test_files: []