apartment 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cdae6ddf14e715ae80d9c932ca1d6425e6f56e1
-  data.tar.gz: 8162a81d9eb38bf3992314a4d6fddad14bbc55a8
+  metadata.gz: 5edda0f57e98bfa6166bb6bd4fcea9368cdc2963
+  data.tar.gz: 8fdda9e1bbee41a48490ae0c61dc6bc18d5084c4
 SHA512:
-  metadata.gz: 8683c9692ee16ece0b1876937e2ad79d25c057106c1f750e077386f5c0d04e822b5318baf250b10bcb0f9918bbddabdde6a53aaddd9637e9de0ccb9f33748208
-  data.tar.gz: b76295e730aa02ac1f5a89b53459fed7499f70821bc0292321d2b2f7dc8fc036dc441995a25334f8207519102f5375063f6b99099902713db2c935f241e98238
+  metadata.gz: 7450954792e78f6bd27bb8c4a6414853331562554d027cb54703746f59f1f255d898b8966349640494c7574917924ab3faa690ef07d295791d50693c56b6a0eb
+  data.tar.gz: 9ffd46752338eb87341c0deb314395e0f8223beb5744a2ade9a632be6234f6ec68184a1ab01744b404978e11b25f80d03314645510cda7fb8875a1f86809c86d

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2
+ruby-2.3

data/.travis.yml

@@ -1,25 +1,22 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - jruby-19mode
-  - jruby-head
+  - 2.1.9
+  - 2.2.4
+  - 2.3.1
+  - jruby-9.0.5.0
 gemfile:
   - gemfiles/rails_3_2.gemfile
   - gemfiles/rails_4_0.gemfile
   - gemfiles/rails_4_1.gemfile
   - gemfiles/rails_4_2.gemfile
-bundler_args: --without local --verbose
+bundler_args: --without local
 before_install:
   - gem install bundler -v '> 1.5.0'
 env:
   RUBY_GC_MALLOC_LIMIT: 90000000
   RUBY_FREE_MIN: 200000
 matrix:
-  allow_failures:
-    - rvm: jruby-head
   exclude:
     - rvm: 2.2.0
       gemfile: gemfiles/rails_3_2.gemfile

data/Gemfile

@@ -6,4 +6,5 @@ gem 'rails',        '>= 3.1.2'
 
 group :local do
   gem 'pry'
+  gem 'guard-rspec', '~> 4.2'
 end

data/README.md

@@ -8,14 +8,22 @@ Apartment provides tools to help you deal with multiple tenants in your Rails
 application. If you need to have certain data sequestered based on account or company,
 but still allow some data to exist in a common tenant, Apartment can help.
 
