multiplicity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbb437285df420a10c5468ccbf46f342d5688356
+  data.tar.gz: f2de70fd4eedac87e4af6a0eef0f597a48c25212
+SHA512:
+  metadata.gz: 63a4d8ec0b7e4d764364326081b743fa12e564229474b1469f0c33ba05f83548066b38aaed2bcb7a144a86ff3caa667abd897b94e587645afd3d48e6fc69d114
+  data.tar.gz: 564a6288b57e4ffb1a789725784a6e5c581bdde1206173df73ad075143ee2a44c6692a3e538e228ee22d60ab1e73a9cb11112ce01d439a156a34dbb45425d9ce

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multiplicity.gemspec
+gemspec
+
+gem 'activerecord', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam Lassek
+
+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,174 @@
+# Multiplicity
+
+Multiplicity is a gem for building a multitenant application in a Rack application,
+with a much less opinionated approach than e.g. [Apartment](https://github.com/influitive/apartment) might entail.
+
+The goal of this gem is to provide the simplest tools required to isolate your data, and then get out of your way.
+
+It uses an adapter system to plug into your ORM framework of choice. Currently ActiveRecord is the only adapter included, but it is not a dependency and never will be.
+
+Adapter contributions for additional ORMs are welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multiplicity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multiplicity
+
+## Usage
+
+Multiplicity expects a table that looks like this:
+
+| id | subdomain | name         | deleted_at |
+|----|-----------|--------------|------------|
+| 1  | demo      | Demo Account | NULL       |
+
+The table name defaults to `tenants` but can be set with `Multiplicity.table_name`.
+
+First, choose your adapter.
+
+```ruby
+require 'multiplicity/adapters/active_record'
+```
+
+Second, set the default domain for your app.
+
+```ruby
+Multiplicity.domain = 'example.com'
+```
+
+The domain is purely a convenience setting, you can override this when calling `Multiplicity::Tenant#uri` by passing a domain as an argument.
+
+Finally, load the middleware. Either `config.ru` for a Rack app, or perhaps `application.rb` for Rails.
+
+```ruby
+require 'multiplicity/middleware'
+use Multiplicity::Middleware
+```
+
+This will automatically set `Multiplicity::Tenant.current` by subdomain for the duration of your request.
+
+## Multiplicity::Tenant
+
+This is the object that gets initialized by your tenant record from the db. It's just a simple [Virtus](https://github.com/solnic/virtus) model with some helper functions. It's been namespaced under `Multiplicity` so that you can be free to define your own tenant model.
+
+### `.find_by(column_name, value)`
+
+This performs a simple `SELECT` against a given column.
+
+```ruby
+Multiplicity::Tenant.current
+# => nil
+Multiplicity::Tenant.find_by :subdomain, 'demo'
+# => #<Tenant id=1 subdomain=demo name="Demo Account" deleted_at=nil>
+Multiplicity::Tenant.current
+# => #<Tenant id=1 subdomain=demo name="Demo Account" deleted_at=nil>
+```
+
+### `.find_by!(column_name, value)`
+
+Raises `Multiplicity::Tenant::UnknownTenantError` if tenant is not found.
+
+### `.load(subdomain)`
+
+Alias for `find_by :subdomain`
+
+### `.current_id`
+
+Returns the numeric id from `Multiplicity::Tenant.current` without having to care about nil traversal.
+
+```ruby
+Multiplicity::Tenant.current_id # => nil
+Multiplicity::Tenant.load 'demo'
+Multiplicity::Tenant.current_id # => 1
+```
+
+### `.use_tenant(subdomain, &block)`
+
+Set a given tenant inside the block without changing the global context.
+
+```ruby
+Multiplicity::Tenant.current
+# => #<Tenant id=1 subdomain=foo name="Foo Account" deleted_at=nil>
+Multiplicity::Tenant.use_tenant('bar') do
+  Multiplicity::Tenant.current
+end
+# => #<Tenant id=2 subdomain=bar name="Bar Account" deleted_at=nil>
+Multiplicity::Tenant.current
+# => #<Tenant id=1 subdomain=foo name="Foo Account" deleted_at=nil>
+```
+
+### `#archived?`
+
+Simple convenience predicate to check if `deleted_at` is nil.
+
+### `#uri(domain = Multiplicity.domain)`
+
+Returns a `URI` object for the tenant's subdomain.
+
+```ruby
+Multiplicity::Tenant.current.uri
+# => #<URI::HTTPS URL:https://demo.example.com>
+Multiplicity::Tenant.current.uri('example.org')
+# => #<URI::HTTPS URL:https://demo.example.org>
+```
+
+## Isolating data
+
+Since Multiplicity doesn't impose opinions on how to do this, it doesn't include the logic for it. Here's an example using ActiveRecord's `default_scope` feature.
+
+```ruby
+# All multitenant models should descend from this
+# parent, as they already should in Rails 5.0+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  def self.inherited(subclass)
+    super
+
+    return unless subclass.superclass == self
+    return unless subclass.column_names.include? 'tenant_id'
+
+    subclass.class_eval do
+      default_scope ->{ where tenant_id: Multiplicity::Tenant.current_id }
+    end
+  end
+end
+```
+
+Side-effects of `default_scope` that are normally downsides are upsides in this case. Every new record created in a tenant scope will automatically save the correct id.
+
+But this is merely a suggestion. Do what works best for your business logic.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+You are, at some point, going to need to point a local url to your development machine to actually test the middleware, however most of the time you can actually just set `Multiplicity::Tenant.current` with a fake record.
+
+```ruby
+if Rails.env.development?
+  Multiplicity::Tenant.current = Multiplicity::Tenant.new(id: 1, subdomain: 'demo', name: 'Demo Account')
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alassek/multiplicity.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

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/lib/multiplicity.rb

@@ -0,0 +1,28 @@
+require 'multiplicity/version'
+require 'multiplicity/tenant'
+require 'multiplicity/middleware'
+
+module Multiplicity
+  def self.adapter; @adapter; end
+
+  def self.adapter=(adapter)
+    @adapter = adapter
+  end
+
+  def self.table_name
+    @table ||= :tenants
+  end
+
+  def self.table_name=(value)
+    @table = value.to_sym
+  end
+
+  def self.domain; @domain; end
+
+  def self.domain=(uri)
+    @domain = uri.to_s
+  end
+end
+
+# Always load AR adapter for now, until there is more than one
+require 'multiplicity/adapters/active_record'

data/lib/multiplicity/adapters/active_record.rb

@@ -0,0 +1,38 @@
+module Multiplicity
+  module Adapters
+    class ActiveRecord
+      def self.connection_pool
+        Thread.current[:multiplicity_connection_pool] ||= ::ActiveRecord::Base.connection_pool
+      end
+
+      def self.connection_pool=(pool)
+        Thread.current[:multiplicity_connection_pool] = pool
+      end
+
+      def self.find_by(field, value)
+        table   = Arel::Table.new(Multiplicity.table_name)
+        columns = Multiplicity::Tenant.column_names.map{|col| table[col] }
+        query   = table.where(table[field].eq(value)).project(columns)
+
+        connection_pool.with_connection do |connection|
+          connection.select_one query
+        end
+      end
+    end
+  end
+end
+
+begin
+  gem 'activerecord', '>= 3.1'
+rescue Gem::LoadError => e
+  raise Gem::LoadError, "You are using functionality requiring
+     the optional gem dependency `#{e.name}`, but the gem is not
+     loaded, or is not using an acceptable version. Add
+     `gem '#{e.name}'` to your Gemfile. Version #{Multiplicity::VERSION}
+     of multiplicity requires #{e.name} that matches #{e.requirement}".gsub(/\n/, '').gsub(/\s+/, ' ')
+end
+
+require 'active_support/lazy_load_hooks'
+ActiveSupport.on_load(:active_record) do
+  Multiplicity.adapter = Multiplicity::Adapters::ActiveRecord
+end

data/lib/multiplicity/middleware.rb

@@ -0,0 +1,49 @@
+module Multiplicity
+  class Middleware
+    attr_reader :app, :header
+
+    def initialize(app, header = 'HTTP_HOST')
+      @app    = app
+      @header = header
+
+      unless defined?(Multiplicity::Adapters)
+        raise RuntimeError, "You must require an adapter to use Multiplicity"
+      end
+    end
+
+    def call(env)
+      subdomain = env[header].to_s.sub(/^http(s)?:\/\//, '').sub(/:[0-9]+$/, '')
+      subdomain = subdomain.split('.')[0..-3].join('.').downcase if subdomain.split('.').length > 2
+      subdomain = env.fetch('TENANT', 'localhost') if development?(subdomain)
+
+      if subdomain.length > 0
+        ::Multiplicity::Tenant.load(subdomain) or return not_found
+      else
+        return not_found
+      end
+
+      return gone if ::Multiplicity::Tenant.current.archived?
+
+      @app.call(env)
+    ensure
+      ::Multiplicity::Tenant.current = nil
+    end
+
+    def not_found
+      [404, { 'Content-Type' => 'text/plain', 'Content-Length' => '9' }, ['Not Found']]
+    end
+
+    def gone
+      [410, { 'Content-Type' => 'text/plain', 'Content-Length' => '15' }, ['Tenant archived']]
+    end
+
+  private
+
+    def development?(server_name)
+      return true if server_name =~ /^localhost(?:\:[0-9]+)$/
+      return true if server_name =~ /\.local$/
+      return true if server_name =~ /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}(?:\:[0-9]+)$/
+      false
+    end
+  end
+end

data/lib/multiplicity/tenant.rb

@@ -0,0 +1,66 @@
+require 'virtus'
+require 'uri'
+
+module Multiplicity
+  class Tenant
+    UnknownTenantError = Class.new(StandardError)
+
+    include Virtus.model(nullify_blank: true)
+
+    attribute :id, Integer
+    attribute :subdomain, String
+    attribute :name, String
+    attribute :deleted_at, DateTime
+
+    def archived?
+      !!deleted_at
+    end
+
+    def uri(domain = Multiplicity.domain)
+      URI("https://#{ subdomain }.#{ domain }")
+    end
+
+    class << self
+      def column_names
+        attribute_set.map(&:name)
+      end
+
+      def current
+        Thread.current[:multiplicity_tenant]
+      end
+
+      def current=(value)
+        Thread.current[:multiplicity_tenant] = value
+      end
+
+      def current_id
+        current && current.id
+      end
+
+      def use_tenant(subdomain)
+        previous = Tenant.current
+        find_by :subdomain, subdomain
+        yield
+      ensure
+        self.current = previous
+      end
+
+      def load(subdomain)
+        find_by :subdomain, subdomain
+      end
+
+      def find_by(field, value)
+        return current if current && current.send(field) == value
+
+        record = Multiplicity.adapter.find_by(field, value)
+
+        self.current = nil
+        self.current = new(record) if record
+      end
+
+      def find_by!(field, value)
+        find_by(field, value) or raise UnknownTenantError, "Unknown Tenant #{field}: #{value}"
+      end
+    end
+  end
+end

data/lib/multiplicity/version.rb

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

data/multiplicity.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multiplicity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multiplicity"
+  spec.version       = Multiplicity::VERSION
+  spec.authors       = ["Adam Lassek"]
+  spec.email         = ["adam@doubleprime.net"]
+
+  spec.summary       = %q{Simple multitenancy for rack-based web servers}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'virtus', '>= 1.0.5'
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-expectations"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: multiplicity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Lassek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: rack
+  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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- adam@doubleprime.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multiplicity.rb
+- lib/multiplicity/adapters/active_record.rb
+- lib/multiplicity/middleware.rb
+- lib/multiplicity/tenant.rb
+- lib/multiplicity/version.rb
+- multiplicity.gemspec
+homepage: 
+licenses:
+- MIT
+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: Simple multitenancy for rack-based web servers
+test_files: []