multi_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb959e3e7261ece07ebd98c3c50024e9aeeebf00
+  data.tar.gz: 12f046e79761540fa66f8ac99f6cd23c78e08b56
+SHA512:
+  metadata.gz: ffd03a80b02d73e9354aea0581d0192685217591380e5d1f602f9e5aae486f2fb45c20f07d59542f04354c9c51d637d5de5a39db273a7f4afcf905c60ce08a27
+  data.tar.gz: 575e6f74d0533afdfe35dababf3b6a998bd5506909f3572f1367458897e34d12081c0089280b5aee5ac5216666563c1dbb68d8dbd1f0e0997f3e80f00afa1ea4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Roberto Vasquez Angel
+
+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.rdoc

@@ -0,0 +1,28 @@
+= MultiClient
+
+= Installation
+
+Add it to your gemfile:
+
+    # Gemfile
+    gem 'multi_client'
+
+Run the installer:
+
+    > rails generate multi_client:install
+
+Add migrations and migrate
+
+    > rake multi_client:install:migrations && rake db:migrate
+
+= How do I set the current client?
+
+  # console
+  MultiClient::Client.set_current_by_identifier '100'
+
+= How do I unset the current client?
+
+  # console
+  MultiClient::Client.unset_current
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MultiClient'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/multi_client/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/multi_client/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/concerns/multi_client/controller_with_client.rb

@@ -0,0 +1,31 @@
+module MultiClient
+  module ControllerWithClient
+    extend ActiveSupport::Concern
+
+    included do
+      around_action :set_current_client
+
+      helper_method :current_client
+    end
+
+    private
+
+    def client_class
+      Configuration.model_name.constantize
+    end
+
+    def current_client
+      @current_client ||= client_class.enabled.find(MultiClient::Client.current_id) if MultiClient::Client.current_id
+    end
+
+    def set_current_client
+      redirect_to(root_url(subdomain: 'www')) && return unless current_client = client_class.enabled.find_by_subdomain(request.subdomains.first)
+      client_class.current_id = current_client.id
+      begin
+        yield
+      ensure
+        @current_client = client_class.current_id = nil
+      end
+    end
+  end
+end

data/app/controllers/multi_client/application_controller.rb

@@ -0,0 +1,4 @@
+module MultiClient
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/exceptions/unscoped_forbidden_error.rb

@@ -0,0 +1,2 @@
+class UnscopedForbiddenError < StandardError
+end

data/app/helpers/multi_client/application_helper.rb

@@ -0,0 +1,4 @@
+module MultiClient
+  module ApplicationHelper
+  end
+end

data/app/helpers/multi_client_helper.rb

@@ -0,0 +1,6 @@
+module MultiClientHelper
+  def render_client_navigation
+    clients = MultiClient::Client.all
+    render 'multi_client/client_navigation', clients: clients
+  end
+end

data/app/models/concerns/multi_client/model_with_client.rb

@@ -0,0 +1,35 @@
+module MultiClient
+  module ModelWithClient
+    extend ActiveSupport::Concern
+
+    included do
+      klass = Class.new(self) do
+        default_scope { unscoped }
+
+        def unscoped
+          super
+        end
+      end
+      const_set 'Unscoped', klass
+
+      belongs_to MultiClient::Configuration.method_name.to_sym, class_name: MultiClient::Configuration.model_name
+
+      scope "for_current_#{MultiClient::Configuration.method_name}".to_sym, -> { where(MultiClient::Configuration.foreign_key.to_sym => MultiClient::Configuration.model_name.constantize.current_id) }
+      default_scope { send("for_current_#{MultiClient::Configuration.method_name}".to_sym) }
+
+      validates MultiClient::Configuration.foreign_key.to_sym, presence: true
+
+      ::MultiClient::Client.has_many name.demodulize.underscore.pluralize.to_sym, class_name: "::#{name}", foreign_key: MultiClient::Configuration.foreign_key.to_sym
+    end
+
+    class_methods do
+      def unscoped
+        return super if name.demodulize == 'Unscoped'
+        caller = caller_locations(1, 1)[0].label
+        return where(MultiClient::Configuration.foreign_key.to_sym => MultiClient::Configuration.model_name.constantize.current_id) if MultiClient::Configuration.force_client_scope_for_unscoped_callers.include?(caller)
+        return super if MultiClient::Configuration.allowed_unscoped_callers.include?(caller)
+        raise UnscopedForbiddenError, "Calling unscoped from #{caller} is not allowed to prevent client data leakage"
+      end
+    end
+  end
+end

