activerecord-multi-tenant 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeff78948e2addc557a047bbf14bc9ff8268ba82
-  data.tar.gz: 2956b31946178941f0f8b66ed62cff54b7100b60
+  metadata.gz: 2c5c0ba14d59d29394780c14bc3af728e9f9e8c4
+  data.tar.gz: 76633446183eeca8bf24f5763db3dab4582d83fa
 SHA512:
-  metadata.gz: c92d6c7bee05cd4bc1040387e5484586a435bd6c7f376f8de4747cfa027003f7780538ecceb5b973f4d5b73946646b21e77581a1bda4bfc0dcb131997cad68ff
-  data.tar.gz: ad059f082e84e003a5d67506f5a00d555a7098389346263be4148a1f3f11b7c278c253fab2d871ecd080f8ec56f32b64c2d877b54e08d91d96f5df06ae794280
+  metadata.gz: 83055c97bedeab4a83b32a4a772c2ed62511f464529e392283832fb42fe39d0e04e0c33e710e1950c49e0cf14ac9a3d95da7a73375e813898fdd07f79a664597
+  data.tar.gz: a89de927f75b3e5824d07cfb731fe21c506e5104d10e42e9406609d10b9d70b08ab1152919e7ea9f9191d7b57a04ba60c0fcde1b4795d9dac12f6890580ecaa0

data/.gitignore

@@ -0,0 +1,2 @@
+spec/debug.log
+pkg/

data/Appraisals

@@ -0,0 +1,12 @@
+appraise 'rails-3.2' do
+  gem 'test-unit', '~> 3.0'
+  gem 'rails', '3.2.22.5'
+end
+
+appraise 'rails-4.2' do
+  gem 'rails', '4.2.7.1'
+end
+
+appraise 'rails-5.0' do
+  gem 'rails', '5.0.1'
+end

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 0.3.0       2016-12-30
+
+* Remove dependency on acts_as_tenant - instead copy the code thats necessary
+* Fix issue with callbacks having TenantIdWrapper instead of the actual object
+
+
+## 0.2.1       2016-12-29
+
+* Fix bug in CopyFromClient helper
+
+
+## 0.2.0       2016-12-27
+
+* Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'appraisal'

data/Gemfile.lock

