acts_as_tenant 0.3.5 → 0.3.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWRkOGI4YTQ3YWJiNDZmMDg5YmQ5ZjZiNGVlNzRjZGUzOGYyYTYxMw==
+    MmNiZWQ1ZWI4YWU2Y2M4YTMxNjRiN2RkYTA0MzNkN2VkZTRhNTczOA==
   data.tar.gz: !binary |-
-    M2I2OTE5NTlmZmM2NDk1MDY5NzIyMGFhMjMwOGU1ODRkOTRlNTg1Nw==
+    YzUzZmVmOTdhY2NlZDQ3NGMxZWRjMDYxY2RjODBmOWE1MjJlOTRiMA==
 SHA512:
   metadata.gz: !binary |-
-    Y2EwYmZlNTU5Y2RmM2YyMjQzNjE2MjljY2I1YjIxYThkZjllNTExYzY3OTRh
-    Y2U3YzAyYzc2NGRlNGUyYmY1NjY1MTdkZmNjMGNkMzFkNzE1MjRjNWU2OTQz
-    YjljN2I3OTk2MjQxNmM4YjAzMzQwMzFmMmY0MGVhZjNiMDBmOTc=
+    NzhmYWY4NmY3ZTkxZjE0MTIzZjdlYjc2ZTI5ZmFhMWI0OGEzZmRhYzFmYjQ3
+    ODhiMmVmMmE0MTFiYjBiZTQyODg1ZTU3MzRiMzZmNmJmMzYwYzZkMTI1OGJi
+    ZDRjODllOWMzNmVhZmUxNmFkMmM1MjRjNDhmZjU4MTc3Y2YyMjQ=
   data.tar.gz: !binary |-
-    OTQ2ZjZmMzMwYTc0NmZlMjYyMzg0OGE4MTQ2NWMxYjc5ODYwMTNmNWMzMjJm
-    Yzg4NzJiOTU0MjcyMGE1ZGQxMjc5Zjk4NTJkMWU5YWNjNDBjZWE2OTlmNTE2
-    NWIwYjAxYjkwNGRiMjIzNGY2YmVlYmFmYWQyMTNhMTgyYzIzODU=
+    NmU4NjEzZGQyOGQ5ZTk2MzgyMzMyYjRmMDczNGIwOTQ4NDA4YTNmNzc0MTU4
+    ZDc5M2UwNDMzMTI5YmExN2I1MjRhYTgxMDgyYjI0MjY3OWZkNjgyOTQxOGMw
+    MzYyNThlNjhiMTM2YTdhZTQ0NzQ4ODQxZDUzYTZlNTNhM2YyNzQ=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.3.6
+-----
+* Added method `set_current_tenant_by_subdomain_or_domain` (thx preth00nker)
+
 0.3.5
 -----
 * Fix to degredation introduced after 3.1 that prevented tenant_id from being set during initialization (thx jorgevaldivia)

data/README.md

@@ -41,8 +41,11 @@ There are three ways to set the current tenant: (1) by using the subdomain to lo
     class ApplicationController < ActionController::Base
       set_current_tenant_by_subdomain(:account, :subdomain)
     end
+
 This tells acts_as_tenant to use the current subdomain to identify the current tenant. In addition, it tells acts_as_tenant that tenants are represented by the Account model and this model has a column named 'subdomain' which can be used to lookup the Account using the actual subdomain. If ommitted, the parameters will default to the values used above.
 
+Alternatively, you could locate the tenant using the method set_current_tenant_by_subdomain_or_domain( :account, :subdomain,  :domain ) which will try to match a record first by subdomain. in case it fails, by domain.
+
 **Setting the current tenant in a controller, manually**
 
     class ApplicationController < ActionController::Base

data/acts_as_tenant.gemspec

@@ -17,17 +17,16 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   #add_runtime_dependency("rails")
   s.add_runtime_dependency('request_store', '>= 1.0.5')
   s.add_dependency('rails','>= 3.1')
   #s.add_dependency('request_store', '>= 1.0.5')
 
