multitenancy_tools 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 607a5090d739ade79846b7d136b1b9b08fa28980
+  data.tar.gz: 8672d9af120642bcfc42f0b2431553210bd62ac7
+SHA512:
+  metadata.gz: 142763f57d6f6f7b5356dc2d5160423ec312e54f59058036510d2267d741ec50431003733c49db5ac2af75be9d8c91c118a7e0bfe043b4c5ceb7070cadf06454
+  data.tar.gz: 8c699c5a0e5c89a793234c0fed79985ace9de9b67c465d40a176a04515a14a1df41ed36c3ee17937be7eb3c6426637fa6e349bc8ff878ddc7e23413de3eb7ae5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/database.yml
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Locaweb
+
+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,77 @@
+# MultitenancyTools
+
+This gem is a collection of tools that can be used to handle multitenant
+Ruby/Rails apps. The currently only supported database is PostgreSQL and there
+is no plan to support other databases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multitenancy_tools'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multitenancy_tools
+
+## Usage
+
+#### Dumping the structure of a PostgreSQL schema to a SQL file
+
+Please note that `pg_dump` must be on your `PATH`:
+
+```ruby
+dumper = MultitenancyTools::SchemaDumper.new('database name', 'schema name')
+dumper.dump_to('path/to/file.sql')
+```
+
+#### Dumping the content of a table to a SQL file
+
+Like `SchemaDumper`, this tool also requires `pg_dump` to be on the `PATH`:
+
+```ruby
+dumper = MultitenancyTools::TableDumper.new('database name', 'schema name', 'table name')
+dumper.dump_to('path/to/file.sql')
+```
+
+#### Creating a new PostgreSQL schema using a SQL file as template
+
+After using `SchemaDumper` to create the SQL template, you can use the following
+class to create a new schema using this file as template:
+
+```ruby
+creator = MultitenancyTools::SchemaCreator.new('schema name', ActiveRecord::Base.connection)
+creator.create_from_file('path/to/file.sql')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+edit `spec/database.yml` with your PostgreSQL database connection details (take
+a look at the example in `spec/database.yml.example`). **IMPORTANT:** this
+database will *be destroyed and recreated* on test execution.
+
+You can use `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/locaweb/multitenancy_tools.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'multitenancy_tools'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multitenancy_tools/dump_cleaner.rb

@@ -0,0 +1,23 @@
+module MultitenancyTools
+  # This class receives an SQL string and removes statements that should not
+  # be present on dumps generated by {SchemaDumper} and {TableDumper}.
+  class DumpCleaner
+    # @param [String] sql
+    def initialize(sql)
+      @sql = sql.dup
+    end
+
+    # Returns a new cleaned string.
+    #
+    # @return String
+    def clean
+      @sql.gsub!(/CREATE SCHEMA .*;\n/, '')
+      @sql.gsub!(/SET search_path .*;\n/, '')
+      @sql.gsub!(/SET statement_timeout .*;\n/, '')
+      @sql.gsub!(/SET lock_timeout .*;\n/, '')
+      @sql.gsub!(/^--(?:.*)\n+/, '')
+      @sql.gsub!(/\n+/, "\n")
+      @sql
+    end
+  end
+end

data/lib/multitenancy_tools/errors.rb

@@ -0,0 +1,3 @@
+module MultitenancyTools
+  class PgDumpError < StandardError; end
+end

data/lib/multitenancy_tools/schema_creator.rb

@@ -0,0 +1,29 @@
+module MultitenancyTools
+  # {SchemaCreator} can be used to create a schema on a PostgreSQL database
+  # using a SQL file as template. This template should be previously generated
+  # by {SchemaDumper}.
+  #
+  # @example
+  #   creator = MultitenancyTools::SchemaCreator.new('schema name', ActiveRecord::Base.connection)
+  #   creator.create_from_file('path/to/file.sql')
+  class SchemaCreator
+    # @param schema [String] schema name
+    # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+    def initialize(schema, connection)
+      @schema = schema
+      @connection = connection
+    end
+
+    # Creates the schema using a SQL file that was generated by {SchemaDumper}.
+    #
+    # @param file [String] path to a SQL file
+    def create_from_file(file)
+      quoted_schema_name = @connection.quote_table_name(@schema)
+
+      SchemaSwitcher.new(@schema, @connection).run do
+        @connection.create_schema(quoted_schema_name)
+        @connection.execute(File.read(file))
+      end
+    end
+  end
+end

data/lib/multitenancy_tools/schema_dumper.rb

@@ -0,0 +1,53 @@
+require 'open3'
+
+module MultitenancyTools
+  # {SchemaDumper} can be used to generate SQL dumps of the structure of a
+  # PostgreSQL schema. It requires pg_dump.
+  #
+  # The generated dump DOES NOT contain:
+  # * privilege statements (GRANT/REVOKE)
+  # * tablespace assigments
+  # * ownership information
+  # * any table data
+  #
+  # {SchemaDumper} is suitable to create SQL templates for {SchemaCreator}.
+  #
+  # @see http://www.postgresql.org/docs/9.3/static/app-pgdump.html
+  #      pg_dump
+  # @example
+  #   dumper = MultitenancyTools::SchemaDumper.new('my_db', 'my_schema')
+  #   dumper.dump_to('path/to/file.sql')
+  class SchemaDumper
+    # @param database [String] database name
+    # @param schema [String] schema name
+    def initialize(database, schema)
+      @database = database
+      @schema = schema
+    end
+
+    # Generates a dump an writes it into a file. Please see {IO.new} for open
+    # modes.
+    #
+    # @see http://ruby-doc.org/core-2.2.2/IO.html#method-c-new-label-Open+Mode
+    #      IO Open Modes
+    # @param file [String] file path
+    # @param mode [String] IO open mode
+    def dump_to(file, mode: 'w')
+      stdout, stderr, status = Open3.capture3(
+        'pg_dump',
+        '--schema', @schema,
+        '--schema-only',
+        '--no-privileges',
+        '--no-tablespaces',
+        '--no-owner',
+        '--dbname', @database
+      )
+
+      fail(PgDumpError, stderr) unless status.success?
+
+      File.open(file, mode) do |f|
+        f.write DumpCleaner.new(stdout).clean
+      end
+    end
+  end
+end