@@ -0,0 +1,151 @@
+PATH
+  remote: .
+  specs:
+    activerecord-multi-tenant (0.3.0)
+      rails (>= 3.1)
+      request_store (>= 1.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.1)
+      actionpack (= 5.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.1)
+      activesupport (= 5.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activerecord (5.0.1)
+      activemodel (= 5.0.1)
+      activesupport (= 5.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    builder (3.2.2)
+    concurrent-ruby (1.0.4)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nio4r (1.2.1)
+    nokogiri (1.7.0)
+      mini_portile2 (~> 2.1.0)
+    pg (0.19.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.1)
+      actioncable (= 5.0.1)
+      actionmailer (= 5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      activemodel (= 5.0.1)
+      activerecord (= 5.0.1)
+      activesupport (= 5.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.1)
+      actionpack (= 5.0.1)
+      activesupport (= 5.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    request_store (1.3.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-multi-tenant!
+  appraisal
+  database_cleaner (~> 1.3.0)
+  pg
+  rspec (>= 3.0)
+  rspec-rails
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,88 @@
+# activerecord-multi-tenant [ ![](https://img.shields.io/gem/v/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant) [ ![](https://img.shields.io/gem/dt/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant)
+
+ActiveRecord/Rails integration for multi-tenant databases, in particular the Citus extension for PostgreSQL.
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'activerecord-multi-tenant'
+```
+
+## Supported Rails versions
+
+All Ruby on Rails versions starting with 3.2 or newer are supported.
+
+This gem only supports ActiveRecord (the Rails default ORM), and not alternative ORMs like Sequel.
+
+## Usage
+
+It is required that you add `multi_tenant` definitions to your model in order to have full support for Citus, in particular when updating records.
+
+In the example of an analytics application, sharding on `customer_id`, annotate your models like this:
+
+```ruby
+class PageView < ActiveRecord::Base
+  multi_tenant :customer
+  belongs_to :site
+
+  # ...
+end
+
+class Site < ActiveRecord::Base
+  multi_tenant :customer
+  has_many :page_views
+  belongs_to :customer
+
+  # ...
+end
+```
+
+and then wrap all code that runs queries/modifications in blocks like this:
+
+```ruby
+customer = Customer.find(session[:current_customer_id])
+# ...
+MultiTenant.with(customer) do
+  site = Site.find(params[:site_id])
+  site.update! last_accessed_at: Time.now
+  site.page_views.count
+end
+```
+
+Inside controllers you can use a before_action together with set_current_tenant, to set the tenant for the current request:
+
+```ruby
+class ApplicationController < ActionController::Base
+  set_current_tenant_through_filter # Required to opt into this behavior
+  before_action :set_customer_as_tenant
+
+  def set_customer_as_tenant
+    customer = Customer.find(session[:current_customer_id])
+    set_current_tenant(customer)
+  end
+end
+```
+
+## Considerations when using Ruby on Rails with Citus
+
+In case you use Ruby on Rails together with Citus, please also note the following.
+
+You'll need to disable prepared_statements in your database.yml like this:
+
+```
+default: &default
+  adapter: postgresql
+  url: <%= ENV['DATABASE_URL'] %>
+  prepared_statements: false
+```
+
+## Credits
+
+This gem was initially based on [acts_as_tenant](https://github.com/ErwinM/acts_as_tenant), and still shares some code. We thank the authors for their efforts.
+
+## License
+
+Licensed under the MIT license<br>
+Copyright (c) 2016, Citus Data Inc.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/activerecord-multi-tenant.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'activerecord-multi-tenant/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'activerecord-multi-tenant'
+  s.version     = MultiTenant::VERSION
+  s.summary     = 'ActiveRecord/Rails integration for multi-tenant databases, in particular the Citus extension for PostgreSQL'
+  s.description = ''
+  s.authors     = ['Citus Data']
+  s.email       = 'engage@citusdata.com'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage      = 'https://github.com/citusdata/activerecord-multi-tenant'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency('request_store', '>= 1.0.5')
+  s.add_dependency('rails','>= 3.1')
+
+  s.add_development_dependency 'rspec', '>= 3.0'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'database_cleaner', '~> 1.3.0'
+  s.add_development_dependency 'pg'
+end

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '2'
+
+services:
+  master:
+    image: 'citusdata/citus:6.0.1'
+    ports: ['5600:5432']
+    labels: ['com.citusdata.role=Master']
+    volumes: ['/var/run/postgresql']
+  worker1:
+    image: 'citusdata/citus:6.0.1'
+    labels: ['com.citusdata.role=Worker']
+  worker2:
+    image: 'citusdata/citus:6.0.1'
+    labels: ['com.citusdata.role=Worker']
+  config:
+    image: 'citusdata/workerlist-gen:2.0.0'
+    volumes: ['/var/run/docker.sock:/tmp/docker.sock']
+    volumes_from: ['master']

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "test-unit", "~> 3.0"
+gem "rails", "3.2.22.5"

data/gemfiles/rails_3.2.gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.22.5)
+      actionpack (= 3.2.22.5)
+      mail (~> 2.5.4)
+    actionpack (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
+      builder (~> 3.0.0)
+    activerecord (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+    activesupport (3.2.22.5)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.7.0)
+    journey (1.0.4)
+    json (1.8.3)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    multi_json (1.12.1)
+    polyglot (0.3.5)
+    power_assert (0.4.1)
+    rack (1.4.7)
+    rack-cache (1.6.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (3.2.22.5)
+      actionmailer (= 3.2.22.5)
+      actionpack (= 3.2.22.5)
+      activerecord (= 3.2.22.5)
+      activeresource (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+      bundler (~> 1.0)
+      railties (= 3.2.22.5)
+    railties (3.2.22.5)
+      actionpack (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (12.0.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.2.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    test-unit (3.2.3)
+      power_assert
+    thor (0.19.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.52)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  rails (= 3.2.22.5)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   1.11.2