company_scope 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 736068a8a448f00bbc6691173a4a6fa89c086d41
-  data.tar.gz: ed3357ed9447e8018760334dad8b5aa0febe463c
+  metadata.gz: e23f0f1665e578c9287a203ebff02717f204dfe4
+  data.tar.gz: 83ba3007224cc8c97f5003263efc18e97ee7e111
 SHA512:
-  metadata.gz: 9b70cb263376ee416321a517c0f2c72653cee0cdfc59f4e3ffed8bb9e41454c38b8b3638b42e4c85695c797fe494b7db3eb0e58138cfdfcf398e470aebcda3fa
-  data.tar.gz: ad8b3a6fe5b67ba1a8e4a114ecf7106582b1fb3cc94ca945dcff594f39b67838c49e4c1957716b89728b324d5274cb0803ce0bf2ab46ebfc696b9896bcdea4a6
+  metadata.gz: e0835d33a937cb22c23d5fa021f644470050ffbd4f160e0096f28a018cb902ace3bb83b44cd55b5c615194d7302949a7d5760999f8fe4a8771fea1f0514035f5
+  data.tar.gz: d73b5642d099a30aec593f7b4c124b766312237b20c2cb4838fbea1d84bb6216fed20305d1e0d1f46ce706a11003ef7ec06aab0ed56997382bda1e562bbf7f28

data/README.md

@@ -41,15 +41,54 @@ There are three main steps in adding multi-tenancy/company to your app with comp
 ### Decide on a process of determining the company/account ###
 
 In the current version a helper_method called "current_company" is added to the Controller,
-where you add the method "company_setup". You have therefore two choices. Either you use your
-own process to set the instance of "Company" into "request.env".
+where you add the method "company_setup". You have therefore two choices. Either you use the
+company_scope gem process included Rack Middleware or your own process to set the instance
+of "Company" into "request.env".
+
+The included Rack Middleware can be inserted into the Rails Application stack in the config
+section of 'application.rb'.
+
+```ruby
+module YourRailsApp
+  class Application < Rails::Application
+    ...
+    # - add some Rack middleware to detect the company_name from the subdomain
+    config.middleware.insert_after Rack::Sendfile, Rack::MultiCompany, :company
+    ...
+  end
+end
+```
+
+The parameter in the example above needs to be a symbol of the model of your application
+that will act as the account i.e. company, tenant etc.
+
+The domain 'lvh.me' points to 127.0.0.1 and is therefore an ideal candidate for using with local development and subdomains since they will also all point to your localhost.
+
+[See here for info](http://stackoverflow.com/questions/12983072/rails-3-subdomain-testing-using-lvh-me)
+
+NB: The middleware currently uses a regex to ensure the domain name can only obtain the following:
+
+* A-Z
+* a-z
+* 0-9
+
+The middleware then uses the column called "class_name"_name i.e. "company_name"
+
+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 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
+object into each request!
 
 ```ruby
 def current_company
   request.env["COMPANY_ID"]
 end
 ```
-An example of this is to use "Rack Middleware" - see the method excerpt below:
+
+An example of how the gem does this using "Rack Middleware" - is in the excerpt below:
 
 ```ruby
 def call(env)
@@ -61,9 +100,6 @@ def call(env)
 end
 ```
 
-The next version of "company_scope", will have the Rack::Middleware call integrated and the
-ability to opt out of using it.
-
 Alternatively you can use your own process for determining the "current_company" and override this
 method in your application controller, providing you declare this after the "company_setup" method,
 which is detailed in the next step.
@@ -119,6 +155,9 @@ class Company < ActiveRecord::Base
 end
 ```
 
+The gem also injects
+
+
 * Each class to be scoped needs to have the "acts_as_company :account" method. The parameter ":account"
 defaults to :company if left blank. This can be any class/name of your choosing - the parameter needs
 to be a underscored version of the Class name as a symbol.

data/company_scope.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   #
   # - gem related ones
+  spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-given'
   spec.add_development_dependency 'rspec-collection_matchers'

data/lib/company_scope/guardian.rb

@@ -10,6 +10,9 @@ module CompanyScope
     module GuardianClassMethods
       #
       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
         #
         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.2"
+  VERSION = "0.1.3"
 end

data/lib/company_scope.rb

@@ -1,5 +1,6 @@
 require "request_store"
 #
+require File.dirname(__FILE__) + '/rack/multi_company'
 require File.dirname(__FILE__) + '/company_scope/base'
 require File.dirname(__FILE__) + '/company_scope/guardian'
 require File.dirname(__FILE__) + '/company_scope/control'

data/lib/rack/multi_company.rb

@@ -0,0 +1,44 @@
+#
+module Rack
+  #
+  class MultiCompany
+    #
+    attr_reader :company_class_name
+    #
+    def initialize(app, company_class)
+      @app = app
+      @company_class_name = company_class.to_s.split('_').collect!{ |w| w.capitalize }.join
+      @company = Module.const_get(@company_class_name).find_by_company_name('DEFAULT') if db_configured
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      first_sub_domain = request.host.split('.').first
+      # disallow any non alphabetic chars!
+      domain = first_sub_domain.upcase if first_sub_domain.match(/\A[a-zA-Z0-9]*\z/)
+      # insert the company into ENV - for the controller helper_method 'current_company'
+      env["COMPANY_ID"] = retrieve_company_from_subdomain(domain)
+      response = @app.call(env)
+      response
+    end
+
+    private
+
+    def db_configured
+      ActiveRecord::Base.connection.table_exists? Module.const_get(@company_class_name).table_name
+    end
+
+    def retrieve_company_from_subdomain(domain)
+      # - During test runs we load a company called 'DEFAULT' - it does not need to exist during initialisation
+      @company = Module.const_get(@company_class_name).find_by_company_name('DEFAULT') if Rails.env == 'test'
+
+      # - only ever load the company when the subdomain changes - also works when company is nil from an unsuccessful attempt..
+      @company = Module.const_get(@company_class_name).find_by_company_name(domain) unless ( domain == @company.to_s )
+
+      @company
+    rescue ActiveRecord::RecordNotFound => e
+      puts "\n\n Rack Error - Company not found: #{e.to_s}\n\n"
+      nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: company_scope
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Steve Forkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +190,7 @@ files:
 - lib/company_scope/guardian.rb
 - lib/company_scope/railtie.rb
 - lib/company_scope/version.rb
+- lib/rack/multi_company.rb
 homepage: http://github.com/netflakes/company_scope
 licenses: []
 metadata: {}