data/app/models/multi_client/client.rb

@@ -0,0 +1,31 @@
+module MultiClient
+  class Client < ActiveRecord::Base
+    validates :identifier, presence: true,
+                           uniqueness: true
+
+    validates :subdomain, presence: true,
+                          uniqueness: true
+
+    scope :enabled, -> { where(enabled: true) }
+
+    def self.current_id=(id)
+      Thread.current[:client_id] = id
+    end
+
+    def self.current_id
+      Thread.current[:client_id]
+    end
+
+    def human
+      identifier
+    end
+
+    def self.set_current_by_identifier(identifier)
+      self.current_id = where(identifier: identifier).first.try(:id)
+    end
+
+    def self.unset_current
+      self.current_id = nil
+    end
+  end
+end

data/app/views/layouts/multi_client/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>MultiClient</title>
+  <%= stylesheet_link_tag    "multi_client/application", media: "all" %>
+  <%= javascript_include_tag "multi_client/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/multi_client/_client_navigation.haml

@@ -0,0 +1,9 @@
+%li.dropdown.active
+  = link_to('#', { class: 'dropdown-toggle', 'data-toggle': 'dropdown', role: 'button', 'aria-haspopup': true, 'aria-expanded': false }) do
+    = t("classes.#{MultiClient::Client.name.underscore}")
+    %span.caret
+  %ul.dropdown-menu
+    - MultiClient::Client.enabled.all.each do |client|
+      %li{ class: (request.subdomain == client.subdomain ? 'active' : nil) }
+        = link_to(url_for(host: "#{client.subdomain}.#{request.domain}")) do
+          = "#{client.identifier} (#{client.subdomain})"

data/app/views/multi_client/_current_client.html.erb

@@ -0,0 +1,4 @@
+<% if MultiClient::Client.current_id %>
+  Current <%= MultiClient::Configuration.model_name.constantize.model_name.human %>: <%= current_client.human %>
+  <%= link_to 'Logout', sessions_url(subdomain: 'www'), method: :delete %>
+<% end %>

data/config/locales/de.yml

@@ -0,0 +1,3 @@
+de:
+  classes:
+    multi_client/client: Mandant

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  classes:
+    multi_client/client: Mandant

data/config/routes.rb

@@ -0,0 +1,2 @@
+MultiClient::Engine.routes.draw do
+end

data/db/migrate/001_create_multi_client_clients.rb

@@ -0,0 +1,11 @@
+class CreateMultiClientClients < ActiveRecord::Migration
+  def change
+    create_table :multi_client_clients do |t|
+      t.string :identifier, null: false
+      t.string :subdomain, null: false
+      t.boolean :enabled
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/multi_client/install/install_generator.rb

@@ -0,0 +1,13 @@
+module MultiClient
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Generates the initializer'
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_intializer
+        copy_file 'multi_client.rb', 'config/initializers/multi_client.rb'
+      end
+    end
+  end
+end

data/lib/generators/multi_client/install/templates/multi_client.rb

