penthouse 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 190533a0da2c8d16b425d2ffa4bde288e19a97da
-  data.tar.gz: 69a6e1b680e9525c513e386d427de26f5b6667fd
+  metadata.gz: 5fdce337d0e5a5c6662f7d2fbfd2a3f14877fc7a
+  data.tar.gz: ca32b3019f2bdf8b105f962c8f1f40767a86cf95
 SHA512:
-  metadata.gz: 46a2dce89a0a2577808f9bc325766a010b19f58f0fa566c414a9aaa5ba16352e08ae84f25ad0b5d8b55f689b2119ed15156654fa22203527ab5c0f58e2da130f
-  data.tar.gz: 0a502681b521e29b05fbdb96b78b5b86821ea35924a05693557566b95ae127ede976bd866efa8e2c7df977b47ff99823aca7720a9de0eaf915c256eb92d6fb6e
+  metadata.gz: fbc0c2e3951d8acd63ffe18c6a2dd2d3ea4a32b508001767ce64cfbff1c30e8d63e913f0401688c157bf88b95f0c69a977a735c4cc6f1c8c3d2433283bf644f5
+  data.tar.gz: 2eab6ab62ea17238ab22999b6c7a0f6f8bc7228583ee06f29bef91e9e3a2676a42fc25b681d649f5b737c4b141826ca75562e07a40b2575331151be4e76d97b1

data/lib/penthouse/configuration.rb

@@ -12,17 +12,25 @@
 
 module Penthouse
   class Configuration
-    attr_accessor :router, :runner, :migrate_tenants, :tenant_identifiers
+    attr_accessor :router, :runner, :migrate_tenants, :db_schema_file, :tenant_identifiers
 
     # @param router [Penthouse::Routers::BaseRouter] the default router for your application to use
     # @param runner [Penthouse::Runners::BaseRunner] the default runner for your application to use
     # @param migrate_tenants [Boolean] whether you want Penthouse to automatically migrate all tenants
+    # @param db_schema_file [String] a path to your schema file (typically `db/schema.rb` or `db/structure.sql` in Rails)
     # @param tenant_identifiers [Proc] some code which must return an array of tenant identifiers (strings/symbols)
-    def initialize(router: nil, runner: nil, migrate_tenants: false, tenant_identifiers: -> { raise NotImplementedError })
+    def initialize(router: nil, runner: nil, migrate_tenants: false, db_schema_file: nil, tenant_identifiers: -> { raise NotImplementedError })
       self.router = router
       self.runner = runner
       self.migrate_tenants = migrate_tenants
+      self.db_schema_file = db_schema_file
       self.tenant_identifiers = tenant_identifiers
+
+      if migrate_tenants? && !db_schema_file
+        raise ArgumentError, "If you want to migrate tenants, we need a path to a DB schema file"
+      elsif migrate_tenants? && !File.exist?(db_schema_file)
+        raise ArgumentError, "#{db_schema_file} is not readable"
+      end
     end
 
     # @return [Boolean] whether or not Penthouse should automatically migrate all tenants

data/lib/penthouse/routers/base_router.rb

@@ -11,7 +11,7 @@ module Penthouse
   module Routers
     class BaseRouter
 
-      # Typically used by the App to return a tenant that can be switched to
+      # @abstract typically used by the App to receive a request and return a tenant that can be switched to
       # @param request [Rack::Request] The request from the Rack app, used to determine the tenant
       # @return [String, Symbol] A tenant identifier
       # @raise [Penthouse::TenantNotFound] if the tenant cannot be found/switched to

data/lib/penthouse/runners/base_runner.rb

@@ -22,6 +22,7 @@ module Penthouse
         end
       end
 
+      # @abstract returns the tenant object
       # @param tenant_identifier [String, Symbol] The identifier for the tenant
       # @return [Penthouse::Tenants::BaseTenant] An instance of a tenant
       # @raise [Penthouse::TenantNotFound] if the tenant cannot be switched to

data/lib/penthouse/tenants/base_tenant.rb

@@ -18,12 +18,22 @@ module Penthouse
         self.identifier = identifier
       end
 
