groundskeeper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3975fada368881d791f29aff9a9d69ec1936601
+  data.tar.gz: e8ea24cf07c35ac745f2049ebe3f8bf89a1f120f
+SHA512:
+  metadata.gz: 7eaad077b35bfc0fed048f25da2f5b899709d286e474ec33d89870e388aaeceb4ac5046d81f7c1b7e7df2f379f596fa5037879d752a263515b245a23ac7bb252
+  data.tar.gz: de45823a612d6f0bcbab713d6438078b6a6b349301dfbdcd755bbc094c986eca18ac3b559900e2dcc8725e4086c22613a8a2c5137743bc7774316ba8f14789fb

data/lib/groundskeeper.rb

@@ -0,0 +1,8 @@
+require "rack"
+
+# This is the main namespace for your gem
+module Groundskeeper
+  require_relative "groundskeeper/version"
+  require_relative "groundskeeper/middleware"
+
+end

data/lib/groundskeeper/middleware.rb

@@ -0,0 +1,71 @@
+module Groundskeeper
+  class Middleware
+    NAMESPACE_KEY = "Groundskeeper-Namespace"
+    TENANT_KEY = "Groundskeeper-Tenant"
+    MODEL_KEY = :model
+    QUERY_KEY = :query
+    DEFAULT_KEY = :default
+    QUERY_DEFAULT = ->(model, slug) do
+      model.find_by_slug(slug)
+    end
+
+    def initialize(app, options = {})
+      raise ArgumentError, "missing model" unless options.key?(model_key)
+
+      @options = options
+      @app = app
+      @env = {}
+    end
+
+    def call(env)
+      @env = env
+      env[namespace_key] = namespace
+      env[tenant_key] = tenant
+      @app.call(env)
+    end
+
+    private def tenant
+      query.call(model, namespace) || default
+    end
+
+    private def model
+      if @options[model_key].is_a?(String)
+        Object.const_get(@options[model_key])
+      else
+        @options[model_key]
+      end
+    end
+
+    private def default
+      @options[default_key]
+    end
+
+    private def query
+      @options[query_key] || query_default
+    end
+
+    private def namespace_key
+      self.class.const_get("NAMESPACE_KEY")
+    end
+
+    private def tenant_key
+      self.class.const_get("TENANT_KEY")
+    end
+
+    private def model_key
+      self.class.const_get("MODEL_KEY")
+    end
+
+    private def default_key
+      self.class.const_get("DEFAULT_KEY")
+    end
+
+    private def query_key
+      self.class.const_get("QUERY_KEY")
+    end
+
+    private def query_default
+      self.class.const_get("QUERY_DEFAULT")
+    end
+  end
+end

data/lib/groundskeeper/middleware/header.rb

@@ -0,0 +1,25 @@
+module Groundskeeper
+  class Middleware
+    class Header < Middleware
+      PARSE_KEY = :parse
+      PARSE_DEFAULT = ->(headers) { headers[HEADER_DEFAULT_KEY] }
+      HEADER_DEFAULT_KEY = "Groundskeeper-Namespace"
+
+      private def namespace
+        # parse.call()
+      end
+
+      private def parse
+        @options[parse_key] || parse_default
+      end
+
+      private def parse_key
+        self.class.const_get("PARSE_KEY")
+      end
+
+      private def parse_default
+        self.class.const_get("PARSE_DEFAULT")
+      end
+    end
+  end
+end

data/lib/groundskeeper/middleware/parameter.rb

@@ -0,0 +1,25 @@
+module Groundskeeper
+  class Middleware
+    class Parameter < Middleware
+      PARSE_KEY = :parse
+      PARSE_DEFAULT = ->(params) { params[PARAM_DEFAULT_KEY] }
+      PARAM_DEFAULT_KEY = "tenant"
+
+      private def namespace
+        # parse.call()
+      end
+
+      private def parse
+        @options[parse_key] || parse_default
+      end
+
+      private def parse_key
+        self.class.const_get("PARSE_KEY")
+      end
+
+      private def parse_default
+        self.class.const_get("PARSE_DEFAULT")
+      end
+    end
+  end
+end

data/lib/groundskeeper/middleware/path.rb

@@ -0,0 +1,29 @@
+module Groundskeeper
+  class Middleware
+    class Path < Middleware
+      PARSE_KEY = :parse
+      PARSE_DEFAULT = ->(path) { path.split("/")[1] }
+      RACK_PATH_KEY = "PATH_INFO"
+
+      private def namespace
+        parse.call(@env[rack_path_key])
+      end
+
+      private def parse
+        @options[parse_key] || parse_default
+      end
+
+      private def parse_key
+        self.class.const_get("PARSE_KEY")
+      end
+
+      private def parse_default
+        self.class.const_get("PARSE_DEFAULT")
+      end
+
+      private def rack_path_key
+        self.class.const_get("RACK_PATH_KEY")
+      end
+    end
+  end
+end

data/lib/groundskeeper/middleware/subdomain.rb

