my_banner 1.0.0

data/lib/my_banner/section.rb

@@ -0,0 +1,58 @@
+module MyBanner
+  class Section
+
+    attr_accessor :metadata, :course, :section, :title, :instructor, :weekdays, :location, :time_zone, :term_start, :term_end, :start_time, :end_time
+
+    def initialize(metadata={})
+      @metadata = metadata
+
+      @course = metadata.try(:[], :course)
+      @section = metadata.try(:[], :section)
+      @title = metadata.try(:[], :title)
+
+      schedule_info = metadata.try(:[], :scheduled_meeting_times)
+      @instructor = schedule_info.try(:[], :instructors).try(:first)
+      @weekdays = schedule_info.try(:[], :days).try(:each_char).try(:to_a)
+      @location = schedule_info.try(:[], :where)
+      @time_zone = "America/New_York" #todo: lookup or customize
+
+      term_info = schedule_info.try(:[], :date_range) #todo: validate string splits into two-member array
+      @term_start = Date.parse( term_info.try(:split, " - ").try(:first) ) rescue nil
+      @term_end = Date.parse( term_info.try(:split, " - ").try(:last) ) rescue nil
+
+      time_info = schedule_info.try(:[], :time) #todo: validate string splits into two-member array
+      @start_time = time_info.try(:split, " - ").try(:first)
+      @end_time = time_info.try(:split, " - ").try(:last)
+    end
+
+    def abbreviation
+      "#{course}-#{section}" if course && section
+    end
+    alias_method :abbrev, :abbreviation
+
+    # @note does not exclude meetings cancelled due to holidays
+    # @todo cross-reference the "Holidays in the United States" calendar events to make a best guess at which classes to exclude
+    def meetings
+      meeting_dates.map do |date|
+        start_at = DateTime.parse("#{date} #{start_time}")
+        end_at = DateTime.parse("#{date} #{end_time}")
+        Meeting.new(start_at: start_at, end_at: end_at)
+      end
+    end
+
+    def meeting_dates
+      term_date_range.select { |date| weekday_numbers.include?(date.wday) }
+    end
+
+    def term_date_range
+      term_start..term_end
+    end
+
+    def weekday_numbers
+      weekdays.map { |char| WEEKDAYS_MAP[char.to_sym] }
+    end
+
+    WEEKDAYS_MAP = { M: 1, T: 2, W: 3, R: 4, F: 5, S: 6, N: 0 } # S and N assumed but not yet verified
+
+  end
+end

data/lib/my_banner/section/meeting.rb

@@ -0,0 +1,27 @@
+module MyBanner
+  class Section::Meeting
+
+    attr_reader :start_at, :end_at
+
+    def initialize(options={})
+      @start_at = options[:start_at]
+      @end_at = options[:end_at]
+      validate_datetimes
+    end
+
+    def to_s
+      "#{start_at.try(:strftime, '%Y-%m-%d %H:%M')} ... #{end_at.try(:strftime, '%Y-%m-%d %H:%M')}"
+    end
+
+    def to_h
+      { start_at: start_at, end_at: end_at }
+    end
+
+    private
+
+    def validate_datetimes
+      raise "expecting datetimes" unless start_at && end_at && start_at.is_a?(DateTime) && end_at.is_a?(DateTime)
+    end
+
+  end
+end

data/lib/my_banner/spreadsheet_authorization.rb

@@ -0,0 +1,16 @@
+require "google/apis/sheets_v4"
+
+module MyBanner
+  class SpreadsheetAuthorization < GoogleAuthorization
+
+    AUTH_SCOPE = Google::Apis::SheetsV4::AUTH_SPREADSHEETS #> "https://www.googleapis.com/auth/spreadsheets"
+
+    def initialize(options={})
+      options[:scope] ||= AUTH_SCOPE
+      options[:credentials_filepath] ||= "auth/spreadsheet_credentials.json"
+      options[:token_filepath] ||= "auth/spreadsheet_token.yaml"
+      super(options)
+    end
+
+  end
+end

data/lib/my_banner/spreadsheet_client.rb

@@ -0,0 +1,16 @@
+require "google/apis/sheets_v4"
+
+module MyBanner
+  class SpreadsheetClient < Google::Apis::SheetsV4::SheetsService
+
+    # @param authorization [SpreadsheetAuthorization]
+    def initialize(authorization=nil)
+      super()
+      self.client_options.application_name = "MyBanner Spreadsheet Client"
+      self.client_options.application_version = VERSION
+      authorization ||= SpreadsheetAuthorization.new
+      self.authorization = authorization.stored_credentials || authorization.user_provided_credentials
+    end
+
+  end
+end

data/lib/my_banner/spreadsheet_service.rb

