tenanfy 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,57 @@
+= Tenanfy
+
+This is opinionated use of the awesome Apartment gem. 
+It's a plug and play ready solution for enabling multitenancy in rails applications.
+It comes with configurations and helpers I find usefull in my projects.
+
+Apartment is an awesome gem by itself, be sure to read more about it at https://github.com/bradrobertson/apartment
+
+
+=== How
+
+If you don't know what is tenantcy or how the apartment gem works, please read https://github.com/bradrobertson/apartment first.
+
+This gem creates 2 models, Tenanfy::[Tenant, Url].
+When you include the Tenanfy::Controller to your controller, it will automatically check for the correct Tenant for each request.
+This is done by looking for the request.host in the Tenanfy::Url table. The current tenant will be available in the `current_tenant` method.
+
+This is meant to be used and only tested using PostgreSQL.
+Every tenant will have it own schema in the database, and the apartment gem will use postgres' awesome `search_path` to look in the current_tenant schema first.
+You may have shared tables between your tenants, check the `config/initializers/apartment.rb`.
+
+=== Why
+
+If you don't need any of this customizations, I recommend you use the Apartment gem alone.
+I only made this because I had these requirements in more than one project, and maybe someone could find a good use of it too.
+
+=== Customizations
+
+==== Custom Views per tenant
+
+In my projects, each tenant usually have a different layout/theme. So the tenant model have a `theme` attribute.
+When this is setted, the `Tenanfy::Controller` will prepend the tenant theme in the view path, for example, if the theme is `blue`,
+the path `app/views/blue` will be prepended to the controller view_path. 
+
+==== Custom JS/CSS per tenant
+
+There are helpers to include the javascripts/stylesheets with the tenant theme (ex: app/assets/javascripts/blue/application.js).
+
+Example:
+
+  <%= tenant_stylesheet_link_tag('application.css') %>   # will include blue/application.css
+  <%= tenant_javascript_include_tag('application.js') %> # will include blue/application.js
+
+== Installation
+
+Gemfile:
+
+  gem 'tenanfy'
+
+Console:
+
+  rails g tenanfy:install
+  rake db:migrate
+
+= License
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tenanfy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/models/tenanfy/tenant.rb

@@ -0,0 +1,42 @@
+module Tenanfy
+  class Tenant < ActiveRecord::Base
+    attr_accessible :description, :keywords, :name, :theme, :configs
+    validates       :name, :theme, presence: true
+    validates       :theme, format: { with: /[a-z0-9_]+/ }
+    serialize       :configs, Hash
+
+    has_many :urls, inverse_of: :tenant
+
+    after_create  :build_schema
+    after_destroy :drop_schema
+
+    scope :filter_by_domain, ->(domain) { joins(:urls).where("tenanfy_urls.url" => domain).readonly(false) }
+
+    def self.find_by_domain(host)
+      self.filter_by_domain(host).first
+    end
+
+    def schema_name
+      "tenant_#{self.id}"
+    end
+
+    def switch_to_tenant
+      ::Apartment::Database.switch(self.schema_name)
+    end
+
+    def theme_path
+      "app/views/#{self.theme}"
+    end
+
+    private
+
+    def build_schema
+      ::Apartment::Database.create(self.schema_name)
+    end
+
+    def drop_schema
+      ::Apartment::Database.drop(self.schema_name)
+    end
+
+  end
+end

data/app/models/tenanfy/url.rb

@@ -0,0 +1,8 @@
+module Tenanfy
+  class Url < ActiveRecord::Base
+    belongs_to :tenant, inverse_of: :urls
+    attr_accessible :url
+    validates :url, presence: true, uniqueness: true
+    validates :tenant_id, presence: true
+  end
+end

data/db/migrate/20130128025640_create_tenanfy_tenants.rb

@@ -0,0 +1,12 @@
+class CreateTenanfyTenants < ActiveRecord::Migration
+  def change
+    create_table :tenanfy_tenants do |t|
+      t.string :name  , null: false
+      t.string :theme , null: false
+      t.string :description
+      t.string :keywords
+      t.text   :configs
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130128025755_create_tenanfy_urls.rb

