sandboxy 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0900175ab295d91c3afe0ae5dcb2de0b1d82612
-  data.tar.gz: 2777176852c4b7abbf7d5ec92c2ef427bc94ae4a
+SHA256:
+  metadata.gz: a5eac48d43fcaf454f691ca0169d9ba357f31e46b30aa452e4de0d99f172e9a7
+  data.tar.gz: 61eeb91dfcd1b788cd95b4f8944684b792552e1f378b46c910eb46e8b2a454a0
 SHA512:
-  metadata.gz: 1f65c09ea2e4982e6013cf1cbbc8672a1d236187052c2580418fb7cfe6c72c2d52dfa859e1d26ede4828be0cb50d746eb507f83e5c6c6825c640ac1b57b347e7
-  data.tar.gz: 152653d0560fc783bf4f0b7d56dc01cc955b37fb8674f2bfe03818bca506c22fdf45dcd785769bc08974dc401ded0a750d97a6d30cd03d19b73ca28dab9ca272
+  metadata.gz: be725877526b7a6e616670c73a0ea5348a0feee76e05d600ad4aa404e04d64b5e1dce0dcb17a2aadadcd692235e3ac09a6f7ad942b51abe652ce17ec3890d1ec
+  data.tar.gz: 51d58e7689ffef821e4d44a71be4aea455b3e19976c58c963caa1c968789754f25f12eb4f4dcaffe0bd46cc00ba80fb043aca9665c88939bb4d7babae4333e5d

data/.github/pull_request_template.md

