my_banner 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+import "./lib/tasks/my_banner.rake"

data/auth/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "my_banner"
+
+require "pry"
+Pry.start
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/my_banner.rb

@@ -0,0 +1,32 @@
+require "active_support/core_ext/array"
+require "active_support/core_ext/numeric/time"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/string/conversions"
+#require "googleauth"
+#require "googleauth/stores/file_token_store"
+#require "google/apis/calendar_v3"
+#require "google/apis/drive_v3"
+#require "google/apis/sheets_v4"
+#require "nokogiri"
+require "pry"
+
+require "my_banner/version"
+
+require "my_banner/google_authorization"
+
+require "my_banner/calendar_authorization"
+require "my_banner/calendar_client"
+require "my_banner/calendar_service"
+require "my_banner/drive_authorization"
+require "my_banner/drive_client"
+require "my_banner/spreadsheet_authorization"
+require "my_banner/spreadsheet_client"
+require "my_banner/spreadsheet_service"
+
+require "my_banner/schedule"
+require "my_banner/schedule/tableset"
+require "my_banner/section" # consider "my_banner/schedule/tableset/section"
+require "my_banner/section/meeting" # consider "my_banner/schedule/tableset/section/meeting"
+
+module MyBanner
+end

data/lib/my_banner/calendar_authorization.rb

@@ -0,0 +1,16 @@
+require "google/apis/calendar_v3"
+
+module MyBanner
+  class CalendarAuthorization < GoogleAuthorization
+
+    AUTH_SCOPE = Google::Apis::CalendarV3::AUTH_CALENDAR #> "https://www.googleapis.com/auth/calendar"
+
+    def initialize(options={})
+      options[:scope] ||= AUTH_SCOPE
+      options[:credentials_filepath] ||= "auth/calendar_credentials.json"
+      options[:token_filepath] ||= "auth/calendar_token.yaml"
+      super(options)
+    end
+
+  end
+end

data/lib/my_banner/calendar_client.rb

@@ -0,0 +1,26 @@
+require "google/apis/calendar_v3"
+
+module MyBanner
+  class CalendarClient < Google::Apis::CalendarV3::CalendarService
+
+    # @param authorization [CalendarAuthorization]
+    def initialize(authorization=nil)
+      super()
+      self.client_options.application_name = "MyBanner Calendar Client"
+      self.client_options.application_version = VERSION
+      authorization ||= CalendarAuthorization.new
+      self.authorization = authorization.stored_credentials || authorization.user_provided_credentials
+    end
+
+    def calendars
+      @calendars ||= list_calendar_lists.items.sort_by { |cal| cal.summary }
+    end
+
+    # @param calendar [Google::Apis::CalendarV3::Calendar]
+    def upcoming_events(calendar)
+      request_options = {max_results: 100, single_events: true, order_by: "startTime", time_min: Time.now.iso8601, show_deleted: false}
+      list_events(calendar.id, request_options).items
+    end
+
+  end
+end

data/lib/my_banner/calendar_service.rb

