acts_as_tenant 0.3.9 → 0.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTU3MTcwNGYyNzk1NDk3OWMyNmQxYWJjNDdkNjI5NDVjZjc4MjA0MQ==
-  data.tar.gz: !binary |-
-    NTUxMDJkZmI1NmE3MGY3NzliMzI5N2ZiOGY4MTA1ZGQyZDlkNDRlYg==
+SHA1:
+  metadata.gz: b818ac81194035979865164439e777511f68c06c
+  data.tar.gz: f395680cfb279dd618df7e88ca6373adb2f6596a
 SHA512:
-  metadata.gz: !binary |-
-    ZDFkMWRmYjRhNTdmZmYxNDFmOWE4YjYxNTVhMTU0ZDYxNjE3OTk2Yjk0Yzdh
-    OWRlZGFmODNlN2E1NWJlNmRmNmVkYTEzOWVlOGViODBlNzY5YmYxY2QzMDZl
-    NTgwMjU5MjU3MGFkN2Q5MzBkY2MwMzljMDhiNTViZTI1ZmY3OTk=
-  data.tar.gz: !binary |-
-    ODI0OTM1YzE1NGM1N2QwNzBiNzZlMzI1MTM1YjhkZDU0Nzc2OGU4Y2FkMTdi
-    YTZmYjU3YjJiZjdkOGI5NWFmNDI4ZGNhMjk4NTZmM2VkYTYzZDg1MTc3NDQx
-    NmYxZmM4YmM2ODg5MjhmYjgzNDEwZTk0ZTVmODZkMGM1YWVlMjQ=
+  metadata.gz: 61cffd95ae9374d1f09a6353785468d8b13db7a3fbb2e9936585d9b0f8092a34a6d683bb20032715465e7cb4e72afacd67fc80dd5cf6c6b1b01178658b67bc36
+  data.tar.gz: 9f2f90d90b7ec7a25b443da85dc89cb75912bf348e600175e5a83af9ed14699ab1a2313e463eda90bfbd3db87674e148bacdc11e0d275a5aa5c2928590fc4387

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 services:
   - mongodb
+before_install:
+  - gem update bundler
 script: bundle exec rake spec:all

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.4.0
+------
+* (Sub)domain lookup is no longer case insensitive
+* Added ability to use inverse_of (thx lowjoel)
+* Added ability to disable tenant checking for a block (thx duboff)
+* Allow for validation that associations belong to the tenant to reflect on associations which return an Array from `where` (thx ludamillion)
+
 0.3.9
 -----
 * Added ability to configure a default tenant for testing purposes. (thx iangreenleaf)

data/README.md

@@ -83,6 +83,15 @@ any code in this block will be scoped to the current tenant. All methods that se
 
 **Note:** If the current tenant is not set by one of these methods, Acts_as_tenant will be unable to apply the proper scope to your models. So make sure you use one of the two methods to tell acts_as_tenant about the current tenant.
 
+### Disabling tenant checking for a block ###
+
+```ruby
+ActsAsTenant.without_tenant do
+  # Tenant checking is disabled for all code in this block
+end
+```
+This is useful in shared routes such as admin panels or internal dashboards when `require_tenant` option is enabled throughout the app.
+
 ### Require tenant to be set always ###
 
 If you want to require the tenant to be set at all times, you can configure acts_as_tenant to raise an error when a query is made without a tenant available. See below under configuarion options.
