activerecord-multi-tenant 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c5c0ba14d59d29394780c14bc3af728e9f9e8c4
-  data.tar.gz: 76633446183eeca8bf24f5763db3dab4582d83fa
+  metadata.gz: 9d6ecfbf3c596f4c97db44220ae47b9b17370060
+  data.tar.gz: a13da12778bcc68651a52fd03f25b5e99f32fee4
 SHA512:
-  metadata.gz: 83055c97bedeab4a83b32a4a772c2ed62511f464529e392283832fb42fe39d0e04e0c33e710e1950c49e0cf14ac9a3d95da7a73375e813898fdd07f79a664597
-  data.tar.gz: a89de927f75b3e5824d07cfb731fe21c506e5104d10e42e9406609d10b9d70b08ab1152919e7ea9f9191d7b57a04ba60c0fcde1b4795d9dac12f6890580ecaa0
+  metadata.gz: 40aab782eaa7eaf613f576febca765da3942d7678fe3ee3bad99fb7b0aa495dcb3bbac651d33eea5d5807461b42c934329a489a74d9c77691a310965ac1e7429
+  data.tar.gz: 0ff0d1fbf17c30c5730ec24e8f8274a0367af4382f790d67f97908c8ea4623676c312f6f3b14788237ab8698a41128ec84c5fcc4310902a51316d5ccac936d76

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.3.1       2017-02-13
+
+* Rails 5 API controller support [@mstahl](https://github.com/mstahl) [#4](https://github.com/citusdata/activerecord-multi-tenant/pull/4)
+* Citus 6.1 compatibility
+
+
 ## 0.3.0       2016-12-30
 
 * Remove dependency on acts_as_tenant - instead copy the code thats necessary

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-multi-tenant (0.3.0)
+    activerecord-multi-tenant (0.3.1)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
@@ -144,8 +144,10 @@ DEPENDENCIES
   appraisal
   database_cleaner (~> 1.3.0)
   pg
+  rake
   rspec (>= 3.0)
   rspec-rails
+  thor
 
 BUNDLED WITH
    1.11.2

data/README.md

@@ -65,18 +65,11 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-## Considerations when using Ruby on Rails with Citus
+## Frequently Asked Questions
 
-In case you use Ruby on Rails together with Citus, please also note the following.
+* **What if I have a table that doesn't relate to my tenant?** (e.g. templates that are the same in every account)
 
-You'll need to disable prepared_statements in your database.yml like this:
-
-```
-default: &default
-  adapter: postgresql
-  url: <%= ENV['DATABASE_URL'] %>
-  prepared_statements: false
-```
+  We recommend not using activerecord-multi-tenant on these tables. In case only some records in a table are not associated to a tenant (i.e. your templates are in the same table as actual objects), we recommend setting the tenant_id to 0, and then using MultiTenant.with_id(0) to access these objects.
 
 ## Credits
 

data/activerecord-multi-tenant.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'database_cleaner', '~> 1.3.0'
   s.add_development_dependency 'pg'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'thor'
 end

data/docker-compose.yml

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

data/gemfiles/rails_3.2.gemfile

@@ -5,3 +5,5 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "test-unit", "~> 3.0"
 gem "rails", "3.2.22.5"
+
+gemspec :path => "../"

data/gemfiles/rails_3.2.gemfile.lock

@@ -1,3 +1,10 @@
+PATH
+  remote: ../
+  specs:
+    activerecord-multi-tenant (0.3.1)
+      rails (>= 3.1)
+      request_store (>= 1.0.5)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -34,6 +41,8 @@ GEM
       thor (>= 0.14.0)
     arel (3.0.3)
     builder (3.0.4)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
     hike (1.2.3)
     i18n (0.7.0)
@@ -44,6 +53,7 @@ GEM
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     multi_json (1.12.1)
+    pg (0.19.0)
     polyglot (0.3.5)
     power_assert (0.4.1)
     rack (1.4.7)
@@ -71,6 +81,28 @@ GEM
     rake (12.0.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    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 (2.2.3)
       hike (~> 1.2)
       multi_json (~> 1.0)
@@ -89,9 +121,16 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord-multi-tenant!
   appraisal
+  database_cleaner (~> 1.3.0)
+  pg
   rails (= 3.2.22.5)
+  rake
+  rspec (>= 3.0)
+  rspec-rails
   test-unit (~> 3.0)
+  thor
 
 BUNDLED WITH
    1.11.2

data/gemfiles/rails_4.2.gemfile

@@ -4,3 +4,5 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rails", "4.2.7.1"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile.lock

@@ -1,3 +1,10 @@
+PATH
+  remote: ../
+  specs:
+    activerecord-multi-tenant (0.3.1)
+      rails (>= 3.1)
+      request_store (>= 1.0.5)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -43,6 +50,8 @@ GEM
     arel (6.0.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)
@@ -59,6 +68,7 @@ GEM
     minitest (5.10.1)
     nokogiri (1.7.0)
       mini_portile2 (~> 2.1.0)
+    pg (0.19.0)
     rack (1.6.5)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -87,6 +97,28 @@ GEM
       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)
@@ -103,8 +135,15 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord-multi-tenant!
   appraisal
+  database_cleaner (~> 1.3.0)
+  pg
   rails (= 4.2.7.1)
+  rake
+  rspec (>= 3.0)
+  rspec-rails
+  thor
 
 BUNDLED WITH
    1.11.2

data/gemfiles/rails_5.0.gemfile

@@ -4,3 +4,5 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rails", "5.0.1"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile.lock

@@ -1,3 +1,10 @@
+PATH
+  remote: ../
+  specs:
+    activerecord-multi-tenant (0.3.1)
+      rails (>= 3.1)
+      request_store (>= 1.0.5)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -45,6 +52,8 @@ GEM
     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)