@@ -0,0 +1,116 @@
+module MyBanner
+  class CalendarService
+
+    attr_accessor :section, :calendar_name, :time_zone, :location, :meetings
+
+    def initialize(section)
+      @section = section
+      validate_section
+      @calendar_name = section.abbreviation
+      @time_zone = section.time_zone
+      @location = section.location
+      @meetings = section.meetings
+    end
+
+    def execute
+      meetings.map do |meeting|
+        event = find_event(meeting.to_h)
+        event ? update_event(event, meeting.to_h) : create_event(meeting.to_h)
+      end
+    end
+
+    def events
+      @events ||= client.upcoming_events(calendar)
+    end
+
+    def calendar
+      @calendar ||= (find_calendar || create_calendar)
+    end
+
+    def client
+      @client = CalendarClient.new
+    end
+
+    private
+
+    #
+    # EVENT OPERATIONS
+    #
+
+    def delete_events
+      events.map { |event| client.delete_event(calendar.id, event.id) }
+    end
+
+    def update_event(event, meeting_attrs)
+      client.update_event(calendar.id, event.id, new_event(meeting_attrs))
+    end
+
+    def find_event(meeting_attrs)
+      events.find do |e|
+        # match datetime events
+        (
+          e.start.date_time.try(:strftime, "%Y-%m-%dT%H:%M:%S") == meeting_attrs[:start_at].try(:strftime, "%Y-%m-%dT%H:%M:%S") &&
+          e.end.date_time.try(:strftime, "%Y-%m-%dT%H:%M:%S") == meeting_attrs[:end_at].try(:strftime, "%Y-%m-%dT%H:%M:%S")
+        ) ||
+        # match date events
+        (
+          e.start.date.try(:strftime, "%Y-%m-%dT%H:%M:%S") == meeting_attrs[:start_at].try(:strftime, "%Y-%m-%dT%H:%M:%S") &&
+          e.end.date.try(:strftime, "%Y-%m-%dT%H:%M:%S") == meeting_attrs[:end_at].try(:strftime, "%Y-%m-%dT%H:%M:%S")
+        )
+      end
+    end
+
+    def create_event(meeting_attrs)
+      client.insert_event(calendar.id, new_event(meeting_attrs))
+    end
+
+    def new_event(meeting_attrs)
+      Google::Apis::CalendarV3::Event.new(event_attributes(meeting_attrs))
+    end
+
+    def event_attributes(meeting_attrs)
+      {
+        summary: calendar_name,
+        location: location,
+        start: {
+          date_time: meeting_attrs[:start_at].strftime("%Y-%m-%-dT%H:%M:%S"), # excludes offset, regardless of tz presence, to avoid maladjustment
+          time_zone: time_zone
+        },
+        end: {
+          date_time: meeting_attrs[:end_at].strftime("%Y-%m-%-dT%H:%M:%S"), # excludes offset, regardless of tz presence, to avoid maladjustment
+          time_zone: time_zone
+        },
+        # description: "Agenda: https://.../units/1 \n \n Objectives: \n 1: ....  \n 2: ....  \n 3: ....", # todo
+        # attendees: ["hello@gmail.com", "prof@my-school.edu", "student@my-school.edu"],
+        # source: {title: "External link", url: "https://.../units/1"}
+      }
+    end
+
+    #
+    # CALENDAR OPERATIONS
+    #
+
+    def find_calendar
+      client.calendars.find { |cal| cal.summary == calendar_name }
+    end
+
+    def create_calendar
+      client.insert_calendar(new_calendar)
+    end
+
+    def new_calendar
+      Google::Apis::CalendarV3::Calendar.new(calendar_attributes)
+    end
+
+    def calendar_attributes
+      { summary: calendar_name, time_zone: time_zone }
+    end
+
+    private
+
+    def validate_section
+      raise "OOPS, expecting a section object" unless section && section.is_a?(Section)
+    end
+
+  end
+end

data/lib/my_banner/drive_authorization.rb

@@ -0,0 +1,17 @@
+require "google/apis/drive_v3"
+require "google/apis/drive_v3"
+
+module MyBanner
+  class DriveAuthorization < GoogleAuthorization
+
+    AUTH_SCOPE = Google::Apis::DriveV3::AUTH_DRIVE_FILE #> "https://www.googleapis.com/auth/drive.file"
+
+    def initialize(options={})
+      options[:scope] ||= AUTH_SCOPE
+      options[:credentials_filepath] ||= "auth/drive_credentials.json"
+      options[:token_filepath] ||= "auth/drive_token.yaml"
+      super(options)
+    end
+
+  end
+end

data/lib/my_banner/drive_client.rb

@@ -0,0 +1,16 @@
+require "google/apis/drive_v3"
+
+module MyBanner
+  class DriveClient < Google::Apis::DriveV3::DriveService
+
+    # @param authorization [DriveAuthorization]
+    def initialize(authorization=nil)
+      super()
+      self.client_options.application_name = "MyBanner Drive Client"
+      self.client_options.application_version = VERSION
+      authorization ||= DriveAuthorization.new
+      self.authorization = authorization.stored_credentials || authorization.user_provided_credentials
+    end
+
+  end
+end

data/lib/my_banner/google_authorization.rb

