milia 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79734aeaf103cdc61a4ebce073a840cac3e359ab
-  data.tar.gz: d521ade804dda61d0743cfd7f9427bdace6c226f
+  metadata.gz: b17d04a8171ccbdc169aa06e5f1d28c5e850c3e2
+  data.tar.gz: c5d93e06cbd053b83c4704ba0fabcd6b1c809c7e
 SHA512:
-  metadata.gz: 1fe1f3293e03e3af8f1689f51bc860a2d0a8592e51735c762db25b1b3a8e4ee547dc16bd26ec0bbbbbc4749c608fc62c651e513ac2c4b3adf3b8d7f4fe572030
-  data.tar.gz: 806f8f3bf695d6f2cd9ecde69af8f5e4099d6791b09432a96001344a9ccb672e879748ed2f8a04939ba7b6e7fa2e93626c77db182dc51c7cfa2d682d9e893b07
+  metadata.gz: 76db8065475838404861cada72daaad22cd582c3233ff455ce411a3daf512de8bad59c71788684db5e6cb524758af7620d15013c7efe4df502b62811bc00b81a
+  data.tar.gz: 1fa75ebac26ede1a0f394e3fac189e20753af27bcd44d6247377856d1ab1838c4a6f10be693d091ac7a3698fb95cd80cad791a544fc13f0652e434313e424889

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+gemfile: test/Gemfile
+before_install: cd test
+script: bundle exec rake

data/README.md