@@ -0,0 +1,56 @@
+MultiClient.configure do |config|
+  # Client model name
+  #
+  # default: config.model_name = 'Client'
+  config.model_name = 'Client'
+
+  # Foreign key column
+  #
+  # default: config.foreign_key = 'client_id'
+  config.foreign_key = 'client_id'
+
+  # Method name pre/suffix
+  #
+  # default: config.method_name = 'client'
+  config.method_name = 'client'
+
+  # Calling unscoped is blocked to prevent data leakage. You can define
+  # exceptions here.
+  # 
+  # default: config.allowed_unscoped_callers = %w(
+  #   _create_record 
+  #   _update_record 
+  #   aggregate_column 
+  #   bottom_item 
+  #   eval_scope
+  #   relation_for_destroy 
+  #   reload 
+  #   scope
+  #   scope_for_slug_generator 
+  #   update_counters
+  #   update_positions 
+  #   validate_each
+  # )
+  #
+  config.allowed_unscoped_callers = %w(
+    _create_record 
+    _update_record 
+    aggregate_column 
+    bottom_item 
+    eval_scope
+    relation_for_destroy 
+    reload 
+    scope
+    scope_for_slug_generator 
+    update_counters
+    update_positions 
+    validate_each
+  )
+
+  # Calling unscoped is blocked to prevent data leakage. You can override the behaviour of unscoped
+  # here. If the caller is in this list, it wont get the unscoped scope, but a client scoped relation.
+  #
+  # default: config.force_client_scope_for_unscoped_callers = ['aggregate_column']
+  #
+  config.force_client_scope_for_unscoped_callers = ['aggregate_column']
+end

data/lib/multi_client/configuration.rb

@@ -0,0 +1,27 @@
+module MultiClient
+  module Configuration
+    def configure
+      yield self
+    end
+
+    mattr_accessor :model_name do
+      'Client'
+    end
+
+    mattr_accessor :foreign_key do
+      'client_id'
+    end
+
+    mattr_accessor :method_name do
+      'client'
+    end
+
+    mattr_accessor(:allowed_unscoped_callers) { [] }
+
+    mattr_accessor(:force_client_scope_for_unscoped_callers) { [] }
+
+    def self.namespaced_model_name
+      "MultiClient::#{model_name}"
+    end
+  end
+end

data/lib/multi_client/engine.rb

@@ -0,0 +1,7 @@
+module MultiClient
+  class Engine < ::Rails::Engine
+    isolate_namespace MultiClient
+
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+  end
+end

data/lib/multi_client/no_subdomain.rb

@@ -0,0 +1,12 @@
+module MultiClient
+  class NoSubdomain
+    def self.matches?(request)
+      case request.subdomain
+      when 'www', '', nil
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/multi_client/subdomain.rb

@@ -0,0 +1,12 @@
+module MultiClient
+  class Subdomain
+    def self.matches?(request)
+      case request.subdomain
+      when 'www', '', nil
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/multi_client/version.rb

@@ -0,0 +1,3 @@
+module MultiClient
+  VERSION = '0.1.1'.freeze
+end

data/lib/multi_client.rb

@@ -0,0 +1,6 @@
+require 'multi_client/engine'
+require 'multi_client/configuration'
+
+module MultiClient
+  extend Configuration
+end

data/lib/tasks/multi_client_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :multi_client do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: multi_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Roberto Vasquez Angel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: jquery-rails
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  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: guard-rspec
+  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: factory_girl_rails
+  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: shoulda-matchers
+  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: Easy MultiClient Support for Rails.
+email:
+- roberto@vasquez-angel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/assets/javascripts/multi_client/application.js
+- app/assets/stylesheets/multi_client/application.css
+- app/controllers/concerns/multi_client/controller_with_client.rb
+- app/controllers/multi_client/application_controller.rb
+- app/exceptions/unscoped_forbidden_error.rb
+- app/helpers/multi_client/application_helper.rb
+- app/helpers/multi_client_helper.rb
+- app/models/concerns/multi_client/model_with_client.rb
+- app/models/multi_client/client.rb
+- app/views/layouts/multi_client/application.html.erb
+- app/views/multi_client/_client_navigation.haml
+- app/views/multi_client/_current_client.html.erb
+- config/locales/de.yml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/001_create_multi_client_clients.rb
+- lib/generators/multi_client/install/install_generator.rb
+- lib/generators/multi_client/install/templates/multi_client.rb
+- lib/multi_client.rb
+- lib/multi_client/configuration.rb
+- lib/multi_client/engine.rb
+- lib/multi_client/no_subdomain.rb
+- lib/multi_client/subdomain.rb
+- lib/multi_client/version.rb
+- lib/tasks/multi_client_tasks.rake
+homepage: https://github.com/robotex82/multi_client
+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.8
+signing_key: 
+specification_version: 4
+summary: MultiClient Module.
+test_files: []