@@ -0,0 +1,75 @@
+
+
+require "google/apis/sheets_v4"
+
+module MyBanner
+  class SpreadsheetService
+    attr_reader :spreadsheet_title #, :sheet_name #, :sheet_values
+
+    def initialize(spreadsheet_title)
+      @spreadsheet_title = spreadsheet_title
+      #@sheet_name = "roster-todo" # todo: "roster-#{Date.today.to_s}"
+      #@sheet_values = [["email", "registration_number", "net_id"]] + 27.times.map { |i| ["student#{i+1}@todo.edu", i+1, "student#{i+1}"] } # todo: get from roster
+    end
+
+    #def execute
+    #  spreadsheet
+    #  #update_values
+    #end
+
+    # # @return Google::Apis::SheetsV4::UpdateValuesResponse
+    # def update_values
+    #   range = "#{sheet_name}!A1"
+    #   vals = Google::Apis::SheetsV4::ValueRange.new(values: sheet_values)
+    #   client.update_spreadsheet_value(spreadsheet.spreadsheet_id, range, vals, value_input_option: "RAW")
+    # end
+
+    # @return Google::Apis::SheetsV4::Spreadsheet
+    def spreadsheet
+      @spreadsheet ||= if spreadsheet_file
+        client.get_spreadsheet(spreadsheet_file.id)
+      else
+        client.create_spreadsheet(new_spreadsheet)
+      end
+    end
+
+    def client
+      @client ||= SpreadsheetClient.new
+    end
+
+    def new_spreadsheet
+      #roster_sheet = Google::Apis::SheetsV4::Sheet.new(properties: {title: sheet_name, sheet_type: "GRID"})
+      #new_spreadsheet_attrs = { properties: {title: spreadsheet_title}, sheets: [roster_sheet] }
+      new_spreadsheet_attrs = { properties: { title: spreadsheet_title } }
+      Google::Apis::SheetsV4::Spreadsheet.new(new_spreadsheet_attrs)
+    end
+
+    #
+    # DRIVE FILES
+    #
+
+    # @return Google::Apis::DriveV3::File
+    def spreadsheet_file
+      file_list.files.find { |f| f.name == spreadsheet_title }
+    end
+
+    # @return Google::Apis::DriveV3::FileList
+    def file_list
+      @file_list ||= begin
+        request_options = {q: "mimeType='application/vnd.google-apps.spreadsheet'", order_by: "createdTime desc", page_size: 25}
+        drive_client.list_files(request_options)
+      end
+    end
+
+    def drive_client
+      @drive_client ||= DriveClient.new
+    end
+
+    private
+
+    def delete_spreadsheet # DANGER!
+      drive_client.delete_file(spreadsheet.spreadsheet_id)
+    end
+
+  end
+end

data/lib/my_banner/version.rb

@@ -0,0 +1,3 @@
+module MyBanner
+  VERSION = "1.0.0"
+end

data/lib/tasks/my_banner.rake