+## HELP!
+
+In order to help drive the direction of development and clean up the codebase, we'd like to take a poll
+on how people are currently using Apartment. If you can take 5 seconds (1 question) to answer
+this poll, we'd greatly appreciated it.
+
+[View Poll](http://www.poll-maker.com/poll391552x4Bfb41a9-15)
+
 ## Excessive Memory Issues on ActiveRecord 4.x
 
 > If you're noticing ever growing memory issues (ie growing with each tenant you add)
 > when using Apartment, that's because there's [an issue](https://github.com/rails/rails/issues/19578)
 > with how ActiveRecord maps Postgresql data types into AR data types.
-> This has been patched and will be release for AR 4.2.2. It's apparently hard
+> This has been patched and will be released for AR 4.2.2. It's apparently hard
 > to backport to 4.1 unfortunately.
-> If you want to use this today, you can use our [4.2.1 patched version](https://github.com/influitive/rails/tree/v4.2.1.memfix) on our github account using the code sample below.
+> If you're noticing high memory usage from ActiveRecord with Apartment please upgrade.
 
 ```ruby
 gem 'rails', '4.2.1', github: 'influitive/rails', tag: 'v4.2.1.memfix'
@@ -118,7 +126,16 @@ module MyApplication
 end
 ```
 
-If you want to exclude a domain, for example if you don't want your application to treate www like a subdomain, in an initializer in your application, you can set the following:
+By default, the subdomain elevator assumes that the parent domain consists of two segments, e.g. 'example.com'. If this isn't the case, you can adjust the `tld_length` (top level domain length) configuration variable, which defaults to 1. For example, if you are using 'localhost' in development:
+```ruby
+# config/initializers/apartment.rb
+Apartment.configure do |config|
+ ...
+ config.tld_length = 0 if Rails.env == 'development'
+end
+```
+
+If you want to exclude a domain, for example if you don't want your application to treat www like a subdomain, in an initializer in your application, you can set the following:
 
 ```ruby
 # config/initializers/apartment/subdomain_exclusions.rb
@@ -127,6 +144,27 @@ Apartment::Elevators::Subdomain.excluded_subdomains = ['www']
 
 This functions much in the same way as Apartment.excluded_models. This example will prevent switching your tenant when the subdomain is www. Handy for subdomains like: "public", "www", and "admin" :)
 
+**Switch on first subdomain**
+To switch on the first subdomain, which analyzes the chain of subdomains of the request and switches to a tenant schema of the first name in the chain (e.g. owls.birds.animals.com would switch to "owl").  It can be used like so:
+
+```ruby
+# application.rb
+module MyApplication
+  class Application < Rails::Application
+    config.middleware.use 'Apartment::Elevators::FirstSubdomain'
+  end
+end
+```
+
+If you want to exclude a domain, for example if you don't want your application to treate www like a subdomain, in an initializer in your application, you can set the following:
+
+```ruby
+# config/initializers/apartment/subdomain_exclusions.rb
+Apartment::Elevators::FirstSubdomain.excluded_subdomains = ['www']
+```
+
+This functions much in the same way as the Subdomain elevator.
+
 **Switch on domain**
 To switch based on full domain (excluding subdomains *ie 'www'* and top level domains *ie '.com'* ) use the following:
 
@@ -187,6 +225,16 @@ class MyCustomElevator < Apartment::Elevators::Generic
 end
 ```
 
+### Dropping Tenants
+
+To drop tenants using Apartment, use the following command:
+
+```ruby
+Apartment::Tenant.drop('tenant_name')
+```
+
+When method is called, the schema is dropped and all data from itself will be lost. Be careful with this method.
+
 ## Config
 
 The following config options should be set up in a Rails initializer such as:
@@ -225,7 +273,7 @@ By default, ActiveRecord will use `"$user", public` as the default `schema_searc
 config.default_schema = "some_other_schema"
 ```
 
-With that set, all excluded models will use this schema as the table name prefix instead of `public` and `reset` on `Apartment::Tenant` will return to this schema also
+With that set, all excluded models will use this schema as the table name prefix instead of `public` and `reset` on `Apartment::Tenant` will return to this schema as well.
 
 ## Persistent Schemas
 Apartment will normally just switch the `schema_search_path` whole hog to the one passed in.  This can lead to problems if you want other schemas to always be searched as well.  Enter `persistent_schemas`.  You can configure a list of other schemas that will always remain in the search path, while the default gets swapped out:
@@ -377,6 +425,33 @@ and test environments.  If you wish to turn this option off in production, you c
 config.prepend_environment = !Rails.env.production?
 ```
 
+## Tenants on different servers
+
+You can store your tenants in different databases on one or more servers.
+To do it, specify your `tenant_names` as a hash, keys being the actual tenant names,
+values being a hash with the database configuration to use.
+
+Example:
+
+```ruby
+config.tenant_names = {
+  'tenant1' => {
+    adapter: 'postgresql',
+    host: 'some_server',
+    port: 5555,
+    database: 'postgres' # this is not the name of the tenant's db
+                         # but the name of the database to connect to, before creating the tenant's db
+                         # mandatory in postgresql
+  }
+}
+# or using a lambda:
+config.tenant_names = lambda do
+  Tenant.all.each_with_object({}) do |tenant, hash|
+    hash[tenant.name] = tenant.db_configuration
+  end
+end
+```
+
 ## Delayed::Job
 ### Has been removed... See apartment-sidekiq for a better backgrounding experience
 

data/apartment.gemspec

@@ -40,8 +40,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'rake',         '~> 0.9'
-  s.add_development_dependency 'rspec-rails',  '~> 2.14'
-  s.add_development_dependency 'guard-rspec',  '~> 4.2'
+  s.add_development_dependency 'rspec',        '~> 3.4'
+  s.add_development_dependency 'rspec-rails',  '~> 3.4'
   s.add_development_dependency 'capybara',     '~> 2.0'
 
   if defined?(JRUBY_VERSION)

data/gemfiles/rails_3_2.gemfile

@@ -9,3 +9,5 @@ group :local do
 end
 
 gemspec :path => "../"
+
+gem "test-unit"

data/lib/apartment.rb

@@ -24,9 +24,16 @@ module Apartment
       yield self if block_given?
     end
 
-    # Be careful not to use `return` here so both Proc and lambda can be used without breaking
     def tenant_names
-      @tenant_names.respond_to?(:call) ? @tenant_names.call : @tenant_names
+      extract_tenant_config.keys.map(&:to_s)
+    end
+
+    def tenants_with_config
+      extract_tenant_config
+    end
+
+    def db_config_for(tenant)
+      (tenants_with_config[tenant] || connection_config).with_indifferent_access
     end
 
     # Whether or not db:migrate should also migrate tenants
@@ -96,6 +103,19 @@ module Apartment
       Apartment::Deprecation.warn "[Deprecation Warning] `use_postgresql_schemas=` is now deprecated, please use `use_schemas=`"
       self.use_schemas = to_use_or_not_to_use
     end
+
+    def extract_tenant_config
+      return {} unless @tenant_names
+      values = @tenant_names.respond_to?(:call) ? @tenant_names.call : @tenant_names
+      unless values.is_a? Hash
+        values = values.each_with_object({}) do |tenant, hash|
+          hash[tenant] = connection_config
+        end
+      end
+      values.with_indifferent_access
+    rescue ActiveRecord::StatementInvalid
+      {}
+    end
   end
 
   # Exceptions

data/lib/apartment/adapters/abstract_adapter.rb

@@ -67,11 +67,12 @@ module Apartment
       #   @param {String} tenant name
       #
       def drop(tenant)
-        # Apartment.connection.drop_database   note that drop_database will not throw an exception, so manually execute
-        Apartment.connection.execute("DROP DATABASE #{environmentify(tenant)}" )
+        with_neutral_connection(tenant) do |conn|
+          drop_command(conn, tenant)
+        end
 
-      rescue *rescuable_exceptions
-        raise TenantNotFound, "The tenant #{environmentify(tenant)} cannot be found"
+      rescue *rescuable_exceptions => exception
+        raise_drop_tenant_error!(tenant, exception)
       end
 
       #   Switch to a new tenant
@@ -125,7 +126,7 @@ module Apartment
       def process_excluded_models
         # All other models will shared a connection (at Apartment.connection_class) and we can modify at will
         Apartment.excluded_models.each do |excluded_model|
-          excluded_model.constantize.establish_connection @config
+          process_excluded_model(excluded_model)
         end
       end
 
@@ -139,21 +140,38 @@ module Apartment
       #
       def seed_data
         # Don't log the output of seeding the db
-        silence_stream(STDOUT){ load_or_abort(Apartment.seed_data_file) } if Apartment.seed_data_file
+        silence_warnings{ load_or_abort(Apartment.seed_data_file) } if Apartment.seed_data_file
       end
       alias_method :seed, :seed_data
 
     protected
 
+      def process_excluded_model(excluded_model)
+        excluded_model.constantize.establish_connection @config
+      end
+
+      def drop_command(conn, tenant)
+        # connection.drop_database   note that drop_database will not throw an exception, so manually execute
+        conn.execute("DROP DATABASE #{environmentify(tenant)}")
+      end
+
+      class SeparateDbConnectionHandler < ::ActiveRecord::Base
+      end
+
       #   Create the tenant
       #
       #   @param {String} tenant Database name
       #
       def create_tenant(tenant)
-        Apartment.connection.create_database( environmentify(tenant) )
+        with_neutral_connection(tenant) do |conn|
+          create_tenant_command(conn, tenant)
+        end
+      rescue *rescuable_exceptions => exception
+        raise_create_tenant_error!(tenant, exception)
+      end
 
-      rescue *rescuable_exceptions
-        raise TenantExists, "The tenant #{environmentify(tenant)} already exists."
+      def create_tenant_command(conn, tenant)
+        conn.create_database(environmentify(tenant))
       end
 
       #   Connect to new tenant
@@ -163,9 +181,9 @@ module Apartment
       def connect_to_new(tenant)
         Apartment.establish_connection multi_tenantify(tenant)
         Apartment.connection.active?   # call active? to manually check if this connection is valid
-
-      rescue *rescuable_exceptions
-        raise TenantNotFound, "The tenant #{environmentify(tenant)} cannot be found."
+      rescue *rescuable_exceptions => exception
+        Apartment::Tenant.reset if reset_on_connection_exception?
+        raise_connect_error!(tenant, exception)
       end
 
       #   Prepend the environment if configured and the environment isn't already there
@@ -196,13 +214,21 @@ module Apartment
       end
 
       #   Return a new config that is multi-tenanted
-      #
-      def multi_tenantify(tenant)
-        @config.clone.tap do |config|
-          config[:database] = environmentify(tenant)
+      #   @param {String}  tenant: Database name
+      #   @param {Boolean} with_database: if true, use the actual tenant's db name
+      #                                   if false, use the default db name from the db
+      def multi_tenantify(tenant, with_database = true)
+        db_connection_config(tenant).tap do |config|
+          if with_database
+            multi_tenantify_with_tenant_db_name(config, tenant)
+          end
         end
       end
 
+      def multi_tenantify_with_tenant_db_name(config, tenant)
+        config[:database] = environmentify(tenant)
+      end
+
       #   Load a file or abort if it doesn't exists
       #
       def load_or_abort(file)
@@ -224,6 +250,34 @@ module Apartment
       def rescue_from
         []
       end
+
+      def db_connection_config(tenant)
+        Apartment.db_config_for(tenant).clone
+      end
+
+      # neutral connection is necessary whenever you need to create/remove a database from a server.
+      # example: when you use postgresql, you need to connect to the default postgresql database before you create your own.
+      def with_neutral_connection(tenant, &block)
+        SeparateDbConnectionHandler.establish_connection(multi_tenantify(tenant, false))
+        yield(SeparateDbConnectionHandler.connection)
+        SeparateDbConnectionHandler.connection.close
+      end
+
+      def reset_on_connection_exception?
+        false
+      end
+
+      def raise_drop_tenant_error!(tenant, exception)
+        raise TenantNotFound, "Error while dropping tenant #{environmentify(tenant)}: #{ exception.message }"
+      end
+
+      def raise_create_tenant_error!(tenant, exception)
+        raise TenantExists, "Error while creating tenant #{environmentify(tenant)}: #{ exception.message }"
+      end
+
+      def raise_connect_error!(tenant, exception)
+        raise TenantNotFound, "Error while connecting to tenant #{environmentify(tenant)}: #{ exception.message }"
+      end
     end
   end
 end

data/lib/apartment/adapters/abstract_jdbc_adapter.rb

@@ -4,20 +4,15 @@ module Apartment
   module Adapters
     class AbstractJDBCAdapter < AbstractAdapter
 
-    protected
+    private
 
-      #   Return a new config that is multi-tenanted
-      #
-      def multi_tenantify(database)
-        @config.clone.tap do |config|
-          config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(database)}"
-        end
+      def multi_tenantify_with_tenant_db_name(config, tenant)
+        config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(tenant)}"
       end
-    private
 
       def rescue_from
         ActiveRecord::JDBCError
       end
     end
   end
-end
+end

data/lib/apartment/adapters/jdbc_mysql_adapter.rb

@@ -11,19 +11,8 @@ module Apartment
   module Adapters
     class JDBCMysqlAdapter < AbstractJDBCAdapter
 
-      protected
-
-      #   Connect to new database
-      #   Abstract adapter will catch generic ActiveRecord error
-      #   Catch specific adapter errors here
-      #
-      #   @param {String} database Database name
-      #
-      def connect_to_new(database)
-        super
-      rescue TenantNotFound
-        Apartment::Tenant.reset
-        raise TenantNotFound, "Cannot find database #{environmentify(database)}"
+      def reset_on_connection_exception?
+        true
       end
     end
   end

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -15,27 +15,16 @@ module Apartment
     # Default adapter when not using Postgresql Schemas
     class JDBCPostgresqlAdapter < PostgresqlAdapter
 
-    protected
-
-      def create_tenant(tenant)
-        # There is a bug in activerecord-jdbcpostgresql-adapter (1.2.5) that will cause
-        # an exception if no options are passed into the create_database call.
-        Apartment.connection.create_database(environmentify(tenant), { :thisisahack => '' })
+    private
 
-      rescue *rescuable_exceptions
-        raise TenantExists, "The tenant #{environmentify(tenant)} already exists."
+      def multi_tenantify_with_tenant_db_name(config, tenant)
+        config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(tenant)}"
       end
 
-      #   Return a new config that is multi-tenanted
-      #
-      def multi_tenantify(tenant)
-        @config.clone.tap do |config|
-          config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(tenant)}"
-        end
+      def create_tenant_command(conn, tenant)
+        conn.create_database(environmentify(tenant), { :thisisahack => '' })
       end
 
-    private
-
       def rescue_from
         ActiveRecord::JDBCError
       end