data/lib/multitenancy_tools/schema_switcher.rb

@@ -0,0 +1,22 @@
+module MultitenancyTools
+  # {SchemaSwitcher} can be used to switch between PostgreSQL schemas on a
+  # connection. It uses PostgreSQL search_path to achieve this functionality.
+  class SchemaSwitcher
+    # @param schema [String] schema name
+    # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+    def initialize(schema, connection)
+      @connection = connection
+      @schema = @connection.quote(schema)
+    end
+
+    # This sets the connection search_path to use only the current schema,
+    # yields the block and then change search_path back to its previous value.
+    def run(&block)
+      original_path = @connection.schema_search_path
+      @connection.schema_search_path = @schema
+      yield
+    ensure
+      @connection.schema_search_path = original_path
+    end
+  end
+end

data/lib/multitenancy_tools/table_dumper.rb

@@ -0,0 +1,55 @@
+require 'open3'
+
+module MultitenancyTools
+  # {TableDumper} can be used to generate SQL dumps of the structure and,
+  # unlike {SchemaDumper}, the data of a PostgreSQL table. It requires pg_dump.
+  #
+  # The generated dump DOES NOT contain:
+  # * privilege statements (GRANT/REVOKE)
+  # * tablespace assigments
+  # * ownership information
+  #
+  # The dump will use INSERTs instead of COPY statements.
+  #
+  # @see http://www.postgresql.org/docs/9.3/static/app-pgdump.html
+  #      pg_dump
+  # @example
+  #   dumper = MultitenancyTools::TableDumper.new('db name', 'schema name', 'table name')
+  #   dumper.dump_to('path/to/file.sql')
+  class TableDumper
+    # @param database [String] database name
+    # @param schema [String] schema name
+    # @param table [String] table name
+    def initialize(database, schema, table)
+      @database = database
+      @schema = schema
+      @table = table
+    end
+
+    # Generates a dump an writes it into a file. Please see {IO.new} for open
+    # modes.
+    #
+    # @see http://ruby-doc.org/core-2.2.2/IO.html#method-c-new-label-Open+Mode
+    #      IO Open Modes
+    # @param file [String] file path
+    # @param mode [String] IO open mode
+    def dump_to(file, mode: 'w')
+      stdout, stderr, status = Open3.capture3(
+        'pg_dump',
+        '--table', "#{@schema}.#{@table}",
+        '--data-only',
+        '--no-privileges',
+        '--no-tablespaces',
+        '--no-owner',
+        '--inserts',
+        '--dbname', @database
+      )
+
+      fail(PgDumpError, stderr) unless status.success?
+
+      File.open(file, mode) do |f|
+        f.write DumpCleaner.new(stdout).clean
+      end
+    end
+  end
+end

data/lib/multitenancy_tools/version.rb

@@ -0,0 +1,3 @@
+module MultitenancyTools
+  VERSION = '0.1.7'
+end

data/lib/multitenancy_tools.rb

@@ -0,0 +1,10 @@
+require 'multitenancy_tools/version'
+require 'multitenancy_tools/errors'
+require 'multitenancy_tools/dump_cleaner'
+require 'multitenancy_tools/schema_dumper'
+require 'multitenancy_tools/schema_creator'
+require 'multitenancy_tools/table_dumper'
+require 'multitenancy_tools/schema_switcher'
+
+module MultitenancyTools
+end

data/multitenancy_tools.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multitenancy_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'multitenancy_tools'
+  spec.version       = MultitenancyTools::VERSION
+  spec.authors       = ['Lenon Marcel', 'Rafael Timbó', 'Lucas Nogueira',
+                        'Rodolfo Liviero']
+  spec.email         = ['lenon.marcel@gmail.com', 'rafaeltimbosoares@gmail.com',
+                        'lukspn.27@gmail.com', 'rodolfoliviero@gmail.com']
+  spec.summary       = 'A collection of tools for multitenant Ruby/Rails apps'
+  spec.description   = 'A collection of tools for multitenant Ruby/Rails apps'
+  spec.homepage      = 'https://github.com/locaweb/multitenancy_tools'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
+  spec.add_development_dependency 'activerecord', '~> 4.2.0'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: multitenancy_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Lenon Marcel
+- Rafael Timbó
+- Lucas Nogueira
+- Rodolfo Liviero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: yard
+  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: A collection of tools for multitenant Ruby/Rails apps
+email:
+- lenon.marcel@gmail.com
+- rafaeltimbosoares@gmail.com
+- lukspn.27@gmail.com
+- rodolfoliviero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multitenancy_tools.rb
+- lib/multitenancy_tools/dump_cleaner.rb
+- lib/multitenancy_tools/errors.rb
+- lib/multitenancy_tools/schema_creator.rb
+- lib/multitenancy_tools/schema_dumper.rb
+- lib/multitenancy_tools/schema_switcher.rb
+- lib/multitenancy_tools/table_dumper.rb
+- lib/multitenancy_tools/version.rb
+- multitenancy_tools.gemspec
+homepage: https://github.com/locaweb/multitenancy_tools
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A collection of tools for multitenant Ruby/Rails apps
+test_files: []
+has_rdoc: