handcart 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27d609f5f8801213d67ddae823d59976c0016abf
+  data.tar.gz: 01bce062c8bee95eb38ecbe931a1c4ce160e663b
+SHA512:
+  metadata.gz: 633fd074412c2d921ab93775d34e00c61602bca5a2655a5c8da97cd2de17f10e4827242310017373fd201a81833993226bc6f75b9ca6507f0a4279bcf03d34ec
+  data.tar.gz: 9c708debf635ce439e11c5358333d9987b40235cc649f6b63fd23949dc3e1d3167696164ade139158018421a67f1d3dced27c8dbfe6b231446246b37bc090639

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Mark Holmberg
+
+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,247 @@
+## Handcart
+
+#### A rails gem for managing subdomains in Ruby on Rails.
+
+### Installation
+
+```ruby
+gem 'handcart'
+```
+
+### Copy Migrations
+
+Handcart requires that you copy over its migrations in the following manner:
+
+```ruby
+rake handcart:install:migrations
+```
+
+### Configuration
+
+Handcart can be configured via an initializer file in the following fashion:
+
+```ruby
+# config/initializers/handcart.rb
+
+Handcart.setup do |config|
+  # You shouldn't need to change this, but the option is available
+  config.subdomain_class = "Handcart::Subdomain"
+
+  # This MUST be set in order for Handcart to work properly.
+  # Set it to the value of the class which will call `acts_as_handcart`
+  config.handcart_class = "Company"
+
+  # This will allow you to prevent certain subdomains from being created
+  config.reserved_subdomains = ["www", "ftp", "ssh", "pop3", "staging", "master"]
+
+  # Set this to provide a custom route to the show action for the model which
+  # invokes the call to `acts_as_handcart`.
+  config.handcart_show_path = "companies"
+
+  # Set the strategy to use for IP Authorization
+  config.ip_authorization_strategy = :inclusion
+
+  # What Rails environments enable IP blocking and blacklisting
+  config.global_ip_blocking_enabled_environments = ["development", "production"]
+
+  # What Rails environments enable IP forwarding and forbidden redirects
+  config.global_ip_forwarding_enabled_environments = ["development", "staging", "production"]
+end
+```
+
+### Handcart Activation
+
+If the thing which `acts_as_handcart` responds to the method `active?`, Handcart will detect that
+and will not match the routing for the subdomain constraints for that handcart until that method returns true.
+This allows your model to require activation before it will actually go live.
+
+### Extended Configuration
+
+Handcart has support for default domain constraints using a JSON configuration file. Place the following
+file inside the `config/` folder of your application:
+
+```ruby
+# config/handcart.json
+
+{
+  "development" : { "domain_constraint" : "dummy.dev" },
+  "test" : { "domain_constraint" : "dummy.test" },
+  "staging" : { "domain_constraint" : "dummy.dev" },
+  "production" : { "domain_constraint" : "dummy.dev" }
+}
+```
+
+You can then use the default constraint provided by this JSON configuration file by doing the following inside your routes
+
+```ruby
+# config/routes.rb
+
+constraints Handcart::DomainConstraint.default_constraint do
+  # My Routes here...
+end
+```
+
+### Advanced Routing Constraints
+
+Handcart provides the ability to configure advanced routing constraints. This will allow you to match
+routes only if certain conditions are met. See the following example:
+
+```ruby
+  constraints(Handcart::Subdomain) do
+    resources :custom_constraints, only: [:index], constraints: Handcart::SettingConstraint.new(:enables?, :custom_constraints)
+    match '/', to: 'subdomain#index', via: [:get], as: :subdomain_root
+  end
+```
+
+The advanced routing constraint show in this example will only match the route `/custom_constraints` if the Handcart (Company) can call
+`enables?(:custom_constraints)` and returns true. This allows you to check to ensure that routes are match on a per Handcart basis.
+
+### Mount the Engine
+
+Handcart needs to be mounted inside the routes file. Add the following line where appropriate:
+
+```ruby
+mount Handcart::Engine => "/handcart"
+```
+
+### Setup Handcart Model
+
+Handcart needs to know what model is the thing that is being subdomained, i.e. a School or a Company.
+
+```ruby
+# app/models/company.rb
+
+class Company < ActiveRecord::Base
+  acts_as_handcart
+end
+```
+
+### Provided Helpers
+
+Handcart gives you a few helper methods which can be used in the controller or views
+
+* current_subdomain
+
+This helper will allow you to fetch the current subdomain (assuming you're on one).
+
+* current_handcart
+
+This helper will allow you to fetch the current thing that is being subdomained. In the case
+of the company model above, current_handcart would return the company.
+
+* handcart_show_path(handcart)
+
+This is a special route generated by Handcart which will allow the backend to link to the
+show page for the thing which `acts_as_handcart`.
+
+If in the configuration for Handcart the `handcart_show_path` was set to "companies", it
+would result in the following URL:
+
+`/companies/:id`
+
+Where ID would be set to the id of the company. If this configuration option is not set, it will
+try to infer it based on the `handcart_class` that is specified.
+
+
+### Routing Helpers
+
+Handcart provides a way to apply domain/subdomain constraints to your routes. The following
+is an example which uses both Domain Constraints and Subdomain Constraints.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  # Allows for a Reserved Subdomain (Master Backend Interface)
+  constraints(subdomain: /master/) do
+    scope module: 'master' do
+      match '/', to: 'dashboard#index', via: [:get], as: :master_root
+    end
+  end
+
+  # Allows for Subdomains created through Handcart (Franchisee Interface)
+  constraints(Handcart::Subdomain) do
+    match '/', to: 'subdomain#index', via: [:get], as: :subdomain_root
+  end
+
+  # Allows for Domain Constraints (Public Interface)
+  constraints Handcart::DomainConstraint.default_constraint do
+    match '/', to: 'public#index', via: [:get], as: :public_root
+  end
+end
+```
+
+### IP Authorization
+
+Handcart provides support for foreign IP authorization using various built-in strategies.
+The IP authorization module provides the following strategies for use when trying to authenticate foreign
+IP addresses:
+
+#### None
+
+If the `config.ip_authorization_strategy` configuration variable is set to `:none`, then no foreign IP
+authorization will occur. This means that any IP address from the outside world will be permitted to
+login to the franchisee interface.
+
+#### Containment
+
+Setting `config.ip_authorization_strategy` to `:containment` will require that the foreign IP address
+is simple included in the list of IP addresses which are allowed for the franchisee.
+
+#### Inclusion
+
+Setting `config.ip_authorization_strategy` to `:inclusion` will require that the foreign IP address
+is included in the list of IP addresses which are allowed for the franchisee AND that the subnet of
+the foreign IP address is also in the same subnet as any which are in the whitelist.
+
+### IP Forwarding
+
+If your application has a public interface, Handcart can be configured to automatically forward
+authorized foreign IP addresses to a controller action of your choosing. In addition, if they are not
+authorized, it will forward them to a *public* controller action of your choosing. To invoke IP forwarding
+the following settings must be configured in the initializer:
+
+```ruby
+  # config/initializers/handcart.rb
+  # What Rails environments enable IP forwarding and forbidden redirects
+  config.global_ip_forwarding_enabled_environments = ["development", "staging", "production"]
+```
+
+Make sure that the environments in which you want IP forwarding to occur in are listed in the variable above.
+
+
+#### Public Controller Invocation
+
+To have Handcart enable IP forwarding, the following method must be invoked in the `PublicController`:
+
+```ruby
+  # app/controllers/public_controller.rb
+  enable_forwarding("subdomain#forwarding", "public#forbidden", only: [:index])
+```
+
+The first argument indicates what controller and action should be invoked inside the franchisee namespace. The second
+argument is the controller and action on the `PublicController` which should be invoked when the foreign IP is NOT authorized.
+
+### IP Blocking
+
+If you want Handcart to enable the IP blocking feature, you'll need to have the following settings in the initializer:
+
+```ruby
+  # What Rails environments enable IP blocking and blacklisting
+  config.global_ip_blocking_enabled_environments = ["development", "production"]
+```
+
+#### Franchisee Controller Invocation
+
+To have Handcart enable IP blocking, the following method must be invoked in a controller which is namespaced under
+the franchisee:
+
+```ruby
+  # app/controllers/sessions_controller.rb
+  enable_blocking("public#forbidden")
+```
+
+The first argument indicates the controller and action which will be redirected to should the IP authorization strategy indicate
+that the foreign IP address is NOT authorized. This method can also accept the standard options such as `only: [:index]`. The use
+case for this method is designed to be the sessions controller for the franchisee. The idea is that it will not let them login to
+the franchise if they're not authorized.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+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    = 'Handcart'
+  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'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+task default: :spec
+
+desc 'Print out all defined routes in match order, with names. Target specific controller with CONTROLLER=x.'
+task routes: :environment do
+  all_routes = Rails.application.routes.routes
+  require 'action_dispatch/routing/inspector'
+  inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+  puts inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, ENV['CONTROLLER'])
+end

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

@@ -0,0 +1,16 @@
+// 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 jquery
+//= require jquery_ujs
+//= require twitter/bootstrap
+//= require_tree .

data/app/assets/stylesheets/handcart/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 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 twitter-bootstrap-static/bootstrap
+ *=require twitter-bootstrap-static/fontawesome
+ *= require_tree .
+ */

data/app/assets/stylesheets/handcart/layout.css.scss

@@ -0,0 +1,21 @@
+footer p {
+  margin-top: 1em;
+  text-align: center;
+}
+
+td.action-button {
+  width: 2em;
+}
+
+.page-header {
+  margin-bottom: 1em !important;
+}
+
+#button-toolbar {
+  margin-bottom: 2em;
+}
+
+.navbar-inverse .nav .active>a, .navbar-inverse .nav .active>a:hover, .navbar-inverse .nav .active>a:focus {
+  color: #FFFFFF;
+  background-color: #424242;
+}

data/app/controllers/handcart/application_controller.rb

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

data/app/controllers/handcart/ip_addresses_controller.rb

@@ -0,0 +1,56 @@
+require_dependency "handcart/application_controller"
+
+module Handcart
+  class IpAddressesController < ApplicationController
+    before_action :set_ip_address, only: [:show, :edit, :update, :destroy]
+
+    def index
+      @ip_addresses = IpAddress.all
+    end
+
+    def show
+    end
+
+    def new
+      @ip_address = IpAddress.new
+    end
+
+    def edit
+    end
+
+    def create
+      @ip_address = IpAddress.new(safe_params)
+
+      if @ip_address.save
+        redirect_to @ip_address, notice: 'Ip address was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    def update
+      if @ip_address.update(safe_params)
+        redirect_to @ip_address, notice: 'Ip address was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @ip_address.destroy
+      redirect_to ip_addresses_url, notice: 'Ip address was successfully removed.'
+    end
+
+    private
+
+    def set_ip_address
+      @ip_address = IpAddress.find(params[:id])
+    end
+
+    def safe_params
+      safe_attributes = [:address, :subnet_mask, :handcart_id, :blacklisted]
+      params.require(:ip_address).permit(safe_attributes)
+    end
+
+  end
+end

data/app/controllers/handcart/subdomains_controller.rb

@@ -0,0 +1,55 @@
+require_dependency "handcart/application_controller"
+
+module Handcart
+  class SubdomainsController < ApplicationController
+    before_action :set_subdomain, only: [:show, :edit, :update, :destroy]
+
+    def index
+      @subdomains = Subdomain.all
+    end
+
+    def show
+    end
+
+    def new
+      @subdomain = Subdomain.new
+    end
+
+    def edit
+    end
+
+    def create
+      @subdomain = Subdomain.new(safe_params)
+
+      if @subdomain.save
+        redirect_to subdomains_url, notice: 'Subdomain was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    def update
+      if @subdomain.update(safe_params)
+        redirect_to subdomains_url, notice: 'Subdomain was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @subdomain.destroy
+      redirect_to subdomains_url, notice: 'Subdomain was successfully destroyed.'
+    end
+
+    private
+
+    def set_subdomain
+      @subdomain = Subdomain.find(params[:id])
+    end
+
+    def safe_params
+      safe_attributes = [:name]
+      params.require(:subdomain).permit(safe_attributes)
+    end
+  end
+end