@@ -0,0 +1,47 @@
+require "googleauth"
+require "googleauth/stores/file_token_store"
+
+module MyBanner
+  class GoogleAuthorization
+    # returns authorization code in browser title bar and promps user to copy the code
+    # @see https://developers.google.com/api-client-library/python/auth/installed-app#choosingredirecturi
+    BASE_URL = "urn:ietf:wg:oauth:2.0:oob"
+
+    attr_reader :scope, :credentials_filepath, :token_filepath, :user_id
+
+    def initialize(options={})
+      @scope = options[:scope]
+      @credentials_filepath = options[:credentials_filepath]
+      @token_filepath = options[:token_filepath]
+      @user_id = options[:user_id] || "default"
+    end
+
+    def user_authorizer
+      client_id = Google::Auth::ClientId.from_file(credentials_filepath) # will throw an error without credentials file
+      token_store = Google::Auth::Stores::FileTokenStore.new(file: token_filepath)
+      Google::Auth::UserAuthorizer.new(client_id, scope, token_store)
+    end
+
+    # @return [Google::Auth::UserRefreshCredentials] OAuth2 credentials
+    def stored_credentials
+      user_authorizer.get_credentials(user_id)
+    end
+
+    # makes a request to https://oauth2.googleapis.com/token
+    def user_provided_credentials
+      user_authorizer.get_and_store_credentials_from_code(user_id: user_id, code: user_provided_code, base_url: BASE_URL)
+    end
+
+    # prompt user for results of redirected auth flow
+    def user_provided_code
+      puts "Please visit ... \n\n #{authorization_url} \n\n ... login to your google account, get a code, paste it here, and press enter: "
+      code = $stdin.gets.chomp
+      return code
+    end
+
+    def authorization_url
+      user_authorizer.get_authorization_url(base_url: BASE_URL)
+    end
+
+  end
+end

data/lib/my_banner/schedule.rb

@@ -0,0 +1,54 @@
+require "nokogiri"
+require "active_support/core_ext/array"
+
+module MyBanner
+  class Schedule # consider Page, SchedulePage, DetailSchedulePage, FacultyDetailSchedulePage
+
+    attr_reader :filepath
+
+    def initialize(filepath=nil)
+      @filepath = filepath || "pages/my-detail-schedule.html"
+      validate_file_exists
+    end
+
+    def sections
+      @sections ||= tablesets.map{ |tableset| tableset.section }
+    end
+
+    def tablesets
+      @tablesets ||= tables.to_a.in_groups_of(3).map do |batch|
+        summaries = batch.map { |t| t.attributes["summary"].value.squish }
+        raise "Unexpected tableset: #{summaries}" unless summaries.sort == TABLE_SUMMARIES.values.sort
+        info_table = batch.find { |t| t.attributes["summary"].value.squish == TABLE_SUMMARIES[:info].squish }
+        enrollment_table = batch.find { |t| t.attributes["summary"].value == TABLE_SUMMARIES[:enrollment] }
+        schedule_table = batch.find { |t| t.attributes["summary"].value == TABLE_SUMMARIES[:schedule] }
+        Tableset.new(info_table, enrollment_table, schedule_table)
+      end
+    end
+
+    TABLE_SUMMARIES = {
+      info: "This layout table is used to present instructional assignments for the selected Term..",
+      enrollment: "This table displays enrollment and waitlist counts.",
+      schedule: "This table lists the scheduled meeting times and assigned instructors for this class.."
+    }
+
+    # @return Nokogiri::XML::NodeSet
+    def tables
+      @tables ||= doc.css(".pagebodydiv").css("table").css(".datadisplaytable") # ignores the last table
+    end
+
+    # @return Nokogiri::XML::Document
+    def doc
+      @doc ||= File.open(filepath) { |f| Nokogiri::XML(f) }
+    end
+
+    private
+
+    def validate_file_exists
+      unless filepath && File.exists?(filepath)
+        raise "Oh, couldn't find an HTML file at #{filepath}. Please download one and copy it to the expected location."
+      end
+    end
+
+  end
+end

data/lib/my_banner/schedule/tableset.rb

