acts_as_tenant 0.3.3 → 0.3.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDM3YTQ2MDk4YjRjZGRkNDlkMjVlNjVhYmE4MDhlYTZlZDcxY2JlNQ==
+    MDI0NjdkNWMzYTNjMDk2OTI4YjIxMmM1YmNmOThmOGVkYmU5MGQ1Yg==
   data.tar.gz: !binary |-
-    YjIxMTk0YzRmMDg1MmZhNTk2ZDRjMjZiODE4YTA5ZTA1MDgyMzc1OA==
+    MjIxYTJjNmU0MTI1ZGJiZjEyNDNiOTcyMjhjNDk5Yjg5ZjExZDA3ZA==
 SHA512:
   metadata.gz: !binary |-
-    ZjI5MTQzMDEzZTJhYjBiYWI1NjQyOTdhNjhkZTViZGRhZGVkYTVlMWE2MjFk
-    NzE2YzMzMmY1YTJhZGUwN2E3MzgzOWQ1M2EwZjFlZWZjMzQ4MTAwMjFmMWUx
-    NGIzYmVhYTAwNGRhZDUzZWQyMzkzMDIyOTJlM2YxZWY5OTM0OTg=
+    MzUxZmM0MzIyMjM1NWMxMThmNjk5NDE0NmUyYzNjMDk3NWNlODI0NWM3YWIw
+    NjVjMmMxOGZhODRjZDJiOTRmYjJkZjQ3YmJjZDc0YzgwZTBiNDRmY2ZkMjdk
+    MzU2MTBlYTZjM2EzODM1NTY4OGVkMGU3YzU5ZTA3MzdjMzA1ODc=
   data.tar.gz: !binary |-
-    NzY1MDRhMzUxYzgxNzRhYzAxZGYzOTk5OTJiMGUzMzU2ODUwMGMwNTM0MmJh
-    M2FhOWQxMmExNzYyMjM0NThiZDY4MDM0ZDVjOWIwMDI2NzFhMDQ4YzdhNmU1
-    ZjhiMzY1MGZkODJmY2E2MjlmNjAwNzkxMTdmNzlkMTljM2IxM2Y=
+    YjY1ZjM4Yzc5ZTJkZTU3Y2YyNDU1MjMxNjI0OGVlYzQ1NDA2ODA3NTgzY2Ex
+    Zjg1MGM5YTdiMDNkNWQwZTUxZGZlZDljNmEzYjYxZDEzYmM3NTJmYjQxZDVi
+    NGEyMGY2MGE4MzRmMzFjMzU3OWZjZWE0NDg0ZTQ1NGMxZmYwOWY=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.3.4
+-----
+* Fix to a bug introduced in 0.3.2
+
 0.3.3
 -----
 * Support user defined foreign keys on scoped models
@@ -6,7 +10,6 @@
 -----
 * correctly support nested models with has_many :through (thx dexion)
 * Support 'www.subdomain.example.com' (thx wtfiwtz)
-* Support user defined foreign keys on scoped models
 * Support setting `tenant_id` on scoped models if the `tenant_id` is nil (thx Matt Wilson)
 
 0.3.1

data/README.md

@@ -136,6 +136,16 @@ end
 
 * `config.require_tenant` when set to true will raise an ActsAsTenant::NoTenant error whenever a query is made without a tenant set.
 