-      # placeholder for the relevant tenant-switching code
+      # @abstract placeholder for the relevant tenant-switching code
       # @param block [Block] The code to execute within the tenant
       # @yield [BaseTenant] The current tenant instance
       def call(&block)
         raise NotImplementedError
       end
+
+      # @abstract creates the tenant data store
+      def create(*)
+        raise NotImplementedError
+      end
+
+      # @abstract deletes the tenant data store
+      def delete(*)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/penthouse/tenants/migratable.rb

@@ -0,0 +1,31 @@
+#
+# This class provides an abstract for the tenant interface. Whilst any Proc
+# could be used, it's safest for people to sub-class to ensure that any future
+# interface changes are catered for.
+#
+# A tenant class's responsibility is to receive a block, around which it should
+# handle switching to the given tenant's configuration, ensuring that if an
+# exception occurs, the configuration is reset back to the global configuration.
+#
+module Penthouse
+  module Tenants
+    module Migratable
+
+      # @param db_schema_file [String] a path to the DB schema file to load, defaults to Penthouse.configuration.db_schema_file
+      def migrate(db_schema_file: Penthouse.configuration.db_schema_file)
+        if File.exist?(db_schema_file)
+          # turn off logging schemas
+          ActiveRecord::Schema.verbose = false
+          # run the migrations within this schema
+          call do
+            puts ActiveRecord::Base.connection.schema_search_path
+            load(db_schema_file)
+          end
+        else
+          raise ArgumentError, "#{db_schema_file} does not exist"
+        end
+      end
+
+    end
+  end
+end

data/lib/penthouse/tenants/octopus_schema_tenant.rb

@@ -23,6 +23,24 @@ module Penthouse
           super
         end
       end
+
+      # creates the tenant schema within the master shard
+      # @see Penthouse::Tenants::SchemaTenant#create
+      def create(*)
+        call { super }
+      end
+
+      # drops the tenant schema within the master shard
+      # @see Penthouse::Tenants::SchemaTenant#delete
+      def delete(*)
+        call { super }
+      end
+
+      # returns whether or not the schema exists
+      # @see Penthouse::Tenants::SchemaTenant#exists?
+      def exists?(*)
+        call { super }
+      end
     end
   end
 end

data/lib/penthouse/tenants/octopus_shard_tenant.rb

@@ -8,10 +8,13 @@
 
 require_relative './base_tenant'
 require 'octopus'
+require_relative './migratable'
 
 module Penthouse
   module Tenants
     class OctopusShardTenant < BaseTenant
+      include Migratable
+
       attr_accessor :shard
       private :shard=
 

data/lib/penthouse/tenants/schema_tenant.rb

@@ -6,40 +6,69 @@
 #
 
 require_relative './base_tenant'
+require_relative './migratable'
 
 module Penthouse
   module Tenants
     class SchemaTenant < BaseTenant
+      include Migratable
+
       attr_accessor :tenant_schema, :persistent_schemas, :default_schema
       private :tenant_schema=, :persistent_schemas=, :default_schema=
 
       # @param identifier [String, Symbol] An identifier for the tenant
       # @param tenant_schema [String] your tenant's schema name in Postgres
-      # @param tenant_schema [String] your tenant's schema name in Postgres
       # @param persistent_schemas [Array<String>] The schemas you always want in the search path
       # @param default_schema [String] The global schema name, usually 'public'
       def initialize(identifier, tenant_schema:, persistent_schemas: ["shared_extensions"], default_schema: "public")
         super(identifier)
-        self.tenant_schema = tenant_schema
-        self.persistent_schemas = Array(persistent_schemas).flatten
-        self.default_schema = default_schema
+        self.tenant_schema = tenant_schema.freeze
+        self.persistent_schemas = Array(persistent_schemas).flatten.freeze
+        self.default_schema = default_schema.freeze
         freeze
       end
 
-      # ensures we're on the master Octopus shard, just updates the schema name
-      # with the tenant name
+      # switches to the tenant schema to run the block, ensuring we switch back
+      # afterwards, regardless of whether an exception occurs
       # @param block [Block] The code to execute within the schema
       # @yield [SchemaTenant] The current tenant instance
       def call(&block)
         begin
           # set the search path to include the tenant