-  s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec', '>=3.0')
   s.add_development_dependency('rspec-rails')
   s.add_development_dependency('database_cleaner')
   s.add_development_dependency('sqlite3')
-  s.add_development_dependency('debugger')
 
-  s.add_development_dependency('sidekiq')
+  s.add_development_dependency('sidekiq', '>= 3.0')
 end

data/lib/acts_as_tenant/controller_extensions.rb

@@ -26,6 +26,34 @@ module ActsAsTenant
           end
       end
     end
+
+    # 01/27/2014 Christian Yerena / @preth00nker
+    # this method adds the possibility of use the domain as a possible second argument to find 
+    # the current_tenant. 
+    def set_current_tenant_by_subdomain_or_domain(tenant = :account, primary_column = :subdomain, second_column = :domain )
+      self.class_eval do
+        cattr_accessor :tenant_class, :tenant_primary_column, :tenant_second_column
+      end
+      
+      self.tenant_class = tenant.to_s.camelcase.constantize
+      self.tenant_primary_column = primary_column.to_sym
+      self.tenant_second_column = second_column.to_sym
+      
+      self.class_eval do
+        before_filter :find_tenant_by_subdomain_or_domain
+        helper_method :current_tenant
+        
+        private
+          def find_tenant_by_subdomain_or_domain
+            ActsAsTenant.current_tenant = tenant_class.where(tenant_primary_column => request.subdomains.last).first || tenant_class.where(tenant_second_column => request.domain).first
+          end
+          
+          def current_tenant
+            ActsAsTenant.current_tenant
+          end
+      end
+    end
+
     
     # This method sets up a method that allows manual setting of the current_tenant. This method should
     # be used in a before_filter. In addition, a helper is setup that returns the current_tenant

data/lib/acts_as_tenant/sidekiq.rb

@@ -1,7 +1,7 @@
 module ActsAsTenant::Sidekiq
   # Get the current tenant and store in the message to be sent to Sidekiq.
   class Client