@@ -0,0 +1,11 @@
+class CreateTenanfyUrls < ActiveRecord::Migration
+  def change
+    create_table :tenanfy_urls do |t|
+      t.string     :url   , null: false
+      t.references :tenant, null: false
+      t.timestamps
+    end
+    add_index :tenanfy_urls, :tenant_id
+    add_index :tenanfy_urls, :url, unique: true
+  end
+end

data/lib/generators/tenanfy/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/tenanfy/install/install_generator.rb

@@ -0,0 +1,24 @@
+class Tenanfy::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def run_migrations
+    rake("tenanfy:install:migrations")
+  end
+
+  def copy_initializer
+    template "initializer.rb", "config/initializers/apartment.rb"
+  end
+
+  def setup_middleware
+    inject_into_class "config/application.rb", 'Application' do
+      "\n   require 'tenanfy/apartment/elevator'\n" +
+      "   config.middleware.use 'Apartment::Elevators::Generic', Tenanfy::Apartment::Elevator.new\n"
+    end
+  end
+
+  def setup_application_controller
+    inject_into_class "app/controllers/application_controller.rb", 'ApplicationController' do
+      "\n  include Tenanfy::Controller\n"
+    end
+  end
+end

data/lib/generators/tenanfy/install/templates/initializer.rb

@@ -0,0 +1,3 @@
+Apartment.configure do |config|
+  config.excluded_models = ["Tenanfy::Tenant", "Tenanfy::Url"]
+end

data/lib/tasks/tenantfy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tenanfy do
+#   # Task goes here
+# end

data/lib/tenanfy/apartment/elevator.rb

@@ -0,0 +1,14 @@
+module Tenanfy
+  module Apartment
+    class Elevator 
+      def call(request)
+        tenant = Tenant.find_by_domain(request.host)
+        if tenant
+          tenant.schema_name
+        else
+          "public"
+        end
+      end
+    end
+  end
+end

data/lib/tenanfy/configurations/keys.rb

@@ -0,0 +1,21 @@
+module Tenanfy
+  module Configurations
+    # These are constant key names for the tenant configurations.
+    # The values for each of these keys must be set (if used) in
+    # Tenanfy::Tenant.configurations
+    module Keys
+      # Holds what kind of comment the tenant uses
+      COMMENT_TYPE = 'comment_type'
+
+      # FACEBOOK configuration 
+      FACEBOOK_APP_ID     = 'facebook_app_id'
+      FACEBOOK_APP_SECRET = 'facebook_app_secret'
+
+      # DISQUS configuration
+      DISQUS_SHORT_NAME = 'disqus_name'
+
+      # LIVEFYRE configuration
+      LIVEFYRE_SITE_ID = 'livefyre_id'
+    end
+  end
+end

data/lib/tenanfy/configurations/values.rb

@@ -0,0 +1,13 @@
+module Tenanfy
+  module Configurations
+    # These are constant key names for the tenant configurations.
+    # The values for each of these keys must be set (if used) in
+    # Tenanfy::Tenant.configurations
+    module Values
+      # Comment possible values
+      COMMENT_FACEBOOK = 'facebook'
+      COMMENT_DISQUS   = 'disqus'
+      COMMENT_LIVEFYRE = 'livefyre'
+    end
+  end
+end

data/lib/tenanfy/controller.rb