-          ActiveRecord::Base.connection.schema_search_path = persistent_schemas.unshift(tenant_schema).join(", ")
+          ActiveRecord::Base.connection.schema_search_path = persistent_schemas.dup.unshift(tenant_schema).join(", ")
           block.yield(self)
         ensure
           # reset the search path back to the default
-          ActiveRecord::Base.connection.schema_search_path = persistent_schemas.unshift(default_schema).join(", ")
+          ActiveRecord::Base.connection.schema_search_path = persistent_schemas.dup.unshift(default_schema).join(", ")
+        end
+      end
+
+      # creates the tenant schema
+      # @param run_migrations [Boolean] whether or not to run migrations, defaults to Penthouse.configuration.migrate_tenants?
+      # @param db_schema_file [String] a path to the DB schema file to load, defaults to Penthouse.configuration.db_schema_file
+      def create(run_migrations: Penthouse.configuration.migrate_tenants?, db_schema_file: Penthouse.configuration.db_schema_file)
+        sql = ActiveRecord::Base.send(:sanitize_sql_array, ["create schema if not exists %s", tenant_schema])
+        ActiveRecord::Base.connection.exec_query(sql, 'Create Schema')
+        if !!run_migrations
+          migrate(db_schema_file: db_schema_file)
         end
       end
+
+      # drops the tenant schema
+      # @param force [Boolean] whether or not to drop the schema if not empty, defaults to true
+      def delete(force: true)
+        sql = ActiveRecord::Base.send(:sanitize_sql_array, ["drop schema if exists %s %s", tenant_schema, force ? 'cascade' : 'restrict'])
+        ActiveRecord::Base.connection.exec_query(sql, 'Delete Schema')
+      end
+
+      # returns whether or not this tenant's schema exists
+      # @return [Boolean] whether or not the tenant exists
+      def exists?
+        sql = ActiveRecord::Base.send(:sanitize_sql_array, ["select 1 from pg_namespace where nspname = '%s'", tenant_schema])
+        result = ActiveRecord::Base.connection.exec_query(sql, "Schema Exists")
+        !result.rows.empty?
+      end
+
     end
   end
 end

data/lib/penthouse/version.rb

@@ -1,3 +1,3 @@
 module Penthouse
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/penthouse.rb

@@ -47,10 +47,29 @@ module Penthouse
     # @param tenant_identifier [String, Symbol] the identifier for the tenant
     # @param runner [Penthouse::Runners::BaseRunner] an optional runner to use, defaults to the one configured
     # @param block [Block] the code to execute
+    # @yield [Penthouse::Tenants::BaseTenant] the tenant instance
     def switch(tenant_identifier, runner: configuration.runner, &block)
       runner.call(tenant_identifier, &block)
     end
 
+    # Loads the tenant and creates their data store
+    # @param tenant_identifier [String, Symbol] the identifier for the tenant
+    # @see Penthouse::Tenants::BaseTenant#delete
+    def create(tenant_identifier, runner: configuration.runner, **options)
+      switch(tenant_identifier, runner: runner) do |tenant|
+        tenant.create(**options)
+      end
+    end
+
+    # Loads the tenant and deletes their data store
+    # @param tenant_identifier [String, Symbol] the identifier for the tenant
+    # @see Penthouse::Tenants::BaseTenant#delete
+    def delete(tenant_identifier, runner: configuration.runner, **options)
+      switch(tenant_identifier, runner: runner) do |tenant|
+        tenant.delete(**options)
+      end
+    end
+
     # Allows you to configure the router of Penthouse
     # @yield [Penthouse::Configuration]
     def configure(&block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: penthouse
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryan Townsend
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,6 +180,7 @@ files:
 - lib/penthouse/sidekiq/railtie.rb
 - lib/penthouse/tasks/enhancements.rb
 - lib/penthouse/tenants/base_tenant.rb
+- lib/penthouse/tenants/migratable.rb
 - lib/penthouse/tenants/octopus_schema_tenant.rb
 - lib/penthouse/tenants/octopus_shard_tenant.rb
 - lib/penthouse/tenants/schema_tenant.rb