@@ -1,29 +1,38 @@
-# milia
+# milia 
+[![Build Status](https://travis-ci.org/jekuno/milia.svg?branch=master)](https://travis-ci.org/jekuno/milia)
 
-Milia is a multi-tenanting gem for hosted Rails 4.2.x applications which use
-the devise gem for user authentication and registrations. Milia comes with 
-tailoring for common use cases needing multi-tenanting with user authentication.
+Milia is a multi-tenanting gem for Ruby on Rails applications.
+
+* Milia is a solid choice for (SaaS) applications which are used by more than one tenant (i.e. companies or organizations) and is tailored for common use cases of multi-tenanted applications.
+* Milia allows to save the data of all tenants in the same database and enforces row based separation of the tenant data.
+* Milia uses the devise gem for user authentication and registration.
+
+You are viewing the documentation of the milia branch for **Rails 4.2.x** applications.
+Milia also supports **Rails 5.x**. Please consider the according [README](../rails5-support/README.md) of the [Rails5 branch](../../tree/rails5-support/).
 
 ## Basic concepts for the milia multi-tenanting gem
 
-### multi-tenanting highlights
-
-* should be transparent to the main application code
-* should be symbiotic with user authentication
-* should raise exceptions upon attempted illegal access
-* should force tenanting (not allow sloppy access to all tenant records)
-* should allow application flexibility upon new tenant sign-up, 
-  usage of eula information, etc
-* should be as non-invasive (as possible) to Rails code
-* row-based tenanting is used
-* default_scope is used to enforce tenanting
-
-The author used schema-based tenanting in the past but found it deficient for
-the following reasons: most DBMS are optimized to handle enormous number of
-rows but not an enormous number of schema (tables). Schema-based tenancy took a
-performance hit, was seriously time-consuming to backup and restore, was invasive
-into the Rails code structure (monkey patching), was complex to implement, and
-couldn't use Rails migration tools as-is.
+### Milia highlights
+
+* Transparent to the main application code
+* Symbiotic with user authentication
+* Raises exceptions upon attempted illegal access
+* Enforces tenanting (not allow sloppy access to all tenant records)
+* Allows application flexibility upon new tenant sign-up, usage of eula information, etc
+* As non-invasive (as possible) to Rails code
+* Uses row-based tenanting
+* Uses default_scope to enforce tenanting
+
+### Row based vs. schema based tenanting
+* Milia uses row based tenanting.
+* The author used schema-based tenanting in the past but found it deficient for the following reasons. Schema-based tenancy
+  * is not what DBMS are optimized for (most DBMS are optimized to handle enormous number of rows but not an enormous number of schema (tables)),
+  * took a performance hit,
+  * was seriously time-consuming to backup and restore,
+  * was invasive into the Rails code structure (monkey patching),
+  * was complex to implement, and
+  * couldn't use Rails migration tools as-is.
+* Heroku also [strongly recommends against](https://devcenter.heroku.com/articles/heroku-postgresql#multiple-schemas) using schema based tenanting.
 
 ### tenants/users vs organizations/members
 
@@ -93,7 +102,7 @@ Further details about this process can be found via the sources listed below:
   this sample on github, however, will always be for the latest release or latest beta (whichever is most recent).
 * find it at: https://github.com/dsaronin/sample-milia-app
 
-### Available docmentation resources for milia
+### Available documentation resources for milia
 
 * doc/sample.sh -- this document will ALWAYS be the most recent
     (for example in the edge branch: "newdev")
@@ -819,13 +828,13 @@ tenanted areas even if no records are returned. This is a potential security
 breach. Further details can be found in various discussions about the
 behavior of databases such as POSTGRES.
 
-The milia workaround is to add an additional .where( where_restrict_tenants(klass1, klass2,...))
+The milia workaround is to add an additional .where( where_restrict_tenant(klass1, klass2,...))
 for each of the subordinate models in the join.
 
-### usage of where_restrict_tenants
+### usage of where_restrict_tenant
 
 ```ruby
-    Comment.joins(stuff).where( where_restrict_tenants(Post, Author) ).all
+    Comment.joins(stuff).where( where_restrict_tenant(Post, Author) ).all
 ```
 
 ## no tenant authorization required controller actions: root_path

data/lib/milia/control.rb

@@ -99,11 +99,10 @@ module Milia
 # -- sets current tenant
 # ------------------------------------------------------------------------------
   def authenticate_tenant!()
-    unless authenticate_user!
+    unless authenticate_user!(force: true)
       email = ( params.nil? || params[:user].nil?  ?  "<email missing>"  : params[:user][:email] )
       flash[:error] = "cannot sign in as #{email}; check email/password"
       logger.info("MILIA >>>>> [failed auth user] ") unless logger.nil?
-      return false  # abort the before_filter chain
     end
 
     trace_tenanting( "authenticate_tenant!" )

data/lib/milia/version.rb

@@ -1,3 +1,3 @@
 module Milia
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/test/Gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: ../../milia
   specs:
-    milia (1.2.0)
+    milia (1.2.1)
       devise (~> 3.4)
       rails (~> 4.2)
 

data/test/config/application.rb

@@ -14,10 +14,10 @@ module Miliatest
     # uncomment to ensure a common layout for devise forms
 
     config.to_prepare do   # Devise
-    Devise::SessionsController.layout "sign"
-    Devise::RegistrationsController.layout "sign"
-    Devise::ConfirmationsController.layout "sign"
-    Devise::PasswordsController.layout "sign"
+      Devise::SessionsController.layout "sign"
+      Devise::RegistrationsController.layout "sign"
+      Devise::ConfirmationsController.layout "sign"
+      Devise::PasswordsController.layout "sign"
     end   # Devise
 
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.

data/test/config/environments/production.rb

@@ -1,6 +1,6 @@
 Miliatest::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
-   
+
   # devise says to define default url
   config.action_mailer.default_url_options = { :host => 'secure.simple-milia-app.com', :protocol => 'https' }
 
@@ -35,7 +35,7 @@ Miliatest::Application.configure do
   # config.action_dispatch.rack_cache = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this).
-  config.serve_static_assets = false
+  config.serve_static_files = false
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier

data/test/config/environments/test.rb

@@ -1,6 +1,6 @@
 Miliatest::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
-   
+
   # devise says to define default url
   config.action_mailer.default_url_options = { :host => "www.example.com" }
 
@@ -17,7 +17,7 @@ Miliatest::Application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files  = true
   config.static_cache_control = "public, max-age=3600"
 
   # Show full error reports and disable caching.
@@ -34,7 +34,7 @@ Miliatest::Application.configure do
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
-  
+
   config.active_record.logger = nil
 
   # Print deprecation notices to the stderr.

data/test/test/controllers/home_controller_test.rb

@@ -1,7 +1,7 @@
 require 'ctlr_test_helper'
 
 class HomeControllerTest < ActionController::TestCase
-    
+
   context 'home ctlr' do
     setup do
       Tenant.set_current_tenant( tenants( :tenant_1 ).id )
@@ -20,11 +20,10 @@ class HomeControllerTest < ActionController::TestCase
   end  # should do
 
   should 'not get show without login' do
-    assert_raise(ArgumentError, 'uncaught throw :warden'){
-      get :show
-    }
-    assert_response :success
-  end  # should do
+    get :show
+    # redirects to sign in page
+    assert_redirected_to new_user_session_path
+  end # should do
 
   should 'reset tenant' do
     assert Tenant.current_tenant_id
@@ -70,9 +69,9 @@ class HomeControllerTest < ActionController::TestCase
 
   should 'prep signup view' do
     assert_nil  @controller.instance_eval( "@tenant" )
-    @controller.prep_signup_view( 
-        { name: 'Mangoland' }, 
-        {email: 'billybob@bob.com', password: 'monkeymocha', password_confirmation: 'monkeymocha'} 
+    @controller.prep_signup_view(
+        { name: 'Mangoland' },
+        {email: 'billybob@bob.com', password: 'monkeymocha', password_confirmation: 'monkeymocha'}
     )
     assert_equal 'Mangoland', @controller.instance_eval( "@tenant" ).name
   end  # should do

data/test/test/ctlr_test_helper.rb

@@ -2,7 +2,10 @@ require 'test_helper'
 
 class ActiveSupport::TestCase
 
+end
+
+
+class ActionController::TestCase
   include Devise::TestHelpers
 
 end #  class
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: milia
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - daudi amani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -121,6 +121,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".slugignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md