@@ -62,6 +71,7 @@ GEM
     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)
@@ -89,6 +99,28 @@ GEM
       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)
@@ -108,8 +140,15 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord-multi-tenant!
   appraisal
+  database_cleaner (~> 1.3.0)
+  pg
   rails (= 5.0.1)
+  rake
+  rspec (>= 3.0)
+  rspec-rails
+  thor
 
 BUNDLED WITH
    1.11.2

data/lib/activerecord-multi-tenant/controller_extensions.rb

@@ -2,16 +2,19 @@ module MultiTenant
   module ControllerExtensions
     def set_current_tenant_through_filter
       self.class_eval do
-        helper_method :current_tenant
+        if respond_to?(:helper_method)
+          helper_method :current_tenant
+        end
 
         private
-          def set_current_tenant(current_tenant_object)
-            MultiTenant.current_tenant = current_tenant_object
-          end
 
-          def current_tenant
-            MultiTenant.current_tenant
-          end
+        def set_current_tenant(current_tenant_object)
+          MultiTenant.current_tenant = current_tenant_object
+        end
+
+        def current_tenant
+          MultiTenant.current_tenant
+        end
       end
     end
   end
@@ -20,3 +23,7 @@ end
 if defined?(ActionController::Base)
   ActionController::Base.extend MultiTenant::ControllerExtensions
 end
+
+if defined?(ActionController::API)
+  ActionController::API.extend MultiTenant::ControllerExtensions
+end

data/lib/activerecord-multi-tenant/migrations.rb

@@ -1,17 +1,30 @@
 module MultiTenant
   module MigrationExtensions
     def create_distributed_table(table_name, partition_key)
+      return unless citus_version.present?
       execute "SELECT create_distributed_table($$#{table_name}$$, $$#{partition_key}$$)"
     end
 
     def execute_on_all_nodes(sql)
       execute sql
-      execute "SELECT citus_run_on_all_workers($$#{sql}$$)"
+
+      case citus_version
+      when '6.0'
+        execute "SELECT citus_run_on_all_workers($$#{sql}$$)" # initial citus_tools.sql with different names
+      when nil
+        # Do nothing, this is regular Postgres
+      else # 6.1 and newer
+        execute "SELECT run_command_on_workers($$#{sql}$$)"
+      end
     end
 
     def enable_extension_on_all_nodes(extension)
       execute_on_all_nodes "CREATE EXTENSION IF NOT EXISTS \"#{extension}\""
     end
+
+    def citus_version
+      execute("SELECT extversion FROM pg_extension WHERE extname = 'citus'").getvalue(0,0).try(:split, '-').try(:first)
+    end
   end
 end
 

data/lib/activerecord-multi-tenant/version.rb

@@ -1,3 +1,3 @@
 module MultiTenant
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/activerecord-multi-tenant/controller_extensions_spec.rb

@@ -28,3 +28,30 @@ describe ApplicationController, type: :controller do
     expect(MultiTenant.current_tenant.name).to eq 'account1'
   end
 end
+
+if Rails::VERSION::MAJOR >= 5
+  class APIApplicationController < ActionController::API
+    include Rails.application.routes.url_helpers
+    set_current_tenant_through_filter
+    before_action :your_method_that_finds_the_current_tenant
+
+    def your_method_that_finds_the_current_tenant
+      current_account = Account.new
+      current_account.name = 'account1'
+      set_current_tenant(current_account)
+    end
+  end
+
+  describe APIApplicationController, type: :controller do
+    controller do
+      def index
+        render body: 'custom called'
+      end
+    end
+
+    it 'Finds the correct tenant using the filter command' do
+      get :index
+      expect(MultiTenant.current_tenant.name).to eq 'account1'
+    end
+  end
+end

data/spec/schema.rb

@@ -1,4 +1,4 @@
-false && ActiveRecord::Schema.define(version: 1) do
+ActiveRecord::Schema.define(version: 1) do
   create_table :accounts, force: true do |t|
     t.column :name, :string
     t.column :subdomain, :string

data/spec/spec_helper.rb

@@ -13,6 +13,9 @@ ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.
 ActiveRecord::Base.establish_connection(dbconfig['test'])
 
 RSpec.configure do |config|
+  config.infer_base_class_for_anonymous_controllers = true
+  config.use_transactional_fixtures = false
+
   config.after(:each) do
     MultiTenant.current_tenant = nil
   end
@@ -29,8 +32,6 @@ RSpec.configure do |config|
   config.after(:each) do
     DatabaseCleaner[:active_record].clean
   end
-
-  config.infer_base_class_for_anonymous_controllers = true
 end
 
 module MultiTenantTest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multi-tenant
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Citus Data
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-31 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: thor
+  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: engage@citusdata.com
 executables: []