RubyGems - hackathon_manager - Versions diffs - 0.1.0 - Mend

hackathon_manager 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (205) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b629f9fbc6de4475abdcae57d3249f940073f93
+  data.tar.gz: cfa43250214ba8b096fc81d63cbf52fddd2f49b8
+SHA512:
+  metadata.gz: 47a1c3daf4157814e45ee0a59c8c46367862d88fe9b5db918f46e41f2bb2ebf8152da0d260ac60539d7e5769a4a17448ed345856fa8b64f34dc62e1593790678
+  data.tar.gz: 023a806098e9254409b4757d2cf6290fd69afe72226e31f0dbe4a893dfe949cc1303d702eee7b02f4951134f8030db313afe32a5924fc436593efaa834e40dcc

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2017 Stuart Olivera
+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 ADDED Viewed

@@ -0,0 +1,90 @@
+# HackathonManager [![Build Status](https://travis-ci.org/codeRIT/hackathon_manager.svg?branch=master)](https://travis-ci.org/codeRIT/hackathon_manager) [![Code Climate](https://codeclimate.com/github/codeRIT/hackathon_manager/badges/gpa.svg)](https://codeclimate.com/github/codeRIT/hackathon_manager) [![Test Coverage](https://codeclimate.com/github/codeRIT/hackathon_manager/badges/coverage.svg)](https://codeclimate.com/github/codeRIT/hackathon_manager/coverage) [![security](https://hakiri.io/github/codeRIT/hackathon_manager/master.svg)](https://hakiri.io/github/codeRIT/hackathon_manager/master)
+***Still a work in progress! Instructions below are incomplete.** Check out [WiCHacks](https://github.com/sman591/wichacks) for an implementation example.*
+Originally developed for [BrickHack](https://github.com/codeRIT/brickhack.io), this is a Ruby on Rails "plugin" that adds typical hackathon management features to any existing Ruby on Rails application.
+* **Hacker applications:** Users sign up/in using [MyMLH](https://my.mlh.io/), which includes standard hackathon application info. This pre-fills the BrickHack application, so hackers don't have to duplicate information!
+* **Acceptance, RSVPs**: Manage applications & coordinate acceptance/waitlist/denials
+* **Bus Lists:** Coordinate bus sign-ups during the RSVP process while communicating important information to riders & captains
+* **Email communication**: Ensure hackers get consistent, timely information throughout their application process, while enabling the organizing team to communicate important information at any time.
+* **Statistics & Visualization:** Surface key information about the application base, distribution of applicants, progress towards attendance, etc.
+## Usage
+HackathonManager uses a variety of third-party services & Ruby gems:
+* [Devise](https://github.com/plataformatec/devise) + [MyMLH](https://my.mlh.io/) (authentication & attendee identity)
+* [Sidekiq](https://github.com/mperham/sidekiq) (background jobs)
+* [Sparkpost](https://www.sparkpost.com/) (email)
+* [Paperclip](https://github.com/thoughtbot/paperclip) + [Amazon S3](https://aws.amazon.com/s3/) (resume storage)
+* [Chartkick](http://chartkick.com/) (management charts)
+Steps to get the basic flow working:
+1. Add an "apply" or "register" button on your hackathon homepage. This button directs the user through a sign up/login flow to collect their information.
+```erb
+<%= link_to 'Click here to apply!'.html_safe, questionnaires_path %>
+```
+2. Once you have at least one user in the system, you can promote them to an admin to access the management interface. Open up a console session with `bin/rails console`:
+```ruby
+>> User.last.update_attribute(:admin, true)
+=> true
+```
+3. You can then access the management interface from `http://your-site/manage`
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'hackathon_manager'
+```
+And then execute:
+```bash
+$ bundle
+```
+Now, add our database migrations:
+```bash
+$ bin/rails railties:install:migrations
+```
+And finally, create the file `config/hackathon.yml`:
+```yaml
+defaults: &defaults
+  registration_is_open: true
+  event_is_over: false
+  last_day_to_apply: <%= Date.new(2017, 2, 11) %>
+  auto_late_waitlist: false
+  logo_asset: logo.png
+development:
+  <<: *defaults
+test: &test
+  <<: *defaults
+  last_day_to_apply: <%= 2.months.from_now %>
+production:
+  <<: *defaults
+staging:
+  <<: *defaults
+```
+## Contributing
+GitHub issues and pull requests welcome!
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+# IMPORTANT
+* Set a `root to:` (root path)

data/Rakefile ADDED Viewed

@@ -0,0 +1,36 @@
+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    = 'HackathonManager'
+  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'
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test

data/app/assets/config/hackathon_manager_manifest.js ADDED Viewed

File without changes

data/app/assets/javascripts/hackathon_manager/application.js ADDED Viewed

@@ -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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require jquery.ui.autocomplete
+//= require_directory .

data/app/assets/javascripts/hackathon_manager/jquery.transit.min.js ADDED Viewed

@@ -0,0 +1 @@

data/app/assets/javascripts/hackathon_manager/main.js ADDED Viewed

@@ -0,0 +1,237 @@
+$(document).ready(function () {
+  var $sidebar = $('.sidebar');
+  if ($('.carousel').length > 0) {
+    $('.maps.carousel').owlCarousel({
+      items: 3,
+      singleItem: true
+    });
+    $('.support.carousel').owlCarousel({
+      singleItem: true
+    });
+    $('.mentor-list.carousel').owlCarousel({
+      singleItem: true
+    });
+  }
+  if ( $sidebar.hasClass('home') ) {
+    $('.nav-link, .scroll-to').on('click', function (e) {
+      e.preventDefault();
+      $('.active').removeClass('active');
+      $(e.currentTarget).addClass('active');
+      var id = $(e.currentTarget).attr('href');
+      id = id.substring(1);
+      var $target = $(id);
+      $target.addClass('active');
+      $('html,body').animate({
+        scrollTop: ($target.offset().top)
+      }, 1000);
+    });
+  }
+  $('#sidebar-toggle').on('click', toggleSidebar);
+  function toggleSidebar (e) {
+    if ($sidebar.hasClass('open')) {
+      $('#main').off('click', toggleSidebar);
+      $sidebar.removeClass('open');
+    }
+    else {
+      $('#main').on('click', toggleSidebar);
+      $sidebar.addClass('open');
+    }
+  }
+  $.fn.toggleDetails = function() {
+    var toggle = function() {
+      $('.details').slideUp();
+      $(this).parent().find('.details:hidden').slideDown();
+    };
+    $(this).each(function() {
+      $(this).on('click', toggle);
+    });
+  };
+  $('.toggle-details').toggleDetails();
+  $.fn.toggleBlock = function() {
+    var toggle = function() {
+      var $this = $(this);
+      $('.info').slideUp();
+      $('#' + $this.data('target') + ':hidden').slideDown();
+    };
+    $(this).each(function() {
+      $(this).on('click', toggle);
+    });
+  };
+  $('.block .name').toggleBlock();
+  $('[name="questionnaire[travel_not_from_school]"]').on('change', function() {
+    var $location = $('[name="questionnaire[travel_location]"]');
+    if (this.value === "true") {
+      $location.parent().show();
+      $location.prop('disabled', false);
+    }
+    else {
+      $location.parent().hide();
+      $location.prop('disabled', true);
+    }
+  });
+  $('[name="questionnaire[acc_status]"]').on('change', function() {
+    var $content = $('.hide-if-not-attending');
+    if ($(this).val() == 'rsvp_denied') {
+      $content.hide();
+    }
+    else {
+      $content.show();
+    }
+  });
+  $.fn.validate = function(option) {
+    var previous_invalid_inputs = [];
+    var validateInput = function() {
+      var success = true, types = $(this).data('validate').split(/[ ,]+/), value = $(this).val();
+      if ($(this).is(':checkbox') && !$(this).is(':checked')) {
+        value = "";
+      }
+      if ($(this).is(':disabled')) {
+        return true;
+      }
+      for (i = types.length-1; i >= 0; i--) {
+        switch (types[i]) {
+          case 'presence':
+            if (!value || $.trim(value).length < 1) {
+              notify(this, "Missing Information");
+              success = false;
+            }
+          break;
+          case 'email':
+            if (value) {
+              var re = /^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+              if (!re.test(value)) {
+                notify(this, "Invalid Email");
+                success = false;
+              }
+            }
+          break;
+          case 'file-max-size':
+            if (this.files && this.files[0] && this.files[0].size > parseInt($(this).data('validate-file-max-size'))) {
+              notify(this, "File Too Large");
+              success = false;
+            }
+          break;
+          case 'file-content-type':
+            if (this.files && this.files[0] && this.files[0].type != $(this).data('validate-file-content-type')) {
+              notify(this, "Invalid File Type");
+              success = false;
+            }
+          break;
+        }
+      }
+      if (success) {
+        $(this).parent().removeClass('field_with_errors').find('.error').fadeOut(200, function() {
+          $(this).remove();
+        });
+      }
+      return success;
+    };
+    var validateAll = function() {
+      var success = true, invalid_inputs = [], first_input;
+      $(this).find('[data-validate]').each(function(i) {
+        if (!validateInput.call(this)) {
+          success = false;
+          invalid_inputs.push(i);
+          if (!first_input || $(this).is(':focus')) {
+            first_input = this;
+          }
+        }
+      });
+      if (invalid_inputs.length > 0 && $(invalid_inputs).not(previous_invalid_inputs).length == 0 && $(previous_invalid_inputs).not(invalid_inputs).length == 0) {
+        $(this).find('[data-validate]').each(function() {
+          $(this).parent().find('.error').fadeOut(50).fadeIn(100);
+        });
+      }
+      if (first_input) {
+        $(first_input).focus();
+      }
+      previous_invalid_inputs = invalid_inputs;
+      return success;
+    };
+    var notify = function(input, message) {
+      var $element = $(input).parent().find('.error');
+      if ($element.length < 1)  {
+        $element = $('<span class="error"></span>').hide().insertAfter(input);
+      }
+      $element.text(message);
+      $element.fadeIn(100);
+      $element.parent().addClass('field_with_errors');
+    };
+    if (option == 'now') {
+      return validateAll.call(this);
+    }
+    else {
+      $(this).on('submit', function() {
+        $(this).find('[type=submit]').prop('disabled', true);
+        if (!validateAll.call(this)) {
+          $(this).find('[type=submit]').prop('disabled', false);
+          return false;
+        }
+        return true;
+      });
+      $(this).find('[data-validate]').each(function() {
+        $(this).on('blur', validateInput);
+      });
+    }
+  };
+  $('[data-validate=form]').validate();
+  $.fn.wizard = function() {
+    var form = this;
+    var goToStage = function($newStage) {
+      $(form).find('.wizard-current').removeClass('wizard-current');
+      $newStage.addClass('wizard-current');
+      $("html, body").animate({ scrollTop: 0 }, "slow");
+      if ($newStage.find('.field_with_errors').length > 0) {
+        $newStage.find(".field_with_errors").first().find(":input").focus();
+      } else {
+        $newStage.find(":input").first().focus();
+      }
+    }
+    var nextStage = function() {
+      if (!$(form).find('.wizard-current').validate('now')) {
+        return false;
+      }
+      goToStage($(form).find('.wizard-current').next());
+    };
+    var previousStage = function() {
+      goToStage($(form).find('.wizard-current').prev());
+    };
+    if ($(form).find('.field_with_errors').length > 0) {
+      goToStage($(form).find('.field_with_errors').first().parents('.wizard-stage'));
+    }
+    $(this).find('[data-wizard=next]').each(function() {
+      $(this).on('click', nextStage);
+    });
+    $(this).find('[data-wizard=previous]').each(function() {
+      $(this).on('click', previousStage);
+    });
+    if ($(this).is('.wizard-skip-valid')) {
+      nextStage.call(this);
+    }
+  };
+  $('.wizard').wizard();
+});

data/app/assets/javascripts/hackathon_manager/manage/application.js ADDED Viewed

@@ -0,0 +1,20 @@
+//= require_directory ../
+//= require_directory .
+//= require ../vendor/jquery.dataTables.min
+//= require ../vendor/dataTables.buttons.min
+//= require ../vendor/buttons.html5.min
+//= require ../vendor/pdfmake.min
+//= require ../vendor/vfs_fonts
+//= require selectize
+//= require highcharts
+//= require chartkick
+//= require_directory ./lib
+$(document).ready(function () {
+  $('.selectize').selectize();
+  $('select[data-bulk-row-edit]').bulkRowEdit();
+  $().bulkRowSelect();
+  $('body').chartkickAutoReload();
+  setupDataTables();
+  setupHighcharts();
+});

data/app/assets/javascripts/hackathon_manager/manage/lib/emailEvents.js ADDED Viewed

@@ -0,0 +1,25 @@
+$(document).ready(function () {
+  $('.email-events').each(function() {
+    var events_container = this;
+    $(events_container).html('<span class="fa fa-circle-o-notch fa-spin"></span>');
+    var data_url = $(events_container).data('url');
+    $.ajax(data_url)
+      .done(function(json) {
+        if (!json.length) {
+          $(events_container).html('<em>No events found.</em>');
+          return;
+        }
+        var $new_html = $('<ul>');
+        $(json).each(function(_, event) {
+          $new_html.append('<li><p>' + event.subject + ' : <strong>' + event.type + '</strong><br><em>' + event.timestamp + '</em></p></li>');
+        });
+        $(events_container).html($new_html);
+      })
+      .fail(function() {
+        $(events_container).html('<em>An error ocurred. Please try again later.</em>');
+      });
+  });
+});

data/app/assets/javascripts/hackathon_manager/manage/lib/jquery.bulkRowSelect.js ADDED Viewed

@@ -0,0 +1,13 @@
+$.fn.bulkRowSelect = function() {
+  var applyAction = function() {
+    var checkState = $('[data-bulk-row-select]').prop('checked');
+    $('input[type=checkbox][data-bulk-row-edit]').prop('checked', checkState);
+    return true;
+  };
+  $('[data-bulk-row-select]').on('click', function(e) {
+    return applyAction();
+  });
+};

data/app/assets/javascripts/hackathon_manager/manage/lib/jquery.bulkRowedit.js ADDED Viewed

@@ -0,0 +1,42 @@
+$.fn.bulkRowEdit = function() {
+  var applyAction = function() {
+    $('[type=submit][data-bulk-row-edit]').prop('disabled', true);
+    var ids = [];
+    $('input[type=checkbox][data-bulk-row-edit]:checked').each(function() {
+      ids[ids.length] = $(this).data('bulk-row-edit');
+    });
+    var action = $('select[data-bulk-row-edit]').val();
+    if (ids.length == 0) {
+      alert('No rows are selected to be modified!');
+      $('[type=submit][data-bulk-row-edit]').prop('disabled', false);
+      return false;
+    }
+    $.ajax({
+      url: $('form[data-bulk-row-edit]').attr('action'),
+      type: 'PATCH',
+      data: {
+        bulk_action: action,
+        bulk_ids: ids
+      }
+    }).done(function() {
+      window.questionnairesDataTable.draw(false);
+    }).fail(function() {
+      alert("Request failed, please refresh the page or try again later.");
+    }).always(function() {
+      $('[type=submit][data-bulk-row-edit]').prop('disabled', false);
+    });
+    return true;
+  };
+  $('[type=submit][data-bulk-row-edit]').on('click', function(e) {
+    e.preventDefault();
+    return applyAction();
+  });
+};

data/app/assets/javascripts/hackathon_manager/manage/lib/jquery.chartkickAutoReload.js ADDED Viewed

@@ -0,0 +1,8 @@
+$.fn.chartkickAutoReload = function() {
+  var reloadData = function() {
+    for (i in Chartkick.charts) {
+      eval($(Chartkick.charts[i].element).next("script").text());
+    }
+  };
+  setInterval(reloadData, 15000);
+};

data/app/assets/javascripts/hackathon_manager/manage/lib/setupDataTables.js ADDED Viewed

@@ -0,0 +1,98 @@
+var setupDataTables = function() {
+  var defaultDataTableOptions = function() {
+    return {
+      dom: 'Bfrtip',
+      processing : true,
+      serverSide : true,
+      ajax       : {
+        url   : $(this).data('source'),
+        type  : "POST"
+      },
+      pagingType : 'full_numbers',
+      lengthMenu: [
+        [ 10, 25, 50, 100, -1 ],
+        [ '10 rows', '25 rows', '50 rows', '100 rows', 'Show all' ]
+      ],
+      buttons: [
+        'pageLength',
+        {
+          extend: 'collection',
+          text: 'Export',
+          buttons: [
+            'csvHtml5',
+            'pdfHtml5'
+          ]
+        }
+      ]
+    }
+  };
+  var setupDataTable = function($table, options) {
+    var lastTable;
+    $table.each(function() {
+      lastTable = $(this).DataTable($.extend(defaultDataTableOptions.call(this), options));
+    });
+    return lastTable;
+  };
+  window.questionnairesDataTable = setupDataTable($('.datatable.questionnaires'), {
+    order      : [2, 'desc'],
+    scrollX    : false,
+    columns    : [
+      { orderable : false, data: 'bulk' },
+      { orderable : false, data: 'link' },
+      { orderable: true, data: 'id' },
+      { orderable: true, data: 'first_name' },
+      { orderable: true, data: 'last_name' },
+      { orderable: true, data: 'email' },
+      { orderable: true, data: 'acc_status' },
+      { orderable: true, data: 'checked_in' },
+      { orderable: true, data: 'school' }
+    ]
+  });
+  setupDataTable($('.datatable.users'), {
+    order      : [1, 'asc'],
+    scrollX    : false,
+    columns    : [
+      { orderable: false, data: 'link' },
+      { orderable: true, data: 'id' },
+      { orderable: true, data: 'email' },
+      { orderable: true, data: 'admin_limited_access' }
+    ]
+  });
+  setupDataTable($('.datatable.messages'), {
+    order      : [1, 'desc'],
+    scrollX    : false,
+    columns    : [
+      { orderable: false, data: 'link'},
+      { orderable: true, data: 'id'},
+      { orderable: true, data: 'name'},
+      { orderable: true, data: 'subject'},
+      { orderable: false, data: 'status'}
+    ]
+  });
+  setupDataTable($('.datatable.schools'), {
+    order      : [5, 'desc'],
+    scrollX    : false,
+    columns    : [
+      { orderable: false, data: 'link' },
+      { orderable: true, data: 'id' },
+      { orderable: true, data: 'name' },
+      { orderable: true, data: 'city' },
+      { orderable: true, data: 'state' },
+      { orderable: true, data: 'questionnaire_count' },
+      { orderable: false, data: 'bus_list' }
+    ]
+  });
+  setupDataTable($('.datatable.stats'), {
+    scrollX    : false,
+    processing : false,
+    serverSide : false
+  });
+};

data/app/assets/javascripts/hackathon_manager/manage/lib/setupHighcharts.js ADDED Viewed

@@ -0,0 +1,34 @@
+var setupHighcharts = function() {
+  Highcharts.setOptions({
+    global: {
+      timezoneOffset: 5 * 60,
+      useUTC: false
+    },
+    legend: {
+       labelFormatter: function() {
+          var total = 0;
+          for(var i=this.yData.length; i--;) { total += this.yData[i]; };
+          return this.name + ': ' + total;
+       }
+    },
+    chart: {
+      backgroundColor: "#f0f0f0"
+    },
+    tooltip: {
+      shared: true
+    },
+    plotOptions: {
+      series: {
+        animation: false
+      },
+      pie: {
+        allowPointSelect: true,
+        cursor: 'pointer',
+        dataLabels: {
+          enabled: true,
+          format: '<b>{point.name}</b>: {point.y}'
+        }
+      }
+    }
+  });
+};