pairer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8774463f2c0328260af7daf81b8c36eb0f019c841777e163fcb59ca7e799ba0
+  data.tar.gz: fdbffea2f68177d3b6d74ae71a6fd32e1a7a967118a624296091d9f1a105f0ca
+SHA512:
+  metadata.gz: 3f39555a2253f14613bee72894a8b96ed255d9d482daeb5e713099c0fa13bdb6038780c206235ae93d819b987fa8eaa8b86258346c90789aaf8f4a9448771704
+  data.tar.gz: cb2d36c125a60124159a8ed48835b92e52554fa2e253817b5a60edb19535b4e2a164616c7f42454174a884d3feb0bbf51810c6aa7d2c909597d076fa7f90c4f0

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Weston Ganger
+
+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,134 @@
+# Pairer
+
+<a href='https://github.com/westonganger/pairer/actions' target='_blank'><img src="https://github.com/westonganger/pairer/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
+
+Pairer is a Rails app/engine to help you to easily generate and rotate pairs within a larger group. For example its great for pair programming teams where you want to work with someone new everyday.
+
+Each organization has many boards. Within each board you can create people and roles. The tool will allow for both automated and manual assignments of these resources to working groups within the board.
+
+![Screenshot](/screenshot.png)
+
+## Setup
+
+Developed as a Rails engine. So you can add to any existing app or create a brand new app with the functionality.
+
+```ruby
+### Gemfile
+gem 'pairer'
+```
+
+
+#### Option A: Mount to a path
+
+```ruby
+### config/routes.rb
+
+### As sub-path
+mount Pairer::Engine, at: "/pairer", as: "pairer"
+
+### OR as root-path
+mount Pairer::Engine, at: "/", as: "pairer"
+```
+
+#### Option B: Mount as a subdomain
+
+```ruby
+### config/routes.rb
+
+pairer_subdomain = "pairer"
+
+mount Pairer::Engine,
+  at: "/", as: "pairer",
+  constraints: Proc.new{|request| request.subdomain == pairer_subdomain }
+
+not_engine = Proc.new{|request| request.subdomain != pairer_subdomain }
+
+constraints not_engine do
+  # your app routes here...
+end
+```
+
+### Configuration Options
+
+```ruby
+### config/initializers/pairer.rb
+
+Pairer.config do |config|
+  config.hash_id_salt = "Fy@%p0L^$Je6Ybc9uAjNU&T@" ### Dont lose this, this is used to generate public_ids for your records using hash_ids gem
+
+  config.allowed_org_ids = ["example-org", "other-example-org"]
+  ### OR something more secure, for example
+  config.allowed_org_ids = ["pXtHe7YUW0@Wo$H3V*s6l4N5"]
+
+  config.max_iterations_to_track = 100 # Defaults to 100
+end
+```
+
+## How Authentication Works
+
+Authentication models is as follows:
+
+1. Your main app defines a list of `Pairer.config.allowed_org_ids`. When an unauthenticated user visits the site they are taken to the sign-in page. On this page they are required to enter an "Organization ID" if they enter one of the `Pairer.config.allowed_org_ids` then they are signed-in to pairer and all boards will be scoped accordingly.
+
+2. After the user is signed-in via #1 above, then the user can either A. access existing board by entering the boards password, or B. create a new board by defining a board password.
+
+3. Since the authentication model is loose by design, it is strongly recommended that you add the gem `rack-attack` to your main application and configure it to prevent brute force attacks from unauthorized attackers
+
+```ruby
+### Gemfile
+gem "rack-attack"
+```
+
+```ruby
+### config/initializers/pairer.rb
+
+Rack::Attack.throttle('limit unauthorized non-get requests', limit: 5, period: 1.minute) do |req|
+  if req.get?
+    subdomain = req.host.split('.').first
+    site_is_pairer = subdomain&.casecmp?("pairer") ### Replace this with whatever logic is applicable to your app
+
+    if site_is_pairer && !Pairer.config.allowed_org_ids.include?(req.session[:pairer_current_org_id])
+      ### Not signed-in to Pairer
+      req.ip
+    end
+  end
+end
+```
+
+## Configuring Exception Handling
+
+If you want to add exception handling/notifications you can easily just add the behaviour directly to pairers application controller and do your custom exception handling logic. For example:
+
+```ruby
+Pairer::ApplicationController.class_eval do
+  rescue_from Exception do |exception|
+    ExceptionNotifier.notify_exception(exception)
+    render plain: "System error", status: 500
+  end
+end
+```
+
+## Development
+
+Run migrations using: `rails db:migrate`
+
+Run server using: `bin/dev` or `cd test/dummy/; rails s`
+
+## Testing
+
+```
+bundle exec rspec
+```
+
+We can locally test different versions of Rails using `ENV['RAILS_VERSION']` and different database gems using `ENV['DB_GEM']`
+
+```
+export RAILS_VERSION=7.0
+export DB_GEM=sqlite3
+bundle install
+bundle exec rspec
+```
+
+# Credits
+
+Created & Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task test: [:spec]
+
+task default: [:spec]