-    def call(worker_class, msg, queue)
+    def call(worker_class, msg, queue, redis_pool)
       msg['acts_as_tenant'] ||=
         {
             'class' => ActsAsTenant.current_tenant.class.name,

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/spec/acts_as_tenant/configuration_spec.rb

@@ -7,7 +7,7 @@ describe ActsAsTenant::Configuration do
     end
 
     it 'provides defaults' do
-      ActsAsTenant.configuration.require_tenant.should_not be_true
+      expect(ActsAsTenant.configuration.require_tenant).not_to be_truthy
     end
   end
 
@@ -21,7 +21,7 @@ describe ActsAsTenant::Configuration do
         config.require_tenant = true
       end
 
-      ActsAsTenant.configuration.require_tenant.should be_true
+      expect(ActsAsTenant.configuration.require_tenant).to eq(true)
     end
 
   end

data/spec/acts_as_tenant/model_extensions_spec.rb

@@ -5,6 +5,7 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table :accounts, :force => true do |t|
     t.column :name, :string
     t.column :subdomain, :string
+    t.column :domain, :string
   end
 
   create_table :projects, :force => true do |t|
@@ -110,11 +111,11 @@ describe ActsAsTenant do
   end
 
   describe 'is_scoped_as_tenant should return the correct value when true' do
-    it {Project.respond_to?(:scoped_by_tenant?).should == true}
+    it {expect(Project.respond_to?(:scoped_by_tenant?)).to eq(true)}
   end
 
   describe 'is_scoped_as_tenant should return the correct value when false' do
-    it {UnscopedModel.respond_to?(:scoped_by_tenant?).should == false}
+    it {expect(UnscopedModel.respond_to?(:scoped_by_tenant?)).to eq(false)}
   end
 
   describe 'tenant_id should be immutable, if already set' do
@@ -123,7 +124,7 @@ describe ActsAsTenant do
       @project = @account.projects.create!(:name => 'bar')
     end
 
-    it { lambda {@project.account_id = @account.id + 1}.should raise_error }
+    it { expect {@project.account_id = @account.id + 1}.to raise_error }
   end
 
   describe 'tenant_id should be mutable, if not already set' do
@@ -132,8 +133,8 @@ describe ActsAsTenant do
       @project = Project.create!(:name => 'bar')
     end
 
-    it { @project.account_id.should be_nil }
-    it { lambda { @project.account = @account }.should_not raise_error }
+    it { expect(@project.account_id).to be_nil }
+    it { expect { @project.account = @account }.not_to raise_error }
   end
 
   describe 'tenant_id should auto populate after initialization' do
@@ -141,7 +142,7 @@ describe ActsAsTenant do
       @account = Account.create!(:name => 'foo')
       ActsAsTenant.current_tenant = @account
     end
-    it {Project.new.account_id.should == @account.id}
+    it {expect(Project.new.account_id).to eq(@account.id)}
   end
 
   describe 'Handles custom foreign_key on tenant model' do
@@ -151,7 +152,7 @@ describe ActsAsTenant do
       @custom_foreign_key_task = CustomForeignKeyTask.create!(:name => 'foo')
     end
 
-    it { @custom_foreign_key_task.account.should == @account }
+    it { expect(@custom_foreign_key_task.account).to eq(@account) }
   end
 
   # Scoping models
@@ -167,8 +168,8 @@ describe ActsAsTenant do
       @projects = Project.all
     end
 
-    it { @projects.length.should == 1 }
-    it { @projects.should == [@project1] }
+    it { expect(@projects.length).to eq(1) }
+    it { expect(@projects).to eq([@project1]) }
   end
 
   describe 'Project.unscoped.all should return the unscoped value' do
@@ -183,7 +184,7 @@ describe ActsAsTenant do
       @projects = Project.unscoped
     end
 
-    it { @projects.count.should == 2 }
+    it { expect(@projects.count).to eq(2) }
   end
 
   describe 'Querying the tenant from a scoped model without a tenant set' do
@@ -219,11 +220,11 @@ describe ActsAsTenant do
     end
 
     it 'should correctly set the tenant on the task created with current_tenant set' do
-      @task2.account.should == @account
+      expect(@task2.account).to eq(@account)
     end
 
     it 'should filter out the non-tenant task from the project' do
-      @tasks.length.should == 1
+      expect(@tasks.length).to eq(1)
     end
   end
 
@@ -237,17 +238,17 @@ describe ActsAsTenant do
       @task = @project2.tasks.create!(:name => 'bar')
     end
 
-    it { @task.update_attributes(:project_id => @project1.id).should == false }
+    it { expect(@task.update_attributes(:project_id => @project1.id)).to eq(false) }
   end
 
   describe "Create and save an AaT-enabled child without it having a parent" do
       @account = Account.create!(:name => 'baz')
       ActsAsTenant.current_tenant = @account
-      Task.create(:name => 'bar').valid?.should == true
+      it { expect(Task.create(:name => 'bar').valid?).to eq(true) }
   end
 
   describe "It should be possible to use aliased associations" do
-    it { AliasedTask.create(:name => 'foo', :project_alias => @project2).valid?.should == true }
+    it { expect(AliasedTask.create(:name => 'foo', :project_alias => @project2).valid?).to eq(true) }
   end
 
   # Additional default_scopes
@@ -268,8 +269,8 @@ describe ActsAsTenant do
     end
 
     it 'should apply both the tenant scope and the user defined default_scope, including :order' do
-      @tasks.length.should == 3
-      @tasks.should == [@task2, @task3, @task4]
+      expect(@tasks.length).to eq(3)
+      expect(@tasks).to eq([@task2, @task3, @task4])
     end
   end
 
@@ -282,13 +283,13 @@ describe ActsAsTenant do
     end
 
     it 'should not be possible to create a duplicate within the same tenant' do
-      Project.create(:name => 'existing_name').valid?.should == false
+      expect(Project.create(:name => 'existing_name').valid?).to eq(false)
     end
 
     it 'should be possible to create a duplicate outside the tenant scope' do
       account = Account.create!(:name => 'baz')
       ActsAsTenant.current_tenant = account
-      Project.create(:name => 'bar').valid?.should == true
+      expect(Project.create(:name => 'bar').valid?).to eq(true)
     end
   end
 
@@ -297,8 +298,8 @@ describe ActsAsTenant do
       UniqueTask.create!(:name => 'foo', :user_defined_scope => 'unique_scope')
     end
 
-    it { UniqueTask.create(:name => 'foo', :user_defined_scope => 'another_scope').should be_valid }
-    it { UniqueTask.create(:name => 'foo', :user_defined_scope => 'unique_scope').should_not be_valid }
+    it { expect(UniqueTask.create(:name => 'foo', :user_defined_scope => 'another_scope')).to be_valid }
+    it { expect(UniqueTask.create(:name => 'foo', :user_defined_scope => 'unique_scope')).not_to be_valid }
   end
 
   describe 'When using validates_uniqueness_of in a NON-aat model' do
@@ -306,7 +307,7 @@ describe ActsAsTenant do
       UnscopedModel.create!(:name => 'foo')
     end
     it 'should not be possible to create duplicates' do
-      UnscopedModel.create(:name => 'foo').valid?.should == false
+      expect(UnscopedModel.create(:name => 'foo').valid?).to eq(false)
     end
   end
 
@@ -316,7 +317,7 @@ describe ActsAsTenant do
       @account = Account.create!(:name => 'baz')
 
       ActsAsTenant.with_tenant(@account) do
-        ActsAsTenant.current_tenant.should eq(@account)
+        expect(ActsAsTenant.current_tenant).to eq(@account)
       end
     end
 
@@ -329,7 +330,7 @@ describe ActsAsTenant do
 
       end
 
-      ActsAsTenant.current_tenant.should eq(@account1)
+      expect(ActsAsTenant.current_tenant).to eq(@account1)
     end
 
     it "should return the value of the block" do
@@ -341,7 +342,7 @@ describe ActsAsTenant do
         "something"
       end
 
-      value.should eq "something"
+      expect(value).to eq "something"
     end
 
     it "should raise an error when no block is provided" do
@@ -355,7 +356,7 @@ describe ActsAsTenant do
       before do
         @account1 = Account.create!(:name => 'foo')
         @project1 = @account1.projects.create!(:name => 'foobar')
-        ActsAsTenant.configuration.stub(require_tenant: true)
+        allow(ActsAsTenant.configuration).to receive_messages(require_tenant: true)
       end
 
       it "should raise an error when no tenant is provided" do

data/spec/acts_as_tenant/sidekiq_spec.rb

@@ -14,7 +14,7 @@ describe ActsAsTenant::Sidekiq do
       ActsAsTenant.current_tenant = account
 
       msg = {}
-      subject.call(nil, msg, nil) { }
+      subject.call(nil, msg, nil, nil) { }
       expect(msg).to eq message
     end
 
@@ -22,7 +22,7 @@ describe ActsAsTenant::Sidekiq do
       expect(ActsAsTenant.current_tenant).to be_nil
 
       msg = {}
-      subject.call(nil, msg, nil) { }
+      subject.call(nil, msg, nil, nil) { }
       expect(msg).not_to eq message
     end
   end
@@ -54,7 +54,7 @@ describe ActsAsTenant::Sidekiq do
   describe 'Sidekiq configuration' do
     describe 'client configuration' do
       it 'includes ActsAsTenant client' do
-        expect(Sidekiq.client_middleware.exists?(ActsAsTenant::Sidekiq::Client)).to be_true
+        expect(Sidekiq.client_middleware.exists?(ActsAsTenant::Sidekiq::Client)).to eq(true)
       end
     end
 

data/spec/acts_as_tenant/tenant_by_filter_spec.rb

@@ -28,6 +28,6 @@ describe ApplicationController2, :type => :controller do
 
   it 'Finds the correct tenant using the filter command' do
     get :index
-    ActsAsTenant.current_tenant.name.should eq 'account1'
+    expect(ActsAsTenant.current_tenant.name).to eq 'account1'
   end
 end

data/spec/acts_as_tenant/tenant_by_subdomain_or_domain.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+#Setup test specific ApplicationController
+class Account; end # this is so the spec will work in isolation
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  set_current_tenant_by_subdomain_or_domain
+end
+
+# Start testing
+describe ApplicationController, :type => :controller do
+  controller do
+    def index
+      render :text => "custom called"
+    end
+  end
+
+  it 'Finds the correct tenant with a example1.com' do
+    @request.host = "example1.com"
+    expect(Account).to receive(:where).with({subdomain: nil}) {[]}
+    expect(Account).to receive(:where).with({domain: 'example1.com'}) {['account1']}
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq 'account1'
+  end
+
+  it 'Finds the correct tenant with a subdomain.example.com' do
+    @request.host = "subdomain.example.com"
+    expect(Account).to receive(:where).with({subdomain: 'subdomain'}) {['account1']}
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq "account1"
+  end
+
+  it 'Finds the correct tenant with a www.subdomain.example.com' do
+    @request.host = "subdomain.example.com"
+    expect(Account).to receive(:where).with({subdomain: 'subdomain'}) {['account1']}
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq "account1"
+  end
+
+
+end

data/spec/acts_as_tenant/tenant_by_subdomain_spec.rb

@@ -18,15 +18,15 @@ describe ApplicationController, :type => :controller do
 
   it 'Finds the correct tenant with a subdomain.example.com' do
     @request.host = "account1.example.com"
-    Account.should_receive(:where).with({subdomain: 'account1'}) {['account1']}
+    expect(Account).to receive(:where).with({subdomain: 'account1'}) {['account1']}
     get :index
-    ActsAsTenant.current_tenant.should eq 'account1'
+    expect(ActsAsTenant.current_tenant).to eq 'account1'
   end
 
   it 'Finds the correct tenant with a www.subdomain.example.com' do
     @request.host = "www.account1.example.com"
-    Account.should_receive(:where).with({subdomain: 'account1'}) {['account1']}
+    expect(Account).to receive(:where).with({subdomain: 'account1'}) {['account1']}
     get :index
-    ActsAsTenant.current_tenant.should eq 'account1'
+    expect(ActsAsTenant.current_tenant).to eq 'account1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Erwin Matthijssen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -94,34 +94,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  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: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Integrates multi-tenancy into a Rails application in a convenient and
   out-of-your way manner
 email:
@@ -149,6 +135,7 @@ files:
 - spec/acts_as_tenant/model_extensions_spec.rb
 - spec/acts_as_tenant/sidekiq_spec.rb
 - spec/acts_as_tenant/tenant_by_filter_spec.rb
+- spec/acts_as_tenant/tenant_by_subdomain_or_domain.rb
 - spec/acts_as_tenant/tenant_by_subdomain_spec.rb
 - spec/database.yml
 - spec/spec_helper.rb
@@ -180,6 +167,7 @@ test_files:
 - spec/acts_as_tenant/model_extensions_spec.rb
 - spec/acts_as_tenant/sidekiq_spec.rb
 - spec/acts_as_tenant/tenant_by_filter_spec.rb
+- spec/acts_as_tenant/tenant_by_subdomain_or_domain.rb
 - spec/acts_as_tenant/tenant_by_subdomain_spec.rb
 - spec/database.yml
 - spec/spec_helper.rb