@@ -151,7 +160,7 @@ acts_as_tenant(:account, :foreign_key => 'accountID) # by default AaT expects ac
 Configuration options
 ---------------------
 An initializer can be created to control (currently one) option in ActsAsTenant. Defaults
-are shown below with sample overrides following. In `config/initializer/acts_as_tenant.rb`:
+are shown below with sample overrides following. In `config/initializers/acts_as_tenant.rb`:
 
 ```ruby
 ActsAsTenant.configure do |config|
@@ -165,7 +174,7 @@ Sidekiq support
 ---------------
 
 ActsAsTenant supports [Sidekiq](http://sidekiq.org/). A background processing library.
-Add the following code to your `config/initializer/acts_as_tenant.rb`:
+Add the following code to your `config/initializers/acts_as_tenant.rb`:
 
 ```ruby
 require 'acts_as_tenant/sidekiq'

data/lib/acts_as_tenant/controller_extensions.rb

@@ -18,7 +18,9 @@ module ActsAsTenant
 
         private
           def find_tenant_by_subdomain
-            ActsAsTenant.current_tenant = tenant_class.where(tenant_column => request.subdomains.last).first
+            if request.subdomains.last
+              ActsAsTenant.current_tenant = tenant_class.where(tenant_column => request.subdomains.last.downcase).first
+            end
           end
 
           def current_tenant
@@ -45,7 +47,11 @@ module ActsAsTenant
 
         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
+            if request.subdomains.last
+              ActsAsTenant.current_tenant = tenant_class.where(tenant_primary_column => request.subdomains.last.downcase).first
+            else
+              ActsAsTenant.current_tenant = tenant_class.where(tenant_second_column => request.domain.downcase).first
+            end
           end
 
           def current_tenant
@@ -65,7 +71,7 @@ module ActsAsTenant
           def set_current_tenant(current_tenant_object)
             ActsAsTenant.current_tenant = current_tenant_object
           end
-        
+
           def current_tenant
             ActsAsTenant.current_tenant
           end

data/lib/acts_as_tenant/model_extensions.rb

@@ -21,6 +21,18 @@ module ActsAsTenant
     RequestStore.store[:current_tenant] || self.default_tenant
   end
 
+  def self.unscoped=(unscoped)
+    RequestStore.store[:acts_as_tenant_unscoped] = unscoped
+  end
+
+  def self.unscoped
+    RequestStore.store[:acts_as_tenant_unscoped]
+  end
+
+  def self.unscoped?
+    !!unscoped
+  end
+
   class << self
     attr_accessor :default_tenant
   end
@@ -39,6 +51,24 @@ module ActsAsTenant
     self.current_tenant = old_tenant
   end
 
+  def self.without_tenant(&block)
+    if block.nil?
+      raise ArgumentError, "block required"
+    end
+
+    old_tenant = current_tenant
+    old_unscoped = unscoped
+
+    self.current_tenant = nil
+    self.unscoped = true
+    value = block.call
+    return value
+
+  ensure
+    self.current_tenant = old_tenant
+    self.unscoped = old_unscoped
+  end
+
   module ModelExtensions
     def self.included(base)
       base.extend(ClassMethods)
@@ -49,18 +79,18 @@ module ActsAsTenant
         ActsAsTenant.set_tenant_klass(tenant)
 
         # Create the association
-        valid_options = options.slice(:foreign_key, :class_name)
+        valid_options = options.slice(:foreign_key, :class_name, :inverse_of)
         fkey = valid_options[:foreign_key] || ActsAsTenant.fkey
         belongs_to tenant, valid_options
 
         default_scope lambda {
-          if ActsAsTenant.configuration.require_tenant && ActsAsTenant.current_tenant.nil?
+          if ActsAsTenant.configuration.require_tenant && ActsAsTenant.current_tenant.nil? && !ActsAsTenant.unscoped?
             raise ActsAsTenant::Errors::NoTenantSet
           end
           if ActsAsTenant.current_tenant
             where(fkey.to_sym => ActsAsTenant.current_tenant.id)
           else
-            all
+            Rails::VERSION::MAJOR < 4 ? scoped : all
           end
         }
 
@@ -87,7 +117,7 @@ module ActsAsTenant
                             else
                               a.primary_key
                             end.to_sym
-              record.errors.add attr, "association is invalid [ActsAsTenant]" unless value.nil? || association_class.where(primary_key => value).exists?
+              record.errors.add attr, "association is invalid [ActsAsTenant]" unless value.nil? || association_class.where(primary_key => value).any?
             end
           end
         end

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.3.9"
+  VERSION = "0.4.0"
 end

data/spec/acts_as_tenant/model_extensions_spec.rb

@@ -282,17 +282,55 @@ describe ActsAsTenant do
     end
   end
 
+  describe "::without_tenant" do
+    it "should set current_tenant to nil inside the block" do
+      ActsAsTenant.without_tenant do
+        expect(ActsAsTenant.current_tenant).to be_nil
+      end
+    end
+
+    it "should reset current_tenant to the previous tenant once exiting the block" do
+      @account1 = Account.create!(:name => 'foo')
+
+      ActsAsTenant.current_tenant = @account1
+      ActsAsTenant.without_tenant do
+      end
+
+      expect(ActsAsTenant.current_tenant).to eq(@account1)
+    end
+
+    it "should return the value of the block" do
+      value = ActsAsTenant.without_tenant do
+        "something"
+      end
+
+      expect(value).to eq "something"
+    end
+
+    it "should raise an error when no block is provided" do
+      expect { ActsAsTenant.without_tenant }.to raise_error(ArgumentError, /block required/)
+    end
+  end
+
   # Tenant required
   context "tenant required" do
+    before do
+      @account1 = Account.create!(:name => 'foo')
+      @project1 = @account1.projects.create!(:name => 'foobar')
+      allow(ActsAsTenant.configuration).to receive_messages(require_tenant: true)
+    end
+
     describe "raises exception if no tenant specified" do
-      before do
-        @account1 = Account.create!(:name => 'foo')
-        @project1 = @account1.projects.create!(:name => 'foobar')
-        allow(ActsAsTenant.configuration).to receive_messages(require_tenant: true)
+      it "should raise an error when no tenant is provided" do
+        expect { Project.all }.to raise_error(ActsAsTenant::Errors::NoTenantSet)
       end
+    end
 
-      it "should raise an error when no tenant is provided" do
-        expect { Project.all.load }.to raise_error(ActsAsTenant::Errors::NoTenantSet)
+    describe "does not raise exception when run in unscoped mode" do
+      it "should not raise an error when no tenant is provided" do
+        expect do
+          ActsAsTenant.without_tenant { Project.all }
+        end.to_not raise_error
       end
     end
   end

data/spec/acts_as_tenant/tenant_by_subdomain_or_domain.rb

@@ -18,7 +18,6 @@ describe ApplicationController, :type => :controller do
 
   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'
@@ -38,5 +37,10 @@ describe ApplicationController, :type => :controller do
     expect(ActsAsTenant.current_tenant).to eq "account1"
   end
 
-
+  it 'Ignores case when finding tenant by subdomain' 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

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Erwin Matthijssen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2016-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   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: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -130,8 +130,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -168,17 +168,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: acts_as_tenant
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Add multi-tenancy to Rails applications using a shared db strategy