sublease 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1c458d5eb065f845834f0b68125d1a0806fd68e43c19243132f2719cf06570c
+  data.tar.gz: 1e731164736e3e56e8480041e70623294111de7cbd50d2a3c0d3137280096bf7
+SHA512:
+  metadata.gz: e0b40e28f0ab57015f85e91bb9f86fafefaee9f6f12463047f7a8c89f099ed62279b147c07ec6f860f2fa3cedeb99ca8727e9cf1a8a4cc8379a0981d4974f17e
+  data.tar.gz: bce2fd5028bc0af4d46c74c7bec501c7e13cf774777ef54aac7b014140943a16e6dd1fee734231ba8991cc50f77f80a127416bfe4f9517a4d3f8ed15d0aa2dd2

data/.gitignore

@@ -0,0 +1,62 @@
+*.gem
+*.rbc
+/.idea/
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+/tmp/
+log/*.log
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rspec failure tracking
+.rspec_status
+
+# byebug
+.byebug_history

data/.travis.yml

@@ -0,0 +1,68 @@
+addons:
+  apt:
+    packages:
+    - libsqlite3-dev
+    - sqlite3
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
+  - jruby
+
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails-5.0-stable
+  - gemfiles/Gemfile.rails-4.2-stable
+  - gemfiles/Gemfile.rails-4.1-stable
+  - gemfiles/Gemfile.jruby.rails-5.0-stable
+  - gemfiles/Gemfile.jruby.rails-4.2-stable
+  - gemfiles/Gemfile.jruby.rails-4.1-stable
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  exclude:
+    - rvm: 2.5.0
+      gemfile: gemfiles/Gemfile.rails-4.1-stable
+    - rvm: 2.5.0
+      gemfile: gemfiles/Gemfile.jruby.rails-4.1-stable
+    - rvm: 2.5.0
+      gemfile: gemfiles/Gemfile.jruby.rails-4.2-stable
+    - rvm: 2.5.0
+      gemfile: gemfiles/Gemfile.jruby.rails-5.0-stable
+    - rvm: 2.4.3
+      gemfile: gemfiles/Gemfile.rails-4.1-stable
+    - rvm: 2.4.3
+      gemfile: gemfiles/Gemfile.jruby.rails-4.1-stable
+    - rvm: 2.4.3
+      gemfile: gemfiles/Gemfile.jruby.rails-4.2-stable
+    - rvm: 2.4.3
+      gemfile: gemfiles/Gemfile.jruby.rails-5.0-stable
+    - rvm: 2.3.1
+      gemfile: gemfiles/Gemfile.jruby.rails-4.1-stable
+    - rvm: 2.3.1
+      gemfile: gemfiles/Gemfile.jruby.rails-4.2-stable
+    - rvm: 2.3.1
+      gemfile: gemfiles/Gemfile.jruby.rails-5.0-stable
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile.rails-4.1-stable
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile.jruby.rails-4.1-stable
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile.jruby.rails-4.2-stable
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile.jruby.rails-5.0-stable
+    - rvm: jruby
+      gemfile: gemfiles/Gemfile.rails-4.1-stable
+    - rvm: jruby
+      gemfile: gemfiles/Gemfile.rails-4.2-stable
+    - rvm: jruby
+      gemfile: gemfiles/Gemfile.rails-5.0-stable
+
+cache: bundler
+
+before_install:
+  - "rm ${BUNDLE_GEMFILE}.lock"
+  - gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.1.0
+-----
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bacrossland@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+
+ruby '>= 2.3.1'
+gem 'rails', '~> 5.1'
+gem 'rdoc'
+
+gem 'shoulda', group: [:development, :test]
+
+# Declare your gem's dependencies in sublease.gemspec
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+platforms :jruby do
+  gem 'pry', group: [:development, :test]
+  gem 'activerecord-jdbc-adapter'
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jruby-openssl'
+end
+
+platforms :ruby do
+  gem 'byebug', group: [:development, :test]
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    sublease (0.1.0)
+      rails (>= 4.1, < 6.0)
+      request_store (>= 1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.4)
+      actionpack (= 5.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    byebug (10.0.0)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    erubi (1.7.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.2.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails (5.1.4)
+      actioncable (= 5.1.4)
+      actionmailer (= 5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      activemodel (= 5.1.4)
+      activerecord (= 5.1.4)
+      activesupport (= 5.1.4)
+      bundler (>= 1.3.0)
+      railties (= 5.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.0)
+    rdoc (6.0.1)
+    request_store (1.4.0)
+      rack (>= 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-jdbc-adapter
+  activerecord-jdbcsqlite3-adapter
+  byebug
+  jruby-openssl
+  pry
+  rails (~> 5.1)
+  rdoc
+  shoulda
+  sqlite3
+  sublease!
+
+RUBY VERSION
+   ruby 2.5.0p0
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 bacrossland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,126 @@
+[![Build Status](https://travis-ci.org/bacrossland/sublease.svg?branch=master)](https://travis-ci.org/bacrossland/sublease)
+
+# Sublease
+
+Sublease is a tenanting engine for Rails 4.2 and greater applications using a shared database or schema. It's a Rails Engine 
+designed to be lightweight, simple to implement, and easy to use. Sublease works with existing as well as new applications.
+
+## Ruby Versions
+
+The following Ruby MRI and jRuby versions or greater are supported. Sublease was not built for or tested against other versions.
+
+Ruby >= 2.3.1
+jRuby >= 9.1.8.0
+
+## Rails Versions
+
+Sublease is built and tested to run using Rails version 4.2 or greater. While Sublease will run on Rails 4.1.16, it is not officially supported.
+
+## Installation
+
+1. On the model that you want tenanted, add the fields 'domain' and 'subdomain' through a migration. Both of these fields should be strings.
+
+1. Add this line to your application's Gemfile:
+
+        gem 'sublease'
+        
+    And then execute:
+        
+        $ bundle install
+        
+    Or install it yourself as:
+        
+        $ gem install sublease
+
+1. Finally, install the Sublease configuration file. This will add config/initializers/sublease.rb to you application.
+
+
+         $ rails generate sublease:install
+
+
+
+## Usage
+
+### Models
+
+Sublease works by create controlled has_many and belongs_to relationships between your tenant and any other model. The has_many_subleases 
+model should inherit from Sublease::Tenant and the belongs_to_subleases model should inherit from Sublease::Lodger. For 
+instance, if your application allowed for accounts to be created that would be shared by many users, your models would 
+look like this:
+ 
+    class Account < Sublease::Tenant
+      has_many_subleases(:users)
+    end
+    
+    class User < Sublease::Lodger
+      belongs_to_sublease(:account)
+    end
+
+The relationships work just like normal has_many and belongs_to ActiveRecord Relationships even taking the same options. 
+The difference is that the relationship is immutable and all dependencies on the relationship are overridden to call 
+the destroy method. This is to ensure that all callback are called on the model in the event of a delete or destroy method call.
+
+#### Scoping For Unique Records
+
+When adding unique record scope on your model, just do it as you would normally in ActiveRecord. Sublease is designed to 
+be simple and not replace things that Rails and ActiveRecord can do just fine. Using the example above, if you wanted to 
+scope a user's email to be unique per account, you might add a validator like so:
+
+    class User < Sublease::Lodger
+      belongs_to_sublease(:account)
+      
+      validates :email, presence: true, uniqueness: { case_sensitive: false, scope: :account_id }
+    end
+
+#### Moving Tenants
+
+In most cases, once a record is tenanted it stays with it's tenant. Sublease prevents switching tenants by default. 
+However, sometimes it is necessary to move a record from one tenant to another. To do this set the allow_sublease_change 
+property to true. Using the example above, we'll move user 1 from account 1 to account 2.
+
+    $ user = User.find 1
+    $ user.allow_sublease_change = true
+    $ user.account_id = 2
+    $ user.save
+
+### Controllers
+
+Sublease can change your tenant on the fly based on a requests subdomain, domain, or both. This switching is handled in 
+any controller you want by including Sublease::TenantSwitcher. In the example below, we include it into ApplicationController 
+which means that every controller in the application will check the request to make sure the correct tenant is set. 
+You might not want every request to a controller checking to set the tenant so make sure you only add it to the controllers
+that need it.
+
+    class ApplicationController < ActionController::Base
+      
+      include Sublease::TenantSwitcher
+    end
+
+The current tenant can be accessed from `Sublease.current_tenant`. Use this to set the tenant for new records or even to 
+show records belonging to that tenant.
+
+
+## Configuration
+
+Sublease can be configured to set a default subdomain and/or domain. It can also be configured to determine by which method 
+to switch the tenant: subdomain, domain, or subdomain and domain. See config/initializers/sublease.rb for all options.
+
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake test` to run the tests. 
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bacrossland/sublease. All pull requests should be against the 
+development branch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sublease project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sublease/blob/master/CODE_OF_CONDUCT.md).