data/app/assets/config/pairer_manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images/pairer
+//= link_directory ../stylesheets/pairer .css
+//= link_directory ../javascripts/pairer .js

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

@@ -0,0 +1,47 @@
+//= require rails-ujs
+//= require bootstrap-sprockets
+
+window.init = function(){
+  $('form').attr('autocomplete', 'off');
+
+  var alerts = $(".alert:not(.permanent)")
+  setTimeout(function(){
+    alerts.fadeOut();
+  }, 8000);
+}
+
+$(function(){
+  window.init();
+});
+
+function equals(obj1, obj2){
+  if((obj1 == null || typeof obj1 != 'object') || (obj2 == null || typeof obj2 != 'object')){
+    return obj1 == obj2;
+  }
+
+  for(var propName in obj1){
+    if(obj1.hasOwnProperty(propName) != obj2.hasOwnProperty(propName)){
+      return false;
+    }else if(typeof obj1[propName] != typeof obj2[propName]){
+      return false;
+    }
+  }
+  for(var propName in obj2){
+    var val = obj1[propName];
+    var other = obj2[propName];
+    if(obj1.hasOwnProperty(propName) != obj2.hasOwnProperty(propName)){
+      return false;
+    }else if(typeof val != typeof other){
+      return false;
+    }
+
+    if(!obj1.hasOwnProperty(propName)){
+      continue;
+    }
+
+    if(!equals(val, other)){
+      return false;
+    }
+  }
+  return true;
+};

data/app/assets/stylesheets/pairer/application.scss

@@ -0,0 +1,82 @@
+/*
+ *= require ./utility
+ *= require_self
+ */
+
+$my-navbar-height: 3.5em;
+
+@import "bootswatch/united/variables";
+
+$grid-float-breakpoint: 992px; // collapse for xs and sm devices */
+
+@import "bootstrap-sprockets";
+@import "bootstrap";
+@import "bootswatch/united/bootswatch";
+
+.badge-danger{
+  background-color: $brand-danger !important;
+  color: white !important;
+}
+
+.navbar{
+  font-size: 1.1em;
+  min-height: $my-navbar-height;
+
+  .navbar-brand{
+    font-size: 1.5em;
+    font-family: monospace;
+    padding: 8px 15px; 
+    &:hover{
+      color: initial;
+    }
+  }
+
+  .navbar-nav li a, .navbar-brand{
+    line-height: $my-navbar-height/2;
+  }
+}
+
+
+.alert{
+  .close{
+    opacity: 0.6;
+    &:hover{
+      opacity: 0.8;
+    }
+  }
+}
+
+h1, h2, h3, h4, h5{
+  color: #424242;
+}
+
+body{
+  background-color: #F5F6F6;
+  padding-top: 80px;
+  padding-bottom: 20px;
+}
+
+label{
+  margin-right: 10px;
+}
+
+footer{
+  position: fixed;
+  text-align: center;
+  bottom: 10px;
+  right: 0;
+  left: 0;
+}
+
+.btn-default{
+  border-color: gray;
+  background-color: gray;
+  background-image: none;
+}
+
+@media(max-width: 768px){
+  .form-inline .form-control{
+    display: inline-block;
+    width: initial;
+  }
+}

data/app/assets/stylesheets/pairer/utility.scss