@@ -0,0 +1,120 @@
+require_relative "../my_banner"
+
+# namespace :my_banner do
+
+  task :parse_schedule do
+    page = MyBanner::Schedule.new
+    sections = page.sections
+    puts "-----------------------"
+    puts "SECTIONS: #{sections.count}"
+    puts "-----------------------"
+    sections.each do |section|
+      puts ""
+      puts "#{section.title.upcase}:"
+      puts ""
+      pp section.metadata
+      puts ""
+    end
+  end
+
+  # @example bundle exec rake create_calendars
+  task :create_calendars do
+    page = MyBanner::Schedule.new
+    sections = page.sections
+    puts "-----------------------"
+    puts "SECTIONS: #{sections.count}"
+    puts "-----------------------"
+    sections.each do |section|
+      puts "\nSECTION: #{section.abbreviation} (#{section.title})"
+      service = MyBanner::CalendarService.new(section)
+
+      calendar = service.calendar
+      puts "\nCALENDAR: #{calendar.summary} (#{calendar.id})"
+
+      meetings = section.meetings
+      puts "\nMEETINGS: #{meetings.count}"
+      meetings.each do |meeting|
+        puts " + #{meeting.to_s}"
+      end
+
+      events = service.events
+      puts "\nFUTURE EVENTS: #{events.count}"
+      events.each do |event|
+        event_start = event.start.date_time.try(:strftime, "%Y-%m-%d %H:%M") || event.start.date.try(:strftime, "%Y-%m-%d")
+        event_end = event.end.date_time.try(:strftime, "%Y-%m-%d %H:%M") || event.end.date.try(:strftime, "%Y-%m-%d")
+        puts " + #{event_start} ... #{event_end} (#{event.class})"
+      end
+
+      service.execute
+      puts "\n-----------------------"
+    end
+  end
+
+  # @example bundle exec rake clear_calendars
+  task :clear_calendars do
+    page = MyBanner::Schedule.new
+    sections = page.sections
+    sections.each do |section|
+      service = MyBanner::CalendarService.new(section)
+      service.send(:delete_events)
+    end
+  end
+
+  # @example bundle exec rake create_spreadsheets
+  task :create_spreadsheets do
+    page = MyBanner::Schedule.new
+    sections = page.sections
+
+    puts "-----------------------"
+    puts "SECTIONS: #{sections.count}"
+    puts "-----------------------"
+
+    sections.each do |section|
+
+      puts "\nSECTION: #{section.abbreviation} (#{section.title.upcase})\n"
+      course = section.course
+      start_month = section.term_start.strftime("%Y%m")
+      spreadsheet_title = "Gradebook - #{course} (#{start_month})"
+
+      service = MyBanner::SpreadsheetService.new(spreadsheet_title)
+      spreadsheet = service.spreadsheet
+      puts "SPREADSHEET: #{spreadsheet.properties.title.upcase} (#{spreadsheet.spreadsheet_id})"
+      puts "SHEETS:"
+      spreadsheet.sheets.each do |sheet|
+        grid_props = sheet.properties.grid_properties
+        puts "  + #{sheet.properties.title.upcase} (#{grid_props.row_count} rows x #{grid_props.column_count} cols)"
+      end
+
+      #puts "DATA:"
+      #setter_response = service.update_values
+      #getter_response = service.client.get_spreadsheet_values(spreadsheet.spreadsheet_id, setter_response.updated_range)
+      #getter_response.values.each do |row|
+      #  puts "  #{row.join(" | ")}"
+      #end
+    end
+  end
+
+  # @example bundle exec rake delete_spreadsheets
+  task :delete_spreadsheets do
+    page = MyBanner::Schedule.new
+    sections = page.sections
+
+    puts "-----------------------"
+    puts "SECTIONS: #{sections.count}"
+    puts "-----------------------"
+
+    sections.each do |section|
+      puts "\nSECTION: #{section.abbreviation} (#{section.title.upcase})\n"
+      course = section.course
+      start_month = section.term_start.strftime("%Y%m")
+      spreadsheet_title = "Gradebook - #{course} (#{start_month})"
+      service = MyBanner::SpreadsheetService.new(spreadsheet_title)
+
+      spreadsheet = service.spreadsheet
+      puts "SPREADSHEET: #{spreadsheet.properties.title.upcase} (#{spreadsheet.spreadsheet_id})"
+      puts "DELETING..."
+      service.send(:delete_spreadsheet) # temporary, helps to test file creation
+    end
+  end
+
+#end

data/my_banner.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "my_banner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "my_banner"
+  spec.version       = MyBanner::VERSION
+  spec.authors       = ["MJ Rossetti"]
+  spec.email         = ["prof.mj.rossetti@gmail.com", "mjr300@georgetown.edu"]
+
+  spec.summary       = "This program processes detailed schedule information from your school's Ellucian Banner information system to generate Google Calendar events and/or Google Sheets gradebook files for each of your scheduled classes."
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/prof-rossetti/my-banner-rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 5.2"
+  spec.add_dependency "google-api-client", "~> 0.27"
+  spec.add_dependency "nokogiri", '~> 1.9'
+  spec.add_dependency "pry" # really just for development purposes
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "factory_bot", "~> 4.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.4"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "simplecov-console", "~> 0.4"
+end

data/pages/.gitignore

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

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: my_banner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MJ Rossetti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: 
+email:
+- prof.mj.rossetti@gmail.com
+- mjr300@georgetown.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby_version"
+- ".travis.yml"
+- CONTRIBUTING.md
+- CREDITS.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- auth/.gitignore
+- bin/console
+- bin/setup
+- lib/my_banner.rb
+- lib/my_banner/calendar_authorization.rb
+- lib/my_banner/calendar_client.rb
+- lib/my_banner/calendar_service.rb
+- lib/my_banner/drive_authorization.rb
+- lib/my_banner/drive_client.rb
+- lib/my_banner/google_authorization.rb
+- lib/my_banner/schedule.rb
+- lib/my_banner/schedule/tableset.rb
+- lib/my_banner/section.rb
+- lib/my_banner/section/meeting.rb
+- lib/my_banner/spreadsheet_authorization.rb
+- lib/my_banner/spreadsheet_client.rb
+- lib/my_banner/spreadsheet_service.rb
+- lib/my_banner/version.rb
+- lib/tasks/my_banner.rake
+- my_banner.gemspec
+- pages/.gitignore
+homepage: https://github.com/prof-rossetti/my-banner-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: This program processes detailed schedule information from your school's Ellucian
+  Banner information system to generate Google Calendar events and/or Google Sheets
+  gradebook files for each of your scheduled classes.
+test_files: []