@@ -0,0 +1,115 @@
+module MyBanner
+  class Schedule::Tableset
+
+    attr_reader :info_table, :enrollment_table, :schedule_table
+
+    def initialize(info_table, enrollment_table, schedule_table)
+      @info_table = info_table
+      @enrollment_table = enrollment_table
+      @schedule_table = schedule_table
+    end
+
+    def section
+      @section ||= Section.new(metadata)
+    end
+
+    def metadata
+      @metadata ||= info.merge(enrollment_counts: enrollment_counts, scheduled_meeting_times: scheduled_meeting_times)
+    end
+
+    def info
+      @info ||= {
+        title: info_link_text[0],
+        crn: info_link_text[1],
+        course: info_link_text[2],
+        section: info_link_text[3].to_i,
+        status: info_rows[1].css("td").text,
+        registration: info_rows[2].css("td").text,
+        college: info_rows[3].css("td").text.squish,
+        department: info_rows[4].css("td").text.squish,
+        part_of_term: info_rows[5].css("td").text,
+        credits: info_rows[6].css("td").text.squish.to_f,
+        levels: info_rows[7].css("td").text.split(", "),
+        campus: info_rows[8].css("td").text,
+        override: info_rows[9].css("td").text
+      }
+    end
+
+    def enrollment_counts
+      @enrollment_counts ||= {
+        maximum: enrollment_data[0].text.to_i,
+        actual: enrollment_data[1].text.to_i,
+        remaining: enrollment_data[2].text.to_i
+      }
+    end
+
+    def scheduled_meeting_times
+      {
+        type: schedule_data[0].text,
+        time: schedule_data[1].text,
+        days: schedule_data[2].text,
+        where: schedule_data[3].text,
+        date_range: schedule_data[4].text,
+        schedule_type: schedule_data[5].text,
+        instructors: schedule_data[6].text.squish.split(",")
+      }
+    end
+
+    private
+
+    def info_link_text
+      @info_link_text ||= info_rows[0].css("a").first.text.split("Status:").first.squish.split(" - ")
+    end
+
+    def enrollment_data
+      @enrollment_data ||= begin
+        enrollment_row = enrollment_rows[1]
+        raise "Unexpected enrollment table row" unless enrollment_row.css("th").text == "Enrollment:"
+        raise "Unexpected enrollment table data" unless enrollment_row.css("td").count == 3
+        enrollment_row.css("td")
+      end
+    end
+
+    def schedule_data
+      @schedule_data ||= begin
+        schedule_row = schedule_rows[1]
+        raise "Unexpected schedule table data" unless schedule_row.css("td").count == 7 # schedule_table_headers.count
+        schedule_data = schedule_row.css("td")
+      end
+    end
+
+    def info_rows
+      @info_rows ||= begin
+        table = Nokogiri::XML(info_table.to_html) #> workaround because info_table.css("tr") seems to return too many rows (52). the raw html looks good though.
+        table_rows = table.css("tr")
+        raise "Unexpected number of info table rows: #{table_rows.count}" unless table_rows.count == 12
+        table_rows
+      end
+    end
+
+    def enrollment_rows
+      @enrollment_rows ||= begin
+        table_rows = enrollment_table.css("tr")
+        raise "Unexpected enrollment table row count: #{table_rows.count}" unless table_rows.count == 3
+        expected_headers = ["", "Maximum", "Actual", "Remaining"]
+        table_headers = table_rows[0].css("th").map(&:text)
+        raise "Unexpected enrollment table headers" unless table_headers == expected_headers
+        table_rows
+      end
+    end
+
+    def schedule_rows
+      @schedule_rows ||= begin
+        table = Nokogiri::XML(schedule_table.to_html)#> workaround because schedule_table.css("tr") seems to return too many rows (71). the raw html looks good though.
+        table_rows = table.css("tr")
+        raise "Unexpected schedule table row count: #{table_rows.count}" unless table_rows.count == 2
+        # consider also validating table caption == "Scheduled Meeting Times"
+        expected_headers = ["Type", "Time", "Days", "Where", "Date Range", "Schedule Type", "Instructors"]
+        table_headers = table_rows[0].css("th").map(&:text)
+        raise "Unexpected schedule table headers" unless table_headers == expected_headers
+        table_rows
+      end
+    end
+
+  end
+end