multitenant-mysql 1.0.1 → 1.0.2

data/README.rdoc

@@ -1,6 +1,6 @@
 == Multitenant::Mysql
  
-Web app often face multitenancy problem and there are already few gems that help to solve this issue but this one uses different approach.
+Web app often faces multitenancy problem and there are already few gems that help to solve this issue but this one uses different approach.
 Instead of default scopes or creating a separate database for every single tenant this gem uses mysql views and triggers.
 The idea is taken from http://blog.empowercampaigns.com/post/1044240481/multi-tenant-data-and-mysql
 
@@ -12,6 +12,7 @@ The advantages of such approach:
 
 == Code Status
 
+* {<img src="https://fury-badge.herokuapp.com/rb/multitenant-mysql.png" alt="Gem Version" />}[http://badge.fury.io/rb/multitenant-mysql]
 * {<img src="https://travis-ci.org/eugenekorpan/multitenant-mysql.png?branch=master"/>}[http://travis-ci.org/eugenekorpan/multitenant-mysql]
 * {<img src="https://gemnasium.com/eugenekorpan/multitenant-mysql.png" alt="Dependency Status" />}[https://gemnasium.com/eugenekorpan/multitenant-mysql]
 * {<img src="https://codeclimate.com/github/eugenekorpan/multitenant-mysql.png" />}[https://codeclimate.com/github/eugenekorpan/multitenant-mysql]
@@ -70,7 +71,9 @@ E.g.
 
 if method used by `set_current_tenant` returns blank name then `root` account is used
 
-== Host It Works
+Note: if you want to use subdomain as a tenant name then you can use `set_current_tenant_by_subdomain` method. Just add it into your application_controller. In this case `set_current_tenant` is not needed.
+
+== How It Works
 
 About the main principles you can read here http://blog.empowercampaigns.com/post/1044240481/multi-tenant-data-and-mysql.
 

data/lib/generators/multitenant/install/install_generator.rb

@@ -7,7 +7,7 @@ module Multitenant
     CONFIG_FILE_NAME = 'multitenant_mysql_conf.rb'
 
     def copy_conf_file_into_app
-      dest = Rails.root.to_s + "/config/#{CONFIG_FILE_NAME}"
+      dest = "config/#{CONFIG_FILE_NAME}"
       return if FileTest.exist?(dest) # to prevent overwritting of existing file
       src = File.expand_path(File.dirname(__FILE__)) + "/templates/#{CONFIG_FILE_NAME}"
       FileUtils.copy_file src, dest

data/lib/generators/multitenant/install/templates/multitenant_mysql_conf.rb

@@ -1,6 +1,6 @@
 # simple example
 #
-# Multitenant::Mysql.active_record_configs = {
+# Multitenant::Mysql.arc = {
 #   models: ['Book', 'Task'],
 #   tenant_model: { name: 'Subdomain', tenant_name_attr: name }
 # }
@@ -11,7 +11,7 @@
 #   name - model name
 #   tenant_name_attr - attribute used to fetch tenant name
 
-Multitenant::Mysql.active_record_configs = {
+Multitenant::Mysql.arc = {
   models: [],
   tenant_model: { name: '' }
 }

data/lib/generators/multitenant/migrations/migration_builder.rb

@@ -13,7 +13,7 @@ module Multitenant
           "add_column :#{model.table_name}, :tenant, :string"
         }
 
-        dest_path = Rails.root.to_s + "/db/migrate/#{migration_number}_#{MIGRATION_NAME}.rb"
+        dest_path = "db/migrate/#{migration_number}_#{MIGRATION_NAME}.rb"
         migration = File.new(dest_path, "w")
         migration.puts(migration_code(actions))
         migration.close
@@ -35,7 +35,7 @@ end)
       end
 
       def migration_exists?
-        migrations = Dir.entries(Rails.root.to_s + "/db/migrate")
+        migrations = Dir.entries("db/migrate")
         migrations.any? { |m| m.include?(MIGRATION_NAME) }
       end
     end

data/lib/multitenant-mysql.rb

@@ -1,58 +1,6 @@
 require 'multitenant-mysql/version'
-require 'multitenant-mysql/active_record_extension'
 require 'multitenant-mysql/action_controller_extension'
 require 'multitenant-mysql/conf_file'
+require 'multitenant-mysql/arc'
 
-require_relative '../rails/init'
-
-module Multitenant
-  module Mysql
-
-    class << self
-
-      DEFAULT_TENANT_NAME_ATTR = [:name, :title]
-
-      def active_record_configs=(configs)
-        @configs = configs
-      end
-
-      def active_record_configs
-        @configs
-      end
-
-      alias_method :arc, :active_record_configs
-
-      def tenant
-        arc[:tenant_model][:name].constantize
-      rescue
-        if arc.blank? || arc[:tenant_model].blank? || arc[:tenant_model][:name].blank?
-          raise "
-            Multitenant::Mysql: You should specify model which stores info about tenants.
-            E.g. in initializer:
-            Multitenant::Mysql.arc = {
-              tenant_model: { name: 'Subdomain' }
-            }
-          "
-        else
-          raise "Please check your multitenant-mysql configs. Seems like you are trying to use model which doesn't exist: #{arc[:tenant_model][:name]}"
-        end
-      end
-
-      def models
-        active_record_configs[:models]
-      end
-
-      def tenant_name_attr
-        return active_record_configs[:tenant_model][:tenant_name_attr] if active_record_configs[:tenant_model][:tenant_name_attr]
-
-        DEFAULT_TENANT_NAME_ATTR.each do |name|
-          return name if tenant.column_names.include?(name.to_s)
-        end
-
-        raise 'You should specify tenant name attribute or use one default: name, title'
-      end
-
-    end
-
-  end
-end
+require 'multitenant-mysql/active_record_extension'

data/lib/multitenant-mysql/action_controller_extension.rb

@@ -14,4 +14,15 @@ class ActionController::Base
       Multitenant::Mysql::ConnectionSwitcher.new(self, @@tenant_method).execute
     end
   end
+
+  def self.set_current_tenant_by_subdomain
+    require Multitenant::Mysql::ConfFile.path
+
+    before_filter :establish_tenant_connection_by_subdomain
+
+    def establish_tenant_connection_by_subdomain
+      tenant_name = request.subdomain
+      Multitenant::Mysql::ConnectionSwitcher.set_tenant(tenant_name)
+    end
+  end
 end

data/lib/multitenant-mysql/active_record_extension.rb

@@ -7,4 +7,35 @@ class ActiveRecord::Base
       ActiveRecord::Base.connection.execute "flush privileges;"
     end
   end
+
+  def self.inherited(child)
+    return unless FileTest.exist?(Multitenant::Mysql::ConfFile.full_path) # do nothing if no config file provided
+    require Multitenant::Mysql::ConfFile.path
+
+    model_name = child.to_s
+    if Multitenant::Mysql.models.include? model_name
+      view_name = model_name.to_s.downcase.pluralize + "_view"
+
+      # check whether the view exists in db
+      if ActiveRecord::Base.connection.table_exists? view_name
+        child.class_eval do
+          cattr_accessor :original_table_name
+
+          self.original_table_name = self.table_name
+          self.table_name = view_name
+          self.primary_key = :id
+
+          def self.new(*args)
+            object = super(*args)
+            object.id = nil # workaround for https://github.com/rails/rails/issues/5982
+            object
+          end
+        end
+      end
+    end
+
+    if Multitenant::Mysql.tenant == child
+      child.send :acts_as_tenant
+    end
+  end
 end

data/lib/multitenant-mysql/arc.rb

@@ -0,0 +1,52 @@
+module Multitenant
+  module Mysql
+
+    class << self
+
+      DEFAULT_TENANT_NAME_ATTR = [:name, :title]
+
+      def active_record_configs=(configs)
+        @configs = configs
+      end
+
+      def active_record_configs
+        @configs
+      end
+
+      alias_method :arc, :active_record_configs
+      alias_method :arc=, :active_record_configs=
+
+      def tenant
+        arc[:tenant_model][:name].constantize
+      rescue
+        if arc.blank? || arc[:tenant_model].blank? || arc[:tenant_model][:name].blank?
+          raise "
+            Multitenant::Mysql: You should specify model which stores info about tenants.
+            E.g. in initializer:
+            Multitenant::Mysql.arc = {
+              tenant_model: { name: 'Subdomain' }
+            }
+          "
+        else
+          raise "Please check your multitenant-mysql configs. Seems like you are trying to use model which doesn't exist: #{arc[:tenant_model][:name]}"
+        end
+      end
+
+      def models
+        active_record_configs[:models]
+      end
+
+      def tenant_name_attr
+        return active_record_configs[:tenant_model][:tenant_name_attr] if active_record_configs[:tenant_model][:tenant_name_attr]
+
+        DEFAULT_TENANT_NAME_ATTR.each do |name|
+          return name if tenant.column_names.include?(name.to_s)
+        end
+
+        raise 'You should specify tenant name attribute or use one default: name, title'
+      end
+
+    end
+
+  end
+end

data/lib/multitenant-mysql/connection_switcher.rb

@@ -2,6 +2,21 @@ module Multitenant
   module Mysql
     class NoTenantRegistratedError < StandardError; end;
 
+    class DB
+      class << self
+        def configs
+          Rails.configuration.database_configuration[Rails.env]
+        end
+
+        def establish_connection_for tenant_name
+          config = configs
+          config['username'] = tenant_name.blank? ? 'root' : tenant_name
+          ActiveRecord::Base.establish_connection(config)
+          true
+        end
+      end
+    end
+
     class Tenant
       def self.exists? tenant_name
         return true if tenant_name.blank?
@@ -22,25 +37,13 @@ module Multitenant
 
       def self.set_tenant(tenant_name)
         return unless Tenant.exists?(tenant_name)
-
-        config = Rails.configuration.database_configuration[Rails.env]
-        config['username'] = tenant_name.blank? ? 'root' : tenant_name
-        ActiveRecord::Base.establish_connection(config)
+        DB.establish_connection_for tenant_name
       end
 
       def execute
-        config = db_config
-
         tenant_name = action_controller.send(method)
         return unless Tenant.exists?(tenant_name)
-
-        config['username'] = tenant_name.blank? ? 'root' : tenant_name
-        ActiveRecord::Base.establish_connection(config)
-        true
-      end
-
-      def db_config
-        Rails.configuration.database_configuration[Rails.env]
+        DB.establish_connection_for tenant_name
       end
     end
 

data/lib/multitenant-mysql/version.rb

@@ -1,5 +1,5 @@
 module Multitenant
   module Mysql
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/rails/init.rb

@@ -1,34 +1 @@
-ActiveRecord::Base.class_eval do
-  def self.inherited(child)
-
-    return unless FileTest.exist?(Multitenant::Mysql::ConfFile.full_path) # do nothing if no config file provided
-
-    require Multitenant::Mysql::ConfFile.path
-
-    model_name = child.to_s
-    if Multitenant::Mysql.models.include? model_name
-      view_name = model_name.to_s.downcase.pluralize + "_view"
-
-      # check whether the view exists in db
-      if ActiveRecord::Base.connection.table_exists? view_name
-        child.class_eval do
-          cattr_accessor :original_table_name
-
-          self.original_table_name = self.table_name
-          self.table_name = view_name
-          self.primary_key = :id
-
-          def self.new(*args)
-            object = super(*args)
-            object.id = nil # workaround for https://github.com/rails/rails/issues/5982
-            object
-          end
-        end
-      end
-    end
-
-    if Multitenant::Mysql.tenant == child
-      child.send :acts_as_tenant
-    end
-  end
-end
+require 'multitenant-mysql'

data/spec/action_controller_extension_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
 
 describe ActionController::Base do
-  subject { ActionController::Base }
 
   context '.set_current_tenant' do
+    subject { ActionController::Base }
+
     it 'should raise an error when no tenant method provided' do
       expect { subject.set_current_tenant }.to raise_error
     end
@@ -17,4 +18,19 @@ describe ActionController::Base do
       expect( subject.new.establish_tenant_connection ).to eql('ok')
     end
   end
+
+  context '.set_current_tenant_by_subdomain' do
+    subject { ActionController::Base.new }
+
+    before do
+      ActionController::Base.set_current_tenant_by_subdomain
+    end
+
+    it 'should set current tenant by subdomain' do
+      subject.stub_chain(:request, :subdomain).and_return('yahoo')
+      Multitenant::Mysql::ConnectionSwitcher.should_receive(:set_tenant).with('yahoo').and_return(true)
+
+      expect( subject.establish_tenant_connection_by_subdomain ).to be
+    end
+  end
 end

data/spec/{multitenant_mysql_spec.rb → arc_spec.rb}

@@ -63,5 +63,17 @@ describe Multitenant::Mysql do
       end
     end
 
+    context 'alias methods' do
+      it 'should use aliased setter' do
+        subject.arc = 'ARC'
+        expect(subject.active_record_configs).to eql('ARC')
+      end
+
+      it 'should use aliased getter' do
+        subject.active_record_configs = 'ABC'
+        expect(subject.arc).to eql('ABC')
+      end
+    end
+
   end
 end

data/spec/connection_switcher_spec.rb

@@ -14,7 +14,7 @@ describe Multitenant::Mysql::ConnectionSwitcher do
       ac_mock = double('ActionController::Base')
       ac_mock.should_receive(:send).and_return('unexisting tenant')
       switcher = Multitenant::Mysql::ConnectionSwitcher.new(ac_mock, :tenant_method)
-      switcher.stub(:db_config).and_return({ username: 'root' })
+      Multitenant::Mysql::DB.stub(:configs).and_return({ 'username' => 'root' })
 
       expect { switcher.execute }.to raise_error(Multitenant::Mysql::NoTenantRegistratedError)
     end
@@ -27,11 +27,23 @@ describe Multitenant::Mysql::ConnectionSwitcher do
       ac_mock = double('ActionController::Base')
       ac_mock.should_receive(:tenant_method)
       switcher = Multitenant::Mysql::ConnectionSwitcher.new(ac_mock, :tenant_method)
-      switcher.stub(:db_config).and_return({ username: 'root' })
+      Multitenant::Mysql::DB.stub(:configs).and_return({ 'username' => 'root' })
 
       ActiveRecord::Base.should_receive(:establish_connection)
 
       expect( switcher.execute ).to be
     end
   end
+
+  context '.set_tenant' do
+    subject { Multitenant::Mysql::ConnectionSwitcher }
+
+    it 'should change db connection' do
+      Multitenant::Mysql::Tenant.stub(:exists?).and_return(true)
+      Multitenant::Mysql::DB.stub(:configs).and_return({ 'username' => 'root' })
+
+      ActiveRecord::Base.should_receive(:establish_connection).with({ 'username' => 'google'})
+      expect( subject.set_tenant('google') ).to be
+    end
+  end
 end

data/spec/rails/active_record_base_spec.rb

@@ -5,6 +5,7 @@ describe ActiveRecord::Base do
 
   before do
     Multitenant::Mysql::ConfFile.path = CONF_FILE_PATH
+    Multitenant::Mysql.arc = { models: ['Book', 'Task'] }
   end
 
   it 'should respond to acts_as_tenant' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multitenant-mysql
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -51,15 +51,16 @@ files:
 - lib/multitenant-mysql.rb
 - lib/multitenant-mysql/action_controller_extension.rb
 - lib/multitenant-mysql/active_record_extension.rb
+- lib/multitenant-mysql/arc.rb
 - lib/multitenant-mysql/conf_file.rb
 - lib/multitenant-mysql/connection_switcher.rb
 - lib/multitenant-mysql/version.rb
 - multitenant-mysql.gemspec
 - rails/init.rb
 - spec/action_controller_extension_spec.rb
+- spec/arc_spec.rb
 - spec/conf_file_spec.rb
 - spec/connection_switcher_spec.rb
-- spec/multitenant_mysql_spec.rb
 - spec/rails/active_record_base_spec.rb
 - spec/spec_helper.rb
 - spec/support/multitenant_mysql_conf.rb
@@ -83,15 +84,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Add multi-tenancy to Rails application using MySql views
 test_files:
 - spec/action_controller_extension_spec.rb
+- spec/arc_spec.rb
 - spec/conf_file_spec.rb
 - spec/connection_switcher_spec.rb
-- spec/multitenant_mysql_spec.rb
 - spec/rails/active_record_base_spec.rb
 - spec/spec_helper.rb
 - spec/support/multitenant_mysql_conf.rb