houser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 660210769a358f7762e93521067dfa4881540b6a
+  data.tar.gz: 3d17a55eb94cc210592d501f25ed45bdd6baa3a7
+SHA512:
+  metadata.gz: 40ee63aa9cf3f9c9a43da58dc9074b73b21968895c27a23b6dea2a321636c8edfdb26c166a59adbd368d7696074175daf8c3c6c5178dfc0c1c3a5a6873837d24
+  data.tar.gz: ea47db23357f0488d323dd368bdacf86f039b4781d968f29cefdf2af8f3110ad4451d913bfd9f380c406b0e0749dbe9df0ba610a7c609d73f79f3c968d7c1d4f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+Houser is an open source project and we encourage contributions.
+
+## Filing an issue
+
+When filing an issue on the Houser project, please provide these details:
+
+* A comprehensive list of steps to reproduce the issue.
+* What you're *expecting* to happen compared with what's *actually* happening.
+* Your application's complete Gemfile, as text (*not as an image*)
+* Any relevant stack traces ("Full trace" preferred)
+
+In 99% of cases, this information is enough to determine the cause and solution
+to the problem that is being described.
+
+Please remember to format code using triple backticks (\`\`\`) so that it is neatly
+formatted when the issue is posted.
+
+Any issue that is open for 14 days without actionable information or activity
+will be marked as "stalled" and then closed. Stalled issues can be re-opened if
+the information requested is provided.
+
+## Pull requests
+
+We gladly accept pull requests to fix bugs and, in some circumstances, add new
+features to Houser.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate:
+
+        $ bundle exec rspec spec
+
+3. Create new branch then make changes and add tests for your changes. Only
+refactoring and documentation changes require no new tests. If you are adding
+functionality or fixing a bug, we need tests!
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or `my_method my_arg`.
+* `a = b` and not `a=b`.
+* `a_method { |block| ... }` and not `a_method { | block | ... }`
+* Follow the conventions you see used in the source already.
+* -> symbol over lambda
+* Ruby 1.9 hash syntax over Ruby 1.8 hash syntax
+
+And in case we didn't emphasize it enough: we love tests!

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Bigg
+
+MIT License
+
+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,32 @@
+# Houser
+
+This is the multitenancy gem that will be used in the Multitenancy with Rails book as an alternative method to PostgreSQL schemas which can have their own set of problems.
+
+Houser provides you with two Rack environment variables which can then be used in your application to scope resources correctly. That is all it does for the time being, and it will probably do more in the future.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'houser'
+
+And then execute:
+
+    $ bundle
+
+In `config/application.rb`, put this line:
+
+    config.middleware.use Houser::Middleware, 
+      :class_name => 'Model'
+
+Where 'Model' is the class that you're scoping by. 
+
+If you're using a TLD like `.co.uk` instead of `.com`, you will need to specify `tld_length` too:
+
+    config.middleware.use Houser::Middleware, 
+      :class_name => 'Model',
+      :tld_length => 2
+
+## Contributing
+
+Please see [CONTRIBUTING.md](https://github.com/radar/houser/CONTRIBUTING.md)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/houser.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'houser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "houser"
+  spec.version       = Houser::VERSION
+  spec.authors       = ["Ryan Bigg"]
+  spec.email         = ["radarlistener@gmail.com"]
+  spec.summary       = %q{Lightweight multitenancy gem.}
+  spec.description   = %q{Lightweight multitenancy gem.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails", "2.99.0.beta1"
+  spec.add_development_dependency "pry"
+end

data/lib/houser/middleware.rb

@@ -0,0 +1,33 @@
+require 'rack'
+
+module Houser
+  class Middleware
+    def initialize(app, options={})
+      @options = options
+      @options[:class_name] = Object.const_get(@options[:class_name])
+      @options[:tld_length] ||= 1
+      @app = app
+    end
+
+    def call(env)
+      domain_parts = env['HTTP_HOST'].split('.')
+
+      if domain_parts.length > 1 + @options[:tld_length]
+        subdomain = domain_parts[0]
+        find_tenant(env, subdomain)
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def find_tenant(env, subdomain)
+      object = Account.find_by(subdomain: subdomain)
+      if object
+        env['X-Houser-Subdomain'] = subdomain
+        env['X-Houser-Object'] = object
+      end
+    end
+  end
+end

data/lib/houser/version.rb

@@ -0,0 +1,3 @@
+module Houser
+  VERSION = "1.0.0"
+end

data/lib/houser.rb

@@ -0,0 +1,4 @@
+require "houser/version"
+
+module Houser
+end

data/spec/houser_spec.rb

@@ -0,0 +1,66 @@
+require 'houser/middleware'
+require 'pry'
+
+# Inspired by http://taylorluk.com/post/54982679495/how-to-test-rack-middleware-with-rspec
+
+describe Houser::Middleware do
+  let(:app) { ->(env) { [200, env, "app"] } }
+  let(:options) do
+    { 
+      class_name: 'Account'
+    }
+  end
+
+  let(:middleware) do
+    Houser::Middleware.new(app, options)
+  end
+
+  let(:subdomain) { 'account1' }
+
+  def env_for(url, opts={})
+    opts.merge!('HTTP_HOST' => URI.parse(url).host)
+    Rack::MockRequest.env_for(url, opts)
+  end
+
+  it "does nothing for non-subdomained requests" do
+    stub_const('Account', Class.new)
+    expect(Account).to_not receive(:find_by)
+    code, env = middleware.call(env_for("http://example.com"))
+    expect(env['X-Houser-Subdomain']).to be_nil
+    expect(env['X-Houser-ID']).to be_nil
+  end
+
+  context "with more than one-level of TLD" do
+    let(:options) do
+      { 
+        tld_length: 2,
+        class_name: 'Account'
+      }
+    end
+
+    it "support more than one-level of TLD" do
+      stub_const('Account', Class.new)
+      expect(Account).to_not receive(:find_by)
+      code, env = middleware.call(env_for("http://example.co.uk"))
+      expect(env['X-Houser-Subdomain']).to be_nil
+      expect(env['X-Houser-ID']).to be_nil
+    end
+  end
+    
+  it "sets X-HOUSER-ID header for known subdomains" do
+    stub_const('Account', Class.new)
+    account = double(id: 1)
+    expect(Account).to receive(:find_by).with(subdomain: subdomain).and_return(account)
+    code, env = middleware.call(env_for("http://#{subdomain}.example.com"))
+    expect(env['X-Houser-Subdomain']).to eq(subdomain)
+    expect(env['X-Houser-ID']).to eq(1)
+  end
+
+  it "returns no headers for unknown subdomains" do
+    stub_const('Account', Class.new)
+    expect(Account).to receive(:find_by).with(subdomain: subdomain).and_return(nil)
+    code, env = middleware.call(env_for("http://#{subdomain}.example.com"))
+    expect(env['X-Houser-Subdomain']).to be_nil
+    expect(env['X-Houser-ID']).to be_nil
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: houser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Bigg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.99.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.99.0.beta1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Lightweight multitenancy gem.
+email:
+- radarlistener@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- houser.gemspec
+- lib/houser.rb
+- lib/houser/middleware.rb
+- lib/houser/version.rb
+- spec/houser_spec.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Lightweight multitenancy gem.
+test_files:
+- spec/houser_spec.rb