@@ -0,0 +1,221 @@
+.no-gutter{
+  padding:0 !important;
+}
+.bold{
+  font-weight:bold !important;
+}
+.no-bold{
+  font-weight:400 !important;
+}
+.italic{
+  font-style: italic !important;
+}
+.underline{
+  text-decoration:underline !important;
+}
+.space-left{
+  margin-left:5px !important;
+}
+.space-left2{
+  margin-left:10px !important;
+}
+.space-left3{
+  margin-left:15px !important;
+}
+.space-left4{
+  margin-left:20px !important;
+}
+.space-left5{
+  margin-left:30px !important;
+}
+.space-right{
+  margin-right:5px !important;
+}
+.space-right2{
+  margin-right:10px !important;
+}
+.space-right3{
+  margin-right:15px !important;
+}
+.space-right4{
+  margin-right:20px !important;
+}
+.space-right5{
+  margin-right:30px !important;
+}
+.space-above{
+  margin-top:5px !important;
+}
+.space-above2{
+  margin-top:10px !important;
+}
+.space-above3{
+  margin-top:20px !important;
+}
+.space-above4{
+  margin-top:30px !important;
+}
+.space-above5{
+  margin-top:40px !important;
+}
+.space-below{
+  margin-bottom:5px !important;
+}
+.space-below2{
+  margin-bottom:10px !important;
+}
+.space-below3{
+  margin-bottom:15px !important;
+}
+.space-below4{
+  margin-bottom:20px !important;
+}
+.space-below5{
+  margin-bottom:30px !important;
+}
+.width-100{
+  width:100%;
+}
+.width-90{
+  width: 90%;
+}
+.table-text-center{
+  th td{
+    text-align:center !important;
+  }
+}
+.display-table{
+  height:130px;
+  display:table;
+  
+  .vertical-align{
+    display:table-cell;
+    vertical-align:middle;
+  }
+}
+/*
+.visible-xs,
+.visible-sm,
+.visible-md,
+.visible-lg {
+  display: none !important;
+}
+
+.visible-xs {
+  @media (max-width: 767px) {
+    display: block !important;
+    table{
+      display: table !important; 
+    }
+    tr{ 
+      display: table-row !important;
+    }
+    th, td{ 
+      display: table-cell !important;
+    }
+    i, abbr, cite, code, strong, a, br, img, span, sub, button, input, label, select, textarea{
+      display: inline !important;
+    }
+  }
+}
+
+.visible-sm {
+  @media (min-width: 768px) and (max-width: 991px) {
+    display: block !important;
+    table{
+      display: table !important; 
+    }
+    tr{ 
+      display: table-row !important;
+    }
+    th, td{ 
+      display: table-cell !important;
+    }
+    i, abbr, cite, code, strong, a, br, img, span, sub, button, input, label, select, textarea{
+      display: inline !important;
+    }
+  }
+}
+
+.visible-md {
+  @media (min-width: 992px) and (max-width: 1199px) {
+    display: block !important;
+    table{
+      display: table !important; 
+    }
+    tr{ 
+      display: table-row !important;
+    }
+    th, td{ 
+      display: table-cell !important;
+    }
+    i, abbr, cite, code, strong, a, br, img, span, sub, button, input, label, select, textarea{
+      display: inline !important;
+    }
+  }
+}
+
+.visible-lg {
+  @media (min-width: 1200px) {
+    display: block !important;
+    table{
+      display: table !important; 
+    }
+    tr{ 
+      display: table-row !important;
+    }
+    th, td{ 
+      display: table-cell !important;
+    }
+    i, abbr, cite, code, strong, a, br, img, span, sub, button, input, label, select, textarea{
+      display: inline !important;
+    }
+  }
+}
+
+.hidden-xs {
+  @media (max-width: 767px) {
+    display: none !important;
+  }
+}
+.hidden-sm {
+  @media (min-width: 768px) and (max-width: 991px) {
+    display: none !important;
+  }
+}
+.hidden-md {
+  @media (min-width: 992px) and (max-width: 1199px) {
+    display: none !important;
+  }
+}
+.hidden-lg {
+  @media (min-width: 1200px) {
+    display: none !important;
+  }
+}
+.visible-print {
+  display: none !important;
+
+  @media print {
+    display: block !important;
+    table{
+      display: table !important; 
+    }
+    tr{ 
+      display: table-row !important;
+    }
+    th, td{ 
+      display: table-cell !important;
+    }
+    i, abbr, cite, code, strong, a, br, img, span, sub, button, input, label, select, textarea{
+      display: inline !important;
+    }
+  }
+}
+
+.hidden-print {
+  @media print {
+    display: none !important;
+  }
+}
+*/

data/app/controllers/pairer/application_controller.rb

@@ -0,0 +1,31 @@
+module Pairer
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    helper_method :signed_in?
+
+    def robots
+      str = <<~STR
+        User-agent: *
+        Disallow: /
+      STR
+
+      render plain: str, layout: false, content_type: 'text/plain'
+    end
+
+    def render_404
+      if request.format.html?
+        render "pairer/exceptions/show", status: 404
+      else
+        render plain: "404 Not Found", status: 404
+      end
+    end
+
+    def signed_in?
+      if session[:pairer_current_org_id].present?
+        Pairer.config.allowed_org_ids.collect(&:downcase).include?(session[:pairer_current_org_id].downcase)
+      end
+    end
+
+  end
+end