@@ -16,6 +16,6 @@ CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the f
 
 Finally, if your pull request affects documentation or any non-code
 changes, guidelines for those changes are [available
-here](https://github.com/slooob/sandboxy/blob/master/CONTRIBUTING.md)
+here](https://github.com/jonhue/sandboxy/blob/master/CONTRIBUTING.md)
 
-Thanks for contributing to `sandboxy`!
+Thanks for contributing to Sandboxy!

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 * nothing yet
 
+### 2.0.0 - 2017-12-21
+
+* features
+    * configuration by passing a block to `configure`
+    * generator generates initializer instead of yaml file
+
 ### 1.1.1 - 2017-08-27
 
 * bugfixes

data/CODE_OF_CONDUCT.md

@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at help@slooob.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jonas.huebotter@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
 

data/DEPRECATIONS.md

@@ -1,3 +1,5 @@
 # Deprecations
 
-No deprecations
+### 2.0.0 - 2017-12-21
+
+* `config/sandboxy.yml` file replaced by initializer

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
 

data/INSTALL.md

@@ -1,3 +1,3 @@
 **Thank you for installing sandboxy!**
 Get started by running `rails g sandboxy`.
-Learn more at https://github.com/slooob/sandboxy.
+Learn more at https://github.com/jonhue/sandboxy.

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Slooob
+Copyright (c) 2017 Jonas Hübotter
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,8 @@
-# Sandboxy - virtual data-oriented environments for Rails
+# Sandboxy
 
-<img src="https://travis-ci.org/slooob/sandboxy.svg?branch=master" /> [![Gem Version](https://badge.fury.io/rb/sandboxy.svg)](https://badge.fury.io/rb/sandboxy)
+[![Gem Version](https://badge.fury.io/rb/sandboxy.svg)](https://badge.fury.io/rb/sandboxy) <img src="https://travis-ci.org/jonhue/sandboxy.svg?branch=master" />
 
-Sandboxy allows you to use virtual data-oriented environments inside a Rails application while being able to switch in between at runtime. It achieves that by using a combination of Rack Middleware and ActiveRecord.
+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.
 
 ---
 
@@ -11,22 +11,24 @@ Sandboxy allows you to use virtual data-oriented environments inside a Rails app
 * [Installation](#installation)
 * [Usage](#usage)
     * [Setup](#setup)
-    * [Configuration](#configuration)
-    * [Sandboxed methods](#sandboxed-methods)
-    * [Sandboxy methods](#sandboxy-methods)
+    * [`sandboxy` methods](#sandboxy-methods)
+    * [Sandboxy class methods](#sandboxy-class-methods)
     * [Switching environments](#switching-environments)
         * [Sandbox & APIs](#sandbox--apis)
+* [Configuration](#configuration)
+* [Testing](#testing)
+    * [Test Coverage](#test-coverage)
 * [To Do](#to-do)
 * [Contributing](#contributing)
     * [Contributors](#contributors)
-    * [Semantic Versioning](#semantic-versioning)
+    * [Semantic versioning](#semantic-versioning)
 * [License](#license)
 
 ---
 
 ## Installation
 
-Sandboxy works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+Sandboxy works with Rails 5.0 onwards. You can add it to your `Gemfile` with:
 
 ```ruby
 gem 'sandboxy'
@@ -43,27 +45,17 @@ Or install it yourself as:
 If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
 
 ```ruby
-gem 'sandboxy', github: 'slooob/sandboxy'
+gem 'sandboxy', github: 'jonhue/sandboxy'
 ```
 
 Now run the generator:
 
     $ rails g sandboxy
 
-You can specify your applications default environment by passing `--default live` or `--default sandbox`. Learn more about switching environments [here](#switching-environments).
-
-To set that your app should retain it's environment at runtime on new requests pass `--retain_environment true`.
-
-You can always update your [configuration](#configuration) later.
-
 To wrap things up, migrate the changes into your database:
 
     $ rails db:migrate
 
-**Note:** Use `rake db:migrate` instead if you run Rails < 5.
-
-This will create a configuration file under `config/sandboxy.yml` as well as a migration file and the `Sandbox` model.
-
 ## Usage
 
 ### Setup
@@ -76,7 +68,7 @@ class Foo < ApplicationRecord
 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:
+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:
 
 ```ruby
 class SharedSandbox < ApplicationRecord
@@ -87,13 +79,7 @@ class Foo < SharedSandbox
 end
 ```
 
-### Configuration
-
-In `config/sandboxy.yml` you define your app's default environment. This can be either set to `live` or `sandbox`. It defaults to `live`.
-
-Now this default gets refreshed before every new request. To retain any environment you [switched in at runtime](#switching-environments), you need to set `retain_environment` to `true`. Defaults to `false`.
-
-### Sandboxed methods
+### `sandboxy` methods
 
 By default you can only access records belonging to the current environment (`live` or `sandbox`):
 
@@ -129,22 +115,22 @@ foo.make_sandboxed
 foo.sandboxed? # => true
 ```
 
-### Sandboxy methods
+### `Sandboxy` class methods
 
 To access your default environment setting:
 
 ```ruby
-Sandboxy.environment # => 'live' / 'sandbox'
-Sandboxy.sandbox? # => true / false
-Sandboxy.live? # => true / false
+Sandboxy.configuration.environment # => 'live' / 'sandbox'
+Sandboxy.configuration.sandbox? # => true / false
+Sandboxy.configuration.live? # => true / false
 ```
 
-**Note:** `Sandboxy.environment` does *NOT* return the apps current environment. For that use the [`$sandbox` variable](#switching-environments) instead.
+**Note:** `Sandboxy.configuration.environment` does *NOT* return the apps current environment. For that use the [`$sandbox` variable](#switching-environments) instead.
 
-You can also access whether your app retains your environment throughout request:
+You can also access whether your app retains your environment throughout requests:
 
 ```ruby
-Sandboxy.retain_environment # => true / false
+Sandboxy.configuration.retain_environment # => true / false
 ```
 
 ### Switching environments
@@ -161,9 +147,53 @@ Whenever you authenticate your API's consumer, just make sure to set the `$sandb
 
 ---
 
+## Configuration
+
+You can configure Sandboxy by passing a block to `configure`. This can be done in `config/initializers/sandboxy.rb`:
+
+```ruby
+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.
+
+1. Fork this repository
+2. Clone your forked git locally
+3. Install dependencies
+
+    `$ bundle install`
+
+4. Run tests
+
+    `$ rake test`
+
+### Test Coverage
+
+Test coverage can be calculated using SimpleCov. Make sure you have the [simplecov gem](https://github.com/colszowka/simplecov) installed.
+
+1. Uncomment SimpleCov in the Gemfile
+2. Uncomment the relevant section in `test/test_helper.rb`
+3. Run tests
+
+    `$ rake test`
+
+---
+
 ## To Do
 
-* Leave your suggestions [here](https://github.com/slooob/sandboxy/issues/new)
+[Here](https://github.com/jonhue/sandboxy/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/sandboxy/issues/new).
 
 ---
 
@@ -171,13 +201,13 @@ Whenever you authenticate your API's consumer, just make sure to set the `$sandb
 
 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](https://github.com/slooob/sandboxy/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/slooob/sandboxy/blob/master/CODE_OF_CONDUCT.md)
+[Learn more about contributing to this repository](https://github.com/jonhue/sandboxy/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/jonhue/sandboxy/blob/master/CODE_OF_CONDUCT.md)
 
 ### Contributors
 
 Give the people some :heart: who are working on this project. See them all at:
 
-https://github.com/slooob/sandboxy/graphs/contributors
+https://github.com/jonhue/sandboxy/graphs/contributors
 
 ### Semantic Versioning
 
@@ -187,7 +217,7 @@ Sandboxy follows Semantic Versioning 2.0 as defined at http://semver.org.
 
 MIT License
 
-Copyright (c) 2017 Slooob
+Copyright (c) 2017 Jonas Hübotter
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -3,7 +3,6 @@ Bundler::GemHelper.install_tasks
 
 require 'rake'
 require 'rake/testtask'
-require 'rdoc/task'
 
 desc 'Default: run unit tests.'
 task default: :test

data/examples/rails_example/Gemfile

@@ -7,6 +7,7 @@ end
 
 
 gem 'sandboxy'
+gem 'grape'
 
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'

data/examples/rails_example/app/api/books/api.rb

@@ -0,0 +1,33 @@
+module Books
+    class API < Grape::API
+
+        version 'v1', using: :path, vendor: 'books'
+        format :json
+
+        helpers do
+            def authenticate! access_token
+                if current_app ||= ::Application.find_by(access_token: access_token)
+                    $sandbox = false
+                elsif current_app ||= ::Application.find_by(sandbox_access_token: access_token)
+                    $sandbox = true
+                else
+                    error!
+                end
+            end
+        end
+
+        rescue_from :all
+
+        resource :books do
+            params do
+                requires :access_token, String
+            end
+
+            get :index do
+                authenticate! params[:access_token]
+                ::Book.all.limit(5)
+            end
+        end
+
+    end
+end

data/examples/rails_example/app/assets/javascripts/books.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/examples/rails_example/app/assets/javascripts/libraries.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/examples/rails_example/app/assets/javascripts/sandbox.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/examples/rails_example/app/assets/stylesheets/applications.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the applications controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails_example/app/assets/stylesheets/{foos.scss → authors.scss}

@@ -1,3 +1,3 @@
-// Place all the styles related to the foos controller here.
+// Place all the styles related to the authors controller here.
 // They will automatically be included in application.css.
 // You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails_example/app/assets/stylesheets/{bars.scss → books.scss}

@@ -1,3 +1,3 @@
-// Place all the styles related to the bars controller here.
+// Place all the styles related to the books controller here.
 // They will automatically be included in application.css.
 // You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails_example/app/assets/stylesheets/libraries.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the libraries controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails_example/app/assets/stylesheets/sandbox.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the sandbox controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/rails_example/app/controllers/application_controller.rb

@@ -1,3 +1,7 @@
 class ApplicationController < ActionController::Base
-  protect_from_forgery with: :exception
+    protect_from_forgery with: :exception
+
+    def store_sandbox_environment
+        session[:sandbox] == $sandbox unless session.has_key?(:sandbox)
+    end
 end

data/examples/rails_example/app/controllers/applications_controller.rb

@@ -0,0 +1,74 @@
+class ApplicationsController < ApplicationController
+  before_action :set_application, only: [:show, :edit, :update, :destroy]
+
+  # GET /applications
+  # GET /applications.json
+  def index
+    @applications = Application.all
+  end
+
+  # GET /applications/1
+  # GET /applications/1.json
+  def show
+  end
+
+  # GET /applications/new
+  def new
+    @application = Application.new
+  end
+
+  # GET /applications/1/edit
+  def edit
+  end
+
+  # POST /applications
+  # POST /applications.json
+  def create
+    @application = Application.new(application_params)
+
+    respond_to do |format|
+      if @application.save
+        format.html { redirect_to @application, notice: 'Application was successfully created.' }
+        format.json { render :show, status: :created, location: @application }
+      else
+        format.html { render :new }
+        format.json { render json: @application.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /applications/1
+  # PATCH/PUT /applications/1.json
+  def update
+    respond_to do |format|
+      if @application.update(application_params)
+        format.html { redirect_to @application, notice: 'Application was successfully updated.' }
+        format.json { render :show, status: :ok, location: @application }
+      else
+        format.html { render :edit }
+        format.json { render json: @application.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /applications/1
+  # DELETE /applications/1.json
+  def destroy
+    @application.destroy
+    respond_to do |format|
+      format.html { redirect_to applications_url, notice: 'Application was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_application
+      @application = Application.find(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def application_params
+      params.fetch(:application, {})
+    end
+end

data/examples/rails_example/app/controllers/authors_controller.rb

@@ -0,0 +1,77 @@
+class AuthorsController < ApplicationController
+  before_action :set_author, only: [:show, :edit, :update, :destroy]
+
+  # GET /authors
+  # GET /authors.json
+  def index
+    $sandbox = session[:sandbox]
+    @authors = Author.all
+  end
+
+  # GET /authors/1
+  # GET /authors/1.json
+  def show
+  end
+
+  # GET /authors/new
+  def new
+    $sandbox = session[:sandbox]
+    @author = Author.new
+  end
+
+  # GET /authors/1/edit
+  def edit
+  end
+
+  # POST /authors
+  # POST /authors.json
+  def create
+    $sandbox = session[:sandbox]
+    @author = Author.new(author_params)
+
+    respond_to do |format|
+      if @author.save
+        format.html { redirect_to @author, notice: 'Author was successfully created.' }
+        format.json { render :show, status: :created, location: @author }
+      else
+        format.html { render :new }
+        format.json { render json: @author.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /authors/1
+  # PATCH/PUT /authors/1.json
+  def update
+    respond_to do |format|
+      if @author.update(author_params)
+        format.html { redirect_to @author, notice: 'Author was successfully updated.' }
+        format.json { render :show, status: :ok, location: @author }
+      else
+        format.html { render :edit }
+        format.json { render json: @author.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /authors/1
+  # DELETE /authors/1.json
+  def destroy
+    @author.destroy
+    respond_to do |format|
+      format.html { redirect_to authors_url, notice: 'Author was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_author
+      @author = Author.find(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def author_params
+      params.fetch(:author, {})
+    end
+end

data/examples/rails_example/app/controllers/books_controller.rb

@@ -0,0 +1,77 @@
+class BooksController < ApplicationController
+  before_action :set_book, only: [:show, :edit, :update, :destroy]
+
+  # GET /books
+  # GET /books.json
+  def index
+    $sandbox = session[:sandbox]
+    @books = Book.all
+  end
+
+  # GET /books/1
+  # GET /books/1.json
+  def show
+  end
+
+  # GET /books/new
+  def new
+    $sandbox = session[:sandbox]
+    @book = Book.new
+  end
+
+  # GET /books/1/edit
+  def edit
+  end
+
+  # POST /books
+  # POST /books.json
+  def create
+    $sandbox = session[:sandbox]
+    @book = Book.new(book_params)
+
+    respond_to do |format|
+      if @book.save
+        format.html { redirect_to @book, notice: 'Book was successfully created.' }
+        format.json { render :show, status: :created, location: @book }
+      else
+        format.html { render :new }
+        format.json { render json: @book.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /books/1
+  # PATCH/PUT /books/1.json
+  def update
+    respond_to do |format|
+      if @book.update(book_params)
+        format.html { redirect_to @book, notice: 'Book was successfully updated.' }
+        format.json { render :show, status: :ok, location: @book }
+      else
+        format.html { render :edit }
+        format.json { render json: @book.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /books/1
+  # DELETE /books/1.json
+  def destroy
+    @book.destroy
+    respond_to do |format|
+      format.html { redirect_to books_url, notice: 'Book was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_book
+      @book = Book.find(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def book_params
+      params.fetch(:book, {})
+    end
+end