landagent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06e95d6ef6cba4b85f342c358cc6f85ff3dd3f19
+  data.tar.gz: 258c472ad6822088272009af10f87f06e191b578
+SHA512:
+  metadata.gz: d243be8d72905bb6e6855628b9a842cb788047ac3618d252d4a0c1718eea706a4044b92c44732f7645c37bda99dc1a44909a853aacf8874c0f6acee9be8504b6
+  data.tar.gz: 81af9fccaaf2010f180381e955bee532a2b242120bbfb0801df9b0644ec8b82d44cbe584788012102c526ac7e4c724ad3607c83db7e734c5766b3399cb94ab1d

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.3)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.15)
+    builder (3.2.2)
+    descendants_tracker (0.0.3)
+    docile (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.5.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.2.0)
+      atomic (>= 1.1.7, < 2)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Kym McInerney
+
+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,52 @@
+# Landagent
+
+Super Easy Postgres Multitenancy
+
+Using a subdomain mapping design pattern, Landagent takes advantage of PostgresQL SCHEMA_SEARCH_PATH.
+Landagent maps tenants with complete data segregation to the required data namespace.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'landagent'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install landagent
+
+Then Install and run the migrations:
+
+    $ rails g landagent:install
+    $ rake db:migrate
+
+## Usage
+
+### Development Environments
+Once you have Tenants set up, use something like lvh.me to map back to localhost
+
+		$ http://tenant1.lvh.me
+
+### Tenant migrations
+Landagent will set up Tenants, then because she is a good land agent will update each of the tenants with the required migrations with:
+
+    $ rake tenants:db:migrate
+
+## In the Pipeline
+
+1. Devise hooks
+2. Locale hooks
+3. Management layer
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "landagent"
+  gem.homepage = "http://github.com/holodigm/landagent"
+  gem.license = "MIT"
+  gem.summary = %Q{Super simple postgres multi-tenancy}
+  gem.description = %Q{Super simple postgres multi-tenancy}
+  gem.email = "kym@holodigm.com.au"
+  gem.authors = ["Kym McInerney"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "landagent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/landagent.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "landagent"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kym McInerney"]
+  s.date = "2014-03-04"
+  s.description = "Super simple postgres multi-tenancy"
+  s.email = "kym@holodigm.com.au"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "landagent.gemspec",
+    "lib/generators/landagent/install_generator.rb",
+    "lib/generators/landagent/templates/create_tenants.rb",
+    "lib/landagent.rb",
+    "lib/landagent/railtie.rb",
+    "lib/landagent/version.rb",
+    "lib/subdomain.rb",
+    "lib/tasks/tenants.rake",
+    "test/helper.rb",
+    "test/test_landagent.rb"
+  ]
+  s.homepage = "http://github.com/holodigm/landagent"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "Super simple postgres multi-tenancy"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/generators/landagent/install_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators/migration'
+
+module Landagent
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_tenants.rb", "db/migrate/create_tenants.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/landagent/templates/create_tenants.rb

@@ -0,0 +1,13 @@
+class CreateTenants < ActiveRecord::Migration
+  def change
+    create_table :tenants do |t|
+      t.string :subdomain
+      t.string :name
+      t.string :description
+      t.string :code
+      t.string :locale
+
+      t.timestamps
+    end
+  end
+end

data/lib/landagent/railtie.rb

@@ -0,0 +1,16 @@
+require "rails/railtie"
+module Landagent
+	class Railtie < Rails::Railtie
+
+		initializer "Landagent.handle_subdomains" do
+			ActiveSupport.on_load(:action_controller) do
+				Landagent.set_search_path(@tenant.id) if @tenant = Landagent::Tenant.find_by_subdomain(request.subdomain)
+			end
+		end
+
+		rake_tasks do
+			load "tasks/tenants.rake"
+		end
+
+	end
+end

data/lib/landagent/version.rb

@@ -0,0 +1,3 @@
+module Landagent
+  VERSION = "0.1.0"
+end

data/lib/landagent.rb

@@ -0,0 +1,59 @@
+require "landagent/version"
+require "landagent/railtie" if defined? Rails
+
+module Landagent
+  extend self
+
+  def default_search_path
+    @default_search_path ||= %{"$user", public}
+  end
+
+  def set_search_path(name, include_public = true)
+    path_parts = [name.to_s, ("public" if include_public)].compact
+    ActiveRecord::Base.connection.schema_search_path = path_parts.join(",")
+  end
+
+  def restore_default_search_path
+    ActiveRecord::Base.connection.schema_search_path = default_search_path
+  end
+
+  def create_schema(name)
+    sql = %{CREATE SCHEMA "#{name}"}
+    ActiveRecord::Base.connection.execute sql
+  end
+
+  def schemas
+    sql = "SELECT nspname FROM pg_namespace WHERE nspname !~ '^pg_.*'"
+    ActiveRecord::Base.connection.query(sql).flatten
+  end
+
+  class Tenant < ActiveRecord::Base
+
+    has_and_belongs_to_many :admins
+
+    validates :code, :subdomain, :name, :uniqueness => true
+
+    after_create :prepare_tenant
+
+    private
+
+    def prepare_tenant
+      create_schema
+      load_tables
+    end
+
+    def create_schema
+      Landagent.create_schema id unless Landagent.schemas.include? id
+    end
+
+    def load_tables
+      return if Rails.env.test?
+      Landagent.set_search_path id, false
+      load "#{Rails.root}/db/schema.rb"
+      ::Application::SHARED_TABLES.each { |name| connection.execute %{drop table "#{name}"} }
+      Landagent.restore_default_search_path
+    end
+
+  end
+
+end

data/lib/subdomain.rb

@@ -0,0 +1,5 @@
+class Subdomain
+  def self.matches?(request)
+    request.subdomain.present? && request.subdomain != "www"
+  end
+end

data/lib/tasks/tenants.rake

@@ -0,0 +1,16 @@
+namespace :tenants do
+  namespace :db do
+    desc "runs db:migrate on each tentant's private schema"
+    task :migrate => :environment do
+      verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+      ActiveRecord::Migration.verbose = verbose
+
+      Tenant.all.each do |tenant|
+        puts "Migrating tenant #{tenant.id} (#{tenant.subdomain})"
+        Landagent.set_search_path tenant.id, false
+        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+        ActiveRecord::Migrator.migrate("db/migrate/", version)
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'landagent'
+
+class Test::Unit::TestCase
+end

data/test/test_landagent.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestLandagent < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: landagent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kym McInerney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: Super simple postgres multi-tenancy
+email: kym@holodigm.com.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- landagent.gemspec
+- lib/generators/landagent/install_generator.rb
+- lib/generators/landagent/templates/create_tenants.rb
+- lib/landagent.rb
+- lib/landagent/railtie.rb
+- lib/landagent/version.rb
+- lib/subdomain.rb
+- lib/tasks/tenants.rake
+- test/helper.rb
+- test/test_landagent.rb
+homepage: http://github.com/holodigm/landagent
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Super simple postgres multi-tenancy
+test_files: []