allinone 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e958af02e3b9ebd732fe56d160ea6dad911f868
+  data.tar.gz: c373d4e6ed392a2fd0dbb795659b00f894b7b69d
+SHA512:
+  metadata.gz: 85d5c3a8b22d3021b2982b13006eb5f9966d6ff874594a99e33ce4d4c42469875a16814b86b78dc7c17d16dac3eaaf3ff1e5db48243c20be653a20aeab176242
+  data.tar.gz: 26f85e7f826308167e9c5f624a08e28a14696aa3dc82867245b6a2ec37ba87d4dfc3418307a54755060b22a843d93bfe8344b0f90fe45ef6dbe0a21d4ca506e1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in allinone.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Unni
+
+MIT License
+
+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,60 @@
+# Allinone
+
+A gem that adds multitenancy to a Rails app. Install the gem and your app is already capable of handling multiple domains, with a `current_site` method to help you scope data for a particular site. See Usage section for more details. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'allinone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install allinone
+
+## Usage
+
+There is sample application available [here](https://github.com/Liberlabs/sample_multitenant_app).
+
+* Add a migration to create sites and domains tables in your app as shown [here](https://github.com/Liberlabs/sample_multitenant_app/blob/master/db/migrate/20150115080301_create_sites_and_domains.rb).
+
+* Add Site and Domain models in your app as shown [here](https://github.com/Liberlabs/sample_multitenant_app/blob/master/app/models/site.rb) and [here](https://github.com/Liberlabs/sample_multitenant_app/blob/master/app/models/domain.rb).
+
+* Run the migrations
+
+   ```rake db:migrate```
+
+* Add these 2 lines into your ApplicationController, towards the top.
+
+    ```
+    include Allinone::Core
+    act_as_allinone
+    ```
+
+* From the rails console, create a site and at least one domain.
+
+    ```
+       s = Site.create name: 'My Site'
+       s.domains.create name: 'localhost'
+     ```
+
+You can create more sites and domains if you like. You can also create multiple domains for the same site. Make sure you point the domains you create to localhost using entries in /etc/hosts (on development machines) or using DNS on production servers.
+
+* Start the rails server and access the site.
+
+   ```
+      rails s
+      In the browser, go to http://localhost:3000
+   ```
+
+`current_site` method will be accessible from your controllers and views. It will return the site object corresponding to the domain used to access the app. You can use current_site.id to scope the data for a particular site wherever you have to store/access data.
+
+## Invalid Domain Handing
+
+If an invalid domain (a domain that is not present in the domains table) is used to access the site, a 'Site not found' page will be displayed by default.
+
+This behaviour can be customized by overriding `site_not_found_handler` method in the application controller as shown [here] (https://github.com/Liberlabs/sample_multitenant_app/blob/master/app/controllers/application_controller.rb#L10).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/allinone.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'allinone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "allinone"
+  spec.version       = Allinone::VERSION
+  spec.authors       = ["Unni"]
+  spec.email         = ["unni.tallman@gmail.com"]
+  spec.summary       = %q{Makes a Rails app multitenant}
+  spec.description   = %q{Makes it possible to serve multiple sites from the same app}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "request_store"
+end

data/lib/allinone.rb

@@ -0,0 +1,16 @@
+require "allinone/version"
+require "allinone/core"
+require "allinone/site_selector"
+require "request_store"
+
+module Allinone
+  module Core
+    module ClassMethods
+      def act_as_allinone
+        prepend_before_filter :set_current_site
+        helper_method :current_site
+      end
+    end
+  end
+end
+

data/lib/allinone/core.rb

@@ -0,0 +1,27 @@
+module Allinone
+  module Core
+    def self.included(base)
+      base.extend Allinone::Core::ClassMethods
+    end
+
+    def current_site
+      RequestStore.store[:current_site]
+    end
+
+    def set_current_site
+      if Rails.env.test?
+        current_site = "" #set a default, passed from the app controller
+      else
+        current_site = Allinone::SiteSelector.new(request.host).fetch
+      end
+
+      site_not_found_handler unless current_site
+
+      RequestStore.store[:current_site] = current_site
+    end
+
+    def site_not_found_handler
+      render :text => 'Site not Found'
+    end
+  end
+end

data/lib/allinone/site_selector.rb

@@ -0,0 +1,36 @@
+module Allinone
+  class SiteSelector
+
+    def initialize(request_host)
+      @request_host = request_host.downcase
+      @@domains_map_last_build_at ||= Time.at(0).to_datetime.utc
+      setup_domains_map
+    end
+
+    def fetch
+      site_id = @@domains_map[@request_host]
+      Site.where(id: site_id).first
+    end
+
+    private
+    def setup_domains_map
+      if domains_table_last_updated_at > @@domains_map_last_build_at
+        build_domains_map
+      end
+    end
+
+    def build_domains_map
+      @@domains_map = domains_map
+      @@domains_map_last_build_at = 1.second.ago.to_datetime.utc
+    end
+
+    def domains_map
+      Hash[*Domain.select([:name,:site_id]).all.collect{|p| [p.name.downcase, p.site_id]}.flatten]
+    end
+
+    def domains_table_last_updated_at
+      Domain.order('updated_at').last.updated_at
+    end
+
+  end
+end

data/lib/allinone/version.rb

@@ -0,0 +1,3 @@
+module Allinone
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: allinone
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Unni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes it possible to serve multiple sites from the same app
+email:
+- unni.tallman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- allinone.gemspec
+- lib/allinone.rb
+- lib/allinone/core.rb
+- lib/allinone/site_selector.rb
+- lib/allinone/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Makes a Rails app multitenant
+test_files: []