+Sidekiq support
+---------------
+
+ActsAsTenant supports [Sidekiq](http://sidekiq.org/). A background processing library.
+Add the following code to your `config/initializer/acts_as_tenant.rb`:
+
+```ruby
+require 'acts_as_tenant/sidekiq'
+```
+
 Note on testing
 ---------------
 Whenever you set the `current_tenant` in your tests, either through integration tests or directly by calling `ActsAsTenant.current_tenant = some_tenant`, make sure to clean up the tenant after each test by calling `ActsAsTenant.current_tenant = nil`.

data/acts_as_tenant.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency('database_cleaner')
   s.add_development_dependency('sqlite3')
   s.add_development_dependency('debugger')
+
+  s.add_development_dependency('sidekiq')
 end

data/lib/acts_as_tenant/model_extensions.rb

@@ -42,16 +42,12 @@ module ActsAsTenant
 
     module ClassMethods
       def acts_as_tenant(tenant = :account, options = {})
-
         ActsAsTenant.set_tenant_klass(tenant)
 
-        unless options[:foreign_key].nil?
-          fkey = options[:foreign_key]
-          belongs_to tenant, :foreign_key => fkey
-        else
-          fkey = ActsAsTenant.fkey
-          belongs_to tenant
-        end
+        # Create the association
+        valid_options = options.slice(:foreign_key, :class_name)
+        fkey = valid_options[:foreign_key] || ActsAsTenant.fkey
+        belongs_to tenant, valid_options
 
         default_scope lambda {
           if ActsAsTenant.configuration.require_tenant && ActsAsTenant.current_tenant.nil?
@@ -95,12 +91,17 @@ module ActsAsTenant
         end
 
         define_method "#{ActsAsTenant.tenant_klass.to_s}" do
-          return ActsAsTenant.current_tenant if send(fkey) == ActsAsTenant.current_tenant.id
-          super()
+          if !ActsAsTenant.current_tenant.nil? && send(fkey) == ActsAsTenant.current_tenant.id
+            return ActsAsTenant.current_tenant
+          else
+            super()
+          end
         end
 
-        def scoped_by_tenant?
-          true
+        class << self
+          def scoped_by_tenant?
+            true
+          end
         end
       end
 

data/lib/acts_as_tenant/sidekiq.rb

@@ -0,0 +1,43 @@
+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)
+      msg['acts_as_tenant'] ||=
+        {
+            'class' => ActsAsTenant.current_tenant.class.name,
+            'id' => ActsAsTenant.current_tenant.id
+        } if ActsAsTenant.current_tenant.present?
+
+      yield
+    end
+  end
+
+  # Pull the tenant out and run the current thread with it.
+  class Server
+    def call(worker_class, msg, queue)
+      if msg.has_key?('acts_as_tenant')
+        account = msg['acts_as_tenant']['class'].constantize.find msg['acts_as_tenant']['id']
+        ActsAsTenant.with_tenant account do
+          yield
+        end
+      else
+        yield
+      end
+    end
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add ActsAsTenant::Sidekiq::Client
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add ActsAsTenant::Sidekiq::Client
+  end
+  config.server_middleware do |chain|
+    chain.add ActsAsTenant::Sidekiq::Server
+  end
+end

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/spec/acts_as_tenant/model_extensions_spec.rb

@@ -109,10 +109,14 @@ describe ActsAsTenant do
     it { ActsAsTenant.current_tenant == :foo }
   end
 
-  describe 'is_scoped_as_tenant should return the correct value' do
+  describe 'is_scoped_as_tenant should return the correct value when true' do
     it {Project.respond_to?(:scoped_by_tenant?).should == true}
   end
 
+  describe 'is_scoped_as_tenant should return the correct value when false' do
+    it {UnscopedModel.respond_to?(:scoped_by_tenant?).should == false}
+  end
+
   describe 'tenant_id should be immutable, if already set' do
     before do
       @account = Account.create!(:name => 'foo')
@@ -174,6 +178,24 @@ describe ActsAsTenant do
     it { @projects.count.should == 2 }
   end
 
+  describe 'Querying the tenant from a scoped model without a tenant set' do
+    before do
+      @project = Project.create!(:name => 'bar')
+    end
+
+    it { @project.account }
+  end
+
+  describe 'Querying the tenant from a scoped model with a tenant set' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project = @account.projects.create!(:name => 'foobar')
+      ActsAsTenant.current_tenant= @account1
+    end
+
+    it { @project.account }
+  end
+
   # Associations
   describe 'Associations should be correctly scoped by current tenant' do
     before do

data/spec/acts_as_tenant/sidekiq_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'sidekiq'
+require 'acts_as_tenant/sidekiq'
+
+describe ActsAsTenant::Sidekiq do
+  after { ActsAsTenant.current_tenant = nil }
+  let(:account) { Account.new(id: 1234) }
+  let(:message) { { 'acts_as_tenant' => { 'class' => 'Account', 'id' => 1234 } } }
+
+  describe ActsAsTenant::Sidekiq::Client do
+    subject { ActsAsTenant::Sidekiq::Client.new }
+
+    it 'saves tenant if present' do
+      ActsAsTenant.current_tenant = account
+
+      msg = {}
+      subject.call(nil, msg, nil) { }
+      expect(msg).to eq message
+    end
+
+    it 'does not set tenant if not present' do
+      expect(ActsAsTenant.current_tenant).to be_nil
+
+      msg = {}
+      subject.call(nil, msg, nil) { }
+      expect(msg).not_to eq message
+    end
+  end
+
+  describe ActsAsTenant::Sidekiq::Server do
+    subject { ActsAsTenant::Sidekiq::Server.new }
+
+    it 'restores tenant if tenant saved' do
+      expect(Account).to receive(:find).with(1234).once { account }
+
+      msg = message
+      subject.call(nil, msg, nil) do
+        expect(ActsAsTenant.current_tenant).to be_a_kind_of Account
+      end
+      expect(ActsAsTenant.current_tenant).to be_nil
+    end
+
+    it 'runs without tenant if no tenant saved' do
+      expect(Account).not_to receive(:find)
+
+      msg = {}
+      subject.call(nil, msg, nil) do
+        expect(ActsAsTenant.current_tenant).to be_nil
+      end
+      expect(ActsAsTenant.current_tenant).to be_nil
+    end
+  end
+
+  describe 'Sidekiq configuration' do
+    describe 'client configuration' do
+      it 'includes ActsAsTenant client' do
+        expect(Sidekiq.client_middleware.exists?(ActsAsTenant::Sidekiq::Client)).to be_true
+      end
+    end
+
+    # unable to test server configuration
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Erwin Matthijssen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -108,6 +108,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: Integrates multi-tenancy into a Rails application in a convenient and
   out-of-your way manner
 email:
@@ -128,10 +142,12 @@ files:
 - lib/acts_as_tenant/controller_extensions.rb
 - lib/acts_as_tenant/errors.rb
 - lib/acts_as_tenant/model_extensions.rb
+- lib/acts_as_tenant/sidekiq.rb
 - lib/acts_as_tenant/version.rb
 - rails/init.rb
 - spec/acts_as_tenant/configuration_spec.rb
 - 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_spec.rb
 - spec/database.yml
@@ -162,6 +178,7 @@ summary: Add multi-tenancy to Rails applications using a shared db strategy
 test_files:
 - spec/acts_as_tenant/configuration_spec.rb
 - 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_spec.rb
 - spec/database.yml