account_subdomain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b84cd35a4b574ed98471d3bbe1ada6b9f4b6240e
+  data.tar.gz: cda69e55af3a7b72e8e24ad31dde95185f5c21b6
+SHA512:
+  metadata.gz: 51bce02935b0e8d2c00c5ca04dd4d4901809e58301fa44643d0967889953edfab4fb90d29c99c144f661f20e7b5c910ccffa1a84930f3aa30a74642fb8d1187a
+  data.tar.gz: a53b3ac733b6d5221b3523dfd69625dbb52f4a03ffa1196fe369c5b82ce9f93c35c03babb529d19197a9bfba33604f28d29da09c81538a02696a61068f2da46e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,63 @@
+# AccountSubdomain
+
+Adds the subdomain functionality to rails application. Ready for rails 4([RubyGems](http://rubygems.org/gems/account_subdomain))
+
+### Dummy Application
+
+* [spec/dummy_app](https://github.com/sachin/account_subdomain/tree/master/test/dummy)
+
+## Install
+
+**Gemfile** (Rails 4)
+
+```
+gem 'account_subdomain'
+```
+
+**Console**
+
+```
+bundle
+```
+
+```
+rails generate account_subdomain:install
+```
+
+```
+rake db:migrate
+```
+### Extend your Routes for mount ACCOUNT SUBDOMAIN
+
+```
+mount AccountSubdomain::Engine => "/account_subdomain"
+```
+
+You are done !
+
+## Usage
+
+Account subdomain gem add the functionality of adding and managing the subdomain functionality in rails application.
+
+It gives you some filters and ui helpers
+### subdomain
+ It return the subdomain from the request object
+
+### validate_subdomain
+ It validated the request subdomain. If subdomain not found then return to the redirect url mentioned in account_subdomain.rb under initializers.
+
+### current_subdomain
+   Return the valid subdomain else nil.
+
+## Settings
+ Setting for account subdomain mentioned in account_subdomain.rb under initializers
+
+## UI Helper
+
+### url_for
+
+  We override the default url_for helper now it supports the subdomain option to generate the url. example:-
+
+       articles_url(:subdomain => 'test') #=> test.example.com/articles
+
+       article_url(article, :subdomain => 'test') #=> test.example.com/articles/1

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'AccountSubdomain'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/account_subdomain/accounts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/account_subdomain/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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/account_subdomain/accounts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/account_subdomain/accounts_controller.rb

@@ -0,0 +1,49 @@
+#require_dependency "account_subdomain/application_controller"
+
+module AccountSubdomain
+  class AccountsController < ApplicationController
+    before_action :set_account, only: [:show, :destroy]
+
+    # GET /accounts
+    def index
+      @accounts = AccountSubdomain::Account.all
+    end
+
+    # GET /accounts/1
+    def show
+    end
+
+    # GET /accounts/new
+    def new
+      @account = AccountSubdomain::Account.new
+    end
+
+    # POST /accounts
+    def create
+      @account = AccountSubdomain::Account.new(account_params)
+
+      if @account.save
+        redirect_to main_app.root_url(:subdomain => @account.subdomain), notice: 'Account was successfully created.'
+      else
+        render action: 'new'
+      end
+    end
+
+    # DELETE /accounts/1
+    def destroy
+      @account.destroy
+      redirect_to accounts_url, notice: 'Account was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_account
+        @account = AccountSubdomain::Account.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def account_params
+        params.require(:account).permit(:subdomain)
+      end
+  end
+end

data/app/controllers/account_subdomain/application_controller.rb

@@ -0,0 +1,7 @@
+class AccountSubdomain::ApplicationController < ApplicationController
+  AccountSubdomain.action_controller_filters.each_pair do|key, reflection|
+    reflection.each do|_rel|
+      self.class_eval "#{key} :#{_rel.to_sym}"
+    end
+  end
+end

data/app/helpers/account_subdomain/accounts_helper.rb

@@ -0,0 +1,17 @@
+module AccountSubdomain
+  module AccountsHelper
+
+    def subdomain
+      request.subdomain(AccountSubdomain.tld_length)
+    end
+
+    def validate_subdomain
+      redirect_to eval("main_app.#{AccountSubdomain.redirect_path}"), :error => 'You are not authorized.' unless current_subdomain.present?
+    end
+
+    def current_subdomain
+      @subdomain ||= AccountSubdomain::Account.find_by_subdomain(subdomain)
+    end
+
+  end
+end

data/app/helpers/account_subdomain/application_helper.rb

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

data/app/helpers/account_subdomain/url_helper.rb

@@ -0,0 +1,16 @@
+module AccountSubdomain
+  module UrlHelper
+    def with_subdomain(subdomain)
+      subdomain = (subdomain || "")
+      subdomain += '.' unless subdomain.empty?
+      [subdomain, request.domain(AccountSubdomain.tld_length), request.port_string].join
+    end
+
+    def url_for(options = nil)
+      if options.kind_of?(Hash) && options.has_key?(:subdomain)
+        options[:host] = with_subdomain(options.delete(:subdomain))
+      end
+      super
+    end
+  end
+end

data/app/models/account_subdomain/account.rb

@@ -0,0 +1,10 @@
+module AccountSubdomain
+  class Account < ActiveRecord::Base
+    validates :subdomain, :presence => true, uniqueness: {message: 'already been taken.'}
+    AccountSubdomain.reflections.each_pair do|key, reflection|
+      reflection.each do|_rel|
+        self.class_eval "#{key} :#{_rel.to_sym}, class_name: '#{_rel.classify.to_sym}'"
+      end
+    end
+  end
+end

data/app/views/account_subdomain/accounts/_form.html.erb

@@ -0,0 +1,21 @@
+<%= form_for(@account) do |f| %>
+  <% if @account.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@account.errors.count, "error") %> prohibited this account from being saved:</h2>
+
+      <ul>
+      <% @account.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :subdomain %><br>
+    <%= f.text_field :subdomain %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/account_subdomain/accounts/index.html.erb

@@ -0,0 +1,25 @@
+<h1>Listing accounts</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Subdomain</th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @accounts.each do |account| %>
+      <tr>
+        <td><%= account.subdomain %></td>
+        <td><%= link_to 'Show', account %></td>
+        <td><%= link_to 'Destroy', account, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Account', new_account_path %>

data/app/views/account_subdomain/accounts/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New account</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', accounts_path %>

data/app/views/account_subdomain/accounts/show.html.erb

@@ -0,0 +1,8 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Subdomain:</strong>
+  <%= @account.subdomain %>
+</p>
+
+<%= link_to 'Back', accounts_path %>

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

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

data/config/routes.rb

@@ -0,0 +1,4 @@
+AccountSubdomain::Engine.routes.draw do
+  resources :accounts, :except => [:edit, :update]
+  root to: 'accounts#new'
+end

data/lib/account_subdomain.rb

@@ -0,0 +1,15 @@
+require "account_subdomain/engine"
+
+module AccountSubdomain
+  mattr_accessor :reflections
+  @@reflections = {}
+
+  mattr_accessor :redirect_path
+  @@redirect_path = '/'
+
+  mattr_accessor :tld_length
+  @@tld_length = 1
+
+  mattr_accessor :action_controller_filters
+  @@action_controller_filters = {}
+end

data/lib/account_subdomain/engine.rb

@@ -0,0 +1,11 @@
+module AccountSubdomain
+  class Engine < ::Rails::Engine
+    isolate_namespace AccountSubdomain
+    initializer  "account_subdomain.load_helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        include AccountSubdomain::AccountsHelper
+        helper AccountSubdomain::Engine.helpers
+      end
+    end
+  end
+end

data/lib/account_subdomain/version.rb

@@ -0,0 +1,3 @@
+module AccountSubdomain
+  VERSION = "0.0.1"
+end

data/lib/generators/account_subdomain/install_generator.rb

@@ -0,0 +1,28 @@
+module AccountSubdomain
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      include Rails::Generators::Migration
+
+      desc "Creates a AccountSubdomain initializer."
+      def copy_initializer
+        template "account_subdomain.rb", "config/initializers/account_subdomain.rb"
+      end
+
+      #desc "Creates a url helper."
+      #def copy_url_helper
+      #  template "url_helper.rb", "app/helpers/url_helper.rb"
+      #end
+
+      def copy_account_subdomain_migration
+        migration_template 'migration.rb', 'db/migrate/create_account_subdomain_accounts.rb'
+      end
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+    end
+  end
+end

data/lib/generators/templates/account_subdomain.rb

@@ -0,0 +1,27 @@
+#Add the relationships in the Account Subdomain models.
+#like if account subdomain has many users
+#you can give that AccountSubdomain.reflections[:has_many] = ['users']
+#You can give an array to each type of relationships.
+#
+#AccountSubdomain supports every type of relationships which rails supports
+AccountSubdomain.reflections[:has_many] = ['users']
+AccountSubdomain.reflections[:has_one] = []
+AccountSubdomain.reflections[:belongs_to] = []
+
+#This setting is used for redirect for invalid subdomain.
+AccountSubdomain.redirect_path = 'account_subdomain_path'
+
+#This setting is for domain tld
+# tdd for
+#example.com => #1
+#example.co.in => #2
+#set it as per your domain name
+AccountSubdomain.tld_length = 1
+
+
+#Settings for filters
+#use case :- You want the https authentication before the access the account subdomain
+#AccountSubdomain.action_controller_filters[:before_filter] = [:validate_http_access_only]
+#
+# Add validate_http_access_only filter in your application.rb
+AccountSubdomain.action_controller_filters[:before_filter] = []