Sandboxy

Sandboxy allows you to use virtual data-oriented environments inside a Rails application while being able to switch between them at runtime. It achieves that by using a combination of Rack Middleware and ActiveRecord.

Installation
Usage
Configuration
Testing
- Test Coverage
To Do
Contributing
- Contributors
- Semantic versioning
License

Installation

Sandboxy works with Rails 5.0 onwards. You can add it to your Gemfile with:

gem 'sandboxy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sandboxy

If you always want to be up to date fetch the latest from GitHub in your Gemfile:

gem 'sandboxy', github: 'jonhue/sandboxy'

Now run the generator:

$ rails g sandboxy

To wrap things up, migrate the changes into your database:

$ rails db:migrate

Usage

Setup

Add Sandboxy to the models where you want to separate live & sandbox records:

class Foo < ApplicationRecord
    sandboxy
end

In most use cases you would want to add sandboxy to a lot of ActiveRecord models if not all. To simplify that you could create a new class and let all your models inherit from it:

class SharedSandbox < ApplicationRecord
    sandboxy
end

class Foo < SharedSandbox
end

`sandboxy` methods

By default you can only access records belonging to the current environment (live or sandbox):

$sandbox = true
Foo.all # => returns all sandbox foo's

Now to access the records belonging to a certain group regardless of your current environment, you can use:

Foo.live # => returns all live foo's
Foo.sandboxed # => returns all sandbox foo's
Foo.desandbox # => returns all foo's

Let's check to which environment this Foo belongs:

foo = Foo.create!
foo.live? # => false
foo.sandboxed? # => true

You should keep in mind that when you create a new record, it will automatically belong to your app's current environment.

Don't worry, you can move records between environments:

foo.make_live
foo.live? # => true
foo.make_sandboxed
foo.sandboxed? # => true

`Sandboxy` class methods

To access your default environment setting:

Sandboxy.configuration.environment # => 'live' / 'sandbox'
Sandboxy.configuration.sandbox? # => true / false
Sandboxy.configuration.live? # => true / false

Note: Sandboxy.configuration.environment does NOT return the apps current environment. For that use the $sandbox variable instead.

You can also access whether your app retains your environment throughout requests:

Sandboxy.configuration.retain_environment # => true / false

Switching environments

At runtime you can always switch environments by using the $sandbox variable anywhere in your application. Set it to true to enable the sandbox environment. Set it to false to enable the live environment. That makes Sandboxy super flexible.

Sandbox & APIs

It's flexibility allows Sandboxy to work really well with APIs.

Typically an API provides two sets of authentication credentials for a consumer - one for live access and one for sandbox/testing.

Whenever you authenticate your API's consumer, just make sure to set the $sandbox variable accordingly to the credential the consumer used. From thereon, Sandboxy will make sure that your consumer only reads & updates data from the environment he is in.

Configuration

You can configure Sandboxy by passing a block to configure. This can be done in config/initializers/sandboxy.rb:

Sandboxy.configure do |config|
    config.environment = 'sandbox'
end

environment Set your environment default: Must be either live or sandbox. This is the environment that your app boots with. By default it gets refreshed with every new request to your server. Defaults to 'live'.

retain_environment Specify whether to retain your current app environment on new requests. If set to true, your app will only load your environment default when starting. Every additional switch of your environment at runtime will then not be automatically resolved to your environment default on a new request. Takes a boolean. Defaults to false.

Testing

Tests are written with Shoulda on top of Test::Unit with Factory Girl being used instead of fixtures. Tests are run using rake.

Fork this repository
Clone your forked git locally
Install dependencies

$ bundle install
Run tests

$ rake test

Test Coverage

Test coverage can be calculated using SimpleCov. Make sure you have the simplecov gem installed.

Uncomment SimpleCov in the Gemfile
Uncomment the relevant section in test/test_helper.rb
Run tests

$ rake test

To Do

Here is the full list of current projects.

To propose your ideas, initiate the discussion by adding a new issue.

Contributing

We hope that you will consider contributing to Sandboxy. Please read this short overview for some information about how to get started:

Learn more about contributing to this repository, Code of Conduct

Contributors

Give the people some :heart: who are working on this project. See them all at:

https://github.com/jonhue/sandboxy/graphs/contributors

Semantic Versioning

Sandboxy follows Semantic Versioning 2.0 as defined at http://semver.org.

License

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.