@@ -0,0 +1,43 @@
+module Groundskeeper
+  class Middleware
+    class Subdomain < Middleware
+      DEPTH_KEY = :depth
+      DEPTH_DEFAULT = -3
+      PARSE_KEY = :parse
+      PARSE_DEFAULT = ->(fqdn, depth) { fqdn.split(".")[depth] }
+      RACK_HOST_KEY = "HTTP_HOST"
+
+      private def namespace
+        parse.call(@env[rack_host_key], depth)
+      end
+
+      private def parse
+        @options[parse_key] || parse_default
+      end
+
+      private def parse_key
+        self.class.const_get("PARSE_KEY")
+      end
+
+      private def parse_default
+        self.class.const_get("PARSE_DEFAULT")
+      end
+
+      private def depth
+        @options[depth_key].to_i * -1 || depth_default
+      end
+
+      private def depth_key
+        self.class.const_get("DEPTH_KEY")
+      end
+
+      private def depth_default
+        self.class.const_get("DEPTH_DEFAULT")
+      end
+
+      private def rack_host_key
+        self.class.const_get("RACK_HOST_KEY")
+      end
+    end
+  end
+end

data/lib/groundskeeper/version.rb

@@ -0,0 +1,4 @@
+# This is where we define the version number for the gem
+module Groundskeeper
+  VERSION = "1.0.0"
+end

data/spec/lib/groundskeeper/middleware/path_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+require "groundskeeper/middleware/path"
+
+describe Groundskeeper::Middleware::Path do
+  include_context "rack setup"
+  let(:url) { "http://foo.example.com/admin/james/users" }
+  let(:namespace) { "admin" }
+
+  describe "#call" do
+    it "sets the namespace correctly" do
+      expect(request_namespace).to eq(namespace)
+    end
+
+    context "looking to namespace on second nested path resource" do
+      let(:options) do
+        {
+          model: model,
+          parse: ->(path) { path.split("/").compact[2] }
+        }
+      end
+      let(:namespace) { "james" }
+
+      it "sets the namespace correctly" do
+        expect(request_namespace).to eq(namespace)
+      end
+    end
+  end
+end

data/spec/lib/groundskeeper/middleware/subdomain_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+require "groundskeeper/middleware/subdomain"
+
+describe Groundskeeper::Middleware::Subdomain do
+  include_context "rack setup"
+
+  describe "#call" do
+    it "sets the namespace correctly" do
+      expect(request_namespace).to eq(namespace)
+    end
+
+    context "looking to namespace on domain" do
+      let(:options) do { model: model, depth: 2 } end
+      let(:namespace) { "example" }
+
+      it "sets the namespace correctly" do
+        expect(request_namespace).to eq(namespace)
+      end
+    end
+  end
+end

data/spec/lib/groundskeeper/middleware_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Groundskeeper::Middleware do
+  include_context "rack setup"
+
+  before(:each) do
+    allow(middleware).to receive(:namespace).and_return(namespace)
+  end
+
+  describe "#call" do
+    it "sets the namespace correctly" do
+      expect(request_namespace).to eq(namespace)
+    end
+
+    it "sets the tenant correctly" do
+      expect(request_tenant).to eq(instance)
+    end
+
+    context "with a default" do
+      let(:default) { double("Default") }
+      let(:options) do { model: model, default: default } end
+
+      before(:each) do
+        allow(model).to receive(:find).and_return(nil)
+      end
+
+      it "sets the default as the tenant" do
+        expect(request_tenant).to eq(default)
+      end
+    end
+  end
+end

data/spec/lib/groundskeeper/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Groundskeeper::VERSION do
+  it "should be a string" do
+    expect(Groundskeeper::VERSION).to be_kind_of(String)
+  end
+end

data/spec/lib/groundskeeper_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Groundskeeper do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require "pry"
+require "rspec"
+require "groundskeeper"
+
+shared_context "rack setup" do
+  let(:url) { "http://foo.example.com" }
+  let(:rack_env) do
+    {
+      "HTTP_HOST" => URI.parse(url).host,
+      "PATH_INFO" => URI.parse(url).path
+    }
+  end
+
+  let(:namespace) { "foo" }
+  let(:model) { double("Model") }
+  let(:instance) { instance_double("Model") }
+
+  let(:app) { ->(env) { [200, rack_env, "app"] } }
+  let(:options) do { model: model } end
+  let(:middleware) { described_class.new(app, options) }
+  let(:request) { middleware.call(rack_env) }
+  let(:request_code) { request[0] }
+  let(:request_env) { request[1] }
+  let(:request_namespace) { request_env[Groundskeeper::Middleware::NAMESPACE_KEY] }
+  let(:request_tenant) { request_env[Groundskeeper::Middleware::TENANT_KEY] }
+
+  before(:each) do
+    allow(model).to receive(:find).and_return(instance)
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: groundskeeper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A simple multi-tenancy middleware with options
+email:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/groundskeeper.rb
+- lib/groundskeeper/middleware.rb
+- lib/groundskeeper/middleware/header.rb
+- lib/groundskeeper/middleware/parameter.rb
+- lib/groundskeeper/middleware/path.rb
+- lib/groundskeeper/middleware/subdomain.rb
+- lib/groundskeeper/version.rb
+- spec/lib/groundskeeper/middleware/path_spec.rb
+- spec/lib/groundskeeper/middleware/subdomain_spec.rb
+- spec/lib/groundskeeper/middleware_spec.rb
+- spec/lib/groundskeeper/version_spec.rb
+- spec/lib/groundskeeper_spec.rb
+- spec/spec_helper.rb
+homepage: http://krainboltgreene.github.io/groundskeeper
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple multi-tenancy middleware with options
+test_files:
+- spec/lib/groundskeeper/middleware/path_spec.rb
+- spec/lib/groundskeeper/middleware/subdomain_spec.rb
+- spec/lib/groundskeeper/middleware_spec.rb
+- spec/lib/groundskeeper/version_spec.rb
+- spec/lib/groundskeeper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: