acts_as_multi_tenant 0.5.1 → 1.0.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 900858457990afa4c3972a78b8fadc624c22134d
-  data.tar.gz: 0a0fc2e1ac224944d60563be966d9818421a4789
+  metadata.gz: de0c6576d3305ddd5a2bc8b939351675e799e755
+  data.tar.gz: d6ccc7ffbe9f7251f46dffe2618879d265c173e4
 SHA512:
-  metadata.gz: b43d5b7c8e5eef9226b7c3f3ba7ea3618ee9d473de7dae3c59bcd4ae16be4225a1e5ff1cb29fdddb9c50fa54fdb7c05a275927a577837f0ac4d976a00a5673b0
-  data.tar.gz: 5072aac61f705c4a66d52579bce2efee8cc772f303177a617eaa97afe72c0334109def5469fd1b8d05746e99449ce5f7f8ae3280c0bdc58d0c69382604db4b4f
+  metadata.gz: d71a6bb84ed043f4b8f4314cdd7d54f9c1389643bd34300699946f4d89d2052204689dfb7a3f901a4a7a5be0e9c0e76efa66bea2a3b59218a493e55e2d61b517
+  data.tar.gz: b6869cef3c3c3023f41771c400bd387f79535696eea3bd7242029e1f74e66048500e6cd7f7638d3003e53c619f8475a5374e00ae8398cff0aa5cde9d26615613

data/README.md

@@ -21,19 +21,19 @@ use MultiTenant::Middleware,
   # (required) Fetch the identifier of the current tenant from a Rack::Request object
   identifier: ->(req) { req.host.split(/\./)[0] },
 
