company_scope 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e23f0f1665e578c9287a203ebff02717f204dfe4
-  data.tar.gz: 83ba3007224cc8c97f5003263efc18e97ee7e111
+  metadata.gz: 78d74779542e73e301d7e76aa127dd7fd66cf662
+  data.tar.gz: ef46ca27b38a368b41dd64d168194904a6a3b925
 SHA512:
-  metadata.gz: e0835d33a937cb22c23d5fa021f644470050ffbd4f160e0096f28a018cb902ace3bb83b44cd55b5c615194d7302949a7d5760999f8fe4a8771fea1f0514035f5
-  data.tar.gz: d73b5642d099a30aec593f7b4c124b766312237b20c2cb4838fbea1d84bb6216fed20305d1e0d1f46ce706a11003ef7ec06aab0ed56997382bda1e562bbf7f28
+  metadata.gz: 4bc0411012a43a13235521568587a663986d0952dce1899b8d80ee0231db6bcb3c613ba292e310eba024b93196cb4f9db2dccfdbdce8277b724b4f60b4b5db21
+  data.tar.gz: da8def416750d32902413b3a7dea14a1619efbe035129f34db0eb532f2e90823f93b76a4624bd787761dd57aa618d7118b5d681c37e4095866dbc656f1a0edab

data/README.md

@@ -68,15 +68,18 @@ The domain 'lvh.me' points to 127.0.0.1 and is therefore an ideal candidate for
 
 NB: The middleware currently uses a regex to ensure the domain name can only obtain the following:
 
-* A-Z
-* a-z
-* 0-9
+* A-Z, a-z, 0-9
 
-The middleware then uses the column called "class_name"_name i.e. "company_name"
+The middleware then uses the column called "company_name" to retrieve the company by the subdomain.
 
-No spaces or special characters are permitted and the name is also upcased - which needs to be handled
-by the model you use for scoping! This just keeps the name clean and simple.
-We would strongly recommend you to have a proper index on the company
+The name is also upcased - which needs to be handled by the model you use for scoping! This just keeps the name clean and simple. We would strongly recommend you to have a proper index on the company_name field.
+
+NB: If you are using a different model and don't like the idea of using the company_name field you can simply
+use the ruby alias method.
+
+```ruby
+alias_method :company_name, :your_account_name_method
+```
 
 The method below is included in the Controller stack (see notes further down), and retrieves
 the company object the request object. The Rack Middleware "Rack::MultiCompany" injects this
@@ -143,13 +146,17 @@ NB: The "CompanyScope" gem does not handle the process of adding migrations or c
 
 ### Scoping your models ###
 
-* The "acts_as_guardian" method injects the behaviour required for the scoping model.
+* The "acts_as_guardian" method injects the behaviour required for the scoping model. The model
+needs to have a string column that is called by the "model"_name i.e. 'company_name'. The gem
+adds a uniqueness validator. NB to ensure this will not cause race conditions at the DB level
+you really need to add an index for this column.
 
 ```ruby
 class Company < ActiveRecord::Base
 
   acts_as_guardian
 
+  # NB - the gem adds a uniqueness validator for the company_name field
   ...
 
 end
@@ -174,6 +181,11 @@ class User < ActiveRecord::Base
 end
 ```
 
+### The Gem is currently being used in Rails 4 and Rails-API apps and is tested against Postgres,
+using UUID based ID/primary keys ###
+
+### It should work with other databases such as MySQL without any issues ###
+
 
 ## Development
 

data/lib/company_scope/base.rb

@@ -15,7 +15,6 @@ module CompanyScope
 
         validates_presence_of "#{tenant.to_s}_id".to_sym #:company_id
 
-        #default_scope { where("#{self.table_name}.company_id = ?", Company.current_id) }
         default_scope { where("#{self.table_name}.#{tenant.to_s.underscore}_id = ?",
           Module.const_get("#{tenant.to_s.classify}").current_id) }
 
@@ -33,7 +32,6 @@ module CompanyScope
 
         before_destroy do |obj|
           # force company to be correct for current_user
-          #raise ::CompanyScope::Control::CompanyAccessViolationError unless obj.company_id == Company.current_id
           raise ::CompanyScope::Control::CompanyAccessViolationError unless
             obj.attributes["#{tenant.to_s.underscore}_id"] == Module.const_get("#{tenant.to_s.classify}").current_id
           true

data/lib/company_scope/guardian.rb

@@ -11,8 +11,8 @@ module CompanyScope
       #
       def acts_as_guardian
         #
-        #puts "\n\n\n Class Name: #{self.class.to_s.downcase}\n\n\n"
-        #validates_uniqueness_of "#{self.class.to_s.downcase}_name".to_sym #:company_name
+        # ensure the column that carries the company unique id/subdomain is unique
+        validates_uniqueness_of :company_name
         #
         def current_id=(id)
           RequestStore.store[:default_scope_company_id] = id

data/lib/company_scope/version.rb

@@ -1,3 +1,3 @@
 module CompanyScope
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: company_scope
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Steve Forkin