my_banner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27e190c7c040b7c94533087b3d9aa277ddb121c9e0b46e3ff8f87bdba337b171
+  data.tar.gz: 01dfd9ce9c4cb0d6fce7b7ba0429b52d095192c4fb56c2da394c65fb33f90846
+SHA512:
+  metadata.gz: 286d1e2eec0726782cae619733819dad4aa93d0fe91badf5609f52555034fc19300a37b0dbfad646a8377b5456bfbac0713ff58139a27be783279b98c3732252
+  data.tar.gz: 7d12acd837e7bee876e2d66aad85238eb4ca9c02634860283151c7b3350d4772d02430372a54292f47d233813fcebd13dd2197205f536f6b43b030104e927be2

data/.codeclimate.yml

@@ -0,0 +1,12 @@
+plugins:
+  rubocop:
+    enabled: false
+    checks:
+        #Rubocop/Metrics/ClassLength:
+        #  enabled: false
+        Rubocop/Style/StringLiterals:
+          enabled: false
+        Rubocop/Layout/LeadingCommentSpace:
+          enabled: false
+        Rubocop/Layout/EmptyLinesAroundClassBody:
+          enabled: false

data/.gitignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# test coverage
+coverage
+
+# roster pages and schedule pages, which can contain PII
+pages/*.html
+
+# google auth credentials
+.env
+auth/*.json
+auth/*.yaml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby_version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,17 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1
+env:
+  global:
+    - CC_TEST_REPORTER_ID=8f424c1882aec9c7bf8f1975801bf5913caa16ca31ecf859b2b4bd839bb362ca
+    - COVERAGE=true
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributor's Guide
+
+## Development
+
+```sh
+bin/console
+```
+
+## Testing
+
+```sh
+bundle exec rspec spec/
+```
+
+## Generating Code Coverage Reports
+
+```sh
+COVERAGE=true bundle exec rspec spec
+```
+
+## Releasing
+
+```sh
+bundle exec rake release
+```

data/CREDITS.md

@@ -0,0 +1,86 @@
+# Credits, Notes, and Reference
+
+## Ruby
+
+  + https://apidock.com/rails/String/to_datetime
+  + https://stackoverflow.com/a/5905875/670433
+  + https://apidock.com/ruby/DateTime/strftime
+  + [active model validation requirements too great?](https://stackoverflow.com/questions/37619583/how-to-load-only-activemodel-validations)
+
+## Rubygems
+
+  + http://data-creative.info/reference-docs/2015/07/03/how-to-make-a-ruby-gem/
+  + https://guides.rubygems.org/make-your-own-gem/#adding-an-executable
+  + https://github.com/rubygems/rubygems/issues/1267#issuecomment-196180872
+  + http://data-creative.info/reference-docs/2015/07/03/how-to-make-a-ruby-gem/
+
+### Rake Tasks
+
+  + http://andyatkinson.com/blog/2014/06/23/sharing-rake-tasks-in-gems
+  + https://github.com/ruby/rake
+
+## Banner
+
+  + https://myaccess.georgetown.edu
+
+## Google Calendar API
+
+  + https://developers.google.com/calendar/concepts/events-calendars
+  + https://developers.google.com/calendar/quickstart/ruby
+  + https://developers.google.com/api-client-library/ruby/apis/calendar/v3
+  + https://github.com/northworld/google_calendar
+  + https://developers.google.com/api-client-library/ruby/auth/installed-app#choosingredirecturi
+  + https://developers.google.com/calendar/v3/reference/calendarList/list#examples
+  + https://developers.google.com/calendar/v3/reference/calendars/insert
+  + https://developers.google.com/calendar/auth
+  + https://developers.google.com/calendar/v3/reference/calendars/delete
+  + [Auth scope constants](https://github.com/googleapis/google-api-ruby-client/blob/6773823e78266830a9a8a651d5fd52e307b63e97/generated/google/apis/calendar_v3.rb#L31-L43)
+  + https://developers.google.com/calendar/v3/reference/events/insert
+  + https://developers.google.com/calendar/v3/reference/events/update
+  + https://developers.google.com/calendar/v3/reference/events/delete
+  + So many events. They don't get deleted, they go into "cancelled" [status](https://developers.google.com/calendar/v3/reference/events#status)
+  + https://developers.google.com/calendar/v3/reference/events/list
+
+## Google Sheets and Drive APIs
+
+  + https://developers.google.com/sheets/api/quickstart/ruby
+  + https://developers.google.com/sheets/api/guides/migration#list_spreadsheets_for_the_authenticated_user
+  + https://developers.google.com/drive/api/v3/reference/files/list
+  + https://developers.google.com/drive/api/v3/quickstart/ruby
+  + https://stackoverflow.com/questions/37876423/get-the-list-of-all-spreadsheets-associated-with-google-account-using-sheets-api
+  + https://github.com/googleapis/google-api-ruby-client/blob/711dfb83b33c03535076917726956584d5c8bf9a/generated/google/apis/drive_v3/service.rb#L795-L847
+  + https://github.com/googleapis/google-api-ruby-client/blob/711dfb83b33c03535076917726956584d5c8bf9a/generated/google/apis/sheets_v4/service.rb#L481-L518
+  + https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/create
+  + https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#Spreadsheet
+  + https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets
+  + https://stackoverflow.com/questions/43207765/how-do-i-add-data-to-a-google-sheet-from-ruby
+  + https://github.com/googleapis/google-api-ruby-client/blob/711dfb83b33c03535076917726956584d5c8bf9a/generated/google/apis/sheets_v4/service.rb#L338-L406
+  + https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append
+  + https://github.com/googleapis/google-api-ruby-client/blob/711dfb83b33c03535076917726956584d5c8bf9a/generated/google/apis/drive_v3/service.rb#L604-L639
+  + https://developers.google.com/drive/api/v2/reference/files/delete
+  + https://stackoverflow.com/questions/46836393/how-do-i-delete-a-spreadsheet-file-using-google-spreadsheets-api
+
+## Parsing HTML with Nokogiri
+
+  + https://www.nokogiri.org/tutorials/searching_a_xml_html_document.html
+
+## Testing and Quality Control
+
+  + https://github.com/bblimke/webmock/wiki/Enabling-and-Disabling-WebMock
+  + https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
+  + https://relishapp.com/rspec/rspec-core/v/2-4/docs/command-line/tag-option
+  + [factory attributes for reserved words](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#method-name--reserved-word-attributes)
+
+### Code Climate
+
+  + https://docs.codeclimate.com/docs/approve-code-climate-as-a-third-party-application-in-github-1
+  + https://docs.codeclimate.com/docs/my-repository-isnt-listed-when-i-try-to-add-it-to-code-climate
+  + https://docs.codeclimate.com/docs/finding-your-test-coverage-token#section-regenerating-a-repos-test-reporter-id
+  + https://docs.codeclimate.com/docs/configuring-test-coverage
+  + https://docs.codeclimate.com/docs/travis-ci-test-coverage
+
+#### Test Coverage Reporting
+
+  + https://github.com/colszowka/simplecov
+  + https://github.com/chetan/simplecov-console/
+  + https://medium.com/the-code-review/display-your-ruby-test-coverage-using-simplecov-gem-and-codeclimate-6db6336fe409

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in my_banner.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    my_banner (1.0.0)
+      activesupport (~> 5.2)
+      google-api-client (~> 0.27)
+      nokogiri (~> 1.9)
+      pry
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    google-api-client (0.27.0)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (>= 0.5, < 0.8.0)
+      httpclient (>= 2.8.1, < 3.0)
+      mime-types (~> 3.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      signet (~> 0.10)
+    googleauth (0.7.1)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    hashdiff (0.3.7)
+    hirb (0.7.3)
+    httpclient (2.8.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    jwt (2.1.0)
+    memoist (0.16.0)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    os (1.0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    signet (0.11.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uber (0.1.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  factory_bot (~> 4.11)
+  my_banner!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16)
+  simplecov-console (~> 0.4)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 MJ Rossetti <prof.mj.rossetti@gmail.com>
+
+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,116 @@
+# MyBanner - Ruby
+
+[![Build Status](https://travis-ci.com/prof-rossetti/my-banner-rb.svg?branch=master)](https://travis-ci.com/prof-rossetti/my-banner-rb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/41968ec227c9b165cd82/maintainability)](https://codeclimate.com/github/prof-rossetti/my-banner-rb/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/41968ec227c9b165cd82/test_coverage)](https://codeclimate.com/github/prof-rossetti/my-banner-rb/test_coverage)
+
+This program processes detailed schedule information from your school's [Ellucian Banner](https://www.ellucian.com/solutions/ellucian-banner) information system to generate [Google Calendar](https://calendar.google.com) events and/or [Google Sheets](https://docs.google.com/spreadsheets) gradebook files for each of your scheduled classes.
+
+## Dependencies
+
+This program requires Ruby (version 2.5) and Bundler (version 1.16).
+
+## Installation
+
+To install the program, download or clone it [from GitHub](https://github.com/prof-rossetti/my-banner-rb):
+
+```sh
+git clone git@github.com:prof-rossetti/my-banner-rb.git
+```
+
+All subsequent usage commands assume you will be running them from the root directory of this repository, so navigate there now:
+
+```sh
+cd my-banner-rb/
+```
+
+## Setup
+
+Install the program's Ruby package dependencies by running the setup script:
+
+```sh
+bin/setup
+```
+
+## Usage
+
+Before the program can generate Google Calendar events and/or Google Sheet gradebook files for all your scheduled classes, it needs access to your schedule. So follow the section below to [Download Schedule Page from Banner](#downloading-schedule-page-from-banner) before performing any of the other functionality.
+
+### Downloading Schedule Page from Banner
+
+To access your schedule of classes for some specified term, login to your school's banner site (e.g. https://myaccess.georgetown.edu/), and navigate to one of the following schedule pages, depending on your role:
+
+  + *Home > Faculty Services > Faculty Detail Schedule*
+  + *Home > Student Services > Student Detail Schedule*
+
+Download your schedule page as an HTML file and move it into this repo at: **pages/my-detail-schedule.html**.
+
+To check the program's ability to parse that HTML content, run the schedule parser script and inspect its results:
+
+```sh
+bundle exec rake parse_schedule
+```
+
+Example results:
+
+```rb
+{
+  :title=>"Intro to Programming",
+  :crn=>123456,
+  :course=>"INFO 101",
+  :section=>20,
+  :status=>"OPEN",
+  :registration=>"May 01, 2018 - Nov 02, 2018",
+  :college=>"School of Business and Technology",
+  :department=>"Information Systems",
+  :part_of_term=>"C04",
+  :credits=>1.5,
+  :levels=>["Graduate", "Juris Doctor", "Undergraduate"],
+  :campus=>"Main Campus",
+  :override=>"No",
+  :enrollment_counts=>{:maximum=>50, :actual=>45, :remaining=>5},
+  :scheduled_meeting_times=>{
+    :type=>"Lecture",
+    :time=>"11:00 am - 12:20 pm",
+    :days=>"TR",
+    :where=>"Science Building 111",
+    :date_range=>"Oct 29, 2018 - Dec 18, 2018",
+    :schedule_type=>"Lecture",
+    :instructors=>["Polly Professor"]
+  }
+}
+```
+
+As long as your schedule data resembles the structure above and reflects the contents of your schedule page, you are ready to use this program to [Generate Google Calendar Events](#Generating-Google-Calendar-Events) and/or [Generate Google Sheet Gradebook Files](#Generating-Google-Sheet-Gradebook-Files).
+
+### Generating Google Calendar Events
+
+For the program to issue requests to the Google Calendar API, it needs the credentials of a Google APIs client application that has access to the Google Calendar API. From the [Google Calendar API quickstart guide](https://developers.google.com/calendar/quickstart/ruby), click "Enable the Calendar API" and follow the instructions to create a new app and generate new credentials. Download the resulting credentials file and move it into this repo at: **auth/calendar_credentials.json**.
+
+Once the schedule page and calendar credentials are in place, you can create google calendars and events for your scheduled classes by running the calendar creation script:
+
+```sh
+bundle exec rake create_calendars
+```
+
+> NOTE: When running this command for the first time, you will be prompted to login to Google to get an authorization code. After supplying that code to this program, the program will store an access token which will be used to authorize subsequent requests on your behalf, so you don't need to login again.
+
+### Generating Google Sheet Gradebook Files
+
+For the program to manage your gradebook files, it needs access to both the Google Sheets and Google Drive APIs.
+
+For the program to issue requests to the Google Sheets API, it needs the credentials of a Google APIs client application that has access to the Google Sheets API. From the [Google Sheets API quickstart guide](https://developers.google.com/sheets/api/quickstart/ruby), click "Enable the Sheets API" and follow the instructions to create a new app or select an existing one, and generate new credentials. Download the resulting credentials file and move it into this repo at: **auth/spreadsheet_credentials.json**.
+
+For the program to issue requests to the Google Drive API, it needs the credentials of a Google APIs client application that has access to the Google Drive API. From the [Google Drive API quickstart guide](https://developers.google.com/drive/api/v3/quickstart/ruby), click "Enable the Drive API" and follow the instructions to create a new app or select an existing one, and generate new credentials. Download the resulting credentials file and move it into this repo at: **auth/drive_credentials.json**.
+
+Once the schedule page, spreadsheet credentials, and drive credentials are in place, you can create google sheet gradebooks for your scheduled classes by running the spreadsheet creation script:
+
+```sh
+bundle exec rake create_spreadsheets
+```
+
+> NOTE: When running this command for the first time, you will be prompted to login to Google to get an authorization codes for both the sheets and drive apis, respectively. After supplying each code to this program, the program will store an access token which will be used to authorize subsequent requests on your behalf, so you don't need to login again.
+
+## [Contributing](/CONTRIBUTING.md)
+
+## [License](/LICENSE.md)