-  # (optional) Array of tentants that don't exist in the database, but should be allowed through anyway.
-  # IMPORTANT For these, Tenant.current will be nil!
-  global_identifiers: %w(global),
-
-  # (optional) Array of Strings or Regexps for paths that don't require a tenant. Only applies 
-  # when the tenant isn't specified in the request - not when a given tenant can't be found.
-  global_paths: [
-    '/about',
-    %r{^/api/v\d+/login$},
-  ],
-
-  # (optional) Returns a Rack response when a tenant couldn't be found in the db, or when
-  # a tenant isn't given (and isn't in the `global_paths` list)
+  # (optional) A Hash of fake identifiers that should be allowed through. Each identifier will have a
+  # Hash of Regex paths with Symbol http methods (or arrays thereof), or :any. These path & method combos
+  # will be allowed through when the identifier matches. All others will be blocked.
+  # IMPORTANT Tenant.current will be nil!
+  globals: {
+    "global" => {
+      %r{\A/api/widgets/} => :any,
+      %r{\A/api/splines/} => [:get, :post]
+    }
+  },
+
+  # (optional) Returns a Rack response when a tenant couldn't be found in the db (excluding globals),
+  # or when a tenant isn't given.
   not_found: ->(x) {
     body = {errors: ["'%s' is not a valid tenant!" % x]}.to_json
     [400, {'Content-Type' => 'application/json', 'Content-Length' => body.size.to_s}, [body]]

data/lib/multi_tenant/middleware.rb

@@ -13,16 +13,16 @@ module MultiTenant
   #     # A Proc that returns the tenant identifier that's used to look up the tenant. (i.e. :using option passed to acts_as_tenant)
   #     identifier: ->(req) { req.host.split(/\./)[0] },
   #
-  #     # (optional) Array of tentants that don't exist in the database, but should be allowed through anyway.
-  #     # IMPORTANT For these, Tenant.current will be nil!
-  #     global_identifiers: %w(global),
-  #
-  #     # (optional) Array of Strings or Regexps for paths that don't require a tenant. Only applies 
-  #     # when the tenant isn't specified in the request - not when a given tenant can't be found.
-  #     global_paths: [
-  #       '/about',
-  #       %r{^/api/v\d+/login$},
-  #     ],
+  #     # (optional) A Hash of fake identifiers that should be allowed through. Each identifier will have a
+  #     # Hash of Regex paths with Symbol http methods (or arrays thereof), or :any. These path & method combos
+  #     # will be allowed through when the identifier matches. All others will be blocked.
+  #     # IMPORTANT Tenant.current will be nil!
+  #     globals: {
+  #       "global" => {
+  #         %r{\A/api/widgets/} => :any,
+  #         %r{\A/api/splines/} => [:get, :post]
+  #       }
+  #     },
   #
   #     # (optional) Returns a Rack response when a tenant couldn't be found in the db, or when
   #     # a tenant isn't given (and isn't in the `global_paths` list)
@@ -38,14 +38,8 @@ module MultiTenant
     # @return [Proc] A Proc which accepts a Rack::Request and returns some identifier for tenant lookup
     attr_accessor :identifier
 
-    # @return [Set<String>] array of "fake" identifiers that will be allowed through, but without setting a current tentant
-    attr_accessor :global_identifiers
-
-    # @return [Set<String>] An array of path strings that don't requite a tenant to be given
-    attr_accessor :global_strings
-
-    # @return [Set<String>] An array of path regexes that don't requite a tenant to be given
-    attr_accessor :global_regexes
+    # @return [Hash] Global identifiers and their allowed paths and methods
+    attr_accessor :globals
 
     # @return [Proc] A Proc which accepts a (non-existent or blank) tenant identifier and returns a rack response describing
     # the error. Defaults to a 404 and some shitty html.
@@ -60,39 +54,36 @@ module MultiTenant
     # Initialize a new multi tenant Rack middleware.
     #
     # @param app the Rack app
-    # @param opts [Hash] Required: :model, :identifier. Optional: :global_identifiers, :global_paths, :not_found.
+    # @param opts [Hash] Required: :model, :identifier. Optional: :globals, :not_found.
     #
     def initialize(app, opts)
       @app = app
       self.model = opts.fetch :model
       self.identifier = opts.fetch :identifier
-      self.global_identifiers = Set.new(Array(opts[:global_identifiers]))
-      self.global_strings = Set.new(Array(opts[:global_paths]).select { |x| x.is_a? String })
-      self.global_regexes = Array(opts[:global_paths]).select { |x| x.is_a? Regexp }
+      self.globals = (opts[:globals] || {}).reduce({}) { |a, (global, patterns)|
+        a[global] = patterns.reduce({}) { |aa, (path, methods)|
+          aa[path] = methods == :any ? :any : Set.new(Array(methods).map { |m| m.to_s.upcase })
+          aa
+        }
+        a
+      }
       self.not_found = opts[:not_found] || DEFAULT_NOT_FOUND
     end
 
     # Rack request call
     def call(env)
+      tenant_class.current = nil
       request = Rack::Request.new env
       tenant_identifier = identifier.(request)
 
-      if tenant_identifier.blank?
-        if global_strings.include? request.path or global_regexes.any? { |x| x =~ request.path }
-          tenant_class.current = nil
-          return @app.call env
-        else
-          return not_found.(tenant_identifier)
-        end
-      end
+      if (allowed_paths = globals[tenant_identifier])
+        allowed = path_matches?(request, allowed_paths)
+        return allowed ? @app.call(env) : not_found.(tenant_identifier)
 
-      tenant_record = tenant_identifier.present? ? tenant_class.where({tenant_class.tenant_identifier => tenant_identifier}).first : nil
-      if tenant_record
-        tenant_class.current = tenant_record
-        return @app.call env
-      elsif global_identifiers.include? tenant_identifier
-        tenant_class.current = nil
+      elsif (tenant = tenant_class.where({tenant_class.tenant_identifier => tenant_identifier}).first)
+        tenant_class.current = tenant
         return @app.call env
+
       else
         return not_found.(tenant_identifier)
       end
@@ -100,6 +91,12 @@ module MultiTenant
       tenant_class.current = nil
     end
 
+    def path_matches?(req, paths)
+      paths.any? { |(path, methods)|
+        (path == req.path || path =~ req.path) && (methods == :any || methods.include?(req.request_method))
+      }
+    end
+
     # Infers and returns the tenant model class this middleware is handling
     def tenant_class
       @tenant_class ||= if self.model.respond_to?(:call)

data/lib/multi_tenant/version.rb

@@ -1,4 +1,4 @@
 module MultiTenant
   # Gem version
-  VERSION = '0.5.1'.freeze
+  VERSION = '1.0.0.pre.rc1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_multi_tenant
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0.pre.rc1
 platform: ruby
 authors:
 - Jordan Hollinger
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -76,12 +76,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: An ActiveRecord plugin for multi-tenant databases