storey 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe9182b67b4f2738c91562f6366b59c15f7c5db272cdc32fd837ec1159cc753a
-  data.tar.gz: b61703b7b12878c85a3a9fbcf1cd0af5208c612f153ce8f25e8e7fe70aef6053
+  metadata.gz: bbbb6a1e4e73a064abdc73ec6a2730af44a48f19827288fa480a5bfca422b246
+  data.tar.gz: 9a2801e339b05307db2169c3d39a9bd05707b8b5b6fdaf10d5712d3ca8ba79cf
 SHA512:
-  metadata.gz: 75fc2bdc24f43a52a7376fcd4db66484c0e53d01f06f6a65002d3a3eaa2f997867153d572dc1d032e2992979a76ba6d3d14e1234e8f3ec8fa65eeed040dd834a
-  data.tar.gz: 67d233bff3fdb58629cc15d5cc244182514e5810a23a5c5607a1b230714eb759425b113bbce776fe1eaaff5f0dd6c3b9fdcdc41d34d91524f945497324d494a3
+  metadata.gz: d85cf6045e666a7c8810af9090363be9dc1cf998ba6764281d44495fa0dc845526fa25a1f7cc17e20ec0bb47f6046fa8018efae533f76f72afe10f736fcade48
+  data.tar.gz: b61f568f85ef3d2c75c63f2af61b16b83b4534aba7ec58950e0b963dcce676d00f7aed5256193be754ebeba0f6e324e23d6419d9bde5c439678eba1647ce0466

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.2.0] - 2019-02-08
+### Added
+- Ability to switch via a Rack app
+
 ## [2.1.2] - 2018-08-14
 ### Fixed
 - Instances when queries are cached between switches

data/README.md

@@ -29,6 +29,65 @@ Storey.configure do |c|
 end
 ```
 
+## Switching in your Rack app
+
+To switch in your application, you can just opt to call `Storey.switch`
+somewhere in your app. For example, in a Rails ApplicationController it would
+look like:
+
+```ruby
+class ApplicationController
+  before_action :switch_to_tenant
+
+  def switch_to_tenant
+    subdomain = request.subdomain
+    Storey.switch(subdomain) if Website.exists?(subdomain: subdomain)
+  end
+end
+```
+
+There are some instances where you need to switch schemas before you get to your
+application. A good example is Devise. Devise uses Warden to authenticate users.
+Warden is inserted as a Rack application and checks to see if the user
+attempting to access the page signed in.
+
+To do this, it must check the database. If your users live on separate schemas,
+there's a big chance that Warden will think the user does not exist. Especially
+in this scenario, use the Rack app found in this gem. In Rails, insert this
+somewhere in your `application.rb` or in an initializer:
+
+```ruby
+Rails.application.config.middleware.
+  insert_before Warden::Manager, Storey::RackSwitch
+```
+
+You must also define how to determine the schema to switch to. To do that, set
+`switch_processor`:
+
+```ruby
+Storey.configure do |c|
+  c.switch_processor = ->(env) do
+    # find the schema name based on something in the env
+    subdomain = find_in_env(env)
+    return subdomain if Website.exists?(subdomain: schema)
+  end
+
+  # You can pass any object that responds to call and accepts one arg: the env.
+  c.switch_processor = MyStoreySwitchProcessor
+end
+
+class MyStoreySwitchProcessor
+  def self.call(env)
+    subdomain = find_in_env(env)
+    # ...
+  end
+end
+```
+
+When the result of `switch_processor` is a string,
+`Storey.switch('the-string-it-returns')` is called. If `nil`, no switching 
+happens.
+
 # Methods
 
 ## schema
@@ -122,3 +181,11 @@ Usage:
 ## storey:hstore:install
 
 Run `rake storey:hstore:install` to install hstore extension into the hstore schema. Ensure that 'hstore' is one of the persistent schemas.
+
+# Development
+
+In the storey directory, after installing the gems:
+
+- `docker-compose up db`
+- `cp spec/dummy/config/database.yml{.sample,}
+- `rspec spec`

data/lib/storey.rb

@@ -6,6 +6,7 @@ require "open3"
 require "storey/version"
 require "rails/all"
 require 'storey/railtie' if defined?(Rails)
+require 'storey/rack_switch'
 require 'storey/exceptions'
 require 'storey/migrator'
 require 'storey/duplicator'
@@ -37,6 +38,7 @@ module Storey
     has :suffix, classes: [String, NilClass]
     has :persistent_schemas, classes: Array, default: []
     has :excluded_models, classes: Array, default: []
+    has :switch_processor
   end
 
   def self.persistent_schemas=(schemas)

data/lib/storey/rack_switch.rb

@@ -0,0 +1,19 @@
+module Storey
+  class RackSwitch
+
+    def initialize(app, processor=Storey.configuration.switch_processor)
+      @app, @processor = app, processor
+    end
+
+    def call(env)
+      schema = @processor.call(env)
+
+      if schema
+        Storey.switch(schema) { @app.call(env) }
+      else
+        @app.call(env)
+      end
+    end
+
+  end
+end

data/lib/storey/version.rb

@@ -1,3 +1,3 @@
 module Storey
-  VERSION = "2.1.2"
+  VERSION = "2.2.0"
 end

data/spec/lib/storey/rack_switch_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+module Storey
+  RSpec.describe RackSwitch do
+
+    let(:env) do
+      { "env" => "here" }
+    end
+
+    context "processor returns nil" do
+      let(:processor) { ->(env) { nil } }
+      before do
+        Storey.create("original_schema")
+        Storey.switch("original_schema")
+      end
+
+      it "does not switch and continues with the next rack app" do
+        schema_in_app = nil
+        app = ->(env) { schema_in_app = Storey.schema }
+
+        expect(processor).to receive(:call).with(env).
+          and_call_original
+
+        switch = described_class.new(app, processor)
+        switch.(env)
+
+        expect(schema_in_app).to eq "original_schema"
+      end
+    end
+
+    context "processor returns a string" do
+      let(:processor) { ->(env) { "tenant" } }
+      before do
+        Storey.create("tenant")
+      end
+
+      it "switches to the string returned by the processor" do
+        schema_in_app = nil
+        app = ->(env) { schema_in_app = Storey.schema }
+
+        expect(processor).to receive(:call).with(env).
+          and_call_original
+
+        switch = described_class.new(app, processor)
+        switch.(env)
+
+        expect(schema_in_app).to eq "tenant"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storey
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -129,6 +129,7 @@ files:
 - lib/storey/hstore.rb
 - lib/storey/migrator.rb
 - lib/storey/native_schema_matcher.rb
+- lib/storey/rack_switch.rb
 - lib/storey/railtie.rb
 - lib/storey/resets_column_info.rb
 - lib/storey/ruby_dumper.rb
@@ -179,6 +180,7 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
 - spec/fixtures/.gitkeep
+- spec/lib/storey/rack_switch_spec.rb
 - spec/lib/storey_spec.rb
 - spec/migrator_spec.rb
 - spec/spec_helper.rb
@@ -276,6 +278,7 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
 - spec/fixtures/.gitkeep
+- spec/lib/storey/rack_switch_spec.rb
 - spec/lib/storey_spec.rb
 - spec/migrator_spec.rb
 - spec/spec_helper.rb