@@ -0,0 +1,48 @@
+module Tenanfy
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      around_filter :setup_tenant_thread
+      helper_method :current_tenant, :current_tenant_theme, :current_tenant_name
+    end
+
+    private
+
+    # Setups the current_tenant in the Thread.current
+    # so it can be accessed by different contexts in the
+    # same request
+    #
+    # ensures that it will be set to nil after the request
+    # this way there isn't any dead tenant hanging
+    #
+    def setup_tenant_thread
+      Thread.current[:tenant] = current_tenant
+      prepend_tenant_theme
+      yield
+    ensure
+      Thread.current[:tenant] = nil
+    end
+
+    # Adds the tenant theme in the controller view path
+    def prepend_tenant_theme
+      prepend_view_path current_tenant.theme_path if current_tenant && current_tenant.theme_path
+    end
+
+    # Returns the current tenant for this request
+    def current_tenant
+      @current_tenant ||= Tenant.find_by_domain(request.host)
+    end
+
+    # Returns the current tenant theme
+    def current_tenant_theme
+      current_tenant ? current_tenant.theme : ""
+    end
+
+    # Returns the current tenant name
+    def current_tenant_name
+      current_tenant ? current_tenant.name : "Global"
+    end
+
+  end
+end

data/lib/tenanfy/engine.rb

@@ -0,0 +1,9 @@
+module Tenanfy
+  class Engine < ::Rails::Engine
+    isolate_namespace Tenanfy
+
+    initializer "tenanfy.include_helpers" do |app|
+      ActionController::Base.helper ::Tenanfy::Helpers
+    end
+  end
+end

data/lib/tenanfy/helpers.rb

@@ -0,0 +1,41 @@
+module Tenanfy
+  module Helpers
+    #extend ActiveSupport::Concern
+
+    # Appends the tenant theme to the source if not a full-path
+    # or url
+    def tenant_stylesheet_link_tag(*sources)
+      new_sources = append_tenant_theme_to_assets(*sources)
+      stylesheet_link_tag(*new_sources)
+    end
+
+    # Appends the tenant theme to the source if not a full-path
+    # or url
+    def tenant_javascript_include_tag(*sources)
+      new_sources = append_tenant_theme_to_assets(*sources)
+      javascript_include_tag(*new_sources)
+    end
+
+    private
+
+    # updates the asset list with tenant theme where it's
+    # necessary
+    #
+    def append_tenant_theme_to_assets(*assets)
+      assets.map! do |asset|
+        should_add_tenant_theme_to_asset?(asset) && current_tenant ? "#{current_tenant.theme}/#{asset}" : asset
+      end
+      assets
+    end
+
+    # Returns false if the asset is a full-path or url
+    # true for everything else
+    def should_add_tenant_theme_to_asset?(asset)
+      if asset.is_a? String
+        return true if (! asset.match /^http:\/\//) && (! asset.match /^\//)
+      end
+      false
+    end
+
+  end
+end

data/lib/tenanfy/version.rb

@@ -0,0 +1,3 @@
+module Tenanfy
+  VERSION = "0.0.1"
+end

data/lib/tenanfy.rb

@@ -0,0 +1,11 @@
+require "apartment"
+
+module Tenanfy
+  require 'tenanfy/configurations/keys'
+  require 'tenanfy/configurations/values'
+  require 'tenanfy/apartment/elevator'
+  require 'tenanfy/controller'
+  require 'tenanfy/helpers'
+end
+
+require "tenanfy/engine"

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: tenanfy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tiago Scolari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: apartment
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Offers a opinated use of the Apartment gem.
+email:
+- tscolari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/tenanfy/tenant.rb
+- app/models/tenanfy/url.rb
+- db/migrate/20130128025640_create_tenanfy_tenants.rb
+- db/migrate/20130128025755_create_tenanfy_urls.rb
+- lib/generators/tenanfy/install/install_generator.rb
+- lib/generators/tenanfy/install/templates/initializer.rb
+- lib/generators/tenanfy/install/USAGE
+- lib/tasks/tenantfy_tasks.rake
+- lib/tenanfy/apartment/elevator.rb
+- lib/tenanfy/configurations/keys.rb
+- lib/tenanfy/configurations/values.rb
+- lib/tenanfy/controller.rb
+- lib/tenanfy/engine.rb
+- lib/tenanfy/helpers.rb
+- lib/tenanfy/version.rb
+- lib/tenanfy.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/tscolari/tenanfy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 639758106311764618
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 639758106311764618
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Mult-Tenant drop and play solution.
+test_files: []